lwc 2.37.2 → 2.38.0

package/dist/engine-dom/esm/es2017/engine-dom.js

@@ -322,6 +322,24 @@ function htmlAttributeToProperty(attrName) {
     return propertyName;
 }
 
+/*
+ * Copyright (c) 2020, 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
+ */
+const ESCAPED_CHARS = {
+    '"': '"',
+    "'": ''',
+    '<': '&lt;',
+    '>': '&gt;',
+    '&': '&amp;',
+};
+function htmlEscape(str, attrMode = false) {
+    const searchValue = attrMode ? /["&]/g : /["'<>&]/g;
+    return str.replace(searchValue, (char) => ESCAPED_CHARS[char]);
+}
+
 /*
  * Copyright (c) 2018, salesforce.com, inc.
  * All rights reserved.
@@ -329,9 +347,9 @@ function htmlAttributeToProperty(attrName) {
  * For full license text, see the LICENSE file in the repo root or https://opensource.org/licenses/MIT
  */
 // Increment whenever the LWC template compiler changes
-const LWC_VERSION = "2.37.2";
+const LWC_VERSION = "2.38.0";
 const LWC_VERSION_COMMENT_REGEX = /\/\*LWC compiler v([\d.]+)\*\/\s*}/;
-/** version: 2.37.2 */
+/** version: 2.38.0 */
 
 /**
  * Copyright (C) 2018 salesforce.com, inc.
@@ -410,7 +428,7 @@ function setFeatureFlagForTest(name, value) {
         setFeatureFlag(name, value);
     }
 }
-/** version: 2.37.2 */
+/** version: 2.38.0 */
 
 /**
  * Copyright (C) 2018 salesforce.com, inc.
@@ -474,7 +492,7 @@ function applyAriaReflection(prototype = Element.prototype) {
         }
     }
 }
-/** version: 2.37.2 */
+/** version: 2.38.0 */
 
 /*
  * Copyright (c) 2018, salesforce.com, inc.
@@ -2272,6 +2290,14 @@ LightningElement.prototype = {
         }
         return renderer.getLastElementChild(vm.elm);
     },
+    get ownerDocument() {
+        const vm = getAssociatedVM(this);
+        const renderer = vm.renderer;
+        if (process.env.NODE_ENV !== 'production') {
+            warnIfInvokedDuringConstruction(vm, 'ownerDocument');
+        }
+        return renderer.ownerDocument(vm.elm);
+    },
     render() {
         const vm = getAssociatedVM(this);
         return vm.def.template;
@@ -2347,31 +2373,84 @@ function createObservedFieldPropertyDescriptor(key) {
 }
 
 /*
- * 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
  */
-const DeprecatedWiredElementHost = '$$DeprecatedWiredElementHostKey$$';
-const DeprecatedWiredParamsMeta = '$$DeprecatedWiredParamsMetaKey$$';
-const WIRE_DEBUG_ENTRY = '@wire';
-const WireMetaMap = new Map();
-class WireContextRegistrationEvent extends CustomEvent {
-    constructor(adapterToken, { setNewContext, setDisconnectedCallback }) {
-        super(adapterToken, {
-            bubbles: true,
-            composed: true,
+const AdapterToTokenMap = new Map();
+function createContextProviderWithRegister(adapter, registerContextProvider) {
+    let adapterContextToken = AdapterToTokenMap.get(adapter);
+    if (!isUndefined$1(adapterContextToken)) {
+        throw new Error(`Adapter already has a context provider.`);
+    }
+    adapterContextToken = guid();
+    AdapterToTokenMap.set(adapter, adapterContextToken);
+    const providers = new WeakSet();
+    return (elmOrComponent, options) => {
+        if (providers.has(elmOrComponent)) {
+            throw new Error(`Adapter was already installed on ${elmOrComponent}.`);
+        }
+        providers.add(elmOrComponent);
+        const { consumerConnectedCallback, consumerDisconnectedCallback } = options;
+        registerContextProvider(elmOrComponent, adapterContextToken, (subscriptionPayload) => {
+            const { setNewContext, setDisconnectedCallback } = subscriptionPayload;
+            const consumer = {
+                provide(newContext) {
+                    setNewContext(newContext);
+                },
+            };
+            const disconnectCallback = () => {
+                if (!isUndefined$1(consumerDisconnectedCallback)) {
+                    consumerDisconnectedCallback(consumer);
+                }
+            };
+            setDisconnectedCallback(disconnectCallback);
+            consumerConnectedCallback(consumer);
         });
-        defineProperties(this, {
-            setNewContext: {
-                value: setNewContext,
+    };
+}
+function createContextWatcher(vm, wireDef, callbackWhenContextIsReady) {
+    const { adapter } = wireDef;
+    const adapterContextToken = AdapterToTokenMap.get(adapter);
+    if (isUndefined$1(adapterContextToken)) {
+        return; // no provider found, nothing to be done
+    }
+    const { elm, context: { wiredConnecting, wiredDisconnecting }, renderer: { registerContextConsumer }, } = vm;
+    // waiting for the component to be connected to formally request the context via the token
+    ArrayPush$1.call(wiredConnecting, () => {
+        // This will attempt to connect the current element with one of its anscestors
+        // that can provide context for the given wire adapter. This relationship is
+        // keyed on the secret & internal value of `adapterContextToken`, which is unique
+        // to a given wire adapter.
+        //
+        // Depending on the runtime environment, this connection is made using either DOM
+        // events (in the browser) or a custom traversal (on the server).
+        registerContextConsumer(elm, adapterContextToken, {
+            setNewContext(newContext) {
+                // eslint-disable-next-line @lwc/lwc-internal/no-invalid-todo
+                // TODO: dev-mode validation of config based on the adapter.contextSchema
+                callbackWhenContextIsReady(newContext);
             },
-            setDisconnectedCallback: {
-                value: setDisconnectedCallback,
+            setDisconnectedCallback(disconnectCallback) {
+                // adds this callback into the disconnect bucket so it gets disconnected from parent
+                // the the element hosting the wire is disconnected
+                ArrayPush$1.call(wiredDisconnecting, disconnectCallback);
             },
         });
-    }
+    });
 }
+
+/*
+ * 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
+ */
+const DeprecatedWiredElementHost = '$$DeprecatedWiredElementHostKey$$';
+const DeprecatedWiredParamsMeta = '$$DeprecatedWiredParamsMetaKey$$';
+const WIRE_DEBUG_ENTRY = '@wire';
+const WireMetaMap = new Map();
 function createFieldDataCallback(vm, name) {
     return (value) => {
         updateComponentValue(vm, name, value);
@@ -2415,35 +2494,6 @@ function createConfigWatcher(component, configCallback, callbackWhenConfigIsRead
         ro,
     };
 }
-function createContextWatcher(vm, wireDef, callbackWhenContextIsReady) {
-    const { adapter } = wireDef;
-    const adapterContextToken = getAdapterToken(adapter);
-    if (isUndefined$1(adapterContextToken)) {
-        return; // no provider found, nothing to be done
-    }
-    const { elm, context: { wiredConnecting, wiredDisconnecting }, renderer: { dispatchEvent }, } = vm;
-    // waiting for the component to be connected to formally request the context via the token
-    ArrayPush$1.call(wiredConnecting, () => {
-        // This event is responsible for connecting the host element with another
-        // element in the composed path that is providing contextual data. The provider
-        // must be listening for a special dom event with the name corresponding to the value of
-        // `adapterContextToken`, which will remain secret and internal to this file only to
-        // guarantee that the linkage can be forged.
-        const contextRegistrationEvent = new WireContextRegistrationEvent(adapterContextToken, {
-            setNewContext(newContext) {
-                // eslint-disable-next-line @lwc/lwc-internal/no-invalid-todo
-                // TODO: dev-mode validation of config based on the adapter.contextSchema
-                callbackWhenContextIsReady(newContext);
-            },
-            setDisconnectedCallback(disconnectCallback) {
-                // adds this callback into the disconnect bucket so it gets disconnected from parent
-                // the the element hosting the wire is disconnected
-                ArrayPush$1.call(wiredDisconnecting, disconnectCallback);
-            },
-        });
-        dispatchEvent(elm, contextRegistrationEvent);
-    });
-}
 function createConnector(vm, name, wireDef) {
     const { method, adapter, configCallback, dynamic } = wireDef;
     let debugInfo;
@@ -2518,13 +2568,6 @@ function createConnector(vm, name, wireDef) {
         resetConfigWatcher: () => ro.reset(),
     };
 }
-const AdapterToTokenMap = new Map();
-function getAdapterToken(adapter) {
-    return AdapterToTokenMap.get(adapter);
-}
-function setAdapterToken(adapter, token) {
-    AdapterToTokenMap.set(adapter, token);
-}
 function storeWiredMethodMeta(descriptor, adapter, configCallback, dynamic) {
     // support for callable adapters
     if (adapter.adapter) {
@@ -6333,6 +6376,10 @@ function forceRehydration(vm) {
 // Use the unpatched native getElementById/querySelectorAll rather than the synthetic one
 const getElementById = _globalThis[KEY__NATIVE_GET_ELEMENT_BY_ID];
 const querySelectorAll = _globalThis[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 _globalThis[KEY__NATIVE_GET_ELEMENT_BY_ID];
+delete _globalThis[KEY__NATIVE_QUERY_SELECTOR_ALL];
 function isSyntheticShadowRootInstance(rootNode) {
     return rootNode !== document && isTrue(rootNode.synthetic);
 }
@@ -6580,67 +6627,6 @@ function enableDetection() {
     }
 }
 
-/*
- * Copyright (c) 2018, 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
- */
-// this is lwc internal implementation
-function createContextProvider(adapter) {
-    let adapterContextToken = getAdapterToken(adapter);
-    if (!isUndefined$1(adapterContextToken)) {
-        throw new Error(`Adapter already has a context provider.`);
-    }
-    adapterContextToken = guid();
-    setAdapterToken(adapter, adapterContextToken);
-    const providers = new WeakSet();
-    return (elm, options) => {
-        if (providers.has(elm)) {
-            throw new Error(`Adapter was already installed on ${elm}.`);
-        }
-        providers.add(elm);
-        const { consumerConnectedCallback, consumerDisconnectedCallback } = options;
-        elm.addEventListener(adapterContextToken, ((evt) => {
-            const { setNewContext, setDisconnectedCallback } = evt;
-            const consumer = {
-                provide(newContext) {
-                    setNewContext(newContext);
-                },
-            };
-            const disconnectCallback = () => {
-                if (!isUndefined$1(consumerDisconnectedCallback)) {
-                    consumerDisconnectedCallback(consumer);
-                }
-            };
-            setDisconnectedCallback(disconnectCallback);
-            consumerConnectedCallback(consumer);
-            evt.stopImmediatePropagation();
-        }));
-    };
-}
-
-/*
- * Copyright (c) 2018, 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
- */
-/**
- * EXPERIMENTAL: This function allows you to create a reactive readonly
- * membrane around any object value. This API is subject to change or
- * being removed.
- */
-function readonly(obj) {
-    if (process.env.NODE_ENV !== 'production') {
-        // TODO [#1292]: Remove the readonly decorator
-        if (arguments.length !== 1) {
-            assert.fail('@readonly cannot be used as a decorator just yet, use it as a function with one argument to produce a readonly version of the provided value.');
-        }
-    }
-    return getReadOnlyProxy(obj);
-}
-
 /*
  * Copyright (c) 2022, salesforce.com, inc.
  * All rights reserved.
@@ -6694,15 +6680,44 @@ function hydrateNode(node, vnode, renderer) {
     return renderer.nextSibling(hydratedNode);
 }
 const NODE_VALUE_PROP = 'nodeValue';
+const PARENT_NODE_PROP = 'parentNode';
+const TAG_NAME_PROP = 'tagName';
+function textNodeContentsAreEqual(node, vnode, renderer) {
+    const { getProperty } = renderer;
+    const nodeValue = getProperty(node, NODE_VALUE_PROP);
+    if (nodeValue === vnode.text) {
+        return true;
+    }
+    // Special case for empty text nodes – these are serialized differently on the server
+    // See https://github.com/salesforce/lwc/pull/2656
+    if (nodeValue === '\u200D' && vnode.text === '') {
+        return true;
+    }
+    // Special case for text nodes inside `<style>` tags – these are escaped when rendered server-size,
+    // but not when generated by the engine client-side.
+    const parentNode = getProperty(node, PARENT_NODE_PROP);
+    // Should never be null, but just to be safe, we check.
+    /* istanbul ignore else */
+    if (!isNull(parentNode)) {
+        const tagName = getProperty(parentNode, TAG_NAME_PROP);
+        // If the tagName is STYLE, then the following condition should always be true.
+        // The LWC compiler blocks using `<style>`s inside of templates, so it should be impossible
+        // for component authors to render different `<style>` text content on the client and server.
+        // But just to be safe, we check.
+        /* istanbul ignore next */
+        if (tagName === 'STYLE' && htmlEscape(vnode.text) === nodeValue) {
+            return true;
+        }
+    }
+    return false;
+}
 function hydrateText(node, vnode, renderer) {
     var _a;
     if (!hasCorrectNodeType(vnode, node, 3 /* EnvNodeTypes.TEXT */, renderer)) {
         return handleMismatch(node, vnode, renderer);
     }
     if (process.env.NODE_ENV !== 'production') {
-        const { getProperty } = renderer;
-        const nodeValue = getProperty(node, NODE_VALUE_PROP);
-        if (nodeValue !== vnode.text && !(nodeValue === '\u200D' && vnode.text === '')) {
+        if (!textNodeContentsAreEqual(node, vnode, renderer)) {
             logWarn('Hydration mismatch: text values do not match, will recover from the difference', vnode.owner);
         }
     }
@@ -6882,6 +6897,19 @@ function isMatchingElement(vnode, elm, renderer) {
     const hasIncompatibleStyle = validateStyleAttr(vnode, elm, renderer);
     return hasIncompatibleAttrs && hasIncompatibleClass && hasIncompatibleStyle;
 }
+function attributeValuesAreEqual(vnodeValue, value) {
+    const vnodeValueAsString = String(vnodeValue);
+    if (vnodeValueAsString === value) {
+        return true;
+    }
+    // If the expected value is null, this means that the attribute does not exist. In that case,
+    // we accept any nullish value (undefined or null).
+    if (isNull(value) && (isUndefined$1(vnodeValue) || isNull(vnodeValue))) {
+        return true;
+    }
+    // In all other cases, the two values are not considered equal
+    return false;
+}
 function validateAttrs(vnode, elm, renderer) {
     const { data: { attrs = {} }, } = vnode;
     let nodesAreCompatible = true;
@@ -6891,10 +6919,10 @@ function validateAttrs(vnode, elm, renderer) {
         const { owner } = vnode;
         const { getAttribute } = renderer;
         const elmAttrValue = getAttribute(elm, attrName);
-        if (String(attrValue) !== elmAttrValue) {
+        if (!attributeValuesAreEqual(attrValue, elmAttrValue)) {
             if (process.env.NODE_ENV !== 'production') {
                 const { getProperty } = renderer;
-                logError(`Mismatch hydrating element <${getProperty(elm, 'tagName').toLowerCase()}>: attribute "${attrName}" has different values, expected "${attrValue}" but found "${elmAttrValue}"`, owner);
+                logError(`Mismatch hydrating element <${getProperty(elm, 'tagName').toLowerCase()}>: attribute "${attrName}" has different values, expected "${attrValue}" but found ${isNull(elmAttrValue) ? 'null' : `"${elmAttrValue}"`}`, owner);
             }
             nodesAreCompatible = false;
         }
@@ -7288,7 +7316,28 @@ function getComponentConstructor(elm) {
     }
     return ctor;
 }
-/* version: 2.37.2 */
+
+/*
+ * Copyright (c) 2018, 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
+ */
+/**
+ * EXPERIMENTAL: This function allows you to create a reactive readonly
+ * membrane around any object value. This API is subject to change or
+ * being removed.
+ */
+function readonly(obj) {
+    if (process.env.NODE_ENV !== 'production') {
+        // TODO [#1292]: Remove the readonly decorator
+        if (arguments.length !== 1) {
+            assert.fail('@readonly cannot be used as a decorator just yet, use it as a function with one argument to produce a readonly version of the provided value.');
+        }
+    }
+    return getReadOnlyProxy(obj);
+}
+/* version: 2.38.0 */
 
 /*
  * Copyright (c) 2018, salesforce.com, inc.
@@ -7716,7 +7765,37 @@ function rendererFactory(baseRenderer) {
     function isNull(obj) {
         return obj === null;
     }
-    /** version: 2.37.2 */
+    /** version: 2.38.0 */
+
+    /*
+     * 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
+     */
+    class WireContextSubscriptionEvent extends CustomEvent {
+        constructor(adapterToken, { setNewContext, setDisconnectedCallback }) {
+            super(adapterToken, {
+                bubbles: true,
+                composed: true,
+            });
+            this.setNewContext = setNewContext;
+            this.setDisconnectedCallback = setDisconnectedCallback;
+        }
+    }
+    function registerContextConsumer(elm, adapterContextToken, subscriptionPayload) {
+        dispatchEvent(elm, new WireContextSubscriptionEvent(adapterContextToken, subscriptionPayload));
+    }
+    function registerContextProvider(elm, adapterContextToken, onContextSubscription) {
+        addEventListener(elm, adapterContextToken, ((evt) => {
+            evt.stopImmediatePropagation();
+            const { setNewContext, setDisconnectedCallback } = evt;
+            onContextSubscription({
+                setNewContext,
+                setDisconnectedCallback,
+            });
+        }));
+    }
 
     /*
      * Copyright (c) 2018, salesforce.com, inc.
@@ -7897,6 +7976,9 @@ function rendererFactory(baseRenderer) {
     function assertInstanceOfHTMLElement(elm, msg) {
         assert.invariant(elm instanceof HTMLElement, msg);
     }
+    function ownerDocument(element) {
+        return element.ownerDocument;
+    }
 
     exports.addEventListener = addEventListener;
     exports.assertInstanceOfHTMLElement = assertInstanceOfHTMLElement;
@@ -7921,8 +8003,11 @@ function rendererFactory(baseRenderer) {
     exports.insert = insert;
     exports.isConnected = isConnected;
     exports.nextSibling = nextSibling;
+    exports.ownerDocument = ownerDocument;
     exports.querySelector = querySelector;
     exports.querySelectorAll = querySelectorAll;
+    exports.registerContextConsumer = registerContextConsumer;
+    exports.registerContextProvider = registerContextProvider;
     exports.remove = remove;
     exports.removeAttribute = removeAttribute;
     exports.removeEventListener = removeEventListener;
@@ -8269,6 +8354,37 @@ defineProperty(LightningElement, 'CustomElementConstructor', {
 });
 freeze(LightningElement);
 seal(LightningElement.prototype);
-/* version: 2.37.2 */
+
+/*
+ * Copyright (c) 2018, 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
+ */
+function addEventListener(target, type, callback, options) {
+    target.addEventListener(type, callback, options);
+}
+
+/*
+ * 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
+ */
+function createContextProvider(adapter) {
+    return createContextProviderWithRegister(adapter, registerContextProvider);
+}
+function registerContextProvider(elm, adapterContextToken, onContextSubscription) {
+    addEventListener(elm, adapterContextToken, ((evt) => {
+        evt.stopImmediatePropagation();
+        const { setNewContext, setDisconnectedCallback } = evt;
+        onContextSubscription({
+            setNewContext,
+            setDisconnectedCallback,
+        });
+    }));
+}
+/* version: 2.38.0 */
 
 export { LightningElement, profilerControl as __unstable__ProfilerControl, reportingControl as __unstable__ReportingControl, api$1 as api, deprecatedBuildCustomElementConstructor as buildCustomElementConstructor, createContextProvider, createElement, freezeTemplate, getComponentConstructor, getComponentDef, hydrateComponent, isComponentConstructor, isNodeShadowed as isNodeFromTemplate, parseFragment, parseSVGFragment, readonly, register, registerComponent, registerDecorators, registerTemplate, renderer, rendererFactory, sanitizeAttribute, setFeatureFlag, setFeatureFlagForTest, setHooks, swapComponent, swapStyle, swapTemplate, track, unwrap, wire };
+//# sourceMappingURL=engine-dom.js.map