@lwc/engine-core 3.6.0 → 3.7.0

package/dist/index.js

@@ -1,7 +1,7 @@
 /**
  * Copyright (C) 2023 salesforce.com, inc.
  */
-import { noop, StringToLowerCase, isNull, ArrayPush as ArrayPush$1, ArrayJoin, isFrozen, isUndefined as isUndefined$1, defineProperty, ArrayIndexOf, ArraySplice, create, seal, isArray as isArray$1, isFunction as isFunction$1, keys, hasOwnProperty as hasOwnProperty$1, globalThis as globalThis$1, forEach, AriaPropNameToAttrNameMap, getPropertyDescriptor, defineProperties, getPrototypeOf as getPrototypeOf$1, setPrototypeOf, assign, isObject, freeze, KEY__SYNTHETIC_MODE, assert, toString as toString$1, getOwnPropertyDescriptor as getOwnPropertyDescriptor$1, isFalse, LWC_VERSION_COMMENT_REGEX, LWC_VERSION, getOwnPropertyNames as getOwnPropertyNames$1, getOwnPropertyDescriptors, htmlPropertyToAttribute, ArraySlice, ArrayMap, KEY__SCOPED_CSS, kebabCaseToCamelCase, StringCharCodeAt, XML_NAMESPACE, XLINK_NAMESPACE, isString, StringSlice, isTrue, SVG_NAMESPACE, KEY__SHADOW_STATIC, KEY__SHADOW_RESOLVER, ArraySome, ArrayPop, isNumber, StringReplace, ArrayUnshift, LOWEST_API_VERSION, KEY__NATIVE_GET_ELEMENT_BY_ID, KEY__NATIVE_QUERY_SELECTOR_ALL, ID_REFERENCING_ATTRIBUTES_SET, KEY__SHADOW_TOKEN, ArrayFilter, StringSplit, arrayEvery, ArrayIncludes, ArrayCopyWithin, ArrayFill, ArraySort, ArrayReverse, ArrayShift } from '@lwc/shared';
+import { noop, StringToLowerCase, isNull, ArrayPush as ArrayPush$1, ArrayJoin, isFrozen, isUndefined as isUndefined$1, defineProperty, ArrayIndexOf, ArraySplice, create, seal, isArray as isArray$1, isFunction as isFunction$1, keys, hasOwnProperty as hasOwnProperty$1, globalThis as globalThis$1, forEach, AriaPropNameToAttrNameMap, getPropertyDescriptor, defineProperties, getPrototypeOf as getPrototypeOf$1, setPrototypeOf, assign, isObject, freeze, KEY__SYNTHETIC_MODE, assert, toString as toString$1, getOwnPropertyDescriptor as getOwnPropertyDescriptor$1, isFalse, LWC_VERSION_COMMENT_REGEX, LWC_VERSION, getOwnPropertyNames as getOwnPropertyNames$1, getOwnPropertyDescriptors, htmlPropertyToAttribute, ArraySlice, ArrayMap, KEY__SCOPED_CSS, kebabCaseToCamelCase, StringCharCodeAt, XML_NAMESPACE, XLINK_NAMESPACE, isString, StringSlice, ArrayShift, ArrayUnshift, isTrue, SVG_NAMESPACE, KEY__SHADOW_STATIC, KEY__SHADOW_RESOLVER, ArraySome, ArrayPop, isNumber, StringReplace, LOWEST_API_VERSION, KEY__NATIVE_GET_ELEMENT_BY_ID, KEY__NATIVE_QUERY_SELECTOR_ALL, ID_REFERENCING_ATTRIBUTES_SET, KEY__SHADOW_TOKEN, ArrayFilter, StringSplit, arrayEvery, ArrayIncludes, ArrayCopyWithin, ArrayFill, ArraySort, ArrayReverse } from '@lwc/shared';
 import { applyAriaReflection } from '@lwc/aria-reflection';
 export { setFeatureFlag, setFeatureFlagForTest } from '@lwc/features';
 
@@ -388,20 +388,6 @@ function flattenStylesheets(stylesheets) {
     }
     return list;
 }
