@ui5/webcomponents-base 2.0.0-rc.6 → 2.0.1

package/dist/UI5Element.d.ts

@@ -54,7 +54,14 @@ declare abstract class UI5Element extends HTMLElement {
     static template?: TemplateFunction;
     static _metadata: UI5ElementMetadata;
     static renderer: Renderer;
+    initializedProperties: Map<string, unknown>;
+    _rendered: boolean;
     constructor();
+    _initShadowRoot(): void;
+    /**
+     * Note: this "slotchange" listener is for slots, rendered in the component's shadow root
+     */
+    _onShadowRootSlotChange(e: Event): void;
     /**
      * Returns a unique ID for this UI5 Element
      *
@@ -148,14 +155,6 @@ declare abstract class UI5Element extends HTMLElement {
      * @private
      */
     _updateAttribute(name: string, newValue: PropertyValue): void;
-    /**
-     * @private
-     */
-    _upgradeProperty(this: Record<string, any>, propertyName: string): void;
-    /**
-     * @private
-     */
-    _upgradeAllProperties(): void;
     /**
      * Returns a singleton event listener for the "change" event of a child in a given slot
      *
@@ -180,6 +179,7 @@ declare abstract class UI5Element extends HTMLElement {
     _detachSlotChange(child: HTMLSlotElement, slotName: string): void;
     /**
      * Whenever a slot element is slotted inside a UI5 Web Component, its slotchange event invalidates the component
+     * Note: this "slotchange" listener is for slots that are children of the component (in the light dom, as opposed to slots rendered by the component in the shadow root)
      *
      * @param slotName the name of the slot, where the slot element (whose slotchange event we're listening to) is
      * @private
@@ -213,6 +213,7 @@ declare abstract class UI5Element extends HTMLElement {
      * @public
      */
     onInvalidation(changeInfo: ChangeInfo): void;
+    updateAttributes(): void;
     /**
      * Do not call this method directly, only intended to be called by js
      * @protected

package/dist/UI5Element.js

@@ -22,6 +22,31 @@ const DEV_MODE = true;
 let autoId = 0;
 const elementTimeouts = new Map();
 const uniqueDependenciesCache = new Map();
+const defaultConverter = {
+    fromAttribute(value, type) {
+        if (type === Boolean) {
+            return value !== null;
+        }
+        if (type === Number) {
+            return value === null ? undefined : parseFloat(value);
+        }
+        return value;
+    },
+    toAttribute(value, type) {
+        if (type === Boolean) {
+            return value ? "" : null;
+        }
+        // don't set attributes for arrays and objects
+        if (type === Object || type === Array) {
+            return null;
+        }
+        // object, array, other
+        if (value === null || value === undefined) {
+            return null;
+        }
+        return String(value);
+    },
+};
 /**
  * Triggers re-rendering of a UI5Element instance due to state change.
  * @param {ChangeInfo} changeInfo An object with information about the change that caused invalidation.
@@ -65,6 +90,10 @@ function getPropertyDescriptor(proto, name) {
 class UI5Element extends HTMLElement {
     constructor() {
         super();
+        // used to differentiate whether a setter is called from the constructor (from an initializer) or later
+        // setters from the constructor should not set attributes, this is delegated after the first rendering but is async
+        // setters after the constructor can set attributes synchronously for more convinient development
+        this._rendered = false;
         const ctor = this.constructor;
         this._changedState = []; // Filled on each invalidation, cleared on re-render (used for debugging)
         this._suppressInvalidation = true; // A flag telling whether all invalidations should be ignored. Initialized with "true" because a UI5Element can not be invalidated until it is rendered for the first time
@@ -82,10 +111,35 @@ class UI5Element extends HTMLElement {
         this._doNotSyncAttributes = new Set(); // attributes that are excluded from attributeChangedCallback synchronization
         this._slotsAssignedNodes = new WeakMap(); // map of all nodes, slotted (directly or transitively) per component slot
         this._state = { ...ctor.getMetadata().getInitialState() };
-        this._upgradeAllProperties();
+        // save properties set before element is upgraded, as they will be overriden by the field initializers in the constructor
+        this.initializedProperties = new Map();
+        const allProps = this.constructor.getMetadata().getPropertiesList();
+        allProps.forEach(propertyName => {
+            if (this.hasOwnProperty(propertyName)) { // eslint-disable-line
+                const value = this[propertyName];
+                this.initializedProperties.set(propertyName, value);
+            }
+        });
+        this._initShadowRoot();
+    }
+    _initShadowRoot() {
+        const ctor = this.constructor;
         if (ctor._needsShadowDOM()) {
             const defaultOptions = { mode: "open" };
             this.attachShadow({ ...defaultOptions, ...ctor.getMetadata().getShadowRootOptions() });
+            const slotsAreManaged = ctor.getMetadata().slotsAreManaged();
+            if (slotsAreManaged) {
+                this.shadowRoot.addEventListener("slotchange", this._onShadowRootSlotChange.bind(this));
+            }
+        }
+    }
+    /**
+     * Note: this "slotchange" listener is for slots, rendered in the component's shadow root
+     */
+    _onShadowRootSlotChange(e) {
+        const targetShadowRoot = e.target?.getRootNode(); // the "slotchange" event target is always a slot element
+        if (targetShadowRoot === this.shadowRoot) { // only for slotchange events that originate from slots, belonging to the component's shadow root
+            this._processChildren();
         }
     }
     /**
@@ -124,7 +178,8 @@ class UI5Element extends HTMLElement {
         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)) {
+                if (Object.hasOwn(this, prop) && !this.initializedProperties.has(prop)) {
+                    // initialized properties should not trigger this error as they will be reassigned, only property initializers will trigger this in case unsupported TS mode
                     // 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`);
                 }
@@ -199,10 +254,9 @@ class UI5Element extends HTMLElement {
             return;
         }
         const canSlotText = metadata.canSlotText();
-        const hasClonedSlot = Object.keys(metadata.getSlots()).some(slotName => metadata.getSlots()[slotName].cloned);
         const mutationObserverOptions = {
             childList: true,
-            subtree: canSlotText || hasClonedSlot,
+            subtree: canSlotText,
             characterData: canSlotText,
         };
         observeDOMNode(this, this._processChildren.bind(this), mutationObserverOptions);
@@ -301,6 +355,7 @@ class UI5Element extends HTMLElement {
         // not the order elements are defined.
         slottedChildrenMap.forEach((children, propertyName) => {
             this._state[propertyName] = children.sort((a, b) => a.idx - b.idx).map(_ => _.child);
+            this._state[kebabToCamelCase(propertyName)] = this._state[propertyName];
         });
         // Compare the content of each slot with the cached values and invalidate for the ones that changed
         let invalidated = false;
@@ -345,6 +400,7 @@ class UI5Element extends HTMLElement {
             }
         });
         this._state[propertyName] = [];
+        this._state[kebabToCamelCase(propertyName)] = this._state[propertyName];
     }
     /**
      * Attach a callback that will be executed whenever the component is invalidated
@@ -398,20 +454,8 @@ class UI5Element extends HTMLElement {
         const nameInCamelCase = kebabToCamelCase(realName);
         if (properties.hasOwnProperty(nameInCamelCase)) { // eslint-disable-line
             const propData = properties[nameInCamelCase];
-            const propertyType = propData.type;
-            let propertyValidator = propData.validator;
-            if (propertyType && propertyType.isDataTypeClass) {
-                propertyValidator = propertyType;
-            }
-            if (propertyValidator) {
-                newPropertyValue = propertyValidator.attributeToProperty(newValue);
-            }
-            else if (propertyType === Boolean) {
-                newPropertyValue = newValue !== null;
-            }
-            else {
-                newPropertyValue = newValue;
-            }
+            const converter = propData.converter ?? defaultConverter;
+            newPropertyValue = converter.fromAttribute(newValue, propData.type);
             this[nameInCamelCase] = newPropertyValue;
         }
     }
@@ -435,55 +479,29 @@ class UI5Element extends HTMLElement {
         }
         const properties = ctor.getMetadata().getProperties();
         const propData = properties[name];
-        const propertyType = propData.type;
-        let propertyValidator = propData.validator;
         const attrName = camelToKebabCase(name);
-        const attrValue = this.getAttribute(attrName);
-        if (propertyType && propertyType.isDataTypeClass) {
-            propertyValidator = propertyType;
-        }
-        if (propertyValidator) {
-            const newAttrValue = propertyValidator.propertyToAttribute(newValue);
-            if (newAttrValue === null) { // null means there must be no attribute for the current value of the property
-                this._doNotSyncAttributes.add(attrName); // skip the attributeChangedCallback call for this attribute
-                this.removeAttribute(attrName); // remove the attribute safely (will not trigger synchronization to the property value due to the above line)
-                this._doNotSyncAttributes.delete(attrName); // enable synchronization again for this attribute
+        const converter = propData.converter || defaultConverter;
+        if (DEV_MODE) {
+            const tag = this.constructor.getMetadata().getTag();
+            if (typeof newValue === "boolean" && propData.type !== Boolean) {
+                // eslint-disable-next-line
+                console.error(`[UI5-FWK] boolean value for property [${name}] of component [${tag}] is missing "{ type: Boolean }" in its property decorator. Attribute conversion will treat it as a string. If this is intended, pass the value converted to string, otherwise add the type to the property decorator`);
             }
-            else {
-                this.setAttribute(attrName, newAttrValue);
+            if (typeof newValue === "number" && propData.type !== Number) {
+                // eslint-disable-next-line
+                console.error(`[UI5-FWK] numeric value for property [${name}] of component [${tag}] is missing "{ type: Number }" in its property decorator. Attribute conversion will treat it as a string. If this is intended, pass the value converted to string, otherwise add the type to the property decorator`);
             }
         }
-        else if (propertyType === Boolean) {
-            if (newValue === true && attrValue === null) {
-                this.setAttribute(attrName, "");
-            }
-            else if (newValue === false && attrValue !== null) {
-                this.removeAttribute(attrName);
-            }
+        const newAttrValue = converter.toAttribute(newValue, propData.type);
+        if (newAttrValue === null || newAttrValue === undefined) { // null means there must be no attribute for the current value of the property
+            this._doNotSyncAttributes.add(attrName); // skip the attributeChangedCallback call for this attribute
+            this.removeAttribute(attrName); // remove the attribute safely (will not trigger synchronization to the property value due to the above line)
+            this._doNotSyncAttributes.delete(attrName); // enable synchronization again for this attribute
         }
-        else if (typeof newValue !== "object") {
-            if (attrValue !== newValue) {
-                this.setAttribute(attrName, newValue);
-            }
-        } // else { return; } // old object handling
-    }
-    /**
-     * @private
-     */
-    _upgradeProperty(propertyName) {
-        if (this.hasOwnProperty(propertyName)) { // eslint-disable-line
-            const value = this[propertyName];
-            delete this[propertyName];
-            this[propertyName] = value;
+        else {
+            this.setAttribute(attrName, newAttrValue);
         }
     }
-    /**
-     * @private
-     */
-    _upgradeAllProperties() {
-        const allProps = this.constructor.getMetadata().getPropertiesList();
-        allProps.forEach(this._upgradeProperty.bind(this));
-    }
     /**
      * Returns a singleton event listener for the "change" event of a child in a given slot
      *
@@ -546,6 +564,7 @@ class UI5Element extends HTMLElement {
     }
     /**
      * Whenever a slot element is slotted inside a UI5 Web Component, its slotchange event invalidates the component
+     * Note: this "slotchange" listener is for slots that are children of the component (in the light dom, as opposed to slots rendered by the component in the shadow root)
      *
      * @param slotName the name of the slot, where the slot element (whose slotchange event we're listening to) is
      * @private
@@ -585,6 +604,13 @@ class UI5Element extends HTMLElement {
      * @public
      */
     onInvalidation(changeInfo) { } // eslint-disable-line
+    updateAttributes() {
+        const ctor = this.constructor;
+        const props = ctor.getMetadata().getProperties();
+        for (const [prop, propData] of Object.entries(props)) { // eslint-disable-line
+            this._updateAttribute(prop, this[prop]);
+        }
+    }
     /**
      * Do not call this method directly, only intended to be called by js
      * @protected
@@ -592,9 +618,21 @@ class UI5Element extends HTMLElement {
     _render() {
         const ctor = this.constructor;
         const hasIndividualSlots = ctor.getMetadata().hasIndividualSlots();
+        // restore properties that were initialized before `define` by calling the setter
+        if (this.initializedProperties.size > 0) {
+            Array.from(this.initializedProperties.entries()).forEach(([prop, value]) => {
+                delete this[prop];
+                this[prop] = value;
+            });
+            this.initializedProperties.clear();
+        }
         // suppress invalidation to prevent state changes scheduling another rendering
         this._suppressInvalidation = true;
         this.onBeforeRendering();
+        if (!this._rendered) {
+            // first time rendering, previous setters might have been initializers from the constructor - update attributes here
+            this.updateAttributes();
+        }
         // Intended for framework usage only. Currently ItemNavigation updates tab indexes after the component has updated its state but before the template is rendered
         this._componentStateFinalizedEventProvider.fireEvent("componentStateFinalized");
         // resume normal invalidation handling
@@ -625,6 +663,7 @@ class UI5Element extends HTMLElement {
         if (ctor._needsShadowDOM()) {
             updateShadowRoot(this);
         }
+        this._rendered = true;
         // Safari requires that children get the slot attribute only after the slot tags have been rendered in the shadow DOM
         if (hasIndividualSlots) {
             this._assignIndividualSlotsToChildren();
@@ -822,18 +861,6 @@ class UI5Element extends HTMLElement {
             if (!isValidPropertyName(prop)) {
                 console.warn(`"${prop}" is not a valid property name. Use a name that does not collide with DOM APIs`); /* eslint-disable-line */
             }
-            if (propData.type === Boolean && propData.defaultValue) {
-                throw new Error(`Cannot set a default value for property "${prop}". All booleans are false by default.`);
-            }
-            if (propData.type === Array) {
-                throw new Error(`Wrong type for property "${prop}". Properties cannot be of type Array - use "multiple: true" and set "type" to the single value type, such as "String", "Object", etc...`);
-            }
-            if (propData.type === Object && propData.defaultValue) {
-                throw new Error(`Cannot set a default value for property "${prop}". All properties of type "Object" are empty objects by default.`);
-            }
-            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;
@@ -853,43 +880,12 @@ class UI5Element extends HTMLElement {
                     if (origGet) {
                         return origGet.call(this);
                     }
-                    if (this._state[prop] !== undefined) {
-                        return this._state[prop];
-                    }
-                    const propDefaultValue = propData.defaultValue;
-                    if (propData.type === Boolean) {
-                        return false;
-                    }
-                    else if (propData.type === String) { // eslint-disable-line
-                        return propDefaultValue;
-                    }
-                    else if (propData.multiple) { // eslint-disable-line
-                        return [];
-                    }
-                    else {
-                        return propDefaultValue;
-                    }
+                    return this._state[prop];
                 },
                 set(value) {
-                    let isDifferent;
                     const ctor = this.constructor;
-                    const metadataCtor = ctor.getMetadata().constructor;
-                    value = metadataCtor.validatePropertyValue(value, propData);
-                    const propertyType = propData.type;
-                    let propertyValidator = propData.validator;
                     const oldState = origGet ? origGet.call(this) : this._state[prop];
-                    if (propertyType && propertyType.isDataTypeClass) {
-                        propertyValidator = propertyType;
-                    }
-                    if (propertyValidator) {
-                        isDifferent = !propertyValidator.valuesAreEqual(oldState, value);
-                    }
-                    else if (Array.isArray(oldState) && Array.isArray(value) && propData.multiple && propData.compareValues) { // compareValues is added for IE, test if needed now
-                        isDifferent = !arraysAreEqual(oldState, value);
-                    }
-                    else {
-                        isDifferent = oldState !== value;
-                    }
+                    const isDifferent = oldState !== value;
                     if (isDifferent) {
                         // if the decorator is on a setter, use it for storage
                         if (origSet) {
@@ -904,10 +900,13 @@ class UI5Element extends HTMLElement {
                             newValue: value,
                             oldValue: oldState,
                         });
+                        if (this._rendered) {
+                            // is already rendered so it is not the constructor - can set the attribute synchronously
+                            this._updateAttribute(prop, value);
+                        }
                         if (ctor.getMetadata().isFormAssociated()) {
                             setFormValue(this);
                         }
-                        this._updateAttribute(prop, value);
                     }
                 },
             });
@@ -920,7 +919,7 @@ class UI5Element extends HTMLElement {
                     console.warn(`"${slotName}" is not a valid property name. Use a name that does not collide with DOM APIs`); /* eslint-disable-line */
                 }
                 const propertyName = slotData.propertyName || slotName;
-                Object.defineProperty(proto, propertyName, {
+                const propertyDescriptor = {
                     get() {
                         if (this._state[propertyName] !== undefined) {
                             return this._state[propertyName];
@@ -930,7 +929,11 @@ class UI5Element extends HTMLElement {
                     set() {
                         throw new Error("Cannot set slot content directly, use the DOM APIs (appendChild, removeChild, etc...)");
                     },
-                });
+                };
+                Object.defineProperty(proto, propertyName, propertyDescriptor);
+                if (propertyName !== kebabToCamelCase(propertyName)) {
+                    Object.defineProperty(proto, kebabToCamelCase(propertyName), propertyDescriptor);
+                }
             }
         }
     }