@lwc/engine-core 2.5.6 → 2.5.10-alpha1

package/dist/engine-core.cjs.js

@@ -51,6 +51,26 @@ function guid() {
   }
 
   return s4() + s4() + '-' + s4() + '-' + s4() + '-' + s4() + '-' + s4() + s4() + s4();
+} // Borrowed from Vue template compiler.
+// https://github.com/vuejs/vue/blob/531371b818b0e31a989a06df43789728f23dc4e8/src/platforms/web/util/style.js#L5-L16
+
+const DECLARATION_DELIMITER = /;(?![^(]*\))/g;
+const PROPERTY_DELIMITER = /:(.+)/;
+function parseStyleText(cssText) {
+  const styleMap = {};
+  const declarations = cssText.split(DECLARATION_DELIMITER);
+
+  for (const declaration of declarations) {
+    if (declaration) {
+      const [prop, value] = declaration.split(PROPERTY_DELIMITER);
+
+      if (prop !== undefined && value !== undefined) {
+        styleMap[prop.trim()] = value.trim();
+      }
+    }
+  }
+
+  return styleMap;
 }
 
 /*
@@ -222,8 +242,9 @@ function getErrorComponentStack(vm) {
  * SPDX-License-Identifier: MIT
  * For full license text, see the LICENSE file in the repo root or https://opensource.org/licenses/MIT
  */
