Missing Types in @salesforce/lightning-types

未关闭
  • 哪里不对？
#3,683 1 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看

还没有人认领这个 Issue。

评估

难度
4/5
预计耗时
3-5 天
新手友好度
45/100
Issue 类型
功能
描述清晰度
基本清楚
活跃度
活跃
技术栈
javascript, node.js, typescript
领域
developer-experience, tooling

调研方向

Start by checking the Salesforce TypeScript guidance linked in the issue and the published @salesforce/lightning-types package to see how platform module declarations are organized. The issue names missing types for lightning/platformShowToastEvent and lightning/navigation, but does not identify the package source repository or its contribution process. Done means both modules resolve with useful type information in an LWC, though maintainers may need to confirm where the package is maintained.

由索引模型根据 Issue 内容生成。

描述

investigating validated
Before You Submit
  • I'm using the latest version of Salesforce CLI
  • I've searched the existing issues
  • I've run sf doctor to diagnose common issues
Related Issue

No response

Command

nom install @salesforce/lightning-types

Org Type

Not applicable

Did this work before?

No, this is a new bug

Last Working Version

No response

Summary

Please route this to the correct channel.

When trying to use type checking in JS or TS I've found that I can't find types for a few packages available from any of the Salesforce extensions or packages, specifically the expected @salesforce/lightning-types package.

The first few I found:

  • lightning/platformShowToastEvent
  • lightning/navigation

Please help me get these in front of whomever maintains those packages so they can be added. I'm happy to submit initial types that I've added to my own project though they may be incomplete. If there is a better channel to submit these issues please let me know.

Note: It would be amazing if that package were made available as an open-source project so the community could take a more direct hand in contributing and maintaining.

Repository to Reproduce

No response

Steps to reproduce

Following the instructions at
https://developer.salesforce.com/docs/platform/lwc/guide/ts.html#manually-install-the-lightning-types-package

Then use either of the two packages in an LWC. The type information is unable to resolve.

If you'd like clearer errors you can enable type checking for the JS components by adding the Compiler Options "checkJS" = true in your jsconfig.json, this will cause the import to display as unresolvable.

Expected Result

I would like the @salesforce/lightning-types package to provide type information for all of the platform provided packages. Making is so I can provide a better development experience and enforce type safety, improving the quality of the components we build.

Actual Result

The types do not resolve and the type checking throws an error and the IDE is unable to provide completion helps.

Error Message
System Information
{
  "architecture": "darwin-arm64",
  "cliVersion": "@salesforce/cli/2.157.8",
  "nodeVersion": "node-v26.13.0",
  "osVersion": "Darwin 27.2.0",
  "rootPath": "/Users/heber/.local/share/sf/client/2.157.8-b36e90e",
  "shell": "zsh",
  "pluginVersions": [
    "@oclif/plugin-autocomplete 4.0.6 (core)",
    "@oclif/plugin-commands 5.0.6 (core)",
    "@oclif/plugin-help 7.0.6 (core)",
    "@oclif/plugin-not-found 4.0.7 (core)",
    "@oclif/plugin-plugins 7.0.13 (core)",
    "@oclif/plugin-search 2.0.9 (core)",
    "@oclif/plugin-update 5.0.10 (core)",
    "@oclif/plugin-version 3.0.7 (core)",
    "@oclif/plugin-warn-if-update-available 4.0.5 (core)",
    "@oclif/plugin-which 4.0.6 (core)",
    "@salesforce/cli 2.157.8 (core)",
    "agent 2.2.3 (core)",
    "apex 4.4.4 (core)",
    "api 2.0.24 (core)",
    "auth 6.0.0 (core)",
    "data 5.1.24 (core)",
    "deploy-retrieve 4.3.2 (core)",
    "info 4.0.22 (core)",
    "lightning-dev 6.2.22 (user) published 20 days ago (Thu Oct 15 2026)",
    "limits 4.0.6 (core)",
    "marketplace 2.0.23 (core)",
    "org 7.0.10 (core)",
    "packaging 3.0.17 (user) published 9 days ago (Mon Oct 26 2026)",
    "schema 4.0.16 (core)",
    "settings 3.0.22 (core)",
    "signups 3.0.12 (user) published 18 days ago (Sun Oct 18 2026) (latest is 3.0.13)",
    "sobject 2.0.20 (core)",
    "telemetry 4.2.4 (core)",
    "templates 57.5.0 (core)",
    "trust 4.0.28 (core)",
    "user 6.0.6 (core)",
    "sfdx-git-delta 6.45.1 (user) published 132 days ago (Fri Jun 26 2026)"
  ]
}
Additional Information

No response

Screenshots or Log Files

No response

主要语言
没有语言数据
星标
575
派生
80
平均合并
11 小时 37 分钟
30 天内合并 PR
6

环境准备

  • 没有 Dockerfile 或 Docker Compose 文件
  • 没有 Pull Request 模板
  • 阅读贡献指南

从这里开始

  1. 先读完整个 Issue，再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库，在一个分支上完成修改。
  4. 提交 Pull Request，并在描述里引用这个 Issue 编号。

forcedotcom/cli 的其他 Issue

查看 forcedotcom/cli 的全部 Issue

相似的 Issue

更多 DevTools Issue

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。