@ui5/webcomponents-base 0.0.0-7e7d9ea6f → 0.0.0-8085abb8d

package/dist/UI5ElementMetadata.js

@@ -1,352 +1,291 @@
-import DataType from "./types/DataType.js";
-import isDescendantOf from "./util/isDescendantOf.js";
 import { camelToKebabCase } from "./util/StringHelper.js";
-import { getSlottedElements } from "./util/SlotsHelper.js";
+import { getSlottedNodes } from "./util/SlotsHelper.js";
 import { getEffectiveScopingSuffixForTag } from "./CustomElementsScopeUtils.js";
-
 /**
  *
  * @class
  * @public
  */
 class UI5ElementMetadata {
-	constructor(metadata) {
-		this.metadata = metadata;
-	}
-
-	getInitialState() {
-		if (Object.prototype.hasOwnProperty.call(this, "_initialState")) {
-			return this._initialState;
-		}
-
-		const initialState = {};
-		const slotsAreManaged = this.slotsAreManaged();
-
-		// Initialize properties
-		const props = this.getProperties();
-		for (const propName in props) { // eslint-disable-line
-			const propType = props[propName].type;
-			const propDefaultValue = props[propName].defaultValue;
-
-			if (propType === Boolean) {
-				initialState[propName] = false;
-
-				if (propDefaultValue !== undefined) {
-					console.warn("The 'defaultValue' metadata key is ignored for all booleans properties, they would be initialized with 'false' by default"); // eslint-disable-line
-				}
-			} else if (props[propName].multiple) {
-				initialState[propName] = [];
-			} else if (propType === Object) {
-				initialState[propName] = "defaultValue" in props[propName] ? props[propName].defaultValue : {};
-			} else if (propType === String) {
-				initialState[propName] = "defaultValue" in props[propName] ? props[propName].defaultValue : "";
-			} else {
-				initialState[propName] = propDefaultValue;
-			}
-		}
-
-		// Initialize slots
-		if (slotsAreManaged) {
-			const slots = this.getSlots();
-			for (const [slotName, slotData] of Object.entries(slots)) { // eslint-disable-line
-				const propertyName = slotData.propertyName || slotName;
-				initialState[propertyName] = [];
-			}
-		}
-
-		this._initialState = initialState;
-		return initialState;
-	}
-
-	/**
-	 * Only intended for use by UI5Element.js
-	 * @protected
-	 */
-	static validatePropertyValue(value, propData) {
-		const isMultiple = propData.multiple;
-		if (isMultiple) {
-			return value.map(propValue => validateSingleProperty(propValue, propData));
-		}
-		return validateSingleProperty(value, propData);
-	}
-
-	/**
-	 * Only intended for use by UI5Element.js
-	 * @protected
-	 */
-	static validateSlotValue(value, slotData) {
-		return validateSingleSlot(value, slotData);
-	}
-
-	/**
-	 * Returns the tag of the UI5 Element without the scope
-	 * @public
-	 */
-	getPureTag() {
-		return this.metadata.tag;
-	}
-
-	/**
-	 * Returns the tag of the UI5 Element
-	 * @public
-	 */
-	getTag() {
-		const pureTag = this.metadata.tag;
-		const suffix = getEffectiveScopingSuffixForTag(pureTag);
-		if (!suffix) {
-			return pureTag;
-		}
-
-		return `${pureTag}-${suffix}`;
-	}
-
-	/**
-	 * Used to get the tag we need to register for backwards compatibility
-	 * @public
-	 */
-	getAltTag() {
-		const pureAltTag = this.metadata.altTag;
-		if (!pureAltTag) {
-			return;
-		}
-
-		const suffix = getEffectiveScopingSuffixForTag(pureAltTag);
-		if (!suffix) {
-			return pureAltTag;
-		}
-
-		return `${pureAltTag}-${suffix}`;
-	}
-
-	/**
-	 * Determines whether a property should have an attribute counterpart
-	 * @public
-	 * @param propName
-	 * @returns {boolean}
-	 */
-	hasAttribute(propName) {
-		const propData = this.getProperties()[propName];
-		return propData.type !== Object && !propData.noAttribute && !propData.multiple;
-	}
-
-	/**
-	 * Returns an array with the properties of the UI5 Element (in camelCase)
-	 * @public
-	 * @returns {string[]}
-	 */
-	getPropertiesList() {
-		return Object.keys(this.getProperties());
-	}
-
-	/**
-	 * Returns an array with the attributes of the UI5 Element (in kebab-case)
-	 * @public
-	 * @returns {string[]}
-	 */
-	getAttributesList() {
-		return this.getPropertiesList().filter(this.hasAttribute, this).map(camelToKebabCase);
-	}
-
-	/**
-	 * Returns an object with key-value pairs of slots and their metadata definitions
-	 * @public
-	 */
-	getSlots() {
-		return this.metadata.slots || {};
-	}
-
-	/**
-	 * Determines whether this UI5 Element has a default slot of type Node, therefore can slot text
-	 * @returns {boolean}
-	 */
-	canSlotText() {
-		const defaultSlot = this.getSlots().default;
-		return defaultSlot && defaultSlot.type === Node;
-	}
-
-	/**
-	 * Determines whether this UI5 Element supports any slots
-	 * @public
-	 */
-	hasSlots() {
-		return !!Object.entries(this.getSlots()).length;
-	}
-
-	/**
-	 * Determines whether this UI5 Element supports any slots with "individualSlots: true"
-	 * @public
-	 */
-	hasIndividualSlots() {
-		return this.slotsAreManaged() && Object.entries(this.getSlots()).some(([_slotName, slotData]) => slotData.individualSlots);
-	}
-
-	/**
-	 * Determines whether this UI5 Element needs to invalidate if children are added/removed/changed
-	 * @public
-	 */
-	slotsAreManaged() {
-		return !!this.metadata.managedSlots;
-	}
-
-	/**
-	 * Determines whether this control supports F6 fast navigation
-	 * @public
-	 */
-	supportsF6FastNavigation() {
-		return !!this.metadata.fastNavigation;
-	}
-
-	/**
-	 * Returns an object with key-value pairs of properties and their metadata definitions
-	 * @public
-	 */
-	getProperties() {
-		return this.metadata.properties || {};
-	}
-
-	/**
-	 * Returns an object with key-value pairs of events and their metadata definitions
-	 * @public
-	 */
-	getEvents() {
-		return this.metadata.events || {};
-	}
-
-	/**
-	 * Determines whether this UI5 Element has any translatable texts (needs to be invalidated upon language change)
-	 * @returns {boolean}
-	 */
-	isLanguageAware() {
-		return !!this.metadata.languageAware;
-	}
-
-	/**
-	 * Determines whether this UI5 Element has any theme dependant carachteristics.
-	 * @returns {boolean}
-	 */
-	 isThemeAware() {
-		return !!this.metadata.themeAware;
-	}
-
-	/**
-	 * Matches a changed entity (property/slot) with the given name against the "invalidateOnChildChange" configuration
-	 * and determines whether this should cause and invalidation
-	 *
-	 * @param slotName the name of the slot in which a child was changed
-	 * @param type the type of change in the child: "property" or "slot"
-	 * @param name the name of the property/slot that changed
-	 * @returns {boolean}
-	 */
-	shouldInvalidateOnChildChange(slotName, type, name) {
-		const config = this.getSlots()[slotName].invalidateOnChildChange;
-
-		// invalidateOnChildChange was not set in the slot metadata - by default child changes do not affect the component
-		if (config === undefined) {
-			return false;
-		}
-
-		// The simple format was used: invalidateOnChildChange: true/false;
-		if (typeof config === "boolean") {
-			return config;
-		}
-
-		// The complex format was used: invalidateOnChildChange: { properties, slots }
-		if (typeof config === "object") {
-			// A property was changed
-			if (type === "property") {
-				// The config object does not have a properties field
-				if (config.properties === undefined) {
-					return false;
-				}
-
-				// The config object has the short format: properties: true/false
-				if (typeof config.properties === "boolean") {
-					return config.properties;
-				}
-
-				// The config object has the complex format: properties: [...]
-				if (Array.isArray(config.properties)) {
-					return config.properties.includes(name);
-				}
-
-				throw new Error("Wrong format for invalidateOnChildChange.properties: boolean or array is expected");
-			}
-
-			// A slot was changed
-			if (type === "slot") {
-				// The config object does not have a slots field
-				if (config.slots === undefined) {
-					return false;
-				}
-
-				// The config object has the short format: slots: true/false
-				if (typeof config.slots === "boolean") {
-					return config.slots;
-				}
-
-				// The config object has the complex format: slots: [...]
-				if (Array.isArray(config.slots)) {
-					return config.slots.includes(name);
-				}
-
-				throw new Error("Wrong format for invalidateOnChildChange.slots: boolean or array is expected");
-			}
-		}
-
-		throw new Error("Wrong format for invalidateOnChildChange: boolean or object is expected");
-	}
+    constructor(metadata) {
+        this.metadata = metadata;
+    }
+    getInitialState() {
+        if (Object.prototype.hasOwnProperty.call(this, "_initialState")) {
+            return this._initialState;
+        }
+        const initialState = {};
+        const slotsAreManaged = this.slotsAreManaged();
+        // Initialize properties
+        const props = this.getProperties();
+        for (const propName in props) { // eslint-disable-line
+            const propType = props[propName].type;
+            const propDefaultValue = props[propName].defaultValue;
+            if (propType === Boolean) {
+                initialState[propName] = false;
+                if (propDefaultValue !== undefined) {
+                    console.warn("The 'defaultValue' metadata key is ignored for all booleans properties, they would be initialized with 'false' by default"); // eslint-disable-line
+                }
+            }
+            else if (props[propName].multiple) {
+                initialState[propName] = [];
+            }
+            else if (propType === Object) {
+                initialState[propName] = "defaultValue" in props[propName] ? props[propName].defaultValue : {};
+            }
+            else if (propType === String) {
+                initialState[propName] = "defaultValue" in props[propName] ? props[propName].defaultValue : "";
+            }
+            else {
+                initialState[propName] = propDefaultValue;
+            }
+        }
+        // Initialize slots
+        if (slotsAreManaged) {
+            const slots = this.getSlots();
+            for (const [slotName, slotData] of Object.entries(slots)) { // eslint-disable-line
+                const propertyName = slotData.propertyName || slotName;
+                initialState[propertyName] = [];
+            }
+        }
+        this._initialState = initialState;
+        return initialState;
+    }
+    /**
+     * Validates the property's value and returns it if correct
+     * or returns the default value if not.
+     * <b>Note:</b> Only intended for use by UI5Element.js
+     * @public
+     */
+    static validatePropertyValue(value, propData) {
+        const isMultiple = propData.multiple;
+        if (isMultiple && value) {
+            return value.map((propValue) => validateSingleProperty(propValue, propData));
+        }
+        return validateSingleProperty(value, propData);
+    }
+    /**
+     * Validates the slot's value and returns it if correct
+     * or throws an exception if not.
+     * <b>Note:</b> Only intended for use by UI5Element.js
+     * @pubic
+     */
+    static validateSlotValue(value, slotData) {
+        return validateSingleSlot(value, slotData);
+    }
+    /**
+     * Returns the tag of the UI5 Element without the scope
+     * @public
+     */
+    getPureTag() {
+        return this.metadata.tag || "";
+    }
+    /**
+     * Returns the tag of the UI5 Element
+     * @public
+     */
+    getTag() {
+        const pureTag = this.metadata.tag;
+        if (!pureTag) {
+            return "";
+        }
+        const suffix = getEffectiveScopingSuffixForTag(pureTag);
+        if (!suffix) {
+            return pureTag;
+        }
+        return `${pureTag}-${suffix}`;
+    }
+    /**
+     * Determines whether a property should have an attribute counterpart
+     * @public
+     * @param propName
+     * @returns {boolean}
+     */
+    hasAttribute(propName) {
+        const propData = this.getProperties()[propName];
+        return propData.type !== Object && !propData.noAttribute && !propData.multiple;
+    }
+    /**
+     * Returns an array with the properties of the UI5 Element (in camelCase)
+     * @public
+     * @returns {string[]}
+     */
+    getPropertiesList() {
+        return Object.keys(this.getProperties());
+    }
+    /**
+     * Returns an array with the attributes of the UI5 Element (in kebab-case)
+     * @public
+     * @returns {string[]}
+     */
+    getAttributesList() {
+        return this.getPropertiesList().filter(this.hasAttribute.bind(this)).map(camelToKebabCase);
+    }
+    /**
+     * Determines whether this UI5 Element has a default slot of type Node, therefore can slot text
+     * @returns {boolean}
+     */
+    canSlotText() {
+        const defaultSlot = this.getSlots().default;
+        return defaultSlot && defaultSlot.type === Node;
+    }
+    /**
+     * Determines whether this UI5 Element supports any slots
+     * @public
+     */
+    hasSlots() {
+        return !!Object.entries(this.getSlots()).length;
+    }
+    /**
+     * Determines whether this UI5 Element supports any slots with "individualSlots: true"
+     * @public
+     */
+    hasIndividualSlots() {
+        return this.slotsAreManaged() && Object.values(this.getSlots()).some(slotData => slotData.individualSlots);
+    }
+    /**
+     * Determines whether this UI5 Element needs to invalidate if children are added/removed/changed
+     * @public
+     */
+    slotsAreManaged() {
+        return !!this.metadata.managedSlots;
+    }
+    /**
+     * Determines whether this control supports F6 fast navigation
+     * @public
+     */
+    supportsF6FastNavigation() {
+        return !!this.metadata.fastNavigation;
+    }
+    /**
+     * Returns an object with key-value pairs of properties and their metadata definitions
+     * @public
+     */
+    getProperties() {
+        if (!this.metadata.properties) {
+            this.metadata.properties = {};
+        }
+        return this.metadata.properties;
+    }
+    /**
+     * Returns an object with key-value pairs of events and their metadata definitions
+     * @public
+     */
+    getEvents() {
+        if (!this.metadata.events) {
+            this.metadata.events = {};
+        }
+        return this.metadata.events;
+    }
+    /**
+     * Returns an object with key-value pairs of slots and their metadata definitions
+     * @public
+     */
+    getSlots() {
+        if (!this.metadata.slots) {
+            this.metadata.slots = {};
+        }
+        return this.metadata.slots;
+    }
+    /**
+     * Determines whether this UI5 Element has any translatable texts (needs to be invalidated upon language change)
+     * @returns {boolean}
+     */
+    isLanguageAware() {
+        return !!this.metadata.languageAware;
+    }
+    /**
+     * Determines whether this UI5 Element has any theme dependant carachteristics.
+     * @returns {boolean}
+     */
+    isThemeAware() {
+        return !!this.metadata.themeAware;
+    }
+    /**
+     * Matches a changed entity (property/slot) with the given name against the "invalidateOnChildChange" configuration
+     * and determines whether this should cause and invalidation
+     *
+     * @param slotName the name of the slot in which a child was changed
+     * @param type the type of change in the child: "property" or "slot"
+     * @param name the name of the property/slot that changed
+     * @returns {boolean}
+     */
+    shouldInvalidateOnChildChange(slotName, type, name) {
+        const config = this.getSlots()[slotName].invalidateOnChildChange;
+        // invalidateOnChildChange was not set in the slot metadata - by default child changes do not affect the component
+        if (config === undefined) {
+            return false;
+        }
+        // The simple format was used: invalidateOnChildChange: true/false;
+        if (typeof config === "boolean") {
+            return config;
+        }
+        // The complex format was used: invalidateOnChildChange: { properties, slots }
+        if (typeof config === "object") {
+            // A property was changed
+            if (type === "property") {
+                // The config object does not have a properties field
+                if (config.properties === undefined) {
+                    return false;
+                }
+                // The config object has the short format: properties: true/false
+                if (typeof config.properties === "boolean") {
+                    return config.properties;
+                }
+                // The config object has the complex format: properties: [...]
+                if (Array.isArray(config.properties)) {
+                    return config.properties.includes(name);
+                }
+                throw new Error("Wrong format for invalidateOnChildChange.properties: boolean or array is expected");
+            }
+            // A slot was changed
+            if (type === "slot") {
+                // The config object does not have a slots field
+                if (config.slots === undefined) {
+                    return false;
+                }
+                // The config object has the short format: slots: true/false
+                if (typeof config.slots === "boolean") {
+                    return config.slots;
+                }
+                // The config object has the complex format: slots: [...]
+                if (Array.isArray(config.slots)) {
+                    return config.slots.includes(name);
+                }
+                throw new Error("Wrong format for invalidateOnChildChange.slots: boolean or array is expected");
+            }
+        }
+        throw new Error("Wrong format for invalidateOnChildChange: boolean or object is expected");
+    }
 }
