@ui5/webcomponents-base 0.0.0-7a547f8cc → 0.0.0-7c7170d4a

package/dist/UI5Element.js

@@ -1,11 +1,12 @@
+// eslint-disable-next-line import/no-extraneous-dependencies
+import "@ui5/webcomponents-base/dist/ssr-dom.js";
 import merge from "./thirdparty/merge.js";
 import { boot } from "./Boot.js";
 import UI5ElementMetadata from "./UI5ElementMetadata.js";
 import EventProvider from "./EventProvider.js";
-import getSingletonElementInstance from "./util/getSingletonElementInstance.js";
-import StaticAreaItem from "./StaticAreaItem.js";
 import updateShadowRoot from "./updateShadowRoot.js";
-import { renderDeferred, renderImmediately, cancelRender } from "./Render.js";
+import { shouldIgnoreCustomElement } from "./IgnoreCustomElements.js";
+import { renderDeferred, renderImmediately, cancelRender, } from "./Render.js";
 import { registerTag, isTagRegistered, recordTagRegistrationFailure } from "./CustomElementsRegistry.js";
 import { observeDOMNode, unobserveDOMNode } from "./DOMObserver.js";
 import { skipOriginalEvent } from "./config/NoConflict.js";
@@ -15,7 +16,9 @@ import isValidPropertyName from "./util/isValidPropertyName.js";
 import { getSlotName, getSlottedNodesList } from "./util/SlotsHelper.js";
 import arraysAreEqual from "./util/arraysAreEqual.js";
 import { markAsRtlAware } from "./locale/RTLAwareRegistry.js";
-import preloadLinks from "./theming/preloadLinks.js";
+import executeTemplate, { getTagsToScope } from "./renderer/executeTemplate.js";
+import { attachFormElementInternals, setFormValue } from "./features/InputElementsFormSupport.js";
+const DEV_MODE = true;
 let autoId = 0;
 const elementTimeouts = new Map();
 const uniqueDependenciesCache = new Map();
@@ -34,16 +37,28 @@ function _invalidate(changeInfo) {
     this.onInvalidation(changeInfo);
     this._changedState.push(changeInfo);
     renderDeferred(this);
-    this._eventProvider.fireEvent("invalidate", { ...changeInfo, target: this });
+    this._invalidationEventProvider.fireEvent("invalidate", { ...changeInfo, target: this });
 }
-let metadata = {};
 /**
+ * looks up a property descsriptor including in the prototype chain
+ * @param proto the starting prototype
+ * @param name the property to look for
+ * @returns the property descriptor if found directly or in the prototype chaing, undefined if not found
+ */
+function getPropertyDescriptor(proto, name) {
+    do {
+        const descriptor = Object.getOwnPropertyDescriptor(proto, name);
+        if (descriptor) {
+            return descriptor;
+        }
+        // go up the prototype chain
+        proto = Object.getPrototypeOf(proto);
+    } while (proto && proto !== HTMLElement.prototype);
+}
+/**
+ * @class
  * Base class for all UI5 Web Components
  *
- * @class
- * @constructor
- * @author SAP SE
- * @alias sap.ui.webc.base.UI5Element
  * @extends HTMLElement
  * @public
  */
