@prezly/theme-kit-intl 8.0.0 → 9.0.0

package/build/formatting/messages/lib.test.cjs

@@ -1,5 +1,6 @@
 "use strict";
 
+var _index = require("../../locales/index.cjs");
 var _lib = require("./lib.cjs");
 /* eslint-disable @typescript-eslint/no-use-before-define */
 
@@ -13,11 +14,45 @@ var I18N = {
   }, {
     type: 0,
     value: '!'
+  }],
+  ["images.count"]: [{
+    type: 0,
+    value: 'Images: '
+  }, {
+    offset: 0,
+    options: {
+      // eslint-disable-next-line @typescript-eslint/naming-convention
+      '=0': {
+        value: [{
+          type: 0,
+          value: 'no images'
+        }]
+      },
+      one: {
+        value: [{
+          type: 7
+        }, {
+          type: 0,
+          value: ' image'
+        }]
+      },
+      other: {
+        value: [{
+          type: 7
+        }, {
+          type: 0,
+          value: ' images'
+        }]
+      }
+    },
+    pluralType: 'cardinal',
+    type: 6,
+    value: 'imagesCount'
   }]
 };
 describe('formatMessageString', () => {
   it('should format intl-generated message intl object using the given values', () => {
-    var formatted = (0, _lib.formatMessageString)({
+    var formatted = (0, _lib.formatMessageString)('en', {
       id: 'hello.world',
       defaultMessage: 'Hello, {name}!'
     }, I18N, {
@@ -26,14 +61,14 @@ describe('formatMessageString', () => {
     expect(formatted).toBe('¡Hola, Julio!');
   });
   it('should leave placeholders if the given values object does not have enough data', () => {
-    var formatted = (0, _lib.formatMessageString)({
+    var formatted = (0, _lib.formatMessageString)('en', {
       id: 'hello.world',
       defaultMessage: 'Hello, {name}!'
     }, I18N, {});
     expect(formatted).toBe('¡Hola, {name}!');
   });
   it('should fallback to the default message if the dictionary does not have it', () => {
-    var formatted = (0, _lib.formatMessageString)({
+    var formatted = (0, _lib.formatMessageString)('en', {
       id: 'hello.world',
       defaultMessage: 'Hello, {name}!'
     }, {}, {
@@ -41,10 +76,36 @@ describe('formatMessageString', () => {
     });
     expect(formatted).toBe('Hello, Julio!');
   });
+  it('should format pluralization placeholders', () => {
+    function format(imagesCount) {
+      return (0, _lib.formatMessageString)('en', {
+        id: 'images.count',
+        defaultMessage: 'default'
+      }, I18N, {
+        imagesCount
+      });
+    }
+    expect(format(0)).toBe('Images: no images');
+    expect(format(1)).toBe('Images: 1 image');
+    expect(format(1024)).toBe('Images: 1024 images');
+  });
+  it('should do the most minimal support for pluralization placeholders in default messages', () => {
+    function format(imagesCount) {
+      return (0, _lib.formatMessageString)('en', {
+        id: 'images.count',
+        defaultMessage: 'Images: {imagesCount, plural, other {IDK}}'
+      }, {}, {
+        imagesCount
+      });
+    }
+    expect(format(0)).toEqual('Images: 0');
+    expect(format(1)).toEqual('Images: 1');
+    expect(format(1024)).toEqual('Images: 1024');
+  });
 });
 describe('formatMessageFragment', () => {
   it('should format intl-generated message intl object using the given values', () => {
-    var formatted = (0, _lib.formatMessageFragment)({
+    var formatted = (0, _lib.formatMessageFragment)('en', {
       id: 'hello.world',
       defaultMessage: 'Hello, {name}!'
     }, I18N, {
@@ -56,14 +117,14 @@ describe('formatMessageFragment', () => {
     }, '!']);
   });
   it('should leave placeholders if the given values object does not have enough data', () => {
-    var formatted = (0, _lib.formatMessageFragment)({
+    var formatted = (0, _lib.formatMessageFragment)('en', {
       id: 'hello.world',
       defaultMessage: 'Hello, {name}!'
     }, I18N, {});
     expect(formatted).toEqual(['¡Hola, ', '{name}', '!']);
   });
   it('should fallback to the default message if the dictionary does not have it', () => {
-    var formatted = (0, _lib.formatMessageFragment)({
+    var formatted = (0, _lib.formatMessageFragment)('en', {
       id: 'hello.world',
       defaultMessage: 'Hello, {name}!'
     }, {}, {
@@ -74,6 +135,80 @@ describe('formatMessageFragment', () => {
       children: ['Julio']
     }, '!']);
   });
+  it('should format pluralization placeholders', () => {
+    function format(imagesCount) {
+      return (0, _lib.formatMessageFragment)('en', {
+        id: 'images.count',
+        defaultMessage: 'default'
+      }, I18N, {
+        imagesCount
+      });
+    }
+    expect(format(0)).toEqual(['Images: ', 'no images']);
+    expect(format(1)).toEqual(['Images: ', '1', ' image']);
+    expect(format(1024)).toEqual(['Images: ', '1024', ' images']);
+  });
+  it('should do the most minimal support for pluralization placeholders in default messages', () => {
+    function format(imagesCount) {
+      return (0, _lib.formatMessageFragment)('en', {
+        id: 'images.count',
+        defaultMessage: 'Images: {imagesCount, plural, other {IDK}}'
+      }, {}, {
+        imagesCount
+      });
+    }
+    expect(format(0)).toEqual(['Images: ', 0]);
+    expect(format(1)).toEqual(['Images: ', 1]);
+    expect(format(1024)).toEqual(['Images: ', 1024]);
+  });
+});
+describe('parseMessage', () => {
+  it('should parse literal string', () => {
+    var parsed = (0, _lib.parseMessage)('Hello world!');
+    expect(parsed).toEqual([{
+      type: 0,
+      value: 'Hello world!'
+    }]);
+  });
+  it('should parse argument placeholders', () => {
+    var parsed = (0, _lib.parseMessage)('Hello {name}!');
+    expect(parsed).toEqual([{
+      type: 0,
+      value: 'Hello '
+    }, {
+      type: 1,
+      value: 'name'
+    }, {
+      type: 0,
+      value: '!'
+    }]);
+  });
+  it('should partially parse plural placeholders as a last resort fallback', () => {
+    var parsed = (0, _lib.parseMessage)('{apples, plural, zero {There are no apples}, one {There is one apple}, other {There are # apples}}');
+    expect(parsed).toEqual([{
+      type: 1,
+      value: 'apples'
+    }]);
+  });
+});
+describe('tokenizeMessage', () => {
+  it('should return a single item array for literal strings', () => {
+    var tokens = (0, _lib.tokenizeMessage)('Hello world');
+    expect(tokens).toEqual(['Hello world']);
+  });
+  it('it should tokenize simple placeholders', () => {
+    var tokens = (0, _lib.tokenizeMessage)('Hello {type} world of {creatures}!');
+    expect(tokens).toEqual(['Hello ', '{type}', ' world of ', '{creatures}', '!']);
+  });
+  it('it should tokenize pluralization placeholders', () => {
+    var tokens = (0, _lib.tokenizeMessage)('Hello {type} world of {count, plural, other {#}} {creatures}!');
+    expect(tokens).toEqual(['Hello ', '{type}', ' world of ', '{count, plural, other {#}}', ' ', '{creatures}', '!']);
+  });
+});
+describe('getPluralRules', () => {
+  test.each(_index.supportedLocales)('should be safe to use with any of the supported locales: %s', locale => {
+    expect((0, _lib.getPluralRules)(_index.Locale.from(locale).code)).toBeInstanceOf(Intl.PluralRules);
+  });
 });
 
 /**

package/build/formatting/messages/lib.test.mjs

@@ -1,5 +1,6 @@
 /* eslint-disable @typescript-eslint/no-use-before-define */
-import { formatMessageFragment, formatMessageString } from "./lib.mjs";
+import { Locale, supportedLocales } from "../../locales/index.mjs";
+import { formatMessageFragment, formatMessageString, getPluralRules, parseMessage, tokenizeMessage } from "./lib.mjs";
 var I18N = {
   ["hello.world"]: [{
     type: 0,
@@ -10,11 +11,45 @@ var I18N = {
   }, {
     type: 0,
     value: '!'
+  }],
+  ["images.count"]: [{
+    type: 0,
+    value: 'Images: '
+  }, {
+    offset: 0,
+    options: {
+      // eslint-disable-next-line @typescript-eslint/naming-convention
+      '=0': {
+        value: [{
+          type: 0,
+          value: 'no images'
+        }]
+      },
+      one: {
+        value: [{
+          type: 7
+        }, {
+          type: 0,
+          value: ' image'
+        }]
+      },
+      other: {
+        value: [{
+          type: 7
+        }, {
+          type: 0,
+          value: ' images'
+        }]
+      }
+    },
+    pluralType: 'cardinal',
+    type: 6,
+    value: 'imagesCount'
   }]
 };
 describe('formatMessageString', () => {
   it('should format intl-generated message intl object using the given values', () => {
-    var formatted = formatMessageString({
+    var formatted = formatMessageString('en', {
       id: 'hello.world',
       defaultMessage: 'Hello, {name}!'
     }, I18N, {
@@ -23,14 +58,14 @@ describe('formatMessageString', () => {
     expect(formatted).toBe('¡Hola, Julio!');
   });
   it('should leave placeholders if the given values object does not have enough data', () => {
-    var formatted = formatMessageString({
+    var formatted = formatMessageString('en', {
       id: 'hello.world',
       defaultMessage: 'Hello, {name}!'
     }, I18N, {});
     expect(formatted).toBe('¡Hola, {name}!');
   });
   it('should fallback to the default message if the dictionary does not have it', () => {
-    var formatted = formatMessageString({
+    var formatted = formatMessageString('en', {
       id: 'hello.world',
       defaultMessage: 'Hello, {name}!'
     }, {}, {
@@ -38,10 +73,36 @@ describe('formatMessageString', () => {
     });
     expect(formatted).toBe('Hello, Julio!');
   });
+  it('should format pluralization placeholders', () => {
+    function format(imagesCount) {
+      return formatMessageString('en', {
+        id: 'images.count',
+        defaultMessage: 'default'
+      }, I18N, {
+        imagesCount
+      });
+    }
+    expect(format(0)).toBe('Images: no images');
+    expect(format(1)).toBe('Images: 1 image');
+    expect(format(1024)).toBe('Images: 1024 images');
+  });
+  it('should do the most minimal support for pluralization placeholders in default messages', () => {
+    function format(imagesCount) {
+      return formatMessageString('en', {
+        id: 'images.count',
+        defaultMessage: 'Images: {imagesCount, plural, other {IDK}}'
+      }, {}, {
+        imagesCount
+      });
+    }
+    expect(format(0)).toEqual('Images: 0');
+    expect(format(1)).toEqual('Images: 1');
+    expect(format(1024)).toEqual('Images: 1024');
+  });
 });
 describe('formatMessageFragment', () => {
   it('should format intl-generated message intl object using the given values', () => {
-    var formatted = formatMessageFragment({
+    var formatted = formatMessageFragment('en', {
       id: 'hello.world',
       defaultMessage: 'Hello, {name}!'
     }, I18N, {
@@ -53,14 +114,14 @@ describe('formatMessageFragment', () => {
     }, '!']);
   });
   it('should leave placeholders if the given values object does not have enough data', () => {
-    var formatted = formatMessageFragment({
+    var formatted = formatMessageFragment('en', {
       id: 'hello.world',
       defaultMessage: 'Hello, {name}!'
     }, I18N, {});
     expect(formatted).toEqual(['¡Hola, ', '{name}', '!']);
   });
   it('should fallback to the default message if the dictionary does not have it', () => {
-    var formatted = formatMessageFragment({
+    var formatted = formatMessageFragment('en', {
       id: 'hello.world',
       defaultMessage: 'Hello, {name}!'
     }, {}, {
@@ -71,6 +132,80 @@ describe('formatMessageFragment', () => {
       children: ['Julio']
     }, '!']);
   });
+  it('should format pluralization placeholders', () => {
+    function format(imagesCount) {
+      return formatMessageFragment('en', {
+        id: 'images.count',
+        defaultMessage: 'default'
+      }, I18N, {
+        imagesCount
+      });
+    }
+    expect(format(0)).toEqual(['Images: ', 'no images']);
+    expect(format(1)).toEqual(['Images: ', '1', ' image']);
+    expect(format(1024)).toEqual(['Images: ', '1024', ' images']);
+  });
+  it('should do the most minimal support for pluralization placeholders in default messages', () => {
+    function format(imagesCount) {
+      return formatMessageFragment('en', {
+        id: 'images.count',
+        defaultMessage: 'Images: {imagesCount, plural, other {IDK}}'
+      }, {}, {
+        imagesCount
+      });
+    }
+    expect(format(0)).toEqual(['Images: ', 0]);
+    expect(format(1)).toEqual(['Images: ', 1]);
+    expect(format(1024)).toEqual(['Images: ', 1024]);
+  });
+});
+describe('parseMessage', () => {
+  it('should parse literal string', () => {
+    var parsed = parseMessage('Hello world!');
+    expect(parsed).toEqual([{
+      type: 0,
+      value: 'Hello world!'
+    }]);
+  });
+  it('should parse argument placeholders', () => {
+    var parsed = parseMessage('Hello {name}!');
+    expect(parsed).toEqual([{
+      type: 0,
+      value: 'Hello '
+    }, {
+      type: 1,
+      value: 'name'
+    }, {
+      type: 0,
+      value: '!'
+    }]);
+  });
+  it('should partially parse plural placeholders as a last resort fallback', () => {
+    var parsed = parseMessage('{apples, plural, zero {There are no apples}, one {There is one apple}, other {There are # apples}}');
+    expect(parsed).toEqual([{
+      type: 1,
+      value: 'apples'
+    }]);
+  });
+});
+describe('tokenizeMessage', () => {
+  it('should return a single item array for literal strings', () => {
+    var tokens = tokenizeMessage('Hello world');
+    expect(tokens).toEqual(['Hello world']);
+  });
+  it('it should tokenize simple placeholders', () => {
+    var tokens = tokenizeMessage('Hello {type} world of {creatures}!');
+    expect(tokens).toEqual(['Hello ', '{type}', ' world of ', '{creatures}', '!']);
+  });
+  it('it should tokenize pluralization placeholders', () => {
+    var tokens = tokenizeMessage('Hello {type} world of {count, plural, other {#}} {creatures}!');
+    expect(tokens).toEqual(['Hello ', '{type}', ' world of ', '{count, plural, other {#}}', ' ', '{creatures}', '!']);
+  });
+});
+describe('getPluralRules', () => {
+  test.each(supportedLocales)('should be safe to use with any of the supported locales: %s', locale => {
+    expect(getPluralRules(Locale.from(locale).code)).toBeInstanceOf(Intl.PluralRules);
+  });
 });
 
 /**

package/build/formatting/messages/types.cjs

@@ -1 +1,18 @@
-"use strict";
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.IntlMessageFormat = void 0;
+// eslint-disable-next-line @typescript-eslint/no-redeclare
+var IntlMessageFormat;
+(function (_IntlMessageFormat) {
+  var Type = /*#__PURE__*/function (Type) {
+    Type[Type["LITERAL"] = 0] = "LITERAL";
+    Type[Type["ARGUMENT"] = 1] = "ARGUMENT";
+    Type[Type["PLURAL"] = 6] = "PLURAL";
+    Type[Type["POUND"] = 7] = "POUND";
+    return Type;
+  }({}); // TAG = 8, // Not implemented
+  _IntlMessageFormat.Type = Type;
+})(IntlMessageFormat || (exports.IntlMessageFormat = IntlMessageFormat = {}));

package/build/formatting/messages/types.d.ts

@@ -1,10 +1,53 @@
 export type IntlDictionary = Partial<Record<string, IntlMessageFormat>>;
-export type IntlMessageFormat = {
-    type: 0 | 1;
+type VarName = string;
+export type IntlMessageFormat = ({
+    type: IntlMessageFormat.Type.LITERAL;
     value: string;
-}[];
+} | {
+    type: IntlMessageFormat.Type.ARGUMENT;
+    value: VarName;
+} | {
+    type: IntlMessageFormat.Type.PLURAL;
+    value: VarName;
+    pluralType: 'cardinal' | 'ordinal';
+    offset: number;
+    options: Partial<Record<'zero' | 'one' | 'two' | 'few' | 'many' | `=${number}`, {
+        value: IntlMessageFormat;
+    }>> & {
+        other: {
+            value: IntlMessageFormat;
+        };
+    };
+} | {
+    type: IntlMessageFormat.Type.POUND;
+})[];
+export declare namespace IntlMessageFormat {
+    /**
+     * @see https://github.com/formatjs/formatjs/blob/df4f21270320237eb5a91fbf74f3f8f51b4ff184/rust/icu-messageformat-parser/src/ast.rs#L212-L262
+     */
+    enum Type {
+        /**
+         * Raw text
+         */
+        LITERAL = 0,
+        /**
+         * Variable without any format, e.g. `var` in `this is a {var}`
+         */
+        ARGUMENT = 1,
+        /**
+         * Variable with plural format
+         */
+        PLURAL = 6,
+        /**
+         * Only possible within plural argument.
+         * This is the `#` symbol that will be substituted with the count.
+         */
+        POUND = 7
+    }
+}
 export interface IntlMessageDescriptor {
     id: string;
     defaultMessage?: string;
 }
 export type IntlMessageValues<T> = Record<string, T>;
+export {};

package/build/formatting/messages/types.mjs

@@ -1 +1,12 @@
-export {};
+// eslint-disable-next-line @typescript-eslint/no-redeclare
+export var IntlMessageFormat;
+(function (_IntlMessageFormat) {
+  var Type = /*#__PURE__*/function (Type) {
+    Type[Type["LITERAL"] = 0] = "LITERAL";
+    Type[Type["ARGUMENT"] = 1] = "ARGUMENT";
+    Type[Type["PLURAL"] = 6] = "PLURAL";
+    Type[Type["POUND"] = 7] = "POUND";
+    return Type;
+  }({}); // TAG = 8, // Not implemented
+  _IntlMessageFormat.Type = Type;
+})(IntlMessageFormat || (IntlMessageFormat = {}));

package/build/i18n/af.json

@@ -159,12 +159,98 @@
       "value": "Lets het verkeerd geloop. Probeer die vorm weer indien"
     }
   ],
+  "mediaGallery.imagesCount": [
+    {
+      "offset": 0,
+      "options": {
+        "=0": {
+          "value": [
+            {
+              "type": 0,
+              "value": "Geen beelde nie"
+            }
+          ]
+        },
+        "one": {
+          "value": [
+            {
+              "type": 7
+            },
+            {
+              "type": 0,
+              "value": " beeld"
+            }
+          ]
+        },
+        "other": {
+          "value": [
+            {
+              "type": 7
+            },
+            {
+              "type": 0,
+              "value": " beelde"
+            }
+          ]
+        }
+      },
+      "pluralType": "cardinal",
+      "type": 6,
+      "value": "imagesCount"
+    }
+  ],
   "mediaGallery.title": [
     {
       "type": 0,
       "value": "Media galerye"
     }
   ],
+  "mediaGallery.titleSingular": [
+    {
+      "type": 0,
+      "value": "Mediagalery"
+    }
+  ],
+  "mediaGallery.videosCount": [
+    {
+      "offset": 0,
+      "options": {
+        "=0": {
+          "value": [
+            {
+              "type": 0,
+              "value": "Geen video's nie"
+            }
+          ]
+        },
+        "one": {
+          "value": [
+            {
+              "type": 7
+            },
+            {
+              "type": 0,
+              "value": " video"
+            }
+          ]
+        },
+        "other": {
+          "value": [
+            {
+              "type": 7
+            },
+            {
+              "type": 0,
+              "value": " video's"
+            }
+          ]
+        }
+      },
+      "pluralType": "cardinal",
+      "type": 6,
+      "value": "videosCount"
+    }
+  ],
   "misc.embargoMessage": [
     {
       "type": 0,
@@ -258,7 +344,7 @@
   "search.filters": [
     {
       "type": 0,
-      "value": "Filters"
+      "value": "Filtreer"
     }
   ],
   "search.fullResultsSubTitle": [