-
-const validateAltTypes = (value, propData, fallbackValue) => {
-	let finalValue = fallbackValue;
-	const altTypes = propData.altTypes || [];
-
-	for (let index = 0; index < altTypes.length; index++) {
-		const type = altTypes[index];
-
-		if (type === Boolean && typeof value === "boolean") {
-			finalValue = value;
-			break;
-		} else if (type === String && (typeof value === "string" || typeof value === "undefined" || value === null)) {
-			finalValue = value;
-			break;
-		} else if (type === Object && typeof value === "object") {
-			finalValue = value;
-			break;
-		} else if (isDescendantOf(type, DataType) && type.isValid(value)) {
-			finalValue = value;
-			break;
-		}
-	}
-
-	return finalValue;
-};
-
 const validateSingleProperty = (value, propData) => {
-	const propertyType = propData.type;
-
-	if (propertyType === Boolean) {
-		return typeof value === "boolean" ? value : validateAltTypes(value, propData, false);
-	}
-	if (propertyType === String) {
-		return (typeof value === "string" || typeof value === "undefined" || value === null) ? value : validateAltTypes(value, propData, value.toString());
-	}
-	if (propertyType === Object) {
-		return typeof value === "object" ? value : validateAltTypes(value, propData, propData.defaultValue);
-	}
-	if (isDescendantOf(propertyType, DataType)) {
-		return propertyType.isValid(value) ? value : validateAltTypes(value, propData, propData.defaultValue);
-	}
+    const propertyType = propData.type;
+    let propertyValidator = propData.validator;
+    if (propertyType && propertyType.isDataTypeClass) {
+        propertyValidator = propertyType;
+    }
+    if (propertyValidator) {
+        return propertyValidator.isValid(value) ? value : propData.defaultValue;
+    }
+    if (!propertyType || propertyType === String) {
+        return (typeof value === "string" || typeof value === "undefined" || value === null) ? value : value.toString();
+    }
+    if (propertyType === Boolean) {
+        return typeof value === "boolean" ? value : false;
+    }
+    if (propertyType === Object) {
+        return typeof value === "object" ? value : propData.defaultValue;
+    }
+    // Check if "value" is part of the enum (propertyType) values and return the defaultValue if not found.
+    return value in propertyType ? value : propData.defaultValue;
 };
-
 const validateSingleSlot = (value, slotData) => {
-	value && getSlottedElements(value).forEach(el => {
-		if (!(el instanceof slotData.type)) {
-			throw new Error(`${el} is not of type ${slotData.type}`);
-		}
-	});
-
-	return value;
+    value && getSlottedNodes(value).forEach(el => {
+        if (!(el instanceof slotData.type)) {
+            throw new Error(`The element is not of type ${slotData.type.toString()}`);
+        }
+    });
+    return value;
 };
-
 export default UI5ElementMetadata;
+//# sourceMappingURL=UI5ElementMetadata.js.map