@ui5/webcomponents-base 0.0.0-037d08c67

package/dist/asset-registries/Illustrations.d.ts

@@ -0,0 +1,144 @@
+import type { I18nText } from "../i18nBundle.js";
+import type { TemplateFunction } from "../renderer/executeTemplate.js";
+/**
+ * Loader function for lazy-loading illustration data.
+ */
+type IllustrationLoader = (illustrationName: string) => Promise<UnsafeIllustrationData>;
+/**
+ * Database properties shared by all illustration types.
+ */
+type IllustrationDatabase = {
+    /** The illustration title text (supports i18n) */
+    title: I18nText;
+    /** The illustration subtitle text (supports i18n) */
+    subtitle: I18nText;
+};
+/**
+ * Illustration properties using template functions (recommended).
+ *
+ * @public
+ */
+type IllustrationProperties = IllustrationDatabase & {
+    /** Template function for the medium variant (M breakpoint, ≤ 681px) */
+    dialogTemplate?: TemplateFunction;
+    /** Template function for the large variant (L breakpoint, > 681px) */
+    sceneTemplate?: TemplateFunction;
+    /** Template function for the small variant (S breakpoint, ≤ 360px) */
+    spotTemplate?: TemplateFunction;
+    /** Template function for the extra small variant (XS breakpoint, ≤ 260px) */
+    dotTemplate?: TemplateFunction;
+};
+/**
+ * Illustration properties using raw SVG strings (unsafe).
+ *
+ * @public
+ */
+type UnsafeIllustrationProperties = IllustrationDatabase & {
+    /** SVG content for the medium variant (M breakpoint, ≤ 681px) */
+    dialogSvg: string;
+    /** SVG content for the large variant (L breakpoint, > 681px) */
+    sceneSvg: string;
+    /** SVG content for the small variant (S breakpoint, ≤ 360px) */
+    spotSvg: string;
+    /** SVG content for the extra small variant (XS breakpoint, ≤ 260px) */
+    dotSvg: string;
+};
+/**
+ * Complete illustration data for registration (recommended).
+ *
+ * @public
+ */
+type IllustrationData = IllustrationProperties & {
+    /** The illustration set identifier (e.g., "custom") */
+    set: string;
+    /** Collection identifier (defaults to "V4") */
+    collection?: string;
+};
+/**
+ * Complete unsafe illustration data for registration.
+ *
+ * @public
+ */
+type UnsafeIllustrationData = UnsafeIllustrationProperties & {
+    /** The illustration set identifier (e.g., "custom") */
+    set: string;
+    /** Collection identifier (defaults to "V4") */
+    collection?: string;
+};
+/**
+ * Registers a custom illustration in the global registry using template functions.
+ *
+ * This is the recommended way to register illustrations as it accepts template functions
+ * instead of raw SVG strings, preventing XSS vulnerabilities.
+ *
+ * @param name - The name of the illustration (without set prefix)
+ * @param data - The illustration data (see {@link IllustrationData})
+ *
+ * @public
+ * @since 2.17.0
+ * @example
+ * ```js
+ * import { registerIllustration } from "@ui5/webcomponents-base/dist/asset-registries/Illustrations.js";
+ *
+ * registerIllustration("EmptyCart", {
+ *   sceneTemplate: (component) => <svg>...</svg>,
+ *   dialogTemplate: (component) => <svg>...</svg>,
+ *   spotTemplate: (component) => <svg>...</svg>,
+ *   dotTemplate: (component) => <svg>...</svg>,
+ *   title: "Your cart is empty",
+ *   subtitle: "Add items to get started",
+ *   set: "custom"
+ * });
+ * ```
+ */
+declare const registerIllustration: (name: string, data: IllustrationData) => void;
+/**
+ * Registers a custom illustration in the global registry.
+ *
+ * <b>Note:</b> This method is unsafe as it allows the SVG content to be passed as raw strings
+ * through the `dialogSvg`, `sceneSvg`, `spotSvg`, and `dotSvg` properties of the `data`.
+ * Ensure that the SVG content is properly validated.
+ * Improperly sanitized SVG strings can lead to security vulnerabilities such as XSS (Cross-Site Scripting).
+ *
+ * @param name - The name of the illustration (without set prefix)
+ * @param data - The illustration data (see {@link UnsafeIllustrationData})
+ *
+ * @public
+ * @since 2.17.0
+ * @example
+ * ```js
+ * import { unsafeRegisterIllustration } from "@ui5/webcomponents-base/dist/asset-registries/Illustrations.js";
+ *
+ * unsafeRegisterIllustration("EmptyCart", {
+ *   sceneSvg: "<svg>...</svg>",
+ *   dialogSvg: "<svg>...</svg>",
+ *   spotSvg: "<svg>...</svg>",
+ *   dotSvg: "<svg>...</svg>",
+ *   title: "Your cart is empty",
+ *   subtitle: "Add items to get started",
+ *   set: "custom"
+ * });
+ * ```
+ */
+declare const unsafeRegisterIllustration: (name: string, data: UnsafeIllustrationData) => void;
+declare const registerIllustrationLoader: (illustrationName: string, loader: IllustrationLoader) => void;
+/**
+ * Synchronously retrieves illustration data from the registry.
+ *
+ * @param illustrationName - The illustration identifier in format "set/name"
+ * @returns The illustration properties or undefined if not available
+ *
+ * @public
+ */
+declare const getIllustrationDataSync: (illustrationName: string) => UnsafeIllustrationProperties | IllustrationProperties | undefined;
+/**
+ * Asynchronously retrieves illustration data, loading it if necessary.
+ *
+ * @param illustrationName - The illustration identifier in format "set/name"
+ * @returns Promise resolving to illustration properties or undefined
+ *
+ * @public
+ */
+declare const getIllustrationData: (illustrationName: string) => Promise<UnsafeIllustrationProperties | IllustrationProperties | undefined>;
+export { getIllustrationDataSync, registerIllustration, unsafeRegisterIllustration, registerIllustrationLoader, getIllustrationData, };
+export type { IllustrationData, UnsafeIllustrationData, IllustrationProperties, UnsafeIllustrationProperties, };

package/dist/asset-registries/Illustrations.js

