lwc 2.23.6 → 2.25.0

package/dist/engine-dom/umd/es5/engine-dom_debug.js

@@ -349,7 +349,7 @@
     CACHED_PROPERTY_ATTRIBUTE_MAPPING.set(propName, attributeName);
     return attributeName;
   }
-  /** version: 2.23.6 */
+  /** version: 2.25.0 */
 
   /**
    * Copyright (C) 2018 salesforce.com, inc.
@@ -443,7 +443,7 @@
       patch$1(propName);
     }
   }
-  /** version: 2.23.6 */
+  /** version: 2.25.0 */
 
   /**
    * Copyright (C) 2018 salesforce.com, inc.
@@ -618,6 +618,19 @@
 
     return result;
   }
+
+
+  function setRefVNode(vm, ref, vnode) {
+    // If not, then something went wrong and we threw an error above.
+
+
+    var 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;
+    }
+  }
   /*
    * Copyright (c) 2019, salesforce.com, inc.
    * All rights reserved.
@@ -1771,13 +1784,15 @@
       }
     };
   }
+
+  var EMPTY_REFS = freeze(create(null));
+  var refsCache = new WeakMap();
   /**
    * This class is the base class for any LWC element.
    * Some elements directly extends this class, others implement it via inheritance.
    **/
   // @ts-ignore
 
-
   var LightningElement = function LightningElement() {
     // This should be as performant as possible, while any initialization should be done lazily
     if (isNull(vmBeingConstructed)) {
@@ -1949,6 +1964,77 @@
       return vm.shadowRoot;
     },
 
+    get refs() {
+      var vm = getAssociatedVM(this);
+
+      if (isUpdatingTemplate) {
+        // process of returning the refs and caching them, because the state of the refs is unstable.
+        // This can happen if e.g. a template contains `<div class={foo}></div>` and `foo` is computed
+        // based on `this.refs.bar`.
+
+
+        return;
+      }
+
+      var refVNodes = vm.refVNodes,
+          hasRefVNodes = vm.hasRefVNodes;
+          vm.cmpTemplate; // If the `cmpTemplate` is null, that means that the template has not been rendered yet. Most likely this occurs
+      // were introduced, we return undefined if the template has no refs defined
+      // anywhere. This fixes components that may want to add an expando called `refs`
+      // and are checking if it exists with `if (this.refs)`  before adding it.
+      // Note it is not sufficient to just check if `refVNodes` is null or empty,
+      // because a template may have `lwc:ref` defined within a falsy `if:true` block.
+
+
+      if (!hasRefVNodes) {
+        return;
+      } // For templates that are using `lwc:ref`, if there are no refs currently available
+      // (e.g. refs inside of a falsy `if:true` block), we return an empty object.
+
+
+      if (isNull(refVNodes)) {
+        return EMPTY_REFS;
+      } // The refNodes can be cached based on the refVNodes, since the refVNodes
+      // are recreated from scratch every time the template is rendered.
+      // This happens with `vm.refVNodes = null` in `template.ts` in `@lwc/engine-core`.
+
+
+      var refs = refsCache.get(refVNodes);
+
+      if (isUndefined$1(refs)) {
+        refs = create(null);
+
+        var _iterator3 = _createForOfIteratorHelper(keys(refVNodes)),
+            _step3;
+
+        try {
+          for (_iterator3.s(); !(_step3 = _iterator3.n()).done;) {
+            var key = _step3.value;
+            refs[key] = refVNodes[key].elm;
+          }
+        } catch (err) {
+          _iterator3.e(err);
+        } finally {
+          _iterator3.f();
+        }
+
+        freeze(refs);
+        refsCache.set(refVNodes, refs);
+      }
+
+      return refs;
+    },
+
+    // For backwards compat, we allow component authors to set `refs` as an expando
+    set refs(value) {
+      defineProperty(this, 'refs', {
+        configurable: true,
+        enumerable: true,
+        writable: true,
+        value: value
+      });
+    },
+
     get shadowRoot() {
       // From within the component instance, the shadowRoot is always reported as "closed".
       // Authors should rely on this.template instead.
@@ -3121,6 +3207,18 @@
         context = owner.context;
     return context.hasScopedStyles && (cmpTemplate === null || cmpTemplate === void 0 ? void 0 : cmpTemplate.stylesheetToken) || null;
   }
+  /**
+   * This function returns the host style token for a custom element if it
+   * exists. Otherwise it returns null.
+   */
+
+
+  function getStylesheetTokenHost(vnode) {
+    var _getComponentInternal = getComponentInternalDef(vnode.ctor),
+        stylesheetToken = _getComponentInternal.template.stylesheetToken;
+
+    return !isUndefined$1(stylesheetToken) ? makeHostToken(stylesheetToken) : null;
+  }
 
   function getNearestNativeShadowComponent(vm) {
     var owner = getNearestShadowComponent(vm);
@@ -3260,6 +3358,12 @@
   function isSameVnode(vnode1, vnode2) {
     return vnode1.key === vnode2.key && vnode1.sel === vnode2.sel;
   }
+
+  function isVCustomElement(vnode) {
+    return vnode.type === 3
+    /* VNodeType.CustomElement */
+    ;
+  }
   /*
    * Copyright (c) 2018, salesforce.com, inc.
    * All rights reserved.
@@ -3326,15 +3430,33 @@
 
   function patchProps(oldVnode, vnode, renderer) {
     var props = vnode.data.props;
+    var spread = vnode.data.spread;
 
-    if (isUndefined$1(props)) {
+    if (isUndefined$1(props) && isUndefined$1(spread)) {
       return;
     }
 
-    var oldProps = isNull(oldVnode) ? EmptyObject : oldVnode.data.props;
+    var oldProps;
 
-    if (oldProps === props) {
-      return;
+    if (!isNull(oldVnode)) {
+      oldProps = oldVnode.data.props;
+      var oldSpread = oldVnode.data.spread;
+
+      if (oldProps === props && oldSpread === spread) {
+        return;
+      }
+
+      if (isUndefined$1(oldProps)) {
+        oldProps = EmptyObject;
+      }
+
+      if (!isUndefined$1(oldSpread)) {
+        oldProps = assign({}, oldProps, oldSpread);
+      }
+    }
+
+    if (!isUndefined$1(spread)) {
+      props = assign({}, props, spread);
     }
 
     var isFirstPatch = isNull(oldVnode);
@@ -3347,7 +3469,8 @@
       var cur = props[key]; // Set the property if it's the first time is is patched or if the previous property is
       // different than the one previously set.
 
-      if (isFirstPatch || cur !== (isLiveBindingProp(sel, key) ? getProperty(elm, key) : oldProps[key])) {
+      if (isFirstPatch || cur !== (isLiveBindingProp(sel, key) ? getProperty(elm, key) : oldProps[key]) || !(key in oldProps) // this is required because the above case will pass when `cur` is `undefined` and key is missing in `oldProps`
+      ) {
 
         setProperty(elm, key, cur);
       }
@@ -4316,19 +4439,25 @@
     var children = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : EmptyArray;
     var vmBeingRendered = getVMBeingRendered();
 
-    var elm;
-    var key = data.key;
-    return {
+    var key = data.key,
+        ref = data.ref;
+    var vnode = {
       type: 2
       /* VNodeType.Element */
       ,
       sel: sel,
       data: data,
       children: children,
-      elm: elm,
+      elm: undefined,
       key: key,
       owner: vmBeingRendered
     };
+
+    if (!isUndefined$1(ref)) {
+      setRefVNode(vmBeingRendered, ref, vnode);
+    }
+
+    return vnode;
   } // [t]ab[i]ndex function
 
 
