@ui5/webcomponents-base 0.0.0-deac3098a → 0.0.0-df5b4199a

package/src/asset-registries/Icons.js

@@ -1,135 +0,0 @@
-import getSharedResource from "../getSharedResource.js";
-import IconCollectionsAlias from "../assets-meta/IconCollectionsAlias.js";
-import { getEffectiveDefaultIconCollection } from "../config/Icons.js";
-
-const loaders = new Map();
-const registry = getSharedResource("SVGIcons.registry", new Map());
-const iconCollectionPromises = getSharedResource("SVGIcons.promises", new Map());
-
-const ICON_NOT_FOUND = "ICON_NOT_FOUND";
-
-/**
- * @deprecated
- */
-const registerIconBundle = async (collectionName, bundleData) => {
-	throw new Error("This method has been removed. Use `registerIconLoader` instead.");
-};
-
-const registerIconLoader = async (collectionName, loader) => {
-	loaders.set(collectionName, loader);
-};
-
-const _loadIconCollectionOnce = async collectionName => {
-	if (!iconCollectionPromises.has(collectionName)) {
-		if (!loaders.has(collectionName)) {
-			throw new Error(`No loader registered for the ${collectionName} icons collection. Probably you forgot to import the "AllIcons.js" module for the respective package.`);
-		}
-		const loadIcons = loaders.get(collectionName);
-		iconCollectionPromises.set(collectionName, loadIcons(collectionName));
-	}
-
-	return iconCollectionPromises.get(collectionName);
-};
-
-const _fillRegistry = bundleData => {
-	Object.keys(bundleData.data).forEach(iconName => {
-		const iconData = bundleData.data[iconName];
-
-		registerIcon(iconName, {
-			pathData: iconData.path,
-			ltr: iconData.ltr,
-			accData: iconData.acc,
-			collection: bundleData.collection,
-			packageName: bundleData.packageName,
-		 });
-	});
-};
-
-// set
-const registerIcon = (name, { pathData, ltr, accData, collection, packageName } = {}) => { // eslint-disable-line
-	if (!collection) {
-		collection = getEffectiveDefaultIconCollection();
-	}
-
-	const key = `${collection}/${name}`;
-	registry.set(key, {
-		pathData,
-		ltr,
-		accData,
-		packageName,
-	});
-};
-
-const _parseName = name => {
-	// silently support ui5-compatible URIs
-	if (name.startsWith("sap-icon://")) {
-		name = name.replace("sap-icon://", "");
-	}
-
-	let collection;
-	[name, collection] = name.split("/").reverse();
-	collection = collection || getEffectiveDefaultIconCollection();
-
-	// Normalize collection name.
-	// - resolve `SAP-icons-TNT` to `tnt`.
-	// - resolve `BusinessSuiteInAppSymbols` to `business-suite`.
-	// - resolve `horizon` to `SAP-icons-v5`,
-	// Note: aliases can be made as a feature, if more collections need it or more aliases are needed.
-	collection = _normalizeCollection(collection);
-	name = name.replace("icon-", "");
-
-	const registryKey = `${collection}/${name}`;
-	return { name, collection, registryKey };
-};
-
-const getIconDataSync = nameProp => {
-	const { registryKey } = _parseName(nameProp);
-	return registry.get(registryKey);
-};
-
-const getIconData = async nameProp => {
-	const { collection, registryKey } = _parseName(nameProp);
-
-	let iconData = ICON_NOT_FOUND;
-	try {
-		iconData = await _loadIconCollectionOnce(collection);
-	} catch (e) {
-		console.error(e.message); /* eslint-disable-line */
-	}
-
-	if (iconData === ICON_NOT_FOUND) {
-		return iconData;
-	}
-
-	if (!registry.has(registryKey)) {
-		// not filled by another await. many getters will await on the same loader, but fill only once
-		_fillRegistry(iconData);
-	}
-	return registry.get(registryKey);
-};
-
-// test page usage only
-const _getRegisteredNames = async () => {
-	// fetch one icon of each collection to trigger the bundle load
-	await getIconData("edit");
-	await getIconData("tnt/arrow");
-	await getIconData("business-suite/3d");
-	return Array.from(registry.keys());
-};
-
-const _normalizeCollection = collectionName => {
-	if (IconCollectionsAlias[collectionName]) {
-		return IconCollectionsAlias[collectionName];
-	}
-
-	return collectionName;
-};
-
-export {
-	registerIconBundle,
-	registerIconLoader,
-	getIconData,
-	getIconDataSync,
-	registerIcon,
-	_getRegisteredNames,
-};