@@ -0,0 +1,158 @@
+import getSharedResource from "../getSharedResource.js";
+import { getTheme } from "../config/Theme.js";
+const IllustrationCollections = new Map([
+    ["sap_horizon", "V5"],
+    ["sap_horizon_dark", "V5"],
+    ["sap_horizon_hcb", "V5/HC"],
+    ["sap_horizon_hcw", "V5/HC"],
+]);
+const FALLBACK_COLLECTION = "V4";
+const loaders = new Map();
+const registry = getSharedResource("SVGIllustration.registry", new Map());
+const illustrationPromises = getSharedResource("SVGIllustration.promises", new Map());
+const getCollection = () => {
+    const theme = getTheme();
+    if (IllustrationCollections.has(theme)) {
+        return IllustrationCollections.get(theme);
+    }
+    return FALLBACK_COLLECTION;
+};
+/**
+ * Processes the name of the illustration
+ * The name is used to generate the registry key and the loader key
+ * The registry key is used to store and get the illustration data from the registry
+ * The loader key is used to store and get the illustration loader from the loaders map
+ * The function generates the correct registry key and loader key based on whether an loader exists for the illustration
+ * If there is no loader registered for the collection, it falls back to the default collection
+ */
+const processName = (name) => {
+    let collection = getCollection();
+    const [set, illustrationName] = name.split("/");
+    let registryKey = `${set}/${collection}/${illustrationName}`;
+    if (!loaders.has(registryKey) && collection !== FALLBACK_COLLECTION) {
+        collection = FALLBACK_COLLECTION;
+        registryKey = `${set}/${collection}/${illustrationName}`;
+    }
+    return {
+        registryKey,
+        collection,
+    };
+};
+/**
+ * Registers a custom illustration in the global registry using template functions.
+ *
+ * This is the recommended way to register illustrations as it accepts template functions
+ * instead of raw SVG strings, preventing XSS vulnerabilities.
+ *
+ * @param name - The name of the illustration (without set prefix)
+ * @param data - The illustration data (see {@link IllustrationData})
+ *
+ * @public
+ * @since 2.17.0
+ * @example
+ * ```js
+ * import { registerIllustration } from "@ui5/webcomponents-base/dist/asset-registries/Illustrations.js";
+ *
+ * registerIllustration("EmptyCart", {
+ *   sceneTemplate: (component) => <svg>...</svg>,
+ *   dialogTemplate: (component) => <svg>...</svg>,
+ *   spotTemplate: (component) => <svg>...</svg>,
+ *   dotTemplate: (component) => <svg>...</svg>,
+ *   title: "Your cart is empty",
+ *   subtitle: "Add items to get started",
+ *   set: "custom"
+ * });
+ * ```
+ */
+const registerIllustration = (name, data) => {
+    const collection = data.collection || FALLBACK_COLLECTION;
+    registry.set(`${data.set}/${collection}/${name}`, {
+        dialogTemplate: data.dialogTemplate,
+        sceneTemplate: data.sceneTemplate,
+        spotTemplate: data.spotTemplate,
+        dotTemplate: data.dotTemplate,
+        title: data.title,
+        subtitle: data.subtitle,
+    });
+};
+/**
+ * Registers a custom illustration in the global registry.
+ *
+ * <b>Note:</b> This method is unsafe as it allows the SVG content to be passed as raw strings
+ * through the `dialogSvg`, `sceneSvg`, `spotSvg`, and `dotSvg` properties of the `data`.
+ * Ensure that the SVG content is properly validated.
+ * Improperly sanitized SVG strings can lead to security vulnerabilities such as XSS (Cross-Site Scripting).
+ *
+ * @param name - The name of the illustration (without set prefix)
+ * @param data - The illustration data (see {@link UnsafeIllustrationData})
+ *
+ * @public
+ * @since 2.17.0
+ * @example
+ * ```js
+ * import { unsafeRegisterIllustration } from "@ui5/webcomponents-base/dist/asset-registries/Illustrations.js";
+ *
+ * unsafeRegisterIllustration("EmptyCart", {
+ *   sceneSvg: "<svg>...</svg>",
+ *   dialogSvg: "<svg>...</svg>",
+ *   spotSvg: "<svg>...</svg>",
+ *   dotSvg: "<svg>...</svg>",
+ *   title: "Your cart is empty",
+ *   subtitle: "Add items to get started",
+ *   set: "custom"
+ * });
+ * ```
+ */
+const unsafeRegisterIllustration = (name, data) => {
+    const collection = data.collection || FALLBACK_COLLECTION;
+    registry.set(`${data.set}/${collection}/${name}`, {
+        dialogSvg: data.dialogSvg,
+        sceneSvg: data.sceneSvg,
+        spotSvg: data.spotSvg,
+        dotSvg: data.dotSvg,
+        title: data.title,
+        subtitle: data.subtitle,
+    });
+};
+const registerIllustrationLoader = (illustrationName, loader) => {
+    loaders.set(illustrationName, loader);
+};
+const _loadIllustrationOnce = (illustrationName) => {
+    const { registryKey } = processName(illustrationName);
+    if (!illustrationPromises.has(registryKey)) {
+        if (!loaders.has(registryKey)) {
+            const illustrationPath = illustrationName.startsWith("fiori/") ? illustrationName.replace("fiori/", "") : illustrationName;
+            throw new Error(`No loader registered for the ${illustrationName} illustration. Probably you forgot to import the "@ui5/webcomponents-fiori/dist/illustrations/${illustrationPath}.js" module. Or you can import the "@ui5/webcomponents-fiori/dist/illustrations/AllIllustrations.js" module that will make all illustrations available, but fetch only the ones used.`);
+        }
+        const loadIllustrations = loaders.get(registryKey);
+        illustrationPromises.set(registryKey, loadIllustrations(registryKey));
+    }
+    return illustrationPromises.get(registryKey);
+};
+/**
+ * Synchronously retrieves illustration data from the registry.
+ *
+ * @param illustrationName - The illustration identifier in format "set/name"
+ * @returns The illustration properties or undefined if not available
+ *
+ * @public
+ */
+const getIllustrationDataSync = (illustrationName) => {
+    const { registryKey } = processName(illustrationName);
+    return registry.get(registryKey);
+};
+/**
+ * Asynchronously retrieves illustration data, loading it if necessary.
+ *
+ * @param illustrationName - The illustration identifier in format "set/name"
+ * @returns Promise resolving to illustration properties or undefined
+ *
+ * @public
+ */
+const getIllustrationData = async (illustrationName) => {
+    const { registryKey } = processName(illustrationName);
+    await _loadIllustrationOnce(illustrationName);
+    return registry.get(registryKey);
+};
+export { getIllustrationDataSync, registerIllustration, unsafeRegisterIllustration, registerIllustrationLoader, getIllustrationData, };
+//# sourceMappingURL=Illustrations.js.map