-function logError(message, vm) {
-  let msg = `[LWC error]: ${message}`;
+
+function log(method, message, vm) {
+  let msg = `[LWC ${method}]: ${message}`;
 
   if (!shared.isUndefined(vm)) {
     msg = `${msg}\n${getComponentStack(vm)}`;
@@ -231,7 +252,7 @@ function logError(message, vm) {
 
   if (process.env.NODE_ENV === 'test') {
     /* eslint-disable-next-line no-console */
-    console.error(msg);
+    console[method](msg);
     return;
   }
 
@@ -239,10 +260,17 @@ function logError(message, vm) {
     throw new Error(msg);
   } catch (e) {
     /* eslint-disable-next-line no-console */
-    console.error(e);
+    console[method](e);
   }
 }
 
+function logError(message, vm) {
+  log('error', message, vm);
+}
+function logWarn(message, vm) {
+  log('warn', message, vm);
+}
+
 /*
  * Copyright (c) 2018, salesforce.com, inc.
  * All rights reserved.
@@ -2596,8 +2624,10 @@ for (const [elementProp, rendererMethod] of childGetters) {
       }
 
       return renderer[rendererMethod](elm);
-    }
+    },
 
+    configurable: true,
+    enumerable: true
   };
 }
 
@@ -2617,8 +2647,11 @@ for (const queryMethod of queryMethods) {
       }
 
       return renderer[queryMethod](elm, arg);
-    }
+    },
 
+    configurable: true,
+    enumerable: true,
+    writable: true
   };
 }
 
@@ -3750,7 +3783,7 @@ function createComponentDef(Ctor) {
     if (!shared.isUndefined(ctorShadowSupportMode)) {
       shared.assert.invariant(ctorShadowSupportMode === "any"
       /* Any */
-      || ctorShadowSupportMode === "default"
+      || ctorShadowSupportMode === "reset"
       /* Default */
       , `Invalid value for static property shadowSupportMode: '${ctorShadowSupportMode}'`);
     }
@@ -3910,7 +3943,7 @@ const lightingElementDef = {
   renderMode: 1
   /* Shadow */
   ,
-  shadowSupportMode: "default"
+  shadowSupportMode: "reset"
   /* Default */
   ,
   wire: EmptyObject,
@@ -4055,6 +4088,16 @@ function createElmHook(vnode) {
   modComputedClassName.create(vnode);
   modComputedStyle.create(vnode);
 }
+function hydrateElmHook(vnode) {
+  modEvents.create(vnode); // Attrs are already on the element.
+  // modAttrs.create(vnode);
+
+  modProps.create(vnode); // Already set.
+  // modStaticClassName.create(vnode);
+  // modStaticStyle.create(vnode);
+  // modComputedClassName.create(vnode);
+  // modComputedStyle.create(vnode);
+}
 function fallbackElmHook(elm, vnode) {
   const {
     owner
@@ -4219,6 +4262,179 @@ function createChildrenHook(vnode) {
     }
   }
 }
+
+function isElementNode(node) {
+  // eslint-disable-next-line lwc-internal/no-global-node
+  return node.nodeType === Node.ELEMENT_NODE;
+}
+
+function vnodesAndElementHaveCompatibleAttrs(vnode, elm) {
+  const {
+    data: {
+      attrs = {}
+    },
+    owner: {
+      renderer
+    }
+  } = vnode;
+  let nodesAreCompatible = true; // Validate attributes, though we could always recovery from those by running the update mods.
+  // Note: intentionally ONLY matching vnodes.attrs to elm.attrs, in case SSR is adding extra attributes.
+
+  for (const [attrName, attrValue] of Object.entries(attrs)) {
+    const elmAttrValue = renderer.getAttribute(elm, attrName);
+
+    if (String(attrValue) !== elmAttrValue) {
+      logError(`Mismatch hydrating element <${elm.tagName.toLowerCase()}>: attribute "${attrName}" has different values, expected "${attrValue}" but found "${elmAttrValue}"`, vnode.owner);
+      nodesAreCompatible = false;
+    }
+  }
+
+  return nodesAreCompatible;
+}
+
+function vnodesAndElementHaveCompatibleClass(vnode, elm) {
+  const {
+    data: {
+      className,
+      classMap
+    },
+    owner: {
+      renderer
+    }
+  } = vnode;
+  let nodesAreCompatible = true;
+  let vnodeClassName;
+
+  if (!shared.isUndefined(className) && String(className) !== elm.className) {
+    // className is used when class is bound to an expr.
+    nodesAreCompatible = false;
+    vnodeClassName = className;
+  } else if (!shared.isUndefined(classMap)) {
+    // classMap is used when class is set to static value.
+    const classList = renderer.getClassList(elm);
+    let computedClassName = ''; // all classes from the vnode should be in the element.classList
+
+    for (const name in classMap) {
+      computedClassName += ' ' + name;
+
+      if (!classList.contains(name)) {
+        nodesAreCompatible = false;
+      }
+    }
+
+    vnodeClassName = computedClassName.trim();
+
+    if (classList.length > shared.keys(classMap).length) {
+      nodesAreCompatible = false;
+    }
+  }
+
+  if (!nodesAreCompatible) {
+    logError(`Mismatch hydrating element <${elm.tagName.toLowerCase()}>: attribute "class" has different values, expected "${vnodeClassName}" but found "${elm.className}"`, vnode.owner);
+  }
+
+  return nodesAreCompatible;
+}
+
+function vnodesAndElementHaveCompatibleStyle(vnode, elm) {
+  const {
+    data: {
+      style,
+      styleDecls
+    },
+    owner: {
+      renderer
+    }
+  } = vnode;
+  const elmStyle = renderer.getAttribute(elm, 'style') || '';
+  let vnodeStyle;
+  let nodesAreCompatible = true;
+
+  if (!shared.isUndefined(style) && style !== elmStyle) {
+    nodesAreCompatible = false;
+    vnodeStyle = style;
+  } else if (!shared.isUndefined(styleDecls)) {
+    const parsedVnodeStyle = parseStyleText(elmStyle);
+    const expectedStyle = []; // styleMap is used when style is set to static value.
+
+    for (let i = 0, n = styleDecls.length; i < n; i++) {
+      const [prop, value, important] = styleDecls[i];
+      expectedStyle.push(`${prop}: ${value + (important ? ' important!' : '')}`);
+      const parsedPropValue = parsedVnodeStyle[prop];
+
+      if (shared.isUndefined(parsedPropValue)) {
+        nodesAreCompatible = false;
+      } else if (!parsedPropValue.startsWith(value)) {
+        nodesAreCompatible = false;
+      } else if (important && !parsedPropValue.endsWith('!important')) {
+        nodesAreCompatible = false;
+      }
+    }
+
+    if (shared.keys(parsedVnodeStyle).length > styleDecls.length) {
+      nodesAreCompatible = false;
+    }
+
+    vnodeStyle = shared.ArrayJoin.call(expectedStyle, ';');
+  }
+
+  if (!nodesAreCompatible) {
+    // style is used when class is bound to an expr.
+    logError(`Mismatch hydrating element <${elm.tagName.toLowerCase()}>: attribute "style" has different values, expected "${vnodeStyle}" but found "${elmStyle}".`, vnode.owner);
+  }
+
+  return nodesAreCompatible;
+}
+
+function throwHydrationError() {
+  shared.assert.fail('Server rendered elements do not match client side generated elements');
+}
+
+function hydrateChildrenHook(elmChildren, children, vm) {
+  var _a, _b;
+
+  if (process.env.NODE_ENV !== 'production') {
+    const filteredVNodes = shared.ArrayFilter.call(children, vnode => !!vnode);
+
+    if (elmChildren.length !== filteredVNodes.length) {
+      logError(`Hydration mismatch: incorrect number of rendered nodes, expected ${filteredVNodes.length} but found ${elmChildren.length}.`, vm);
+      throwHydrationError();
+    }
+  }
+
+  let elmCurrentChildIdx = 0;
+
+  for (let j = 0, n = children.length; j < n; j++) {
+    const ch = children[j];
+
+    if (ch != null) {
+      const childNode = elmChildren[elmCurrentChildIdx];
+
+      if (process.env.NODE_ENV !== 'production') {
+        // VComments and VTexts validation is handled in their hooks
+        if (isElementNode(childNode)) {
+          if (((_a = ch.sel) === null || _a === void 0 ? void 0 : _a.toLowerCase()) !== childNode.tagName.toLowerCase()) {
+            logError(`Hydration mismatch: expecting element with tag "${(_b = ch.sel) === null || _b === void 0 ? void 0 : _b.toLowerCase()}" but found "${childNode.tagName.toLowerCase()}".`, vm);
+            throwHydrationError();
+          } // Note: props are not yet set
+
+
+          const hasIncompatibleAttrs = vnodesAndElementHaveCompatibleAttrs(ch, childNode);
+          const hasIncompatibleClass = vnodesAndElementHaveCompatibleClass(ch, childNode);
+          const hasIncompatibleStyle = vnodesAndElementHaveCompatibleStyle(ch, childNode);
+          const isVNodeAndElementCompatible = hasIncompatibleAttrs && hasIncompatibleClass && hasIncompatibleStyle;
+
+          if (!isVNodeAndElementCompatible) {
+            throwHydrationError();
+          }
+        }
+      }
+
+      ch.hook.hydrate(ch, childNode);
+      elmCurrentChildIdx++;
+    }
+  }
+}
 function updateCustomElmHook(oldVnode, vnode) {
   // Attrs need to be applied to element before props
   // IE11 will wipe out value on radio inputs if value
@@ -4292,36 +4508,6 @@ function getUpgradableConstructor(tagName, renderer) {
   return CE;
 }
 
-/*
- * 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 acts like a hook for Lightning Locker Service and other similar
- * libraries to sanitize HTML content. This hook process the content passed via the template to
- * lwc:inner-html directive.
- * It is meant to be overridden with setSanitizeHtmlContentHook
- */
-let sanitizeHtmlContentHook = () => {
-  // locker-service patches this function during runtime to sanitize HTML content.
-  throw new Error('sanitizeHtmlContent hook must be implemented.');
-};
-/**
- * Sets the sanitizeHtmlContentHook.
- *
- * @param newHookImpl
- * @returns oldHookImplementation.
- */
-
-function setSanitizeHtmlContentHook(newHookImpl) {
-  const currentHook = sanitizeHtmlContentHook;
-  sanitizeHtmlContentHook = newHookImpl;
-  return currentHook;
-}
-
 /*
  * Copyright (c) 2018, salesforce.com, inc.
  * All rights reserved.
@@ -4345,7 +4531,26 @@ const TextHook = {
   update: updateNodeHook,
   insert: insertNodeHook,
   move: insertNodeHook,
-  remove: removeNodeHook
+  remove: removeNodeHook,
+  hydrate: (vNode, node) => {
+    var _a;
+
+    if (process.env.NODE_ENV !== 'production') {
+      // eslint-disable-next-line lwc-internal/no-global-node
+      if (node.nodeType !== Node.TEXT_NODE) {
+        logError('Hydration mismatch: incorrect node type received', vNode.owner);
+        shared.assert.fail('Hydration mismatch: incorrect node type received.');
+      }
+
+      if (node.nodeValue !== vNode.text) {
+        logWarn('Hydration mismatch: text values do not match, will recover from the difference', vNode.owner);
+      }
+    } // always set the text value to the one from the vnode.
+
+
+    node.nodeValue = (_a = vNode.text) !== null && _a !== void 0 ? _a : null;
+    vNode.elm = node;
+  }
 };
 const CommentHook = {
   create: vnode => {
@@ -4363,7 +4568,26 @@ const CommentHook = {
   update: updateNodeHook,
   insert: insertNodeHook,
   move: insertNodeHook,
-  remove: removeNodeHook
+  remove: removeNodeHook,
+  hydrate: (vNode, node) => {
+    var _a;
+
+    if (process.env.NODE_ENV !== 'production') {
+      // eslint-disable-next-line lwc-internal/no-global-node
+      if (node.nodeType !== Node.COMMENT_NODE) {
+        logError('Hydration mismatch: incorrect node type received', vNode.owner);
+        shared.assert.fail('Hydration mismatch: incorrect node type received.');
+      }
+
+      if (node.nodeValue !== vNode.text) {
+        logWarn('Hydration mismatch: comment values do not match, will recover from the difference', vNode.owner);
+      }
+    } // always set the text value to the one from the vnode.
+
+
+    node.nodeValue = (_a = vNode.text) !== null && _a !== void 0 ? _a : null;
+    vNode.elm = node;
+  }
 }; // insert is called after update, which is used somewhere else (via a module)
 // to mark the vm as inserted, that means we cannot use update as the main channel
 // to rehydrate when dirty, because sometimes the element is not inserted just yet,
@@ -4403,6 +4627,38 @@ const ElementHook = {
   remove: (vnode, parentNode) => {
     removeNodeHook(vnode, parentNode);
     removeElmHook(vnode);
+  },
+  hydrate: (vnode, node) => {
+    const elm = node;
+    vnode.elm = elm;
+    const {
+      context
+    } = vnode.data;
+    const isDomManual = Boolean(!shared.isUndefined(context) && !shared.isUndefined(context.lwc) && context.lwc.dom === "manual"
+    /* manual */
+    );
+
+    if (isDomManual) {
+      // it may be that this element has lwc:inner-html, we need to diff and in case are the same,
+      // remove the innerHTML from props so it reuses the existing dom elements.
+      const {
+        props
+      } = vnode.data;
+
+      if (!shared.isUndefined(props) && !shared.isUndefined(props.innerHTML)) {
+        if (elm.innerHTML === props.innerHTML) {
+          delete props.innerHTML;
+        } else {
+          logWarn(`Mismatch hydrating element <${elm.tagName.toLowerCase()}>: innerHTML values do not match for element, will recover from the difference`, vnode.owner);
+        }
+      }
+    }
+
+    hydrateElmHook(vnode);
+
+    if (!isDomManual) {
+      hydrateChildrenHook(vnode.elm.childNodes, vnode.children, vnode.owner);
+    }
   }
 };
 const CustomElementHook = {
@@ -4494,6 +4750,44 @@ const CustomElementHook = {
       // will take care of disconnecting any child VM attached to its shadow as well.
       removeVM(vm);
     }
+  },
+  hydrate: (vnode, elm) => {
+    // the element is created, but the vm is not
+    const {
+      sel,
+      mode,
+      ctor,
+      owner
+    } = vnode;
+    const def = getComponentInternalDef(ctor);
+    createVM(elm, def, {
+      mode,
+      owner,
+      tagName: sel,
+      renderer: owner.renderer
+    });
+    vnode.elm = elm;
+    const vm = getAssociatedVM(elm);
+    allocateChildrenHook(vnode, vm);
+    hydrateElmHook(vnode); // Insert hook section:
+
+    if (process.env.NODE_ENV !== 'production') {
+      shared.assert.isTrue(vm.state === 0
+      /* created */
+      , `${vm} cannot be recycled.`);
+    }
+
+    runConnectedCallback(vm);
+
+    if (vm.renderMode !== 0
+    /* Light */
+    ) {
+      // VM is not rendering in Light DOM, we can proceed and hydrate the slotted content.
+      // Note: for Light DOM, this is handled while hydrating the VM
+      hydrateChildrenHook(vnode.elm.childNodes, vnode.children, vm);
+    }
+
+    hydrateVM(vm);
   }
 };
 