-// Set a ref (lwc:ref) on a VM, from a template API
-function setRefVNode(vm, ref, vnode) {
-    if (process.env.NODE_ENV !== 'production' && isUndefined$1(vm.refVNodes)) {
-        throw new Error('refVNodes must be defined when setting a ref');
-    }
-    // If this method is called, then vm.refVNodes is set as the template has refs.
-    // If not, then something went wrong and we threw an error above.
-    const refVNodes = vm.refVNodes;
-    // In cases of conflict (two elements with the same ref), prefer, the last one,
-    // in depth-first traversal order.
-    if (!(ref in refVNodes) || refVNodes[ref].key < vnode.key) {
-        refVNodes[ref] = vnode;
-    }
-}
 // Throw an error if we're running in prod mode. Ensures code is truly removed from prod mode.
 function assertNotProd() {
     /* istanbul ignore if */
@@ -3698,6 +3684,106 @@ function applyStaticStyleAttribute(vnode, renderer) {
     }
 }
 
+/*
+ * 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
+ */
+// Set a ref (lwc:ref) on a VM, from a template API
+function applyRefs(vnode, owner) {
+    const { data } = vnode;
+    const { ref } = data;
+    if (isUndefined$1(ref)) {
+        return;
+    }
+    if (process.env.NODE_ENV !== 'production' && isUndefined$1(owner.refVNodes)) {
+        throw new Error('refVNodes must be defined when setting a ref');
+    }
+    // If this method is called, then vm.refVNodes is set as the template has refs.
+    // If not, then something went wrong and we threw an error above.
+    const refVNodes = owner.refVNodes;
+    // In cases of conflict (two elements with the same ref), prefer the last one,
+    // in depth-first traversal order. This happens automatically due to how we render
+    refVNodes[ref] = vnode;
+}
+
+/*
+ * 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 traverseAndSetElements(root, parts, renderer) {
+    const numParts = parts.length;
+    // Optimization given that, in most cases, there will be one part, and it's just the root
+    if (numParts === 1) {
+        const firstPart = parts[0];
+        if (firstPart.partId === 0) {
+            // 0 means the root node
+            firstPart.elm = root;
+            return;
+        }
+    }
+    const partIdsToParts = new Map();
+    for (const staticPart of parts) {
+        partIdsToParts.set(staticPart.partId, staticPart);
+    }
+    let numFoundParts = 0;
+    const { previousSibling, getLastChild } = renderer;
+    const stack = [root];
+    let partId = -1;
+    // Depth-first traversal. We assign a partId to each element, which is an integer based on traversal order.
+    while (stack.length > 0) {
+        const elm = ArrayShift.call(stack);
+        partId++;
+        const part = partIdsToParts.get(partId);
+        if (!isUndefined$1(part)) {
+            part.elm = elm;
+            if (++numFoundParts === numParts) {
+                return; // perf optimization - stop traversing once we've found everything we need
+            }
+        }
+        // For depth-first traversal, prepend to the stack in reverse order
+        // Note that we traverse using `*Child`/`*Sibling` rather than `children` because the browser uses a linked
+        // list under the hood to represent the DOM tree, so it's faster to do this than to create an underlying array
+        // by calling `children`.
+        let child = getLastChild(elm);
+        while (!isNull(child)) {
+            ArrayUnshift.call(stack, child);
+            child = previousSibling(child);
+        }
+    }
+    if (process.env.NODE_ENV !== 'production') {
+        assert.isTrue(numFoundParts === numParts, `Should have found all parts by now. Found ${numFoundParts}, needed ${numParts}.`);
+    }
+}
+/**
+ * Given an array of static parts, do all the mounting required for these parts.
+ *
+ * @param root - the root element
+ * @param vnode - the parent VStatic
+ * @param renderer - the renderer to use
+ */
+function applyStaticParts(root, vnode, renderer) {
+    // On the server, we don't support ref (because it relies on renderedCallback), nor do we
+    // support event listeners (no interactivity), so traversing parts makes no sense
+    if (!process.env.IS_BROWSER) {
+        return;
+    }
+    const { parts, owner } = vnode;
+    if (isUndefined$1(parts)) {
+        return;
+    }
+    traverseAndSetElements(root, parts, renderer); // this adds `part.elm` to each `part`
+    for (const part of parts) {
+        // Event listeners are only applied once when mounting, so they are allowed for static vnodes
+        applyEventListeners(part, renderer);
+        // Refs are allowed as well
+        applyRefs(part, owner);
+    }
+}
+
 /*
  * Copyright (c) 2018, salesforce.com, inc.
  * All rights reserved.
@@ -3834,13 +3920,13 @@ function mountElement(vnode, parent, anchor, renderer) {
     applyStyleScoping(elm, owner, renderer);
     applyDomManual(elm, vnode);
     applyElementRestrictions(elm, vnode);
-    patchElementPropsAndAttrs$1(null, vnode, renderer);
+    patchElementPropsAndAttrsAndRefs$1(null, vnode, renderer);
     insertNode(elm, parent, anchor, renderer);
     mountVNodes(vnode.children, elm, renderer, null);
 }
 function patchElement(n1, n2, renderer) {
     const elm = (n2.elm = n1.elm);
-    patchElementPropsAndAttrs$1(n1, n2, renderer);
+    patchElementPropsAndAttrsAndRefs$1(n1, n2, renderer);
     patchChildren(n1.children, n2.children, elm, renderer);
 }
 function mountStatic(vnode, parent, anchor, renderer) {
@@ -3857,8 +3943,7 @@ function mountStatic(vnode, parent, anchor, renderer) {
         }
     }
     insertNode(elm, parent, anchor, renderer);
-    // Event listeners are only applied once when mounting, so they are allowed for static vnodes
-    applyEventListeners(vnode, renderer);
+    applyStaticParts(elm, vnode, renderer);
 }
 function mountCustomElement(vnode, parent, anchor, renderer) {
     const { sel, owner } = vnode;
@@ -3913,7 +3998,7 @@ function mountCustomElement(vnode, parent, anchor, renderer) {
     if (vm) {
         allocateChildren(vnode, vm);
     }
-    patchElementPropsAndAttrs$1(null, vnode, renderer);
+    patchElementPropsAndAttrsAndRefs$1(null, vnode, renderer);
     insertNode(elm, parent, anchor, renderer);
     if (vm) {
         if (process.env.IS_BROWSER) {
@@ -3950,7 +4035,7 @@ function patchCustomElement(n1, n2, parent, renderer) {
         // Otherwise patch the existing component with new props/attrs/etc.
         const elm = (n2.elm = n1.elm);
         const vm = (n2.vm = n1.vm);
-        patchElementPropsAndAttrs$1(n1, n2, renderer);
+        patchElementPropsAndAttrsAndRefs$1(n1, n2, renderer);
         if (!isUndefined$1(vm)) {
             // in fallback mode, the allocation will always set children to
             // empty and delegate the real allocation to the slot elements
@@ -4097,7 +4182,7 @@ function removeNode(node, parent, renderer) {
         lockDomMutation();
     }
 }
-function patchElementPropsAndAttrs$1(oldVnode, vnode, renderer) {
+function patchElementPropsAndAttrsAndRefs$1(oldVnode, vnode, renderer) {
     if (isNull(oldVnode)) {
         applyEventListeners(vnode, renderer);
         applyStaticClassAttribute(vnode, renderer);
@@ -4109,6 +4194,8 @@ function patchElementPropsAndAttrs$1(oldVnode, vnode, renderer) {
     patchStyleAttribute(oldVnode, vnode, renderer);
     patchAttributes(oldVnode, vnode, renderer);
     patchProps(oldVnode, vnode, renderer);
+    // The `refs` object is blown away in every re-render, so we always need to re-apply them
+    applyRefs(vnode, vnode.owner);
 }
 function applyStyleScoping(elm, owner, renderer) {
     const { getClassList } = renderer;
@@ -4510,6 +4597,14 @@ const SymbolIterator = Symbol.iterator;
 function addVNodeToChildLWC(vnode) {
     ArrayPush$1.call(getVMBeingRendered().velements, vnode);
 }
+// [s]tatic [p]art
+function sp(partId, data) {
+    return {
+        partId,
+        data,
+        elm: undefined, // elm is defined later
+    };
+}
 // [s]coped [s]lot [f]actory
 function ssf(slotName, factory) {
     return {
@@ -4523,7 +4618,7 @@ function ssf(slotName, factory) {
     };
 }
 // [st]atic node
-function st(fragment, key, data) {
+function st(fragment, key, parts) {
     const owner = getVMBeingRendered();
     const vnode = {
         type: 4 /* VNodeType.Static */,
