@pega/cosmos-react-core 2.0.0-dev.14.3 → 2.0.0-dev.15.0

package/lib/i18n/i18n.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"i18n.d.ts","sourceRoot":"","sources":["../../src/i18n/i18n.ts"],"names":[],"mappings":"AAAA,OAAO,kBAAkB,MAAM,gBAAgB,CAAC;AAEhD,oBAAY,eAAe,GAAG,QAAQ,CAAC,OAAO,kBAAkB,CAAC,CAAC;AAClE,oBAAY,WAAW,GAAG,OAAO,CAAC,OAAO,kBAAkB,CAAC,CAAC;AAE7D,QAAA,MAAM,MAAM;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;mBAAiC,SAAS,eAAe,CAEpE,CAAC;AACF,eAAe,MAAM,CAAC;AAEtB,eAAO,MAAM,kBAAkB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAAW,CAAC;AAiB3C,eAAO,MAAM,SAAS,cAAe,MAAM,KAAG,KAAK,GAAG,KAErD,CAAC"}
+{"version":3,"file":"i18n.d.ts","sourceRoot":"","sources":["../../src/i18n/i18n.ts"],"names":[],"mappings":"AAAA,OAAO,kBAAkB,MAAM,gBAAgB,CAAC;AAEhD,oBAAY,eAAe,GAAG,QAAQ,CAAC,OAAO,kBAAkB,CAAC,CAAC;AAClE,oBAAY,WAAW,GAAG,OAAO,CAAC,OAAO,kBAAkB,CAAC,CAAC;AAE7D,QAAA,MAAM,MAAM;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;mBAAiC,SAAS,eAAe,CAEpE,CAAC;AACF,eAAe,MAAM,CAAC;AAEtB,eAAO,MAAM,kBAAkB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAAW,CAAC;AAiB3C,eAAO,MAAM,SAAS,cAAe,MAAM,KAAG,KAAK,GAAG,KAErD,CAAC"}

package/lib/i18n/translate.d.ts

@@ -1,8 +1,33 @@
+import { ReactFragment } from 'react';
 import type { ReactChild, ReactText } from 'react';
