@ui5/webcomponents-base 0.0.0-453158269 → 0.0.0-4738ea0dc

package/src/theming/getEffectiveLinksHrefs.ts

@@ -0,0 +1,26 @@
+import { getUrl } from "../CSP.js";
+import { getFeature } from "../FeaturesRegistry.js";
+import type UI5Element from "../UI5Element.js";
+import type OpenUI5Enablement from "../features/OpenUI5Enablement.js";
+import type { ComponentStylesData, StyleDataCSP } from "../types.js";
+
+const MAX_DEPTH_INHERITED_CLASSES = 10; // TypeScript complains about Infinity and big numbers
+
+const getEffectiveLinksHrefs = (ElementClass: typeof UI5Element, forStaticArea = false) => {
+	const stylesData: ComponentStylesData = ElementClass[forStaticArea ? "staticAreaStyles" : "styles"];
+
+	if (!stylesData) {
+		return;
+	}
+
+	const stylesDataArray: ComponentStylesData = Array.isArray(stylesData) ? stylesData : [stylesData];
+
+	const openUI5Enablement = getFeature<typeof OpenUI5Enablement>("OpenUI5Enablement");
+	if (openUI5Enablement) {
+		stylesDataArray.push(openUI5Enablement.getBusyIndicatorStyles());
+	}
+
+	return stylesDataArray.flat(MAX_DEPTH_INHERITED_CLASSES).filter(data => !!data).map(data => getUrl((data as StyleDataCSP).packageName, (data as StyleDataCSP).fileName));
+};
+
+export default getEffectiveLinksHrefs;

package/src/theming/{getEffectiveStyle.js → getEffectiveStyle.ts}

@@ -1,24 +1,26 @@
 import { getCustomCSS, attachCustomCSSChange } from "./CustomStyle.js";
 import getStylesString from "./getStylesString.js";
 import { getFeature } from "../FeaturesRegistry.js";
+import type UI5Element from "../UI5Element.js";
+import OpenUI5Enablement from "../features/OpenUI5Enablement.js";
 
-const effectiveStyleMap = new Map();
+const effectiveStyleMap = new Map<string, string>();
 
