@ui5/webcomponents-base 0.0.0-0fcda382e → 0.0.0-11d529e8a

package/dist/asset-registries/i18n.js

@@ -1,19 +1,31 @@
 import getLocale from "../locale/getLocale.js";
-import { fetchJsonOnce } from "../util/FetchHelper.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 bundleURLs = new Map();
+const bundlePromises = new Map();
+const loaders = new Map();
 
 /**
- * Sets a map with texts and ID the are related to.
- * @param {string} packageName package ID that the i18n bundle will be related to
- * @param {Object} data an object with string locales as keys and text translataions as values
- * @public
+ *
+ * @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 setI18nBundleData = (packageName, data) => {
+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);
 };
 
@@ -22,13 +34,36 @@ const getI18nBundleData = packageName => {
 };
 
 /**
- * Registers a map of locale/url information, to be used by the <code>fetchI18nBundle</code> method.
- * @param {string} packageName package ID that the i18n bundle will be related to
- * @param {Object} bundle an object with string locales as keys and the URLs of where the corresponding locale can be fetched from, f.e {"en": "path/en.json", ...}
  * @public
+ * @deprecated
  */
-const registerI18nBundle = (packageName, bundle) => {
-	bundleURLs.set(packageName, bundle);
+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);
+	}
 };
 
 /**
@@ -41,39 +76,46 @@ const registerI18nBundle = (packageName, bundle) => {
  * @public
  */
 const fetchI18nBundle = async packageName => {
-	const bundlesForPackage = bundleURLs.get(packageName);
-
-	if (!bundlesForPackage) {
-		console.warn(`Message bundle assets are not configured. Falling back to English texts.`, /* eslint-disable-line */
-		` You need to import ${packageName}/dist/Assets.js with a build tool that supports JSON imports.`); /* eslint-disable-line */
-		return;
-	}
-
 	const language = getLocale().getLanguage();
+	const region = getLocale().getRegion();
+	let localeId = normalizeLocale(language + (region ? `-${region}` : ``));
 
-	let localeId = normalizeLocale(language);
-	while (!bundlesForPackage[localeId]) {
+	while (localeId !== DEFAULT_LANGUAGE && !_hasLoader(packageName, localeId)) {
 		localeId = nextFallbackLocale(localeId);
 	}
 
-	if (localeId === DEFAULT_LANGUAGE) {
+	// 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;
 	}
 
-	const bundleURL = bundlesForPackage[localeId];
-
-	if (typeof bundleURL === "object") { // inlined from build
-		setI18nBundleData(packageName, bundleURL);
+	if (!_hasLoader(packageName, localeId)) {
+		_showAssetsWarningOnce(packageName);
 		return;
 	}
 
-	const data = await fetchJsonOnce(bundleURL);
-	setI18nBundleData(packageName, data);
+	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,
-	setI18nBundleData,
 	getI18nBundleData,
 };

package/dist/config/AnimationMode.js

@@ -1,4 +1,5 @@
 import { getAnimationMode as getConfiguredAnimationMode } from "../InitialConfiguration.js";
+import AnimationMode from "../types/AnimationMode.js";
 
 let animationMode;
 
@@ -10,4 +11,13 @@ const getAnimationMode = () => {
 	return animationMode;
 };
 
-export { getAnimationMode }; // eslint-disable-line
+const setAnimationMode = newAnimationMode => {
+	if (Object.values(AnimationMode).includes(newAnimationMode)) {
+		animationMode = newAnimationMode;
+	}
+};
+
+export {
+	getAnimationMode,
+	setAnimationMode,
+};

package/dist/config/Language.js

@@ -1,7 +1,17 @@
-import { getLanguage as getConfiguredLanguage } from "../InitialConfiguration.js";
+import {
+	getLanguage as getConfiguredLanguage,
+	getFetchDefaultLanguage as getConfiguredFetchDefaultLanguage,
+} from "../InitialConfiguration.js";
+import { fireLanguageChange } from "../locale/languageChange.js";
+import { reRenderAllUI5Elements } from "../Render.js";
 
 let language;
+let fetchDefaultLanguage;
 
+/**
+ * Returns the currently configured language, or the browser language as a fallback
+ * @returns {String}
+ */
 const getLanguage = () => {
 	if (language === undefined) {
 		language = getConfiguredLanguage();
@@ -9,4 +19,50 @@ const getLanguage = () => {
 	return language;
 };
 
-export { getLanguage }; // eslint-disable-line
+/**
+ * Changes the current language, re-fetches all message bundles, updates all language-aware components
+ * and returns a promise that resolves when all rendering is done
+ *
+ * @param newLanguage
+ * @returns {Promise<void>}
+ */
+const setLanguage = async newLanguage => {
+	if (language === newLanguage) {
+		return;
+	}
+
+	language = newLanguage;
+
+	await fireLanguageChange(newLanguage);
+	await reRenderAllUI5Elements({ languageAware: true });
+};
+
+/**
+ * Defines if the default language, that is inlined, should be
+ * fetched over the network instead of using the inlined one.
+ * <b>Note:</b> By default the language will not be fetched.
+ *
+ * @param {Boolean} fetchDefaultLanguage
+ */
+const setFetchDefaultLanguage = fetchDefaultLang => {
+	fetchDefaultLanguage = fetchDefaultLang;
+};
+
+/**
+ * Returns if the default language, that is inlined, should be fetched over the network.
+ * @returns {Boolean}
+ */
+const getFetchDefaultLanguage = () => {
+	if (fetchDefaultLanguage === undefined) {
+		setFetchDefaultLanguage(getConfiguredFetchDefaultLanguage());
+	}
+
+	return fetchDefaultLanguage;
+};
+
+export {
+	getLanguage,
+	setLanguage,
+	setFetchDefaultLanguage,
+	getFetchDefaultLanguage,
+};