-export interface TranslationFunction<T extends Record<string, string>> {
-    (literal: keyof T, ...tokens: ReactText[]): string;
-    (literal: keyof T, ...tokens: ReactChild[]): ReactChild[];
+declare type TranslationTemplate = string | Record<Intl.LDMLPluralRule, string>;
+/**
+ * Interface for advanced translation options, like plural forms.
+ */
+export interface TranslationOptions {
+    /**
+     * Value that determines which plural form will be chosen during translation.
+     * @default 0
+     */
+    count?: number;
+    pluralType?: Intl.PluralRuleType;
 }
-declare const translatorFor: <T extends Record<string, string>>(translation: T) => TranslationFunction<T>;
+/**
+ * Function that takes translation key with optional tokens and translation options to drive the translation process.
+ * Returns translated string with tokens inserted at defined slots.
+ */
+export interface TranslationFunction<T extends Record<string, TranslationTemplate>> {
+    (literal: keyof T): string;
+    (literal: keyof T, tokens: ReactText[], options?: TranslationOptions): string;
+    (literal: keyof T, tokens: ReactChild[], options?: TranslationOptions): ReactFragment[];
+}
+/**
+ * Function returns a function capable to translate tokens based on given translation pack and given locale.
+ * The passed translation object should be correlated to given locale.
+ * @param translation a translation pack (might be default or completely/partially overridden).
+ * @param locale locale as BCP 47 language tag. Used for pluralization rules.
+ * @returns
+ */
+declare const translatorFor: <T extends Record<string, TranslationTemplate>>(translation: T, locale: string) => TranslationFunction<T>;
 export default translatorFor;
 //# sourceMappingURL=translate.d.ts.map

package/lib/i18n/translate.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"translate.d.ts","sourceRoot":"","sources":["../../src/i18n/translate.tsx"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,UAAU,EAAE,SAAS,EAAE,MAAM,OAAO,CAAC;AAEnD,MAAM,WAAW,mBAAmB,CAAC,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC;IACnE,CAAC,OAAO,EAAE,MAAM,CAAC,EAAE,GAAG,MAAM,EAAE,SAAS,EAAE,GAAG,MAAM,CAAC;IACnD,CAAC,OAAO,EAAE,MAAM,CAAC,EAAE,GAAG,MAAM,EAAE,UAAU,EAAE,GAAG,UAAU,EAAE,CAAC;CAC3D;AAED,QAAA,MAAM,aAAa,8EAgBlB,CAAC;AAEF,eAAe,aAAa,CAAC"}
+{"version":3,"file":"translate.d.ts","sourceRoot":"","sources":["../../src/i18n/translate.tsx"],"names":[],"mappings":"AAAA,OAAO,EAAY,aAAa,EAAE,MAAM,OAAO,CAAC;AAChD,OAAO,KAAK,EAAE,UAAU,EAAE,SAAS,EAAE,MAAM,OAAO,CAAC;AAInD,aAAK,mBAAmB,GAAG,MAAM,GAAG,MAAM,CAAC,IAAI,CAAC,cAAc,EAAE,MAAM,CAAC,CAAC;AAExE;;GAEG;AACH,MAAM,WAAW,kBAAkB;IACjC;;;OAGG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf,UAAU,CAAC,EAAE,IAAI,CAAC,cAAc,CAAC;CAClC;AAED;;;GAGG;AACH,MAAM,WAAW,mBAAmB,CAAC,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,mBAAmB,CAAC;IAChF,CAAC,OAAO,EAAE,MAAM,CAAC,GAAG,MAAM,CAAC;IAC3B,CAAC,OAAO,EAAE,MAAM,CAAC,EAAE,MAAM,EAAE,SAAS,EAAE,EAAE,OAAO,CAAC,EAAE,kBAAkB,GAAG,MAAM,CAAC;IAC9E,CAAC,OAAO,EAAE,MAAM,CAAC,EAAE,MAAM,EAAE,UAAU,EAAE,EAAE,OAAO,CAAC,EAAE,kBAAkB,GAAG,aAAa,EAAE,CAAC;CACzF;AAED;;;;;;GAMG;AACH,QAAA,MAAM,aAAa,0EAET,MAAM,2BA6Bf,CAAC;AAEF,eAAe,aAAa,CAAC"}

package/lib/i18n/translate.js

@@ -1,18 +1,31 @@
 import { jsx as _jsx } from "react/jsx-runtime";
 import { Fragment } from 'react';
-const translatorFor = (translation) => {
-    return ((literal, ...tokens) => {
-        const template = translation[literal];
+/**
+ * Function returns a function capable to translate tokens based on given translation pack and given locale.
+ * The passed translation object should be correlated to given locale.
+ * @param translation a translation pack (might be default or completely/partially overridden).
+ * @param locale locale as BCP 47 language tag. Used for pluralization rules.
+ * @returns
+ */
+const translatorFor = (translation, locale) => {
+    const cardinalRules = new Intl.PluralRules(locale);
+    const ordinalRules = new Intl.PluralRules(locale, { type: 'ordinal' });
+    return ((literal, tokens = [], options) => {
+        let template = translation[literal];
         if (!template)
-            return '';
+            return `!unknown key: ${literal}`;
         const result = [];
-        template.split(/(?:\{(\d)\})/g).forEach((chunk, index) => {
-            const part = (index % 2 ? tokens[Number(chunk)] : chunk) || null;
-            if (part)
+        if (typeof template === 'object') {
+            const type = (options?.pluralType === 'ordinal' ? ordinalRules : cardinalRules).select(options?.count || 0);
+            template = template[type];
+        }
+        template.split(/\{(\d+)\}/g).forEach((chunk, index) => {
+            const part = index % 2 ? tokens[Number(chunk)] : chunk;
+            if (part !== undefined && part !== '')
                 result.push(part);
         });
         if (result.every(part => typeof part === 'string' || typeof part === 'number'))
-            return result.join('');
+            return result.join('').trim();
         // eslint-disable-next-line react/no-array-index-key
         return result.map((part, i) => _jsx(Fragment, { children: part }, i));
     });

package/lib/i18n/translate.js.map

@@ -1 +1 @@
-{"version":3,"file":"translate.js","sourceRoot":"","sources":["../../src/i18n/translate.tsx"],"names":[],"mappings":";AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,OAAO,CAAC;AAQjC,MAAM,aAAa,GAAG,CAAmC,WAAc,EAAE,EAAE;IACzE,OAAO,CAAC,CAAC,OAAgB,EAAE,GAAG,MAAoB,EAAyB,EAAE;QAC3E,MAAM,QAAQ,GAAG,WAAW,CAAC,OAAO,CAAC,CAAC;QACtC,IAAI,CAAC,QAAQ;YAAE,OAAO,EAAE,CAAC;QACzB,MAAM,MAAM,GAAiB,EAAE,CAAC;QAChC,QAAQ,CAAC,KAAK,CAAC,eAAe,CAAC,CAAC,OAAO,CAAC,CAAC,KAAK,EAAE,KAAK,EAAE,EAAE;YACvD,MAAM,IAAI,GAAG,CAAC,KAAK,GAAG,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,IAAI,IAAI,CAAC;YACjE,IAAI,IAAI;gBAAE,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAC9B,CAAC,CAAC,CAAC;QAEH,IAAI,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,OAAO,IAAI,KAAK,QAAQ,IAAI,OAAO,IAAI,KAAK,QAAQ,CAAC;YAC5E,OAAO,MAAM,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;QAEzB,oDAAoD;QACpD,OAAO,MAAM,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,CAAC,EAAE,EAAE,CAAC,KAAC,QAAQ,cAAU,IAAI,IAAR,CAAC,CAAmB,CAAC,CAAC;IACtE,CAAC,CAA2B,CAAC;AAC/B,CAAC,CAAC;AAEF,eAAe,aAAa,CAAC","sourcesContent":["import { Fragment } from 'react';\nimport type { ReactChild, ReactText } from 'react';\n\nexport interface TranslationFunction<T extends Record<string, string>> {\n  (literal: keyof T, ...tokens: ReactText[]): string;\n  (literal: keyof T, ...tokens: ReactChild[]): ReactChild[];\n}\n\nconst translatorFor = <T extends Record<string, string>>(translation: T) => {\n  return ((literal: keyof T, ...tokens: ReactChild[]): string | ReactChild[] => {\n    const template = translation[literal];\n    if (!template) return '';\n    const result: ReactChild[] = [];\n    template.split(/(?:\\{(\\d)\\})/g).forEach((chunk, index) => {\n      const part = (index % 2 ? tokens[Number(chunk)] : chunk) || null;\n      if (part) result.push(part);\n    });\n\n    if (result.every(part => typeof part === 'string' || typeof part === 'number'))\n      return result.join('');\n\n    // eslint-disable-next-line react/no-array-index-key\n    return result.map((part, i) => <Fragment key={i}>{part}</Fragment>);\n  }) as TranslationFunction<T>;\n};\n\nexport default translatorFor;\n"]}
+{"version":3,"file":"translate.js","sourceRoot":"","sources":["../../src/i18n/translate.tsx"],"names":[],"mappings":";AAAA,OAAO,EAAE,QAAQ,EAAiB,MAAM,OAAO,CAAC;AA8BhD;;;;;;GAMG;AACH,MAAM,aAAa,GAAG,CACpB,WAAc,EACd,MAAc,EACU,EAAE;IAC1B,MAAM,aAAa,GAAG,IAAI,IAAI,CAAC,WAAW,CAAC,MAAM,CAAC,CAAC;IACnD,MAAM,YAAY,GAAG,IAAI,IAAI,CAAC,WAAW,CAAC,MAAM,EAAE,EAAE,IAAI,EAAE,SAAS,EAAE,CAAC,CAAC;IACvE,OAAO,CAAC,CACN,OAA8B,EAC9B,SAAqC,EAAE,EACvC,OAA4B,EACF,EAAE;QAC5B,IAAI,QAAQ,GAAwB,WAAW,CAAC,OAAO,CAAC,CAAC;QACzD,IAAI,CAAC,QAAQ;YAAE,OAAO,iBAAiB,OAAO,EAAE,CAAC;QACjD,MAAM,MAAM,GAAiB,EAAE,CAAC;QAChC,IAAI,OAAO,QAAQ,KAAK,QAAQ,EAAE;YAChC,MAAM,IAAI,GAAG,CAAC,OAAO,EAAE,UAAU,KAAK,SAAS,CAAC,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,aAAa,CAAC,CAAC,MAAM,CACpF,OAAO,EAAE,KAAK,IAAI,CAAC,CACpB,CAAC;YACF,QAAQ,GAAG,QAAQ,CAAC,IAAI,CAAC,CAAC;SAC3B;QACD,QAAQ,CAAC,KAAK,CAAC,YAAY,CAAC,CAAC,OAAO,CAAC,CAAC,KAAK,EAAE,KAAK,EAAE,EAAE;YACpD,MAAM,IAAI,GAAG,KAAK,GAAG,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC;YACvD,IAAI,IAAI,KAAK,SAAS,IAAI,IAAI,KAAK,EAAE;gBAAE,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAC3D,CAAC,CAAC,CAAC;QAEH,IAAI,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,OAAO,IAAI,KAAK,QAAQ,IAAI,OAAO,IAAI,KAAK,QAAQ,CAAC;YAC5E,OAAO,MAAM,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,IAAI,EAAE,CAAC;QAEhC,oDAAoD;QACpD,OAAO,MAAM,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,CAAC,EAAE,EAAE,CAAC,KAAC,QAAQ,cAAU,IAAI,IAAR,CAAC,CAAmB,CAAC,CAAC;IACtE,CAAC,CAA2B,CAAC;AAC/B,CAAC,CAAC;AAEF,eAAe,aAAa,CAAC","sourcesContent":["import { Fragment, ReactFragment } from 'react';\nimport type { ReactChild, ReactText } from 'react';\n\nimport { TranslationPack } from './i18n';\n\ntype TranslationTemplate = string | Record<Intl.LDMLPluralRule, string>;\n\n/**\n * Interface for advanced translation options, like plural forms.\n */\nexport interface TranslationOptions {\n  /**\n   * Value that determines which plural form will be chosen during translation.\n   * @default 0\n   */\n  count?: number;\n  // Descriminator for pluralization type: 'cardinal' or 'ordinal'.\n  pluralType?: Intl.PluralRuleType;\n}\n\n/**\n * Function that takes translation key with optional tokens and translation options to drive the translation process.\n * Returns translated string with tokens inserted at defined slots.\n */\nexport interface TranslationFunction<T extends Record<string, TranslationTemplate>> {\n  (literal: keyof T): string;\n  (literal: keyof T, tokens: ReactText[], options?: TranslationOptions): string;\n  (literal: keyof T, tokens: ReactChild[], options?: TranslationOptions): ReactFragment[];\n}\n\n/**\n * Function returns a function capable to translate tokens based on given translation pack and given locale.\n * The passed translation object should be correlated to given locale.\n * @param translation a translation pack (might be default or completely/partially overridden).\n * @param locale locale as BCP 47 language tag. Used for pluralization rules.\n * @returns\n */\nconst translatorFor = <T extends Record<string, TranslationTemplate>>(\n  translation: T,\n  locale: string\n): TranslationFunction<T> => {\n  const cardinalRules = new Intl.PluralRules(locale);\n  const ordinalRules = new Intl.PluralRules(locale, { type: 'ordinal' });\n  return ((\n    literal: keyof TranslationPack,\n    tokens: (ReactChild | ReactText)[] = [],\n    options?: TranslationOptions\n  ): string | ReactFragment[] => {\n    let template: TranslationTemplate = translation[literal];\n    if (!template) return `!unknown key: ${literal}`;\n    const result: ReactChild[] = [];\n    if (typeof template === 'object') {\n      const type = (options?.pluralType === 'ordinal' ? ordinalRules : cardinalRules).select(\n        options?.count || 0\n      );\n      template = template[type];\n    }\n    template.split(/\\{(\\d+)\\}/g).forEach((chunk, index) => {\n      const part = index % 2 ? tokens[Number(chunk)] : chunk;\n      if (part !== undefined && part !== '') result.push(part);\n    });\n\n    if (result.every(part => typeof part === 'string' || typeof part === 'number'))\n      return result.join('').trim();\n\n    // eslint-disable-next-line react/no-array-index-key\n    return result.map((part, i) => <Fragment key={i}>{part}</Fragment>);\n  }) as TranslationFunction<T>;\n};\n\nexport default translatorFor;\n"]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pega/cosmos-react-core",
-  "version": "2.0.0-dev.14.3",
+  "version": "2.0.0-dev.15.0",
   "description": "Cosmos is a visual design system and UI component collection. Its goal is to empower application developers in their pursuit to create engaging and rewarding user experiences.",
   "author": "Pegasystems",
   "license": "SEE LICENSE IN LICENSE",