@ui5/webcomponents-base 0.0.0-cc312800a → 0.0.0-cf069fb29

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ui5/webcomponents-base",
-  "version": "0.0.0-cc312800a",
+  "version": "0.0.0-cf069fb29",
   "description": "UI5 Web Components: webcomponents.base",
   "author": "SAP SE (https://www.sap.com)",
   "license": "Apache-2.0",
@@ -15,6 +15,13 @@
     "url": "https://github.com/SAP/ui5-webcomponents.git",
     "directory": "packages/base"
   },
+  "exports": {
+    ".": "./index.js",
+    "./dist/*": "./dist/*",
+    "./package.json": "./package.json",
+    "./bundle.esm.js": "./bundle.esm.js",
+    "./*": "./dist/*"
+  },
   "scripts": {
     "clean": "nps clean",
     "lint": "nps lint",
@@ -25,16 +32,17 @@
     "prepublishOnly": "npm run clean && npm run build"
   },
   "dependencies": {
-    "lit-html": "^1.3.0"
+    "lit-html": "2.0.1"
   },
   "devDependencies": {
-    "@ui5/webcomponents-tools": "0.0.0-cc312800a",
-    "array-uniq": "^2.0.0",
-    "chromedriver": "89.0.0",
+    "@buxlabs/amd-to-es6": "0.16.1",
+    "@openui5/sap.ui.core": "1.94.0",
+    "@ui5/webcomponents-tools": "0.0.0-cf069fb29",
+    "chromedriver": "96.0.0",
+    "clean-css": "^5.2.2",
     "copy-and-watch": "^0.1.5",
     "eslint": "^7.22.0",
-    "eslint-config-airbnb-base": "^14.2.1",
-    "npm-run-all": "^4.1.5",
-    "path-exists-cli": "^1.0.0"
+    "mkdirp": "^1.0.4",
+    "resolve": "^1.20.0"
   }
 }

package/src/Boot.js

@@ -4,9 +4,10 @@ import insertFontFace from "./FontFace.js";
 import insertSystemCSSVars from "./SystemCSSVars.js";
 import { getTheme } from "./config/Theme.js";
 import applyTheme from "./theming/applyTheme.js";
+import { registerCurrentRuntime } from "./Runtimes.js";
 import { getFeature } from "./FeaturesRegistry.js";
 
-let booted = false;
+let bootPromise;
 const eventProvider = new EventProvider();
 
 /**
@@ -19,22 +20,39 @@ const attachBoot = listener => {
 };
 
 const boot = async () => {
-	if (booted) {
-		return;
+	if (bootPromise) {
+		return bootPromise;
 	}
 
-	const OpenUI5Support = getFeature("OpenUI5Support");
-	if (OpenUI5Support) {
-		await OpenUI5Support.init();
-	}
+	/* eslint-disable no-alert, no-async-promise-executor */
+	/*
+		Note(since we disable eslint rule):
+		If an async executor function throws an error, the error will be lost and won't cause the newly-constructed Promise to reject.
+		This could make it difficult to debug and handle some errors.
+	*/
+	bootPromise = new Promise(async resolve => {
+		registerCurrentRuntime();
+
+		const OpenUI5Support = getFeature("OpenUI5Support");
+		const F6Navigation = getFeature("F6Navigation");
+		if (OpenUI5Support) {
+			await OpenUI5Support.init();
+		} else if (F6Navigation) {
+			F6Navigation.init();
+		}
+
+		await whenDOMReady();
+		await applyTheme(getTheme());
+		OpenUI5Support && OpenUI5Support.attachListeners();
+		insertFontFace();
+		insertSystemCSSVars();
+		await eventProvider.fireEventAsync("boot");
+
+		resolve();
+	});
+	/* eslint-enable no-alert, no-async-promise-executor */
 
