@ui5/webcomponents-base 0.0.0-a3eca7ade → 0.0.0-a7032d86e

package/src/{CSP.js → CSP.ts}

@@ -1,20 +1,27 @@
-const roots = new Map();
+const roots = new Map<string, string>();
 let useLinks = false;
 let preloadLinks = true;
 
 /**
- * Use this function to provide the path to the directory where the css resources for the given package will be served from
+ * Use this function to provide the path to the directory where the css resources for the given package will be served from.
  *
  * @public
  * @param packageName name of the package that is being configured
  * @param root path, accessible by the server that will serve the css resources
  */
-const setPackageCSSRoot = (packageName, root) => {
+const setPackageCSSRoot = (packageName: string, root: string) => {
 	roots.set(packageName, root);
 };
 
-const getUrl = (packageName, path) => {
-	return `${roots.get(packageName)}${path}`;
+const getUrl = (packageName: string, path: string) => {
+	const packageCSSRoot = roots.get(packageName);
+
+	if (!packageCSSRoot) {
+		console.warn(`Root path to the CSS resources ${packageName} not provided - use "setPackageCSSRoot" to provide the root.`); // eslint-disable-line
+		return "";
+	}
+
+	return `${packageCSSRoot}${path}`;
 };
 
 /**
@@ -25,7 +32,7 @@ const getUrl = (packageName, path) => {
  * @public
  * @param use whether links will be used
  */
-const setUseLinks = use => {
+const setUseLinks = (use: boolean) => {
 	useLinks = use;
 };
 
@@ -37,7 +44,7 @@ const setUseLinks = use => {
  * @public
  * @param preload
  */
-const setPreloadLinks = preload => {
+const setPreloadLinks = (preload: boolean) => {
 	preloadLinks = preload;
 };
 

package/src/{CustomElementsRegistry.js → CustomElementsRegistry.ts}

@@ -1,40 +1,43 @@
-import setToArray from "./util/setToArray.js";
 import getSharedResource from "./getSharedResource.js";
 import { getCurrentRuntimeIndex, compareRuntimes, getAllRuntimes } from "./Runtimes.js";
+import { Timeout } from "./types.js";
 
-const Tags = getSharedResource("Tags", new Map());
+const Tags = getSharedResource<Map<string, number>>("Tags", new Map());
+const Definitions = new Set<string>();
 
-const Definitions = new Set();
-let Failures = {};
-let failureTimeout;
+let Failures = new Map<number, Set<string>>();
+let failureTimeout: Timeout | undefined;
 
-const UNKNOWN_RUNTIME = "unknown";
+const UNKNOWN_RUNTIME = -1;
 
-const registerTag = tag => {
+const registerTag = (tag: string) => {
 	Definitions.add(tag);
 	Tags.set(tag, getCurrentRuntimeIndex());
 };
 
-const isTagRegistered = tag => {
+const isTagRegistered = (tag: string) => {
 	return Definitions.has(tag);
 };
 
 const getAllRegisteredTags = () => {
-	return setToArray(Definitions);
+	return [...Definitions.values()];
 };
 
-const recordTagRegistrationFailure = tag => {
+const recordTagRegistrationFailure = (tag: string) => {
 	let tagRegRuntimeIndex = Tags.get(tag);
 	if (tagRegRuntimeIndex === undefined) {
 		tagRegRuntimeIndex = UNKNOWN_RUNTIME; // If the tag is taken, but not registered in Tags, then a version before 1.1.0 defined it => use the "unknown" key
 	}
-	Failures[tagRegRuntimeIndex] = Failures[tagRegRuntimeIndex] || new Set();
-	Failures[tagRegRuntimeIndex].add(tag);
+
+	if (!Failures.has(tagRegRuntimeIndex)) {
+		Failures.set(tagRegRuntimeIndex, new Set());
+	}
+	Failures.get(tagRegRuntimeIndex)!.add(tag);
 
 	if (!failureTimeout) {
 		failureTimeout = setTimeout(() => {
 			displayFailedRegistrations();
-			Failures = {};
+			Failures = new Map();
 			failureTimeout = undefined;
 		}, 1000);
 	}
@@ -51,8 +54,8 @@ const displayFailedRegistrations = () => {
 		message = `${message}\nLoading order (versions before 1.1.0 not listed): ${allRuntimes.map(runtime => `\n${runtime.description}`).join("")}`;
 	}
 
-	Object.keys(Failures).forEach(otherRuntimeIndex => {
-		let comparison;
+	[...Failures.keys()].forEach(otherRuntimeIndex => {
+		let comparison: number;
 		let otherRuntime;
 
 		if (otherRuntimeIndex === UNKNOWN_RUNTIME) { // version < 1.1.0 defined the tag
@@ -73,7 +76,7 @@ const displayFailedRegistrations = () => {
 		} else {
 			compareWord = "the same";
 		}
-		message = `${message}\n\n"${currentRuntime.description}" failed to define ${Failures[otherRuntimeIndex].size} tag(s) as they were defined by a runtime of ${compareWord} version "${otherRuntime.description}": ${setToArray(Failures[otherRuntimeIndex]).sort().join(", ")}.`;
+		message = `${message}\n\n"${currentRuntime.description}" failed to define ${Failures.get(otherRuntimeIndex)!.size} tag(s) as they were defined by a runtime of ${compareWord} version "${otherRuntime.description}": ${([...Failures.get(otherRuntimeIndex)!]).sort().join(", ")}.`;
 
 		if (comparison > 0) {
 			message = `${message}\nWARNING! If your code uses features of the above web components, unavailable in ${otherRuntime.description}, it might not work as expected!`;
@@ -82,7 +85,7 @@ const displayFailedRegistrations = () => {
 		}
 	});
 
-	message = `${message}\n\nTo prevent other runtimes from defining tags that you use, consider using scoping or have third-party libraries use scoping: https://github.com/SAP/ui5-webcomponents/blob/master/docs/2-advanced/03-scoping.md.`;
+	message = `${message}\n\nTo prevent other runtimes from defining tags that you use, consider using scoping or have third-party libraries use scoping: https://github.com/SAP/ui5-webcomponents/blob/main/docs/2-advanced/03-scoping.md.`;
 
 	console.warn(message); // eslint-disable-line
 };

package/src/CustomElementsScope.ts

@@ -0,0 +1,33 @@
+import {
+	html,
+	svg,
+	unsafeStatic,
+} from "lit-html/static.js";
+
+import {
+	setCustomElementsScopingSuffix,
+	getCustomElementsScopingSuffix,
+	setCustomElementsScopingRules,
+	getCustomElementsScopingRules,
+	shouldScopeCustomElement,
+	getEffectiveScopingSuffixForTag,
+} from "./CustomElementsScopeUtils.js";
+import { registerFeature } from "./FeaturesRegistry.js";
+
+class LitStatic {
+	static html = html;
+	static svg = svg;
+	static unsafeStatic: (value: string) => object = unsafeStatic;
+}
+
+registerFeature("LitStatic", LitStatic);
+
+export {
+	LitStatic,
+	setCustomElementsScopingSuffix,
+	getCustomElementsScopingSuffix,
+	setCustomElementsScopingRules,
+	getCustomElementsScopingRules,
+	shouldScopeCustomElement,
+	getEffectiveScopingSuffixForTag,
+};

package/src/{CustomElementsScope.js → CustomElementsScopeUtils.ts}

@@ -1,9 +1,16 @@
-let suf;
-let rulesObj = {
+let suf: string;
+
+type Rules = {
+	include: Array<RegExp>,
+	exclude: Array<RegExp>,
+};
+
+let rulesObj: Rules = {
 	include: [/^ui5-/],
 	exclude: [],
 };
-const tagsCache = new Map(); // true/false means the tag should/should not be cached, undefined means not known yet.
+
+const tagsCache = new Map<string, boolean>(); // true/false means the tag should/should not be cached, undefined means not known yet.
 
 /**
  * Sets the suffix to be used for custom elements scoping, f.e. pass "demo" to get tags such as "ui5-button-demo".
@@ -12,7 +19,7 @@ const tagsCache = new Map(); // true/false means the tag should/should not be ca
  * @public
  * @param suffix The scoping suffix
  */
-const setCustomElementsScopingSuffix = suffix => {
+const setCustomElementsScopingSuffix = (suffix: string) => {
 	if (!suffix.match(/^[a-zA-Z0-9_-]+$/)) {
 		throw new Error("Only alphanumeric characters and dashes allowed for the scoping suffix");
 	}
@@ -39,7 +46,7 @@ const getCustomElementsScopingSuffix = () => {
  * @param rules Object with "include" and "exclude" properties, both arrays of regular expressions. Note that "include"
  * rules are applied first and "exclude" rules second.
  */
-const setCustomElementsScopingRules = rules => {
+const setCustomElementsScopingRules = (rules: Rules) => {
 	if (!rules || !rules.include) {
 		throw new Error(`"rules" must be an object with at least an "include" property`);
 	}
@@ -76,7 +83,7 @@ const getCustomElementsScopingRules = () => {
  * @public
  * @param tag
  */
-const shouldScopeCustomElement = tag => {
+const shouldScopeCustomElement = (tag: string) => {
 	if (!tagsCache.has(tag)) {
 		const result = rulesObj.include.some(rule => tag.match(rule)) && !rulesObj.exclude.some(rule => tag.match(rule));
 		tagsCache.set(tag, result);
@@ -92,7 +99,7 @@ const shouldScopeCustomElement = tag => {
  * @param tag
  * @returns {String}
  */
-const getEffectiveScopingSuffixForTag = tag => {
+const getEffectiveScopingSuffixForTag = (tag: string) => {
 	if (shouldScopeCustomElement(tag)) {
 		return getCustomElementsScopingSuffix();
 	}

package/src/DOMObserver.ts

@@ -0,0 +1,28 @@
+const observers = new WeakMap<Node, MutationObserver>();
+
+/**
+ * @param node
+ * @param callback
+ * @param options
+ */
+const observeDOMNode = (node: Node, callback: MutationCallback, options?: MutationObserverInit) => {
+	const observer = new MutationObserver(callback);
+	observers.set(node, observer);
+	observer.observe(node, options);
+};
+
+/**
+ * @param node
+ */
+const unobserveDOMNode = (node: Node) => {
+	const observer = observers.get(node);
+	if (observer) {
+		observer.disconnect();
+		observers.delete(node);
+	}
+};
+
+export {
+	observeDOMNode,
+	unobserveDOMNode,
+};

package/src/{Device.js → Device.ts}

@@ -2,10 +2,11 @@ const ua = navigator.userAgent;
 const touch = "ontouchstart" in window || navigator.maxTouchPoints > 0;
 const ie = /(msie|trident)/i.test(ua);
 const chrome = !ie && /(Chrome|CriOS)/.test(ua);
+const firefox = /Firefox/.test(ua);
 const safari = !ie && !chrome && /(Version|PhantomJS)\/(\d+\.\d+).*Safari/.test(ua);
 const webkit = !ie && /webkit/.test(ua);
 const windows = navigator.platform.indexOf("Win") !== -1;
-const iOS = navigator.platform.match(/iPhone|iPad|iPod/) || (navigator.userAgent.match(/Mac/) && "ontouchend" in document);
+const iOS = !!(navigator.platform.match(/iPhone|iPad|iPod/)) || !!(navigator.userAgent.match(/Mac/) && "ontouchend" in document);
 const android = !windows && /Android/.test(ua);
 const androidPhone = android && /(?=android)(?=.*mobile)/i.test(ua);
 const ipad = /ipad/i.test(ua) || (/Macintosh/i.test(ua) && "ontouchend" in document);
@@ -13,9 +14,9 @@ const ipad = /ipad/i.test(ua) || (/Macintosh/i.test(ua) && "ontouchend" in docum
 // "Request Desktop Website -> All websites" (for more infos see: https://forums.developer.apple.com/thread/119186).
 // Therefore the OS is detected as MACINTOSH instead of iOS and the device is a tablet if the Device.support.touch is true.
 
-let windowsVersion;
-let webkitVersion;
-let tablet;
+let windowsVersion: number;
+let webkitVersion: number;
+let tablet: boolean;
 
 const isWindows8OrAbove = () => {
 	if (!windows) {
@@ -76,41 +77,48 @@ const detectTablet = () => {
 	tablet = (ie && ua.indexOf("Touch") !== -1) || (android && !androidPhone);
 };
 
-const supportsTouch = () => touch;
-const isIE = () => ie;
-const isSafari = () => safari;
-const isChrome = () => chrome;
+const supportsTouch = (): boolean => touch;
+const isIE = (): boolean => ie;
+const isSafari = (): boolean => safari;
+const isChrome = (): boolean => chrome;
+const isFirefox = (): boolean => firefox;
 
-const isTablet = () => {
+const isTablet = (): boolean => {
 	detectTablet();
 	return (touch || isWindows8OrAbove()) && tablet;
 };
 
-const isPhone = () => {
+const isPhone = (): boolean => {
 	detectTablet();
 	return touch && !tablet;
 };
 
-const isDesktop = () => {
+const isDesktop = (): boolean => {
 	return (!isTablet() && !isPhone()) || isWindows8OrAbove();
 };
 
-const isCombi = () => {
+const isCombi = (): boolean => {
 	return isTablet() && isDesktop();
 };
 
-const isIOS = () => {
+const isIOS = (): boolean => {
 	return iOS;
 };
 
+const isAndroid = (): boolean => {
+	return android || androidPhone;
+};
+
 export {
 	supportsTouch,
 	isIE,
 	isSafari,
 	isChrome,
+	isFirefox,
 	isPhone,
 	isTablet,
 	isDesktop,
 	isCombi,
 	isIOS,
+	isAndroid,
 };

package/src/{EventProvider.js → EventProvider.ts}

@@ -1,9 +1,11 @@
-class EventProvider {
+class EventProvider<EventListenerParam, EventListenerReturn> {
+	_eventRegistry: Map<string, Array<(param: EventListenerParam) => EventListenerReturn>>;
+
 	constructor() {
 		this._eventRegistry = new Map();
 	}
 
-	attachEvent(eventName, fnFunction) {
+	attachEvent(eventName: string, fnFunction: (param: EventListenerParam) => EventListenerReturn) {
 		const eventRegistry = this._eventRegistry;
 		const eventListeners = eventRegistry.get(eventName);
 
@@ -17,7 +19,7 @@ class EventProvider {
 		}
 	}
 
-	detachEvent(eventName, fnFunction) {
+	detachEvent(eventName: string, fnFunction: (param: EventListenerParam) => EventListenerReturn) {
 		const eventRegistry = this._eventRegistry;
 		const eventListeners = eventRegistry.get(eventName);
 
@@ -42,7 +44,7 @@ class EventProvider {
 	 * @param data optional data to pass to each event listener
 	 * @returns {Array} an array with the results of all event listeners
 	 */
-	fireEvent(eventName, data) {
+	fireEvent(eventName: string, data: EventListenerParam) {
 		const eventRegistry = this._eventRegistry;
 		const eventListeners = eventRegistry.get(eventName);
 
@@ -62,11 +64,11 @@ class EventProvider {
 	 * @param data optional data to pass to each event listener
 	 * @returns {Promise} a promise that will resolve when all listeners have resolved
 	 */
-	fireEventAsync(eventName, data) {
+	fireEventAsync(eventName: string, data: EventListenerParam) {
 		return Promise.all(this.fireEvent(eventName, data));
 	}
 
-	isHandlerAttached(eventName, fnFunction) {
+	isHandlerAttached(eventName: string, fnFunction: (param: EventListenerParam) => EventListenerReturn) {
 		const eventRegistry = this._eventRegistry;
 		const eventListeners = eventRegistry.get(eventName);
 
@@ -77,7 +79,7 @@ class EventProvider {
 		return eventListeners.includes(fnFunction);
 	}
 
-	hasListeners(eventName) {
+	hasListeners(eventName: string) {
 		return !!this._eventRegistry.get(eventName);
 	}
 }

package/src/FeaturesRegistry.ts

@@ -0,0 +1,14 @@
+const features = new Map<string, any>();
+
+const registerFeature = (name: string, feature: object) => {
+	features.set(name, feature);
+};
+
+const getFeature = <T>(name: string): T => {
+	return features.get(name) as T;
+};
+
+export {
+	registerFeature,
+	getFeature,
+};

package/src/{FontFace.js → FontFace.ts}

@@ -2,12 +2,13 @@ import { hasStyle, createStyle } from "./ManagedStyles.js";
 import { getFeature } from "./FeaturesRegistry.js";
 import fontFaceCSS from "./generated/css/FontFace.css.js";
 import overrideFontFaceCSS from "./generated/css/OverrideFontFace.css.js";
+import type OpenUI5Support from "./features/OpenUI5Support.js";
 
 const insertFontFace = () => {
-	const OpenUI5Support = getFeature("OpenUI5Support");
+	const openUI5Support = getFeature<typeof OpenUI5Support>("OpenUI5Support");
 
 	// Only set the main font if there is no OpenUI5 support, or there is, but OpenUI5 is not loaded
-	if (!OpenUI5Support || !OpenUI5Support.isLoaded()) {
+	if (!openUI5Support || !openUI5Support.isLoaded()) {
 		insertMainFontFace();
 	}
 

package/src/{InitialConfiguration.js → InitialConfiguration.ts}

@@ -1,15 +1,34 @@
 import merge from "./thirdparty/merge.js";
 import { getFeature } from "./FeaturesRegistry.js";
 import { DEFAULT_THEME } from "./generated/AssetParameters.js";
+import validateThemeRoot from "./validateThemeRoot.js";
+import type OpenUI5Support from "./features/OpenUI5Support";
+import type { FormatSettings } from "./config/FormatSettings.js";
+import AnimationMode from "./types/AnimationMode.js";
+import CalendarType from "./types/CalendarType.js";
 
 let initialized = false;
 
-let initialConfig = {
-	animationMode: "full",
+type InitialConfig = {
+	[key: string]: any,
+	animationMode: AnimationMode,
+	theme: string,
+	themeRoot: string | undefined,
+	rtl: boolean | undefined,
+	language: string | undefined,
+	calendarType: CalendarType | undefined,
+	noConflict: boolean,
+	formatSettings: FormatSettings,
+	fetchDefaultLanguage: boolean,
+};
+
+let initialConfig: InitialConfig = {
+	animationMode: AnimationMode.Full,
 	theme: DEFAULT_THEME,
-	rtl: null,
-	language: null,
-	calendarType: null,
+	themeRoot: undefined,
+	rtl: undefined,
+	language: undefined,
+	calendarType: undefined,
 	noConflict: false, // no URL
 	formatSettings: {},
 	fetchDefaultLanguage: false,
@@ -26,6 +45,11 @@ const getTheme = () => {
 	return initialConfig.theme;
 };
 
+const getThemeRoot = () => {
+	initConfiguration();
+	return initialConfig.themeRoot;
+};
+
 const getRTL = () => {
 	initConfiguration();
 	return initialConfig.rtl;
@@ -51,6 +75,10 @@ const getNoConflict = () => {
 	return initialConfig.noConflict;
 };
 
+/**
+ * Get the configured calendar type
+ * @returns { String } the name of the configured calendar type
+ */
 const getCalendarType = () => {
 	initConfiguration();
 	return initialConfig.calendarType;
@@ -106,7 +134,13 @@ const parseURLParameters = () => {
 	});
 };
 
-const normalizeParamValue = (param, value) => {
+const normalizeThemeRootParamValue = (value: string) => {
+	const themeRoot = value.split("@")[1];
+
+	return validateThemeRoot(themeRoot);
+};
+
+const normalizeThemeParamValue = (param: string, value: string) => {
 	if (param === "theme" && value.includes("@")) { // the theme parameter might have @<URL-TO-THEME> in the value - strip this
 		return value.split("@")[0];
 	}
@@ -114,7 +148,7 @@ const normalizeParamValue = (param, value) => {
 	return value;
 };
 
-const applyURLParam = (key, value, paramType) => {
+const applyURLParam = (key: string, value: string, paramType: string) => {
 	const lowerCaseValue = value.toLowerCase();
 	const param = key.split(`${paramType}-`)[1];
 
@@ -122,18 +156,24 @@ const applyURLParam = (key, value, paramType) => {
 		value = booleanMapping.get(lowerCaseValue);
 	}
 
-	value = normalizeParamValue(param, value);
+	if (param === "theme") {
+		initialConfig.theme = normalizeThemeParamValue(param, value);
 
-	initialConfig[param] = value;
+		if (value && value.includes("@")) {
+			initialConfig.themeRoot = normalizeThemeRootParamValue(value);
+		}
+	} else {
+		initialConfig[param] = value;
+	}
 };
 
 const applyOpenUI5Configuration = () => {
-	const OpenUI5Support = getFeature("OpenUI5Support");
-	if (!OpenUI5Support || !OpenUI5Support.isLoaded()) {
+	const openUI5Support = getFeature<typeof OpenUI5Support>("OpenUI5Support");
+	if (!openUI5Support || !openUI5Support.isLoaded()) {
 		return;
 	}
 
-	const OpenUI5Config = OpenUI5Support.getConfigurationSettingsObject();
+	const OpenUI5Config = openUI5Support.getConfigurationSettingsObject();
 	initialConfig = merge(initialConfig, OpenUI5Config);
 };
 
@@ -157,6 +197,7 @@ const initConfiguration = () => {
 export {
 	getAnimationMode,
 	getTheme,
+	getThemeRoot,
 	getRTL,
 	getLanguage,
 	getFetchDefaultLanguage,