@messagevisor/module-interpolation 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-interpolation
+
+
+
+
+
+# [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-interpolation
+
+
+
+
+
+## 0.0.2 (2026-05-31)
+
+**Note:** Version bump only for package @messagevisor/module-interpolation

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-interpolation
+
+Visit [https://messagevisor.com/docs/modules/interpolation/](https://messagevisor.com/docs/modules/interpolation/) for more information.
+
+## License
+
+MIT © [Fahad Heylaal](https://fahad19.com)

package/jest.config.js

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

package/lib/index.d.ts

@@ -0,0 +1,6 @@
+import type { MessagevisorModule } from "@messagevisor/sdk";
+export interface InterpolationModuleOptions {
+    name?: string;
+    pattern?: RegExp;
+}
+export declare function createInterpolationModule(options?: InterpolationModuleOptions): MessagevisorModule;

package/lib/index.js

@@ -0,0 +1,31 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createInterpolationModule = createInterpolationModule;
+const DEFAULT_PATTERN = /\{([A-Za-z_][A-Za-z0-9_]*)\}/g;
+function toGlobalPattern(pattern = DEFAULT_PATTERN) {
+    const flags = Array.from(new Set(`${pattern.flags}g`.split(""))).join("");
+    return new RegExp(pattern.source, flags);
+}
+function isInterpolatableValue(value) {
+    return typeof value === "string" || typeof value === "number" || typeof value === "boolean";
+}
+function createInterpolationModule(options = {}) {
+    const pattern = toGlobalPattern(options.pattern);
+    return {
+        name: options.name || "interpolation",
+        format(payload) {
+            if (typeof payload.translation !== "string") {
+                return;
+            }
+            return payload.translation.replace(pattern, (match, variableName) => {
+                var _a;
+                if (typeof variableName !== "string") {
+                    return match;
+                }
+                const value = (_a = payload.values) === null || _a === void 0 ? void 0 : _a[variableName];
+                return isInterpolatableValue(value) ? String(value) : match;
+            });
+        },
+    };
+}
+//# sourceMappingURL=index.js.map

package/lib/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;AAkBA,8DAuBC;AAlCD,MAAM,eAAe,GAAG,+BAA+B,CAAC;AAExD,SAAS,eAAe,CAAC,UAAkB,eAAe;IACxD,MAAM,KAAK,GAAG,KAAK,CAAC,IAAI,CAAC,IAAI,GAAG,CAAC,GAAG,OAAO,CAAC,KAAK,GAAG,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IAC1E,OAAO,IAAI,MAAM,CAAC,OAAO,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC;AAC3C,CAAC;AAED,SAAS,qBAAqB,CAAC,KAAc;IAC3C,OAAO,OAAO,KAAK,KAAK,QAAQ,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,OAAO,KAAK,KAAK,SAAS,CAAC;AAC9F,CAAC;AAED,SAAgB,yBAAyB,CACvC,UAAsC,EAAE;IAExC,MAAM,OAAO,GAAG,eAAe,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;IAEjD,OAAO;QACL,IAAI,EAAE,OAAO,CAAC,IAAI,IAAI,eAAe;QACrC,MAAM,CAAC,OAAkC;YACvC,IAAI,OAAO,OAAO,CAAC,WAAW,KAAK,QAAQ,EAAE,CAAC;gBAC5C,OAAO;YACT,CAAC;YAED,OAAO,OAAO,CAAC,WAAW,CAAC,OAAO,CAAC,OAAO,EAAE,CAAC,KAAK,EAAE,YAAqB,EAAE,EAAE;;gBAC3E,IAAI,OAAO,YAAY,KAAK,QAAQ,EAAE,CAAC;oBACrC,OAAO,KAAK,CAAC;gBACf,CAAC;gBAED,MAAM,KAAK,GAAG,MAAA,OAAO,CAAC,MAAM,0CAAG,YAAY,CAAC,CAAC;gBAE7C,OAAO,qBAAqB,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC;YAC9D,CAAC,CAAC,CAAC;QACL,CAAC;KACF,CAAC;AACJ,CAAC"}

package/package.json

@@ -1,15 +1,44 @@
 {
-	"name": "@messagevisor/module-interpolation",
-	"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-interpolation",
+  "version": "0.2.0",
+  "description": "String interpolation 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"
+  },
+  "gitHead": "53cfef1a5ae28724b24226dd3a32ff813b063ce3"
 }

package/src/index.spec.ts

@@ -0,0 +1,169 @@
+import type { DatafileContent } from "@messagevisor/types";
+import { createMessagevisor } from "@messagevisor/sdk";
+import { createICUModule } from "@messagevisor/module-icu";
+
+import { createInterpolationModule } from "./index";
+
+const datafile: DatafileContent = {
+  schemaVersion: "1",
+  messagevisorVersion: "0.0.1",
+  revision: "1",
+  target: "web",
+  locale: "en-US",
+  formats: {
+    number: {
+      decimalFixed: { style: "decimal", minimumFractionDigits: 2, maximumFractionDigits: 2 },
+    },
+  },
+  segments: {},
+  messages: {
+    greeting: {},
+    repeated: {},
+    customPrefix: {},
+    mixedFormatting: {},
+  },
+  translations: {
+    greeting: "Hello {name}",
+    repeated: "{name} and {name} and {_value_2}",
+    customPrefix: "Hello %{name}",
+    mixedFormatting: "Total %{currency}{amount, number, decimalFixed}",
+  },
+};
+
+describe("@messagevisor/module-interpolation", function () {
+  it("interpolates default placeholders for translate and formatMessage", function () {
+    const m = createMessagevisor({
+      datafile,
+      modules: [createInterpolationModule()],
+    });
+
+    expect(m.translate("greeting", { name: "Ada" })).toEqual("Hello Ada");
+    expect(m.formatMessage("Hi {name}", { name: "Lin" })).toEqual("Hi Lin");
+  });
+
+  it("replaces repeated placeholders and supports uppercase, lowercase, digits, and underscores", function () {
+    const m = createMessagevisor({
+      datafile,
+      modules: [createInterpolationModule()],
+    });
+
+    expect(
+      m.translate("repeated", {
+        name: "Ada",
+        _value_2: "OK",
+      }),
+    ).toEqual("Ada and Ada and OK");
+    expect(
+      m.formatMessage("Vars {USER_1} {user_2}", {
+        USER_1: "A",
+        user_2: "B",
+      }),
+    ).toEqual("Vars A B");
+  });
+
+  it("leaves unknown, null, undefined, object, array, date, and function placeholders untouched", function () {
+    const m = createMessagevisor({
+      datafile,
+      modules: [createInterpolationModule()],
+    });
+
+    expect(m.formatMessage("Hello {name}", {})).toEqual("Hello {name}");
+    expect(m.formatMessage("Hello {name}", { name: null as any })).toEqual("Hello {name}");
+    expect(m.formatMessage("Hello {name}", { name: undefined as any })).toEqual("Hello {name}");
+    expect(m.formatMessage("Hello {name}", { name: { first: "Ada" } as any })).toEqual(
+      "Hello {name}",
+    );
+    expect(m.formatMessage("Hello {name}", { name: ["Ada"] as any })).toEqual("Hello {name}");
+    expect(m.formatMessage("Hello {name}", { name: new Date() as any })).toEqual("Hello {name}");
+    expect(
+      m.formatMessage("Hello {name}", {
+        name: (() => "Ada") as any,
+      }),
+    ).toEqual("Hello {name}");
+  });
+
+  it("interpolates string, number, and boolean values", function () {
+    const m = createMessagevisor({
+      datafile,
+      modules: [createInterpolationModule()],
+    });
+
+    expect(m.formatMessage("Name {name}", { name: "Ada" })).toEqual("Name Ada");
+    expect(m.formatMessage("Count {count}", { count: 12 })).toEqual("Count 12");
+    expect(m.formatMessage("Flag {enabled}", { enabled: false })).toEqual("Flag false");
+  });
+
+  it("skips processing when the incoming translation is not a string", function () {
+    const m = createMessagevisor({
+      datafile,
+      modules: [
+        {
+          name: "object-first",
+          format() {
+            return { value: "not-a-string" };
+          },
+        },
+        createInterpolationModule(),
+      ],
+    });
+
+    expect(m.translate("greeting", { name: "Ada" })).toEqual({ value: "not-a-string" });
+  });
+
+  it("supports custom regex patterns such as %{name}", function () {
+    const m = createMessagevisor({
+      datafile,
+      modules: [
+        createInterpolationModule({
+          pattern: /%\{([A-Za-z_][A-Za-z0-9_]*)\}/,
+        }),
+      ],
+    });
+
+    expect(m.translate("customPrefix", { name: "Ada" })).toEqual("Hello Ada");
+  });
+
+  it("composes with module-icu through module ordering", function () {
+    const m = createMessagevisor({
+      datafile,
+      modules: [
+        createInterpolationModule({
+          pattern: /%\{([A-Za-z_][A-Za-z0-9_]*)\}/,
+        }),
+        createICUModule(),
+      ],
+    });
+
+    expect(
+      m.translate("mixedFormatting", {
+        currency: "EUR",
+        amount: 12,
+      }),
+    ).toEqual("Total EUR12.00");
+  });
+
+  it("does not mutate payload values", function () {
+    const values = { name: "Ada" };
+    const m = createMessagevisor({
+      datafile,
+      modules: [createInterpolationModule()],
+    });
+
+    m.translate("greeting", values);
+
+    expect(values).toEqual({ name: "Ada" });
+  });
+
+  it("can be removed by its default name", function () {
+    const m = createMessagevisor({
+      datafile,
+      modules: [createInterpolationModule()],
+    });
+
+    expect(m.translate("greeting", { name: "Ada" })).toEqual("Hello Ada");
+
+    m.removeModule("interpolation");
+
+    expect(m.translate("greeting", { name: "Ada" })).toEqual("Hello {name}");
+  });
+});

package/src/index.ts

@@ -0,0 +1,42 @@
+import type { MessagevisorFormatPayload, MessagevisorModule } from "@messagevisor/sdk";
+
+export interface InterpolationModuleOptions {
+  name?: string;
+  pattern?: RegExp;
+}
+
+const DEFAULT_PATTERN = /\{([A-Za-z_][A-Za-z0-9_]*)\}/g;
+
+function toGlobalPattern(pattern: RegExp = DEFAULT_PATTERN) {
+  const flags = Array.from(new Set(`${pattern.flags}g`.split(""))).join("");
+  return new RegExp(pattern.source, flags);
+}
+
+function isInterpolatableValue(value: unknown): value is string | number | boolean {
+  return typeof value === "string" || typeof value === "number" || typeof value === "boolean";
+}
+
+export function createInterpolationModule(
+  options: InterpolationModuleOptions = {},
+): MessagevisorModule {
+  const pattern = toGlobalPattern(options.pattern);
+
+  return {
+    name: options.name || "interpolation",
+    format(payload: MessagevisorFormatPayload) {
+      if (typeof payload.translation !== "string") {
+        return;
+      }
+
+      return payload.translation.replace(pattern, (match, variableName: unknown) => {
+        if (typeof variableName !== "string") {
+          return match;
+        }
+
+        const value = payload.values?.[variableName];
+
+        return isInterpolatableValue(value) ? String(value) : match;
+      });
+    },
+  };
+}

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": []
+}