@@ -4374,7 +4503,8 @@
     var children = arguments.length > 3 && arguments[3] !== undefined ? arguments[3] : EmptyArray;
     var vmBeingRendered = getVMBeingRendered();
 
-    var key = data.key;
+    var key = data.key,
+        ref = data.ref;
     var elm, aChildren, vm;
     var vnode = {
       type: 3
@@ -4392,6 +4522,11 @@
       vm: vm
     };
     addVNodeToChildLWC(vnode);
+
+    if (!isUndefined$1(ref)) {
+      setRefVNode(vmBeingRendered, ref, vnode);
+    }
+
     return vnode;
   } // [i]terable node
 
@@ -4891,9 +5026,13 @@
           context.styleVNodes = stylesheetsContent.length === 0 ? null : createStylesheet(vm, stylesheetsContent);
         }
 
-        if ("production" !== 'production') ; // right before producing the vnodes, we clear up all internal references
-        // to custom elements from the template.
+        if ("production" !== 'production') ; // reset the refs; they will be set during the tmpl() instantiation
+
 
+        var hasRefVNodes = Boolean(html.hasRefs);
+        vm.hasRefVNodes = hasRefVNodes;
+        vm.refVNodes = hasRefVNodes ? create(null) : null; // right before producing the vnodes, we clear up all internal references
+        // to custom elements from the template.
 
         vm.velements = []; // Set the global flag that template is being updated
 
