@messagevisor/module-icu 0.0.1 → 0.2.0

package/CHANGELOG.md

@@ -0,0 +1,24 @@
+# Change Log
+
+All notable changes to this project will be documented in this file.
+See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
+
+# [0.2.0](https://github.com/messagevisor/messagevisor/compare/v0.1.0...v0.2.0) (2026-06-02)
+
+**Note:** Version bump only for package @messagevisor/module-icu
+
+
+
+
+
+# [0.1.0](https://github.com/messagevisor/messagevisor/compare/v0.0.2...v0.1.0) (2026-05-31)
+
+**Note:** Version bump only for package @messagevisor/module-icu
+
+
+
+
+
+## 0.0.2 (2026-05-31)
+
+**Note:** Version bump only for package @messagevisor/module-icu

package/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2026 Fahad Heylaal (https://fahad19.com)
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

package/README.md

@@ -0,0 +1,7 @@
+# @messagevisor/module-icu
+
+Visit [https://messagevisor.com/docs/modules/icu/](https://messagevisor.com/docs/modules/icu/) for more information.
+
+## License
+
+MIT © [Fahad Heylaal](https://fahad19.com)

package/jest.config.js

@@ -0,0 +1,11 @@
+const base = require("../../jest.config");
+
+module.exports = {
+  ...base,
+  rootDir: "../..",
+  testRegex: undefined,
+  testMatch: ["<rootDir>/packages/module-icu/src/**/*.spec.ts"],
+  moduleNameMapper: {
+    "^@messagevisor/sdk$": "<rootDir>/packages/sdk/src/index.ts",
+  },
+};

package/lib/index.d.ts

@@ -0,0 +1,6 @@
+import type { MessagevisorModule } from "@messagevisor/sdk";
+export interface ICUModuleOptions {
+    name?: string;
+    ignoreTags?: boolean;
+}
+export declare function createICUModule(options?: ICUModuleOptions): MessagevisorModule;

package/lib/index.js

@@ -0,0 +1,51 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createICUModule = createICUModule;
+/* eslint-disable @typescript-eslint/no-unused-vars */
+const intl_messageformat_1 = __importDefault(require("intl-messageformat"));
+function createEmptyRecord() {
+    return {};
+}
+function createICUModuleCache() {
+    return {
+        messageFormat: createEmptyRecord(),
+    };
+}
+function getCacheKey(payload, ignoreTags) {
+    return JSON.stringify({
+        locale: payload.locale,
+        translation: payload.translation,
+        formats: payload.formats,
+        ignoreTags,
+    });
+}
+function getCachedIntlMessageFormat(cache, payload, ignoreTags) {
+    const cacheKey = getCacheKey(payload, ignoreTags);
+    if (!cache.messageFormat[cacheKey]) {
+        cache.messageFormat[cacheKey] = new intl_messageformat_1.default(String(payload.translation), payload.locale, {
+            number: payload.formats.number,
+            date: payload.formats.date,
+            time: payload.formats.time,
+        }, {
+            ignoreTag: ignoreTags,
+        });
+    }
+    return cache.messageFormat[cacheKey];
+}
+function createICUModule(options = {}) {
+    const cache = createICUModuleCache();
+    const name = options.name || "icu";
+    return {
+        name,
+        format(payload) {
+            var _a, _b, _c;
+            const moduleOptions = (_a = payload.moduleOptions) === null || _a === void 0 ? void 0 : _a[name];
+            const ignoreTags = (_c = (_b = moduleOptions === null || moduleOptions === void 0 ? void 0 : moduleOptions.ignoreTags) !== null && _b !== void 0 ? _b : options.ignoreTags) !== null && _c !== void 0 ? _c : true;
+            return getCachedIntlMessageFormat(cache, payload, ignoreTags).format(payload.values);
+        },
+    };
+}
+//# sourceMappingURL=index.js.map

package/lib/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;AA0DA,0CAaC;AAvED,sDAAsD;AACtD,4EAAmD;AAanD,SAAS,iBAAiB;IACxB,OAAO,EAAuB,CAAC;AACjC,CAAC;AAED,SAAS,oBAAoB;IAC3B,OAAO;QACL,aAAa,EAAE,iBAAiB,EAAqB;KACtD,CAAC;AACJ,CAAC;AAED,SAAS,WAAW,CAAC,OAAkC,EAAE,UAAmB;IAC1E,OAAO,IAAI,CAAC,SAAS,CAAC;QACpB,MAAM,EAAE,OAAO,CAAC,MAAM;QACtB,WAAW,EAAE,OAAO,CAAC,WAAW;QAChC,OAAO,EAAE,OAAO,CAAC,OAAO;QACxB,UAAU;KACX,CAAC,CAAC;AACL,CAAC;AAED,SAAS,0BAA0B,CACjC,KAAqB,EACrB,OAAkC,EAClC,UAAmB;IAEnB,MAAM,QAAQ,GAAG,WAAW,CAAC,OAAO,EAAE,UAAU,CAAC,CAAC;IAElD,IAAI,CAAC,KAAK,CAAC,aAAa,CAAC,QAAQ,CAAC,EAAE,CAAC;QACnC,KAAK,CAAC,aAAa,CAAC,QAAQ,CAAC,GAAG,IAAI,4BAAiB,CACnD,MAAM,CAAC,OAAO,CAAC,WAAW,CAAC,EAC3B,OAAO,CAAC,MAAM,EACd;YACE,MAAM,EAAE,OAAO,CAAC,OAAO,CAAC,MAAM;YAC9B,IAAI,EAAE,OAAO,CAAC,OAAO,CAAC,IAAI;YAC1B,IAAI,EAAE,OAAO,CAAC,OAAO,CAAC,IAAI;SACpB,EACR;YACE,SAAS,EAAE,UAAU;SACtB,CACF,CAAC;IACJ,CAAC;IAED,OAAO,KAAK,CAAC,aAAa,CAAC,QAAQ,CAAC,CAAC;AACvC,CAAC;AAED,SAAgB,eAAe,CAAC,UAA4B,EAAE;IAC5D,MAAM,KAAK,GAAG,oBAAoB,EAAE,CAAC;IACrC,MAAM,IAAI,GAAG,OAAO,CAAC,IAAI,IAAI,KAAK,CAAC;IAEnC,OAAO;QACL,IAAI;QACJ,MAAM,CAAC,OAAkC;;YACvC,MAAM,aAAa,GAAG,MAAA,OAAO,CAAC,aAAa,0CAAG,IAAI,CAAyC,CAAC;YAC5F,MAAM,UAAU,GAAG,MAAA,MAAA,aAAa,aAAb,aAAa,uBAAb,aAAa,CAAE,UAAU,mCAAI,OAAO,CAAC,UAAU,mCAAI,IAAI,CAAC;YAE3E,OAAO,0BAA0B,CAAC,KAAK,EAAE,OAAO,EAAE,UAAU,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC,MAAa,CAAC,CAAC;QAC9F,CAAC;KACF,CAAC;AACJ,CAAC"}

package/package.json

@@ -1,15 +1,45 @@
 {
-	"name": "@messagevisor/module-icu",
-	"version": "0.0.1",
-	"description": "Messagevisor package",
-	"license": "ISC",
-	"author": "",
-	"type": "commonjs",
-	"main": "index.js",
-	"publishConfig": {
-		"access": "public"
-	},
-	"scripts": {
-		"test": "echo \"Error: no test specified\" && exit 1"
-	}
+  "name": "@messagevisor/module-icu",
+  "version": "0.2.0",
+  "description": "ICU formatting module for Messagevisor",
+  "main": "lib/index.js",
+  "module": "lib/index.js",
+  "types": "lib/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./lib/index.d.ts",
+      "require": "./lib/index.js",
+      "import": "./lib/index.js"
+    },
+    "./package.json": "./package.json"
+  },
+  "scripts": {
+    "transpile": "rimraf lib && tsc --project tsconfig.cjs.json",
+    "dist": "echo 'Nothing to dist here'",
+    "build": "npm run transpile",
+    "test": "jest --config jest.config.js --verbose",
+    "typecheck": "tsc --noEmit --skipLibCheck -p tsconfig.typecheck.json"
+  },
+  "author": {
+    "name": "Fahad Heylaal",
+    "url": "https://fahad19.com"
+  },
+  "homepage": "https://messagevisor.com",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/messagevisor/messagevisor.git"
+  },
+  "publishConfig": {
+    "access": "public",
+    "registry": "https://registry.npmjs.org/"
+  },
+  "bugs": {
+    "url": "https://github.com/messagevisor/messagevisor/issues"
+  },
+  "license": "MIT",
+  "dependencies": {
+    "@messagevisor/sdk": "0.2.0",
+    "intl-messageformat": "^10.7.16"
+  },
+  "gitHead": "53cfef1a5ae28724b24226dd3a32ff813b063ce3"
 }

