@ui5/webcomponents-base 0.0.0-7d5f73b20 → 0.0.0-7d8c57f70

package/dist/UI5Element.js

@@ -1,3 +1,5 @@
+// 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";
@@ -5,6 +7,7 @@ import EventProvider from "./EventProvider.js";
 import getSingletonElementInstance from "./util/getSingletonElementInstance.js";
 import StaticAreaItem from "./StaticAreaItem.js";
 import updateShadowRoot from "./updateShadowRoot.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";
@@ -16,6 +19,8 @@ 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 from "./renderer/executeTemplate.js";
+import { subscribeForFeatureLoad } from "./FeaturesRegistry.js";
 let autoId = 0;
 const elementTimeouts = new Map();
 const uniqueDependenciesCache = new Map();
@@ -34,16 +39,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 +74,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;
@@ -82,6 +100,14 @@ class UI5Element extends HTMLElement {
         }
         return this.__id;
     }
+    render() {
+        const template = this.constructor.template;
+        return executeTemplate(template, this);
+    }
+    renderStatic() {
+        const template = this.constructor.staticAreaTemplate;
+        return executeTemplate(template, this);
+    }
     /**
      * Do not call this method from derivatives of UI5Element, use "onEnterDOM" only
      * @private
@@ -152,14 +178,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 +248,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 +260,7 @@ class UI5Element extends HTMLElement {
                         }
                         await Promise.race([whenDefinedPromise, timeoutPromise]);
                     }
-                    window.customElements.upgrade(child);
+                    customElements.upgrade(child);
                 }
             }
             child = ctor.getMetadata().constructor.validateSlotValue(child, slotData);
@@ -307,26 +335,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) {
@@ -436,7 +464,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 +476,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) {
@@ -525,9 +551,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
@@ -627,7 +651,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 +668,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 +709,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 +740,8 @@ class UI5Element extends HTMLElement {
     }
     /**
      * Used to duck-type UI5 elements without using instanceof
-     * @returns {boolean}
      * @public
+     * @default true
      */
     get isUI5Element() {
         return true;
@@ -707,6 +749,13 @@ class UI5Element extends HTMLElement {
     get classes() {
         return {};
     }
+    /**
+     * Returns the component accessibility info.
+     * @private
+     */
+    get accessibilityInfo() {
+        return {};
+    }
     /**
      * Do not override this method in derivatives of UI5Element, use metadata properties instead
      * @private
@@ -718,13 +767,13 @@ class UI5Element extends HTMLElement {
      * @private
      */
     static _needsShadowDOM() {
-        return !!this.template;
+        return !!this.template || Object.prototype.hasOwnProperty.call(this.prototype, "render");
     }
     /**
      * @private
      */
     static _needsStaticArea() {
-        return !!this.staticAreaTemplate;
+        return !!this.staticAreaTemplate || Object.prototype.hasOwnProperty.call(this.prototype, "renderStatic");
     }
     /**
      * @public
@@ -766,8 +815,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 +858,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,7 +872,13 @@ 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,
@@ -840,27 +912,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
@@ -878,6 +929,10 @@ class UI5Element extends HTMLElement {
     static get dependencies() {
         return [];
     }
+    static cacheUniqueDependencies() {
+        const filtered = this.dependencies.filter((dep, index, deps) => deps.indexOf(dep) === index);
+        uniqueDependenciesCache.set(this, filtered);
+    }
     /**
      * Returns a list of the unique dependencies for this UI5 Web Component
      *
@@ -885,15 +940,12 @@ class UI5Element extends HTMLElement {
      */
     static getUniqueDependencies() {
         if (!uniqueDependenciesCache.has(this)) {
-            const filtered = this.dependencies.filter((dep, index, deps) => deps.indexOf(dep) === index);
-            uniqueDependenciesCache.set(this, filtered);
+            this.cacheUniqueDependencies();
         }
         return uniqueDependenciesCache.get(this) || [];
     }
     /**
      * 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 +954,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 +961,6 @@ class UI5Element extends HTMLElement {
     /**
      * Registers a UI5 Web Component in the browser window object
      * @public
-     * @returns {Promise<UI5Element>}
      */
     static async define() {
         await boot();
@@ -919,6 +969,10 @@ class UI5Element extends HTMLElement {
             this.onDefine(),
         ]);
         const tag = this.getMetadata().getTag();
+        const features = this.getMetadata().getFeatures();
+        features.forEach(feature => {
+            subscribeForFeatureLoad(feature, this, this.cacheUniqueDependencies.bind(this));
+        });
         const definedLocally = isTagRegistered(tag);
         const definedGlobally = customElements.get(tag);
         if (definedGlobally && !definedLocally) {
@@ -927,7 +981,7 @@ class UI5Element extends HTMLElement {
         else if (!definedGlobally) {
             this._generateAccessors();
             registerTag(tag);
-            window.customElements.define(tag, this);
+            customElements.define(tag, this);
             preloadLinks(this);
         }
         return this;
@@ -936,29 +990,34 @@ 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;
     }
 }
-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;