@lwc/engine-core 5.1.0 → 5.2.0

package/dist/framework/reporting.d.ts

@@ -1,10 +1,12 @@
+import { ShadowMode } from './vm';
 export declare const enum ReportingEventId {
     CrossRootAriaInSyntheticShadow = "CrossRootAriaInSyntheticShadow",
     CompilerRuntimeVersionMismatch = "CompilerRuntimeVersionMismatch",
     NonStandardAriaReflection = "NonStandardAriaReflection",
     TemplateMutation = "TemplateMutation",
     StylesheetMutation = "StylesheetMutation",
-    ConnectedCallbackWhileDisconnected = "ConnectedCallbackWhileDisconnected"
+    ConnectedCallbackWhileDisconnected = "ConnectedCallbackWhileDisconnected",
+    ShadowModeUsage = "ShadowModeUsage"
 }
 export interface BasePayload {
     tagName?: string;
@@ -29,6 +31,9 @@ export interface StylesheetMutationPayload extends BasePayload {
 }
 export interface ConnectedCallbackWhileDisconnectedPayload extends BasePayload {
 }
+export interface ShadowModeUsagePayload extends BasePayload {
+    mode: ShadowMode;
+}
 export type ReportingPayloadMapping = {
     [ReportingEventId.CrossRootAriaInSyntheticShadow]: CrossRootAriaInSyntheticShadowPayload;
     [ReportingEventId.CompilerRuntimeVersionMismatch]: CompilerRuntimeVersionMismatchPayload;
@@ -36,6 +41,7 @@ export type ReportingPayloadMapping = {
     [ReportingEventId.TemplateMutation]: TemplateMutationPayload;
     [ReportingEventId.StylesheetMutation]: StylesheetMutationPayload;
     [ReportingEventId.ConnectedCallbackWhileDisconnected]: ConnectedCallbackWhileDisconnectedPayload;
+    [ReportingEventId.ShadowModeUsage]: ShadowModeUsagePayload;
 };
 export type ReportingDispatcher<T extends ReportingEventId = ReportingEventId> = (reportingEventId: T, payload: ReportingPayloadMapping[T]) => void;
 /** Callbacks to invoke when reporting is enabled **/

package/dist/framework/shadow-migration-mode.d.ts

@@ -0,0 +1 @@
+export declare function applyShadowMigrateMode(shadowRoot: ShadowRoot): void;

package/dist/framework/vm.d.ts

@@ -83,6 +83,8 @@ export interface VM<N = HostNode, E = HostElement> {
     /** Rendering operations associated with the VM */
     renderMode: RenderMode;
     shadowMode: ShadowMode;
+    /** True if shadow migrate mode is in effect, i.e. this is native with synthetic-like modifications */
+    shadowMigrateMode: boolean;
     /** The component creation index. */
     idx: number;
     /** Component state, analogous to Element.isConnected */

package/dist/index.cjs.js

@@ -1354,6 +1354,77 @@ function markLockerLiveObject(obj) {
     }
 }
 
+/*
+ * 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
+ */
+let globalStylesheet;
+function isStyleElement(elm) {
+    return elm.tagName === 'STYLE';
+}
+async function fetchStylesheet(elm) {
+    if (isStyleElement(elm)) {
+        return elm.textContent;
+    }
+    else {
+        // <link>
+        const { href } = elm;
+        try {
+            return await (await fetch(href)).text();
+        }
+        catch (err) {
+            logWarnOnce(`Ignoring cross-origin stylesheet in migrate mode: ${href}`);
+            // ignore errors with cross-origin stylesheets - nothing we can do for those
+            return '';
+        }
+    }
+}
+function initGlobalStylesheet() {
+    const stylesheet = new CSSStyleSheet();
+    const elmsToPromises = new Map();
+    let lastSeenLength = 0;
+    const copyToGlobalStylesheet = () => {
+        const elms = document.head.querySelectorAll('style:not([data-rendered-by-lwc]),link[rel="stylesheet"]');
+        if (elms.length === lastSeenLength) {
+            return; // nothing to update
+        }
+        lastSeenLength = elms.length;
+        const promises = [...elms].map((elm) => {
+            let promise = elmsToPromises.get(elm);
+            if (!promise) {
+                // Cache the promise
+                promise = fetchStylesheet(elm);
+                elmsToPromises.set(elm, promise);
+            }
+            return promise;
+        });
+        Promise.all(promises).then((stylesheetTexts) => {
+            // When replaceSync() is called, the entire contents of the constructable stylesheet are replaced
+            // with the copied+concatenated styles. This means that any shadow root's adoptedStyleSheets that
+            // contains this constructable stylesheet will immediately get the new styles.
+            stylesheet.replaceSync(stylesheetTexts.join('\n'));
+        });
+    };
+    const headObserver = new MutationObserver(copyToGlobalStylesheet);
+    // By observing only the childList, note that we are not covering the case where someone changes an `href`
+    // on an existing <link>`, or the textContent on an existing `<style>`. This is assumed to be an uncommon
+    // case and not worth covering.
+    headObserver.observe(document.head, {
+        childList: true,
+    });
+    copyToGlobalStylesheet();
+    return stylesheet;
+}
+function applyShadowMigrateMode(shadowRoot) {
+    if (!globalStylesheet) {
+        globalStylesheet = initGlobalStylesheet();
+    }
+    shadowRoot.synthetic = true; // pretend to be synthetic mode
+    shadowRoot.adoptedStyleSheets.push(globalStylesheet);
+}
+
 /*
  * Copyright (c) 2018, salesforce.com, inc.
  * All rights reserved.
@@ -1481,6 +1552,11 @@ function doAttachShadow(vm) {
     if (process.env.NODE_ENV !== 'production') {
         patchShadowRootWithRestrictions(shadowRoot);
     }
+    if (process.env.IS_BROWSER &&
+        lwcRuntimeFlags.ENABLE_FORCE_SHADOW_MIGRATE_MODE &&
+        vm.shadowMigrateMode) {
+        applyShadowMigrateMode(shadowRoot);
+    }
     return shadowRoot;
 }
 function warnIfInvokedDuringConstruction(vm, methodOrPropName) {
@@ -3244,8 +3320,8 @@ function getComponentDef(Ctor) {
     for (const key in props) {
         // avoid leaking the reference to the public props descriptors
         publicProps[key] = {
-            config: propsConfig[key] || 0,
-            type: "any" /* PropDefType.any */,
+            config: propsConfig[key] || 0, // a property by default
+            type: "any" /* PropDefType.any */, // no type inference for public services
             attr: shared.htmlPropertyToAttribute(key),
         };
     }