package/dist/asset-registries/Illustrations.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Illustrations.js","sourceRoot":"","sources":["../../src/asset-registries/Illustrations.ts"],"names":[],"mappings":"AAAA,OAAO,iBAAiB,MAAM,yBAAyB,CAAC;AAExD,OAAO,EAAE,QAAQ,EAAE,MAAM,oBAAoB,CAAC;AA0E9C,MAAM,uBAAuB,GAAG,IAAI,GAAG,CAAC;IACvC,CAAC,aAAa,EAAE,IAAI,CAAC;IACrB,CAAC,kBAAkB,EAAE,IAAI,CAAC;IAC1B,CAAC,iBAAiB,EAAE,OAAO,CAAC;IAC5B,CAAC,iBAAiB,EAAE,OAAO,CAAC;CAC5B,CAAC,CAAC;AAEH,MAAM,mBAAmB,GAAG,IAAI,CAAC;AAEjC,MAAM,OAAO,GAAG,IAAI,GAAG,EAA8B,CAAC;AACtD,MAAM,QAAQ,GAAG,iBAAiB,CAAqE,0BAA0B,EAAE,IAAI,GAAG,EAAE,CAAC,CAAC;AAC9I,MAAM,oBAAoB,GAAG,iBAAiB,CAA+C,0BAA0B,EAAE,IAAI,GAAG,EAAE,CAAC,CAAC;AAEpI,MAAM,aAAa,GAAG,GAAG,EAAE;IAC1B,MAAM,KAAK,GAAG,QAAQ,EAAE,CAAC;IAEzB,IAAI,uBAAuB,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE,CAAC;QACxC,OAAO,uBAAuB,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;IAC3C,CAAC;IAED,OAAO,mBAAmB,CAAC;AAC5B,CAAC,CAAC;AAEF;;;;;;;GAOG;AACH,MAAM,WAAW,GAAG,CAAC,IAAY,EAAE,EAAE;IACpC,IAAI,UAAU,GAAG,aAAa,EAAE,CAAC;IACjC,MAAM,CAAC,GAAG,EAAE,gBAAgB,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;IAChD,IAAI,WAAW,GAAG,GAAG,GAAG,IAAI,UAAU,IAAI,gBAAgB,EAAE,CAAC;IAE7D,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,WAAW,CAAC,IAAI,UAAU,KAAK,mBAAmB,EAAE,CAAC;QACrE,UAAU,GAAG,mBAAmB,CAAC;QACjC,WAAW,GAAG,GAAG,GAAG,IAAI,UAAU,IAAI,gBAAgB,EAAE,CAAC;IAC1D,CAAC;IAED,OAAO;QACN,WAAW;QACX,UAAU;KACV,CAAC;AACH,CAAC,CAAC;AAEF;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,MAAM,oBAAoB,GAAG,CAAC,IAAY,EAAE,IAAsB,EAAE,EAAE;IACrE,MAAM,UAAU,GAAG,IAAI,CAAC,UAAU,IAAI,mBAAmB,CAAC;IAC1D,QAAQ,CAAC,GAAG,CAAC,GAAG,IAAI,CAAC,GAAG,IAAI,UAAU,IAAI,IAAI,EAAE,EAAE;QACjD,cAAc,EAAE,IAAI,CAAC,cAAc;QACnC,aAAa,EAAE,IAAI,CAAC,aAAa;QACjC,YAAY,EAAE,IAAI,CAAC,YAAY;QAC/B,WAAW,EAAE,IAAI,CAAC,WAAW;QAC7B,KAAK,EAAE,IAAI,CAAC,KAAK;QACjB,QAAQ,EAAE,IAAI,CAAC,QAAQ;KACvB,CAAC,CAAC;AACJ,CAAC,CAAC;AAEF;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2BG;AACH,MAAM,0BAA0B,GAAG,CAAC,IAAY,EAAE,IAA4B,EAAE,EAAE;IACjF,MAAM,UAAU,GAAG,IAAI,CAAC,UAAU,IAAI,mBAAmB,CAAC;IAC1D,QAAQ,CAAC,GAAG,CAAC,GAAG,IAAI,CAAC,GAAG,IAAI,UAAU,IAAI,IAAI,EAAE,EAAE;QACjD,SAAS,EAAE,IAAI,CAAC,SAAS;QACzB,QAAQ,EAAE,IAAI,CAAC,QAAQ;QACvB,OAAO,EAAE,IAAI,CAAC,OAAO;QACrB,MAAM,EAAE,IAAI,CAAC,MAAM;QACnB,KAAK,EAAE,IAAI,CAAC,KAAK;QACjB,QAAQ,EAAE,IAAI,CAAC,QAAQ;KACvB,CAAC,CAAC;AACJ,CAAC,CAAC;AAEF,MAAM,0BAA0B,GAAG,CAAC,gBAAwB,EAAE,MAA0B,EAAE,EAAE;IAC3F,OAAO,CAAC,GAAG,CAAC,gBAAgB,EAAE,MAAM,CAAC,CAAC;AACvC,CAAC,CAAC;AAEF,MAAM,qBAAqB,GAAG,CAAC,gBAAwB,EAAE,EAAE;IAC1D,MAAM,EAAE,WAAW,EAAE,GAAG,WAAW,CAAC,gBAAgB,CAAC,CAAC;IACtD,IAAI,CAAC,oBAAoB,CAAC,GAAG,CAAC,WAAW,CAAC,EAAE,CAAC;QAC5C,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,WAAW,CAAC,EAAE,CAAC;YAC/B,MAAM,gBAAgB,GAAG,gBAAgB,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,gBAAgB,CAAC,OAAO,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,gBAAgB,CAAC;YAC3H,MAAM,IAAI,KAAK,CAAC,gCAAgC,gBAAgB,iGAAiG,gBAAgB,uLAAuL,CAAC,CAAC;QAC3W,CAAC;QAED,MAAM,iBAAiB,GAAG,OAAO,CAAC,GAAG,CAAC,WAAW,CAAE,CAAC;QACpD,oBAAoB,CAAC,GAAG,CAAC,WAAW,EAAE,iBAAiB,CAAC,WAAW,CAAC,CAAC,CAAC;IACvE,CAAC;IACD,OAAO,oBAAoB,CAAC,GAAG,CAAC,WAAW,CAAC,CAAC;AAC9C,CAAC,CAAC;AAEF;;;;;;;GAOG;AACH,MAAM,uBAAuB,GAAG,CAAC,gBAAwB,EAAE,EAAE;IAC5D,MAAM,EAAE,WAAW,EAAE,GAAG,WAAW,CAAC,gBAAgB,CAAC,CAAC;IACtD,OAAO,QAAQ,CAAC,GAAG,CAAC,WAAW,CAAC,CAAC;AAClC,CAAC,CAAC;AAEF;;;;;;;GAOG;AACH,MAAM,mBAAmB,GAAG,KAAK,EAAE,gBAAwB,EAAE,EAAE;IAC9D,MAAM,EAAE,WAAW,EAAE,GAAG,WAAW,CAAC,gBAAgB,CAAC,CAAC;IAEtD,MAAM,qBAAqB,CAAC,gBAAgB,CAAC,CAAC;IAC9C,OAAO,QAAQ,CAAC,GAAG,CAAC,WAAW,CAAC,CAAC;AAClC,CAAC,CAAC;AAEF,OAAO,EACN,uBAAuB,EACvB,oBAAoB,EACpB,0BAA0B,EAC1B,0BAA0B,EAC1B,mBAAmB,GACnB,CAAC","sourcesContent":["import getSharedResource from \"../getSharedResource.js\";\nimport type { I18nText } from \"../i18nBundle.js\";\nimport { getTheme } from \"../config/Theme.js\";\nimport type { TemplateFunction } from \"../renderer/executeTemplate.js\";\n\n/**\n * Loader function for lazy-loading illustration data.\n */\ntype IllustrationLoader = (illustrationName: string) => Promise<UnsafeIllustrationData>;\n\n/**\n * Database properties shared by all illustration types.\n */\ntype IllustrationDatabase = {\n\t/** The illustration title text (supports i18n) */\n\ttitle: I18nText,\n\t/** The illustration subtitle text (supports i18n) */\n\tsubtitle: I18nText,\n};\n\n/**\n * Illustration properties using template functions (recommended).\n *\n * @public\n */\ntype IllustrationProperties = IllustrationDatabase & {\n\t/** Template function for the medium variant (M breakpoint, ≤ 681px) */\n\tdialogTemplate?: TemplateFunction,\n\t/** Template function for the large variant (L breakpoint, > 681px) */\n\tsceneTemplate?: TemplateFunction,\n\t/** Template function for the small variant (S breakpoint, ≤ 360px) */\n\tspotTemplate?: TemplateFunction,\n\t/** Template function for the extra small variant (XS breakpoint, ≤ 260px) */\n\tdotTemplate?: TemplateFunction,\n};\n\n/**\n * Illustration properties using raw SVG strings (unsafe).\n *\n * @public\n */\ntype UnsafeIllustrationProperties = IllustrationDatabase & {\n\t/** SVG content for the medium variant (M breakpoint, ≤ 681px) */\n\tdialogSvg: string,\n\t/** SVG content for the large variant (L breakpoint, > 681px) */\n\tsceneSvg: string,\n\t/** SVG content for the small variant (S breakpoint, ≤ 360px) */\n\tspotSvg: string,\n\t/** SVG content for the extra small variant (XS breakpoint, ≤ 260px) */\n\tdotSvg: string,\n};\n\n/**\n * Complete illustration data for registration (recommended).\n *\n * @public\n */\ntype IllustrationData = IllustrationProperties & {\n\t/** The illustration set identifier (e.g., \"custom\") */\n\tset: string,\n\t/** Collection identifier (defaults to \"V4\") */\n\tcollection?: string,\n};\n\n/**\n * Complete unsafe illustration data for registration.\n *\n * @public\n */\ntype UnsafeIllustrationData = UnsafeIllustrationProperties & {\n\t/** The illustration set identifier (e.g., \"custom\") */\n\tset: string,\n\t/** Collection identifier (defaults to \"V4\") */\n\tcollection?: string,\n};\n\nconst IllustrationCollections = new Map([\n\t[\"sap_horizon\", \"V5\"],\n\t[\"sap_horizon_dark\", \"V5\"],\n\t[\"sap_horizon_hcb\", \"V5/HC\"],\n\t[\"sap_horizon_hcw\", \"V5/HC\"],\n]);\n\nconst FALLBACK_COLLECTION = \"V4\";\n\nconst loaders = new Map<string, IllustrationLoader>();\nconst registry = getSharedResource<Map<string, IllustrationProperties | UnsafeIllustrationProperties>>(\"SVGIllustration.registry\", new Map());\nconst illustrationPromises = getSharedResource<Map<string, Promise<UnsafeIllustrationData>>>(\"SVGIllustration.promises\", new Map());\n\nconst getCollection = () => {\n\tconst theme = getTheme();\n\n\tif (IllustrationCollections.has(theme)) {\n\t\treturn IllustrationCollections.get(theme);\n\t}\n\n\treturn FALLBACK_COLLECTION;\n};\n\n/**\n * Processes the name of the illustration\n * The name is used to generate the registry key and the loader key\n * The registry key is used to store and get the illustration data from the registry\n * The loader key is used to store and get the illustration loader from the loaders map\n * The function generates the correct registry key and loader key based on whether an loader exists for the illustration\n * If there is no loader registered for the collection, it falls back to the default collection\n */\nconst processName = (name: string) => {\n\tlet collection = getCollection();\n\tconst [set, illustrationName] = name.split(\"/\");\n\tlet registryKey = `${set}/${collection}/${illustrationName}`;\n\n\tif (!loaders.has(registryKey) && collection !== FALLBACK_COLLECTION) {\n\t\tcollection = FALLBACK_COLLECTION;\n\t\tregistryKey = `${set}/${collection}/${illustrationName}`;\n\t}\n\n\treturn {\n\t\tregistryKey,\n\t\tcollection,\n\t};\n};\n\n/**\n * Registers a custom illustration in the global registry using template functions.\n *\n * This is the recommended way to register illustrations as it accepts template functions\n * instead of raw SVG strings, preventing XSS vulnerabilities.\n *\n * @param name - The name of the illustration (without set prefix)\n * @param data - The illustration data (see {@link IllustrationData})\n *\n * @public\n * @since 2.17.0\n * @example\n * ```js\n * import { registerIllustration } from \"@ui5/webcomponents-base/dist/asset-registries/Illustrations.js\";\n *\n * registerIllustration(\"EmptyCart\", {\n *   sceneTemplate: (component) => <svg>...</svg>,\n *   dialogTemplate: (component) => <svg>...</svg>,\n *   spotTemplate: (component) => <svg>...</svg>,\n *   dotTemplate: (component) => <svg>...</svg>,\n *   title: \"Your cart is empty\",\n *   subtitle: \"Add items to get started\",\n *   set: \"custom\"\n * });\n * ```\n */\nconst registerIllustration = (name: string, data: IllustrationData) => {\n\tconst collection = data.collection || FALLBACK_COLLECTION;\n\tregistry.set(`${data.set}/${collection}/${name}`, {\n\t\tdialogTemplate: data.dialogTemplate,\n\t\tsceneTemplate: data.sceneTemplate,\n\t\tspotTemplate: data.spotTemplate,\n\t\tdotTemplate: data.dotTemplate,\n\t\ttitle: data.title,\n\t\tsubtitle: data.subtitle,\n\t});\n};\n\n/**\n * Registers a custom illustration in the global registry.\n *\n * <b>Note:</b> This method is unsafe as it allows the SVG content to be passed as raw strings\n * through the `dialogSvg`, `sceneSvg`, `spotSvg`, and `dotSvg` properties of the `data`.\n * Ensure that the SVG content is properly validated.\n * Improperly sanitized SVG strings can lead to security vulnerabilities such as XSS (Cross-Site Scripting).\n *\n * @param name - The name of the illustration (without set prefix)\n * @param data - The illustration data (see {@link UnsafeIllustrationData})\n *\n * @public\n * @since 2.17.0\n * @example\n * ```js\n * import { unsafeRegisterIllustration } from \"@ui5/webcomponents-base/dist/asset-registries/Illustrations.js\";\n *\n * unsafeRegisterIllustration(\"EmptyCart\", {\n *   sceneSvg: \"<svg>...</svg>\",\n *   dialogSvg: \"<svg>...</svg>\",\n *   spotSvg: \"<svg>...</svg>\",\n *   dotSvg: \"<svg>...</svg>\",\n *   title: \"Your cart is empty\",\n *   subtitle: \"Add items to get started\",\n *   set: \"custom\"\n * });\n * ```\n */\nconst unsafeRegisterIllustration = (name: string, data: UnsafeIllustrationData) => {\n\tconst collection = data.collection || FALLBACK_COLLECTION;\n\tregistry.set(`${data.set}/${collection}/${name}`, {\n\t\tdialogSvg: data.dialogSvg,\n\t\tsceneSvg: data.sceneSvg,\n\t\tspotSvg: data.spotSvg,\n\t\tdotSvg: data.dotSvg,\n\t\ttitle: data.title,\n\t\tsubtitle: data.subtitle,\n\t});\n};\n\nconst registerIllustrationLoader = (illustrationName: string, loader: IllustrationLoader) => {\n\tloaders.set(illustrationName, loader);\n};\n\nconst _loadIllustrationOnce = (illustrationName: string) => {\n\tconst { registryKey } = processName(illustrationName);\n\tif (!illustrationPromises.has(registryKey)) {\n\t\tif (!loaders.has(registryKey)) {\n\t\t\tconst illustrationPath = illustrationName.startsWith(\"fiori/\") ? illustrationName.replace(\"fiori/\", \"\") : illustrationName;\n\t\t\tthrow new Error(`No loader registered for the ${illustrationName} illustration. Probably you forgot to import the \"@ui5/webcomponents-fiori/dist/illustrations/${illustrationPath}.js\" module. Or you can import the \"@ui5/webcomponents-fiori/dist/illustrations/AllIllustrations.js\" module that will make all illustrations available, but fetch only the ones used.`);\n\t\t}\n\n\t\tconst loadIllustrations = loaders.get(registryKey)!;\n\t\tillustrationPromises.set(registryKey, loadIllustrations(registryKey));\n\t}\n\treturn illustrationPromises.get(registryKey);\n};\n\n/**\n * Synchronously retrieves illustration data from the registry.\n *\n * @param illustrationName - The illustration identifier in format \"set/name\"\n * @returns The illustration properties or undefined if not available\n *\n * @public\n */\nconst getIllustrationDataSync = (illustrationName: string) => {\n\tconst { registryKey } = processName(illustrationName);\n\treturn registry.get(registryKey);\n};\n\n/**\n * Asynchronously retrieves illustration data, loading it if necessary.\n *\n * @param illustrationName - The illustration identifier in format \"set/name\"\n * @returns Promise resolving to illustration properties or undefined\n *\n * @public\n */\nconst getIllustrationData = async (illustrationName: string) => {\n\tconst { registryKey } = processName(illustrationName);\n\n\tawait _loadIllustrationOnce(illustrationName);\n\treturn registry.get(registryKey);\n};\n\nexport {\n\tgetIllustrationDataSync,\n\tregisterIllustration,\n\tunsafeRegisterIllustration,\n\tregisterIllustrationLoader,\n\tgetIllustrationData,\n};\n\nexport type {\n\tIllustrationData,\n\tUnsafeIllustrationData,\n\tIllustrationProperties,\n\tUnsafeIllustrationProperties,\n};\n"]}