@@ -57,7 +72,8 @@ class UI5Element extends HTMLElement {
         this._fullyConnected = false; // A flag telling whether the UI5Element's onEnterDOM hook was called (since it's possible to have the element removed from DOM before that)
         this._childChangeListeners = new Map(); // used to store lazy listeners per slot for the child change event of every child inside that slot
         this._slotChangeListeners = new Map(); // used to store lazy listeners per slot for the slotchange event of all slot children inside that slot
-        this._eventProvider = new EventProvider(); // used by parent components for listening to changes to child components
+        this._invalidationEventProvider = new EventProvider(); // used by parent components for listening to changes to child components
+        this._componentStateFinalizedEventProvider = new EventProvider(); // used by friend classes for synchronization
         let deferredResolve;
         this._domRefReadyPromise = new Promise(resolve => {
             deferredResolve = resolve;
@@ -67,7 +83,8 @@ class UI5Element extends HTMLElement {
         this._state = { ...ctor.getMetadata().getInitialState() };
         this._upgradeAllProperties();
         if (ctor._needsShadowDOM()) {
-            this.attachShadow({ mode: "open" });
+            const defaultOptions = { mode: "open" };
+            this.attachShadow({ ...defaultOptions, ...ctor.getMetadata().getShadowRootOptions() });
         }
     }
     /**
@@ -82,11 +99,36 @@ class UI5Element extends HTMLElement {
         }
         return this.__id;
     }
+    render() {
+        const template = this.constructor.template;
+        return executeTemplate(template, this);
+    }
     /**
      * Do not call this method from derivatives of UI5Element, use "onEnterDOM" only
      * @private
      */
     async connectedCallback() {
+        if (DEV_MODE) {
+            const rootNode = this.getRootNode();
+            // when an element is connected, check if it exists in the `dependencies` of the parent
+            if (rootNode instanceof ShadowRoot && instanceOfUI5Element(rootNode.host)) {
+                const klass = rootNode.host.constructor;
+                const hasDependency = getTagsToScope(rootNode.host).includes(this.constructor.getMetadata().getPureTag());
+                if (!hasDependency) {
+                    // eslint-disable-next-line no-console
+                    console.error(`[UI5-FWK] ${this.constructor.getMetadata().getTag()} not found in dependencies of ${klass.getMetadata().getTag()}`);
+                }
+            }
+        }
+        if (DEV_MODE) {
+            const props = this.constructor.getMetadata().getProperties();
+            for (const [prop, propData] of Object.entries(props)) { // eslint-disable-line
+                if (Object.hasOwn(this, prop)) {
+                    // eslint-disable-next-line no-console
+                    console.error(`[UI5-FWK] ${this.constructor.getMetadata().getTag()} has a property [${prop}] that is shadowed by the instance. Updates to this property will not invalidate the component. Possible reason is TS target ES2022 or TS useDefineForClassFields`);
+                }
+            }
+        }
         const ctor = this.constructor;
         this.setAttribute(ctor.getMetadata().getPureTag(), "");
         if (ctor.getMetadata().supportsF6FastNavigation()) {
@@ -122,9 +164,7 @@ class UI5Element extends HTMLElement {
             this.onExitDOM();
             this._fullyConnected = false;
         }
-        if (this.staticAreaItem && this.staticAreaItem.parentElement) {
-            this.staticAreaItem.parentElement.removeChild(this.staticAreaItem);
-        }
+        this._domRefReadyPromise._deferredResolve();
         cancelRender(this);
     }
     /**
@@ -152,14 +192,16 @@ class UI5Element extends HTMLElement {
      */
     _startObservingDOMChildren() {
         const ctor = this.constructor;
-        const shouldObserveChildren = ctor.getMetadata().hasSlots();
+        const metadata = ctor.getMetadata();
+        const shouldObserveChildren = metadata.hasSlots();
         if (!shouldObserveChildren) {
             return;
         }
-        const canSlotText = ctor.getMetadata().canSlotText();
+        const canSlotText = metadata.canSlotText();
+        const hasClonedSlot = Object.keys(metadata.getSlots()).some(slotName => metadata.getSlots()[slotName].cloned);
         const mutationObserverOptions = {
             childList: true,
-            subtree: canSlotText,
+            subtree: canSlotText || hasClonedSlot,
             characterData: canSlotText,
         };
         observeDOMNode(this, this._processChildren.bind(this), mutationObserverOptions);
@@ -220,11 +262,11 @@ class UI5Element extends HTMLElement {
             // Await for not-yet-defined custom elements
             if (child instanceof HTMLElement) {
                 const localName = child.localName;
-                const isCustomElement = localName.includes("-");
-                if (isCustomElement) {
-                    const isDefined = window.customElements.get(localName);
+                const shouldWaitForCustomElement = localName.includes("-") && !shouldIgnoreCustomElement(localName);
+                if (shouldWaitForCustomElement) {
+                    const isDefined = customElements.get(localName);
                     if (!isDefined) {
-                        const whenDefinedPromise = window.customElements.whenDefined(localName); // Class registered, but instances not upgraded yet
+                        const whenDefinedPromise = customElements.whenDefined(localName); // Class registered, but instances not upgraded yet
                         let timeoutPromise = elementTimeouts.get(localName);
                         if (!timeoutPromise) {
                             timeoutPromise = new Promise(resolve => setTimeout(resolve, 1000));
@@ -232,7 +274,7 @@ class UI5Element extends HTMLElement {
                         }
                         await Promise.race([whenDefinedPromise, timeoutPromise]);
                     }
-                    window.customElements.upgrade(child);
+                    customElements.upgrade(child);
                 }
             }
             child = ctor.getMetadata().constructor.validateSlotValue(child, slotData);
@@ -272,6 +314,9 @@ class UI5Element extends HTMLElement {
                     reason: "children",
                 });
                 invalidated = true;
+                if (ctor.getMetadata().isFormAssociated()) {
+                    setFormValue(this);
+                }
             }
         }
         // If none of the slots had an invalidation due to changes to immediate children,
@@ -307,26 +352,26 @@ class UI5Element extends HTMLElement {
     /**
      * Attach a callback that will be executed whenever the component is invalidated
      *
-     * @param {InvalidationInfo} callback
+     * @param callback
      * @public
      */
     attachInvalidate(callback) {
-        this._eventProvider.attachEvent("invalidate", callback);
+        this._invalidationEventProvider.attachEvent("invalidate", callback);
     }
     /**
      * Detach the callback that is executed whenever the component is invalidated
      *
-     * @param {InvalidationInfo} callback
+     * @param callback
      * @public
      */
     detachInvalidate(callback) {
-        this._eventProvider.detachEvent("invalidate", callback);
+        this._invalidationEventProvider.detachEvent("invalidate", callback);
     }
     /**
      * Callback that is executed whenever a monitored child changes its state
      *
-     * @param {sting} slotName the slot in which a child was invalidated
-     * @param { ChangeInfo } childChangeInfo the changeInfo object for the child in the given slot
+     * @param slotName the slot in which a child was invalidated
+     * @param childChangeInfo the changeInfo object for the child in the given slot
      * @private
      */
     _onChildChange(slotName, childChangeInfo) {
@@ -373,6 +418,16 @@ class UI5Element extends HTMLElement {
             this[nameInCamelCase] = newPropertyValue;
         }
     }
+    formAssociatedCallback() {
+        const ctor = this.constructor;
+        if (!ctor.getMetadata().isFormAssociated()) {
+            return;
+        }
+        attachFormElementInternals(this);
+    }
+    static get formAssociated() {
+        return this.getMetadata().isFormAssociated();
+    }
     /**
      * @private
      */
@@ -436,7 +491,6 @@ class UI5Element extends HTMLElement {
      * Returns a singleton event listener for the "change" event of a child in a given slot
      *
      * @param slotName the name of the slot, where the child is
-     * @returns {ChildChangeListener}
      * @private
      */
     _getChildChangeListener(slotName) {
@@ -449,7 +503,6 @@ class UI5Element extends HTMLElement {
      * Returns a singleton slotchange event listener that invalidates the component due to changes in the given slot
      *
      * @param slotName the name of the slot, where the slot element (whose slotchange event we're listening to) is
-     * @returns {SlotChangeListener}
      * @private
      */
     _getSlotChangeListener(slotName) {
@@ -501,9 +554,9 @@ class UI5Element extends HTMLElement {
      *   1) children: immediate children (HTML elements or text nodes) were added, removed or reordered in the slot
      *   2) textcontent: text nodes in the slot changed value (or nested text nodes were added or changed value). Can only trigger for slots of "type: Node"
      *   3) slotchange: a slot element, slotted inside that slot had its "slotchange" event listener called. This practically means that transitively slotted children changed.
-     *      Can only trigger if the child of a slot is a slot element itself.
+     *	  Can only trigger if the child of a slot is a slot element itself.
      *   4) childchange: indicates that a UI5Element child in that slot was invalidated and in turn invalidated the component.
-     *      Can only trigger for slots with "invalidateOnChildChange" metadata descriptor
+     *	  Can only trigger for slots with "invalidateOnChildChange" metadata descriptor
      *
      *  - newValue: the new value of the property (for type="property" only)
      *
@@ -525,9 +578,7 @@ class UI5Element extends HTMLElement {
         this._suppressInvalidation = true;
         this.onBeforeRendering();
         // Intended for framework usage only. Currently ItemNavigation updates tab indexes after the component has updated its state but before the template is rendered
-        if (this._onComponentStateFinalized) {
-            this._onComponentStateFinalized();
-        }
+        this._componentStateFinalizedEventProvider.fireEvent("componentStateFinalized");
         // resume normal invalidation handling
         this._suppressInvalidation = false;
         // Update the shadow root with the render result
@@ -556,9 +607,6 @@ class UI5Element extends HTMLElement {
         if (ctor._needsShadowDOM()) {
             updateShadowRoot(this);
         }
-        if (this.staticAreaItem) {
-            this.staticAreaItem.update();
-        }
         // Safari requires that children get the slot attribute only after the slot tags have been rendered in the shadow DOM
         if (hasIndividualSlots) {
             this._assignIndividualSlotsToChildren();
@@ -598,11 +646,7 @@ class UI5Element extends HTMLElement {
         if (!this.shadowRoot || this.shadowRoot.children.length === 0) {
             return;
         }
-        const children = [...this.shadowRoot.children].filter(child => !["link", "style"].includes(child.localName));
-        if (children.length !== 1) {
-            console.warn(`The shadow DOM for ${this.constructor.getMetadata().getTag()} does not have a top level element, the getDomRef() method might not work as expected`); // eslint-disable-line
-        }
-        return children[0];
+        return this.shadowRoot.children[0];
     }
     /**
      * Returns the DOM Element marked with "data-sap-focus-ref" inside the template.
@@ -627,7 +671,7 @@ class UI5Element extends HTMLElement {
     }
     /**
      * Set the focus to the element, returned by "getFocusDomRef()" (marked by "data-sap-focus-ref")
-     * @param {FocusOptions} focusOptions additional options for the focus
+     * @param focusOptions additional options for the focus
      * @public
      */
     async focus(focusOptions) {
@@ -644,13 +688,13 @@ class UI5Element extends HTMLElement {
      * @param data - additional data for the event
      * @param cancelable - true, if the user can call preventDefault on the event object
      * @param bubbles - true, if the event bubbles
-     * @returns {boolean} false, if the event was cancelled (preventDefault called), true otherwise
+     * @returns false, if the event was cancelled (preventDefault called), true otherwise
      */
     fireEvent(name, data, cancelable = false, bubbles = true) {
         const eventResult = this._fireEvent(name, data, cancelable, bubbles);
         const camelCaseEventName = kebabToCamelCase(name);
         if (camelCaseEventName !== name) {
-            return eventResult && this._fireEvent(camelCaseEventName, data, cancelable);
+            return eventResult && this._fireEvent(camelCaseEventName, data, cancelable, bubbles);
         }
         return eventResult;
     }
@@ -685,12 +729,30 @@ class UI5Element extends HTMLElement {
     getSlottedNodes(slotName) {
         return getSlottedNodesList(this[slotName]);
     }
+    /**
+     * Attach a callback that will be executed whenever the component's state is finalized
+     *
+     * @param callback
+     * @public
+     */
+    attachComponentStateFinalized(callback) {
+        this._componentStateFinalizedEventProvider.attachEvent("componentStateFinalized", callback);
+    }
+    /**
+     * Detach the callback that is executed whenever the component's state is finalized
+     *
+     * @param callback
+     * @public
+     */
+    detachComponentStateFinalized(callback) {
+        this._componentStateFinalizedEventProvider.detachEvent("componentStateFinalized", callback);
+    }
     /**
      * Determines whether the component should be rendered in RTL mode or not.
      * Returns: "rtl", "ltr" or undefined
      *
      * @public
-     * @returns {String|undefined}
+     * @default undefined
      */
     get effectiveDir() {
         markAsRtlAware(this.constructor); // if a UI5 Element calls this method, it's considered to be rtl-aware
@@ -698,8 +760,8 @@ class UI5Element extends HTMLElement {
     }
     /**
      * Used to duck-type UI5 elements without using instanceof
-     * @returns {boolean}
      * @public
+     * @default true
      */
     get isUI5Element() {
         return true;
@@ -708,39 +770,24 @@ class UI5Element extends HTMLElement {
         return {};
     }
     /**
-     * Do not override this method in derivatives of UI5Element, use metadata properties instead
+     * Returns the component accessibility info.
      * @private
      */
-    static get observedAttributes() {
-        return this.getMetadata().getAttributesList();
+    get accessibilityInfo() {
+        return {};
     }
     /**
+     * Do not override this method in derivatives of UI5Element, use metadata properties instead
      * @private
      */
-    static _needsShadowDOM() {
-        return !!this.template;
+    static get observedAttributes() {
+        return this.getMetadata().getAttributesList();
     }
     /**
      * @private
      */
-    static _needsStaticArea() {
-        return !!this.staticAreaTemplate;
-    }
-    /**
-     * @public
-     */
-    getStaticAreaItemDomRef() {
-        if (!this.constructor._needsStaticArea()) {
-            throw new Error("This component does not use the static area");
-        }
-        if (!this.staticAreaItem) {
-            this.staticAreaItem = StaticAreaItem.createInstance();
-            this.staticAreaItem.setOwnerElement(this);
-        }
-        if (!this.staticAreaItem.parentElement) {
-            getSingletonElementInstance("ui5-static-area").appendChild(this.staticAreaItem);
-        }
-        return this.staticAreaItem.getDomRef();
+    static _needsShadowDOM() {
+        return !!this.template || Object.prototype.hasOwnProperty.call(this.prototype, "render");
     }
     /**
      * @private
@@ -766,8 +813,25 @@ class UI5Element extends HTMLElement {
             if (propData.multiple && propData.defaultValue) {
                 throw new Error(`Cannot set a default value for property "${prop}". All multiple properties are empty arrays by default.`);
             }
+            const descriptor = getPropertyDescriptor(proto, prop);
+            // if the decorator is on a setter, proxy the new setter to it
+            let origSet;
+            if (descriptor?.set) {
+                // eslint-disable-next-line @typescript-eslint/unbound-method
+                origSet = descriptor.set;
+            }
+            // if the decorator is on a setter, there will be a corresponding getter - proxy the new getter to it
+            let origGet;
+            if (descriptor?.get) {
+                // eslint-disable-next-line @typescript-eslint/unbound-method
+                origGet = descriptor.get;
+            }
             Object.defineProperty(proto, prop, {
                 get() {
+                    // proxy the getter to the original accessor if there was one
+                    if (origGet) {
+                        return origGet.call(this);
+                    }
                     if (this._state[prop] !== undefined) {
                         return this._state[prop];
                     }
@@ -792,7 +856,7 @@ class UI5Element extends HTMLElement {
                     value = metadataCtor.validatePropertyValue(value, propData);
                     const propertyType = propData.type;
                     let propertyValidator = propData.validator;
-                    const oldState = this._state[prop];
+                    const oldState = origGet ? origGet.call(this) : this._state[prop];
                     if (propertyType && propertyType.isDataTypeClass) {
                         propertyValidator = propertyType;
                     }
@@ -806,13 +870,22 @@ class UI5Element extends HTMLElement {
                         isDifferent = oldState !== value;
                     }
                     if (isDifferent) {
-                        this._state[prop] = value;
+                        // if the decorator is on a setter, use it for storage
+                        if (origSet) {
+                            origSet.call(this, value);
+                        }
+                        else {
+                            this._state[prop] = value;
+                        }
                         _invalidate.call(this, {
                             type: "property",
                             name: prop,
                             newValue: value,
                             oldValue: oldState,
                         });
+                        if (ctor.getMetadata().isFormAssociated()) {
+                            setFormValue(this);
+                        }
                         this._updateAttribute(prop, value);
                     }
                 },
@@ -840,34 +913,6 @@ class UI5Element extends HTMLElement {
             }
         }
     }
-    /**
-     * Returns the metadata object for this UI5 Web Component Class
-     * @protected
-     */
-    static get metadata() {
-        return metadata;
-    }
-    /**
-     * Sets a new metadata object for this UI5 Web Component Class
-     * @protected
-     */
-    static set metadata(newMetadata) {
-        metadata = newMetadata;
-    }
-    /**
-     * Returns the CSS for this UI5 Web Component Class
-     * @protected
-     */
-    static get styles() {
-        return "";
-    }
-    /**
-     * Returns the Static Area CSS for this UI5 Web Component Class
-     * @protected
-     */
-    static get staticAreaStyles() {
-        return "";
-    }
     /**
      * Returns an array with the dependencies for this UI5 Web Component, which could be:
      *  - composed components (used in its shadow root or static area item)
@@ -892,8 +937,6 @@ class UI5Element extends HTMLElement {
     }
     /**
      * Returns a promise that resolves whenever all dependencies for this UI5 Web Component have resolved
-     *
-     * @returns {Promise}
      */
     static whenDependenciesDefined() {
         return Promise.all(this.getUniqueDependencies().map(dep => dep.define()));
@@ -902,7 +945,6 @@ class UI5Element extends HTMLElement {
      * Hook that will be called upon custom element definition
      *
      * @protected
-     * @returns {Promise<void>}
      */
     static async onDefine() {
         return Promise.resolve();
@@ -910,7 +952,6 @@ class UI5Element extends HTMLElement {
     /**
      * Registers a UI5 Web Component in the browser window object
      * @public
-     * @returns {Promise<UI5Element>}
      */
     static async define() {
         await boot();
@@ -927,8 +968,7 @@ class UI5Element extends HTMLElement {
         else if (!definedGlobally) {
             this._generateAccessors();
             registerTag(tag);
-            window.customElements.define(tag, this);
-            preloadLinks(this);
+            customElements.define(tag, this);
         }
         return this;
     }
@@ -936,33 +976,42 @@ class UI5Element extends HTMLElement {
      * Returns an instance of UI5ElementMetadata.js representing this UI5 Web Component's full metadata (its and its parents')
      * Note: not to be confused with the "get metadata()" method, which returns an object for this class's metadata only
      * @public
-     * @returns {UI5ElementMetadata}
      */
     static getMetadata() {
         if (this.hasOwnProperty("_metadata")) { // eslint-disable-line
             return this._metadata;
         }
-        const effectiveMetadata = Object.keys(this.metadata).length ? this.metadata : this.decoratorMetadata;
-        const metadataObjects = [effectiveMetadata];
+        const metadataObjects = [this.metadata];
         let klass = this; // eslint-disable-line
         while (klass !== UI5Element) {
             klass = Object.getPrototypeOf(klass);
-            const effectiveKlassMetadata = Object.keys(klass.metadata).length ? klass.metadata : klass.decoratorMetadata;
-            metadataObjects.unshift(effectiveKlassMetadata);
+            metadataObjects.unshift(klass.metadata);
         }
         const mergedMetadata = merge({}, ...metadataObjects);
         this._metadata = new UI5ElementMetadata(mergedMetadata);
         return this._metadata;
     }
+    get validity() { return this._internals?.validity; }
+    get validationMessage() { return this._internals?.validationMessage; }
+    checkValidity() { return this._internals?.checkValidity(); }
+    reportValidity() { return this._internals?.reportValidity(); }
 }
-UI5Element.decoratorMetadata = {};
+/**
+ * Returns the metadata object for this UI5 Web Component Class
+ * @protected
+ */
+UI5Element.metadata = {};
+/**
+ * Returns the CSS for this UI5 Web Component Class
+ * @protected
+ */
+UI5Element.styles = "";
 /**
  * Always use duck-typing to cover all runtimes on the page.
- * @returns {boolean}
  */
 const instanceOfUI5Element = (object) => {
     return "isUI5Element" in object;
 };
 export default UI5Element;
-export { instanceOfUI5Element };
+export { instanceOfUI5Element, };
 //# sourceMappingURL=UI5Element.js.map