@ui5/webcomponents-base 0.0.0-4b9b0ab7c → 0.0.0-4e88b8243

package/lib/generate-asset-parameters/index.js

@@ -1,25 +0,0 @@
-const fs = require('fs').promises;
-const assets = require('@ui5/webcomponents-tools/assets-meta.js');
-
-const fileContent = `const assetParameters = ${JSON.stringify(assets)};
-
-const DEFAULT_THEME = assetParameters.themes.default;
-const DEFAULT_LANGUAGE = assetParameters.languages.default;
-const DEFAULT_LOCALE = assetParameters.locales.default;
-const SUPPORTED_LOCALES = assetParameters.locales.all;
-
-export {
-	DEFAULT_THEME,
-	DEFAULT_LANGUAGE,
-	DEFAULT_LOCALE,
-	SUPPORTED_LOCALES,
-};`;
-
-const generate = async () => {
-	await fs.mkdir("dist/generated/", { recursive: true });
-	return fs.writeFile("dist/generated/AssetParameters.js", fileContent);
-}
-
-generate().then(() => {
-	console.log("Assets parameters generated.");
-});

package/lib/generate-styles/index.js

@@ -1,31 +0,0 @@
-const fs = require('fs').promises;
-const path = require('path');
-const CleanCSS = require('clean-css');
-
-const generate = async () => {
-	await fs.mkdir("src/generated/css/", {recursive: true});
-
-	const files = (await fs.readdir("src/css/")).filter(file => file.endsWith(".css"));
-	const filesPromises = files.map(async file => {
-		let content = await fs.readFile(path.join("src/css/", file));
-		const res = new CleanCSS().minify(`${content}`);
-		content = `import type { StyleData } from "../../types.js";
-
-const styleData: StyleData = {
-	packageName: "@ui5/webcomponents-base",
-	fileName: "${file}",
-	content: \`${res.styles}\`,
-};
-
-export default styleData;
-`;
-
-		return fs.writeFile(path.join("src/generated/css/", `${file}.ts`), content);
-	});
-
-	return Promise.all(filesPromises);
-};
-
-generate().then(() => {
-	console.log("Styles files generated.");
-});

package/lib/generate-version-info/index.js

@@ -1,32 +0,0 @@
-const fs = require('fs').promises;
-
-const generate = async () => {
-	const version = JSON.parse(await fs.readFile("package.json")).version;
-
-	// Parse version
-	const matches = version.match(/^([0-9]+)\.([0-9]+)\.([0-9]+)(.*)$/);
-	if (!matches) {
-		throw new Error("Unsupported version format");
-	}
-
-	const isNext = version.match(/[a-f0-9]{9}$/);
-	const buildTime = Math.floor(new Date().getTime() / 1000);
-
-	const fileContent = `const VersionInfo = {
-	version: "${version}",
-	major: ${matches[1]},
-	minor: ${matches[2]},
-	patch: ${matches[3]},
-	suffix: "${matches[4]}",
-	isNext: ${isNext ? "true" : "false"},
-	buildTime: ${buildTime},
-};
-export default VersionInfo;`;
-
-	await fs.mkdir("dist/generated/", { recursive: true });
-	await fs.writeFile("dist/generated/VersionInfo.js", fileContent);
-}
-
-generate().then(() => {
-	console.log("Version info file generated.");
-});

package/package-scripts.js