package/dist/asset-registries/LocaleData.d.ts

@@ -0,0 +1,7 @@
+type LocaleDataLoader = (locale: string) => Promise<CLDRData>;
+type CLDRData = Record<string, object | boolean | string>;
+declare const getLocaleData: (localeId: string) => CLDRData;
+declare const fetchCldr: (language: string, region: string, script: string) => Promise<void>;
+declare const registerLocaleDataLoader: (localeId: string, loader: LocaleDataLoader) => void;
+export { registerLocaleDataLoader, fetchCldr, getLocaleData, };
+export type { CLDRData, };

package/dist/asset-registries/LocaleData.js

@@ -0,0 +1,137 @@
+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 _showAssetsWarningOnce = (localeId) => {
+    if (warningShown) {
+        return;
+    }
+    console.warn(`[LocaleData] Supported locale "${localeId}" not configured, import the "Assets.js" module from the webcomponents package you are using.`); /* 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) => {
+    if (!cldrPromises.get(localeId)) {
+        const loadCldr = loaders.get(localeId);
+        if (!loadCldr) {
+            throw new Error(`CLDR data for locale ${localeId} is not loaded!`);
+        }
+        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 (error) {
+        const e = error;
+        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 () => {
+    console.warn(`[LocaleData] Falling back to loading "en" locale data from CDN.`, /* eslint-disable-line */ `For production usage, please configure locale data loading via the "Assets.js" module of the webcomponents package you are using.`); /* eslint-disable-line */
+    const cldrContent = await fetch(`https://cdn.jsdelivr.net/npm/@openui5/sap.ui.core@1.120.17/src/sap/ui/core/cldr/en.json`);
+    return cldrContent.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, };
+//# sourceMappingURL=LocaleData.js.map

