@ngx-runtime-i18n/core 1.0.0

package/README.md

@@ -0,0 +1,31 @@
+# @ngx-runtime-i18n
+
+Lightweight runtime internationalization core (framework-agnostic).
+
+Provides the core ICU-like formatting engine and catalog management.
+
+## Install
+
+```bash
+npm i @ngx-runtime-i18n
+```
+
+## Usage
+
+```ts
+import { formatIcu } from '@ngx-runtime-i18n/core';
+
+const catalog = {
+  hello: 'Hello {name}!',
+  'cart.items': '{count, plural, =0 {No items} one {1 item} other {# items}} in your cart',
+};
+
+formatIcu('en', 'hello', catalog, { name: 'Ashwin' });
+// → "Hello Ashwin!"
+```
+
+This package contains:
+
+- `formatIcu(lang, key, catalog, params, onMissingKey?)`
+- Type definitions (`Catalog`, `RuntimeI18nConfig`)
+- Utilities for Angular bindings (`@ngx-runtime-i18n/angular`)

package/fesm2022/ngx-runtime-i18n-core.mjs

@@ -0,0 +1,110 @@
+function formatIcu(_lang, key, cat, params = {}, onMissingKey) {
+    const raw = lookup(key, cat);
+    if (raw == null)
+        return onMissingKey ? onMissingKey(key) : key;
+    let out = String(raw);
+    // 1) Resolve {x, plural, ...} with a brace-balanced scanner.
+    out = replacePluralBlocks(out, (arg, body) => {
+        const n = Number(params[arg] ?? 0);
+        const options = parsePluralBody(body);
+        if (Number.isFinite(n)) {
+            const exact = options[`=${n}`];
+            if (exact)
+                return exact;
+            const one = options['one'];
+            if (n === 1 && one)
+                return one;
+            const other = options['other'] ?? '';
+            return other.replace(/#/g, String(n));
+        }
+        return options['other'] ?? '';
+    });
+    // 2) Simple {name} interpolation AFTER plural branch selection.
+    out = out.replace(/\{(\w+)\}/g, (_m, p1) => params[p1] != null ? String(params[p1]) : `{${p1}}`);
+    return out;
+}
+function lookup(path, obj) {
+    return path
+        .split('.')
+        .reduce((o, k) => (o && k in o ? o[k] : undefined), obj);
+}
+/**
+ * Replace all `{arg, plural, ...}` blocks in `s` using a brace-balanced scan.
+ */
+function replacePluralBlocks(s, render) {
+    let i = 0;
+    let out = '';
+    while (i < s.length) {
+        const start = s.indexOf('{', i);
+        if (start === -1) {
+            out += s.slice(i);
+            break;
+        }
+        out += s.slice(i, start);
+        // Try to match the prefix "{arg, plural,"
+        const prefixMatch = /\{(\w+),\s*plural,\s*/y;
+        prefixMatch.lastIndex = start;
+        const m = prefixMatch.exec(s);
+        if (!m) {
+            // Not a plural block; copy '{' and continue scanning after it.
+            out += '{';
+            i = start + 1;
+            continue;
+        }
+        const arg = m[1];
+        let j = prefixMatch.lastIndex; // position after the matched prefix
+        // Find the matching closing '}' for the whole plural block with nesting.
+        let depth = 1;
+        while (j < s.length && depth > 0) {
+            const ch = s.charAt(j++);
+            if (ch === '{')
+                depth++;
+            else if (ch === '}')
+                depth--;
+        }
+        if (depth !== 0) {
+            // Unbalanced; fall back to literal copy of the unmatched segment.
+            out += s.slice(start, j);
+            i = j;
+            continue;
+        }
+        // Body is the contents between prefix end and the final '}'.
+        const body = s.slice(prefixMatch.lastIndex, j - 1);
+        const rendered = render(arg, body);
+        out += rendered;
+        i = j; // continue after the closing brace
+    }
+    return out;
+}
+/** Parse a simple ICU plural clause body: e.g. `one {A} other {B} =0 {C}` */
+function parsePluralBody(body) {
+    const map = {};
+    // Allow balanced inner {...} in the value (non-greedy over balanced chunks is complex;
+    // we approximate by accepting any sequence without unbalanced braces at top level).
+    const re = /(one|other|=\d+)\s*\{((?:[^{}]|\{[^{}]*\})*)\}/g;
+    let m;
+    while ((m = re.exec(body)) !== null) {
+        const key = m[1];
+        const val = (m[2] ?? '');
+        map[key] = val;
+    }
+    return map;
+}
+
+/**
+ * @packageDocumentation
+ * Core runtime i18n primitives.
+ * Keep this surface minimal and stable.
+ */
+/**
+ * Lightweight ICU-style formatter used internally by the Angular service.
+ * Exposed as @experimental for advanced users or custom integrations.
+ * @experimental
+ */
+
+/**
+ * Generated bundle index. Do not edit.
+ */
+
+export { formatIcu };
+//# sourceMappingURL=ngx-runtime-i18n-core.mjs.map

package/fesm2022/ngx-runtime-i18n-core.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"ngx-runtime-i18n-core.mjs","sources":["../../../../libs/runtime-i18n/src/lib/icu.ts","../../../../libs/runtime-i18n/src/index.ts","../../../../libs/runtime-i18n/src/ngx-runtime-i18n-core.ts"],"sourcesContent":["/**\n * Very small ICU-like formatter with interpolation and plural basics.\n * Used by the Angular service and pipe. Replace with full ICU in a later minor.\n * @experimental\n */\nimport type { Catalog } from './types';\n\nexport function formatIcu(\n  _lang: string,\n  key: string,\n  cat: Catalog,\n  params: Record<string, unknown> = {},\n  onMissingKey?: (k: string) => string\n): string {\n  const raw = lookup(key, cat);\n  if (raw == null) return onMissingKey ? onMissingKey(key) : key;\n\n  let out = String(raw);\n\n  // 1) Resolve {x, plural, ...} with a brace-balanced scanner.\n  out = replacePluralBlocks(out, (arg, body) => {\n    const n = Number(params[arg] ?? 0);\n    const options = parsePluralBody(body);\n    if (Number.isFinite(n)) {\n      const exact = options[`=${n}`];\n      if (exact) return exact;\n      const one = options['one'];\n      if (n === 1 && one) return one;\n      const other = options['other'] ?? '';\n      return other.replace(/#/g, String(n));\n    }\n    return options['other'] ?? '';\n  });\n\n  // 2) Simple {name} interpolation AFTER plural branch selection.\n  out = out.replace(/\\{(\\w+)\\}/g, (_m: string, p1: string) =>\n    params[p1] != null ? String(params[p1]) : `{${p1}}`\n  );\n\n  return out;\n}\n\nfunction lookup(path: string, obj: any): any {\n  return path\n    .split('.')\n    .reduce((o: any, k: string) => (o && k in o ? o[k] : undefined), obj);\n}\n\n/**\n * Replace all `{arg, plural, ...}` blocks in `s` using a brace-balanced scan.\n */\nfunction replacePluralBlocks(\n  s: string,\n  render: (arg: string, body: string) => string\n): string {\n  let i = 0;\n  let out = '';\n\n  while (i < s.length) {\n    const start = s.indexOf('{', i);\n    if (start === -1) {\n      out += s.slice(i);\n      break;\n    }\n    out += s.slice(i, start);\n\n    // Try to match the prefix \"{arg, plural,\"\n    const prefixMatch = /\\{(\\w+),\\s*plural,\\s*/y;\n    prefixMatch.lastIndex = start;\n    const m = prefixMatch.exec(s);\n    if (!m) {\n      // Not a plural block; copy '{' and continue scanning after it.\n      out += '{';\n      i = start + 1;\n      continue;\n    }\n\n    const arg = m[1];\n    let j = prefixMatch.lastIndex; // position after the matched prefix\n\n    // Find the matching closing '}' for the whole plural block with nesting.\n    let depth = 1;\n    while (j < s.length && depth > 0) {\n      const ch = s.charAt(j++);\n      if (ch === '{') depth++;\n      else if (ch === '}') depth--;\n    }\n\n    if (depth !== 0) {\n      // Unbalanced; fall back to literal copy of the unmatched segment.\n      out += s.slice(start, j);\n      i = j;\n      continue;\n    }\n\n    // Body is the contents between prefix end and the final '}'.\n    const body = s.slice(prefixMatch.lastIndex, j - 1);\n    const rendered = render(arg, body);\n    out += rendered;\n    i = j; // continue after the closing brace\n  }\n\n  return out;\n}\n\n/** Parse a simple ICU plural clause body: e.g. `one {A} other {B} =0 {C}` */\nfunction parsePluralBody(body: string): Record<string, string> {\n  const map: Record<string, string> = {};\n  // Allow balanced inner {...} in the value (non-greedy over balanced chunks is complex;\n  // we approximate by accepting any sequence without unbalanced braces at top level).\n  const re = /(one|other|=\\d+)\\s*\\{((?:[^{}]|\\{[^{}]*\\})*)\\}/g;\n  let m: RegExpExecArray | null;\n  while ((m = re.exec(body)) !== null) {\n    const key = m[1] as string;\n    const val = (m[2] ?? '') as string;\n    map[key] = val;\n  }\n  return map;\n}\n","/**\n * @packageDocumentation\n * Core runtime i18n primitives.\n * Keep this surface minimal and stable.\n */\n\nexport type { Catalog, RuntimeI18nConfig } from './lib/types';\n\n/**\n * Lightweight ICU-style formatter used internally by the Angular service.\n * Exposed as @experimental for advanced users or custom integrations.\n * @experimental\n */\nexport { formatIcu } from './lib/icu';\n","/**\n * Generated bundle index. Do not edit.\n */\n\nexport * from './index';\n"],"names":[],"mappings":"AAOM,SAAU,SAAS,CACvB,KAAa,EACb,GAAW,EACX,GAAY,EACZ,MAAA,GAAkC,EAAE,EACpC,YAAoC,EAAA;IAEpC,MAAM,GAAG,GAAG,MAAM,CAAC,GAAG,EAAE,GAAG,CAAC;IAC5B,IAAI,GAAG,IAAI,IAAI;AAAE,QAAA,OAAO,YAAY,GAAG,YAAY,CAAC,GAAG,CAAC,GAAG,GAAG;AAE9D,IAAA,IAAI,GAAG,GAAG,MAAM,CAAC,GAAG,CAAC;;IAGrB,GAAG,GAAG,mBAAmB,CAAC,GAAG,EAAE,CAAC,GAAG,EAAE,IAAI,KAAI;QAC3C,MAAM,CAAC,GAAG,MAAM,CAAC,MAAM,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;AAClC,QAAA,MAAM,OAAO,GAAG,eAAe,CAAC,IAAI,CAAC;AACrC,QAAA,IAAI,MAAM,CAAC,QAAQ,CAAC,CAAC,CAAC,EAAE;YACtB,MAAM,KAAK,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA,CAAE,CAAC;AAC9B,YAAA,IAAI,KAAK;AAAE,gBAAA,OAAO,KAAK;AACvB,YAAA,MAAM,GAAG,GAAG,OAAO,CAAC,KAAK,CAAC;AAC1B,YAAA,IAAI,CAAC,KAAK,CAAC,IAAI,GAAG;AAAE,gBAAA,OAAO,GAAG;YAC9B,MAAM,KAAK,GAAG,OAAO,CAAC,OAAO,CAAC,IAAI,EAAE;YACpC,OAAO,KAAK,CAAC,OAAO,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC,CAAC,CAAC;QACvC;AACA,QAAA,OAAO,OAAO,CAAC,OAAO,CAAC,IAAI,EAAE;AAC/B,IAAA,CAAC,CAAC;;AAGF,IAAA,GAAG,GAAG,GAAG,CAAC,OAAO,CAAC,YAAY,EAAE,CAAC,EAAU,EAAE,EAAU,KACrD,MAAM,CAAC,EAAE,CAAC,IAAI,IAAI,GAAG,MAAM,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC,GAAG,IAAI,EAAE,CAAA,CAAA,CAAG,CACpD;AAED,IAAA,OAAO,GAAG;AACZ;AAEA,SAAS,MAAM,CAAC,IAAY,EAAE,GAAQ,EAAA;AACpC,IAAA,OAAO;SACJ,KAAK,CAAC,GAAG;AACT,SAAA,MAAM,CAAC,CAAC,CAAM,EAAE,CAAS,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,SAAS,CAAC,EAAE,GAAG,CAAC;AACzE;AAEA;;AAEG;AACH,SAAS,mBAAmB,CAC1B,CAAS,EACT,MAA6C,EAAA;IAE7C,IAAI,CAAC,GAAG,CAAC;IACT,IAAI,GAAG,GAAG,EAAE;AAEZ,IAAA,OAAO,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE;QACnB,MAAM,KAAK,GAAG,CAAC,CAAC,OAAO,CAAC,GAAG,EAAE,CAAC,CAAC;AAC/B,QAAA,IAAI,KAAK,KAAK,CAAC,CAAC,EAAE;AAChB,YAAA,GAAG,IAAI,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC;YACjB;QACF;QACA,GAAG,IAAI,CAAC,CAAC,KAAK,CAAC,CAAC,EAAE,KAAK,CAAC;;QAGxB,MAAM,WAAW,GAAG,wBAAwB;AAC5C,QAAA,WAAW,CAAC,SAAS,GAAG,KAAK;QAC7B,MAAM,CAAC,GAAG,WAAW,CAAC,IAAI,CAAC,CAAC,CAAC;QAC7B,IAAI,CAAC,CAAC,EAAE;;YAEN,GAAG,IAAI,GAAG;AACV,YAAA,CAAC,GAAG,KAAK,GAAG,CAAC;YACb;QACF;AAEA,QAAA,MAAM,GAAG,GAAG,CAAC,CAAC,CAAC,CAAC;AAChB,QAAA,IAAI,CAAC,GAAG,WAAW,CAAC,SAAS,CAAC;;QAG9B,IAAI,KAAK,GAAG,CAAC;QACb,OAAO,CAAC,GAAG,CAAC,CAAC,MAAM,IAAI,KAAK,GAAG,CAAC,EAAE;YAChC,MAAM,EAAE,GAAG,CAAC,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC;YACxB,IAAI,EAAE,KAAK,GAAG;AAAE,gBAAA,KAAK,EAAE;iBAClB,IAAI,EAAE,KAAK,GAAG;AAAE,gBAAA,KAAK,EAAE;QAC9B;AAEA,QAAA,IAAI,KAAK,KAAK,CAAC,EAAE;;YAEf,GAAG,IAAI,CAAC,CAAC,KAAK,CAAC,KAAK,EAAE,CAAC,CAAC;YACxB,CAAC,GAAG,CAAC;YACL;QACF;;AAGA,QAAA,MAAM,IAAI,GAAG,CAAC,CAAC,KAAK,CAAC,WAAW,CAAC,SAAS,EAAE,CAAC,GAAG,CAAC,CAAC;QAClD,MAAM,QAAQ,GAAG,MAAM,CAAC,GAAG,EAAE,IAAI,CAAC;QAClC,GAAG,IAAI,QAAQ;AACf,QAAA,CAAC,GAAG,CAAC,CAAC;IACR;AAEA,IAAA,OAAO,GAAG;AACZ;AAEA;AACA,SAAS,eAAe,CAAC,IAAY,EAAA;IACnC,MAAM,GAAG,GAA2B,EAAE;;;IAGtC,MAAM,EAAE,GAAG,iDAAiD;AAC5D,IAAA,IAAI,CAAyB;AAC7B,IAAA,OAAO,CAAC,CAAC,GAAG,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,IAAI,EAAE;AACnC,QAAA,MAAM,GAAG,GAAG,CAAC,CAAC,CAAC,CAAW;QAC1B,MAAM,GAAG,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,CAAW;AAClC,QAAA,GAAG,CAAC,GAAG,CAAC,GAAG,GAAG;IAChB;AACA,IAAA,OAAO,GAAG;AACZ;;ACtHA;;;;AAIG;AAIH;;;;AAIG;;ACZH;;AAEG;;;;"}

package/index.d.ts

@@ -0,0 +1,50 @@
+/**
+ * A translation catalog is a nested object where keys are dot-addressable.
+ * Example:
+ * {
+ *   "hello": { "user": "Hello, {name}!" },
+ *   "cart": { "items": "{count, plural, one {1 item} other {# items}}" }
+ * }
+ * Keys may contain ICU message syntax.
+ * @publicApi
+ */
+type Catalog = Record<string, unknown>;
+/**
+ * Runtime i18n configuration shared across CSR and SSR.
+ * Provide via {@link @ngx-runtime-i18n/angular!provideRuntimeI18n | provideRuntimeI18n()}.
+ * @publicApi
+ */
+interface RuntimeI18nConfig {
+    /**
+     * The language to render when no user preference is known.
+     * SSR should override per request (e.g., from URL/cookie).
+     */
+    defaultLang: string;
+    /**
+     * The set of allowed languages. `setLang()` will guard against values not in this list.
+     * Use BCP-47 tags (e.g., "en", "en-GB", "hi").
+     */
+    supported: string[];
+    /**
+     * Fetch a catalog at runtime. Must be idempotent and cancellable via AbortSignal.
+     * - Runs on the client only (the server should seed catalogs via TransferState).
+     * - Return a plain object (parsed JSON).
+     */
+    fetchCatalog: (lang: string, signal?: AbortSignal) => Promise<Catalog>;
+    /**
+     * Missing key handler. When omitted, the key itself is returned (useful in dev).
+     * Use to log or to inject a visible marker.
+     */
+    onMissingKey?: (key: string) => string;
+}
+
+/**
+ * Very small ICU-like formatter with interpolation and plural basics.
+ * Used by the Angular service and pipe. Replace with full ICU in a later minor.
+ * @experimental
+ */
+
+declare function formatIcu(_lang: string, key: string, cat: Catalog, params?: Record<string, unknown>, onMissingKey?: (k: string) => string): string;
+
+export { formatIcu };
+export type { Catalog, RuntimeI18nConfig };

package/package.json

@@ -0,0 +1,43 @@
+{
+  "name": "@ngx-runtime-i18n/core",
+  "version": "1.0.0",
+  "description": "Runtime i18n core with ICU-lite formatting",
+  "type": "module",
+  "sideEffects": false,
+  "keywords": [
+    "angular",
+    "i18n",
+    "internationalization",
+    "icu",
+    "runtime",
+    "ssr",
+    "signals"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/AshwinSathian/ngx-runtime-i18n.git"
+  },
+  "license": "MIT",
+  "exports": {
+    ".": {
+      "import": "./fesm2022/ngx-runtime-i18n-core.mjs",
+      "types": "./index.d.ts",
+      "default": "./fesm2022/ngx-runtime-i18n-core.mjs"
+    },
+    "./package.json": {
+      "default": "./package.json"
+    }
+  },
+  "publishConfig": {
+    "access": "public",
+    "provenance": false
+  },
+  "engines": {
+    "node": ">=18"
+  },
+  "module": "fesm2022/ngx-runtime-i18n-core.mjs",
+  "typings": "index.d.ts",
+  "dependencies": {
+    "tslib": "^2.3.0"
+  }
+}