@lwc/engine-core 6.0.0 → 6.1.1

package/dist/framework/utils.d.ts

@@ -1,5 +1,6 @@
 import { StylesheetFactory, TemplateStylesheetFactories } from './stylesheet';
 import { LightningElementConstructor } from './base-lightning-element';
+import { VElementData } from './vnodes';
 type Callback = () => void;
 export declare const SPACE_CHAR = 32;
 export declare const EmptyObject: any;
@@ -17,4 +18,23 @@ export declare function cloneAndOmitKey(object: {
 };
 export declare function flattenStylesheets(stylesheets: TemplateStylesheetFactories): StylesheetFactory[];
 export declare function assertNotProd(): void;
+export declare function applyTemporaryCompilerV5SlotFix(data: VElementData): VElementData | {
+    attrs: {
+        [key: string]: any;
+    };
+    slotAssignment: string;
+    key: import("./vnodes").Key;
+    external?: boolean | undefined;
+    ref?: string | undefined;
+    slotData?: any;
+    props?: Readonly<Record<string, any>> | undefined;
+    className?: string | undefined;
+    style?: string | undefined;
+    classMap?: Readonly<Record<string, boolean>> | undefined;
+    styleDecls?: readonly [string, string, boolean][] | undefined;
+    context?: Readonly<Record<string, Readonly<Record<string, any>>>> | undefined;
+    on?: Readonly<Record<string, (event: Event) => any>> | undefined;
+    svg?: boolean | undefined;
+    renderer?: import("./renderer").RendererAPI | undefined;
+};
 export {};

package/dist/index.cjs.js

@@ -1,5 +1,5 @@
 /**
- * Copyright (C) 2023 salesforce.com, inc.
+ * Copyright (c) 2024 Salesforce, Inc.
  */
 'use strict';
 
@@ -413,6 +413,25 @@ function assertNotProd() {
         throw new ReferenceError();
     }
 }
+// Temporary fix for when the LWC v5 compiler is used in conjunction with a v6+ engine
+// The old compiler format used the "slot" attribute in the `data` bag, whereas the new
+// format uses the special `slotAssignment` key.
+// This should be removed when the LWC v5 compiler is not used anywhere where it could be mismatched
+// with another LWC engine version.
+// TODO [#3974]: remove temporary logic to support v5 compiler + v6+ engine
+function applyTemporaryCompilerV5SlotFix(data) {
+    if (lwcRuntimeFlags.DISABLE_TEMPORARY_V5_COMPILER_SUPPORT) {
+        return data;
+    }
+    const { attrs } = data;
+    if (!shared.isUndefined(attrs)) {
+        const { slot } = attrs;
+        if (!shared.isUndefined(slot) && !shared.isNull(slot)) {
+            return Object.assign(Object.assign({}, data), { attrs: cloneAndOmitKey(attrs, 'slot'), slotAssignment: String(slot) });
+        }
+    }
+    return data;
+}
 
 /*
  * Copyright (c) 2020, salesforce.com, inc.
@@ -429,8 +448,8 @@ function isCircularModuleDependency(obj) {
 }
 
 var _a, _b;
-const instrumentDef = (_a = shared.globalThis.__lwc_instrument_cmp_def) !== null && _a !== void 0 ? _a : shared.noop;
-const instrumentInstance = (_b = shared.globalThis.__lwc_instrument_cmp_instance) !== null && _b !== void 0 ? _b : shared.noop;
+const instrumentDef = (_a = globalThis.__lwc_instrument_cmp_def) !== null && _a !== void 0 ? _a : shared.noop;
+const instrumentInstance = (_b = globalThis.__lwc_instrument_cmp_instance) !== null && _b !== void 0 ? _b : shared.noop;
 
 /*
  * Copyright (c) 2018, salesforce.com, inc.
@@ -3152,6 +3171,10 @@ function createComponentDef(Ctor) {
             ctorShadowSupportMode !== "native" /* ShadowSupportMode.Native */) {
             logError(`Invalid value for static property shadowSupportMode: '${ctorShadowSupportMode}'`);
         }
