@lwc-bolts/lightning-base-components 0.0.0-stage → 1.0.0

package/LICENSE.md

@@ -0,0 +1,7 @@
+Copyright 2025 Anthony Heber
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/README.md

@@ -1,3 +1,57 @@
-# Temporary Holding Version
+# @lwc-bolts/lightning-base-components
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+Definitions of the Salesforce `lightning-*` base components: each component's properties (with the types they accept and their descriptions), methods and events, by tag. The [content mapper](../typescript-content-mapper)'s template checks use them through [sf2ts](../sf2ts).
+
+```ts
+import { LIGHTNING_COMPONENTS } from "@lwc-bolts/lightning-base-components";
+
+LIGHTNING_COMPONENTS["lightning-combobox"].events.change.type; // 'CustomEvent<{ value: string }>'
+```
+
+## Updating the definitions
+
+`src/components.generated.ts` is generated by `npm run generate` from two sources, whose versions `lightning/sources.json` pins:
+
+- The Salesforce LWC language server's component metadata (`@salesforce/lwc-language-server`'s `lib/resources/transformed-lwc-standard.json`, BSD-3-Clause), which lists components and their attributes, most with a type and a description.
+- The base component stubs Salesforce's Jest preset uses (`@salesforce/sfdx-lwc-jest`'s `src/lightning-stubs`, MIT): an LWC class per component, with an `@api` member for each property and method, without types.
+
+Components, properties and methods are the union of both, typed and described from the language server's metadata where it has them, and `any` otherwise. Neither has events. The generated file carries both licenses. `npm run generate -- --update` moves both sources to their latest versions first, and pins them.
+
+`lightning/overrides.jsonc` changes the definitions by hand, and wins over both sources. Its schema, `lightning/overrides.schema.json`, describes it to editors:
+
+```jsonc
+{
+  "$schema": "./overrides.schema.json",
+  "components": {
+    "lightning-input": {
+      "methods": { "reportValidity": { "type": "() => boolean" } },        // change a member's type
+      "events": { "change": { "detail": "{ value: any; checked?: boolean }" } } // add an event
+    },
+    "lightning-card": {
+      "properties": { "actions": null, "footer": null }  // remove members: these are slots
+    },
+    "lightning-legacy-thing": null,                       // remove a whole component
+    "lightning-new-thing": {                              // add a component neither source has
+      "properties": { "size": { "type": "number" } }
+    }
+  }
+}
+```
+
+- `null` removes a component, property, method or event, and blocks it: the overrides are applied every time the file is generated, so an update can't bring it back.
+- A member's `type` and `description` replace the imported ones. A member or component neither source has is added; a member without a type gets `any` (methods `(...args: any[]) => any`, events `CustomEvent<any>`). An event's `detail` is shorthand for `CustomEvent<detail>`, and its name is the one `on<name>` handles.
+- `"replace": true` ignores a component's imported members, so it has only those the overrides give it.
+
+The script checks the overrides before using them, and warns about removals that no longer match anything imported, so they can be cleaned up. Run it after changing the overrides, and commit both. The tests check that the generated file reflects the overrides, and compile every component's definition.
+
+The overrides' events, method types and descriptions, and the components neither source has (`lightning-select`, `lightning-empty-state` and `lightning-illustration`), come from the [Lightning Component Reference](https://developer.salesforce.com/docs/platform/lightning-component-reference/guide/components.html), with its descriptions verbatim. Where the reference disagrees with how a component behaves (such as `lightning-combobox`'s `change` event, whose detail is `{ value }` rather than the documented `selectedValue`), a comment says so.
+
+`npm run compare-docs` crawls the reference and compares it with the generated definitions, to find what to add to the overrides or what's out of date there:
+
+```sh
+npm run compare-docs                                   # every component in the reference
+npm run compare-docs -- lightning-input lightning-tabs # only these
+npm run compare-docs -- --cache .reference-cache --json comparison.json
+```
+
+For each component it reads the reference's Markdown page (its description and custom events) and its specification (attributes, methods and slots, from the endpoint the page's Specifications tab uses), and lists, per component: attributes, methods and events one has that the other doesn't, attribute types whose kinds don't overlap, methods whose argument count differs, documented event parameters our detail type lacks, and the documented slots, which the definitions don't model. Members every component gets from its host element (`title`, `aria-*`, `focus()` and the like) aren't listed. The site refuses bursts of requests, so the script fetches one page at a time and backs off when refused; with `--cache`, an interrupted run resumes where it stopped. `--json` also writes what it read and the comparison.

package/dist/components.generated.d.ts

@@ -0,0 +1,3 @@
+import type { LightningComponent } from "./types.ts";
+/** The `lightning-*` base components, by tag. */
+export declare const LIGHTNING_COMPONENTS: Readonly<Record<string, LightningComponent>>;