@lwc/engine-core 6.2.1 → 6.3.0

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

@@ -23,13 +23,14 @@ 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' | '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'>;
 type RefNodes = {
     [name: string]: Element;
 };
 export interface LightningElement extends HTMLElementTheGoodParts, AccessibleElementProperties {
+    constructor: LightningElementConstructor;
     template: ShadowRoot | null;
-    refs: RefNodes;
+    refs: RefNodes | undefined;
     render(): Template;
     connectedCallback?(): void;
     disconnectedCallback?(): void;

package/dist/index.cjs.js

@@ -132,7 +132,7 @@ function addErrorComponentStack(vm, error) {
 }
 
 /*
- * 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
@@ -140,7 +140,6 @@ function addErrorComponentStack(vm, error) {
 const alreadyLoggedMessages = new Set();
 // Only used in LWC's Karma tests
 if (process.env.NODE_ENV === 'test-karma-lwc') {
-    // @ts-ignore
     window.__lwcResetAlreadyLoggedMessages = () => {
         alreadyLoggedMessages.clear();
     };
@@ -798,7 +797,7 @@ function getShadowRootRestrictionsDescriptors(sr) {
                     logError('The `addEventListener` method on ShadowRoot does not support any options.', getAssociatedVMIfPresent(this));
                 }
                 // Typescript does not like it when you treat the `arguments` object as an array
-                // @ts-ignore type-mismatch
+                // @ts-expect-error type-mismatch
                 return originalAddEventListener.apply(this, arguments);
             },
         }),
@@ -847,7 +846,7 @@ function getCustomElementRestrictionsDescriptors(elm) {
                     logError('The `addEventListener` method in `LightningElement` does not support any options.', getAssociatedVMIfPresent(this));
                 }
                 // Typescript does not like it when you treat the `arguments` object as an array
-                // @ts-ignore type-mismatch
+                // @ts-expect-error type-mismatch
                 return originalAddEventListener.apply(this, arguments);
             },
         }),
@@ -1599,7 +1598,7 @@ 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.
  */
-// @ts-ignore
+// @ts-expect-error When exported, it will conform, but we need to build it first!
 const LightningElement = function () {
     // This should be as performant as possible, while any initialization should be done lazily
     if (shared.isNull(vmBeingConstructed)) {
@@ -1741,7 +1740,7 @@ function createElementInternalsProxy(elementInternals, isFormAssociated) {
     });
     return elementInternalsProxy;
 }
-// @ts-ignore
+// Type assertion because we need to build the prototype before it satisfies the interface.
 LightningElement.prototype = {
     constructor: LightningElement,
     dispatchEvent(event) {
@@ -1943,6 +1942,9 @@ LightningElement.prototype = {
         if (process.env.NODE_ENV !== 'production') {
             warnIfInvokedDuringConstruction(vm, 'childNodes');
         }
+        // getChildNodes returns a NodeList, which has `item(index: number): Node | null`.
+        // NodeListOf<T> extends NodeList, but claims to not return null. That seems inaccurate,
+        // but these are built-in types, so ultimately not our problem.
         return renderer.getChildNodes(vm.elm);
     },
     get firstChild() {
@@ -2182,7 +2184,7 @@ function createConfigWatcher(component, configCallback, callbackWhenConfigIsRead
         ro.observe(() => (config = configCallback(component)));
         // eslint-disable-next-line @lwc/lwc-internal/no-invalid-todo
         // TODO: dev-mode validation of config based on the adapter.configSchema
-        // @ts-ignore it is assigned in the observe() callback
+        // @ts-expect-error it is assigned in the observe() callback
         callbackWhenConfigIsReady(config);
     };
     return {
@@ -2258,7 +2260,7 @@ function createConnector(vm, name, wireDef) {
         });
     }
     return {
-        // @ts-ignore the boundary protection executes sync, connector is always defined
+        // @ts-expect-error the boundary protection executes sync, connector is always defined
         connector,
         computeConfigAndUpdate,
         resetConfigWatcher: () => ro.reset(),
@@ -2737,7 +2739,6 @@ function getDecoratorsMeta(Ctor) {
 let warned = false;
 // Only used in LWC's Karma tests
 if (process.env.NODE_ENV === 'test-karma-lwc') {
-    // @ts-ignore
     window.__lwcResetWarnedOnVersionMismatch = () => {
         warned = false;
     };
@@ -2855,7 +2856,7 @@ function createAttributeChangedCallback(attributeToPropMap, superAttributeChange
             if (!shared.isUndefined(superAttributeChangedCallback)) {
                 // delegate unknown attributes to the super.
                 // Typescript does not like it when you treat the `arguments` object as an array
-                // @ts-ignore type-mismatch
+                // @ts-expect-error type-mismatch
                 superAttributeChangedCallback.apply(this, arguments);
             }
             return;
@@ -5608,9 +5609,27 @@ function validateLightDomTemplate(template, vm) {
         }
     }
 }
+// This should be a no-op outside of LWC's Karma tests, where it's not needed
+let registerFragmentCache = shared.noop;
+// Only used in LWC's Karma tests
+if (process.env.NODE_ENV === 'test-karma-lwc') {
+    // Keep track of fragmentCaches, so we can clear them in LWC's Karma tests
+    const fragmentCaches = [];
+    registerFragmentCache = (fragmentCache) => {
+        fragmentCaches.push(fragmentCache);
+    };
+    window.__lwcResetFragmentCaches = () => {
+        for (const fragmentCache of fragmentCaches) {
+            for (const key of shared.keys(fragmentCache)) {
+                delete fragmentCache[key];
+            }
+        }
+    };
+}
 function buildParseFragmentFn(createFragmentFn) {
     return (strings, ...keys) => {
         const cache = shared.create(null);
+        registerFragmentCache(cache);
         return function () {
             const { context: { hasScopedStyles, stylesheetToken, legacyStylesheetToken }, shadowMode, renderer, } = getVMBeingRendered();
             const hasStyleToken = !shared.isUndefined(stylesheetToken);
@@ -5623,11 +5642,6 @@ function buildParseFragmentFn(createFragmentFn) {
             if (hasStyleToken && isSyntheticShadow) {
                 cacheKey |= 2 /* FragmentCache.SHADOW_MODE_SYNTHETIC */;
             }
-            if (hasLegacyToken) {
-                // This isn't strictly required for prod, but it's required for our karma tests
-                // since the lwcRuntimeFlag may change over time
-                cacheKey |= 4 /* FragmentCache.HAS_LEGACY_SCOPE_TOKEN */;
-            }
             if (!shared.isUndefined(cache[cacheKey])) {
                 return cache[cacheKey];
             }
@@ -6817,7 +6831,6 @@ function enableDetection() {
                 throw new Error('detect-non-standard-aria.ts loaded before @lwc/aria-reflection');
             }
         }
-        // @ts-ignore
         const { get, set } = descriptor;
         // It's important for this defineProperty call to happen _after_ ARIA accessors are applied to the
         // BaseBridgeElement and LightningElement prototypes. Otherwise, we will log/report for access of non-standard
@@ -7428,7 +7441,7 @@ function warnOnArrayMutation(stylesheets) {
         const originalArrayMethod = getOriginalArrayMethod(prop);
         stylesheets[prop] = function arrayMutationWarningWrapper() {
             reportTemplateViolation('stylesheets');
-            // @ts-ignore
+            // @ts-expect-error can't properly determine the right `this`
             return originalArrayMethod.apply(this, arguments);
         };
     }
@@ -7656,5 +7669,5 @@ exports.swapTemplate = swapTemplate;
 exports.track = track;
 exports.unwrap = unwrap;
 exports.wire = wire;
-/** version: 6.2.1 */
+/** version: 6.3.0 */
 //# sourceMappingURL=index.cjs.js.map