@lwc/engine-core 6.3.0 → 6.3.2

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, ArraySplice, 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, isString, 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, kebabCaseToCamelCase, StringCharCodeAt, XML_NAMESPACE, XLINK_NAMESPACE, StringSlice, ArrayShift, ArrayUnshift, isTrue, SVG_NAMESPACE, KEY__SHADOW_STATIC, KEY__SHADOW_RESOLVER, ArraySome, ArrayPop, isNumber, StringReplace, 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 } from '@lwc/shared';
+import { noop, StringToLowerCase, isNull, ArrayPush as ArrayPush$1, ArrayJoin, isFrozen, isUndefined as isUndefined$1, defineProperty, ArrayIndexOf, ArraySplice, 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, kebabCaseToCamelCase, StringCharCodeAt, XML_NAMESPACE, XLINK_NAMESPACE, isString, StringSlice, ArrayShift, ArrayUnshift, isTrue, SVG_NAMESPACE, KEY__SHADOW_STATIC, KEY__SHADOW_RESOLVER, ArraySome, ArrayPop, isNumber, StringReplace, 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 } from '@lwc/shared';
 export { setFeatureFlag, setFeatureFlagForTest } from '@lwc/features';
 
 /*
@@ -522,6 +522,18 @@ function applyTemporaryCompilerV5SlotFix(data) {
     }
     return data;
 }
+function shouldBeFormAssociated(Ctor) {
+    const ctorFormAssociated = Boolean(Ctor.formAssociated);
+    const apiVersion = getComponentAPIVersion(Ctor);
+    const apiFeatureEnabled = isAPIFeatureEnabled(8 /* APIFeature.ENABLE_ELEMENT_INTERNALS_AND_FACE */, apiVersion);
+    if (process.env.NODE_ENV !== 'production' && ctorFormAssociated && !apiFeatureEnabled) {
+        const tagName = getComponentRegisteredName(Ctor);
+        logWarnOnce(`Component <${tagName}> set static formAssociated to true, but form ` +
+            `association is not enabled because the API version is ${apiVersion}. To enable form association, ` +
+            `update the LWC component API version to 61 or above. https://lwc.dev/guide/versioning`);
+    }
+    return ctorFormAssociated && apiFeatureEnabled;
+}
 
 /*
  * Copyright (c) 2020, salesforce.com, inc.
@@ -1663,79 +1675,6 @@ function warnIfInvokedDuringConstruction(vm, methodOrPropName) {
         logError(`this.${methodOrPropName} should not be called during the construction of the custom element for ${getComponentTag(vm)} because the element is not yet in the DOM or has no children yet.`);
     }
 }
-// List of properties on ElementInternals that are formAssociated can be found in the spec:
-// https://html.spec.whatwg.org/multipage/custom-elements.html#form-associated-custom-elements
-const formAssociatedProps = new Set([
-    'setFormValue',
-    'form',
-    'setValidity',
-    'willValidate',
-    'validity',
-    'validationMessage',
-    'checkValidity',
-    'reportValidity',
-    'labels',
-]);
-// Verify that access to a form-associated property of the ElementInternals proxy has formAssociated set in the LWC.
-function verifyPropForFormAssociation(propertyKey, isFormAssociated) {
-    if (isString(propertyKey) && formAssociatedProps.has(propertyKey) && !isFormAssociated) {
-        //Note this error message mirrors Chrome and Firefox error messages, in Safari the error is slightly different.
-        throw new DOMException(`Failed to execute '${propertyKey}' on 'ElementInternals': The target element is not a form-associated custom element.`);
-    }
-}
-const elementInternalsAccessorAllowList = new Set(['shadowRoot', 'role', ...formAssociatedProps]);
-// Prevent access to properties not defined in the HTML spec in case browsers decide to
-// provide new APIs that provide access to form associated properties.
-// This can be removed along with UpgradeableConstructor.
-function isAllowedElementInternalAccessor(propertyKey) {
-    let isAllowedAccessor = false;
-    // As of this writing all ElementInternal property keys as described in the spec are implemented with strings
-    // in Chrome, Firefox, and Safari
-    if (isString(propertyKey)) {
-        // Allow list is based on HTML spec:
-        // https://html.spec.whatwg.org/multipage/custom-elements.html#the-elementinternals-interface
-        isAllowedAccessor =
-            elementInternalsAccessorAllowList.has(propertyKey) || /^aria/.test(propertyKey);
-        if (!isAllowedAccessor && process.env.NODE_ENV !== 'production') {
-            logWarn('Only properties defined in the ElementInternals HTML spec are available.');
-        }
-    }
-    return isAllowedAccessor;
-}
-// Wrap all ElementInternal objects in a proxy to prevent form association when `formAssociated` is not set on an LWC.
-// This is needed because the 1UpgradeableConstructor1 always sets `formAssociated=true`, which means all
-// ElementInternal objects will have form-associated properties set when an LWC is placed in a form.
-// We are doing this to guard against customers taking a dependency on form elements being associated to ElementInternals
-// when 'formAssociated' has not been set on the LWC.
-function createElementInternalsProxy(elementInternals, isFormAssociated) {
-    const elementInternalsProxy = new Proxy(elementInternals, {
-        set(target, propertyKey, newValue) {
-            if (isAllowedElementInternalAccessor(propertyKey)) {
-                // Verify that formAssociated is set for form associated properties
-                verifyPropForFormAssociation(propertyKey, isFormAssociated);
-                return Reflect.set(target, propertyKey, newValue);
-            }
-            // As of this writing ElementInternals do not have non-string properties that can be set.
-            return false;
-        },
-        get(target, propertyKey) {
-            if (
-            // Pass through Object.prototype methods such as toString()
-            hasOwnProperty$1.call(Object.prototype, propertyKey) ||
-                // As of this writing, ElementInternals only uses Symbol.toStringTag which is called
-                // on Object.hasOwnProperty invocations
-                Symbol.for('Symbol.toStringTag') === propertyKey ||
-                // ElementInternals allow listed properties
-                isAllowedElementInternalAccessor(propertyKey)) {
-                // Verify that formAssociated is set for form associated properties
-                verifyPropForFormAssociation(propertyKey, isFormAssociated);
-                const propertyValue = Reflect.get(target, propertyKey);
-                return isFunction$1(propertyValue) ? propertyValue.bind(target) : propertyValue;
-            }
-        },
-    });
-    return elementInternalsProxy;
-}
 // Type assertion because we need to build the prototype before it satisfies the interface.
 LightningElement.prototype = {
     constructor: LightningElement,
@@ -1829,13 +1768,16 @@ LightningElement.prototype = {
     },
     attachInternals() {
         const vm = getAssociatedVM(this);
-        const { elm, def: { formAssociated }, renderer: { attachInternals }, } = vm;
+        const { elm, apiVersion, renderer: { attachInternals }, } = vm;
+        if (!isAPIFeatureEnabled(8 /* APIFeature.ENABLE_ELEMENT_INTERNALS_AND_FACE */, apiVersion)) {
+            throw new Error(`The attachInternals API is only supported in API version 61 and above. ` +
+                `The current version is ${apiVersion}. ` +
+                `To use this API, update the LWC component API version. https://lwc.dev/guide/versioning`);
+        }
         if (vm.shadowMode === 1 /* ShadowMode.Synthetic */) {
-            throw new Error('attachInternals API is not supported in light DOM or synthetic shadow.');
+            throw new Error('attachInternals API is not supported in synthetic shadow.');
         }
