@lwc/engine-core 8.22.6 → 8.24.0

package/dist/framework/component.d.ts

@@ -8,6 +8,11 @@ type ComponentConstructorMetadata = {
     tmpl: Template;
     sel: string;
     apiVersion: APIVersion;
+    enableSyntheticElementInternals?: boolean | undefined;
+    componentFeatureFlag?: {
+        value: boolean;
+        path: string;
+    } | undefined;
 };
 /**
  * INTERNAL: This function can only be invoked by compiled code. The compiler
@@ -19,6 +24,9 @@ export declare function registerComponent(Ctor: any, metadata: ComponentConstruc
 export declare function getComponentRegisteredTemplate(Ctor: LightningElementConstructor): Template | undefined;
 export declare function getComponentRegisteredName(Ctor: LightningElementConstructor): string | undefined;
 export declare function getComponentAPIVersion(Ctor: LightningElementConstructor): APIVersion;
+export declare function supportsSyntheticElementInternals(Ctor: LightningElementConstructor): boolean;
+export declare function isComponentFeatureEnabled(Ctor: LightningElementConstructor): boolean;
+export declare function getComponentMetadata(Ctor: LightningElementConstructor): ComponentConstructorMetadata | undefined;
 export declare function getTemplateReactiveObserver(vm: VM): ReactiveObserver;
 export declare function resetTemplateObserverAndUnsubscribe(vm: VM): void;
 export declare function renderComponent(vm: VM): VNodes;

package/dist/index.cjs.js

@@ -540,6 +540,18 @@ function unsubscribeFromSignals(target) {
         signalTracker.reset();
     }
 }
+/**
+ * A normalized string representation of an error, because browsers behave differently
+ */
+const errorWithStack = (err) => {
+    if (typeof err !== 'object' || err === null) {
+        return String(err);
+    }
+    const stack = 'stack' in err ? String(err.stack) : '';
+    const message = 'message' in err ? String(err.message) : '';
+    const constructor = err.constructor.name;
+    return stack.includes(message) ? stack : `${constructor}: ${message}\n${stack}`;
+};
 /**
  * This class is used to keep track of the signals associated to a given object.
  * It is used to prevent the LWC engine from subscribing duplicate callbacks multiple times
@@ -563,7 +575,7 @@ class SignalTracker {
             }
         }
         catch (err) {
-            logWarnOnce(`Attempted to subscribe to an object that has the shape of a signal but received the following error: ${err?.stack ?? err}`);
+            logWarnOnce(`Attempted to subscribe to an object that has the shape of a signal but received the following error: ${errorWithStack(err)}`);
         }
     }
     unsubscribeFromSignals() {
@@ -571,7 +583,7 @@ class SignalTracker {
             this.signalToUnsubscribeMap.forEach((unsubscribe) => unsubscribe());
         }
         catch (err) {
-            logWarnOnce(`Attempted to call a signal's unsubscribe callback but received the following error: ${err?.stack ?? err}`);
+            logWarnOnce(`Attempted to call a signal's unsubscribe callback but received the following error: ${errorWithStack(err)}`);
         }
     }
     reset() {
@@ -1849,16 +1861,35 @@ LightningElement.prototype = {
     },
     attachInternals() {
         const vm = getAssociatedVM(this);
-        const { elm, apiVersion, renderer: { attachInternals }, } = vm;
+        const { def: { ctor }, elm, apiVersion, renderer: { attachInternals }, } = vm;
         if (!shared.isAPIFeatureEnabled(7 /* APIFeature.ENABLE_ELEMENT_INTERNALS_AND_FACE */, apiVersion)) {
             throw new Error(`The attachInternals API is only supported in API version 61 and above. ` +
                 `The current version is ${apiVersion}. ` +
                 `To use this API, update the LWC component API version. https://lwc.dev/guide/versioning`);
         }
