intor-translator 1.2.1 → 1.2.3

package/README.md

@@ -38,6 +38,12 @@ yarn add intor-translator
 pnpm add intor-translator
 ```
 
+Or load it directly from a CDN:
+
+```js
+import { Translator } from "https://cdn.jsdelivr.net/npm/intor-translator/+esm";
+```
+
 ## Quick Start
 
 ```typescript

package/dist/index.cjs

@@ -2,7 +2,7 @@
 
 var rura = require('rura');
 
-// src/pipeline/hooks/find-message.ts
+// src/translators/core-translator/core-translator.ts
 
 // src/translators/shared/utils/find-message-in-locales.ts
 var findMessageInLocales = ({
@@ -275,6 +275,12 @@ var CoreTranslator = class extends BaseTranslator {
     }
     this.sortHooks();
   }
+  /** Outputs a debug overview of the active pipeline. */
+  debugHooks() {
+    return rura.rura.createPipeline(this.hooks).debugHooks(
+      (hooks) => `\u{1F916} Intor Translator pipeline (${hooks.length} hooks)`
+    );
+  }
   /** Check if a key exists in the specified locale or current locale. */
   hasKey = (key, targetLocale) => {
     return hasKey({

package/dist/index.d.cts

@@ -188,7 +188,7 @@ type LeafKeys<M, D extends number = DefaultDepth> = [D] extends [never] ? never
  * LocalizedNodeKeys // → string
  * ```
  */
-type LocalizedNodeKeys<M extends LocaleMessages | undefined = undefined, L extends keyof M | "union" = "union", D extends number = DefaultDepth> = [M] extends [undefined] ? string : L extends "union" ? NodeKeys<M[keyof M], D> : NodeKeys<M[Extract<L, keyof M>], D>;
+type LocalizedNodeKeys<M = unknown, L extends keyof M | "union" = "union", D extends number = DefaultDepth> = M extends LocaleMessages ? L extends "union" ? NodeKeys<M[keyof M], D> : NodeKeys<M[Extract<L, keyof M>], D> : string;
 /**
  * Extracts all **leaf keys** from the messages
  * of a specified locale (or union of locales).
@@ -211,7 +211,7 @@ type LocalizedNodeKeys<M extends LocaleMessages | undefined = undefined, L exten
  * LocalizedLeafKeys // → string
  * ```
  */
-type LocalizedLeafKeys<M extends LocaleMessages | undefined = undefined, L extends keyof M | "union" = "union", D extends number = DefaultDepth> = [M] extends [undefined] ? string : L extends "union" ? LeafKeys<M[keyof M], D> : LeafKeys<M[Extract<L, keyof M>], D>;
+type LocalizedLeafKeys<M = unknown, L extends keyof M | "union" = "union", D extends number = DefaultDepth> = M extends LocaleMessages ? L extends "union" ? LeafKeys<M[keyof M], D> : LeafKeys<M[Extract<L, keyof M>], D> : string;
 
 /**
  * Resolves the type at a dot-separated key in a nested object.
@@ -351,7 +351,7 @@ interface BaseTranslatorOptions<M = unknown> {
  *
  * @template M - Shape of the messages object.
  */
-declare class BaseTranslator<M extends LocaleMessages> {
+declare class BaseTranslator<M extends LocaleMessages | unknown = unknown> {
     /** Current messages for translation */
     protected _messages: Readonly<M>;
     /** Current active locale */
@@ -400,7 +400,7 @@ interface TranslatorPlugin {
  * @template M - Shape of the messages object.
  * @template L - Locale selection strategy ("union" or specific locale keys).
  */
-declare class CoreTranslator<M extends LocaleMessages, L extends keyof M | "union" = "union"> extends BaseTranslator<M> {
+declare class CoreTranslator<M extends LocaleMessages | unknown = unknown, L extends keyof M | "union" = "union"> extends BaseTranslator<M> {
     /** User-provided options including messages, locale, and config. */
     protected translateConfig: TranslateConfig<M>;
     /** Active pipeline hooks applied during translation. */
@@ -410,6 +410,8 @@ declare class CoreTranslator<M extends LocaleMessages, L extends keyof M | "unio
     private sortHooks;
     /** Register a plugin or a raw pipeline hook. */
     use(plugin: TranslatorPlugin | TranslateHook): void;
+    /** Outputs a debug overview of the active pipeline. */
+    debugHooks(): void;
     /** Check if a key exists in the specified locale or current locale. */
     hasKey: <K extends LocalizedLeafKeys<M, L>>(key: K, targetLocale?: Locale<M>) => boolean;
     /** Get the translated message for a key, with optional replacements. */
@@ -417,12 +419,12 @@ declare class CoreTranslator<M extends LocaleMessages, L extends keyof M | "unio
 }
 
 type ScopeTranslatorOptions<M> = CoreTranslatorOptions<M>;
-type ScopeTranslatorMethods<M extends LocaleMessages | undefined = undefined, L extends keyof M | "union" = "union", K = LocalizedLeafKeys<M, L>> = {
+type ScopeTranslatorMethods<M extends LocaleMessages | unknown = unknown, L extends keyof M | "union" = "union", K = LocalizedLeafKeys<M, L>> = {
     hasKey: (key?: K, targetLocale?: Locale<M>) => boolean;
     t: <Result = string>(key?: K, replacements?: Replacement) => Result;
 };
 
-declare class ScopeTranslator<M extends LocaleMessages, L extends keyof M | "union" = "union"> extends CoreTranslator<M> {
+declare class ScopeTranslator<M extends LocaleMessages | unknown = unknown, L extends keyof M | "union" = "union"> extends CoreTranslator<M> {
     constructor(options: ScopeTranslatorOptions<M>);
     /** Create a scoped translator with a prefix key, providing `t` and `hasKey` for nested keys. */
     scoped<PK extends LocalizedNodeKeys<M, L> | undefined = undefined>(preKey?: PK): PK extends string ? ScopeTranslatorMethods<M, L, ScopedLeafKeys<M, PK, L>> : ScopeTranslatorMethods<M, L>;

package/dist/index.d.ts

@@ -188,7 +188,7 @@ type LeafKeys<M, D extends number = DefaultDepth> = [D] extends [never] ? never
  * LocalizedNodeKeys // → string
  * ```
  */
-type LocalizedNodeKeys<M extends LocaleMessages | undefined = undefined, L extends keyof M | "union" = "union", D extends number = DefaultDepth> = [M] extends [undefined] ? string : L extends "union" ? NodeKeys<M[keyof M], D> : NodeKeys<M[Extract<L, keyof M>], D>;
+type LocalizedNodeKeys<M = unknown, L extends keyof M | "union" = "union", D extends number = DefaultDepth> = M extends LocaleMessages ? L extends "union" ? NodeKeys<M[keyof M], D> : NodeKeys<M[Extract<L, keyof M>], D> : string;
 /**
  * Extracts all **leaf keys** from the messages
  * of a specified locale (or union of locales).
@@ -211,7 +211,7 @@ type LocalizedNodeKeys<M extends LocaleMessages | undefined = undefined, L exten
  * LocalizedLeafKeys // → string
  * ```
  */
-type LocalizedLeafKeys<M extends LocaleMessages | undefined = undefined, L extends keyof M | "union" = "union", D extends number = DefaultDepth> = [M] extends [undefined] ? string : L extends "union" ? LeafKeys<M[keyof M], D> : LeafKeys<M[Extract<L, keyof M>], D>;
+type LocalizedLeafKeys<M = unknown, L extends keyof M | "union" = "union", D extends number = DefaultDepth> = M extends LocaleMessages ? L extends "union" ? LeafKeys<M[keyof M], D> : LeafKeys<M[Extract<L, keyof M>], D> : string;
 
 /**
  * Resolves the type at a dot-separated key in a nested object.
@@ -351,7 +351,7 @@ interface BaseTranslatorOptions<M = unknown> {
  *
  * @template M - Shape of the messages object.
  */
-declare class BaseTranslator<M extends LocaleMessages> {
+declare class BaseTranslator<M extends LocaleMessages | unknown = unknown> {
     /** Current messages for translation */
     protected _messages: Readonly<M>;
     /** Current active locale */
@@ -400,7 +400,7 @@ interface TranslatorPlugin {
  * @template M - Shape of the messages object.
  * @template L - Locale selection strategy ("union" or specific locale keys).
  */
-declare class CoreTranslator<M extends LocaleMessages, L extends keyof M | "union" = "union"> extends BaseTranslator<M> {
+declare class CoreTranslator<M extends LocaleMessages | unknown = unknown, L extends keyof M | "union" = "union"> extends BaseTranslator<M> {
     /** User-provided options including messages, locale, and config. */
     protected translateConfig: TranslateConfig<M>;
     /** Active pipeline hooks applied during translation. */
@@ -410,6 +410,8 @@ declare class CoreTranslator<M extends LocaleMessages, L extends keyof M | "unio
     private sortHooks;
     /** Register a plugin or a raw pipeline hook. */
     use(plugin: TranslatorPlugin | TranslateHook): void;
+    /** Outputs a debug overview of the active pipeline. */
+    debugHooks(): void;
     /** Check if a key exists in the specified locale or current locale. */
     hasKey: <K extends LocalizedLeafKeys<M, L>>(key: K, targetLocale?: Locale<M>) => boolean;
     /** Get the translated message for a key, with optional replacements. */
@@ -417,12 +419,12 @@ declare class CoreTranslator<M extends LocaleMessages, L extends keyof M | "unio
 }
 
 type ScopeTranslatorOptions<M> = CoreTranslatorOptions<M>;
-type ScopeTranslatorMethods<M extends LocaleMessages | undefined = undefined, L extends keyof M | "union" = "union", K = LocalizedLeafKeys<M, L>> = {
+type ScopeTranslatorMethods<M extends LocaleMessages | unknown = unknown, L extends keyof M | "union" = "union", K = LocalizedLeafKeys<M, L>> = {
     hasKey: (key?: K, targetLocale?: Locale<M>) => boolean;
     t: <Result = string>(key?: K, replacements?: Replacement) => Result;
 };
 
-declare class ScopeTranslator<M extends LocaleMessages, L extends keyof M | "union" = "union"> extends CoreTranslator<M> {
+declare class ScopeTranslator<M extends LocaleMessages | unknown = unknown, L extends keyof M | "union" = "union"> extends CoreTranslator<M> {
     constructor(options: ScopeTranslatorOptions<M>);
     /** Create a scoped translator with a prefix key, providing `t` and `hasKey` for nested keys. */
     scoped<PK extends LocalizedNodeKeys<M, L> | undefined = undefined>(preKey?: PK): PK extends string ? ScopeTranslatorMethods<M, L, ScopedLeafKeys<M, PK, L>> : ScopeTranslatorMethods<M, L>;

package/dist/index.js

@@ -1,6 +1,6 @@
 import { rura } from 'rura';
 
-// src/pipeline/hooks/find-message.ts
+// src/translators/core-translator/core-translator.ts
 
 // src/translators/shared/utils/find-message-in-locales.ts
 var findMessageInLocales = ({
@@ -273,6 +273,12 @@ var CoreTranslator = class extends BaseTranslator {
     }
     this.sortHooks();
   }
+  /** Outputs a debug overview of the active pipeline. */
+  debugHooks() {
+    return rura.createPipeline(this.hooks).debugHooks(
+      (hooks) => `\u{1F916} Intor Translator pipeline (${hooks.length} hooks)`
+    );
+  }
   /** Check if a key exists in the specified locale or current locale. */
   hasKey = (key, targetLocale) => {
     return hasKey({

package/package.json

@@ -1,9 +1,12 @@
 {
   "name": "intor-translator",
-  "version": "1.2.1",
+  "version": "1.2.3",
   "description": "🤖 A modern, type-safe i18n engine.",
-  "author": "Yiming Liao",
-  "license": "MIT",
+  "author": {
+    "name": "Yiming Liao",
+    "email": "yimingliao.official@gmail.com",
+    "url": "https://github.com/yiming-liao"
+  },
   "homepage": "https://github.com/yiming-liao/intor-translator#readme",
   "repository": {
     "type": "git",
@@ -12,6 +15,10 @@
   "bugs": {
     "url": "https://github.com/yiming-liao/intor-translator/issues"
   },
+  "funding": {
+    "type": "github",
+    "url": "https://github.com/sponsors/yiming-liao"
+  },
   "keywords": [
     "i18n",
     "internationalization",
@@ -21,6 +28,8 @@
     "i18n engine",
     "translator"
   ],
+  "license": "MIT",
+  "type": "module",
   "exports": {
     ".": {
       "types": "./dist/index.d.ts",
@@ -36,7 +45,10 @@
     "README.md",
     "LICENSE"
   ],
-  "type": "module",
+  "sideEffects": false,
+  "engines": {
+    "node": ">=16.0.0"
+  },
   "scripts": {
     "build": "tsup",
     "prepublishOnly": "yarn build",
@@ -47,32 +59,28 @@
     "knip": "knip --config .config/knip.config.ts",
     "examples:html": "vite --config examples/html/vite.config.ts"
   },
-  "sideEffects": false,
-  "engines": {
-    "node": ">=16.0.0"
-  },
   "dependencies": {
     "rura": "1.0.7"
   },
   "devDependencies": {
-    "@types/node": "^24.10.1",
-    "@vitest/coverage-v8": "4.0.15",
-    "eslint": "^9.39.1",
-    "eslint-config-prettier": "^10.1.8",
-    "eslint-import-resolver-typescript": "^4.4.4",
-    "eslint-plugin-import": "^2.32.0",
-    "eslint-plugin-prettier": "^5.5.4",
-    "eslint-plugin-unicorn": "^62.0.0",
-    "eslint-plugin-unused-imports": "^4.3.0",
-    "intl-messageformat": "^10.7.16",
-    "knip": "^5.69.1",
-    "prettier": "^3.6.2",
-    "ts-node": "^10.9.2",
-    "tsd": "^0.33.0",
-    "tsup": "^8.4.0",
-    "typescript": "^5.8.3",
-    "typescript-eslint": "^8.46.4",
-    "vite": "^7.2.6",
-    "vitest": "^4.0.9"
+    "@types/node": "24.10.1",
+    "@vitest/coverage-v8": "4.0.16",
+    "eslint": "9.39.1",
+    "eslint-config-prettier": "10.1.8",
+    "eslint-import-resolver-typescript": "4.4.4",
+    "eslint-plugin-import": "2.32.0",
+    "eslint-plugin-prettier": "5.5.4",
+    "eslint-plugin-unicorn": "62.0.0",
+    "eslint-plugin-unused-imports": "4.3.0",
+    "intl-messageformat": "10.7.16",
+    "knip": "5.69.1",
+    "prettier": "3.6.2",
+    "ts-node": "10.9.2",
+    "tsd": "0.33.0",
+    "tsup": "8.4.0",
+    "typescript": "5.8.3",
+    "typescript-eslint": "8.46.4",
+    "vite": "7.2.6",
+    "vitest": "4.0.16"
   }
 }