package/src/asset-registries/Illustrations.js

@@ -1,30 +0,0 @@
-import getSharedResource from "../getSharedResource.js";
-
-const registry = getSharedResource("SVGIllustration.registry", new Map());
-const ILLUSTRATION_NOT_FOUND = "ILLUSTRATION_NOT_FOUND";
-
-const registerIllustration = (name, { dialogSvg, sceneSvg, spotSvg, set, title, subtitle } = {}) => { // eslint-disable-line
-	registry.set(`${set}/${name}`, {
-		dialogSvg,
-		sceneSvg,
-		spotSvg,
-		title,
-		subtitle,
-	});
-};
-
-const getIllustrationDataSync = nameProp => {
-	let set = "fiori";
-
-	if (nameProp.startsWith("Tnt")) {
-		set = "tnt";
-		nameProp = nameProp.replace(/^Tnt/, "");
-	}
-
-	return registry.get(`${set}/${nameProp}`) || ILLUSTRATION_NOT_FOUND;
-};
-
-export {
-	getIllustrationDataSync,
-	registerIllustration,
-};

package/src/asset-registries/LocaleData.js

@@ -1,164 +0,0 @@
-import { attachLanguageChange } from "../locale/languageChange.js";
-import getLocale from "../locale/getLocale.js";
-import { DEFAULT_LOCALE, SUPPORTED_LOCALES } from "../generated/AssetParameters.js";
-import { getFeature } from "../FeaturesRegistry.js";
-
-const localeDataMap = new Map();
-const loaders = new Map();
-const cldrPromises = new Map();
-const reportedErrors = new Set();
-let warningShown = false;
-
-const M_ISO639_OLD_TO_NEW = {
-	"iw": "he",
-	"ji": "yi",
-	"in": "id",
-};
-
-const DEV_MODE = false;
-
-const _showAssetsWarningOnce = localeId => {
-	if (warningShown) {
-		return;
-	}
-
-	if (!DEV_MODE) {
-		console.warn(`[LocaleData] Supported locale "${localeId}" not configured, import the "Assets.js" module from the webcomponents package you are using.`); /* eslint-disable-line */
-	} else {
-		console.warn(`[LocaleData] Note: in dev mode, CLDR assets might be disabled for performance reasons. Try running "ENABLE_CLDR=1 yarn start" to test CLDR assets.`); /* eslint-disable-line */
-	}
-
-	warningShown = true;
-};
-
-const calcLocale = (language, region, script) => {
-	// normalize language and handle special cases
-	language = (language && M_ISO639_OLD_TO_NEW[language]) || language;
-	// Special case 1: in an SAP context, the inclusive language code "no" always means Norwegian Bokmal ("nb")
-	if (language === "no") {
-		language = "nb";
-	}
-	// Special case 2: for Chinese, derive a default region from the script (this behavior is inherited from Java)
-	if (language === "zh" && !region) {
-		if (script === "Hans") {
-			region = "CN";
-		} else if (script === "Hant") {
-			region = "TW";
-		}
-	}
-
-	// Special case 3: for Serbian, there are cyrillic and latin scripts, "sh" and "sr-latn" map to "latin", "sr" maps to cyrillic.
-	if (language === "sh" || (language === "sr" && script === "Latn")) {
-		language = "sr";
-		region = "Latn";
-	}
-
-	// try language + region
-	let localeId = `${language}_${region}`;
-	if (SUPPORTED_LOCALES.includes(localeId)) {
-		if (loaders.has(localeId)) {
-			// supported and has loader
-			return localeId;
-		}
-
-		// supported, no loader - fallback to default and warn
-		_showAssetsWarningOnce(localeId);
-		return DEFAULT_LOCALE;
-	}
-
-	// not supported, try language only
-	localeId = language;
-	if (SUPPORTED_LOCALES.includes(localeId)) {
-		if (loaders.has(localeId)) {
-			// supported and has loader
-			return localeId;
-		}
-
-		// supported, no loader - fallback to default and warn
-		_showAssetsWarningOnce(localeId);
-		return DEFAULT_LOCALE;
-	}
-
-	// not supported - fallback to default locale
-	return DEFAULT_LOCALE;
-};
-
-// internal set data
-const setLocaleData = (localeId, content) => {
-	localeDataMap.set(localeId, content);
-};
-
-// external getSync
-const getLocaleData = localeId => {
-	// if there is no loader, the default fallback was fetched and a warning was given - use default locale instead
-	if (!loaders.has(localeId)) {
-		localeId = DEFAULT_LOCALE;
-	}
-
-	const content = localeDataMap.get(localeId);
-	if (!content) {
-		throw new Error(`CLDR data for locale ${localeId} is not loaded!`);
-	}
-
-	return content;
-};
-
-// load bundle over the network once
-const _loadCldrOnce = localeId => {
-	const loadCldr = loaders.get(localeId);
-
-	if (!cldrPromises.get(localeId)) {
-		cldrPromises.set(localeId, loadCldr(localeId));
-	}
-
-	return cldrPromises.get(localeId);
-};
-
-// external getAsync
-const fetchCldr = async (language, region, script) => {
-	const localeId = calcLocale(language, region, script);
-
-	// reuse OpenUI5 CLDR if present
-	const OpenUI5Support = getFeature("OpenUI5Support");
-	if (OpenUI5Support) {
-		const cldrContent = OpenUI5Support.getLocaleDataObject();
-		if (cldrContent) {
-			// only if openui5 actually returned valid content
-			setLocaleData(localeId, cldrContent);
-			return;
-		}
-	}
-
-	// fetch it
-	try {
-		const cldrContent = await _loadCldrOnce(localeId);
-		setLocaleData(localeId, cldrContent);
-	} catch (e) {
-		if (!reportedErrors.has(e.message)) {
-			reportedErrors.add(e.message);
-			console.error(e.message); /* eslint-disable-line */
-		}
-	}
-};
-
-const registerLocaleDataLoader = (localeId, loader) => {
-	loaders.set(localeId, loader);
-};
-
-// register default loader for "en" from ui5 CDN (dev workflow without assets)
-registerLocaleDataLoader("en", async runtimeLocaleId => {
-	return (await fetch(`https://ui5.sap.com/1.60.2/resources/sap/ui/core/cldr/en.json`)).json();
-});
-
-// When the language changes dynamically (the user calls setLanguage),
-// re-fetch the required CDRD data.
-attachLanguageChange(() => {
-	const locale = getLocale();
-	return fetchCldr(locale.getLanguage(), locale.getRegion(), locale.getScript());
-});
-
-export {
-	registerLocaleDataLoader,
-	fetchCldr,
-	getLocaleData,
-};