@@ -4806,7 +5100,7 @@ function co(text) {
 
 
 function d(value) {
-  return value == null ? '' : value;
+  return value == null ? '' : String(value);
 } // [b]ind function
 
 
@@ -4968,9 +5262,28 @@ function sc(vnodes) {
 
   markAsDynamicChildren(vnodes);
   return vnodes;
-} // [s]anitize [h]tml [c]ontent
+}
+/**
+ * EXPERIMENTAL: This function acts like a hook for Lightning Locker Service and other similar
+ * libraries to sanitize HTML content. This hook process the content passed via the template to
+ * lwc:inner-html directive.
+ * It is meant to be overridden with setSanitizeHtmlContentHook, it throws an error by default.
+ */
+
+
+let sanitizeHtmlContentHook = () => {
+  // locker-service patches this function during runtime to sanitize HTML content.
+  throw new Error('sanitizeHtmlContent hook must be implemented.');
+};
+/**
+ * Sets the sanitizeHtmlContentHook.
+ */
 
 
+function setSanitizeHtmlContentHook(newHookImpl) {
+  sanitizeHtmlContentHook = newHookImpl;
+} // [s]anitize [h]tml [c]ontent
+
 function shc(content) {
   return sanitizeHtmlContentHook(content);
 }
@@ -5162,7 +5475,10 @@ function createStylesheet(vm, stylesheets) {
     for (let i = 0; i < stylesheets.length; i++) {
       renderer.insertGlobalStylesheet(stylesheets[i]);
     }
-  } else if (renderer.ssr) {
+  } else if (renderer.ssr || renderer.isHydrating()) {
+    // Note: We need to ensure that during hydration, the stylesheets method is the same as those in ssr.
+    //       This works in the client, because the stylesheets are created, and cached in the VM
+    //       the first time the VM renders.
     // native shadow or light DOM, SSR
     const combinedStylesheetContent = shared.ArrayJoin.call(stylesheets, '\n');
     return createInlineStyleVNode(combinedStylesheetContent);
@@ -5759,12 +6075,20 @@ function connectRootElement(elm) {
   /* GlobalHydrate */
   , vm);
 }
