@lwc/engine-core 3.1.2 → 3.2.0

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

@@ -20,7 +20,7 @@ export interface LightningElementConstructor {
     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;
 };

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, } from './vm';
 export { createContextProviderWithRegister } from './wiring';
 export { parseFragment, parseSVGFragment } from './template';
 export { hydrateRoot } from './hydration';

package/dist/framework/renderer.d.ts

@@ -5,7 +5,6 @@ type N = HostNode;
 type E = HostElement;
 export type LifecycleCallback = (elm: E) => void;
 export interface RendererAPI {
-    isNativeShadowDefined: boolean;
     isSyntheticShadowDefined: boolean;
     insert: (node: N, parent: E, anchor: N | null) => void;
     remove: (node: N, parent: E) => void;
@@ -45,5 +44,6 @@ export interface RendererAPI {
     createCustomElement: (tagName: string, upgradeCallback: LifecycleCallback, connectedCallback?: LifecycleCallback, disconnectedCallback?: LifecycleCallback) => E;
     ownerDocument(elm: E): Document;
     registerContextConsumer: (element: E, adapterContextToken: string, subscriptionPayload: WireContextSubscriptionPayload) => void;
+    attachInternals: (elm: E) => ElementInternals;
 }
 export {};

package/dist/framework/vm.d.ts

@@ -147,6 +147,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;

package/dist/index.cjs.js

@@ -1458,6 +1458,7 @@ function warnIfInvokedDuringConstruction(vm, methodOrPropName) {
         logError(`this.${methodOrPropName} should not be called during the construction of the custom element for ${getComponentTag(vm)} because the element is not yet in the DOM or has no children yet.`);
     }
 }
+const supportsElementInternals = typeof ElementInternals !== 'undefined';
 // @ts-ignore
 LightningElement.prototype = {
     constructor: LightningElement,
@@ -1549,6 +1550,18 @@ LightningElement.prototype = {
         }
         return getBoundingClientRect(elm);
     },
+    attachInternals() {
+        const vm = getAssociatedVM(this);
+        const { elm, renderer: { attachInternals }, } = vm;
+        if (shared.isFalse(supportsElementInternals)) {
+            // Browsers that don't support attachInternals will need to be polyfilled before LWC is loaded.
+            throw new Error('attachInternals API is not supported in this browser environment.');
+        }
+        if (vm.renderMode === 0 /* RenderMode.Light */ || vm.shadowMode === 1 /* ShadowMode.Synthetic */) {
+            throw new Error('attachInternals API is not supported in light DOM or synthetic shadow.');
+        }
+        return attachInternals(elm);
+    },
     get isConnected() {
         const vm = getAssociatedVM(this);
         const { elm, renderer: { isConnected }, } = vm;
@@ -2590,6 +2603,14 @@ function HTMLBridgeElementFactory(SuperClass, props, methods) {
     descriptors.attributeChangedCallback = {
         value: createAttributeChangedCallback(attributeToPropMap, superAttributeChangedCallback),
     };
+    // To avoid leaking private component details, accessing internals from outside a component is not allowed.
+    descriptors.attachInternals = {
+        get() {
+            if (process.env.NODE_ENV !== 'production') {
+                logError('attachInternals cannot be accessed outside of a component. Use this.attachInternals instead.');
+            }
+        },
+    };
     // Specify attributes for which we want to reflect changes back to their corresponding
     // properties via attributeChangedCallback.
     shared.defineProperty(HTMLBridgeElement, 'observedAttributes', {
@@ -5354,7 +5375,7 @@ function invokeServiceHook(vm, cbs) {
 }
 
 /*
- * Copyright (c) 2018, salesforce.com, inc.
+ * Copyright (c) 2023, Salesforce.com, inc.
  * All rights reserved.
  * SPDX-License-Identifier: MIT
  * For full license text, see the LICENSE file in the repo root or https://opensource.org/licenses/MIT
@@ -5415,8 +5436,8 @@ function removeVM(vm) {
     }
     resetComponentStateWhenRemoved(vm);
 }
-function getNearestShadowAncestor(vm) {
-    let ancestor = vm.owner;
+function getNearestShadowAncestor(owner) {
+    let ancestor = owner;
     while (!shared.isNull(ancestor) && ancestor.renderMode === 0 /* RenderMode.Light */) {
         ancestor = ancestor.owner;
     }
@@ -5472,15 +5493,12 @@ function createVM(elm, ctor, renderer, options) {
         vm.debugInfo = shared.create(null);
     }
     vm.stylesheets = computeStylesheets(vm, def.ctor);
-    vm.shadowMode = computeShadowMode(vm, renderer);
+    vm.shadowMode = computeShadowMode(def, vm.owner, renderer);
     vm.tro = getTemplateReactiveObserver(vm);
     if (process.env.NODE_ENV !== 'production') {
         vm.toString = () => {
             return `[object:vm ${def.name} (${vm.idx})]`;
         };
-        if (lwcRuntimeFlags.ENABLE_FORCE_NATIVE_SHADOW_MODE_FOR_TEST) {
-            vm.shadowMode = 0 /* ShadowMode.Native */;
-        }
     }
     // Create component instance associated to the vm and the element.
     invokeComponentConstructor(vm, def.ctor);
@@ -5543,9 +5561,22 @@ function warnOnStylesheetsMutation(ctor) {
         });
     }
 }
