@lwc/engine-core 4.0.0-alpha.0 → 4.0.0

package/README.md

@@ -96,11 +96,6 @@ This experimental API enables the identification of LWC constructors.
 This experimental API enables the creation of a reactive readonly membrane around any object
 value.
 
-### register()
-
-This experimental API enables the registration of 'services' in LWC by exposing hooks into the
-component life-cycle.
-
 ### setHooks()
 
 This experimental API allows setting overridable hooks with an application specific implementation.

package/dist/framework/api.d.ts

@@ -1,8 +1,9 @@
 import { SlotSet } from './vm';
 import { LightningElementConstructor } from './base-lightning-element';
-import { Key, VComment, VCustomElement, VElement, VElementData, VFragment, VNode, VNodes, VScopedSlotFragment, VStatic, VStaticElementData, VText } from './vnodes';
+import { Key, VComment, VCustomElement, VElement, VElementData, VFragment, VNode, VNodes, VScopedSlotFragment, VStatic, VText, VStaticPart, VStaticPartData } from './vnodes';
+declare function sp(partId: number, data: VStaticPartData): VStaticPart;
 declare function ssf(slotName: unknown, factory: (value: any, key: any) => VFragment): VScopedSlotFragment;
-declare function st(fragment: Element, key: Key, data?: VStaticElementData): VStatic;
+declare function st(fragment: Element, key: Key, parts?: VStaticPart[]): VStatic;
 declare function fr(key: Key, children: VNodes, stable: 0 | 1): VFragment;
 declare function h(sel: string, data: VElementData, children?: VNodes): VElement;
 declare function ti(value: any): number;
@@ -56,6 +57,7 @@ declare const api: Readonly<{
     shc: typeof shc;
     ssf: typeof ssf;
     ddc: typeof ddc;
+    sp: typeof sp;
 }>;
 export default api;
 export type RenderAPI = typeof api;

package/dist/framework/base-bridge-element.d.ts

@@ -1,6 +1,7 @@
+import { LightningElement } from './base-lightning-element';
 export interface HTMLElementConstructor {
     prototype: HTMLElement;
     new (): HTMLElement;
 }
-export declare function HTMLBridgeElementFactory(SuperClass: HTMLElementConstructor, props: string[], methods: string[]): HTMLElementConstructor;
+export declare function HTMLBridgeElementFactory(SuperClass: HTMLElementConstructor, publicProperties: string[], methods: string[], observedFields: string[], proto: LightningElement | null, hasCustomSuperClass: boolean): HTMLElementConstructor;
 export declare const BaseBridgeElement: HTMLElementConstructor;

package/dist/framework/base-lightning-element.d.ts

@@ -17,10 +17,11 @@ export interface LightningElementConstructor {
     readonly CustomElementConstructor: HTMLElementConstructor;
     delegatesFocus?: boolean;
     renderMode?: 'light' | 'shadow';
+    formAssociated?: boolean;
     shadowSupportMode?: ShadowSupportMode;
     stylesheets: TemplateStylesheetFactories;
 }
-type HTMLElementTheGoodParts = Pick<Object, 'toString'> & Pick<HTMLElement, 'accessKey' | 'addEventListener' | 'children' | 'childNodes' | 'classList' | 'dir' | 'dispatchEvent' | 'draggable' | 'firstChild' | 'firstElementChild' | 'getAttribute' | 'getAttributeNS' | 'getBoundingClientRect' | 'getElementsByClassName' | 'getElementsByTagName' | 'hasAttribute' | 'hasAttributeNS' | 'hidden' | 'id' | 'isConnected' | 'lang' | 'lastChild' | 'lastElementChild' | 'ownerDocument' | 'querySelector' | 'querySelectorAll' | 'removeAttribute' | 'removeAttributeNS' | 'removeEventListener' | 'setAttribute' | 'setAttributeNS' | 'spellcheck' | 'tabIndex' | 'tagName' | 'title'>;
+type HTMLElementTheGoodParts = Pick<Object, 'toString'> & Pick<HTMLElement, 'accessKey' | 'addEventListener' | 'attachInternals' | 'children' | 'childNodes' | 'classList' | 'dir' | 'dispatchEvent' | 'draggable' | 'firstChild' | 'firstElementChild' | 'getAttribute' | 'getAttributeNS' | 'getBoundingClientRect' | 'getElementsByClassName' | 'getElementsByTagName' | 'hasAttribute' | 'hasAttributeNS' | 'hidden' | 'id' | 'isConnected' | 'lang' | 'lastChild' | 'lastElementChild' | 'ownerDocument' | 'querySelector' | 'querySelectorAll' | 'removeAttribute' | 'removeAttributeNS' | 'removeEventListener' | 'setAttribute' | 'setAttributeNS' | 'spellcheck' | 'tabIndex' | 'tagName' | 'title'>;
 type RefNodes = {
     [name: string]: Element;
 };