@@ -5256,6 +5395,8 @@
       tagName: tagName,
       mode: mode,
       owner: owner,
+      refVNodes: null,
+      hasRefVNodes: false,
       children: EmptyArray,
       aChildren: EmptyArray,
       velements: EmptyArray,
@@ -6378,7 +6519,8 @@
         classMap = data.classMap;
     var getProperty = renderer.getProperty,
         getClassList = renderer.getClassList;
-    var scopedToken = getScopeTokenClass(owner); // Classnames for scoped CSS are added directly to the DOM during rendering,
+    var scopedToken = getScopeTokenClass(owner);
+    var stylesheetTokenHost = isVCustomElement(vnode) ? getStylesheetTokenHost(vnode) : null; // Classnames for scoped CSS are added directly to the DOM during rendering,
     // or to the VDOM on the server in the case of SSR. As such, these classnames
     // are never present in VDOM nodes in the browser.
     //
@@ -6387,9 +6529,11 @@
 
     if (scopedToken) {
       if (!isUndefined$1(className)) {
-        className = "".concat(scopedToken, " ").concat(className);
+        className = isNull(stylesheetTokenHost) ? "".concat(scopedToken, " ").concat(className) : "".concat(scopedToken, " ").concat(className, " ").concat(stylesheetTokenHost);
       } else if (!isUndefined$1(classMap)) {
-        classMap = Object.assign(Object.assign({}, classMap), _defineProperty({}, scopedToken, true));
+        classMap = Object.assign(Object.assign(Object.assign({}, classMap), _defineProperty({}, scopedToken, true)), isNull(stylesheetTokenHost) ? {} : _defineProperty({}, stylesheetTokenHost, true));
+      } else {
+        className = isNull(stylesheetTokenHost) ? "".concat(scopedToken) : "".concat(scopedToken, " ").concat(stylesheetTokenHost);
       }
     }
 
@@ -6560,7 +6704,7 @@
 
     return ctor;
   }
-  /* version: 2.23.6 */
+  /* version: 2.25.0 */
 
   /*
    * Copyright (c) 2018, salesforce.com, inc.
@@ -6779,7 +6923,7 @@
       function isNull(obj) {
         return obj === null;
       }
-      /** version: 2.23.6 */
+      /** version: 2.25.0 */
 
       /*
        * Copyright (c) 2018, salesforce.com, inc.
@@ -6928,18 +7072,18 @@
           var wrapperTags = topLevelWrappingMap[getTagName(html)];
 
           if (!isUndefined(wrapperTags)) {
-            var _iterator5 = _createForOfIteratorHelper(wrapperTags),
-                _step5;
+            var _iterator6 = _createForOfIteratorHelper(wrapperTags),
+                _step6;
 
             try {
-              for (_iterator5.s(); !(_step5 = _iterator5.n()).done;) {
-                var wrapperTag = _step5.value;
+              for (_iterator6.s(); !(_step6 = _iterator6.n()).done;) {
+                var wrapperTag = _step6.value;
                 html = "<".concat(wrapperTag, ">").concat(html, "</").concat(wrapperTag, ">");
               }
             } catch (err) {
-              _iterator5.e(err);
+              _iterator6.e(err);
             } finally {
-              _iterator5.f();
+              _iterator6.f();
             }
           } // For IE11, the document title must not be undefined, but it can be an empty string
           // https://developer.mozilla.org/en-US/docs/Web/API/DOMImplementation/createHTMLDocument#browser_compatibility
@@ -7502,7 +7646,7 @@
   });
   freeze(LightningElement);
   seal(LightningElement.prototype);
-  /* version: 2.23.6 */
+  /* version: 2.25.0 */
 
   exports.LightningElement = LightningElement;
   exports.__unstable__ProfilerControl = profilerControl;

package/dist/engine-server/commonjs/es2017/engine-server.js

@@ -436,9 +436,9 @@ function htmlEscape(str, attrMode = false) {
  * 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.23.6";
+const LWC_VERSION = "2.25.0";
 const LWC_VERSION_COMMENT_REGEX = /\/\*LWC compiler v([\d.]+)\*\/\s*}/;
-/** version: 2.23.6 */
+/** version: 2.25.0 */
 
 /*
  * Copyright (c) 2020, salesforce.com, inc.
@@ -549,7 +549,7 @@ function setFeatureFlagForTest(name, value) {
         setFeatureFlag(name, value);
     }
 }
-/** version: 2.23.6 */
+/** version: 2.25.0 */
 
 /* proxy-compat-disable */
 