-function computeShadowMode(vm, renderer) {
-    const { def } = vm;
-    const { isSyntheticShadowDefined, isNativeShadowDefined } = renderer;
+// Compute the shadowMode/renderMode without creating a VM. This is used in some scenarios like hydration.
+function computeShadowAndRenderMode(Ctor, renderer) {
+    const def = getComponentInternalDef(Ctor);
+    const { renderMode } = def;
+    // Assume null `owner` - this is what happens in hydration cases anyway
+    const shadowMode = computeShadowMode(def, /* owner */ null, renderer);
+    return { renderMode, shadowMode };
+}
+function computeShadowMode(def, owner, renderer) {
+    // Force the shadow mode to always be native. Used for running tests with synthetic shadow patches
+    // on, but components running in actual native shadow mode
+    if (process.env.NODE_ENV !== 'production' &&
+        lwcRuntimeFlags.ENABLE_FORCE_NATIVE_SHADOW_MODE_FOR_TEST) {
+        return 0 /* ShadowMode.Native */;
+    }
+    const { isSyntheticShadowDefined } = renderer;
     let shadowMode;
     if (isSyntheticShadowDefined) {
         if (def.renderMode === 0 /* RenderMode.Light */) {
@@ -5553,34 +5584,25 @@ function computeShadowMode(vm, renderer) {
             // everything defaults to native when the synthetic shadow polyfill is unavailable.
             shadowMode = 0 /* ShadowMode.Native */;
         }
-        else if (isNativeShadowDefined) {
-            // Not combined with above condition because @lwc/features only supports identifiers in
-            // the if-condition.
-            if (lwcRuntimeFlags.ENABLE_MIXED_SHADOW_MODE) {
-                if (def.shadowSupportMode === "any" /* ShadowSupportMode.Any */) {
+        else if (lwcRuntimeFlags.ENABLE_MIXED_SHADOW_MODE) {
+            if (def.shadowSupportMode === "any" /* ShadowSupportMode.Any */) {
+                shadowMode = 0 /* ShadowMode.Native */;
+            }
+            else {
+                const shadowAncestor = getNearestShadowAncestor(owner);
+                if (!shared.isNull(shadowAncestor) && shadowAncestor.shadowMode === 0 /* ShadowMode.Native */) {
+                    // Transitive support for native Shadow DOM. A component in native mode
+                    // transitively opts all of its descendants into native.
                     shadowMode = 0 /* ShadowMode.Native */;
                 }
                 else {
-                    const shadowAncestor = getNearestShadowAncestor(vm);
-                    if (!shared.isNull(shadowAncestor) &&
-                        shadowAncestor.shadowMode === 0 /* ShadowMode.Native */) {
-                        // Transitive support for native Shadow DOM. A component in native mode
-                        // transitively opts all of its descendants into native.
-                        shadowMode = 0 /* ShadowMode.Native */;
-                    }
-                    else {
-                        // Synthetic if neither this component nor any of its ancestors are configured
-                        // to be native.
-                        shadowMode = 1 /* ShadowMode.Synthetic */;
-                    }
+                    // Synthetic if neither this component nor any of its ancestors are configured
+                    // to be native.
+                    shadowMode = 1 /* ShadowMode.Synthetic */;
                 }
             }
-            else {
-                shadowMode = 1 /* ShadowMode.Synthetic */;
-            }
         }
         else {
-            // Synthetic if there is no native Shadow DOM support.
             shadowMode = 1 /* ShadowMode.Synthetic */;
         }
     }
@@ -6903,6 +6925,7 @@ exports.LightningElement = LightningElement;
 exports.__unstable__ProfilerControl = profilerControl;
 exports.__unstable__ReportingControl = reportingControl;
 exports.api = api$1;
+exports.computeShadowAndRenderMode = computeShadowAndRenderMode;
 exports.connectRootElement = connectRootElement;
 exports.createContextProviderWithRegister = createContextProviderWithRegister;
 exports.createVM = createVM;
@@ -6930,5 +6953,5 @@ exports.swapTemplate = swapTemplate;
 exports.track = track;
 exports.unwrap = unwrap;
 exports.wire = wire;
-/** version: 3.1.2 */
+/** version: 3.2.0 */
 //# sourceMappingURL=index.cjs.js.map