@lwc/engine-core 6.7.2 → 7.0.0-alpha.1

package/dist/index.js

@@ -1,7 +1,7 @@
 /**
  * Copyright (c) 2024 Salesforce, Inc.
  */
-import { noop, StringToLowerCase, isNull, ArrayPush as ArrayPush$1, ArrayJoin, isFrozen, isUndefined as isUndefined$1, defineProperty, ArrayIndexOf, ArrayPop, create, isFalse, isFunction as isFunction$1, isObject, seal, isAPIFeatureEnabled, isArray as isArray$1, keys, hasOwnProperty as hasOwnProperty$1, entries, AriaPropNameToAttrNameMap, getPropertyDescriptor, forEach, defineProperties, getPrototypeOf as getPrototypeOf$1, setPrototypeOf, assign, freeze, KEY__SYNTHETIC_MODE, assert, toString as toString$1, getOwnPropertyDescriptor as getOwnPropertyDescriptor$1, LWC_VERSION_COMMENT_REGEX, LWC_VERSION, getOwnPropertyNames as getOwnPropertyNames$1, getOwnPropertyDescriptors, htmlPropertyToAttribute, ArraySlice, ArrayMap, KEY__SCOPED_CSS, ArraySplice, kebabCaseToCamelCase, StringCharCodeAt, XML_NAMESPACE, XLINK_NAMESPACE, isString, StringSlice, isTrue, SVG_NAMESPACE, KEY__SHADOW_STATIC, KEY__SHADOW_RESOLVER, ArraySome, isNumber, StringReplace, htmlEscape, StringCharAt, 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, ArrayPop, create, isFalse, isFunction as isFunction$1, isObject, seal, isAPIFeatureEnabled, isArray as isArray$1, keys, hasOwnProperty as hasOwnProperty$1, entries, AriaPropNameToAttrNameMap, getPropertyDescriptor, forEach, defineProperties, getPrototypeOf as getPrototypeOf$1, setPrototypeOf, assign, assert, freeze, KEY__SYNTHETIC_MODE, toString as toString$1, getOwnPropertyDescriptor as getOwnPropertyDescriptor$1, LWC_VERSION_COMMENT_REGEX, LWC_VERSION, getOwnPropertyNames as getOwnPropertyNames$1, getOwnPropertyDescriptors, htmlPropertyToAttribute, ArraySlice, ArrayMap, KEY__SCOPED_CSS, ArraySplice, kebabCaseToCamelCase, StringCharCodeAt, XML_NAMESPACE, XLINK_NAMESPACE, isString, StringSlice, isTrue, SVG_NAMESPACE, KEY__SHADOW_STATIC, KEY__SHADOW_RESOLVER, ArraySome, isNumber, StringReplace, StringTrim, htmlEscape, StringCharAt, 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';
 export { setFeatureFlag, setFeatureFlagForTest } from '@lwc/features';
 
 /*
@@ -1513,7 +1513,7 @@ function applyShadowMigrateMode(shadowRoot) {
 }
 
 /*
- * Copyright (c) 2018, salesforce.com, inc.
+ * Copyright (c) 2024, Salesforce, 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
@@ -1780,6 +1780,25 @@ LightningElement.prototype = {
         }
         return vm.shadowRoot;
     },
+    get hostElement() {
+        const vm = getAssociatedVM(this);
+        if (!process.env.IS_BROWSER) {
+            assert.fail('this.hostElement is not supported in this environment');
+        }
+        const apiVersion = getComponentAPIVersion(vm.def.ctor);
+        if (!isAPIFeatureEnabled(9 /* APIFeature.ENABLE_THIS_DOT_HOST_ELEMENT */, apiVersion)) {
+            if (process.env.NODE_ENV !== 'production') {
+                logWarnOnce('The `this.hostElement` API within LightningElement is ' +
+                    'only supported in API version 62 and above. Increase the API version to use it.');
+            }
+            // Simulate the old behavior for `this.hostElement` to avoid a breaking change
+            return undefined;
+        }
+        if (process.env.NODE_ENV !== 'production') {
+            assert.isTrue(vm.elm instanceof Element, `this.hostElement should be an Element, found: ${vm.elm}`);
+        }
+        return vm.elm;
+    },
     get refs() {
         const vm = getAssociatedVM(this);
         if (isUpdatingTemplate) {
@@ -1906,6 +1925,19 @@ LightningElement.prototype = {
         const { elm, renderer } = getAssociatedVM(this);
         return renderer.getTagName(elm);
     },
+    get style() {
+        const { elm, renderer, def } = getAssociatedVM(this);
+        const apiVersion = getComponentAPIVersion(def.ctor);
+        if (!isAPIFeatureEnabled(10 /* APIFeature.ENABLE_THIS_DOT_STYLE */, apiVersion)) {
+            if (process.env.NODE_ENV !== 'production') {
+                logWarnOnce('The `this.style` API within LightningElement returning the CSSStyleDeclaration is ' +
+                    'only supported in API version 62 and above. Increase the API version to use it.');
+            }
+            // Simulate the old behavior for `this.style` to avoid a breaking change
+            return undefined;
+        }
+        return renderer.getStyle(elm);
+    },
     render() {
         const vm = getAssociatedVM(this);
         return vm.def.template;
@@ -2258,12 +2290,21 @@ function disconnectWireAdapters(vm) {
 }
 
 /*
- * Copyright (c) 2018, salesforce.com, inc.
+ * Copyright (c) 2024, Salesforce, 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 api$1() {
+/**
+ * The `@api` decorator marks public fields and public methods in
+ * LWC Components. This function implements the internals of this
+ * decorator.
+ */
+function api$1(
+// eslint-disable-next-line @typescript-eslint/no-unused-vars
+value, 
+// eslint-disable-next-line @typescript-eslint/no-unused-vars
+context) {
     if (process.env.NODE_ENV !== 'production') {
         assert.fail(`@api decorator can only be used as a decorator function.`);
     }
@@ -2336,7 +2377,7 @@ function createPublicAccessorDescriptor(key, descriptor) {
 }
 
 /*
- * Copyright (c) 2018, salesforce.com, inc.
+ * Copyright (c) 2024, Salesforce, 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
@@ -2378,19 +2419,27 @@ function internalTrackDecorator(key) {
 }
 
 /*
- * Copyright (c) 2018, salesforce.com, inc.
+ * Copyright (c) 2024, Salesforce, 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
  */
 /**
- * The @wire decorator wires fields and methods to a wire adapter in
- * LWC Components. This function implements the internals of this
- * decorator.
- * @param _adapter
- * @param _config
+ * Decorator factory to wire a property or method to a wire adapter data source.
+ * @param adapter the adapter used to provision data
+ * @param config configuration object for the adapter
+ * @returns A decorator function
+ * @example
+ * export default class WireExample extends LightningElement {
+ *   \@api bookId;
+ *   \@wire(getBook, { id: '$bookId'}) book;
+ * }
  */
-function wire(_adapter, _config) {
+function wire(
+// eslint-disable-next-line @typescript-eslint/no-unused-vars
+adapter, 
+// eslint-disable-next-line @typescript-eslint/no-unused-vars
+config) {
     if (process.env.NODE_ENV !== 'production') {
         assert.fail('@wire(adapter, config?) may only be used as a decorator.');
     }
@@ -2426,13 +2475,13 @@ function internalWireFieldDecorator(key) {
  */
 function getClassDescriptorType(descriptor) {
     if (isFunction$1(descriptor.value)) {
-        return "method" /* DescriptorType.Method */;
+        return 'method';
     }
     else if (isFunction$1(descriptor.set) || isFunction$1(descriptor.get)) {
-        return "accessor" /* DescriptorType.Accessor */;
+        return 'accessor';
     }
     else {
-        return "field" /* DescriptorType.Field */;
+        return 'field';
     }
 }
 function validateObservedField(Ctor, fieldName, descriptor) {
@@ -2662,9 +2711,7 @@ function checkVersionMismatch(func, type) {
     const versionMatcher = func.toString().match(LWC_VERSION_COMMENT_REGEX);
     if (!isNull(versionMatcher) && !warned) {
         const version = versionMatcher[1];
-        const [major, minor] = version.split('.');
-        const [expectedMajor, expectedMinor] = LWC_VERSION.split('.');
-        if (major !== expectedMajor || minor !== expectedMinor) {
+        if (version !== LWC_VERSION) {
             warned = true; // only warn once to avoid flooding the console
             // stylesheets and templates do not have user-meaningful names, but components do
             const friendlyName = type === 'component' ? `${type} ${func.name}` : type;
@@ -3297,7 +3344,7 @@ let swappedComponentMap =
 let swappedStyleMap = /*@__PURE__@*/ new WeakMap();
 // The important thing here is the weak values – VMs are transient (one per component instance) and should be GC'ed,
 // so we don't want to create strong references to them.
-// The weak keys are kind of useless, because Templates, LightningElementConstructors, and StylesheetFactories are
+// The weak keys are kind of useless, because Templates, LightningElementConstructors, and Stylesheets are
 // never GC'ed. But maybe they will be someday, so we may as well use weak keys too.
 // The "pure" annotations are so that Rollup knows for sure it can remove these from prod mode
 let activeTemplates = /*@__PURE__@*/ new WeakMultiMap();
@@ -3530,13 +3577,13 @@ function createComponentDef(Ctor) {
             logError(`Missing ${ctorName}.constructor, ${ctorName} should have a "constructor" property.`);
         }
         if (!isUndefined$1(ctorShadowSupportMode) &&
-            ctorShadowSupportMode !== "any" /* ShadowSupportMode.Any */ &&
-            ctorShadowSupportMode !== "reset" /* ShadowSupportMode.Default */ &&
-            ctorShadowSupportMode !== "native" /* ShadowSupportMode.Native */) {
+            ctorShadowSupportMode !== 'any' &&
+            ctorShadowSupportMode !== 'reset' &&
+            ctorShadowSupportMode !== 'native') {
             logError(`Invalid value for static property shadowSupportMode: '${ctorShadowSupportMode}'`);
         }
         // TODO [#3971]: Completely remove shadowSupportMode "any"
-        if (ctorShadowSupportMode === "any" /* ShadowSupportMode.Any */) {
+        if (ctorShadowSupportMode === 'any') {
             logWarn(`Invalid value 'any' for static property shadowSupportMode. 'any' is deprecated and will be removed in a future release--use 'native' instead.`);
         }
         if (!isUndefined$1(ctorRenderMode) &&
@@ -3570,8 +3617,7 @@ function createComponentDef(Ctor) {
     if (!isUndefined$1(ctorShadowSupportMode)) {
         shadowSupportMode = ctorShadowSupportMode;
         if (isReportingEnabled() &&
-            (shadowSupportMode === "any" /* ShadowSupportMode.Any */ ||
-                shadowSupportMode === "native" /* ShadowSupportMode.Native */)) {
+            (shadowSupportMode === 'any' || shadowSupportMode === 'native')) {
             report("ShadowSupportModeUsage" /* ReportingEventId.ShadowSupportModeUsage */, {
                 tagName: Ctor.name,
                 mode: shadowSupportMode,
@@ -3686,7 +3732,7 @@ const lightingElementDef = {
     propsConfig: EmptyObject,
     methods: EmptyObject,
     renderMode: 1 /* RenderMode.Shadow */,
-    shadowSupportMode: "reset" /* ShadowSupportMode.Default */,
+    shadowSupportMode: 'reset',
     formAssociated: undefined,
     wire: EmptyObject,
     bridge: BaseBridgeElement,
@@ -3710,7 +3756,7 @@ function getComponentDef(Ctor) {
         // avoid leaking the reference to the public props descriptors
         publicProps[key] = {
             config: propsConfig[key] || 0, // a property by default
-            type: "any" /* PropDefType.any */, // no type inference for public services
+            type: 'any', // no type inference for public services
             attr: htmlPropertyToAttribute(key),
         };
     }
@@ -4687,14 +4733,14 @@ function applyStyleScoping(elm, owner, renderer) {
 }
 function applyDomManual(elm, vnode) {
     const { owner, data: { context }, } = vnode;
-    if (owner.shadowMode === 1 /* ShadowMode.Synthetic */ && context?.lwc?.dom === "manual" /* LwcDomMode.Manual */) {
+    if (owner.shadowMode === 1 /* ShadowMode.Synthetic */ && context?.lwc?.dom === 'manual') {
         elm.$domManual$ = true;
     }
 }
 function applyElementRestrictions(elm, vnode) {
     if (process.env.NODE_ENV !== 'production') {
         const isSynthetic = vnode.owner.shadowMode === 1 /* ShadowMode.Synthetic */;
-        const isPortal = vnode.type === 2 /* VNodeType.Element */ && vnode.data.context?.lwc?.dom === "manual" /* LwcDomMode.Manual */;
+        const isPortal = vnode.type === 2 /* VNodeType.Element */ && vnode.data.context?.lwc?.dom === 'manual';
         const isLight = vnode.owner.renderMode === 0 /* RenderMode.Light */;
         patchElementWithRestrictions(elm, {
             isPortal,
@@ -5579,6 +5625,37 @@ function setSanitizeHtmlContentHook(newHookImpl) {
 function shc(content) {
     return sanitizeHtmlContentHook(content);
 }
+/**
+ * [ncls] - Normalize class name attribute.
+ *
+ * Transforms the provided class property value from an object/string into a string the diffing algo
+ * can operate on.
+ *
+ * This implementation is borrowed from Vue:
+ * https://github.com/vuejs/core/blob/e790e1bdd7df7be39e14780529db86e4da47a3db/packages/shared/src/normalizeProp.ts#L63-L82
+ */
+function ncls(value) {
+    let res = '';
+    if (isString(value)) {
+        res = value;
+    }
+    else if (isArray$1(value)) {
+        for (let i = 0; i < value.length; i++) {
+            const normalized = ncls(value[i]);
+            if (normalized) {
+                res += normalized + ' ';
+            }
+        }
+    }
+    else if (isObject(value)) {
+        for (const key in value) {
+            if (value[key]) {
+                res += key + ' ';
+            }
+        }
+    }
+    return StringTrim.call(res);
+}
 const api = freeze({
     s,
     h,
@@ -5600,6 +5677,7 @@ const api = freeze({
     ssf,
     ddc,
     sp,
+    ncls,
 });
 
 /*
@@ -6481,7 +6559,7 @@ function computeShadowMode(def, owner, renderer, hydrated) {
             // everything defaults to native when the synthetic shadow polyfill is unavailable.
             shadowMode = 0 /* ShadowMode.Native */;
         }
-        else if (def.shadowSupportMode === "native" /* ShadowSupportMode.Native */) {
+        else if (def.shadowSupportMode === 'native') {
             shadowMode = 0 /* ShadowMode.Native */;
         }
         else {
@@ -7276,7 +7354,7 @@ function hydrateElement(elm, vnode, renderer) {
     vnode.elm = elm;
     const { owner } = vnode;
     const { context } = vnode.data;
-    const isDomManual = Boolean(!isUndefined$1(context) && !isUndefined$1(context.lwc) && context.lwc.dom === "manual" /* LwcDomMode.Manual */);
+    const isDomManual = Boolean(!isUndefined$1(context) && !isUndefined$1(context.lwc) && context.lwc.dom === '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.
@@ -7951,5 +8029,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, shouldBeFormAssociated, swapComponent, swapStyle, swapTemplate, track, unwrap, wire };
-/** version: 6.7.2 */
+/** version: 7.0.0-alpha.0 */
 //# sourceMappingURL=index.js.map