@@ -4532,12 +4627,8 @@ function st(fragment, key, data) {
         elm: undefined,
         fragment,
         owner,
-        data,
+        parts,
     };
-    const ref = data === null || data === void 0 ? void 0 : data.ref;
-    if (!isUndefined$1(ref)) {
-        setRefVNode(owner, ref, vnode);
-    }
     return vnode;
 }
 // [fr]agment node
@@ -4579,7 +4670,7 @@ function h(sel, data, children = EmptyArray) {
             }
         });
     }
-    const { key, ref } = data;
+    const { key } = data;
     const vnode = {
         type: 2 /* VNodeType.Element */,
         sel,
@@ -4589,9 +4680,6 @@ function h(sel, data, children = EmptyArray) {
         key,
         owner: vmBeingRendered,
     };
-    if (!isUndefined$1(ref)) {
-        setRefVNode(vmBeingRendered, ref, vnode);
-    }
     return vnode;
 }
 // [t]ab[i]ndex function
@@ -4700,7 +4788,7 @@ function c(sel, Ctor, data, children = EmptyArray) {
             });
         }
     }
-    const { key, ref } = data;
+    const { key } = data;
     let elm, aChildren, vm;
     const vnode = {
         type: 3 /* VNodeType.CustomElement */,
@@ -4716,9 +4804,6 @@ function c(sel, Ctor, data, children = EmptyArray) {
         vm,
     };
     addVNodeToChildLWC(vnode);
-    if (!isUndefined$1(ref)) {
-        setRefVNode(vmBeingRendered, ref, vnode);
-    }
     return vnode;
 }
 // [i]terable node