@@ -1,71 +0,0 @@
-const resolve = require("resolve");
-const path = require("path");
-
-const assetParametersScript = resolve.sync("@ui5/webcomponents-base/lib/generate-asset-parameters/index.js");
-const stylesScript = resolve.sync("@ui5/webcomponents-base/lib/generate-styles/index.js");
-const versionScript = resolve.sync("@ui5/webcomponents-base/lib/generate-version-info/index.js");
-const copyUsedModules = resolve.sync("@ui5/webcomponents-tools/lib/copy-list/index.js");
-const esmAbsToRel = resolve.sync("@ui5/webcomponents-tools/lib/esm-abs-to-rel/index.js");
-const preprocessJSDocScript = resolve.sync("@ui5/webcomponents-tools/lib/jsdoc/preprocess.js");
-
-const LIB = path.join(__dirname, `../tools/lib/`);
-
-const viteConfig = `-c "${require.resolve("@ui5/webcomponents-tools/components-package/vite.config.js")}"`;
-const eslintConfig = `--config ${require.resolve("@ui5/webcomponents-tools/components-package/eslint.js")}`;
-
-const scripts = {
-	clean: "rimraf jsdoc-dist && rimraf src/generated && rimraf dist && rimraf .port",
-	lint: `eslint . ${eslintConfig}`,
-	prepare: "cross-env UI5_TS=true nps clean integrate copy generateAssetParameters generateVersionInfo generateStyles generateTemplates typescript generateAPI",
-	typescript: "tsc",
-	integrate: {
-		default: "nps integrate.copy-used-modules integrate.replace-amd integrate.amd-to-es6 integrate.esm-abs-to-rel integrate.third-party",
-		"copy-used-modules": `node "${copyUsedModules}" ./used-modules.txt dist/`,
-		"replace-amd": "replace-in-file sap.ui.define define dist/**/*.js",
-		"amd-to-es6": "amdtoes6 --src=dist/ --replace --glob=**/*.js",
-		"esm-abs-to-rel": `node "${esmAbsToRel}" dist/ dist/`,
-		"third-party": {
-			default: "nps integrate.third-party.copy integrate.third-party.fix",
-			copy: "mkdirp dist/sap/ui/thirdparty/ && copy-and-watch ../../node_modules/@openui5/sap.ui.core/src/sap/ui/thirdparty/caja-html-sanitizer.js dist/sap/ui/thirdparty/",
-			fix: "replace-in-file 240 xA0 dist/sap/ui/thirdparty/caja-html-sanitizer.js"
-		},
-	},
-	build: {
-		default: `nps prepare lint build.bundle`,
-		bundle: `vite build ${viteConfig}`,
-	},
-	copy: {
-		default: "nps copy.src",
-		src: `copy-and-watch "src/**/*.{js,css,d.ts}" dist/`,
-	},
-	generateAssetParameters: `node "${assetParametersScript}"`,
-	generateVersionInfo: `node "${versionScript}"`,
-	generateStyles: `node "${stylesScript}"`,
-	generateTemplates: `mkdirp dist/generated/templates && node "${LIB}/hbs2ui5/index.js" -d test/elements -o dist/generated/templates`,
-	generateAPI: {
-		default: "nps generateAPI.prepare generateAPI.preprocess generateAPI.jsdoc generateAPI.cleanup",
-		prepare: `copy-and-watch "dist/**/*.js" jsdoc-dist/`,
-		preprocess: `node "${preprocessJSDocScript}" jsdoc-dist/`,
-		jsdoc: `jsdoc -c "${LIB}/jsdoc/configTypescript.json"`,
-		cleanup: "rimraf jsdoc-dist/"
-	},
-	watch: {
-		default: 'concurrently "nps watch.src" "nps watch.styles" "nps watch.typescript"',
-		withBundle: 'concurrently "nps watch.src" "nps watch.bundle" "nps watch.styles" "nps watch.typescript"',
-		src: 'nps "copy.src --watch --skip-initial-copy"',
-		typescript: 'tsc --watch',
-		bundle: `node ${LIB}/dev-server/dev-server.js ${viteConfig}`,
-		styles: 'chokidar "src/css/*.css" -c "nps generateStyles"'
-	},
-	start: "nps prepare watch.withBundle",
-	test: {
-		default: 'concurrently "nps test.wdio"',
-		ssr: `mocha test/ssr`,
-		wdio: `node "${LIB}/test-runner/test-runner.js"`
-	},
-};
-
-
-module.exports = {
-	scripts,
-};

package/src/AssetRegistry.ts

@@ -1,11 +0,0 @@
-import { registerI18nLoader } from "./asset-registries/i18n.js";
-import { registerLocaleDataLoader } from "./asset-registries/LocaleData.js";
-import { registerThemePropertiesLoader } from "./asset-registries/Themes.js";
-import { registerIconLoader } from "./asset-registries/Icons.js";
-
-export {
-	registerI18nLoader,
-	registerLocaleDataLoader,
-	registerThemePropertiesLoader,
-	registerIconLoader,
-};

package/src/Boot.ts