-attachCustomCSSChange(tag => {
+attachCustomCSSChange((tag: string) => {
 	effectiveStyleMap.delete(`${tag}_normal`); // there is custom CSS only for the component itself, not for its static area part
 });
 
-const getEffectiveStyle = (ElementClass, forStaticArea = false) => {
+const getEffectiveStyle = (ElementClass: typeof UI5Element, forStaticArea = false) => {
 	const tag = ElementClass.getMetadata().getTag();
 	const key = `${tag}_${forStaticArea ? "static" : "normal"}`;
-	const OpenUI5Enablement = getFeature("OpenUI5Enablement");
+	const openUI5Enablement = getFeature<typeof OpenUI5Enablement>("OpenUI5Enablement");
 
 	if (!effectiveStyleMap.has(key)) {
 		let effectiveStyle;
 		let busyIndicatorStyles = "";
 
-		if (OpenUI5Enablement) {
-			busyIndicatorStyles = getStylesString(OpenUI5Enablement.getBusyIndicatorStyles());
+		if (openUI5Enablement) {
+			busyIndicatorStyles = getStylesString(openUI5Enablement.getBusyIndicatorStyles());
 		}
 
 		if (forStaticArea) {
@@ -33,7 +35,7 @@ const getEffectiveStyle = (ElementClass, forStaticArea = false) => {
 		effectiveStyleMap.set(key, effectiveStyle);
 	}
 
-	return effectiveStyleMap.get(key);
+	return effectiveStyleMap.get(key)!; // The key is guaranteed to exist
 };
 
 export default getEffectiveStyle;

package/src/theming/getStylesString.ts

@@ -0,0 +1,15 @@
+import type { ComponentStylesData, StyleData } from "../types.js";
+
+const MAX_DEPTH_INHERITED_CLASSES = 10; // TypeScript complains about Infinity and big numbers
+
+const getStylesString = (styles: ComponentStylesData) => {
+	if (Array.isArray(styles)) {
+		return (styles.filter(style => !!style).flat(MAX_DEPTH_INHERITED_CLASSES) as Array<StyleData>).map((style: StyleData) => {
+			return typeof style === "string" ? style : style.content;
+		}).join(" ");
+	}
+
+	return typeof styles === "string" ? styles : styles.content;
+};
+
+export default getStylesString;

package/src/theming/{getThemeDesignerTheme.js → getThemeDesignerTheme.ts}

@@ -1,4 +1,14 @@
-const warnings = new Set();
+type ThemeDescriptor = {
+	themeName: string,
+	baseThemeName?: string,
+};
+
+type ThemeMetadata = {
+	Path: string,
+	Extends: Array<string>,
+};
+
+const warnings = new Set<string>();
 
 const getThemeMetadata = () => {
 	// Check if the class was already applied, most commonly to the link/style tag with the CSS Variables
@@ -8,7 +18,7 @@ const getThemeMetadata = () => {
 	}
 
 	el = document.createElement("span");
-	el.style.display = "none";
+	(el as HTMLSpanElement).style.display = "none";
 
 	// Try with sapThemeMetaData-Base-baseLib first
 	el.classList.add("sapThemeMetaData-Base-baseLib");
@@ -26,7 +36,7 @@ const getThemeMetadata = () => {
 	return metadata;
 };
 
-const parseThemeMetadata = metadataString => {
+const parseThemeMetadata = (metadataString: string) => {
 	const params = /\(["']?data:text\/plain;utf-8,(.*?)['"]?\)$/i.exec(metadataString);
 	if (params && params.length >= 2) {
 		let paramsString = params[1];
@@ -43,7 +53,7 @@ const parseThemeMetadata = metadataString => {
 			}
 		}
 		try {
-			return JSON.parse(paramsString);
+			return JSON.parse(paramsString) as ThemeMetadata;
 		} catch (ex) {
 			if (!warnings.has("parse")) {
 				console.warn("Malformed theme metadata string, unable to parse JSON"); // eslint-disable-line
@@ -53,12 +63,12 @@ const parseThemeMetadata = metadataString => {
 	}
 };
 
-const processThemeMetadata = metadata => {
+const processThemeMetadata = (metadata: ThemeMetadata): ThemeDescriptor | undefined => {
 	let themeName;
 	let baseThemeName;
 
 	try {
-		themeName = metadata.Path.match(/\.([^.]+)\.css_variables$/)[1];
+		themeName = metadata.Path.match(/\.([^.]+)\.css_variables$/)![1];
 		baseThemeName = metadata.Extends[0];
 	} catch (ex) {
 		if (!warnings.has("object")) {
@@ -74,14 +84,18 @@ const processThemeMetadata = metadata => {
 	};
 };
 
-const getThemeDesignerTheme = () => {
+const getThemeDesignerTheme = (): ThemeDescriptor | undefined => {
 	const metadataString = getThemeMetadata();
 	if (!metadataString || metadataString === "none") {
 		return;
 	}
 
 	const metadata = parseThemeMetadata(metadataString);
-	return processThemeMetadata(metadata);
+
+	if (metadata) {
+		return processThemeMetadata(metadata);
+	}
 };
 
 export default getThemeDesignerTheme;
+export type { ThemeDescriptor };

package/src/theming/{preloadLinks.js → preloadLinks.ts}

@@ -1,10 +1,11 @@
 import getEffectiveLinksHrefs from "./getEffectiveLinksHrefs.js";
 import createLinkInHead from "../util/createLinkInHead.js";
 import { shouldUseLinks, shouldPreloadLinks } from "../CSP.js";
+import type UI5Element from "../UI5Element.js";
 
-const preloaded = new Set();
+const preloaded = new Set<string>();
 
-const preloadLinks = ElementClass => {
+const preloadLinks = (ElementClass: typeof UI5Element) => {
 	if (!shouldUseLinks() || !shouldPreloadLinks()) {
 		return;
 	}

package/src/thirdparty/{_merge.js → _merge.ts}

@@ -1,6 +1,6 @@
 import isPlainObject from './isPlainObject.js';
 var oToken = Object.create(null);
-var fnMerge = function () {
+var fnMerge = function (arg1?: any, arg2?: any, arg3?: any, arg4?: any) {
     var src, copyIsArray, copy, name, options, clone, target = arguments[2] || {}, i = 3, length = arguments.length, deep = arguments[0] || false, skipToken = arguments[1] ? undefined : oToken;
     if (typeof target !== 'object' && typeof target !== 'function') {
         target = {};
@@ -29,4 +29,4 @@ var fnMerge = function () {
     }
     return target;
 };
-export default fnMerge;
+export default fnMerge;

package/src/thirdparty/{isPlainObject.js → isPlainObject.ts}

@@ -3,7 +3,7 @@ var hasOwn = class2type.hasOwnProperty;
 var toString = class2type.toString;
 var fnToString = hasOwn.toString;
 var ObjectFunctionString = fnToString.call(Object);
-var fnIsPlainObject = function (obj) {
+var fnIsPlainObject = function (obj: object) {
   var proto, Ctor;
   if (!obj || toString.call(obj) !== "[object Object]") {
     return false;

package/src/thirdparty/merge.ts

@@ -0,0 +1,5 @@
+import _merge from './_merge.js';
+const fnMerge = function (arg1?: any, arg2?: any) {
+    return _merge(true, false, ...arguments);
+};
+export default fnMerge;

package/src/types/AnimationMode.ts

@@ -0,0 +1,33 @@
+/**
+ * Different types of AnimationMode.
+ *
+ * @class
+ * @enum {string}
+ * @public
+ * @author SAP SE
+ * @alias sap.ui.webc.base.types.AnimationMode
+ */
+enum AnimationMode {
+	/**
+	 * @public
+	 * @type {Full}
+	 */
+	Full = "full",
+	/**
+	 * @public
+	 * @type {Basic}
+	 */
+	Basic = "basic",
+	/**
+	 * @public
+	 * @type {Minimal}
+	 */
+	Minimal = "minimal",
+	/**
+	 * @public
+	 * @type {None}
+	 */
+	None = "none",
+}
+
+export default AnimationMode;

package/src/types/{CSSColor.js → CSSColor.ts}

@@ -1,7 +1,18 @@
 import DataType from "./DataType.js";
 
+/**
+ * @class
+ * CSSColor data type.
+ *
+ * @extends sap.ui.webc.base.types.DataType
+ * @constructor
+ * @author SAP SE
+ * @alias sap.ui.webc.base.types.CSSColor
+ * @public
+ * @enum {string}
+ */
 class CSSColor extends DataType {
-	static isValid(value) {
+	static override isValid(value: string) {
 		return /^(#([0-9a-fA-F]{3}|[0-9a-fA-F]{6})|rgb\(\s*((1?[0-9]?[0-9]|2([0-4][0-9]|5[0-5]))|([0-9]?[0-9](\.[0-9]+)?|100(\.0+)?)%)\s*(,\s*((1?[0-9]?[0-9]|2([0-4][0-9]|5[0-5]))|([0-9]?[0-9](\.[0-9]+)?|100(\.0+)?)%)\s*){2}\)|rgba\((\s*((1?[0-9]?[0-9]|2([0-4][0-9]|5[0-5]))|([0-9]?[0-9](\.[0-9]+)?|100(\.0+)?)%)\s*,){3}\s*(0(\.[0-9]+)?|1(\.0+)?)\s*\)|hsl\(\s*([0-2]?[0-9]?[0-9]|3([0-5][0-9]|60))\s*(,\s*(([0-9]?[0-9](\.[0-9]+)?|100(\.0+)?)%)\s*){2}\)|hsla\(\s*([0-2]?[0-9]?[0-9]|3([0-5][0-9]|60))\s*,(\s*(([0-9]?[0-9](\.[0-9]+)?|100(\.0+)?)%)\s*,){2}\s*(0(\.[0-9]+)?|1(\.0+)?)\s*\)|aliceblue|antiquewhite|aqua|aquamarine|azure|beige|bisque|black|blanchedalmond|blue|blueviolet|brown|burlywood|cadetblue|chartreuse|chocolate|coral|cornflowerblue|cornsilk|crimson|cyan|darkblue|darkcyan|darkgoldenrod|darkgray|darkgrey|darkgreen|darkkhaki|darkmagenta|darkolivegreen|darkorange|darkorchid|darkred|darksalmon|darkseagreen|darkslateblue|darkslategray|darkslategrey|darkturquoise|darkviolet|deeppink|deepskyblue|dimgray|dimgrey|dodgerblue|firebrick|floralwhite|forestgreen|fuchsia|gainsboro|ghostwhite|gold|goldenrod|gray|grey|green|greenyellow|honeydew|hotpink|indianred|indigo|ivory|khaki|lavender|lavenderblush|lawngreen|lemonchiffon|lightblue|lightcoral|lightcyan|lightgoldenrodyellow|lightgray|lightgrey|lightgreen|lightpink|lightsalmon|lightseagreen|lightskyblue|lightslategray|lightslategrey|lightsteelblue|lightyellow|lime|limegreen|linen|magenta|maroon|mediumaquamarine|mediumblue|mediumorchid|mediumpurple|mediumseagreen|mediumslateblue|mediumspringgreen|mediumturquoise|mediumvioletred|midnightblue|mintcream|mistyrose|moccasin|navajowhite|navy|oldlace|olive|olivedrab|orange|orangered|orchid|palegoldenrod|palegreen|paleturquoise|palevioletred|papayawhip|peachpuff|peru|pink|plum|powderblue|purple|red|rosybrown|royalblue|saddlebrown|salmon|sandybrown|seagreen|seashell|sienna|silverskyblue|slateblue|slategray|slategrey|snow|springgreen|steelblue|tan|teal|thistle|tomato|turquoise|violet|wheat|white|whitesmoke|yellow|yellowgreen|transparent|inherit|)$/.test(value ); // eslint-disable-line
 	}
 }

package/src/types/CalendarType.ts

@@ -0,0 +1,38 @@
+/**
+ * Different calendar types.
+ *
+ * @class
+ * @enum {string}
+ * @public
+ * @author SAP SE
+ * @alias sap.ui.webc.base.types.CalendarType
+ */
+enum CalendarType {
+	/**
+	 * @public
+	 * @type {Gregorian}
+	 */
+	Gregorian = "Gregorian",
+	/**
+	 * @public
+	 * @type {Islamic}
+	 */
+	Islamic = "Islamic",
+	/**
+	 * @public
+	 * @type {Japanese}
+	 */
+	Japanese = "Japanese",
+	/**
+	 * @public
+	 * @type {Buddhist}
+	 */
+	Buddhist = "Buddhist",
+	/**
+	 * @public
+	 * @type {Persian}
+	 */
+	Persian = "Persian",
+}
+
+export default CalendarType;

package/src/types/DOMReference.ts

@@ -0,0 +1,28 @@
+import DataType from "./DataType.js";
+
+/**
+ * @class
+ * DOM Element reference or ID.
+ * <b>Note:</b> If an ID is passed, it is expected to be part of the same <code>document</code> element as the consuming component.
+ *
+ * @constructor
+ * @extends sap.ui.webc.base.types.DataType
+ * @author SAP SE
+ * @alias sap.ui.webc.base.types.DOMReference
+ * @public
+ */
+class DOMReference extends DataType {
+	static override isValid(value: string | HTMLElement) {
+		return (typeof value === "string" || value instanceof HTMLElement);
+	}
+
+	static override propertyToAttribute(propertyValue: string | HTMLElement) {
+		if (propertyValue instanceof HTMLElement) {
+			return null;
+		}
+
+		return propertyValue;
+	}
+}
+
+export default DOMReference;

package/src/types/DataType.ts

@@ -0,0 +1,51 @@
+import { PropertyValue } from "../UI5ElementMetadata.js";
+
+/**
+ * Base class for all data types.
+ *
+ * @class
+ * @constructor
+ * @author SAP SE
+ * @alias sap.ui.webc.base.types.DataType
+ * @public
+ */
+class DataType {
+	/**
+	 * Checks if the value is valid for its data type.
+ 	 * @public
+	 * @abstract
+	 * @returns {Boolean}
+	 */
+	// eslint-disable-next-line
+	static isValid(value: any): boolean {
+		return false;
+	}
+
+	static attributeToProperty(attributeValue: string | null): PropertyValue {
+		return attributeValue;
+	}
+
+	static propertyToAttribute(propertyValue: PropertyValue): string | null {
+		return propertyValue === null ? null : String(propertyValue);
+	}
+
+	static valuesAreEqual(value1: any, value2: any) {
+		return value1 === value2;
+	}
+
+	static generateTypeAccessors(types: Record<string, string>) {
+		Object.keys(types).forEach(type => {
+			Object.defineProperty(this, type, {
+				get() {
+					return types[type];
+				},
+			});
+		});
+	}
+
+	static get isDataTypeClass() {
+		return true;
+	}
+}
+
+export default DataType;

package/src/types/Float.ts

@@ -0,0 +1,25 @@
+import { PropertyValue } from "../UI5ElementMetadata.js";
+import DataType from "./DataType.js";
+
+/**
+ * @class
+ * Float data type.
+ *
+ * @constructor
+ * @extends sap.ui.webc.base.types.DataType
+ * @author SAP SE
+ * @alias sap.ui.webc.base.types.Float
+ * @public
+ * @enum {number}
+ */
+class Float extends DataType {
+	static override isValid(value: any) {
+		return Number(value) === value;
+	}
+
+	static override attributeToProperty(attributeValue: string): PropertyValue {
+		return parseFloat(attributeValue);
+	}
+}
+
+export default Float;

package/src/types/Integer.ts

@@ -0,0 +1,25 @@
+import { PropertyValue } from "../UI5ElementMetadata.js";
+import DataType from "./DataType.js";
+
+/**
+ * @class
+ * Integer data type.
+ *
+ * @constructor
+ * @extends sap.ui.webc.base.types.DataType
+ * @author SAP SE
+ * @alias sap.ui.webc.base.types.Integer
+ * @public
+ * @enum {number}
+ */
+class Integer extends DataType {
+	static override isValid(value: any) {
+		return Number.isInteger(value);
+	}
+
+	static override attributeToProperty(attributeValue: string): PropertyValue {
+		return parseInt(attributeValue);
+	}
+}
+
+export default Integer;

package/src/types/InvisibleMessageMode.ts

@@ -0,0 +1,27 @@
+/**
+ * Enumeration for different mode behaviors of the InvisibleMessage.
+ *
+ * @class
+ * @enum {string}
+ * @public
+ * @author SAP SE
+ * @alias sap.ui.webc.base.types.InvisibleMessageMode
+ */
+enum InvisibleMessageMode {
+	/**
+     * Indicates that updates to the region should be presented at the next graceful opportunity,
+     * such as at the end of reading the current sentence, or when the user pauses typing.
+	 * @public
+	 * @type {Polite}
+     */
+	Polite = "Polite",
+
+	/**
+     * Indicates that updates to the region have the highest priority and should be presented to the user immediately.
+	 * @public
+	 * @type {Assertive}
+     */
+	Assertive = "Assertive",
+}
+
+export default InvisibleMessageMode;

package/src/types/ItemNavigationBehavior.ts

@@ -0,0 +1,26 @@
+/**
+ * Different behavior for ItemNavigation.
+ *
+ * @class
+ * @enum {string}
+ * @public
+ * @author SAP SE
+ * @alias sap.ui.webc.base.types.ItemNavigationBehavior
+ */
+enum ItemNavigationBehavior {
+	/**
+	 * Static behavior: navigations stops at the first or last item.
+	 * @public
+	 * @type {Static}
+ 	 */
+	Static = "Static",
+
+	/**
+	 * Cycling behavior: navigating past the last item continues with the first and vice versa.
+	 * @public
+	 * @type {Cyclic}
+ 	 */
+	Cyclic = "Cyclic",
+}
+
+export default ItemNavigationBehavior;

package/src/types/NavigationMode.ts

@@ -0,0 +1,33 @@
+/**
+ * Different navigation modes for ItemNavigation.
+ *
+ * @class
+ * @enum {string}
+ * @public
+ * @author SAP SE
+ * @alias sap.ui.webc.base.types.NavigationMode
+ */
+enum NavigationMode {
+	/**
+	 * @public
+	 * @type {Auto}
+	 */
+	Auto = "Auto",
+	/**
+	 * @public
+	 * @type {Vertical}
+	 */
+	Vertical = "Vertical",
+	/**
+	 * @public
+	 * @type {Horizontal}
+	 */
+	Horizontal = "Horizontal",
+	/**
+	 * @public
+	 * @type {Paging}
+	 */
+	Paging = "Paging",
+}
+
+export default NavigationMode;

package/src/types/ValueState.ts

@@ -0,0 +1,47 @@
+/**
+ * Different types of ValueStates.
+ *
+ * @class
+ * @enum {string}
+ * @public
+ * @author SAP SE
+ * @alias sap.ui.webc.base.types.ValueState
+ */
+enum ValueState {
+	/**
+	 *
+	 * @public
+	 * @type {None}
+	 */
+	None = "None",
+
+	/**
+	 *
+	 * @public
+	 * @type {Success}
+	 */
+	Success = "Success",
+
+	/**
+	 *
+	 * @public
+	 * @type {Warning}
+	 */
+	Warning = "Warning",
+
+	/**
+	 *
+	 * @public
+	 * @type {Error}
+	 */
+	Error = "Error",
+
+	/**
+	 *
+	 * @public
+	 * @type {Information}
+	 */
+	Information = "Information",
+}
+
+export default ValueState;

package/src/types.ts

@@ -0,0 +1,30 @@
+type PromiseResolve = (value: void | PromiseLike<void>) => void;
+type Timeout = ReturnType<typeof setTimeout>;
+type Interval = ReturnType<typeof setInterval>;
+
+type StyleDataCSP = {
+	content: string,
+	packageName: string,
+	fileName: string,
+};
+
+type StyleData = StyleDataCSP | string;
+
+type ComponentStylesData = Array<ComponentStylesData> | Array<StyleData> | StyleData;
+
+type ClassMapValue = Record<string, boolean>
+
+type ClassMap = { [x: string] : ClassMapValue | ClassMap };
+
+type PassiveEventListenerObject = EventListenerObject & { passive: boolean };
+
+export type {
+	PromiseResolve,
+	Timeout,
+	Interval,
+	StyleData,
+	StyleDataCSP,
+	ComponentStylesData,
+	ClassMap,
+	PassiveEventListenerObject,
+};

package/src/updateShadowRoot.ts

@@ -0,0 +1,42 @@
+import executeTemplate from "./renderer/executeTemplate.js";
+import getConstructableStyle from "./theming/getConstructableStyle.js";
+import getEffectiveStyle from "./theming/getEffectiveStyle.js";
+import getEffectiveLinksHrefs from "./theming/getEffectiveLinksHrefs.js";
+import { shouldUseLinks } from "./CSP.js";
+import type UI5Element from "./UI5Element.js";
+
+/**
+ * Updates the shadow root of a UI5Element or its static area item
+ * @param element
+ * @param forStaticArea
+ */
+const updateShadowRoot = (element: UI5Element, forStaticArea = false) => {
+	let styleStrOrHrefsArr;
+	const ctor = element.constructor as typeof UI5Element;
+	const propertyName = forStaticArea ? "staticAreaTemplate" : "template";
+	const template = ctor[propertyName];
+	const shadowRoot = forStaticArea ? element.staticAreaItem!.shadowRoot : element.shadowRoot;
+	const renderResult = executeTemplate(template!, element); // this is checked before calling updateShadowRoot
+
+	if (!shadowRoot) {
+		console.warn(`There is no shadow root to update`); // eslint-disable-line
+		return;
+	}
+
+	if (shouldUseLinks()) {
+		styleStrOrHrefsArr = getEffectiveLinksHrefs(ctor, forStaticArea);
+	} else if (document.adoptedStyleSheets) { // Chrome
+		shadowRoot.adoptedStyleSheets = getConstructableStyle(ctor, forStaticArea);
+	} else { // FF, Safari
+		styleStrOrHrefsArr = getEffectiveStyle(ctor, forStaticArea);
+	}
+
+	if (ctor.renderer) {
+		ctor.renderer(renderResult, shadowRoot, styleStrOrHrefsArr, forStaticArea, { host: element });
+		return;
+	}
+
+	ctor.render(renderResult, shadowRoot, styleStrOrHrefsArr, forStaticArea, { host: element });
+};
+
+export default updateShadowRoot;