-	await whenDOMReady();
-	await applyTheme(getTheme());
-	OpenUI5Support && OpenUI5Support.attachListeners();
-	insertFontFace();
-	insertSystemCSSVars();
-	await eventProvider.fireEventAsync("boot");
-	booted = true;
+	return bootPromise;
 };
 
 export {

package/src/CSP.js

@@ -0,0 +1,59 @@
+const roots = new Map();
+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
+ *
+ * @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) => {
+	roots.set(packageName, root);
+};
+
+const getUrl = (packageName, path) => {
+	return `${roots.get(packageName)}${path}`;
+};
+
+/**
+ * Call this function to enable or disable the usage of <link> tags instead of <style> tags to achieve CSP compliance
+ * Example: "setUseLinks(true)" will unconditionally use <link> tags for all browsers;
+ * Example: "setUseLinks(!document.adoptedStyleSheets) will only enable the usage of <link> tags for browsers that do not support constructable stylesheets.
+ *
+ * @public
+ * @param use whether links will be used
+ */
+const setUseLinks = use => {
+	useLinks = use;
+};
+
+/**
+ * Call this function to enable or disable the preloading of <link> tags.
+ * Note: only taken into account when <link> tags are being used.
+ * Note: links are being preloaded by default, so call "setPreloadLinks(false)" to opt out of this.
+ *
+ * @public
+ * @param preload
+ */
+const setPreloadLinks = preload => {
+	preloadLinks = preload;
+};
+
+const shouldUseLinks = () => {
+	return useLinks;
+};
+
+const shouldPreloadLinks = () => {
+	return preloadLinks;
+};
+
+export {
+	setPackageCSSRoot,
+	getUrl,
+	setUseLinks,
+	setPreloadLinks,
+	shouldUseLinks,
+	shouldPreloadLinks,
+};

package/src/CustomElementsRegistry.js

@@ -1,11 +1,18 @@
 import setToArray from "./util/setToArray.js";
+import getSharedResource from "./getSharedResource.js";
+import { getCurrentRuntimeIndex, compareRuntimes, getAllRuntimes } from "./Runtimes.js";
+
+const Tags = getSharedResource("Tags", new Map());
 
 const Definitions = new Set();
-const Failures = new Set();
+let Failures = {};
 let failureTimeout;
 