package/dist/asset-registries/LocaleData.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"LocaleData.js","sourceRoot":"","sources":["../../src/asset-registries/LocaleData.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,oBAAoB,EAAE,MAAM,6BAA6B,CAAC;AACnE,OAAO,SAAS,MAAM,wBAAwB,CAAC;AAC/C,OAAO,EAAE,cAAc,EAAE,iBAAiB,EAAE,MAAM,iCAAiC,CAAC;AACpF,OAAO,EAAE,UAAU,EAAE,MAAM,wBAAwB,CAAC;AAMpD,MAAM,aAAa,GAAG,IAAI,GAAG,EAAoB,CAAC;AAClD,MAAM,OAAO,GAAG,IAAI,GAAG,EAA4B,CAAC;AACpD,MAAM,YAAY,GAAG,IAAI,GAAG,EAA6B,CAAC;AAC1D,MAAM,cAAc,GAAG,IAAI,GAAG,EAAU,CAAC;AACzC,IAAI,YAAY,GAAG,KAAK,CAAC;AAEzB,MAAM,mBAAmB,GAAG;IAC3B,IAAI,EAAE,IAAI;IACV,IAAI,EAAE,IAAI;IACV,IAAI,EAAE,IAAI;CACV,CAAC;AAEF,MAAM,sBAAsB,GAAG,CAAC,QAAgB,EAAE,EAAE;IACnD,IAAI,YAAY,EAAE,CAAC;QAClB,OAAO;IACR,CAAC;IAED,OAAO,CAAC,IAAI,CAAC,kCAAkC,QAAQ,+FAA+F,CAAC,CAAC,CAAC,yBAAyB;IAElL,YAAY,GAAG,IAAI,CAAC;AACrB,CAAC,CAAC;AAEF,MAAM,UAAU,GAAG,CAAC,QAAgB,EAAE,MAAc,EAAE,MAAc,EAAE,EAAE;IACvE,8CAA8C;IAC9C,QAAQ,GAAG,CAAC,QAAQ,IAAI,mBAAmB,CAAC,QAA4C,CAAC,CAAC,IAAI,QAAQ,CAAC;IACvG,2GAA2G;IAC3G,IAAI,QAAQ,KAAK,IAAI,EAAE,CAAC;QACvB,QAAQ,GAAG,IAAI,CAAC;IACjB,CAAC;IACD,8GAA8G;IAC9G,IAAI,QAAQ,KAAK,IAAI,IAAI,CAAC,MAAM,EAAE,CAAC;QAClC,IAAI,MAAM,KAAK,MAAM,EAAE,CAAC;YACvB,MAAM,GAAG,IAAI,CAAC;QACf,CAAC;aAAM,IAAI,MAAM,KAAK,MAAM,EAAE,CAAC;YAC9B,MAAM,GAAG,IAAI,CAAC;QACf,CAAC;IACF,CAAC;IAED,+HAA+H;IAC/H,IAAI,QAAQ,KAAK,IAAI,IAAI,CAAC,QAAQ,KAAK,IAAI,IAAI,MAAM,KAAK,MAAM,CAAC,EAAE,CAAC;QACnE,QAAQ,GAAG,IAAI,CAAC;QAChB,MAAM,GAAG,MAAM,CAAC;IACjB,CAAC;IAED,wBAAwB;IACxB,IAAI,QAAQ,GAAG,GAAG,QAAQ,IAAI,MAAM,EAAE,CAAC;IACvC,IAAI,iBAAiB,CAAC,QAAQ,CAAC,QAAQ,CAAC,EAAE,CAAC;QAC1C,IAAI,OAAO,CAAC,GAAG,CAAC,QAAQ,CAAC,EAAE,CAAC;YAC3B,2BAA2B;YAC3B,OAAO,QAAQ,CAAC;QACjB,CAAC;QAED,sDAAsD;QACtD,sBAAsB,CAAC,QAAQ,CAAC,CAAC;QACjC,OAAO,cAAc,CAAC;IACvB,CAAC;IAED,mCAAmC;IACnC,QAAQ,GAAG,QAAQ,CAAC;IACpB,IAAI,iBAAiB,CAAC,QAAQ,CAAC,QAAQ,CAAC,EAAE,CAAC;QAC1C,IAAI,OAAO,CAAC,GAAG,CAAC,QAAQ,CAAC,EAAE,CAAC;YAC3B,2BAA2B;YAC3B,OAAO,QAAQ,CAAC;QACjB,CAAC;QAED,sDAAsD;QACtD,sBAAsB,CAAC,QAAQ,CAAC,CAAC;QACjC,OAAO,cAAc,CAAC;IACvB,CAAC;IAED,6CAA6C;IAC7C,OAAO,cAAc,CAAC;AACvB,CAAC,CAAC;AAEF,oBAAoB;AACpB,MAAM,aAAa,GAAG,CAAC,QAAgB,EAAE,OAAiB,EAAE,EAAE;IAC7D,aAAa,CAAC,GAAG,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC;AACtC,CAAC,CAAC;AAEF,mBAAmB;AACnB,MAAM,aAAa,GAAG,CAAC,QAAgB,EAAE,EAAE;IAC1C,+GAA+G;IAC/G,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,QAAQ,CAAC,EAAE,CAAC;QAC5B,QAAQ,GAAG,cAAc,CAAC;IAC3B,CAAC;IAED,MAAM,OAAO,GAAG,aAAa,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;IAC5C,IAAI,CAAC,OAAO,EAAE,CAAC;QACd,MAAM,IAAI,KAAK,CAAC,wBAAwB,QAAQ,iBAAiB,CAAC,CAAC;IACpE,CAAC;IAED,OAAO,OAAO,CAAC;AAChB,CAAC,CAAC;AAEF,oCAAoC;AACpC,MAAM,aAAa,GAAG,CAAC,QAAgB,EAAE,EAAE;IAC1C,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,QAAQ,CAAC,EAAE,CAAC;QACjC,MAAM,QAAQ,GAAG,OAAO,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;QAEvC,IAAI,CAAC,QAAQ,EAAE,CAAC;YACf,MAAM,IAAI,KAAK,CAAC,wBAAwB,QAAQ,iBAAiB,CAAC,CAAC;QACpE,CAAC;QAED,YAAY,CAAC,GAAG,CAAC,QAAQ,EAAE,QAAQ,CAAC,QAAQ,CAAC,CAAC,CAAC;IAChD,CAAC;IAED,OAAO,YAAY,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;AACnC,CAAC,CAAC;AAEF,oBAAoB;AACpB,MAAM,SAAS,GAAG,KAAK,EAAE,QAAgB,EAAE,MAAc,EAAE,MAAc,EAAE,EAAE;IAC5E,MAAM,QAAQ,GAAG,UAAU,CAAC,QAAQ,EAAE,MAAM,EAAE,MAAM,CAAC,CAAC;IAEtD,gCAAgC;IAChC,MAAM,cAAc,GAAG,UAAU,CAAwB,gBAAgB,CAAC,CAAC;IAC3E,IAAI,cAAc,EAAE,CAAC;QACpB,MAAM,WAAW,GAAG,cAAc,CAAC,mBAAmB,EAAE,CAAC;QACzD,IAAI,WAAW,EAAE,CAAC;YACjB,kDAAkD;YAClD,aAAa,CAAC,QAAQ,EAAE,WAAW,CAAC,CAAC;YACrC,OAAO;QACR,CAAC;IACF,CAAC;IAED,WAAW;IACX,IAAI,CAAC;QACJ,MAAM,WAAW,GAAG,MAAM,aAAa,CAAC,QAAQ,CAAC,CAAC;QAClD,aAAa,CAAC,QAAQ,EAAE,WAAuB,CAAC,CAAC;IAClD,CAAC;IAAC,OAAO,KAAc,EAAE,CAAC;QACzB,MAAM,CAAC,GAAG,KAAc,CAAC;QACzB,IAAI,CAAC,cAAc,CAAC,GAAG,CAAC,CAAC,CAAC,OAAO,CAAC,EAAE,CAAC;YACpC,cAAc,CAAC,GAAG,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC;YAC9B,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,yBAAyB;QACpD,CAAC;IACF,CAAC;AACF,CAAC,CAAC;AAEF,MAAM,wBAAwB,GAAG,CAAC,QAAgB,EAAE,MAAwB,EAAE,EAAE;IAC/E,OAAO,CAAC,GAAG,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAC;AAC/B,CAAC,CAAC;AAEF,8EAA8E;AAC9E,wBAAwB,CAAC,IAAI,EAAE,KAAK,IAAI,EAAE;IACzC,OAAO,CAAC,IAAI,CAAC,iEAAiE,EAAE,yBAAyB,CACxG,mIAAmI,CAAC,CAAC,CAAC,yBAAyB;IAChK,MAAM,WAAW,GAAG,MAAM,KAAK,CAAC,yFAAyF,CAAC,CAAC;IAC3H,OAAO,WAAW,CAAC,IAAI,EAAuB,CAAC;AAChD,CAAC,CAAC,CAAC;AAEH,sEAAsE;AACtE,mCAAmC;AACnC,oBAAoB,CAAC,GAAG,EAAE;IACzB,MAAM,MAAM,GAAG,SAAS,EAAE,CAAC;IAC3B,OAAO,SAAS,CAAC,MAAM,CAAC,WAAW,EAAE,EAAE,MAAM,CAAC,SAAS,EAAE,EAAE,MAAM,CAAC,SAAS,EAAE,CAAC,CAAC;AAChF,CAAC,CAAC,CAAC;AAEH,OAAO,EACN,wBAAwB,EACxB,SAAS,EACT,aAAa,GACb,CAAC","sourcesContent":["import { attachLanguageChange } from \"../locale/languageChange.js\";\nimport getLocale from \"../locale/getLocale.js\";\nimport { DEFAULT_LOCALE, SUPPORTED_LOCALES } from \"../generated/AssetParameters.js\";\nimport { getFeature } from \"../FeaturesRegistry.js\";\nimport type OpenUI5Support from \"../features/OpenUI5Support.js\";\n\ntype LocaleDataLoader = (locale: string) => Promise<CLDRData>;\ntype CLDRData = Record<string, object | boolean | string>;\n\nconst localeDataMap = new Map<string, CLDRData>();\nconst loaders = new Map<string, LocaleDataLoader>();\nconst cldrPromises = new Map<string, Promise<CLDRData>>();\nconst reportedErrors = new Set<string>();\nlet warningShown = false;\n\nconst M_ISO639_OLD_TO_NEW = {\n\t\"iw\": \"he\",\n\t\"ji\": \"yi\",\n\t\"in\": \"id\",\n};\n\nconst _showAssetsWarningOnce = (localeId: string) => {\n\tif (warningShown) {\n\t\treturn;\n\t}\n\n\tconsole.warn(`[LocaleData] Supported locale \"${localeId}\" not configured, import the \"Assets.js\" module from the webcomponents package you are using.`); /* eslint-disable-line */\n\n\twarningShown = true;\n};\n\nconst calcLocale = (language: string, region: string, script: string) => {\n\t// normalize language and handle special cases\n\tlanguage = (language && M_ISO639_OLD_TO_NEW[language as keyof typeof M_ISO639_OLD_TO_NEW]) || language;\n\t// Special case 1: in an SAP context, the inclusive language code \"no\" always means Norwegian Bokmal (\"nb\")\n\tif (language === \"no\") {\n\t\tlanguage = \"nb\";\n\t}\n\t// Special case 2: for Chinese, derive a default region from the script (this behavior is inherited from Java)\n\tif (language === \"zh\" && !region) {\n\t\tif (script === \"Hans\") {\n\t\t\tregion = \"CN\";\n\t\t} else if (script === \"Hant\") {\n\t\t\tregion = \"TW\";\n\t\t}\n\t}\n\n\t// Special case 3: for Serbian, there are cyrillic and latin scripts, \"sh\" and \"sr-latn\" map to \"latin\", \"sr\" maps to cyrillic.\n\tif (language === \"sh\" || (language === \"sr\" && script === \"Latn\")) {\n\t\tlanguage = \"sr\";\n\t\tregion = \"Latn\";\n\t}\n\n\t// try language + region\n\tlet localeId = `${language}_${region}`;\n\tif (SUPPORTED_LOCALES.includes(localeId)) {\n\t\tif (loaders.has(localeId)) {\n\t\t\t// supported and has loader\n\t\t\treturn localeId;\n\t\t}\n\n\t\t// supported, no loader - fallback to default and warn\n\t\t_showAssetsWarningOnce(localeId);\n\t\treturn DEFAULT_LOCALE;\n\t}\n\n\t// not supported, try language only\n\tlocaleId = language;\n\tif (SUPPORTED_LOCALES.includes(localeId)) {\n\t\tif (loaders.has(localeId)) {\n\t\t\t// supported and has loader\n\t\t\treturn localeId;\n\t\t}\n\n\t\t// supported, no loader - fallback to default and warn\n\t\t_showAssetsWarningOnce(localeId);\n\t\treturn DEFAULT_LOCALE;\n\t}\n\n\t// not supported - fallback to default locale\n\treturn DEFAULT_LOCALE;\n};\n\n// internal set data\nconst setLocaleData = (localeId: string, content: CLDRData) => {\n\tlocaleDataMap.set(localeId, content);\n};\n\n// external getSync\nconst getLocaleData = (localeId: string) => {\n\t// if there is no loader, the default fallback was fetched and a warning was given - use default locale instead\n\tif (!loaders.has(localeId)) {\n\t\tlocaleId = DEFAULT_LOCALE;\n\t}\n\n\tconst content = localeDataMap.get(localeId);\n\tif (!content) {\n\t\tthrow new Error(`CLDR data for locale ${localeId} is not loaded!`);\n\t}\n\n\treturn content;\n};\n\n// load bundle over the network once\nconst _loadCldrOnce = (localeId: string) => {\n\tif (!cldrPromises.get(localeId)) {\n\t\tconst loadCldr = loaders.get(localeId);\n\n\t\tif (!loadCldr) {\n\t\t\tthrow new Error(`CLDR data for locale ${localeId} is not loaded!`);\n\t\t}\n\n\t\tcldrPromises.set(localeId, loadCldr(localeId));\n\t}\n\n\treturn cldrPromises.get(localeId);\n};\n\n// external getAsync\nconst fetchCldr = async (language: string, region: string, script: string) => {\n\tconst localeId = calcLocale(language, region, script);\n\n\t// reuse OpenUI5 CLDR if present\n\tconst openUI5Support = getFeature<typeof OpenUI5Support>(\"OpenUI5Support\");\n\tif (openUI5Support) {\n\t\tconst cldrContent = openUI5Support.getLocaleDataObject();\n\t\tif (cldrContent) {\n\t\t\t// only if openui5 actually returned valid content\n\t\t\tsetLocaleData(localeId, cldrContent);\n\t\t\treturn;\n\t\t}\n\t}\n\n\t// fetch it\n\ttry {\n\t\tconst cldrContent = await _loadCldrOnce(localeId);\n\t\tsetLocaleData(localeId, cldrContent as CLDRData);\n\t} catch (error: unknown) {\n\t\tconst e = error as Error;\n\t\tif (!reportedErrors.has(e.message)) {\n\t\t\treportedErrors.add(e.message);\n\t\t\tconsole.error(e.message); /* eslint-disable-line */\n\t\t}\n\t}\n};\n\nconst registerLocaleDataLoader = (localeId: string, loader: LocaleDataLoader) => {\n\tloaders.set(localeId, loader);\n};\n\n// register default loader for \"en\" from ui5 CDN (dev workflow without assets)\nregisterLocaleDataLoader(\"en\", async () => {\n\tconsole.warn(`[LocaleData] Falling back to loading \"en\" locale data from CDN.`, /* eslint-disable-line */\n\t\t`For production usage, please configure locale data loading via the \"Assets.js\" module of the webcomponents package you are using.`); /* eslint-disable-line */\n\tconst cldrContent = await fetch(`https://cdn.jsdelivr.net/npm/@openui5/sap.ui.core@1.120.17/src/sap/ui/core/cldr/en.json`);\n\treturn cldrContent.json() as Promise<CLDRData>;\n});\n\n// When the language changes dynamically (the user calls setLanguage),\n// re-fetch the required CDRD data.\nattachLanguageChange(() => {\n\tconst locale = getLocale();\n\treturn fetchCldr(locale.getLanguage(), locale.getRegion(), locale.getScript());\n});\n\nexport {\n\tregisterLocaleDataLoader,\n\tfetchCldr,\n\tgetLocaleData,\n};\n\nexport type {\n\tCLDRData,\n};\n"]}

