lwc 4.0.0-alpha.0 → 4.0.0

package/index.d.ts

@@ -38,6 +38,7 @@ declare module 'lwc' {
         querySelectorAll<E extends Element = Element>(selectors: string): NodeListOf<E>;
         getElementsByTagName(tagNameOrWildCard: string): HTMLCollectionOf<Element>;
         getElementsByClassName(names: string): HTMLCollectionOf<Element>;
+        attachInternals(): ElementInternals;
         readonly tagName: string;
         readonly classList: DOMTokenList;
 
@@ -189,44 +190,75 @@ declare module 'lwc' {
      */
     export const track: PropertyDecorator;
 
+    type StringKeyedRecord = Record<string, any>;
     /**
      * Decorator factory to wire a property or method to a wire adapter data source
+     * Use generic types to allow type checking for wire adapters
+     * Default all the generic types to any to maintain backward compatibility
+     *
+     * For example, a wire adapter 'getRecord' can have the following type definition
+     *
+     * export const getRecord: WireAdapterConstructor<GetRecordConfig, RecordRepresentation>;
+     *
+     * in which 'GetRecordConfig' is the adapter config object type and 'RecordRepresentation'
+     * is the returned value.
+     *
      * @param adapter the adapter used to provision data
      * @param config configuration object for the adapter
      */
-    export function wire(
-        adapter: WireAdapterConstructor | LegacyWireAdapterConstructor,
-        config?: WireConfigValue
+    export function wire<
+        Config extends StringKeyedRecord,
+        Value,
+        Context extends StringKeyedRecord = StringKeyedRecord
+    >(
+        adapter:
+            | WireAdapterConstructor<Config, Value, Context>
+            | LegacyWireAdapterConstructor<Config, Value>,
+        config?: WireConfigValue<Config>
     ): PropertyDecorator;
 
-    type LegacyWireAdapterConstructor = (config?: any) => any;
-    type WireConfigValue = Record<string, any>;
-    type ContextValue = Record<string, any>;
+    type LegacyWireAdapterConstructor<Config, Value> = (config?: Config) => Value;
+    type WireConfigValue<Config extends StringKeyedRecord = StringKeyedRecord> = {
+        // wire reactive variables are strings prefixed with '$' so the config value can just be string
+        [K in keyof Config]: Config[K] | string;
+    };
+    type ContextValue<Context extends StringKeyedRecord = StringKeyedRecord> = Context;
 
-    interface WireAdapter {
-        update(config: WireConfigValue, context?: ContextValue): void;
+    interface WireAdapter<Config extends StringKeyedRecord, Context extends StringKeyedRecord> {
+        update(config: WireConfigValue<Config>, context?: ContextValue<Context>): void;
         connect(): void;
         disconnect(): void;
     }
 
-    type WireDataCallback = (value: any) => void;
+    type WireDataCallback<Value> = (value: Value) => void;
     type WireAdapterSchemaValue = 'optional' | 'required';
 
-    interface ContextConsumer {
-        provide(newContext: ContextValue): void;
+    interface ContextConsumer<Context extends StringKeyedRecord> {
+        provide(newContext: ContextValue<Context>): void;
     }
 
-    interface ContextProviderOptions {
-        consumerConnectedCallback: (consumer: ContextConsumer) => void;
-        consumerDisconnectedCallback?: (consumer: ContextConsumer) => void;
+    interface ContextProviderOptions<Context extends StringKeyedRecord> {
+        consumerConnectedCallback: (consumer: ContextConsumer<Context>) => void;
+        consumerDisconnectedCallback?: (consumer: ContextConsumer<Context>) => void;
     }
 
-    interface WireAdapterConstructor {
-        new (callback: WireDataCallback): WireAdapter;
-        configSchema?: Record<string, WireAdapterSchemaValue>;
-        contextSchema?: Record<string, WireAdapterSchemaValue>;
+    interface WireAdapterConstructor<
+        Config extends StringKeyedRecord,
+        Value,
+        Context extends StringKeyedRecord
+    > {
+        new (callback: WireDataCallback<Value>): WireAdapter<Config, Context>;
+        configSchema?: Record<keyof Config, WireAdapterSchemaValue>;
+        contextSchema?: Record<keyof Context, WireAdapterSchemaValue>;
     }
 
-    type Contextualizer = (elm: EventTarget, options: ContextProviderOptions) => void;
-    export function createContextProvider(config: WireAdapterConstructor): Contextualizer;
+    type Contextualizer<Context extends StringKeyedRecord> = (
+        elm: EventTarget,
+        options: ContextProviderOptions<Context>
+    ) => void;
+    export function createContextProvider<
+        Config extends StringKeyedRecord,
+        Value,
+        Context extends StringKeyedRecord = StringKeyedRecord
+    >(config: WireAdapterConstructor<Config, Value, Context>): Contextualizer<Context>;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "lwc",
-    "version": "4.0.0-alpha.0",
+    "version": "4.0.0",
     "description": "Lightning Web Components (LWC)",
     "homepage": "https://lwc.dev/",
     "repository": {
@@ -20,21 +20,21 @@
         "*.d.ts"
     ],
     "dependencies": {
-        "@lwc/aria-reflection": "4.0.0-alpha.0",
-        "@lwc/babel-plugin-component": "4.0.0-alpha.0",
-        "@lwc/compiler": "4.0.0-alpha.0",
-        "@lwc/engine-core": "4.0.0-alpha.0",
-        "@lwc/engine-dom": "4.0.0-alpha.0",
-        "@lwc/engine-server": "4.0.0-alpha.0",
-        "@lwc/errors": "4.0.0-alpha.0",
-        "@lwc/features": "4.0.0-alpha.0",
-        "@lwc/module-resolver": "4.0.0-alpha.0",
-        "@lwc/rollup-plugin": "4.0.0-alpha.0",
-        "@lwc/shared": "4.0.0-alpha.0",
-        "@lwc/style-compiler": "4.0.0-alpha.0",
-        "@lwc/synthetic-shadow": "4.0.0-alpha.0",
-        "@lwc/template-compiler": "4.0.0-alpha.0",
-        "@lwc/wire-service": "4.0.0-alpha.0"
+        "@lwc/aria-reflection": "4.0.0",
+        "@lwc/babel-plugin-component": "4.0.0",
+        "@lwc/compiler": "4.0.0",
+        "@lwc/engine-core": "4.0.0",
+        "@lwc/engine-dom": "4.0.0",
+        "@lwc/engine-server": "4.0.0",
+        "@lwc/errors": "4.0.0",
+        "@lwc/features": "4.0.0",
+        "@lwc/module-resolver": "4.0.0",
+        "@lwc/rollup-plugin": "4.0.0",
+        "@lwc/shared": "4.0.0",
+        "@lwc/style-compiler": "4.0.0",
+        "@lwc/synthetic-shadow": "4.0.0",
+        "@lwc/template-compiler": "4.0.0",
+        "@lwc/wire-service": "4.0.0"
     },
     "lwc": {
         "modules": [
@@ -70,4 +70,4 @@
         "./template-compiler": "./template-compiler.js",
         "./wire-service": "./wire-service.js"
     }
-}
+}