@lwc/engine-core 2.37.2 → 2.38.0

package/types/framework/renderer.d.ts

@@ -1,3 +1,4 @@
+import type { WireContextSubscriptionPayload } from './wiring';
 export type HostNode = any;
 export type HostElement = any;
 type N = HostNode;
@@ -41,5 +42,7 @@ export interface RendererAPI {
     insertStylesheet: (content: string, target?: ShadowRoot) => void;
     assertInstanceOfHTMLElement: (elm: any, msg: string) => void;
     createCustomElement: (tagName: string, upgradeCallback: LifecycleCallback, connectedCallback?: LifecycleCallback, disconnectedCallback?: LifecycleCallback) => E;
+    ownerDocument(elm: E): Document;
+    registerContextConsumer: (element: E, adapterContextToken: string, subscriptionPayload: WireContextSubscriptionPayload) => void;
 }
 export {};

package/types/framework/vnodes.d.ts

@@ -68,7 +68,7 @@ export interface VCustomElement extends VBaseElement {
 }
 export interface VNodeData {
     readonly props?: Readonly<Record<string, any>>;
-    readonly attrs?: Readonly<Record<string, string | number | boolean>>;
+    readonly attrs?: Readonly<Record<string, string | number | boolean | null | undefined>>;
     readonly className?: string;
     readonly style?: string;
     readonly classMap?: Readonly<Record<string, boolean>>;

package/types/framework/wiring/context.d.ts

@@ -0,0 +1,4 @@
+import { VM } from '../vm';
+import { ContextProvider, ContextValue, RegisterContextProviderFn, WireAdapterConstructor, WireDef } from './types';
+export declare function createContextProviderWithRegister(adapter: WireAdapterConstructor, registerContextProvider: RegisterContextProviderFn): ContextProvider;
+export declare function createContextWatcher(vm: VM, wireDef: WireDef, callbackWhenContextIsReady: (newContext: ContextValue) => void): void;

package/types/framework/wiring/index.d.ts

@@ -0,0 +1,3 @@
+export { createContextProviderWithRegister, createContextWatcher } from './context';
+export { ConfigCallback, ConfigValue, ContextValue, DataCallback, WireAdapter, WireAdapterConstructor, WireAdapterSchemaValue, WireContextSubscriptionPayload, WireContextSubscriptionCallback, } from './types';
+export { connectWireAdapters, disconnectWireAdapters, installWireAdapters, storeWiredFieldMeta, storeWiredMethodMeta, } from './wiring';

package/types/framework/wiring/types.d.ts

@@ -0,0 +1,49 @@
+import type { LightningElement } from '../base-lightning-element';
+import type { HostElement } from '../renderer';
+export type DataCallback = (value: any) => void;
+export type ConfigValue = Record<string, any>;
+export type WireAdapterSchemaValue = 'optional' | 'required';
+export type ContextValue = Record<string, any>;
+export interface WireAdapter {
+    update(config: ConfigValue, context?: ContextValue): void;
+    connect(): void;
+    disconnect(): void;
+}
+export interface WireAdapterConstructor {
+    new (callback: DataCallback): WireAdapter;
+    configSchema?: Record<string, WireAdapterSchemaValue>;
+    contextSchema?: Record<string, WireAdapterSchemaValue>;
+}
+export interface WireDef {
+    method?: (data: any) => void;
+    adapter: WireAdapterConstructor;
+    dynamic: string[];
+    configCallback: ConfigCallback;
+}
+export interface WireMethodDef extends WireDef {
+    method: (data: any) => void;
+}
+export interface WireFieldDef extends WireDef {
+    method?: undefined;
+}
+export type ConfigCallback = (component: LightningElement) => ConfigValue;
+export interface WireDebugInfo {
+    data?: any;
+    config?: ConfigValue;
+    context?: ContextValue;
+    wasDataProvisionedForConfig: boolean;
+}
+export type WireContextSubscriptionCallback = (subscriptionPayload: WireContextSubscriptionPayload) => void;
+export interface WireContextSubscriptionPayload {
+    setNewContext(newContext: ContextValue): void;
+    setDisconnectedCallback(disconnectCallback: () => void): void;
+}
+export interface ContextConsumer {
+    provide(newContext: ContextValue): void;
+}
+export interface ContextProviderOptions {
+    consumerConnectedCallback: (consumer: ContextConsumer) => void;
+    consumerDisconnectedCallback?: (consumer: ContextConsumer) => void;
+}
+export type ContextProvider = (elmOrComponent: EventTarget, options: ContextProviderOptions) => void;
+export type RegisterContextProviderFn = (element: HostElement, adapterContextToken: string, onContextSubscription: WireContextSubscriptionCallback) => void;

package/types/framework/wiring/wiring.d.ts

@@ -0,0 +1,7 @@
+import { VM } from '../vm';
+import type { ConfigCallback, WireAdapterConstructor } from './types';
+export declare function storeWiredMethodMeta(descriptor: PropertyDescriptor, adapter: WireAdapterConstructor, configCallback: ConfigCallback, dynamic: string[]): void;
+export declare function storeWiredFieldMeta(descriptor: PropertyDescriptor, adapter: WireAdapterConstructor, configCallback: ConfigCallback, dynamic: string[]): void;
+export declare function installWireAdapters(vm: VM): void;
+export declare function connectWireAdapters(vm: VM): void;
+export declare function disconnectWireAdapters(vm: VM): void;

package/types/framework/context-provider.d.ts

@@ -1,10 +0,0 @@
-import { WireAdapterConstructor, ContextValue } from './wiring';
-interface ContextConsumer {
-    provide(newContext: ContextValue): void;
-}
-interface ContextProviderOptions {
-    consumerConnectedCallback: (consumer: ContextConsumer) => void;
-    consumerDisconnectedCallback?: (consumer: ContextConsumer) => void;
-}
-export declare function createContextProvider(adapter: WireAdapterConstructor): (elm: EventTarget, options: ContextProviderOptions) => void;
-export {};

package/types/framework/wiring.d.ts

@@ -1,34 +0,0 @@
-import { LightningElement } from './base-lightning-element';
-import { VM } from './vm';
-interface WireContextInternalEventPayload {
-    setNewContext(newContext: ContextValue): void;
-    setDisconnectedCallback(disconnectCallback: () => void): void;
-}
-export declare class WireContextRegistrationEvent extends CustomEvent<undefined> {
-    readonly setNewContext: (newContext: ContextValue) => void;
-    readonly setDisconnectedCallback: (disconnectCallback: () => void) => void;
-    constructor(adapterToken: string, { setNewContext, setDisconnectedCallback }: WireContextInternalEventPayload);
-}
-export type DataCallback = (value: any) => void;
-export type ConfigValue = Record<string, any>;
-export interface WireAdapter {
-    update(config: ConfigValue, context?: ContextValue): void;
-    connect(): void;
-    disconnect(): void;
-}
-export type WireAdapterSchemaValue = 'optional' | 'required';
-export declare function getAdapterToken(adapter: WireAdapterConstructor): string | undefined;
-export declare function setAdapterToken(adapter: WireAdapterConstructor, token: string): void;
-export type ContextValue = Record<string, any>;
-export type ConfigCallback = (component: LightningElement) => ConfigValue;
-export interface WireAdapterConstructor {
-    new (callback: DataCallback): WireAdapter;
-    configSchema?: Record<string, WireAdapterSchemaValue>;
-    contextSchema?: Record<string, WireAdapterSchemaValue>;
-}
-export declare function storeWiredMethodMeta(descriptor: PropertyDescriptor, adapter: WireAdapterConstructor, configCallback: ConfigCallback, dynamic: string[]): void;
-export declare function storeWiredFieldMeta(descriptor: PropertyDescriptor, adapter: WireAdapterConstructor, configCallback: ConfigCallback, dynamic: string[]): void;
-export declare function installWireAdapters(vm: VM): void;
-export declare function connectWireAdapters(vm: VM): void;
-export declare function disconnectWireAdapters(vm: VM): void;
-export {};