package/src/index.spec.ts

@@ -0,0 +1,258 @@
+import type { DatafileContent } from "@messagevisor/types";
+import { createMessagevisor } from "@messagevisor/sdk";
+
+import { createICUModule } from "./index";
+
+const datafile: DatafileContent = {
+  schemaVersion: "1",
+  messagevisorVersion: "0.0.1",
+  revision: "1",
+  target: "web",
+  locale: "en-US",
+  formats: {
+    number: {
+      money: { style: "currency", currency: "USD", currencyDisplay: "code" },
+      moneySymbol: { style: "currency", currency: "USD", currencyDisplay: "symbol" },
+      moneyCode: { style: "currency", currency: "USD", currencyDisplay: "code" },
+      moneyAccounting: { style: "currency", currency: "USD", currencySign: "accounting" },
+      runtimeMoney: { style: "currency", currencyDisplay: "code" },
+      decimalFixed: { style: "decimal", minimumFractionDigits: 2, maximumFractionDigits: 2 },
+      compactShort: { notation: "compact", compactDisplay: "short" },
+      unitDistance: { style: "unit", unit: "kilometer", unitDisplay: "short" },
+      scientific: { notation: "scientific" },
+      noCurrency: { style: "currency", currencyDisplay: "code" } as any,
+    },
+    date: {
+      numeric: { year: "numeric", month: "2-digit", day: "2-digit" },
+      weekday: { weekday: "long", year: "numeric", month: "long", day: "numeric" },
+      fullStyle: { dateStyle: "full" },
+    },
+    time: {
+      short: { hour: "numeric", minute: "2-digit" },
+      seconds: { hour: "numeric", minute: "2-digit", second: "2-digit" },
+      event: { hour: "numeric", minute: "2-digit", timeZone: "UTC" },
+      fullStyle: { timeStyle: "full", timeZone: "UTC" },
+    },
+  },
+  segments: {
+    "platform-web": {
+      conditions: [{ attribute: "platform", operator: "equals", value: "web" }],
+    },
+  },
+  messages: {
+    greeting: {
+      overrides: [
+        {
+          key: "platform-web",
+          segments: "platform-web",
+          translation: "Hello web {name}",
+        },
+      ],
+    },
+    namedTotal: {},
+    skeletonTotal: {},
+    fallbackTotal: {},
+    symbolTotal: {},
+    codeTotal: {},
+    accountingTotal: {},
+    runtimeTotal: {},
+    compactTotal: {},
+    compactAudience: {},
+    scientificTotal: {},
+    distance: {},
+    eventTime: {},
+    fullDate: {},
+    fullTime: {},
+    dateFormats: {},
+    timeFormats: {},
+    richTerms: {},
+    richPromo: {
+      overrides: [
+        {
+          key: "promo-web",
+          segments: "platform-web",
+          translation:
+            "Web <strong>{product}</strong> costs <price>{amount, number, money}</price> today.",
+        },
+      ],
+    },
+  },
+  translations: {
+    greeting: "Hello {name}",
+    namedTotal: "Total: {amount, number, money}",
+    skeletonTotal: "Total: {amount, number, ::currency/GBP}",
+    fallbackTotal: "Total: {amount, number, noCurrency}",
+    symbolTotal: "Total: {amount, number, moneySymbol}",
+    codeTotal: "Total: {amount, number, moneyCode}",
+    accountingTotal: "Total: {amount, number, moneyAccounting}",
+    runtimeTotal: "Total: {amount, number, runtimeMoney}",
+    compactTotal: "Total: {currency}{amount, number, decimalFixed}",
+    compactAudience: "Audience: {count, number, compactShort}",
+    scientificTotal: "Scientific: {amount, number, scientific}",
+    distance: "Distance: {distance, number, unitDistance}",
+    eventTime: "Starts at {startsAt, time, event}",
+    fullDate: "Full date: {startsAt, date, fullStyle}",
+    fullTime: "Full time: {startsAt, time, fullStyle}",
+    dateFormats: "Numeric: {startsAt, date, numeric}; weekday: {startsAt, date, weekday}",
+    timeFormats: "Short: {startsAt, time, short}; seconds: {startsAt, time, seconds}",
+    richTerms: "Read our <link>terms</link> for <strong>{product}</strong>.",
+    richPromo: "Default <strong>{product}</strong> costs <price>{amount, number, money}</price>.",
+  },
+};
+
+describe("@messagevisor/module-icu", function () {
+  it("formats ICU interpolations when installed", function () {
+    const m = createMessagevisor({
+      datafile,
+      modules: [createICUModule()],
+    });
+
+    expect(m.translate("greeting", { name: "Ada" })).toEqual("Hello Ada");
+    expect(m.formatMessage("Hi {name}", { name: "Lin" })).toEqual("Hi Lin");
+  });
+
+  it("formats ICU placeholders in per-call default translations for missing keys", function () {
+    const m = createMessagevisor({
+      datafile,
+      modules: [createICUModule()],
+    });
+
+    expect(
+      m.translate("missing.icu.fallback", { name: "Ada" }, { defaultTranslation: "Hi, {name}" }),
+    ).toEqual("Hi, Ada");
+  });
+
+  it("supports rich tags and rich output arrays", function () {
+    const m = createMessagevisor({
+      datafile,
+      modules: [createICUModule({ ignoreTags: false })],
+    });
+
+    expect(
+      m.translate("richTerms", {
+        product: "Messagevisor",
+        link: (chunks: string[]) => `[${chunks.join("")}]`,
+        strong: (chunks: string[]) => chunks.join("").toUpperCase(),
+      }),
+    ).toEqual("Read our [terms] for MESSAGEVISOR.");
+
+    expect(
+      m.formatMessage("Read <link>terms</link>.", {
+        link: (chunks) => ({ type: "link", children: chunks }),
+      }),
+    ).toEqual(["Read ", { type: "link", children: ["terms"] }, "."]);
+  });
+
+  it("supports per-call ignoreTags overrides", function () {
+    const richEnabled = createMessagevisor({
+      datafile,
+      modules: [createICUModule({ ignoreTags: false })],
+    });
+    const richDisabled = createMessagevisor({
+      datafile,
+      modules: [createICUModule()],
+    });
+
+    expect(
+      richEnabled.formatMessage(
+        "Read <link>terms</link>.",
+        {
+          link: (chunks) => `[${chunks.join("")}]`,
+        },
+        {
+          moduleOptions: {
+            icu: {
+              ignoreTags: true,
+            },
+          },
+        },
+      ),
+    ).toEqual("Read <link>terms</link>.");
+
+    expect(
+      richDisabled.formatMessage(
+        "Read <link>terms</link>.",
+        {
+          link: (chunks) => `[${chunks.join("")}]`,
+        },
+        {
+          moduleOptions: {
+            icu: {
+              ignoreTags: false,
+            },
+          },
+        },
+      ),
+    ).toEqual("Read [terms].");
+  });
+
+  it("honors currency and time zone precedence through resolved formats", function () {
+    const startsAt = new Date("2025-01-01T12:00:00Z");
+    const m = createMessagevisor({
+      datafile,
+      currency: "CHF",
+      timeZone: "Asia/Tokyo",
+      modules: [createICUModule()],
+    });
+
+    expect(m.translate("namedTotal", { amount: 12 }, { currency: "EUR" })).toContain("EUR");
+    expect(m.translate("namedTotal", { amount: 12 })).toContain("USD");
+    expect(m.translate("fallbackTotal", { amount: 12 })).toContain("CHF");
+    expect(m.translate("runtimeTotal", { amount: 12 })).toContain("CHF");
+    expect(m.translate("eventTime", { startsAt }, { timeZone: "America/New_York" })).toContain(
+      "7:00",
+    );
+    expect(m.translate("eventTime", { startsAt })).toContain("12:00");
+    expect(m.translate("skeletonTotal", { amount: 12 })).toContain("£");
+  });
+
+  it("supports override-selected translations and named format variants", function () {
+    const m = createMessagevisor({
+      datafile,
+      context: { platform: "web" },
+      currency: "EUR",
+      modules: [createICUModule({ ignoreTags: false })],
+    });
+
+    expect(m.translate("greeting", { name: "Ada" })).toEqual("Hello web Ada");
+    expect(m.translate("symbolTotal", { amount: 12 })).toEqual("Total: $12.00");
+    expect(m.translate("codeTotal", { amount: 12 })).toEqual("Total: USD 12.00");
+    expect(m.translate("accountingTotal", { amount: -12 })).toEqual("Total: ($12.00)");
+    expect(m.translate("compactAudience", { count: 1200 })).toContain("1.2K");
+    expect(m.translate("scientificTotal", { amount: 1200 })).toContain("1.2E3");
+    expect(m.translate("distance", { distance: 5 })).toMatch(/5\s?km/);
+    expect(
+      m.translate("richPromo", {
+        product: "Messagevisor",
+        amount: 12,
+        strong: (chunks: string[]) => `**${chunks.join("")}**`,
+        price: (chunks: string[]) => `<${chunks.join("")}>`,
+      }),
+    ).toEqual("Web **Messagevisor** costs <USD 12.00> today.");
+  });
+
+  it("supports Intl date/time style presets in ICU messages", function () {
+    const m = createMessagevisor({
+      datafile,
+      timeZone: "UTC",
+      modules: [createICUModule()],
+    });
+    const startsAt = new Date("2025-01-01T12:00:00Z");
+
+    expect(m.translate("fullDate", { startsAt })).toContain("Wednesday, January 1, 2025");
+    expect(m.translate("fullTime", { startsAt })).toContain("12:00:00 PM");
+  });
+
+  it("can be removed by its default name", function () {
+    const m = createMessagevisor({
+      datafile,
+      modules: [createICUModule()],
+    });
+
+    expect(m.translate("greeting", { name: "Ada" })).toEqual("Hello Ada");
+
+    m.removeModule("icu");
+
+    expect(m.translate("greeting", { name: "Ada" })).toEqual("Hello {name}");
+  });
+});

