@lwc/engine-core 6.6.2 → 7.0.0-alpha.0

package/LICENSE.md

@@ -15,7 +15,27 @@ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLI
 
 ## @parse5/tools
 
-MIT license defined in package.json in v0.4.0.
+The MIT License (MIT)
+
+Copyright © 2024 James Garbutt
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the “Software”), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.
 
 ## entities
 

package/dist/framework/api.d.ts

@@ -46,6 +46,16 @@ export type SanitizeHtmlContentHook = (content: unknown) => string;
  */
 export declare function setSanitizeHtmlContentHook(newHookImpl: SanitizeHtmlContentHook): void;
 declare function shc(content: unknown): string;
+/**
+ * [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
+ */
+declare function ncls(value: unknown): string;
 declare const api: Readonly<{
     s: typeof s;
     h: typeof h;
@@ -67,6 +77,7 @@ declare const api: Readonly<{
     ssf: typeof ssf;
     ddc: typeof ddc;
     sp: typeof sp;
+    ncls: typeof ncls;
 }>;
 export default api;
 export type RenderAPI = typeof api;

package/dist/framework/base-lightning-element.d.ts

@@ -23,7 +23,7 @@ export interface LightningElementConstructor {
 }
 type HTMLElementTheGoodParts = {
     toString: () => string;
-} & Pick<HTMLElement, 'accessKey' | 'addEventListener' | 'attachInternals' | 'children' | 'childNodes' | 'classList' | 'dir' | 'dispatchEvent' | 'draggable' | 'firstChild' | 'firstElementChild' | 'getAttribute' | 'getAttributeNS' | 'getBoundingClientRect' | 'getElementsByClassName' | 'getElementsByTagName' | 'hasAttribute' | 'hasAttributeNS' | 'hidden' | 'id' | 'isConnected' | 'lang' | 'lastChild' | 'lastElementChild' | 'ownerDocument' | 'querySelector' | 'querySelectorAll' | 'removeAttribute' | 'removeAttributeNS' | 'removeEventListener' | 'setAttribute' | 'setAttributeNS' | 'shadowRoot' | 'spellcheck' | 'tabIndex' | 'tagName' | 'title'>;
+} & Pick<HTMLElement, 'accessKey' | 'addEventListener' | 'attachInternals' | 'children' | 'childNodes' | 'classList' | 'dir' | 'dispatchEvent' | 'draggable' | 'firstChild' | 'firstElementChild' | 'getAttribute' | 'getAttributeNS' | 'getBoundingClientRect' | 'getElementsByClassName' | 'getElementsByTagName' | 'hasAttribute' | 'hasAttributeNS' | 'hidden' | 'id' | 'isConnected' | 'lang' | 'lastChild' | 'lastElementChild' | 'ownerDocument' | 'querySelector' | 'querySelectorAll' | 'removeAttribute' | 'removeAttributeNS' | 'removeEventListener' | 'setAttribute' | 'setAttributeNS' | 'shadowRoot' | 'spellcheck' | 'tabIndex' | 'tagName' | 'title' | 'style'>;
 type RefNodes = {
     [name: string]: Element;
 };

package/dist/framework/decorators/api.d.ts

@@ -1,11 +1,8 @@
 /**
- * The @api decorator marks public fields and public methods in
+ * The `@api` decorator marks public fields and public methods in
  * LWC Components. This function implements the internals of this
  * decorator.
- * @param target
- * @param propertyKey
- * @param descriptor
  */
-export default function api(target: any, propertyKey: string, descriptor: PropertyDescriptor): void;
+export default function api(value: unknown, context: ClassMemberDecoratorContext | string | symbol): void;
 export declare function createPublicPropertyDescriptor(key: string): PropertyDescriptor;
 export declare function createPublicAccessorDescriptor(key: PropertyKey, descriptor: PropertyDescriptor): PropertyDescriptor;

package/dist/framework/decorators/track.d.ts

@@ -1,10 +1,7 @@
 /**
- * The @track decorator function marks field values as reactive in
+ * The `@track` decorator function marks field values as reactive in
  * LWC Components. This function can also be invoked directly
  * with any value to obtain the trackable version of the value.
- * @param target
- * @param propertyKey
- * @param descriptor
  */
-export default function track(target: any, propertyKey: string, descriptor: PropertyDescriptor): any;
+export default function track(value: unknown, context: ClassMemberDecoratorContext | string | symbol): void;
 export declare function internalTrackDecorator(key: string): PropertyDescriptor;

package/dist/framework/decorators/wire.d.ts

@@ -1,10 +1,14 @@
 import { WireAdapterConstructor } from '../wiring';
 /**
- * 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;
+ * }
  */
-export default function wire(_adapter: WireAdapterConstructor, _config?: Record<string, any>): PropertyDecorator | MethodDecorator;
+export default function wire(adapter: WireAdapterConstructor, config?: Record<string, any>): (value: unknown, context: ClassMemberDecoratorContext | string | symbol) => void;
 export declare function internalWireFieldDecorator(key: string): PropertyDescriptor;

package/dist/framework/renderer.d.ts

@@ -40,6 +40,7 @@ export interface RendererAPI {
     getLastChild: (element: E) => N | null;
     getLastElementChild: (element: E) => E | null;
     getTagName: (element: E) => string;
+    getStyle: (elm: E) => CSSStyleDeclaration;
     isConnected: (node: N) => boolean;
     insertStylesheet: (content: string, target: ShadowRoot | undefined, signal: AbortSignal | undefined) => void;
     assertInstanceOfHTMLElement: (elm: any, msg: string) => void;

package/dist/index.cjs.js

@@ -1910,6 +1910,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 (!shared.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;
@@ -2262,12 +2275,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') {
         shared.assert.fail(`@api decorator can only be used as a decorator function.`);
     }
@@ -2340,7 +2362,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
@@ -2382,19 +2404,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') {
         shared.assert.fail('@wire(adapter, config?) may only be used as a decorator.');
     }
@@ -5558,6 +5588,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 (shared.isString(value)) {
+        res = value;
+    }
+    else if (shared.isArray(value)) {
+        for (let i = 0; i < value.length; i++) {
+            const normalized = ncls(value[i]);
+            if (normalized) {
+                res += normalized + ' ';
+            }
+        }
+    }
+    else if (shared.isObject(value)) {
+        for (const key in value) {
+            if (value[key]) {
+                res += key + ' ';
+            }
+        }
+    }
+    return shared.StringTrim.call(res);
+}
 const api = shared.freeze({
     s,
     h,
@@ -5579,6 +5640,7 @@ const api = shared.freeze({
     ssf,
     ddc,
     sp,
+    ncls,
 });
 
 /*
@@ -7965,5 +8027,5 @@ exports.swapTemplate = swapTemplate;
 exports.track = track;
 exports.unwrap = unwrap;
 exports.wire = wire;
-/** version: 6.6.2 */
+/** version: 7.0.0-alpha.0 */
 //# sourceMappingURL=index.cjs.js.map