@@ -1,85 +0,0 @@
-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 applyTheme from "./theming/applyTheme.js";
-import { registerCurrentRuntime } from "./Runtimes.js";
-import { getFeature } from "./FeaturesRegistry.js";
-import type OpenUI5Support from "./features/OpenUI5Support.js";
-import type F6Navigation from "./features/F6Navigation.js";
-import { PromiseResolve } from "./types.js";
-import { attachThemeRegistered } from "./theming/ThemeRegistered.js";
-
-let booted = false;
-let bootPromise: Promise<void>;
-const eventProvider = new EventProvider<void, void>();
-
-/**
- * Attaches a callback that will be executed after boot finishes.
- * <b>Note:</b> If the framework already booted, the callback will be immediately executed.
- * @public
- * @param { Function } listener
- */
-const attachBoot = (listener: () => void) => {
-	if (!booted) {
-		eventProvider.attachEvent("boot", listener);
-		return;
-	}
-
-	listener();
-};
-
-const boot = async (): Promise<void> => {
-	if (bootPromise !== undefined) {
-		return bootPromise;
-	}
-
-	const bootExecutor = async (resolve: PromiseResolve) => {
-		if (typeof document === "undefined") {
-			resolve();
-			return;
-		}
-
-		attachThemeRegistered(() => {
-			if (!booted) {
-				return;
-			}
-			console.log("apply theme when theme registered after boot"); // eslint-disable-line
-			applyTheme(getTheme());
-		});
-
-		registerCurrentRuntime();
-
-		const openUI5Support = getFeature<typeof OpenUI5Support>("OpenUI5Support");
-		const isOpenUI5Loaded = openUI5Support ? openUI5Support.isLoaded() : false;
-		const f6Navigation = getFeature<typeof F6Navigation>("F6Navigation");
-
-		if (openUI5Support) {
-			await openUI5Support.init();
-		}
-
-		if (f6Navigation && !isOpenUI5Loaded) {
-			f6Navigation.init();
-		}
-
-		await whenDOMReady();
-		await applyTheme(getTheme());
-		openUI5Support && openUI5Support.attachListeners();
-		insertFontFace();
-		insertSystemCSSVars();
-
-		resolve();
-
-		booted = true;
-		await eventProvider.fireEventAsync("boot");
-	};
-
-	bootPromise = new Promise(bootExecutor as (resolve: PromiseResolve) => void);
-	return bootPromise;
-};
-
-export {
-	boot,
-	attachBoot,
-};

package/src/CSP.ts

@@ -1,66 +0,0 @@
-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.
- *
- * @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: string, root: string) => {
-	roots.set(packageName, root);
-};
-
-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}`;
-};
-
-/**
- * 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: boolean) => {
-	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: boolean) => {
-	preloadLinks = preload;
-};
-
-const shouldUseLinks = () => {
-	return useLinks;
-};
-
-const shouldPreloadLinks = () => {
-	return preloadLinks;
-};
-
-export {
-	setPackageCSSRoot,
-	getUrl,
-	setUseLinks,
-	setPreloadLinks,
-	shouldUseLinks,
-	shouldPreloadLinks,
-};

package/src/CustomElementsRegistry.ts

@@ -1,98 +0,0 @@
-import getSharedResource from "./getSharedResource.js";
-import { getCurrentRuntimeIndex, compareRuntimes, getAllRuntimes } from "./Runtimes.js";
-import { Timeout } from "./types.js";
-
-const Tags = getSharedResource<Map<string, number>>("Tags", new Map());
-const Definitions = new Set<string>();
-
-let Failures = new Map<number, Set<string>>();
-let failureTimeout: Timeout | undefined;
-
-const UNKNOWN_RUNTIME = -1;
-
-const registerTag = (tag: string) => {
-	Definitions.add(tag);
-	Tags.set(tag, getCurrentRuntimeIndex());
-};
-
-const isTagRegistered = (tag: string) => {
-	return Definitions.has(tag);
-};
-
-const getAllRegisteredTags = () => {
-	return [...Definitions.values()];
-};
-
-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
-	}
-
-	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("")}`;
-	}
-
-	[...Failures.keys()].forEach(otherRuntimeIndex => {
-		let comparison: number;
-		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/SAP/ui5-webcomponents/blob/main/docs/2-advanced/03-scoping.md.`;
-
-	console.warn(message); // eslint-disable-line
-};
-
-export {
-	registerTag,
-	isTagRegistered,
-	getAllRegisteredTags,
-	recordTagRegistrationFailure,
-};

package/src/CustomElementsScope.ts

@@ -1,33 +0,0 @@
-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/CustomElementsScopeUtils.ts

@@ -1,115 +0,0 @@
-let suf: string;
-
-type Rules = {
-	include: Array<RegExp>,
-	exclude: Array<RegExp>,
-};
-
-let rulesObj: Rules = {
-	include: [/^ui5-/],
-	exclude: [],
-};
-
-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".
- * 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: string) => {
-	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: 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: 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);
-	}
-
-	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: string) => {
-	if (shouldScopeCustomElement(tag)) {
-		return getCustomElementsScopingSuffix();
-	}
-};
-
-export {
-	setCustomElementsScopingSuffix,
-	getCustomElementsScopingSuffix,
-	setCustomElementsScopingRules,
-	getCustomElementsScopingRules,
-	shouldScopeCustomElement,
-	getEffectiveScopingSuffixForTag,
-};

package/src/DOMObserver.ts

@@ -1,28 +0,0 @@
-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,
-};