package/src/index.ts

@@ -0,0 +1,72 @@
+/* eslint-disable @typescript-eslint/no-unused-vars */
+import IntlMessageFormat from "intl-messageformat";
+
+import type { MessagevisorFormatPayload, MessagevisorModule } from "@messagevisor/sdk";
+
+export interface ICUModuleOptions {
+  name?: string;
+  ignoreTags?: boolean;
+}
+
+interface ICUModuleCache {
+  messageFormat: Record<string, IntlMessageFormat>;
+}
+
+function createEmptyRecord<T>() {
+  return {} as Record<string, T>;
+}
+
+function createICUModuleCache(): ICUModuleCache {
+  return {
+    messageFormat: createEmptyRecord<IntlMessageFormat>(),
+  };
+}
+
+function getCacheKey(payload: MessagevisorFormatPayload, ignoreTags: boolean) {
+  return JSON.stringify({
+    locale: payload.locale,
+    translation: payload.translation,
+    formats: payload.formats,
+    ignoreTags,
+  });
+}
+
+function getCachedIntlMessageFormat<T>(
+  cache: ICUModuleCache,
+  payload: MessagevisorFormatPayload,
+  ignoreTags: boolean,
+) {
+  const cacheKey = getCacheKey(payload, ignoreTags);
+
+  if (!cache.messageFormat[cacheKey]) {
+    cache.messageFormat[cacheKey] = new IntlMessageFormat(
+      String(payload.translation),
+      payload.locale,
+      {
+        number: payload.formats.number,
+        date: payload.formats.date,
+        time: payload.formats.time,
+      } as any,
+      {
+        ignoreTag: ignoreTags,
+      },
+    );
+  }
+
+  return cache.messageFormat[cacheKey];
+}
+
+export function createICUModule(options: ICUModuleOptions = {}): MessagevisorModule {
+  const cache = createICUModuleCache();
+  const name = options.name || "icu";
+
+  return {
+    name,
+    format(payload: MessagevisorFormatPayload) {
+      const moduleOptions = payload.moduleOptions?.[name] as { ignoreTags?: boolean } | undefined;
+      const ignoreTags = moduleOptions?.ignoreTags ?? options.ignoreTags ?? true;
+
+      return getCachedIntlMessageFormat(cache, payload, ignoreTags).format(payload.values as any);
+    },
+  };
+}

package/tsconfig.cjs.json

@@ -0,0 +1,14 @@
+{
+  "extends": "../../tsconfig.cjs.json",
+  "compilerOptions": {
+    "outDir": "./lib",
+    "rootDir": "./src",
+    "moduleResolution": "node",
+    "esModuleInterop": true,
+    "target": "es2018",
+    "lib": ["es2021", "es2021.intl", "dom"],
+    "skipLibCheck": true
+  },
+  "include": ["./src/**/*.ts"],
+  "exclude": ["./src/**/*.spec.ts"]
+}

package/tsconfig.typecheck.json

@@ -0,0 +1,4 @@
+{
+  "extends": "./tsconfig.cjs.json",
+  "exclude": []
+}