+        // TODO [#3971]: Completely remove shadowSupportMode "any"
+        if (ctorShadowSupportMode === "any" /* ShadowSupportMode.Any */) {
+            logWarn(`Invalid value 'any' for static property shadowSupportMode. 'any' is deprecated and will be removed in a future release--use 'native' instead.`);
+        }
         if (!shared.isUndefined(ctorRenderMode) &&
             ctorRenderMode !== 'light' &&
             ctorRenderMode !== 'shadow') {
@@ -4820,6 +4843,8 @@ function h(sel, data, children = EmptyArray) {
             }
         });
     }
+    // TODO [#3974]: remove temporary logic to support v5 compiler + v6+ engine
+    data = applyTemporaryCompilerV5SlotFix(data);
     const { key, slotAssignment } = data;
     const vnode = {
         type: 2 /* VNodeType.Element */,
@@ -4856,6 +4881,8 @@ function s(slotName, data, children, slotset) {
     }
     const vmBeingRendered = getVMBeingRendered();
     const { renderMode, apiVersion } = vmBeingRendered;
+    // TODO [#3974]: remove temporary logic to support v5 compiler + v6+ engine
+    data = applyTemporaryCompilerV5SlotFix(data);
     if (!shared.isUndefined(slotset) &&
         !shared.isUndefined(slotset.slotAssignments) &&
         !shared.isUndefined(slotset.slotAssignments[slotName]) &&
@@ -4959,6 +4986,8 @@ function c(sel, Ctor, data, children = EmptyArray) {
             });
         }
     }
