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

package/dist/Boot.js

@@ -1,59 +1,105 @@
 import whenDOMReady from "./util/whenDOMReady.js";
+import EventProvider from "./EventProvider.js";
 import insertFontFace from "./FontFace.js";
 import insertSystemCSSVars from "./SystemCSSVars.js";
-import { getTheme } from "./config/Theme.js";
+import insertScrollbarStyles from "./ScrollbarStyles.js";
+import { getTheme, getBaseTheme } from "./config/Theme.js";
 import applyTheme from "./theming/applyTheme.js";
 import { registerCurrentRuntime } from "./Runtimes.js";
 import { getFeature } from "./FeaturesRegistry.js";
-
+import { attachThemeRegistered } from "./theming/ThemeRegistered.js";
+import fixSafariActiveState from "./util/fixSafariActiveState.js";
+let booted = false;
 let bootPromise;
-
+let openUI5ListenersAttached = false;
+const eventProvider = new EventProvider();
+const isBooted = () => {
+    return booted;
+};
 /**
- * Attach a callback that will be executed on boot
+ * Attaches a callback that will be executed after boot finishes.
+ * **Note:** If the framework already booted, the callback will be immediately executed.
  * @public
- * @param listener
+ * @param { Function } listener
+ */
+const attachBoot = (listener) => {
+    if (!booted) {
+        eventProvider.attachEvent("boot", listener);
+        return;
+    }
+    listener();
+};
+/**
+ * This function may now be called twice - once without OpenUI5Support, and then later again, when OpenUI5 is loaded dynamically
+ * In this case, deregister the UI5 Web Components listener
  */
