@lwc/synthetic-shadow 4.0.0-alpha.0 → 4.0.0

package/dist/faux-shadow/legacy-shadow-token.d.ts

@@ -0,0 +1,2 @@
+export declare function getLegacyShadowToken(node: Node): string | undefined;
+export declare function setLegacyShadowToken(node: Node, shadowToken: string | undefined): void;

package/dist/index.cjs.js

@@ -45,7 +45,7 @@ var assert = /*#__PURE__*/Object.freeze({
  * SPDX-License-Identifier: MIT
  * For full license text, see the LICENSE file in the repo root or https://opensource.org/licenses/MIT
  */
-const { assign, create, defineProperties, defineProperty, freeze, getOwnPropertyDescriptor, getOwnPropertyNames, getPrototypeOf, hasOwnProperty, isFrozen, keys, seal, setPrototypeOf, } = Object;
+const { assign, create, defineProperties, defineProperty, freeze, getOwnPropertyDescriptor, getOwnPropertyDescriptors, getOwnPropertyNames, getPrototypeOf, hasOwnProperty, isFrozen, keys, seal, setPrototypeOf, } = Object;
 const { isArray } = Array;
 const { concat: ArrayConcat, copyWithin: ArrayCopyWithin, every: ArrayEvery, fill: ArrayFill, filter: ArrayFilter, find: ArrayFind, findIndex: ArrayFindIndex, includes: ArrayIncludes, indexOf: ArrayIndexOf, join: ArrayJoin, map: ArrayMap, pop: ArrayPop, push: ArrayPush, reduce: ArrayReduce, reverse: ArrayReverse, shift: ArrayShift, slice: ArraySlice, some: ArraySome, sort: ArraySort, splice: ArraySplice, unshift: ArrayUnshift, forEach, } = Array.prototype;
 function isUndefined(obj) {
@@ -109,10 +109,13 @@ const KEY__SHADOW_STATIC = '$shadowStaticNode$';
 const KEY__SHADOW_STATIC_PRIVATE = '$shadowStaticNodeKey$';
 const KEY__SHADOW_TOKEN = '$shadowToken$';
 const KEY__SHADOW_TOKEN_PRIVATE = '$$ShadowTokenKey$$';
+// TODO [#3733]: remove support for legacy scope tokens
+const KEY__LEGACY_SHADOW_TOKEN = '$legacyShadowToken$';
+const KEY__LEGACY_SHADOW_TOKEN_PRIVATE = '$$LegacyShadowTokenKey$$';
 const KEY__SYNTHETIC_MODE = '$$lwc-synthetic-mode';
 const KEY__NATIVE_GET_ELEMENT_BY_ID = '$nativeGetElementById$';
 const KEY__NATIVE_QUERY_SELECTOR_ALL = '$nativeQuerySelectorAll$';
-/** version: 4.0.0-alpha.0 */
+/** version: 4.0.0 */
 
 /**
  * Copyright (C) 2023 salesforce.com, inc.
@@ -121,7 +124,7 @@ const KEY__NATIVE_QUERY_SELECTOR_ALL = '$nativeQuerySelectorAll$';
 if (!_globalThis.lwcRuntimeFlags) {
     Object.defineProperty(_globalThis, 'lwcRuntimeFlags', { value: create(null) });
 }
-/** version: 4.0.0-alpha.0 */
+/** version: 4.0.0 */
 
 /*
  * Copyright (c) 2018, salesforce.com, inc.
@@ -2607,13 +2610,15 @@ function isQualifiedObserver(observer, target) {
  * @param {MutationObserver} observer
  */
 function filterMutationRecords(mutations, observer) {
-    return ArrayReduce.call(mutations, (filteredSet, record) => {
-        const { target, addedNodes, removedNodes, type } = record;
+    const result = [];
+    for (const record of mutations) {
+        const { target, type } = record;
         // If target is an lwc host,
         // Determine if the mutations affected the host or the shadowRoot
         // Mutations affecting host: changes to slot content
         // Mutations affecting shadowRoot: changes to template content
         if (type === 'childList' && !isUndefined(getNodeKey(target))) {
+            const { addedNodes } = record;
             // In case of added nodes, we can climb up the tree and determine eligibility
             if (addedNodes.length > 0) {
                 // Optimization: Peek in and test one node to decide if the MutationRecord qualifies
@@ -2626,15 +2631,16 @@ function filterMutationRecords(mutations, observer) {
                     if (nodeObservers &&
                         (nodeObservers[0] === observer ||
                             ArrayIndexOf.call(nodeObservers, observer) !== -1)) {
-                        ArrayPush.call(filteredSet, record);
+                        ArrayPush.call(result, record);
                     }
                     else {
                         // else, must be observing the shadowRoot
-                        ArrayPush.call(filteredSet, retargetMutationRecord(record));
+                        ArrayPush.call(result, retargetMutationRecord(record));
                     }
                 }
             }
             else {
+                const { removedNodes } = record;
                 // In the case of removed nodes, climbing the tree is not an option as the nodes are disconnected
                 // We can only check if either the host or shadow root was observed and qualify the record
                 const shadowRoot = target.shadowRoot;
@@ -2642,14 +2648,14 @@ function filterMutationRecords(mutations, observer) {
                 if (getNodeNearestOwnerKey(target) === getNodeNearestOwnerKey(sampleNode) && // trickery: sampleNode is slot content
                     isQualifiedObserver(observer, target) // use target as a close enough reference to climb up
                 ) {
-                    ArrayPush.call(filteredSet, record);
+                    ArrayPush.call(result, record);
                 }
                 else if (shadowRoot) {
                     const shadowRootObservers = getNodeObservers(shadowRoot);
                     if (shadowRootObservers &&
                         (shadowRootObservers[0] === observer ||
                             ArrayIndexOf.call(shadowRootObservers, observer) !== -1)) {
-                        ArrayPush.call(filteredSet, retargetMutationRecord(record));
+                        ArrayPush.call(result, retargetMutationRecord(record));
                     }
                 }
             }
@@ -2658,11 +2664,11 @@ function filterMutationRecords(mutations, observer) {
             // Mutation happened under a root node(shadow root or document) and the decision is straighforward
             // Ascend the tree starting from target and check if observer is qualified
             if (isQualifiedObserver(observer, target)) {
-                ArrayPush.call(filteredSet, record);
+                ArrayPush.call(result, record);
             }
         }
-        return filteredSet;
-    }, []);
+    }
+    return result;
 }
 function getWrappedCallback(callback) {
     let wrappedCallback = callback[wrapperLookupField];
@@ -4099,6 +4105,40 @@ defineProperty(Element.prototype, KEY__SHADOW_STATIC, {
     configurable: true,
 });
 
+/*
+ * 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
+ */
+// TODO [#3733]: remove this entire file when we can remove legacy scope tokens
+function getLegacyShadowToken(node) {
+    return node[KEY__LEGACY_SHADOW_TOKEN];
+}
+function setLegacyShadowToken(node, shadowToken) {
+    node[KEY__LEGACY_SHADOW_TOKEN] = shadowToken;
+}
+/**
+ * Patching Element.prototype.$legacyShadowToken$ to mark elements a portal:
+ * Same as $shadowToken$ but for legacy CSS scope tokens.
+ **/
+defineProperty(Element.prototype, KEY__LEGACY_SHADOW_TOKEN, {
+    set(shadowToken) {
+        const oldShadowToken = this[KEY__LEGACY_SHADOW_TOKEN_PRIVATE];
+        if (!isUndefined(oldShadowToken) && oldShadowToken !== shadowToken) {
+            removeAttribute.call(this, oldShadowToken);
+        }
+        if (!isUndefined(shadowToken)) {
+            setAttribute.call(this, shadowToken, '');
+        }
+        this[KEY__LEGACY_SHADOW_TOKEN_PRIVATE] = shadowToken;
+    },
+    get() {
+        return this[KEY__LEGACY_SHADOW_TOKEN_PRIVATE];
+    },
+    configurable: true,
+});
+
 /*
  * Copyright (c) 2018, salesforce.com, inc.
  * All rights reserved.
@@ -4116,7 +4156,8 @@ let portalObserver;
 const portalObserverConfig = {
     childList: true,
 };
-function adoptChildNode(node, fn, shadowToken) {
+// TODO [#3733]: remove support for legacy scope tokens
+function adoptChildNode(node, fn, shadowToken, legacyShadowToken) {
     const previousNodeShadowResolver = getShadowRootResolver(node);
     if (previousNodeShadowResolver === fn) {
         return; // nothing to do here, it is already correctly patched
@@ -4124,6 +4165,9 @@ function adoptChildNode(node, fn, shadowToken) {
     setShadowRootResolver(node, fn);
     if (node instanceof Element) {
         setShadowToken(node, shadowToken);
+        if (lwcRuntimeFlags.ENABLE_LEGACY_SCOPE_TOKENS) {
+            setLegacyShadowToken(node, legacyShadowToken);
+        }
         if (isSyntheticShadowHost(node)) {
             // Root LWC elements can't get content slotted into them, therefore we don't observe their children.
             return;
@@ -4135,7 +4179,7 @@ function adoptChildNode(node, fn, shadowToken) {
         // recursively patching all children as well
         const childNodes = childNodesGetter.call(node);
         for (let i = 0, len = childNodes.length; i < len; i += 1) {
-            adoptChildNode(childNodes[i], fn, shadowToken);
+            adoptChildNode(childNodes[i], fn, shadowToken, legacyShadowToken);
         }
     }
 }
@@ -4156,17 +4200,20 @@ function initPortalObserver() {
             // the target of the mutation should always have a ShadowRootResolver attached to it
             const fn = getShadowRootResolver(elm);
             const shadowToken = getShadowToken(elm);
+            const legacyShadowToken = lwcRuntimeFlags.ENABLE_LEGACY_SCOPE_TOKENS
+                ? getLegacyShadowToken(elm)
+                : undefined;
             // Process removals first to handle the case where an element is removed and reinserted
             for (let i = 0, len = removedNodes.length; i < len; i += 1) {
                 const node = removedNodes[i];
                 if (!(compareDocumentPosition.call(elm, node) & _Node.DOCUMENT_POSITION_CONTAINED_BY)) {
-                    adoptChildNode(node, DocumentResolverFn, undefined);
+                    adoptChildNode(node, DocumentResolverFn, undefined, undefined);
                 }
             }
             for (let i = 0, len = addedNodes.length; i < len; i += 1) {
                 const node = addedNodes[i];
                 if (compareDocumentPosition.call(elm, node) & _Node.DOCUMENT_POSITION_CONTAINED_BY) {
-                    adoptChildNode(node, fn, shadowToken);
+                    adoptChildNode(node, fn, shadowToken, legacyShadowToken);
                 }
             }
         });
@@ -4213,5 +4260,5 @@ defineProperty(Element.prototype, '$domManual$', {
     },
     configurable: true,
 });
-/** version: 4.0.0-alpha.0 */
+/** version: 4.0.0 */
 //# sourceMappingURL=index.cjs.js.map