@@ -600,6 +600,20 @@ 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;
+    }
+}
 
 /*
  * Copyright (c) 2019, salesforce.com, inc.
@@ -1834,6 +1848,8 @@ function createBridgeToElementDescriptor(propName, descriptor) {
         },
     };
 }
+const EMPTY_REFS = freeze(create(null));
+const refsCache = new WeakMap();
 /**
  * This class is the base class for any LWC element.
  * Some elements directly extends this class, others implement it via inheritance.
@@ -2012,6 +2028,70 @@ LightningElement.prototype = {
         }
         return vm.shadowRoot;
     },
+    get refs() {
+        const vm = getAssociatedVM(this);
+        if (isUpdatingTemplate) {
+            if (process.env.NODE_ENV !== 'production') {
+                logError(`this.refs should not be called while ${getComponentTag(vm)} is rendering. Use this.refs only when the DOM is stable, e.g. in renderedCallback().`);
+            }
+            // If the template is in the process of being updated, then we don't want to go through the normal
+            // process of returning the refs and caching them, because the state of the refs is unstable.
+            // This can happen if e.g. a template contains `<div class={foo}></div>` and `foo` is computed
+            // based on `this.refs.bar`.
+            return;
+        }
+        if (process.env.NODE_ENV !== 'production') {
+            warnIfInvokedDuringConstruction(vm, 'refs');
+        }
+        const { refVNodes, hasRefVNodes, cmpTemplate } = vm;
+        // If the `cmpTemplate` is null, that means that the template has not been rendered yet. Most likely this occurs
+        // if `this.refs` is called during the `connectedCallback` phase. The DOM elements have not been rendered yet,
+        // so log a warning. Note we also check `isBeingConstructed()` to avoid a double warning (due to
+        // `warnIfInvokedDuringConstruction` above).
+        if (process.env.NODE_ENV !== 'production' &&
+            isNull(cmpTemplate) &&
+            !isBeingConstructed(vm)) {
+            logError(`this.refs is undefined for ${getComponentTag(vm)}. This is either because the attached template has no "lwc:ref" directive, or this.refs was ` +
+                `invoked before renderedCallback(). Use this.refs only when the referenced HTML elements have ` +
+                `been rendered to the DOM, such as within renderedCallback() or disconnectedCallback().`);
+        }
+        // For backwards compatibility with component written before template refs
+        // were introduced, we return undefined if the template has no refs defined
+        // anywhere. This fixes components that may want to add an expando called `refs`
+        // and are checking if it exists with `if (this.refs)`  before adding it.
+        // Note it is not sufficient to just check if `refVNodes` is null or empty,
+        // because a template may have `lwc:ref` defined within a falsy `if:true` block.
+        if (!hasRefVNodes) {
+            return;
+        }
+        // For templates that are using `lwc:ref`, if there are no refs currently available
+        // (e.g. refs inside of a falsy `if:true` block), we return an empty object.
+        if (isNull(refVNodes)) {
+            return EMPTY_REFS;
+        }
+        // The refNodes can be cached based on the refVNodes, since the refVNodes
+        // are recreated from scratch every time the template is rendered.
+        // This happens with `vm.refVNodes = null` in `template.ts` in `@lwc/engine-core`.
+        let refs = refsCache.get(refVNodes);
+        if (isUndefined$1(refs)) {
+            refs = create(null);
+            for (const key of keys(refVNodes)) {
+                refs[key] = refVNodes[key].elm;
+            }
+            freeze(refs);
+            refsCache.set(refVNodes, refs);
+        }
+        return refs;
+    },
+    // For backwards compat, we allow component authors to set `refs` as an expando
+    set refs(value) {
+        defineProperty(this, 'refs', {
+            configurable: true,
+            enumerable: true,
+            writable: true,
+            value,
+        });
+    },
     get shadowRoot() {
         // From within the component instance, the shadowRoot is always reported as "closed".
         // Authors should rely on this.template instead.
@@ -3434,13 +3514,27 @@ function isLiveBindingProp(sel, key) {
     return sel === 'input' && (key === 'value' || key === 'checked');
 }
 function patchProps(oldVnode, vnode, renderer) {
-    const { props } = vnode.data;
-    if (isUndefined$1(props)) {
+    let { props } = vnode.data;
+    const { spread } = vnode.data;
+    if (isUndefined$1(props) && isUndefined$1(spread)) {
         return;
     }
-    const oldProps = isNull(oldVnode) ? EmptyObject : oldVnode.data.props;
-    if (oldProps === props) {
-        return;
+    let oldProps;
+    if (!isNull(oldVnode)) {
+        oldProps = oldVnode.data.props;
+        const oldSpread = oldVnode.data.spread;
+        if (oldProps === props && oldSpread === spread) {
+            return;
+        }
+        if (isUndefined$1(oldProps)) {
+            oldProps = EmptyObject;
+        }
+        if (!isUndefined$1(oldSpread)) {
+            oldProps = assign({}, oldProps, oldSpread);
+        }
+    }
+    if (!isUndefined$1(spread)) {
+        props = assign({}, props, spread);
     }
     const isFirstPatch = isNull(oldVnode);
     const { elm, sel } = vnode;
@@ -3450,7 +3544,9 @@ function patchProps(oldVnode, vnode, renderer) {
         // Set the property if it's the first time is is patched or if the previous property is
         // different than the one previously set.
         if (isFirstPatch ||
-            cur !== (isLiveBindingProp(sel, key) ? getProperty(elm, key) : oldProps[key])) {
+            cur !== (isLiveBindingProp(sel, key) ? getProperty(elm, key) : oldProps[key]) ||
+            !(key in oldProps) // this is required because the above case will pass when `cur` is `undefined` and key is missing in `oldProps`
+        ) {
             setProperty(elm, key, cur);
         }
     }
@@ -4494,17 +4590,20 @@ function h(sel, data, children = EmptyArray) {
             }
         });
     }
-    let elm;
-    const { key } = data;
-    return {
+    const { key, ref } = data;
+    const vnode = {
         type: 2 /* VNodeType.Element */,
         sel,
         data,
         children,