@@ -32,6 +33,10 @@ export interface LightningElement extends HTMLElementTheGoodParts, AccessibleEle
     disconnectedCallback?(): void;
     renderedCallback?(): void;
     errorCallback?(error: any, stack: string): void;
+    formAssociatedCallback?(): void;
+    formResetCallback?(): void;
+    formDisabledCallback?(): void;
+    formStateRestoreCallback?(): void;
 }
 /**
  * This class is the base class for any LWC element.

package/dist/framework/def.d.ts

@@ -20,12 +20,17 @@ export interface ComponentDef {
     template: Template;
     renderMode: RenderMode;
     shadowSupportMode: ShadowSupportMode;
+    formAssociated: boolean | undefined;
     ctor: LightningElementConstructor;
     bridge: HTMLElementConstructor;
     connectedCallback?: LightningElement['connectedCallback'];
     disconnectedCallback?: LightningElement['disconnectedCallback'];
     renderedCallback?: LightningElement['renderedCallback'];
     errorCallback?: LightningElement['errorCallback'];
+    formAssociatedCallback?: LightningElement['formAssociatedCallback'];
+    formResetCallback?: LightningElement['formResetCallback'];
+    formDisabledCallback?: LightningElement['formDisabledCallback'];
+    formStateRestoreCallback?: LightningElement['formStateRestoreCallback'];
     render: LightningElement['render'];
 }
 /**

package/dist/framework/main.d.ts

@@ -1,5 +1,5 @@
 export { getComponentHtmlPrototype } from './def';
-export { createVM, connectRootElement, disconnectRootElement, getAssociatedVMIfPresent, } from './vm';
+export { RenderMode, ShadowMode, connectRootElement, createVM, disconnectRootElement, getAssociatedVMIfPresent, computeShadowAndRenderMode, runFormAssociatedCallback, runFormDisabledCallback, runFormResetCallback, runFormStateRestoreCallback, } from './vm';
 export { createContextProviderWithRegister } from './wiring';
 export { parseFragment, parseSVGFragment } from './template';
 export { hydrateRoot } from './hydration';
@@ -18,7 +18,6 @@ export { getComponentConstructor } from './get-component-constructor';
 export type { RendererAPI, LifecycleCallback } from './renderer';
 export type { ConfigValue as WireConfigValue, ContextValue as WireContextValue, DataCallback, WireAdapter, WireAdapterConstructor, WireAdapterSchemaValue, WireContextSubscriptionPayload, WireContextSubscriptionCallback, } from './wiring';
 export { LightningElement } from './base-lightning-element';
-export { register } from './services';
 export { default as api } from './decorators/api';
 export { default as track } from './decorators/track';
 export { default as wire } from './decorators/wire';

package/dist/framework/modules/events.d.ts

@@ -1,3 +1,3 @@
 import { RendererAPI } from '../renderer';
-import { VBaseElement, VStatic } from '../vnodes';
-export declare function applyEventListeners(vnode: VBaseElement | VStatic, renderer: RendererAPI): void;
+import { VBaseElement, VStaticPart } from '../vnodes';
+export declare function applyEventListeners(vnode: VBaseElement | VStaticPart, renderer: RendererAPI): void;

package/dist/framework/modules/refs.d.ts

@@ -0,0 +1,3 @@
+import { VM } from '../vm';
+import { VBaseElement, VStaticPart } from '../vnodes';
+export declare function applyRefs(vnode: VBaseElement | VStaticPart, owner: VM): void;

package/dist/framework/modules/static-parts.d.ts

@@ -0,0 +1,11 @@
+import { VStatic } from '../vnodes';
+import { RendererAPI } from '../renderer';
+/**
+ * Given an array of static parts, do all the mounting required for these parts.
+ *
+ * @param root - the root element
+ * @param vnode - the parent VStatic
+ * @param renderer - the renderer to use
+ * @param mount - true this is a first (mount) render as opposed to a subsequent (patch) render
+ */
+export declare function applyStaticParts(root: Element, vnode: VStatic, renderer: RendererAPI, mount: boolean): void;