@@ -5009,6 +5094,7 @@ const api = freeze({
     shc,
     ssf,
     ddc,
+    sp,
 });
 
 /*
@@ -6471,7 +6557,7 @@ function hydrateStaticElement(elm, vnode, renderer) {
         return handleMismatch(elm, vnode, renderer);
     }
     vnode.elm = elm;
-    applyEventListeners(vnode, renderer);
+    applyStaticParts(elm, vnode, renderer);
     return elm;
 }
 function hydrateFragment(elm, vnode, renderer) {
@@ -6505,7 +6591,7 @@ function hydrateElement(elm, vnode, renderer) {
             }
         }
     }
-    patchElementPropsAndAttrs(vnode, renderer);
+    patchElementPropsAndAttrsAndRefs(vnode, renderer);
     if (!isDomManual) {
         const { getFirstChild } = renderer;
         hydrateChildren(getFirstChild(elm), vnode.children, elm, owner);
@@ -6538,7 +6624,7 @@ function hydrateCustomElement(elm, vnode, renderer) {
     vnode.elm = elm;
     vnode.vm = vm;
     allocateChildren(vnode, vm);
-    patchElementPropsAndAttrs(vnode, renderer);
+    patchElementPropsAndAttrsAndRefs(vnode, renderer);
     // Insert hook section:
     if (process.env.NODE_ENV !== 'production') {
         assert.isTrue(vm.state === 0 /* VMState.created */, `${vm} cannot be recycled.`);
@@ -6603,9 +6689,11 @@ function handleMismatch(node, vnode, renderer) {
     removeNode(node, parentNode, renderer);
     return vnode.elm;
 }
-function patchElementPropsAndAttrs(vnode, renderer) {
+function patchElementPropsAndAttrsAndRefs(vnode, renderer) {
     applyEventListeners(vnode, renderer);
     patchProps(null, vnode, renderer);
+    // The `refs` object is blown away in every re-render, so we always need to re-apply them
+    applyRefs(vnode, vnode.owner);
 }
 function hasCorrectNodeType(vnode, node, nodeType, renderer) {
     const { getProperty } = renderer;
@@ -7084,5 +7172,5 @@ function readonly(obj) {
 }
 
 export { 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, setHooks, swapComponent, swapStyle, swapTemplate, track, unwrap, wire };
-/** version: 3.6.0 */
+/** version: 3.7.0 */
 //# sourceMappingURL=index.js.map