package/src/asset-registries/Themes.js

@@ -1,78 +0,0 @@
-import { DEFAULT_THEME } from "../generated/AssetParameters.js";
-
-const themeStyles = new Map();
-const loaders = new Map();
-const registeredPackages = new Set();
-const registeredThemes = new Set();
-
-/**
- * Used to provide CSS Vars for a specific theme for a specific package.
- * The CSS Vars can be passed directly as a string (containing them), as an object with a "_" property(containing them in the "_" property), or as a URL.
- * This URL must point to a JSON file, containing a "_" property.
- *
- * Example usage:
- *  1) Pass the CSS Vars as a string directly.
- *  registerThemeProperties("my-package", "my_theme", ":root{--var1: red;}");
- *
- * @public
- * @param packageName - the NPM package for which CSS Vars are registered
- * @param themeName - the theme which the CSS Vars implement
- * @param style - the style content directly
- * @deprecated
- */
-const registerThemeProperties = (_packageName, _themeName, _style) => {
-	throw new Error("`registerThemeProperties` has been depracated. Use `registerThemePropertiesLoader` instead.");
-};
-
-const registerThemePropertiesLoader = (packageName, themeName, loader) => {
-	loaders.set(`${packageName}/${themeName}`, loader);
-	registeredPackages.add(packageName);
-	registeredThemes.add(themeName);
-};
-
-const getThemeProperties = async (packageName, themeName) => {
-	const style = themeStyles.get(`${packageName}_${themeName}`);
-	if (style !== undefined) { // it's valid for style to be an empty string
-		return style;
-	}
-
-	if (!registeredThemes.has(themeName)) {
-		const regThemesStr = [...registeredThemes.values()].join(", ");
-		console.warn(`You have requested a non-registered theme - falling back to ${DEFAULT_THEME}. Registered themes are: ${regThemesStr}`); /* eslint-disable-line */
-		return themeStyles.get(`${packageName}_${DEFAULT_THEME}`);
-	}
-
-	const loader = loaders.get(`${packageName}/${themeName}`);
-	if (!loader) {
-		// no themes for package
-		console.error(`Theme [${themeName}] not registered for package [${packageName}]`); /* eslint-disable-line */
-		return;
-	}
-	let data;
-	try {
-		data = await loader(themeName);
-	} catch (e) {
-		console.error(packageName, e.message); /* eslint-disable-line */
-		return;
-	}
-	const themeProps = data._ || data;
-
-	themeStyles.set(`${packageName}_${themeName}`, themeProps);
-	return themeProps;
-};
-
-const getRegisteredPackages = () => {
-	return registeredPackages;
-};
-
-const isThemeRegistered = theme => {
-	return registeredThemes.has(theme);
-};
-
-export {
-	registerThemePropertiesLoader,
-	registerThemeProperties,
-	getThemeProperties,
-	getRegisteredPackages,
-	isThemeRegistered,
-};

