@lwc/engine-core 3.1.2 → 3.2.0

package/dist/index.js

@@ -1,7 +1,7 @@
 /**
  * Copyright (C) 2023 salesforce.com, inc.
  */
-import { noop, StringToLowerCase, isNull, ArrayPush as ArrayPush$1, ArrayJoin, isFrozen, isUndefined as isUndefined$1, defineProperty, ArrayIndexOf, ArraySplice, create, seal, isArray as isArray$1, isFunction as isFunction$1, keys, hasOwnProperty as hasOwnProperty$1, globalThis as globalThis$1, forEach, AriaPropNameToAttrNameMap, getPropertyDescriptor, defineProperties, getPrototypeOf as getPrototypeOf$1, setPrototypeOf, assign, isObject, freeze, KEY__SYNTHETIC_MODE, assert, toString as toString$1, getOwnPropertyDescriptor as getOwnPropertyDescriptor$1, isFalse, LWC_VERSION_COMMENT_REGEX, LWC_VERSION, getOwnPropertyNames as getOwnPropertyNames$1, htmlPropertyToAttribute, ArraySlice, ArrayMap, KEY__SCOPED_CSS, kebabCaseToCamelCase, StringCharCodeAt, XML_NAMESPACE, XLINK_NAMESPACE, isString, StringSlice, isTrue, SVG_NAMESPACE, KEY__SHADOW_STATIC, KEY__SHADOW_RESOLVER, ArraySome, ArrayPop, isNumber, StringReplace, ArrayUnshift, LOWEST_API_VERSION, KEY__NATIVE_GET_ELEMENT_BY_ID, KEY__NATIVE_QUERY_SELECTOR_ALL, ID_REFERENCING_ATTRIBUTES_SET, KEY__SHADOW_TOKEN, ArrayFilter, StringSplit, arrayEvery, ArrayIncludes, ArrayCopyWithin, ArrayFill, ArraySort, ArrayReverse, ArrayShift } from '@lwc/shared';
+import { noop, StringToLowerCase, isNull, ArrayPush as ArrayPush$1, ArrayJoin, isFrozen, isUndefined as isUndefined$1, defineProperty, ArrayIndexOf, ArraySplice, create, seal, isArray as isArray$1, isFunction as isFunction$1, keys, hasOwnProperty as hasOwnProperty$1, globalThis as globalThis$1, forEach, AriaPropNameToAttrNameMap, getPropertyDescriptor, defineProperties, getPrototypeOf as getPrototypeOf$1, setPrototypeOf, assign, isObject, isFalse, freeze, KEY__SYNTHETIC_MODE, assert, toString as toString$1, getOwnPropertyDescriptor as getOwnPropertyDescriptor$1, LWC_VERSION_COMMENT_REGEX, LWC_VERSION, getOwnPropertyNames as getOwnPropertyNames$1, htmlPropertyToAttribute, ArraySlice, ArrayMap, KEY__SCOPED_CSS, kebabCaseToCamelCase, StringCharCodeAt, XML_NAMESPACE, XLINK_NAMESPACE, isString, StringSlice, isTrue, SVG_NAMESPACE, KEY__SHADOW_STATIC, KEY__SHADOW_RESOLVER, ArraySome, ArrayPop, isNumber, StringReplace, ArrayUnshift, LOWEST_API_VERSION, KEY__NATIVE_GET_ELEMENT_BY_ID, KEY__NATIVE_QUERY_SELECTOR_ALL, ID_REFERENCING_ATTRIBUTES_SET, KEY__SHADOW_TOKEN, ArrayFilter, StringSplit, arrayEvery, ArrayIncludes, ArrayCopyWithin, ArrayFill, ArraySort, ArrayReverse, ArrayShift } from '@lwc/shared';
 import { applyAriaReflection } from '@lwc/aria-reflection';
 export { setFeatureFlag, setFeatureFlagForTest } from '@lwc/features';
 
@@ -1454,6 +1454,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,
@@ -1545,6 +1546,18 @@ LightningElement.prototype = {
         }
         return getBoundingClientRect(elm);
     },
+    attachInternals() {
+        const vm = getAssociatedVM(this);
+        const { elm, renderer: { attachInternals }, } = vm;
+        if (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;
@@ -2586,6 +2599,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.
     defineProperty(HTMLBridgeElement, 'observedAttributes', {
@@ -5350,7 +5371,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
@@ -5411,8 +5432,8 @@ function removeVM(vm) {
     }
     resetComponentStateWhenRemoved(vm);
 }
-function getNearestShadowAncestor(vm) {
-    let ancestor = vm.owner;
+function getNearestShadowAncestor(owner) {
+    let ancestor = owner;
     while (!isNull(ancestor) && ancestor.renderMode === 0 /* RenderMode.Light */) {
         ancestor = ancestor.owner;
     }
@@ -5468,15 +5489,12 @@ function createVM(elm, ctor, renderer, options) {
         vm.debugInfo = 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);
@@ -5539,9 +5557,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 */) {
@@ -5549,34 +5580,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 (!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 (!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 */;
         }
     }
@@ -6887,6 +6909,6 @@ function readonly(obj) {
     return getReadOnlyProxy(obj);
 }
 
-export { LightningElement, profilerControl as __unstable__ProfilerControl, reportingControl as __unstable__ReportingControl, api$1 as api, connectRootElement, createContextProviderWithRegister, createVM, disconnectRootElement, freezeTemplate, getAssociatedVMIfPresent, getComponentAPIVersion, getComponentConstructor, getComponentDef, getComponentHtmlPrototype, hydrateRoot, isComponentConstructor, parseFragment, parseSVGFragment, readonly, register, registerComponent, registerDecorators, registerTemplate, sanitizeAttribute, setHooks, swapComponent, swapStyle, swapTemplate, track, unwrap, wire };
-/** version: 3.1.2 */
+export { LightningElement, profilerControl as __unstable__ProfilerControl, reportingControl as __unstable__ReportingControl, api$1 as api, computeShadowAndRenderMode, connectRootElement, createContextProviderWithRegister, createVM, disconnectRootElement, freezeTemplate, getAssociatedVMIfPresent, getComponentAPIVersion, getComponentConstructor, getComponentDef, getComponentHtmlPrototype, hydrateRoot, isComponentConstructor, parseFragment, parseSVGFragment, readonly, register, registerComponent, registerDecorators, registerTemplate, sanitizeAttribute, setHooks, swapComponent, swapStyle, swapTemplate, track, unwrap, wire };
+/** version: 3.2.0 */
 //# sourceMappingURL=index.js.map