-const attachBoot = async listener => {
-	await boot();
-	listener();
+const initF6Navigation = async () => {
+    const openUI5Support = getFeature("OpenUI5Support");
+    const isOpenUI5Loaded = openUI5Support ? openUI5Support.isOpenUI5Detected() : false;
+    const f6Navigation = getFeature("F6Navigation");
+    if (openUI5Support) {
+        f6Navigation && f6Navigation.destroy(); // F6Navigation is not needed when OpenUI5 is used
+        await openUI5Support.init();
+    }
+    if (f6Navigation && !isOpenUI5Loaded) {
+        f6Navigation.init();
+    }
+};
+const attachOpenUI5SupportListeners = () => {
+    if (openUI5ListenersAttached) {
+        return;
+    }
+    const openUI5Support = getFeature("OpenUI5Support");
+    if (openUI5Support) {
+        openUI5ListenersAttached = openUI5Support.attachListeners(); // listeners will be attached (return true) only if OpenUI5 is loaded
+    }
 };
-
 const boot = async () => {
-	if (bootPromise) {
-		return bootPromise;
-	}
-
-	/* 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();
-
-		resolve();
-	});
-	/* eslint-enable no-alert, no-async-promise-executor */
-
-	return bootPromise;
+    if (bootPromise !== undefined) {
+        return bootPromise;
+    }
+    const bootExecutor = async (resolve) => {
+        registerCurrentRuntime();
+        if (typeof document === "undefined") {
+            resolve();
+            return;
+        }
+        attachThemeRegistered(onThemeRegistered);
+        await initF6Navigation(); // depends on OpenUI5Support
+        await whenDOMReady();
+        await applyTheme(getTheme());
+        attachOpenUI5SupportListeners(); // depends on OpenUI5Support
+        insertFontFace();
+        insertSystemCSSVars();
+        insertScrollbarStyles();
+        fixSafariActiveState();
+        resolve();
+        booted = true;
+        eventProvider.fireEvent("boot");
+    };
+    bootPromise = new Promise(bootExecutor);
+    return bootPromise;
+};
+const secondaryBoot = async () => {
+    await boot(); // make sure we're not in the middle of boot before re-running the skipped parts
+    await initF6Navigation();
+    attachOpenUI5SupportListeners();
 };
-
-export {
-	boot,
-	attachBoot,
+/**
+ * Callback, executed after theme properties registration
+ * to apply the newly registered theme.
+ * @private
+ * @param { string } theme
+ */
+const onThemeRegistered = (theme) => {
+    if (!booted) {
+        return;
+    }
+    const currentTheme = getTheme();
+    const currentBaseTheme = getBaseTheme();
+    if (theme === currentTheme || theme === currentBaseTheme) {
+        applyTheme(currentTheme);
+    }
 };
+export { boot, secondaryBoot, attachBoot, isBooted, };
+//# sourceMappingURL=Boot.js.map

package/dist/Boot.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Boot.js","sourceRoot":"","sources":["../src/Boot.ts"],"names":[],"mappings":"AAAA,OAAO,YAAY,MAAM,wBAAwB,CAAC;AAClD,OAAO,aAAa,MAAM,oBAAoB,CAAC;AAC/C,OAAO,cAAc,MAAM,eAAe,CAAC;AAC3C,OAAO,mBAAmB,MAAM,oBAAoB,CAAC;AACrD,OAAO,qBAAqB,MAAM,sBAAsB,CAAC;AACzD,OAAO,EAAE,QAAQ,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAC;AAC3D,OAAO,UAAU,MAAM,yBAAyB,CAAC;AACjD,OAAO,EAAE,sBAAsB,EAAE,MAAM,eAAe,CAAC;AACvD,OAAO,EAAE,UAAU,EAAE,MAAM,uBAAuB,CAAC;AAInD,OAAO,EAAE,qBAAqB,EAAE,MAAM,8BAA8B,CAAC;AACrE,OAAO,oBAAoB,MAAM,gCAAgC,CAAC;AAElE,IAAI,MAAM,GAAG,KAAK,CAAC;AACnB,IAAI,WAA0B,CAAC;AAC/B,IAAI,wBAAwB,GAAG,KAAK,CAAC;AACrC,MAAM,aAAa,GAAG,IAAI,aAAa,EAAc,CAAC;AAEtD,MAAM,QAAQ,GAAG,GAAY,EAAE;IAC9B,OAAO,MAAM,CAAC;AACf,CAAC,CAAC;AAEF;;;;;GAKG;AACH,MAAM,UAAU,GAAG,CAAC,QAAoB,EAAE,EAAE;IAC3C,IAAI,CAAC,MAAM,EAAE,CAAC;QACb,aAAa,CAAC,WAAW,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAC;QAC5C,OAAO;IACR,CAAC;IAED,QAAQ,EAAE,CAAC;AACZ,CAAC,CAAC;AAEF;;;GAGG;AACH,MAAM,gBAAgB,GAAG,KAAK,IAAI,EAAE;IACnC,MAAM,cAAc,GAAG,UAAU,CAAwB,gBAAgB,CAAC,CAAC;IAC3E,MAAM,eAAe,GAAG,cAAc,CAAC,CAAC,CAAC,cAAc,CAAC,iBAAiB,EAAE,CAAC,CAAC,CAAC,KAAK,CAAC;IACpF,MAAM,YAAY,GAAG,UAAU,CAAsB,cAAc,CAAC,CAAC;IAErE,IAAI,cAAc,EAAE,CAAC;QACpB,YAAY,IAAI,YAAY,CAAC,OAAO,EAAE,CAAC,CAAC,kDAAkD;QAC1F,MAAM,cAAc,CAAC,IAAI,EAAE,CAAC;IAC7B,CAAC;IAED,IAAI,YAAY,IAAI,CAAC,eAAe,EAAE,CAAC;QACtC,YAAY,CAAC,IAAI,EAAE,CAAC;IACrB,CAAC;AACF,CAAC,CAAC;AAEF,MAAM,6BAA6B,GAAG,GAAG,EAAE;IAC1C,IAAI,wBAAwB,EAAE,CAAC;QAC9B,OAAO;IACR,CAAC;IAED,MAAM,cAAc,GAAG,UAAU,CAAwB,gBAAgB,CAAC,CAAC;IAC3E,IAAI,cAAc,EAAE,CAAC;QACpB,wBAAwB,GAAG,cAAc,CAAC,eAAe,EAAE,CAAC,CAAC,qEAAqE;IACnI,CAAC;AACF,CAAC,CAAC;AAEF,MAAM,IAAI,GAAG,KAAK,IAAmB,EAAE;IACtC,IAAI,WAAW,KAAK,SAAS,EAAE,CAAC;QAC/B,OAAO,WAAW,CAAC;IACpB,CAAC;IAED,MAAM,YAAY,GAAG,KAAK,EAAE,OAAuB,EAAE,EAAE;QACtD,sBAAsB,EAAE,CAAC;QAEzB,IAAI,OAAO,QAAQ,KAAK,WAAW,EAAE,CAAC;YACrC,OAAO,EAAE,CAAC;YACV,OAAO;QACR,CAAC;QAED,qBAAqB,CAAC,iBAAiB,CAAC,CAAC;QAEzC,MAAM,gBAAgB,EAAE,CAAC,CAAC,4BAA4B;QACtD,MAAM,YAAY,EAAE,CAAC;QACrB,MAAM,UAAU,CAAC,QAAQ,EAAE,CAAC,CAAC;QAC7B,6BAA6B,EAAE,CAAC,CAAC,4BAA4B;QAC7D,cAAc,EAAE,CAAC;QACjB,mBAAmB,EAAE,CAAC;QACtB,qBAAqB,EAAE,CAAC;QACxB,oBAAoB,EAAE,CAAC;QAEvB,OAAO,EAAE,CAAC;QAEV,MAAM,GAAG,IAAI,CAAC;QACd,aAAa,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC;IACjC,CAAC,CAAC;IAEF,WAAW,GAAG,IAAI,OAAO,CAAC,YAAiD,CAAC,CAAC;IAC7E,OAAO,WAAW,CAAC;AACpB,CAAC,CAAC;AAEF,MAAM,aAAa,GAAG,KAAK,IAAmB,EAAE;IAC/C,MAAM,IAAI,EAAE,CAAC,CAAC,gFAAgF;IAC9F,MAAM,gBAAgB,EAAE,CAAC;IACzB,6BAA6B,EAAE,CAAC;AACjC,CAAC,CAAC;AAEF;;;;;GAKG;AACH,MAAM,iBAAiB,GAAG,CAAC,KAAa,EAAE,EAAE;IAC3C,IAAI,CAAC,MAAM,EAAE,CAAC;QACb,OAAO;IACR,CAAC;IAED,MAAM,YAAY,GAAG,QAAQ,EAAE,CAAC;IAChC,MAAM,gBAAgB,GAAG,YAAY,EAAE,CAAC;IAExC,IAAI,KAAK,KAAK,YAAY,IAAI,KAAK,KAAK,gBAAgB,EAAE,CAAC;QAC1D,UAAU,CAAC,YAAY,CAAC,CAAC;IAC1B,CAAC;AACF,CAAC,CAAC;AAEF,OAAO,EACN,IAAI,EACJ,aAAa,EACb,UAAU,EACV,QAAQ,GACR,CAAC","sourcesContent":["import whenDOMReady from \"./util/whenDOMReady.js\";\nimport EventProvider from \"./EventProvider.js\";\nimport insertFontFace from \"./FontFace.js\";\nimport insertSystemCSSVars from \"./SystemCSSVars.js\";\nimport insertScrollbarStyles from \"./ScrollbarStyles.js\";\nimport { getTheme, getBaseTheme } from \"./config/Theme.js\";\nimport applyTheme from \"./theming/applyTheme.js\";\nimport { registerCurrentRuntime } from \"./Runtimes.js\";\nimport { getFeature } from \"./FeaturesRegistry.js\";\nimport type OpenUI5Support from \"./features/OpenUI5Support.js\";\nimport type F6Navigation from \"./features/F6Navigation.js\";\nimport type { PromiseResolve } from \"./types.js\";\nimport { attachThemeRegistered } from \"./theming/ThemeRegistered.js\";\nimport fixSafariActiveState from \"./util/fixSafariActiveState.js\";\n\nlet booted = false;\nlet bootPromise: Promise<void>;\nlet openUI5ListenersAttached = false;\nconst eventProvider = new EventProvider<void, void>();\n\nconst isBooted = (): boolean => {\n\treturn booted;\n};\n\n/**\n * Attaches a callback that will be executed after boot finishes.\n * **Note:** If the framework already booted, the callback will be immediately executed.\n * @public\n * @param { Function } listener\n */\nconst attachBoot = (listener: () => void) => {\n\tif (!booted) {\n\t\teventProvider.attachEvent(\"boot\", listener);\n\t\treturn;\n\t}\n\n\tlistener();\n};\n\n/**\n * This function may now be called twice - once without OpenUI5Support, and then later again, when OpenUI5 is loaded dynamically\n * In this case, deregister the UI5 Web Components listener\n */\nconst initF6Navigation = async () => {\n\tconst openUI5Support = getFeature<typeof OpenUI5Support>(\"OpenUI5Support\");\n\tconst isOpenUI5Loaded = openUI5Support ? openUI5Support.isOpenUI5Detected() : false;\n\tconst f6Navigation = getFeature<typeof F6Navigation>(\"F6Navigation\");\n\n\tif (openUI5Support) {\n\t\tf6Navigation && f6Navigation.destroy(); // F6Navigation is not needed when OpenUI5 is used\n\t\tawait openUI5Support.init();\n\t}\n\n\tif (f6Navigation && !isOpenUI5Loaded) {\n\t\tf6Navigation.init();\n\t}\n};\n\nconst attachOpenUI5SupportListeners = () => {\n\tif (openUI5ListenersAttached) {\n\t\treturn;\n\t}\n\n\tconst openUI5Support = getFeature<typeof OpenUI5Support>(\"OpenUI5Support\");\n\tif (openUI5Support) {\n\t\topenUI5ListenersAttached = openUI5Support.attachListeners(); // listeners will be attached (return true) only if OpenUI5 is loaded\n\t}\n};\n\nconst boot = async (): Promise<void> => {\n\tif (bootPromise !== undefined) {\n\t\treturn bootPromise;\n\t}\n\n\tconst bootExecutor = async (resolve: PromiseResolve) => {\n\t\tregisterCurrentRuntime();\n\n\t\tif (typeof document === \"undefined\") {\n\t\t\tresolve();\n\t\t\treturn;\n\t\t}\n\n\t\tattachThemeRegistered(onThemeRegistered);\n\n\t\tawait initF6Navigation(); // depends on OpenUI5Support\n\t\tawait whenDOMReady();\n\t\tawait applyTheme(getTheme());\n\t\tattachOpenUI5SupportListeners(); // depends on OpenUI5Support\n\t\tinsertFontFace();\n\t\tinsertSystemCSSVars();\n\t\tinsertScrollbarStyles();\n\t\tfixSafariActiveState();\n\n\t\tresolve();\n\n\t\tbooted = true;\n\t\teventProvider.fireEvent(\"boot\");\n\t};\n\n\tbootPromise = new Promise(bootExecutor as (resolve: PromiseResolve) => void);\n\treturn bootPromise;\n};\n\nconst secondaryBoot = async (): Promise<void> => {\n\tawait boot(); // make sure we're not in the middle of boot before re-running the skipped parts\n\tawait initF6Navigation();\n\tattachOpenUI5SupportListeners();\n};\n\n/**\n * Callback, executed after theme properties registration\n * to apply the newly registered theme.\n * @private\n * @param { string } theme\n */\nconst onThemeRegistered = (theme: string) => {\n\tif (!booted) {\n\t\treturn;\n\t}\n\n\tconst currentTheme = getTheme();\n\tconst currentBaseTheme = getBaseTheme();\n\n\tif (theme === currentTheme || theme === currentBaseTheme) {\n\t\tapplyTheme(currentTheme);\n\t}\n};\n\nexport {\n\tboot,\n\tsecondaryBoot,\n\tattachBoot,\n\tisBooted,\n};\n"]}