-        elm,
+        elm: undefined,
         key,
         owner: vmBeingRendered,
     };
+    if (!isUndefined$1(ref)) {
+        setRefVNode(vmBeingRendered, ref, vnode);
+    }
+    return vnode;
 }
 // [t]ab[i]ndex function
 function ti(value) {
@@ -4569,7 +4668,7 @@ function c(sel, Ctor, data, children = EmptyArray) {
             });
         }
     }
-    const { key } = data;
+    const { key, ref } = data;
     let elm, aChildren, vm;
     const vnode = {
         type: 3 /* VNodeType.CustomElement */,
@@ -4585,6 +4684,9 @@ function c(sel, Ctor, data, children = EmptyArray) {
         vm,
     };
     addVNodeToChildLWC(vnode);
+    if (!isUndefined$1(ref)) {
+        setRefVNode(vmBeingRendered, ref, vnode);
+    }
     return vnode;
 }
 // [i]terable node
@@ -5074,6 +5176,10 @@ function evaluateTemplate(vm, html) {
                 // add the VM to the list of host VMs that can be re-rendered if html is swapped
                 setActiveVM(vm);
             }
+            // reset the refs; they will be set during the tmpl() instantiation
+            const hasRefVNodes = Boolean(html.hasRefs);
+            vm.hasRefVNodes = hasRefVNodes;
+            vm.refVNodes = hasRefVNodes ? create(null) : null;
             // right before producing the vnodes, we clear up all internal references
             // to custom elements from the template.
             vm.velements = [];
@@ -5426,6 +5532,8 @@ function createVM(elm, ctor, renderer, options) {
     tagName,
     mode,
     owner,
+    refVNodes: null,
+    hasRefVNodes: false,
     children: EmptyArray,
     aChildren: EmptyArray,
     velements: EmptyArray,
@@ -6303,7 +6411,7 @@ function freezeTemplate(tmpl) {
         });
     }
 }
-/* version: 2.23.6 */
+/* version: 2.25.0 */
 
 /*
  * Copyright (c) 2020, salesforce.com, inc.
@@ -6673,7 +6781,7 @@ const renderer = {
  */
 function serializeAttributes(attributes) {
     return attributes
-        .map((attr) => attr.value.length ? `${attr.name}=${JSON.stringify(htmlEscape(attr.value))}` : attr.name)
+        .map((attr) => attr.value.length ? `${attr.name}="${htmlEscape(attr.value, true)}"` : attr.name)
         .join(' ');
 }
 function serializeChildNodes(children) {
@@ -6773,7 +6881,7 @@ function renderComponent(tagName, Ctor, props = {}) {
  */
 freeze(LightningElement);
 seal(LightningElement.prototype);
-/* version: 2.23.6 */
+/* version: 2.25.0 */
 
 exports.LightningElement = LightningElement;
 exports.api = api$1;