package/dist/framework/renderer.d.ts

@@ -14,6 +14,7 @@ export interface RendererAPI {
     createText: (content: string) => N;
     createComment: (content: string) => N;
     nextSibling: (node: N) => N | null;
+    previousSibling: (node: N) => N | null;
     attachShadow: (element: E, options: ShadowRootInit) => N;
     getProperty: (node: N, key: string) => any;
     setProperty: (node: N, key: string, value: any) => void;
@@ -41,8 +42,10 @@ export interface RendererAPI {
     isConnected: (node: N) => boolean;
     insertStylesheet: (content: string, target?: ShadowRoot) => void;
     assertInstanceOfHTMLElement: (elm: any, msg: string) => void;
-    createCustomElement: (tagName: string, upgradeCallback: LifecycleCallback, connectedCallback: LifecycleCallback, disconnectedCallback: LifecycleCallback) => E;
+    createCustomElement: (tagName: string, upgradeCallback: LifecycleCallback, connectedCallback?: LifecycleCallback, disconnectedCallback?: LifecycleCallback, formAssociatedCallback?: LifecycleCallback, formDisabledCallback?: LifecycleCallback, formResetCallback?: LifecycleCallback, formStateRestoreCallback?: LifecycleCallback) => E;
+    defineCustomElement: (tagName: string, connectedCallback?: LifecycleCallback, disconnectedCallback?: LifecycleCallback) => void;
     ownerDocument(elm: E): Document;
     registerContextConsumer: (element: E, adapterContextToken: string, subscriptionPayload: WireContextSubscriptionPayload) => void;
+    attachInternals: (elm: E) => ElementInternals;
 }
 export {};

package/dist/framework/stylesheet.d.ts

@@ -12,14 +12,14 @@ export type StylesheetFactory = (stylesheetToken: string | undefined, useActualH
  * @import CSS declaration).
  */
 export type TemplateStylesheetFactories = Array<StylesheetFactory | TemplateStylesheetFactories>;
-export declare function updateStylesheetToken(vm: VM, template: Template): void;
+export declare function updateStylesheetToken(vm: VM, template: Template, legacy: boolean): void;
 export declare function getStylesheetsContent(vm: VM, template: Template): string[];
 /**
  * If the component that is currently being rendered uses scoped styles,
  * this returns the unique token for that scoped stylesheet. Otherwise
  * it returns null.
  */
-export declare function getScopeTokenClass(owner: VM): string | null;
+export declare function getScopeTokenClass(owner: VM, legacy: boolean): string | null;
 /**
  * This function returns the host style token for a custom element if it
  * exists. Otherwise it returns null.

package/dist/framework/template.d.ts

@@ -10,6 +10,8 @@ export interface Template {
     stylesheets?: TemplateStylesheetFactories;
     /** The string used for synthetic shadow style scoping and light DOM style scoping. */
     stylesheetToken?: string;
+    /** Same as the above, but for legacy use cases (pre-LWC v3.0.0) */
+    legacyStylesheetToken?: string;
     /** Render mode for the template. Could be light or undefined (which means it's shadow) */
     renderMode?: 'light';
     /** True if this template contains template refs, undefined or false otherwise */

package/dist/framework/utils.d.ts

@@ -1,6 +1,4 @@
 import { StylesheetFactory, TemplateStylesheetFactories } from './stylesheet';
-import { VM } from './vm';
-import { VBaseElement, VStatic } from './vnodes';
 type Callback = () => void;
 export declare const SPACE_CHAR = 32;
 export declare const EmptyObject: any;
@@ -16,6 +14,5 @@ export declare function cloneAndOmitKey(object: {
     [key: string]: any;
 };
 export declare function flattenStylesheets(stylesheets: TemplateStylesheetFactories): StylesheetFactory[];
-export declare function setRefVNode(vm: VM, ref: string, vnode: VBaseElement | VStatic): void;
 export declare function assertNotProd(): void;
 export {};

package/dist/framework/vm.d.ts

@@ -4,7 +4,7 @@ import { Template } from './template';
 import { ComponentDef } from './def';
 import { LightningElement, LightningElementConstructor } from './base-lightning-element';
 import { ReactiveObserver } from './mutation-tracker';
-import { VNodes, VCustomElement, VNode, VBaseElement, VStatic } from './vnodes';
+import { VNodes, VCustomElement, VNode, VBaseElement, VStaticPart } from './vnodes';
 import { TemplateStylesheetFactories } from './stylesheet';
 type ShadowRootMode = 'open' | 'closed';
 export interface TemplateCache {
@@ -31,7 +31,8 @@ export declare const enum ShadowMode {
 }
 export declare const enum ShadowSupportMode {
     Any = "any",
-    Default = "reset"
+    Default = "reset",
+    Native = "native"
 }
 export declare const enum LwcDomMode {
     Manual = "manual"
@@ -43,6 +44,12 @@ export interface Context {
     hasTokenInClass: boolean | undefined;
     /** True if a stylesheetToken was added to the host attributes */
     hasTokenInAttribute: boolean | undefined;
+    /** The legacy string used for synthetic shadow DOM and light DOM style scoping. */
+    legacyStylesheetToken: string | undefined;
+    /** True if a legacyStylesheetToken was added to the host class */
+    hasLegacyTokenInClass: boolean | undefined;
+    /** True if a legacyStylesheetToken was added to the host attributes */
+    hasLegacyTokenInAttribute: boolean | undefined;
     /** Whether or not light DOM scoped styles are present in the stylesheets. */
     hasScopedStyles: boolean | undefined;
     /** The VNodes injected in all the shadow trees to apply the associated component stylesheets. */
@@ -56,7 +63,7 @@ export interface Context {
     wiredDisconnecting: Array<() => void>;
 }
 export type RefVNodes = {
-    [name: string]: VBaseElement | VStatic;
+    [name: string]: VBaseElement | VStaticPart;
 };
 export interface VM<N = HostNode, E = HostElement> {
     /** The host element */
@@ -152,6 +159,10 @@ export declare function createVM<HostNode, HostElement>(elm: HostElement, ctor:
     tagName: string;
     hydrated?: boolean;
 }): VM;
+export declare function computeShadowAndRenderMode(Ctor: LightningElementConstructor, renderer: RendererAPI): {
+    renderMode: RenderMode;
+    shadowMode: ShadowMode;
+};
 export declare function associateVM(obj: VMAssociable, vm: VM): void;
 export declare function getAssociatedVM(obj: VMAssociable): VM;
 export declare function getAssociatedVMIfPresent(obj: VMAssociable): VM | undefined;
@@ -161,4 +172,10 @@ export declare function resetComponentRoot(vm: VM): void;
 export declare function scheduleRehydration(vm: VM): void;
 export declare function runWithBoundaryProtection(vm: VM, owner: VM | null, pre: () => void, job: () => void, post: () => void): void;
 export declare function forceRehydration(vm: VM): void;
+export declare function runFormAssociatedCustomElementCallback(vm: VM, faceCb: () => void): void;
+export declare function runFormAssociatedCallback(elm: HTMLElement): void;
+export declare function runFormDisabledCallback(elm: HTMLElement): void;
+export declare function runFormResetCallback(elm: HTMLElement): void;
+export declare function runFormStateRestoreCallback(elm: HTMLElement): void;
+export declare function resetRefVNodes(vm: VM): void;
 export {};

package/dist/framework/vnodes.d.ts

@@ -27,13 +27,18 @@ export interface VScopedSlotFragment extends BaseVNode {
     type: VNodeType.ScopedSlotFragment;
     slotName: unknown;
 }
-export type VStaticElementData = Pick<VElementData, 'on' | 'ref'>;
+export interface VStaticPart {
+    readonly partId: number;
+    readonly data: VStaticPartData;
+    elm: Element | undefined;
+}
+export type VStaticPartData = Pick<VElementData, 'on' | 'ref'>;
 export interface VStatic extends BaseVNode {
     readonly type: VNodeType.Static;
     readonly sel: undefined;
     readonly key: Key;
     readonly fragment: Element;
-    readonly data: VStaticElementData | undefined;
+    readonly parts: VStaticPart[] | undefined;
     elm: Element | undefined;
 }
 export interface VFragment extends BaseVNode, BaseVParent {
@@ -82,7 +87,6 @@ export interface VNodeData {
     readonly on?: Readonly<Record<string, (event: Event) => any>>;
     readonly svg?: boolean;
     readonly renderer?: RendererAPI;
-    readonly spread?: Readonly<Record<string, any>>;
 }
 export interface VElementData extends VNodeData {
     readonly key: Key;