-        const internals = attachInternals(elm);
-        // #TODO[2970]: remove proxy once `UpgradeableConstructor` has been removed
-        return createElementInternalsProxy(internals, Boolean(formAssociated));
+        return attachInternals(elm);
     },
     get isConnected() {
         const vm = getAssociatedVM(this);
@@ -2073,11 +2015,10 @@ function createObservedFieldPropertyDescriptor(key) {
  */
 const AdapterToTokenMap = new Map();
 function createContextProviderWithRegister(adapter, registerContextProvider) {
-    let adapterContextToken = AdapterToTokenMap.get(adapter);
-    if (!isUndefined$1(adapterContextToken)) {
+    if (AdapterToTokenMap.has(adapter)) {
         throw new Error(`Adapter already has a context provider.`);
     }
-    adapterContextToken = guid();
+    const adapterContextToken = guid();
     AdapterToTokenMap.set(adapter, adapterContextToken);
     const providers = new WeakSet();
     return (elmOrComponent, options) => {
@@ -4309,7 +4250,8 @@ function mountCustomElement(vnode, parent, anchor, renderer) {
     // compatibility, we lower case the tagname here.
     const normalizedTagname = sel.toLowerCase();
     const useNativeLifecycle = shouldUseNativeCustomElementLifecycle(ctor);
-    const elm = createCustomElement(normalizedTagname, upgradeCallback, useNativeLifecycle);
+    const isFormAssociated = shouldBeFormAssociated(ctor);
+    const elm = createCustomElement(normalizedTagname, upgradeCallback, useNativeLifecycle, isFormAssociated);
     vnode.elm = elm;
     vnode.vm = vm;
     linkNodeToShadow(elm, owner, renderer);
@@ -6545,14 +6487,7 @@ function forceRehydration(vm) {
     }
 }
 function runFormAssociatedCustomElementCallback(vm, faceCb) {
-    const { renderMode, shadowMode, def: { formAssociated }, } = vm;
-    // Technically the UpgradableConstructor always sets `static formAssociated = true` but silently fail here to match browser behavior.
-    if (isUndefined$1(formAssociated) || isFalse(formAssociated)) {
-        if (process.env.NODE_ENV !== 'production') {
-            logWarn(`Form associated lifecycle methods must have the 'static formAssociated' value set in the component's prototype chain.`);
-        }
-        return;
-    }
+    const { renderMode, shadowMode } = vm;
     if (shadowMode === 1 /* ShadowMode.Synthetic */ && renderMode !== 0 /* RenderMode.Light */) {
         throw new Error('Form associated lifecycle methods are not available in synthetic shadow. Please use native shadow or light DOM.');
     }
@@ -7045,7 +6980,8 @@ function hydrateCustomElement(elm, vnode, renderer) {
     }
     const { sel, mode, ctor, owner } = vnode;
     const { defineCustomElement, getTagName } = renderer;
-    defineCustomElement(StringToLowerCase.call(getTagName(elm)));
+    const isFormAssociated = shouldBeFormAssociated(ctor);
+    defineCustomElement(StringToLowerCase.call(getTagName(elm)), isFormAssociated);
     const vm = createVM(elm, ctor, renderer, {
         mode,
         owner,
@@ -7622,6 +7558,6 @@ function readonly(obj) {
     return getReadOnlyProxy(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, swapComponent, swapStyle, swapTemplate, track, unwrap, wire };
-/** version: 6.3.0 */
+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.3.2 */
 //# sourceMappingURL=index.js.map