+    // TODO [#3974]: remove temporary logic to support v5 compiler + v6+ engine
+    data = applyTemporaryCompilerV5SlotFix(data);
     const { key, slotAssignment } = data;
     let elm, aChildren, vm;
     const vnode = {
@@ -5483,7 +5512,6 @@ const parseSVGFragment = buildParseFragmentFn((html, renderer) => {
 });
 function evaluateTemplate(vm, html) {
     if (process.env.NODE_ENV !== 'production') {
-        shared.assert.isTrue(shared.isFunction(html), `evaluateTemplate() second argument must be an imported template instead of ${shared.toString(html)}`);
         // in dev-mode, we support hot swapping of templates, which means that
         // the component instance might be attempting to use an old version of
         // the template, while internally, we have a replacement for it.
@@ -5502,6 +5530,10 @@ function evaluateTemplate(vm, html) {
         tro.observe(() => {
             // Reset the cache memoizer for template when needed.
             if (html !== cmpTemplate) {
+                // Check that the template was built by the compiler.
+                if (!isTemplateRegistered(html)) {
+                    throw new TypeError(`Invalid template returned by the render() method on ${vm.tagName}. It must return an imported template (e.g.: \`import html from "./${vm.def.name}.html"\`), instead, it has returned: ${shared.toString(html)}.`);
+                }
                 if (process.env.NODE_ENV !== 'production') {
                     validateLightDomTemplate(html, vm);
                 }
@@ -5513,10 +5545,6 @@ function evaluateTemplate(vm, html) {
                     // and snabbdom just rely on the IDs.
                     resetComponentRoot(vm);
                 }
-                // Check that the template was built by the compiler.
-                if (!isTemplateRegistered(html)) {
-                    throw new TypeError(`Invalid template returned by the render() method on ${vm}. It must return an imported template (e.g.: \`import html from "./${vm.def.name}.html"\`), instead, it has returned: ${shared.toString(html)}.`);
-                }
                 vm.cmpTemplate = html;
                 // Create a brand new template cache for the swapped templated.
                 context.tplCache = shared.create(null);
@@ -5891,7 +5919,7 @@ function createVM(elm, ctor, renderer, options) {
         vm.debugInfo = shared.create(null);
     }
     vm.stylesheets = computeStylesheets(vm, def.ctor);
-    const computedShadowMode = computeShadowMode(def, vm.owner, renderer);
+    const computedShadowMode = computeShadowMode(def, vm.owner, renderer, hydrated);
     if (lwcRuntimeFlags.ENABLE_FORCE_SHADOW_MIGRATE_MODE) {
         vm.shadowMode = 0 /* ShadowMode.Native */;
         vm.shadowMigrateMode = computedShadowMode === 1 /* ShadowMode.Synthetic */;
@@ -5978,48 +6006,45 @@ 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);
+    // Also assume we are not in hydration mode for this exported API
+    const shadowMode = computeShadowMode(def, /* owner */ null, renderer, false);
     return { renderMode, shadowMode };
 }
-function computeShadowMode(def, owner, renderer) {
+function computeShadowMode(def, owner, renderer, hydrated) {
     // 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 */;
     }
+    if (shared.isTrue(hydrated)) {
+        // hydration only supports native shadow
+        return 0 /* ShadowMode.Native */;
+    }
     const { isSyntheticShadowDefined } = renderer;
     let shadowMode;
-    // If ENABLE_FORCE_SHADOW_MIGRATE_MODE is true, then ShadowMode.Synthetic here will mean "force-migrate" mode.
     if (isSyntheticShadowDefined || lwcRuntimeFlags.ENABLE_FORCE_SHADOW_MIGRATE_MODE) {
         if (def.renderMode === 0 /* RenderMode.Light */) {
             // ShadowMode.Native implies "not synthetic shadow" which is consistent with how
             // everything defaults to native when the synthetic shadow polyfill is unavailable.
             shadowMode = 0 /* ShadowMode.Native */;
         }
-        else if (lwcRuntimeFlags.ENABLE_MIXED_SHADOW_MODE ||
-            def.shadowSupportMode === "native" /* ShadowSupportMode.Native */) {
-            if (def.shadowSupportMode === "any" /* ShadowSupportMode.Any */ ||
-                def.shadowSupportMode === "native" /* ShadowSupportMode.Native */) {
+        else if (def.shadowSupportMode === "native" /* ShadowSupportMode.Native */) {
+            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(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 {
-                    // 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 {
         // Native if the synthetic shadow polyfill is unavailable.
@@ -6394,12 +6419,12 @@ function resetRefVNodes(vm) {
 // See: https://sfdc.co/synthetic-aria
 //
 // Use the unpatched native getElementById/querySelectorAll rather than the synthetic one
-const getElementById = shared.globalThis[shared.KEY__NATIVE_GET_ELEMENT_BY_ID];
-const querySelectorAll = shared.globalThis[shared.KEY__NATIVE_QUERY_SELECTOR_ALL];
+const getElementById = globalThis[shared.KEY__NATIVE_GET_ELEMENT_BY_ID];
+const querySelectorAll = globalThis[shared.KEY__NATIVE_QUERY_SELECTOR_ALL];
 // This is a "handoff" from synthetic-shadow to engine-core – we want to clean up after ourselves
 // so nobody else can misuse these global APIs.
-delete shared.globalThis[shared.KEY__NATIVE_GET_ELEMENT_BY_ID];
-delete shared.globalThis[shared.KEY__NATIVE_QUERY_SELECTOR_ALL];
+delete globalThis[shared.KEY__NATIVE_GET_ELEMENT_BY_ID];
+delete globalThis[shared.KEY__NATIVE_QUERY_SELECTOR_ALL];
 function isSyntheticShadowRootInstance(rootNode) {
     return rootNode !== document && shared.isTrue(rootNode.synthetic);
 }
@@ -7450,5 +7475,5 @@ exports.swapTemplate = swapTemplate;
 exports.track = track;
 exports.unwrap = unwrap;
 exports.wire = wire;
-/** version: 6.0.0 */
+/** version: 6.1.1 */
 //# sourceMappingURL=index.cjs.js.map