package/src/asset-registries/i18n.js

@@ -1,121 +0,0 @@
-import getLocale from "../locale/getLocale.js";
-import { attachLanguageChange } from "../locale/languageChange.js";
-import normalizeLocale from "../locale/normalizeLocale.js";
-import nextFallbackLocale from "../locale/nextFallbackLocale.js";
-import { DEFAULT_LANGUAGE } from "../generated/AssetParameters.js";
-import { getFetchDefaultLanguage } from "../config/Language.js";
-
-// contains package names for which the warning has been shown
-const warningShown = new Set();
-const reportedErrors = new Set();
-
-const bundleData = new Map();
-const bundlePromises = new Map();
-const loaders = new Map();
-
-/**
- *
- * @param {string} packageName for which package this loader can fetch data
- * @param {function} loader async function that will be passed a localeId and should return a JSON object
- * @param {Array} localeIds Array of locale IDs that this loader can handle
- */
-const registerI18nLoader = (packageName, localeId, loader) => {
-	// register loader by key
-	const bundleKey = `${packageName}/${localeId}`;
-	loaders.set(bundleKey, loader);
-};
-
-const _setI18nBundleData = (packageName, data) => {
-	bundleData.set(packageName, data);
-};
-
-const getI18nBundleData = packageName => {
-	return bundleData.get(packageName);
-};
-
-/**
- * @public
- * @deprecated
- */
-const registerI18nBundle = (_packageName, _bundle) => {
-	throw new Error("This method has been removed. Use `registerI18nLoader` instead.");
-};
-
-const _hasLoader = (packageName, localeId) => {
-	const bundleKey = `${packageName}/${localeId}`;
-	return loaders.has(bundleKey);
-};
-
-// load bundle over the network once
-const _loadMessageBundleOnce = (packageName, localeId) => {
-	const bundleKey = `${packageName}/${localeId}`;
-	const loadMessageBundle = loaders.get(bundleKey);
-
-	if (!bundlePromises.get(bundleKey)) {
-		bundlePromises.set(bundleKey, loadMessageBundle(localeId));
-	}
-
-	return bundlePromises.get(bundleKey);
-};
-
-const _showAssetsWarningOnce = packageName => {
-	if (!warningShown.has(packageName)) {
-		console.warn(`[${packageName}]: Message bundle assets are not configured. Falling back to English texts.`, /* eslint-disable-line */
-		` Add \`import "${packageName}/dist/Assets.js"\` in your bundle and make sure your build tool supports dynamic imports and JSON imports. See section "Assets" in the documentation for more information.`); /* eslint-disable-line */
-		warningShown.add(packageName);
-	}
-};
-
-/**
- * This method preforms the asynchronous task of fetching the actual text resources. It will fetch
- * each text resource over the network once (even for multiple calls to the same method).
- * It should be fully finished before the i18nBundle class is created in the webcomponents.
- * This method uses the bundle URLs that are populated by the <code>registerI18nBundle</code> method.
- * To simplify the usage, the synchronization of both methods happens internally for the same <code>bundleId</code>
- * @param {packageName} packageName the NPM package name
- * @public
- */
-const fetchI18nBundle = async packageName => {
-	const language = getLocale().getLanguage();
-	const region = getLocale().getRegion();
-	let localeId = normalizeLocale(language + (region ? `-${region}` : ``));
-
-	while (localeId !== DEFAULT_LANGUAGE && !_hasLoader(packageName, localeId)) {
-		localeId = nextFallbackLocale(localeId);
-	}
-
-	// use default language unless configured to always fetch it from the network
-	const fetchDefaultLanguage = getFetchDefaultLanguage();
-	if (localeId === DEFAULT_LANGUAGE && !fetchDefaultLanguage) {
-		_setI18nBundleData(packageName, null); // reset for the default language (if data was set for a previous language)
-		return;
-	}
-
-	if (!_hasLoader(packageName, localeId)) {
-		_showAssetsWarningOnce(packageName);
-		return;
-	}
-
-	try {
-		const data = await _loadMessageBundleOnce(packageName, localeId);
-		_setI18nBundleData(packageName, data);
-	} catch (e) {
-		if (!reportedErrors.has(e.message)) {
-			reportedErrors.add(e.message);
-			console.error(e.message); /* eslint-disable-line */
-		}
-	}
-};
-
-// When the language changes dynamically (the user calls setLanguage), re-fetch all previously fetched bundles
-attachLanguageChange(() => {
-	const allPackages = [...bundleData.keys()];
-	return Promise.all(allPackages.map(fetchI18nBundle));
-});
-
-export {
-	registerI18nLoader,
-	fetchI18nBundle,
-	registerI18nBundle,
-	getI18nBundleData,
-};