-        if (vm.shadowMode === 1 /* ShadowMode.Synthetic */) {
+        const internals = attachInternals(elm);
+        if (vm.shadowMode === 1 /* ShadowMode.Synthetic */ && supportsSyntheticElementInternals(ctor)) {
+            const handler = {
+                get(target, prop) {
+                    if (prop === 'shadowRoot') {
+                        return vm.shadowRoot;
+                    }
+                    const value = Reflect.get(target, prop);
+                    if (typeof value === 'function') {
+                        return value.bind(target);
+                    }
+                    return value;
+                },
+                set(target, prop, value) {
+                    return Reflect.set(target, prop, value);
+                },
+            };
+            return new Proxy(internals, handler);
+        }
+        else if (vm.shadowMode === 1 /* ShadowMode.Synthetic */) {
             throw new Error('attachInternals API is not supported in synthetic shadow.');
         }
-        return attachInternals(elm);
+        return internals;
     },
     get isConnected() {
         const vm = getAssociatedVM(this);
@@ -3723,6 +3754,13 @@ function getCtorProto(Ctor) {
     return proto;
 }
 function createComponentDef(Ctor) {
+    // Enforce component-level feature flag if provided at compile time
+    if (!isComponentFeatureEnabled(Ctor)) {
+        const metadata = getComponentMetadata(Ctor);
+        const componentName = Ctor.name || metadata?.sel || 'Unknown';
+        const componentFeatureFlagPath = metadata?.componentFeatureFlag?.path || 'Unknown';
+        throw new Error(`Component ${componentName} is disabled by the feature flag at ${componentFeatureFlagPath}.`);
+    }
     const { shadowSupportMode: ctorShadowSupportMode, renderMode: ctorRenderMode, formAssociated: ctorFormAssociated, } = Ctor;
     if (process.env.NODE_ENV !== 'production') {
         const ctorName = Ctor.name;
@@ -6693,6 +6731,17 @@ function getComponentAPIVersion(Ctor) {
     }
     return apiVersion;
 }
+function supportsSyntheticElementInternals(Ctor) {
+    return registeredComponentMap.get(Ctor)?.enableSyntheticElementInternals || false;
+}
+function isComponentFeatureEnabled(Ctor) {
+    const flag = registeredComponentMap.get(Ctor)?.componentFeatureFlag;
+    // Default to true if not provided
+    return flag?.value !== false;
+}
+function getComponentMetadata(Ctor) {
+    return registeredComponentMap.get(Ctor);
+}
 function getTemplateReactiveObserver(vm) {
     const reactiveObserver = createReactiveObserver(() => {
         const { isDirty } = vm;
@@ -7509,8 +7558,10 @@ function forceRehydration(vm) {
     }
 }
 function runFormAssociatedCustomElementCallback(vm, faceCb, args) {
-    const { renderMode, shadowMode } = vm;
-    if (shadowMode === 1 /* ShadowMode.Synthetic */ && renderMode !== 0 /* RenderMode.Light */) {
+    const { renderMode, shadowMode, def: { ctor }, } = vm;
+    if (shadowMode === 1 /* ShadowMode.Synthetic */ &&
+        renderMode !== 0 /* RenderMode.Light */ &&
+        !supportsSyntheticElementInternals(ctor)) {
         throw new Error('Form associated lifecycle methods are not available in synthetic shadow. Please use native shadow or light DOM.');
     }
     invokeComponentCallback(vm, faceCb, args);
@@ -8789,5 +8840,5 @@ exports.swapTemplate = swapTemplate;
 exports.track = track;
 exports.unwrap = unwrap;
 exports.wire = wire;
-/** version: 8.22.6 */
+/** version: 8.24.0 */
 //# sourceMappingURL=index.cjs.js.map

package/dist/index.js

@@ -537,6 +537,18 @@ function unsubscribeFromSignals(target) {
         signalTracker.reset();
     }
 }
+/**
+ * A normalized string representation of an error, because browsers behave differently
+ */
+const errorWithStack = (err) => {
+    if (typeof err !== 'object' || err === null) {
+        return String(err);
+    }
+    const stack = 'stack' in err ? String(err.stack) : '';
+    const message = 'message' in err ? String(err.message) : '';
+    const constructor = err.constructor.name;
+    return stack.includes(message) ? stack : `${constructor}: ${message}\n${stack}`;
+};
 /**
  * This class is used to keep track of the signals associated to a given object.
  * It is used to prevent the LWC engine from subscribing duplicate callbacks multiple times
@@ -560,7 +572,7 @@ class SignalTracker {
             }
         }
         catch (err) {
-            logWarnOnce(`Attempted to subscribe to an object that has the shape of a signal but received the following error: ${err?.stack ?? err}`);
+            logWarnOnce(`Attempted to subscribe to an object that has the shape of a signal but received the following error: ${errorWithStack(err)}`);
         }
     }
     unsubscribeFromSignals() {
@@ -568,7 +580,7 @@ class SignalTracker {
             this.signalToUnsubscribeMap.forEach((unsubscribe) => unsubscribe());
         }
         catch (err) {
-            logWarnOnce(`Attempted to call a signal's unsubscribe callback but received the following error: ${err?.stack ?? err}`);
+            logWarnOnce(`Attempted to call a signal's unsubscribe callback but received the following error: ${errorWithStack(err)}`);
         }
     }
     reset() {
@@ -1846,16 +1858,35 @@ LightningElement.prototype = {
     },
     attachInternals() {
         const vm = getAssociatedVM(this);
-        const { elm, apiVersion, renderer: { attachInternals }, } = vm;
+        const { def: { ctor }, elm, apiVersion, renderer: { attachInternals }, } = vm;
         if (!isAPIFeatureEnabled(7 /* APIFeature.ENABLE_ELEMENT_INTERNALS_AND_FACE */, apiVersion)) {
             throw new Error(`The attachInternals API is only supported in API version 61 and above. ` +
                 `The current version is ${apiVersion}. ` +
                 `To use this API, update the LWC component API version. https://lwc.dev/guide/versioning`);
         }
-        if (vm.shadowMode === 1 /* ShadowMode.Synthetic */) {
+        const internals = attachInternals(elm);
+        if (vm.shadowMode === 1 /* ShadowMode.Synthetic */ && supportsSyntheticElementInternals(ctor)) {
+            const handler = {
+                get(target, prop) {
+                    if (prop === 'shadowRoot') {
+                        return vm.shadowRoot;
+                    }
+                    const value = Reflect.get(target, prop);
+                    if (typeof value === 'function') {
+                        return value.bind(target);
+                    }
+                    return value;
+                },
+                set(target, prop, value) {
+                    return Reflect.set(target, prop, value);
+                },
+            };
+            return new Proxy(internals, handler);
+        }
+        else if (vm.shadowMode === 1 /* ShadowMode.Synthetic */) {
             throw new Error('attachInternals API is not supported in synthetic shadow.');
         }
-        return attachInternals(elm);
+        return internals;
     },
     get isConnected() {
         const vm = getAssociatedVM(this);
@@ -3720,6 +3751,13 @@ function getCtorProto(Ctor) {
     return proto;
 }
 function createComponentDef(Ctor) {
+    // Enforce component-level feature flag if provided at compile time
+    if (!isComponentFeatureEnabled(Ctor)) {
+        const metadata = getComponentMetadata(Ctor);
+        const componentName = Ctor.name || metadata?.sel || 'Unknown';
+        const componentFeatureFlagPath = metadata?.componentFeatureFlag?.path || 'Unknown';
+        throw new Error(`Component ${componentName} is disabled by the feature flag at ${componentFeatureFlagPath}.`);
+    }
     const { shadowSupportMode: ctorShadowSupportMode, renderMode: ctorRenderMode, formAssociated: ctorFormAssociated, } = Ctor;
     if (process.env.NODE_ENV !== 'production') {
         const ctorName = Ctor.name;
@@ -6690,6 +6728,17 @@ function getComponentAPIVersion(Ctor) {
     }
     return apiVersion;
 }
+function supportsSyntheticElementInternals(Ctor) {
+    return registeredComponentMap.get(Ctor)?.enableSyntheticElementInternals || false;
+}
+function isComponentFeatureEnabled(Ctor) {
+    const flag = registeredComponentMap.get(Ctor)?.componentFeatureFlag;
+    // Default to true if not provided
+    return flag?.value !== false;
+}
+function getComponentMetadata(Ctor) {
+    return registeredComponentMap.get(Ctor);
+}
 function getTemplateReactiveObserver(vm) {
     const reactiveObserver = createReactiveObserver(() => {
         const { isDirty } = vm;
@@ -7506,8 +7555,10 @@ function forceRehydration(vm) {
     }
 }
 function runFormAssociatedCustomElementCallback(vm, faceCb, args) {
-    const { renderMode, shadowMode } = vm;
-    if (shadowMode === 1 /* ShadowMode.Synthetic */ && renderMode !== 0 /* RenderMode.Light */) {
+    const { renderMode, shadowMode, def: { ctor }, } = vm;
+    if (shadowMode === 1 /* ShadowMode.Synthetic */ &&
+        renderMode !== 0 /* RenderMode.Light */ &&
+        !supportsSyntheticElementInternals(ctor)) {
         throw new Error('Form associated lifecycle methods are not available in synthetic shadow. Please use native shadow or light DOM.');
     }
     invokeComponentCallback(vm, faceCb, args);
@@ -8715,5 +8766,5 @@ function readonly(obj) {
 }
 
 export { BaseBridgeElement, 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, registerComponent, registerDecorators, registerTemplate, runFormAssociatedCallback, runFormDisabledCallback, runFormResetCallback, runFormStateRestoreCallback, sanitizeAttribute, shouldBeFormAssociated, swapComponent, swapStyle, swapTemplate, track, unwrap, wire };
-/** version: 8.22.6 */
+/** version: 8.24.0 */
 //# sourceMappingURL=index.js.map

package/package.json

@@ -4,7 +4,7 @@
         "You can safely modify dependencies, devDependencies, keywords, etc., but other props will be overwritten."
     ],
     "name": "@lwc/engine-core",
-    "version": "8.22.6",
+    "version": "8.24.0",
     "description": "Core LWC engine APIs.",
     "keywords": [
         "lwc"
@@ -46,9 +46,9 @@
         }
     },
     "dependencies": {
-        "@lwc/features": "8.22.6",
-        "@lwc/shared": "8.22.6",
-        "@lwc/signals": "8.22.6"
+        "@lwc/features": "8.24.0",
+        "@lwc/shared": "8.24.0",
+        "@lwc/signals": "8.24.0"
     },
     "devDependencies": {
         "observable-membrane": "2.0.0"