package/dist/asset-registries/Themes.d.ts

@@ -0,0 +1,12 @@
+type ThemeData = string;
+type ThemeLoader = (themeName: string) => Promise<string>;
+type CSSVariablesTarget = "root" | "host";
+declare const registerThemePropertiesLoader: (packageName: string, themeName: string, loader: ThemeLoader, cssVariablesTarget?: CSSVariablesTarget) => void;
+declare const registerCustomThemePropertiesLoader: (packageName: string, themeName: string, loader: ThemeLoader) => void;
+declare const getThemeProperties: (packageName: string, themeName: string, externalThemeName?: string) => Promise<string | undefined>;
+declare const getRegisteredPackages: () => Map<string, {
+    cssVariablesTarget: CSSVariablesTarget;
+}>;
+declare const isThemeRegistered: (theme: string) => boolean;
+export { registerThemePropertiesLoader, registerCustomThemePropertiesLoader, getThemeProperties, getRegisteredPackages, isThemeRegistered, };
+export type { ThemeData, ThemeLoader, };

package/dist/asset-registries/Themes.js

@@ -0,0 +1,67 @@
+import { DEFAULT_THEME } from "../generated/AssetParameters.js";
+import { mergeStyles } from "../ManagedStyles.js";
+import { fireThemeRegistered } from "../theming/ThemeRegistered.js";
+const themeStyles = new Map();
+const loaders = new Map();
+const customLoaders = new Map();
+const registeredPackages = new Map();
+const registeredThemes = new Set();
+const registerThemePropertiesLoader = (packageName, themeName, loader, cssVariablesTarget = "root") => {
+    loaders.set(`${packageName}/${themeName}`, loader);
+    registeredPackages.set(packageName, { cssVariablesTarget });
+    registeredThemes.add(themeName);
+    fireThemeRegistered(themeName);
+};
+const registerCustomThemePropertiesLoader = (packageName, themeName, loader) => {
+    customLoaders.set(`${packageName}/${themeName}`, loader);
+};
+const getThemeProperties = async (packageName, themeName, externalThemeName) => {
+    const cacheKey = `${packageName}_${themeName}_${externalThemeName || ""}`;
+    const cachedStyleData = themeStyles.get(cacheKey);
+    if (cachedStyleData !== undefined) { // it's valid for style to be an empty string
+        return cachedStyleData;
+    }
+    if (!registeredThemes.has(themeName)) {
+        const regThemesStr = [...registeredThemes.values()].join(", ");
+        console.warn(`You have requested a non-registered theme ${themeName} - falling back to ${DEFAULT_THEME}. Registered themes are: ${regThemesStr}`); /* eslint-disable-line */
+        return _getThemeProperties(packageName, DEFAULT_THEME);
+    }
+    const [style, customStyle] = await Promise.all([
+        _getThemeProperties(packageName, themeName),
+        externalThemeName ? _getThemeProperties(packageName, externalThemeName, true) : undefined,
+    ]);
+    const styleData = mergeStyles(style, customStyle);
+    if (styleData) {
+        themeStyles.set(cacheKey, styleData);
+    }
+    return styleData;
+};
+const _getThemeProperties = async (packageName, themeName, forCustomTheme = false) => {
+    const loadersMap = forCustomTheme ? customLoaders : loaders;
+    const loader = loadersMap.get(`${packageName}/${themeName}`);
+    if (!loader) {
+        // no themes for package
+        if (!forCustomTheme) {
+            console.error(`Theme [${themeName}] not registered for package [${packageName}]`); /* eslint-disable-line */
+        }
+        return;
+    }
+    let data;
+    try {
+        data = await loader(themeName);
+    }
+    catch (error) {
+        const e = error;
+        console.error(packageName, e.message); /* eslint-disable-line */
+        return;
+    }
+    return data;
+};
+const getRegisteredPackages = () => {
+    return registeredPackages;
+};
+const isThemeRegistered = (theme) => {
+    return registeredThemes.has(theme);
+};
+export { registerThemePropertiesLoader, registerCustomThemePropertiesLoader, getThemeProperties, getRegisteredPackages, isThemeRegistered, };
+//# sourceMappingURL=Themes.js.map