package/src/assets-meta/IconCollectionsAlias.js

@@ -1,18 +0,0 @@
-/**
- * Supported icon collection names and aliases.
- *
- * Users might specify a collection, using both the key and the value in the following key-value pairs,
- * e.g the following pairs are completely exchangeable:
- * "SAP-icons-TNT/actor" and "tnt/actor", "BusinessSuiteInAppSymbols/3d" and "business-suite/3d",
- * "SAP-icons-v5/accept" and "horizon/accept".
- *
- * Note: technically, in the code we maintain the collections under the "value" name - "tnt", "business-suite",
- * SAP-icons-v5" and "SAP-icons"(which does not have an alias).
- */
-const IconCollectionsAlias = {
-	"SAP-icons-TNT": "tnt",
-	"BusinessSuiteInAppSymbols": "business-suite",
-	"horizon": "SAP-icons-v5",
-};
-
-export default IconCollectionsAlias;

package/src/config/AnimationMode.js

@@ -1,23 +0,0 @@
-import { getAnimationMode as getConfiguredAnimationMode } from "../InitialConfiguration.js";
-import AnimationMode from "../types/AnimationMode.js";
-
-let animationMode;
-
-const getAnimationMode = () => {
-	if (animationMode === undefined) {
-		animationMode = getConfiguredAnimationMode();
-	}
-
-	return animationMode;
-};
-
-const setAnimationMode = newAnimationMode => {
-	if (Object.values(AnimationMode).includes(newAnimationMode)) {
-		animationMode = newAnimationMode;
-	}
-};
-
-export {
-	getAnimationMode,
-	setAnimationMode,
-};