package/dist/CustomElementsRegistry.d.ts

@@ -0,0 +1,6 @@
+declare const registerTag: (tag: string) => void;
+declare const isTagRegistered: (tag: string) => boolean;
+declare const hasRegisteredTags: () => boolean;
+declare const getAllRegisteredTags: () => string[];
+declare const recordTagRegistrationFailure: (tag: string) => void;
+export { registerTag, isTagRegistered, hasRegisteredTags, getAllRegisteredTags, recordTagRegistrationFailure, };

package/dist/CustomElementsRegistry.js

@@ -1,95 +1,81 @@
-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();
-let Failures = {};
+let Failures = new Map();
 let failureTimeout;
-
-const UNKNOWN_RUNTIME = "unknown";
-
-const registerTag = tag => {
-	Definitions.add(tag);
-	Tags.set(tag, getCurrentRuntimeIndex());
+const UNKNOWN_RUNTIME = -1;
+const registerTag = (tag) => {
+    Definitions.add(tag);
+    Tags.set(tag, getCurrentRuntimeIndex());
 };
-
-const isTagRegistered = tag => {
-	return Definitions.has(tag);
+const isTagRegistered = (tag) => {
+    return Definitions.has(tag);
+};
+const hasRegisteredTags = () => {
+    return Definitions.size > 0;
 };
-
 const getAllRegisteredTags = () => {
-	return setToArray(Definitions);
+    return [...Definitions.values()];
 };
-
-const recordTagRegistrationFailure = 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 recordTagRegistrationFailure = (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
+    }
+    if (!Failures.has(tagRegRuntimeIndex)) {
+        Failures.set(tagRegRuntimeIndex, new Set());
+    }
+    Failures.get(tagRegRuntimeIndex).add(tag);
+    if (!failureTimeout) {
+        failureTimeout = setTimeout(() => {
+            displayFailedRegistrations();
+            Failures = new Map();
+            failureTimeout = undefined;
+        }, 1000);
+    }
 };
-
 const displayFailedRegistrations = () => {
-	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 {
-	registerTag,
-	isTagRegistered,
-	getAllRegisteredTags,
-	recordTagRegistrationFailure,
+    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("")}`;
+    }
+    [...Failures.keys()].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.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!`;
+        }
+        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/UI5/webcomponents/blob/main/docs/2-advanced/06-scoping.md.`;
+    console.warn(message); // eslint-disable-line
 };
+export { registerTag, isTagRegistered, hasRegisteredTags, getAllRegisteredTags, recordTagRegistrationFailure, };
+//# sourceMappingURL=CustomElementsRegistry.js.map

package/dist/CustomElementsRegistry.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"CustomElementsRegistry.js","sourceRoot":"","sources":["../src/CustomElementsRegistry.ts"],"names":[],"mappings":"AAAA,OAAO,iBAAiB,MAAM,wBAAwB,CAAC;AACvD,OAAO,EAAE,sBAAsB,EAAE,eAAe,EAAE,cAAc,EAAE,MAAM,eAAe,CAAC;AAGxF,MAAM,IAAI,GAAG,iBAAiB,CAAsB,MAAM,EAAE,IAAI,GAAG,EAAE,CAAC,CAAC;AACvE,MAAM,WAAW,GAAG,IAAI,GAAG,EAAU,CAAC;AAEtC,IAAI,QAAQ,GAAG,IAAI,GAAG,EAAuB,CAAC;AAC9C,IAAI,cAAmC,CAAC;AAExC,MAAM,eAAe,GAAG,CAAC,CAAC,CAAC;AAE3B,MAAM,WAAW,GAAG,CAAC,GAAW,EAAE,EAAE;IACnC,WAAW,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;IACrB,IAAI,CAAC,GAAG,CAAC,GAAG,EAAE,sBAAsB,EAAE,CAAC,CAAC;AACzC,CAAC,CAAC;AAEF,MAAM,eAAe,GAAG,CAAC,GAAW,EAAE,EAAE;IACvC,OAAO,WAAW,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;AAC7B,CAAC,CAAC;AAEF,MAAM,iBAAiB,GAAG,GAAG,EAAE;IAC9B,OAAO,WAAW,CAAC,IAAI,GAAG,CAAC,CAAC;AAC7B,CAAC,CAAC;AAEF,MAAM,oBAAoB,GAAG,GAAG,EAAE;IACjC,OAAO,CAAC,GAAG,WAAW,CAAC,MAAM,EAAE,CAAC,CAAC;AAClC,CAAC,CAAC;AAEF,MAAM,4BAA4B,GAAG,CAAC,GAAW,EAAE,EAAE;IACpD,IAAI,kBAAkB,GAAG,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;IACvC,IAAI,kBAAkB,KAAK,SAAS,EAAE,CAAC;QACtC,kBAAkB,GAAG,eAAe,CAAC,CAAC,mHAAmH;IAC1J,CAAC;IAED,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,kBAAkB,CAAC,EAAE,CAAC;QACvC,QAAQ,CAAC,GAAG,CAAC,kBAAkB,EAAE,IAAI,GAAG,EAAE,CAAC,CAAC;IAC7C,CAAC;IACD,QAAQ,CAAC,GAAG,CAAC,kBAAkB,CAAE,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;IAE3C,IAAI,CAAC,cAAc,EAAE,CAAC;QACrB,cAAc,GAAG,UAAU,CAAC,GAAG,EAAE;YAChC,0BAA0B,EAAE,CAAC;YAC7B,QAAQ,GAAG,IAAI,GAAG,EAAE,CAAC;YACrB,cAAc,GAAG,SAAS,CAAC;QAC5B,CAAC,EAAE,IAAI,CAAC,CAAC;IACV,CAAC;AACF,CAAC,CAAC;AAEF,MAAM,0BAA0B,GAAG,GAAG,EAAE;IACvC,MAAM,WAAW,GAAG,cAAc,EAAE,CAAC;IACrC,MAAM,mBAAmB,GAAG,sBAAsB,EAAE,CAAC;IACrD,MAAM,cAAc,GAAG,WAAW,CAAC,mBAAmB,CAAC,CAAC;IAExD,IAAI,OAAO,GAAG,iDAAiD,CAAC;IAEhE,IAAI,WAAW,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QAC5B,OAAO,GAAG,GAAG,OAAO,uDAAuD,WAAW,CAAC,GAAG,CAAC,OAAO,CAAC,EAAE,CAAC,KAAK,OAAO,CAAC,WAAW,EAAE,CAAC,CAAC,IAAI,CAAC,EAAE,CAAC,EAAE,CAAC;IAC9I,CAAC;IAED,CAAC,GAAG,QAAQ,CAAC,IAAI,EAAE,CAAC,CAAC,OAAO,CAAC,iBAAiB,CAAC,EAAE;QAChD,IAAI,UAAkB,CAAC;QACvB,IAAI,YAAY,CAAC;QAEjB,IAAI,iBAAiB,KAAK,eAAe,EAAE,CAAC,CAAC,kCAAkC;YAC9E,UAAU,GAAG,CAAC,CAAC,CAAC,0CAA0C;YAC1D,YAAY,GAAG;gBACd,WAAW,EAAE,uBAAuB;aACpC,CAAC;QACH,CAAC;aAAM,CAAC;YACP,UAAU,GAAG,eAAe,CAAC,mBAAmB,EAAE,iBAAiB,CAAC,CAAC;YACrE,YAAY,GAAG,WAAW,CAAC,iBAAiB,CAAC,CAAC;QAC/C,CAAC;QAED,IAAI,WAAW,CAAC;QAChB,IAAI,UAAU,GAAG,CAAC,EAAE,CAAC;YACpB,WAAW,GAAG,UAAU,CAAC;QAC1B,CAAC;aAAM,IAAI,UAAU,GAAG,CAAC,EAAE,CAAC;YAC3B,WAAW,GAAG,SAAS,CAAC;QACzB,CAAC;aAAM,CAAC;YACP,WAAW,GAAG,UAAU,CAAC;QAC1B,CAAC;QACD,OAAO,GAAG,GAAG,OAAO,QAAQ,cAAc,CAAC,WAAW,sBAAsB,QAAQ,CAAC,GAAG,CAAC,iBAAiB,CAAE,CAAC,IAAI,gDAAgD,WAAW,aAAa,YAAY,CAAC,WAAW,MAAM,CAAC,CAAC,GAAG,QAAQ,CAAC,GAAG,CAAC,iBAAiB,CAAE,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC;QAEpR,IAAI,UAAU,GAAG,CAAC,EAAE,CAAC;YACpB,OAAO,GAAG,GAAG,OAAO,qFAAqF,YAAY,CAAC,WAAW,kCAAkC,CAAC;QACrK,CAAC;aAAM,CAAC;YACP,OAAO,GAAG,GAAG,OAAO,+HAA+H,CAAC;QACrJ,CAAC;IACF,CAAC,CAAC,CAAC;IAEH,OAAO,GAAG,GAAG,OAAO,gNAAgN,CAAC;IAErO,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,sBAAsB;AAC9C,CAAC,CAAC;AAEF,OAAO,EACN,WAAW,EACX,eAAe,EACf,iBAAiB,EACjB,oBAAoB,EACpB,4BAA4B,GAC5B,CAAC","sourcesContent":["import getSharedResource from \"./getSharedResource.js\";\nimport { getCurrentRuntimeIndex, compareRuntimes, getAllRuntimes } from \"./Runtimes.js\";\nimport type { Timeout } from \"./types.js\";\n\nconst Tags = getSharedResource<Map<string, number>>(\"Tags\", new Map());\nconst Definitions = new Set<string>();\n\nlet Failures = new Map<number, Set<string>>();\nlet failureTimeout: Timeout | undefined;\n\nconst UNKNOWN_RUNTIME = -1;\n\nconst registerTag = (tag: string) => {\n\tDefinitions.add(tag);\n\tTags.set(tag, getCurrentRuntimeIndex());\n};\n\nconst isTagRegistered = (tag: string) => {\n\treturn Definitions.has(tag);\n};\n\nconst hasRegisteredTags = () => {\n\treturn Definitions.size > 0;\n};\n\nconst getAllRegisteredTags = () => {\n\treturn [...Definitions.values()];\n};\n\nconst recordTagRegistrationFailure = (tag: string) => {\n\tlet tagRegRuntimeIndex = Tags.get(tag);\n\tif (tagRegRuntimeIndex === undefined) {\n\t\ttagRegRuntimeIndex = 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\n\t}\n\n\tif (!Failures.has(tagRegRuntimeIndex)) {\n\t\tFailures.set(tagRegRuntimeIndex, new Set());\n\t}\n\tFailures.get(tagRegRuntimeIndex)!.add(tag);\n\n\tif (!failureTimeout) {\n\t\tfailureTimeout = setTimeout(() => {\n\t\t\tdisplayFailedRegistrations();\n\t\t\tFailures = new Map();\n\t\t\tfailureTimeout = undefined;\n\t\t}, 1000);\n\t}\n};\n\nconst displayFailedRegistrations = () => {\n\tconst allRuntimes = getAllRuntimes();\n\tconst currentRuntimeIndex = getCurrentRuntimeIndex();\n\tconst currentRuntime = allRuntimes[currentRuntimeIndex];\n\n\tlet message = `Multiple UI5 Web Components instances detected.`;\n\n\tif (allRuntimes.length > 1) {\n\t\tmessage = `${message}\\nLoading order (versions before 1.1.0 not listed): ${allRuntimes.map(runtime => `\\n${runtime.description}`).join(\"\")}`;\n\t}\n\n\t[...Failures.keys()].forEach(otherRuntimeIndex => {\n\t\tlet comparison: number;\n\t\tlet otherRuntime;\n\n\t\tif (otherRuntimeIndex === UNKNOWN_RUNTIME) { // version < 1.1.0 defined the tag\n\t\t\tcomparison = 1; // the current runtime is considered newer\n\t\t\totherRuntime = {\n\t\t\t\tdescription: `Older unknown runtime`,\n\t\t\t};\n\t\t} else {\n\t\t\tcomparison = compareRuntimes(currentRuntimeIndex, otherRuntimeIndex);\n\t\t\totherRuntime = allRuntimes[otherRuntimeIndex];\n\t\t}\n\n\t\tlet compareWord;\n\t\tif (comparison > 0) {\n\t\t\tcompareWord = \"an older\";\n\t\t} else if (comparison < 0) {\n\t\t\tcompareWord = \"a newer\";\n\t\t} else {\n\t\t\tcompareWord = \"the same\";\n\t\t}\n\t\tmessage = `${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(\", \")}.`;\n\n\t\tif (comparison > 0) {\n\t\t\tmessage = `${message}\\nWARNING! If your code uses features of the above web components, unavailable in ${otherRuntime.description}, it might not work as expected!`;\n\t\t} else {\n\t\t\tmessage = `${message}\\nSince the above web components were defined by the same or newer version runtime, they should be compatible with your code.`;\n\t\t}\n\t});\n\n\tmessage = `${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/UI5/webcomponents/blob/main/docs/2-advanced/06-scoping.md.`;\n\n\tconsole.warn(message); // eslint-disable-line\n};\n\nexport {\n\tregisterTag,\n\tisTagRegistered,\n\thasRegisteredTags,\n\tgetAllRegisteredTags,\n\trecordTagRegistrationFailure,\n};\n"]}

package/dist/CustomElementsScope.d.ts

@@ -0,0 +1,7 @@
+import { setCustomElementsScopingSuffix, getCustomElementsScopingSuffix, setCustomElementsScopingRules, getCustomElementsScopingRules, shouldScopeCustomElement, getEffectiveScopingSuffixForTag, getScopedVarName } from "./CustomElementsScopeUtils.js";
+declare class LitStatic {
+    static html: (strings: TemplateStringsArray, ...values: unknown[]) => import("lit-html").TemplateResult;
+    static svg: (strings: TemplateStringsArray, ...values: unknown[]) => import("lit-html").TemplateResult;
+    static unsafeStatic: (value: string) => object;
+}
+export { LitStatic, setCustomElementsScopingSuffix, getCustomElementsScopingSuffix, setCustomElementsScopingRules, getCustomElementsScopingRules, shouldScopeCustomElement, getEffectiveScopingSuffixForTag, getScopedVarName, };

package/dist/CustomElementsScope.js

@@ -1,108 +1,11 @@
-let suf;
-let rulesObj = {
-	include: [/^ui5-/],
-	exclude: [],
-};
-const tagsCache = new Map(); // 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".
- * Note: by default all tags starting with "ui5-" will be scoped, unless you change this by calling "setCustomElementsScopingRules"
- *
- * @public
- * @param suffix The scoping suffix
- */
-const setCustomElementsScopingSuffix = suffix => {
-	if (!suffix.match(/^[a-zA-Z0-9_-]+$/)) {
-		throw new Error("Only alphanumeric characters and dashes allowed for the scoping suffix");
-	}
-
-	suf = suffix;
-};
-
-/**
- * Returns the currently set scoping suffix, or undefined if not set.
- *
- * @public
- * @returns {String|undefined}
- */
-const getCustomElementsScopingSuffix = () => {
-	return suf;
-};
-
-/**
- * Sets the rules, governing which custom element tags to scope and which not, f.e.
- * setCustomElementsScopingRules({include: [/^ui5-/]}, exclude: [/^ui5-mylib-/, /^ui5-carousel$/]);
- * will scope all elements starting with "ui5-" but not the ones starting with "ui5-mylib-" and not "ui5-carousel".
- *
- * @public
- * @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 => {
-	if (!rules || !rules.include) {
-		throw new Error(`"rules" must be an object with at least an "include" property`);
-	}
-
-	if (!Array.isArray(rules.include) || rules.include.some(rule => !(rule instanceof RegExp))) {
-		throw new Error(`"rules.include" must be an array of regular expressions`);
-	}
-
-	if (rules.exclude && (!Array.isArray(rules.exclude) || rules.exclude.some(rule => !(rule instanceof RegExp)))) {
-		throw new Error(`"rules.exclude" must be an array of regular expressions`);
-	}
-
-	rules.exclude = rules.exclude || [];
-	rulesObj = rules;
-	tagsCache.clear(); // reset the cache upon setting new rules
-};
-
-/**
- * Returns the rules, governing which custom element tags to scope and which not. By default, all elements
- * starting with "ui5-" are scoped. The default rules are: {include: [/^ui5-/]}.
- *
- * @public
- * @returns {Object}
- */
-const getCustomElementsScopingRules = () => {
-	return rulesObj;
-};
-
-/**
- * Determines whether custom elements with the given tag should be scoped or not.
- * The tag is first matched against the "include" rules and then against the "exclude" rules and the
- * result is cached until new rules are set.
- *
- * @public
- * @param tag
- */
-const shouldScopeCustomElement = tag => {
-	if (!tagsCache.has(tag)) {
-		const result = rulesObj.include.some(rule => tag.match(rule)) && !rulesObj.exclude.some(rule => tag.match(rule));
-		tagsCache.set(tag, result);
-	}
-
-	return tagsCache.get(tag);
-};
-
-/**
- * Returns the currently set scoping suffix, if any and if the tag should be scoped, or undefined otherwise.
- *
- * @public
- * @param tag
- * @returns {String}
- */
-const getEffectiveScopingSuffixForTag = tag => {
-	if (shouldScopeCustomElement(tag)) {
-		return getCustomElementsScopingSuffix();
-	}
-};
-
-export {
-	setCustomElementsScopingSuffix,
-	getCustomElementsScopingSuffix,
-	setCustomElementsScopingRules,
-	getCustomElementsScopingRules,
-	shouldScopeCustomElement,
-	getEffectiveScopingSuffixForTag,
-};
+import { html, svg, unsafeStatic, } from "lit-html/static.js";
+import { setCustomElementsScopingSuffix, getCustomElementsScopingSuffix, setCustomElementsScopingRules, getCustomElementsScopingRules, shouldScopeCustomElement, getEffectiveScopingSuffixForTag, getScopedVarName, } from "./CustomElementsScopeUtils.js";
+import { registerFeature } from "./FeaturesRegistry.js";
+class LitStatic {
+}
+LitStatic.html = html;
+LitStatic.svg = svg;
+LitStatic.unsafeStatic = unsafeStatic;
+registerFeature("LitStatic", LitStatic);
+export { LitStatic, setCustomElementsScopingSuffix, getCustomElementsScopingSuffix, setCustomElementsScopingRules, getCustomElementsScopingRules, shouldScopeCustomElement, getEffectiveScopingSuffixForTag, getScopedVarName, };
+//# sourceMappingURL=CustomElementsScope.js.map

package/dist/CustomElementsScope.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"CustomElementsScope.js","sourceRoot":"","sources":["../src/CustomElementsScope.ts"],"names":[],"mappings":"AAAA,OAAO,EACN,IAAI,EACJ,GAAG,EACH,YAAY,GACZ,MAAM,oBAAoB,CAAC;AAE5B,OAAO,EACN,8BAA8B,EAC9B,8BAA8B,EAC9B,6BAA6B,EAC7B,6BAA6B,EAC7B,wBAAwB,EACxB,+BAA+B,EAC/B,gBAAgB,GAChB,MAAM,+BAA+B,CAAC;AACvC,OAAO,EAAE,eAAe,EAAE,MAAM,uBAAuB,CAAC;AAExD,MAAM,SAAS;;AACP,cAAI,GAAG,IAAI,CAAC;AACZ,aAAG,GAAG,GAAG,CAAC;AACV,sBAAY,GAA8B,YAAY,CAAC;AAG/D,eAAe,CAAC,WAAW,EAAE,SAAS,CAAC,CAAC;AAExC,OAAO,EACN,SAAS,EACT,8BAA8B,EAC9B,8BAA8B,EAC9B,6BAA6B,EAC7B,6BAA6B,EAC7B,wBAAwB,EACxB,+BAA+B,EAC/B,gBAAgB,GAChB,CAAC","sourcesContent":["import {\n\thtml,\n\tsvg,\n\tunsafeStatic,\n} from \"lit-html/static.js\";\n\nimport {\n\tsetCustomElementsScopingSuffix,\n\tgetCustomElementsScopingSuffix,\n\tsetCustomElementsScopingRules,\n\tgetCustomElementsScopingRules,\n\tshouldScopeCustomElement,\n\tgetEffectiveScopingSuffixForTag,\n\tgetScopedVarName,\n} from \"./CustomElementsScopeUtils.js\";\nimport { registerFeature } from \"./FeaturesRegistry.js\";\n\nclass LitStatic {\n\tstatic html = html;\n\tstatic svg = svg;\n\tstatic unsafeStatic: (value: string) => object = unsafeStatic;\n}\n\nregisterFeature(\"LitStatic\", LitStatic);\n\nexport {\n\tLitStatic,\n\tsetCustomElementsScopingSuffix,\n\tgetCustomElementsScopingSuffix,\n\tsetCustomElementsScopingRules,\n\tgetCustomElementsScopingRules,\n\tshouldScopeCustomElement,\n\tgetEffectiveScopingSuffixForTag,\n\tgetScopedVarName,\n};\n"]}