+const UNKNOWN_RUNTIME = "unknown";
+
 const registerTag = tag => {
 	Definitions.add(tag);
+	Tags.set(tag, getCurrentRuntimeIndex());
 };
 
 const isTagRegistered = tag => {
@@ -17,18 +24,67 @@ const getAllRegisteredTags = () => {
 };
 
 const recordTagRegistrationFailure = tag => {
-	Failures.add(tag);
+	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 (!failureTimeout) {
 		failureTimeout = setTimeout(() => {
 			displayFailedRegistrations();
+			Failures = {};
 			failureTimeout = undefined;
 		}, 1000);
 	}
 };
 
 const displayFailedRegistrations = () => {
-	console.warn(`The following tags have already been defined by a different UI5 Web Components version: ${setToArray(Failures).join(", ")}`); // eslint-disable-line
-	Failures.clear();
+	const allRuntimes = getAllRuntimes();
+	const currentRuntimeIndex = getCurrentRuntimeIndex();
+	const currentRuntime = allRuntimes[currentRuntimeIndex];
+
+	let message = `Multiple UI5 Web Components instances detected.`;
+
+	if (allRuntimes.length > 1) {
+		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;
+		let otherRuntime;
+
+		if (otherRuntimeIndex === UNKNOWN_RUNTIME) { // version < 1.1.0 defined the tag
+			comparison = 1; // the current runtime is considered newer
+			otherRuntime = {
+				description: `Older unknown runtime`,
+			};
+		} else {
+			comparison = compareRuntimes(currentRuntimeIndex, otherRuntimeIndex);
+			otherRuntime = allRuntimes[otherRuntimeIndex];
+		}
+
+		let compareWord;
+		if (comparison > 0) {
+			compareWord = "an older";
+		} else if (comparison < 0) {
+			compareWord = "a newer";
+		} 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(", ")}.`;
+
+		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!`;
+		} else {
+			message = `${message}\nSince the above web components were defined by the same or newer version runtime, they should be compatible with your code.`;
+		}
+	});
+
+	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.`;
+
+	console.warn(message); // eslint-disable-line
 };
 
 export {

package/src/Device.js

@@ -5,9 +5,13 @@ const chrome = !ie && /(Chrome|CriOS)/.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 android = !windows && /Android/.test(ua);
 const androidPhone = android && /(?=android)(?=.*mobile)/i.test(ua);
-const ipad = /ipad/i.test(ua);
+const ipad = /ipad/i.test(ua) || (/Macintosh/i.test(ua) && "ontouchend" in document);
+// With iOS 13 the string 'iPad' was removed from the user agent string through a browser setting, which is applied on all sites by default:
+// "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;
@@ -75,6 +79,7 @@ const detectTablet = () => {
 const supportsTouch = () => touch;
 const isIE = () => ie;
 const isSafari = () => safari;
+const isChrome = () => chrome;
 
 const isTablet = () => {
 	detectTablet();
@@ -90,11 +95,22 @@ const isDesktop = () => {
 	return (!isTablet() && !isPhone()) || isWindows8OrAbove();
 };
 
+const isCombi = () => {
+	return isTablet() && isDesktop();
+};
+
+const isIOS = () => {
+	return iOS;
+};
+
 export {
 	supportsTouch,
 	isIE,
 	isSafari,
+	isChrome,
 	isPhone,
 	isTablet,
 	isDesktop,
+	isCombi,
+	isIOS,
 };

package/src/EventProvider.js

@@ -1,36 +1,37 @@
 class EventProvider {
 	constructor() {
-		this._eventRegistry = {};
+		this._eventRegistry = new Map();
 	}
 
 	attachEvent(eventName, fnFunction) {
 		const eventRegistry = this._eventRegistry;
-		let eventListeners = eventRegistry[eventName];
+		const eventListeners = eventRegistry.get(eventName);
 
 		if (!Array.isArray(eventListeners)) {
-			eventRegistry[eventName] = [];
-			eventListeners = eventRegistry[eventName];
+			eventRegistry.set(eventName, [fnFunction]);
+			return;
 		}
 
-		eventListeners.push({
-			"function": fnFunction,
-		});
+		if (!eventListeners.includes(fnFunction)) {
+			eventListeners.push(fnFunction);
+		}
 	}
 
 	detachEvent(eventName, fnFunction) {
 		const eventRegistry = this._eventRegistry;
-		let eventListeners = eventRegistry[eventName];
+		const eventListeners = eventRegistry.get(eventName);
 
 		if (!eventListeners) {
 			return;
 		}
+		const indexOfFnToDetach = eventListeners.indexOf(fnFunction);
 
-		eventListeners = eventListeners.filter(event => {
-			return event["function"] !== fnFunction; // eslint-disable-line
-		});
+		if (indexOfFnToDetach !== -1) {
+			eventListeners.splice(indexOfFnToDetach, 1);
+		}
 
 		if (eventListeners.length === 0) {
-			delete eventRegistry[eventName];
+			eventRegistry.delete(eventName);
 		}
 	}
 
@@ -43,14 +44,14 @@ class EventProvider {
 	 */
 	fireEvent(eventName, data) {
 		const eventRegistry = this._eventRegistry;
-		const eventListeners = eventRegistry[eventName];
+		const eventListeners = eventRegistry.get(eventName);
 
 		if (!eventListeners) {
 			return [];
 		}
 
-		return eventListeners.map(event => {
-			return event["function"].call(this, data); // eslint-disable-line
+		return eventListeners.map(fn => {
+			return fn.call(this, data); // eslint-disable-line
 		});
 	}
 
@@ -67,24 +68,17 @@ class EventProvider {
 
 	isHandlerAttached(eventName, fnFunction) {
 		const eventRegistry = this._eventRegistry;
-		const eventListeners = eventRegistry[eventName];
+		const eventListeners = eventRegistry.get(eventName);
 
 		if (!eventListeners) {
 			return false;
 		}
 
-		for (let i = 0; i < eventListeners.length; i++) {
-			const event = eventListeners[i];
-			if (event["function"] === fnFunction) { // eslint-disable-line
-				return true;
-			}
-		}
-
-		return false;
+		return eventListeners.includes(fnFunction);
 	}
 
 	hasListeners(eventName) {
-		return !!this._eventRegistry[eventName];
+		return !!this._eventRegistry.get(eventName);
 	}
 }
 

package/src/FeaturesRegistry.js

@@ -8,4 +8,7 @@ const getFeature = name => {
 	return features.get(name);
 };
 
-export { registerFeature, getFeature };
+export {
+	registerFeature,
+	getFeature,
+};

package/src/FontFace.js

@@ -1,95 +1,7 @@
-/**
- * CSS font face used for the texts provided by SAP.
- */
-import createStyleInHead from "./util/createStyleInHead.js";
+import { hasStyle, createStyle } from "./ManagedStyles.js";
 import { getFeature } from "./FeaturesRegistry.js";
-
-/* CDN Locations */
-const font72RegularWoff = `https://ui5.sap.com/sdk/resources/sap/ui/core/themes/sap_fiori_3/fonts/72-Regular.woff?ui5-webcomponents`;
-const font72RegularWoff2 = `https://ui5.sap.com/sdk/resources/sap/ui/core/themes/sap_fiori_3/fonts/72-Regular.woff2?ui5-webcomponents`;
-
-const font72RegularFullWoff = `https://ui5.sap.com/sdk/resources/sap/ui/core/themes/sap_fiori_3/fonts/72-Regular-full.woff?ui5-webcomponents`;
-const font72RegularFullWoff2 = `https://ui5.sap.com/sdk/resources/sap/ui/core/themes/sap_fiori_3/fonts/72-Regular-full.woff2?ui5-webcomponents`;
-
-const font72BoldWoff = `https://ui5.sap.com/sdk/resources/sap/ui/core/themes/sap_fiori_3/fonts/72-Bold.woff?ui5-webcomponents`;
-const font72BoldWoff2 = `https://ui5.sap.com/sdk/resources/sap/ui/core/themes/sap_fiori_3/fonts/72-Bold.woff2?ui5-webcomponents`;
-
-const font72BoldFullWoff = `https://ui5.sap.com/sdk/resources/sap/ui/core/themes/sap_fiori_3/fonts/72-Bold-full.woff?ui5-webcomponents`;
-const font72BoldFullWoff2 = `https://ui5.sap.com/sdk/resources/sap/ui/core/themes/sap_fiori_3/fonts/72-Bold-full.woff2?ui5-webcomponents`;
-
-const fontFaceCSS = `
-	@font-face {
-		font-family: "72";
-		font-style: normal;
-		font-weight: 400;
-		src: local("72"),
-			url(${font72RegularWoff2}) format("woff2"),
-			url(${font72RegularWoff}) format("woff");
-	}
-	
-	@font-face {
-		font-family: "72full";
-		font-style: normal;
-		font-weight: 400;
-		src: local('72-full'),
-			url(${font72RegularFullWoff2}) format("woff2"),
-			url(${font72RegularFullWoff}) format("woff");
-		
-	}
-	
-	@font-face {
-		font-family: "72";
-		font-style: normal;
-		font-weight: 700;
-		src: local('72-Bold'),
-			url(${font72BoldWoff2}) format("woff2"),
-			url(${font72BoldWoff}) format("woff");
-	}
-	
-	@font-face {
-		font-family: "72full";
-		font-style: normal;
-		font-weight: 700;
-		src: local('72-Bold-full'),
-			url(${font72BoldFullWoff2}) format("woff2"),
-			url(${font72BoldFullWoff}) format("woff");
-	}
-`;
-
-/**
- * Some diacritics are supported by the 72 font:
- *  * Grave
- *  * Acute
- *  * Circumflex
- *  * Tilde
- *
- * However, the following diacritics and the combination of multiple diacritics (including the supported ones) are not supported:
- *  * Breve
- *  * Horn
- *  * Dot below
- *  * Hook above
- *
- *
- * Override for the characters that aren't covered by the '72' font to other system fonts
- *
- * U+0102-0103: A and a with Breve
- * U+01A0-01A1: O and o with Horn
- * U+01AF-01B0: U and u with Horn
- * U+1EA0-1EB7: A and a with diacritics that are not supported by the font and combination of multiple diacritics
- * U+1EB8-1EC7: E and e with diacritics that are not supported by the font and combination of multiple diacritics
- * U+1EC8-1ECB: I and i with diacritics that are not supported by the font and combination of multiple diacritics
- * U+1ECC-1EE3: O and o with diacritics that are not supported by the font and combination of multiple diacritics
- * U+1EE4-1EF1: U and u with diacritics that are not supported by the font and combination of multiple diacritics
- * U+1EF4-1EF7: Y and y with diacritics that are not supported by the font and combination of multiple diacritics
- *
- */
-const overrideFontFaceCSS = `
-	@font-face {
-		font-family: '72override';
-		unicode-range: U+0102-0103, U+01A0-01A1, U+01AF-01B0, U+1EA0-1EB7, U+1EB8-1EC7, U+1EC8-1ECB, U+1ECC-1EE3, U+1EE4-1EF1, U+1EF4-1EF7;
-		src: local('Arial'), local('Helvetica'), local('sans-serif');
-	}
-`;
+import fontFaceCSS from "./generated/css/FontFace.css.js";
+import overrideFontFaceCSS from "./generated/css/OverrideFontFace.css.js";
 
 const insertFontFace = () => {
 	const OpenUI5Support = getFeature("OpenUI5Support");
@@ -104,14 +16,14 @@ const insertFontFace = () => {
 };
 
 const insertMainFontFace = () => {
-	if (!document.querySelector(`head>style[data-ui5-font-face]`)) {
-		createStyleInHead(fontFaceCSS, { "data-ui5-font-face": "" });
+	if (!hasStyle("data-ui5-font-face")) {
+		createStyle(fontFaceCSS, "data-ui5-font-face");
 	}
 };
 
 const insertOverrideFontFace = () => {
-	if (!document.querySelector(`head>style[data-ui5-font-face-override]`)) {
-		createStyleInHead(overrideFontFaceCSS, { "data-ui5-font-face-override": "" });
+	if (!hasStyle("data-ui5-font-face-override")) {
+		createStyle(overrideFontFaceCSS, "data-ui5-font-face-override");
 	}
 };
 

package/src/InitialConfiguration.js

@@ -13,7 +13,6 @@ let initialConfig = {
 	noConflict: false, // no URL
 	formatSettings: {},
 	fetchDefaultLanguage: false,
-	assetsPath: "",
 };
 
 /* General settings */
@@ -62,11 +61,6 @@ const getFormatSettings = () => {
 	return initialConfig.formatSettings;
 };
 
-const getAssetsPath = () => {
-	initConfiguration();
-	return initialConfig.assetsPath;
-};
-
 const booleanMapping = new Map();
 booleanMapping.set("true", true);
 booleanMapping.set("false", false);
@@ -92,23 +86,47 @@ const parseConfigurationScript = () => {
 const parseURLParameters = () => {
 	const params = new URLSearchParams(window.location.search);
 
+	// Process "sap-*" params first
 	params.forEach((value, key) => {
-		if (!key.startsWith("sap-ui")) {
+		const parts = key.split("sap-").length;
+		if (parts === 0 || parts === key.split("sap-ui-").length) {
 			return;
 		}
 
-		const lowerCaseValue = value.toLowerCase();
-
-		const param = key.split("sap-ui-")[1];
+		applyURLParam(key, value, "sap");
+	});
 
-		if (booleanMapping.has(value)) {
-			value = booleanMapping.get(lowerCaseValue);
+	// Process "sap-ui-*" params
+	params.forEach((value, key) => {
+		if (!key.startsWith("sap-ui")) {
+			return;
 		}
 
-		initialConfig[param] = value;
+		applyURLParam(key, value, "sap-ui");
 	});
 };
 
+const normalizeParamValue = (param, value) => {
+	if (param === "theme" && value.includes("@")) { // the theme parameter might have @<URL-TO-THEME> in the value - strip this
+		return value.split("@")[0];
+	}
+
+	return value;
+};
+
+const applyURLParam = (key, value, paramType) => {
+	const lowerCaseValue = value.toLowerCase();
+	const param = key.split(`${paramType}-`)[1];
+
+	if (booleanMapping.has(value)) {
+		value = booleanMapping.get(lowerCaseValue);
+	}
+
+	value = normalizeParamValue(param, value);
+
+	initialConfig[param] = value;
+};
+
 const applyOpenUI5Configuration = () => {
 	const OpenUI5Support = getFeature("OpenUI5Support");
 	if (!OpenUI5Support || !OpenUI5Support.isLoaded()) {
@@ -145,5 +163,4 @@ export {
 	getNoConflict,
 	getCalendarType,
 	getFormatSettings,
-	getAssetsPath,
 };