package/src/config/CalendarType.js

@@ -1,18 +0,0 @@
-import CalendarType from "../types/CalendarType.js";
-import { getCalendarType as getConfiguredCalendarType } from "../InitialConfiguration.js";
-
-let calendarType;
-
-const getCalendarType = () => {
-	if (calendarType === undefined) {
-		calendarType = getConfiguredCalendarType();
-	}
-
-	if (CalendarType.isValid(calendarType)) {
-		return calendarType;
-	}
-
-	return CalendarType.Gregorian;
-};
-
-export { getCalendarType }; // eslint-disable-line

package/src/config/FormatSettings.js

@@ -1,13 +0,0 @@
-import { getFormatSettings } from "../InitialConfiguration.js";
-
-let formatSettings;
-
-const getFirstDayOfWeek = () => {
-	if (formatSettings === undefined) {
-		formatSettings = getFormatSettings();
-	}
-
-	return formatSettings.firstDayOfWeek;
-};
-
-export { getFirstDayOfWeek }; // eslint-disable-line

package/src/config/Icons.js

@@ -1,52 +0,0 @@
-import { getTheme, isThemeFamily } from "./Theme.js";
-
-const IconCollectionConfiguration = new Map();
-
-/**
- * Sets the default icon collection (v4 or v5) per theme,
- * which will be applied in case icon collection is not specified.
- *
- * Note: by default SAP-icons-v5 is used in SAP Horizon and  SAP-icons-v4 for all the rest.
- * @param {String} theme
- * @param {String} collectionName
- */
-const setDefaultIconCollection = (theme, collectionName) => {
-	if (collectionName === "horizon") {
-		collectionName = "SAP-icons-v5";
-	}
-
-	IconCollectionConfiguration.set(theme, collectionName);
-};
-
-/**
- * Returns the default icon collection (v4 or v5) for given theme,
- * that is configured.
- *
- * @param {String} theme
- * @returns {String}
- */
-const getDefaultIconCollection = theme => {
-	return IconCollectionConfiguration.get(theme);
-};
-
-/**
- * Returns the effective icon collection that will be applied for icon web components
- * whenever namespace is not specified.
- * @returns {String}
- */
-const getEffectiveDefaultIconCollection = () => {
-	const currentTheme = getTheme();
-	const currentThemeConfiguration = IconCollectionConfiguration.get(currentTheme);
-
-	if (currentThemeConfiguration) {
-		return currentThemeConfiguration;
-	}
-
-	return isThemeFamily("sap_horizon") ? "SAP-icons-v5" : "SAP-icons";
-};
-
-export {
-	setDefaultIconCollection,
-	getDefaultIconCollection,
-	getEffectiveDefaultIconCollection,
-};