package/dist/CustomElementsScopeUtils.d.ts

@@ -0,0 +1,71 @@
+type Rules = {
+    include: Array<RegExp>;
+    exclude: Array<RegExp>;
+};
+/**
+ * Sets the suffix to be used for custom elements scoping, f.e. pass "demo" to get tags such as "ui5-button-demo".
+ *
+ * **Note:** By default all tags starting with "ui5-" will be scoped, unless you change this by calling "setCustomElementsScopingRules"
+ * **Note:** Setting the scoping suffix must be done before importing any components.
+ *
+ * @public
+ * @param suffix The scoping suffix
+ */
+declare const setCustomElementsScopingSuffix: (suffix: string) => void;
+/**
+ * Returns the currently set scoping suffix, or undefined if not set.
+ *
+ * @public
+ * @returns {String|undefined}
+ */
+declare const getCustomElementsScopingSuffix: () => string | undefined;
+/**
+ * Sets the rules, governing which custom element tags to scope and which not, f.e.
+ * setCustomElementsScopingRules({include: [/^ui5-/]}, exclude: [/^ui5-mylib-/, /^ui5-carousel$/]);
+ * will scope all elements starting with "ui5-" but not the ones starting with "ui5-mylib-" and not "ui5-carousel".
+ *
+ * @public
+ * @param rules Object with "include" and "exclude" properties, both arrays of regular expressions. Note that "include"
+ * rules are applied first and "exclude" rules second.
+ */
+declare const setCustomElementsScopingRules: (rules: Rules) => void;
+/**
+ * Returns the rules, governing which custom element tags to scope and which not. By default, all elements
+ * starting with "ui5-" are scoped. The default rules are: {include: [/^ui5-/]}.
+ *
+ * @public
+ * @returns {Object}
+ */
+declare const getCustomElementsScopingRules: () => Rules;
+/**
+ * Determines whether custom elements with the given tag should be scoped or not.
+ * The tag is first matched against the "include" rules and then against the "exclude" rules and the
+ * result is cached until new rules are set.
+ *
+ * @public
+ * @param tag
+ */
+declare const shouldScopeCustomElement: (tag: string) => boolean | undefined;
+/**
+ * Returns the currently set scoping suffix, if any and if the tag should be scoped, or undefined otherwise.
+ *
+ * @public
+ * @param tag
+ * @returns {String}
+ */
+declare const getEffectiveScopingSuffixForTag: (tag: string) => string | undefined;
+/**
+ * @public
+ * Used for getting a scoped name for a CSS variable using the same transformation used in the build
+ * @param name the name of the css variable as written in the code
+ * @param withVersion whether to include the version in the scoped name
+ * @returns a variable name with the current version inserted as available at runtime
+ * @deprecated As of version 2.19.0 this method is no longer required. Variables can now be defined at the component level
+ * and are automatically encapsulated within each component’s Shadow DOM.
+ * As a result, runtime scoping logic is no longer necessary.
+ *
+ * It is still needed for third-party packages that have not yet migrated to the
+ * component-level variable approach.
+ */
+declare const getScopedVarName: (name: string, withVersion?: boolean) => string;
+export { setCustomElementsScopingSuffix, getCustomElementsScopingSuffix, setCustomElementsScopingRules, getCustomElementsScopingRules, shouldScopeCustomElement, getEffectiveScopingSuffixForTag, getScopedVarName, };