package/dist/asset-registries/Themes.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Themes.js","sourceRoot":"","sources":["../../src/asset-registries/Themes.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,iCAAiC,CAAC;AAChE,OAAO,EAAE,WAAW,EAAE,MAAM,qBAAqB,CAAC;AAClD,OAAO,EAAE,mBAAmB,EAAE,MAAM,+BAA+B,CAAC;AAOpE,MAAM,WAAW,GAAG,IAAI,GAAG,EAAkB,CAAC;AAC9C,MAAM,OAAO,GAAG,IAAI,GAAG,EAAuB,CAAC;AAC/C,MAAM,aAAa,GAAG,IAAI,GAAG,EAAuB,CAAC;AACrD,MAAM,kBAAkB,GAAG,IAAI,GAAG,EAAsD,CAAC;AACzF,MAAM,gBAAgB,GAAG,IAAI,GAAG,EAAU,CAAC;AAE3C,MAAM,6BAA6B,GAAG,CAAC,WAAmB,EAAE,SAAiB,EAAE,MAAmB,EAAE,qBAAyC,MAAM,EAAE,EAAE;IACtJ,OAAO,CAAC,GAAG,CAAC,GAAG,WAAW,IAAI,SAAS,EAAE,EAAE,MAAM,CAAC,CAAC;IACnD,kBAAkB,CAAC,GAAG,CAAC,WAAW,EAAE,EAAE,kBAAkB,EAAE,CAAC,CAAC;IAC5D,gBAAgB,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC;IAChC,mBAAmB,CAAC,SAAS,CAAC,CAAC;AAChC,CAAC,CAAC;AAEF,MAAM,mCAAmC,GAAG,CAAC,WAAmB,EAAE,SAAiB,EAAE,MAAmB,EAAE,EAAE;IAC3G,aAAa,CAAC,GAAG,CAAC,GAAG,WAAW,IAAI,SAAS,EAAE,EAAE,MAAM,CAAC,CAAC;AAC1D,CAAC,CAAC;AAEF,MAAM,kBAAkB,GAAG,KAAK,EAAE,WAAmB,EAAE,SAAiB,EAAE,iBAA0B,EAAE,EAAE;IACvG,MAAM,QAAQ,GAAG,GAAG,WAAW,IAAI,SAAS,IAAI,iBAAiB,IAAI,EAAE,EAAE,CAAC;IAC1E,MAAM,eAAe,GAAG,WAAW,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;IAClD,IAAI,eAAe,KAAK,SAAS,EAAE,CAAC,CAAC,6CAA6C;QACjF,OAAO,eAAe,CAAC;IACxB,CAAC;IAED,IAAI,CAAC,gBAAgB,CAAC,GAAG,CAAC,SAAS,CAAC,EAAE,CAAC;QACtC,MAAM,YAAY,GAAG,CAAC,GAAG,gBAAgB,CAAC,MAAM,EAAE,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAC/D,OAAO,CAAC,IAAI,CAAC,6CAA6C,SAAS,sBAAsB,aAAa,4BAA4B,YAAY,EAAE,CAAC,CAAC,CAAC,yBAAyB;QAC5K,OAAO,mBAAmB,CAAC,WAAW,EAAE,aAAa,CAAC,CAAC;IACxD,CAAC;IAED,MAAM,CAAC,KAAK,EAAE,WAAW,CAAC,GAAG,MAAM,OAAO,CAAC,GAAG,CAAC;QAC9C,mBAAmB,CAAC,WAAW,EAAE,SAAS,CAAC;QAC3C,iBAAiB,CAAC,CAAC,CAAC,mBAAmB,CAAC,WAAW,EAAE,iBAAiB,EAAE,IAAI,CAAC,CAAC,CAAC,CAAC,SAAS;KACzF,CAAC,CAAC;IAEH,MAAM,SAAS,GAAG,WAAW,CAAC,KAAK,EAAE,WAAW,CAAC,CAAC;IAClD,IAAI,SAAS,EAAE,CAAC;QACf,WAAW,CAAC,GAAG,CAAC,QAAQ,EAAE,SAAS,CAAC,CAAC;IACtC,CAAC;IAED,OAAO,SAAS,CAAC;AAClB,CAAC,CAAC;AAEF,MAAM,mBAAmB,GAAG,KAAK,EAAE,WAAmB,EAAE,SAAiB,EAAE,cAAc,GAAG,KAAK,EAAE,EAAE;IACpG,MAAM,UAAU,GAAG,cAAc,CAAC,CAAC,CAAC,aAAa,CAAC,CAAC,CAAC,OAAO,CAAC;IAC5D,MAAM,MAAM,GAAG,UAAU,CAAC,GAAG,CAAC,GAAG,WAAW,IAAI,SAAS,EAAE,CAAC,CAAC;IAC7D,IAAI,CAAC,MAAM,EAAE,CAAC;QACb,wBAAwB;QACxB,IAAI,CAAC,cAAc,EAAE,CAAC;YACrB,OAAO,CAAC,KAAK,CAAC,UAAU,SAAS,iCAAiC,WAAW,GAAG,CAAC,CAAC,CAAC,yBAAyB;QAC7G,CAAC;QACD,OAAO;IACR,CAAC;IACD,IAAI,IAAI,CAAC;IACT,IAAI,CAAC;QACJ,IAAI,GAAG,MAAM,MAAM,CAAC,SAAS,CAAC,CAAC;IAChC,CAAC;IAAC,OAAO,KAAc,EAAE,CAAC;QACzB,MAAM,CAAC,GAAG,KAAc,CAAC;QACzB,OAAO,CAAC,KAAK,CAAC,WAAW,EAAE,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,yBAAyB;QAChE,OAAO;IACR,CAAC;IAED,OAAO,IAAI,CAAC;AACb,CAAC,CAAC;AAEF,MAAM,qBAAqB,GAAG,GAAG,EAAE;IAClC,OAAO,kBAAkB,CAAC;AAC3B,CAAC,CAAC;AAEF,MAAM,iBAAiB,GAAG,CAAC,KAAa,EAAE,EAAE;IAC3C,OAAO,gBAAgB,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;AACpC,CAAC,CAAC;AAEF,OAAO,EACN,6BAA6B,EAC7B,mCAAmC,EACnC,kBAAkB,EAClB,qBAAqB,EACrB,iBAAiB,GACjB,CAAC","sourcesContent":["import { DEFAULT_THEME } from \"../generated/AssetParameters.js\";\nimport { mergeStyles } from \"../ManagedStyles.js\";\nimport { fireThemeRegistered } from \"../theming/ThemeRegistered.js\";\n\ntype ThemeData = string;\ntype ThemeLoader = (themeName: string) => Promise<string>;\n\ntype CSSVariablesTarget = \"root\" | \"host\";\n\nconst themeStyles = new Map<string, string>();\nconst loaders = new Map<string, ThemeLoader>();\nconst customLoaders = new Map<string, ThemeLoader>();\nconst registeredPackages = new Map<string, { cssVariablesTarget: CSSVariablesTarget }>();\nconst registeredThemes = new Set<string>();\n\nconst registerThemePropertiesLoader = (packageName: string, themeName: string, loader: ThemeLoader, cssVariablesTarget: CSSVariablesTarget = \"root\") => {\n\tloaders.set(`${packageName}/${themeName}`, loader);\n\tregisteredPackages.set(packageName, { cssVariablesTarget });\n\tregisteredThemes.add(themeName);\n\tfireThemeRegistered(themeName);\n};\n\nconst registerCustomThemePropertiesLoader = (packageName: string, themeName: string, loader: ThemeLoader) => {\n\tcustomLoaders.set(`${packageName}/${themeName}`, loader);\n};\n\nconst getThemeProperties = async (packageName: string, themeName: string, externalThemeName?: string) => {\n\tconst cacheKey = `${packageName}_${themeName}_${externalThemeName || \"\"}`;\n\tconst cachedStyleData = themeStyles.get(cacheKey);\n\tif (cachedStyleData !== undefined) { // it's valid for style to be an empty string\n\t\treturn cachedStyleData;\n\t}\n\n\tif (!registeredThemes.has(themeName)) {\n\t\tconst regThemesStr = [...registeredThemes.values()].join(\", \");\n\t\tconsole.warn(`You have requested a non-registered theme ${themeName} - falling back to ${DEFAULT_THEME}. Registered themes are: ${regThemesStr}`); /* eslint-disable-line */\n\t\treturn _getThemeProperties(packageName, DEFAULT_THEME);\n\t}\n\n\tconst [style, customStyle] = await Promise.all([\n\t\t_getThemeProperties(packageName, themeName),\n\t\texternalThemeName ? _getThemeProperties(packageName, externalThemeName, true) : undefined,\n\t]);\n\n\tconst styleData = mergeStyles(style, customStyle);\n\tif (styleData) {\n\t\tthemeStyles.set(cacheKey, styleData);\n\t}\n\n\treturn styleData;\n};\n\nconst _getThemeProperties = async (packageName: string, themeName: string, forCustomTheme = false) => {\n\tconst loadersMap = forCustomTheme ? customLoaders : loaders;\n\tconst loader = loadersMap.get(`${packageName}/${themeName}`);\n\tif (!loader) {\n\t\t// no themes for package\n\t\tif (!forCustomTheme) {\n\t\t\tconsole.error(`Theme [${themeName}] not registered for package [${packageName}]`); /* eslint-disable-line */\n\t\t}\n\t\treturn;\n\t}\n\tlet data;\n\ttry {\n\t\tdata = await loader(themeName);\n\t} catch (error: unknown) {\n\t\tconst e = error as Error;\n\t\tconsole.error(packageName, e.message); /* eslint-disable-line */\n\t\treturn;\n\t}\n\n\treturn data;\n};\n\nconst getRegisteredPackages = () => {\n\treturn registeredPackages;\n};\n\nconst isThemeRegistered = (theme: string) => {\n\treturn registeredThemes.has(theme);\n};\n\nexport {\n\tregisterThemePropertiesLoader,\n\tregisterCustomThemePropertiesLoader,\n\tgetThemeProperties,\n\tgetRegisteredPackages,\n\tisThemeRegistered,\n};\n\nexport type {\n\tThemeData,\n\tThemeLoader,\n};\n"]}

package/dist/asset-registries/i18n.d.ts

@@ -0,0 +1,23 @@
+type I18nLoader = (localeId: string) => Promise<I18nData>;
+type I18nData = Record<string, string>;
+/**
+ * Registers i18n loader function for given package and locale.
+ *
+ * @public
+ * @param {string} packageName for which package this loader can fetch data
+ * @param {string} localeId locale that this loader can handle
+ * @param {function} loader async function that will be passed a localeId and should return a JSON object
+ */
+declare const registerI18nLoader: (packageName: string, localeId: string, loader: I18nLoader) => void;
+declare const getI18nBundleData: (packageName: string) => I18nData | null | undefined;
+/**
+ * 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 `registerI18nBundle` method.
+ * To simplify the usage, the synchronization of both methods happens internally for the same `bundleId`
+ * @param {packageName} packageName the NPM package name
+ * @public
+ */
+declare const fetchI18nBundle: (packageName: string) => Promise<void>;
+export { registerI18nLoader, fetchI18nBundle, getI18nBundleData, };