+function hydrateRootElement(elm) {
+  const vm = getAssociatedVM(elm);
+  runConnectedCallback(vm);
+  hydrateVM(vm);
+}
 function disconnectRootElement(elm) {
   const vm = getAssociatedVM(elm);
   resetComponentStateWhenRemoved(vm);
 }
 function appendVM(vm) {
   rehydrate(vm);
+}
+function hydrateVM(vm) {
+  hydrate(vm);
 } // just in case the component comes back, with this we guarantee re-rendering it
 // while preventing any attempt to rehydration until after reinsertion.
 
@@ -5995,6 +6319,22 @@ function rehydrate(vm) {
   }
 }
 
+function hydrate(vm) {
+  if (shared.isTrue(vm.isDirty)) {
+    // manually diffing/patching here.
+    // This routine is:
+    // patchShadowRoot(vm, children);
+    //  -> addVnodes.
+    const children = renderComponent(vm);
+    vm.children = children;
+    const vmChildren = vm.renderMode === 0
+    /* Light */
+    ? vm.elm.childNodes : vm.elm.shadowRoot.childNodes;
+    hydrateChildrenHook(vmChildren, children, vm);
+    runRenderedCallback(vm);
+  }
+}
+
 function patchShadowRoot(vm, newCh) {
   const {
     children: oldCh
@@ -6805,35 +7145,23 @@ function readonly(obj) {
  * For full license text, see the LICENSE file in the repo root or https://opensource.org/licenses/MIT
  */
 let hooksAreSet = false;
-
-function overrideHooks(hooks) {
-  const oldHooks = {};
-
-  if (!shared.isUndefined(hooks.sanitizeHtmlContent)) {
-    oldHooks.sanitizeHtmlContent = setSanitizeHtmlContentHook(hooks.sanitizeHtmlContent);
-  }
-
-  return oldHooks;
-}
-
 function setHooks(hooks) {
   shared.assert.isFalse(hooksAreSet, 'Hooks are already overridden, only one definition is allowed.');
-  overrideHooks(hooks);
   hooksAreSet = true;
-}
-function setHooksForTest(hooks) {
-  if (process.env.NODE_ENV !== 'production') {
-    return overrideHooks(hooks);
-  }
+  setSanitizeHtmlContentHook(hooks.sanitizeHtmlContent);
 }
 
 Object.defineProperty(exports, 'setFeatureFlag', {
     enumerable: true,
-    get: function () { return features.setFeatureFlag; }
+    get: function () {
+        return features.setFeatureFlag;
+    }
 });
 Object.defineProperty(exports, 'setFeatureFlagForTest', {
     enumerable: true,
-    get: function () { return features.setFeatureFlagForTest; }
+    get: function () {
+        return features.setFeatureFlagForTest;
+    }
 });
 exports.LightningElement = LightningElement;
 exports.__unstable__ProfilerControl = profilerControl;
@@ -6846,6 +7174,7 @@ exports.getAssociatedVMIfPresent = getAssociatedVMIfPresent;
 exports.getComponentDef = getComponentDef;
 exports.getComponentInternalDef = getComponentInternalDef;
 exports.getUpgradableConstructor = getUpgradableConstructor;
+exports.hydrateRootElement = hydrateRootElement;
 exports.isComponentConstructor = isComponentConstructor;
 exports.readonly = readonly;
 exports.register = register;
@@ -6854,11 +7183,10 @@ exports.registerDecorators = registerDecorators;
 exports.registerTemplate = registerTemplate;
 exports.sanitizeAttribute = sanitizeAttribute;
 exports.setHooks = setHooks;
-exports.setHooksForTest = setHooksForTest;
 exports.swapComponent = swapComponent;
 exports.swapStyle = swapStyle;
 exports.swapTemplate = swapTemplate;
 exports.track = track;
 exports.unwrap = unwrap;
 exports.wire = wire;
-/* version: 2.5.6 */
+/* version: 2.5.10-alpha1 */