@@ -3274,7 +3350,7 @@ function makeHostToken(token) {
 }
 function createInlineStyleVNode(content) {
     return api.h('style', {
-        key: 'style',
+        key: 'style', // special key
         attrs: {
             type: 'text/css',
         },
@@ -4863,7 +4939,7 @@ function c(sel, Ctor, data, children = EmptyArray) {
         key,
         ctor: Ctor,
         owner: vmBeingRendered,
-        mode: 'open',
+        mode: 'open', // TODO [#1294]: this should be defined in Ctor
         aChildren,
         vm,
     };
@@ -5767,6 +5843,7 @@ function createVM(elm, ctor, renderer, options) {
         // Properties set right after VM creation.
         tro: null,
         shadowMode: null,
+        shadowMigrateMode: false,
         stylesheets: null,
         // Properties set by the LightningElement constructor.
         component: null,
@@ -5782,8 +5859,22 @@ function createVM(elm, ctor, renderer, options) {
         vm.debugInfo = shared.create(null);
     }
     vm.stylesheets = computeStylesheets(vm, def.ctor);
-    vm.shadowMode = computeShadowMode(def, vm.owner, renderer);
+    const computedShadowMode = computeShadowMode(def, vm.owner, renderer);
+    if (lwcRuntimeFlags.ENABLE_FORCE_SHADOW_MIGRATE_MODE) {
+        vm.shadowMode = 0 /* ShadowMode.Native */;
+        vm.shadowMigrateMode = computedShadowMode === 1 /* ShadowMode.Synthetic */;
+    }
+    else {
+        vm.shadowMode = computedShadowMode;
+    }
     vm.tro = getTemplateReactiveObserver(vm);
+    // We don't need to report the shadow mode if we're rendering in light DOM
+    if (isReportingEnabled() && vm.renderMode === 1 /* RenderMode.Shadow */) {
+        report("ShadowModeUsage" /* ReportingEventId.ShadowModeUsage */, {
+            tagName: vm.tagName,
+            mode: vm.shadowMode,
+        });
+    }
     if (process.env.NODE_ENV !== 'production') {
         vm.toString = () => {
             return `[object:vm ${def.name} (${vm.idx})]`;
@@ -5867,7 +5958,8 @@ function computeShadowMode(def, owner, renderer) {
     }
     const { isSyntheticShadowDefined } = renderer;
     let shadowMode;
-    if (isSyntheticShadowDefined) {
+    // 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.
@@ -7326,5 +7418,5 @@ exports.swapTemplate = swapTemplate;
 exports.track = track;
 exports.unwrap = unwrap;
 exports.wire = wire;
-/** version: 5.1.0 */
+/** version: 5.2.0 */
 //# sourceMappingURL=index.cjs.js.map