@ooneex/translation 1.1.12 → 1.2.0

package/dist/index.d.ts

@@ -1,11 +1,37 @@
+import { EContainerScope } from "@ooneex/container";
 declare const locales: readonly ["ar", "bg", "cs", "da", "de", "el", "en", "eo", "es", "et", "eu", "fi", "fr", "hu", "hy", "it", "ja", "ko", "lt", "nl", "no", "pl", "pt", "ro", "ru", "sk", "sv", "th", "uk", "zh", "zh-tw"];
-import { Exception } from "@ooneex/exception";
-declare class TranslationException extends Exception {
-	constructor(message: string, key: string, data?: Record<string, unknown>);
-}
 type LocaleType = (typeof locales)[number];
 type LocaleInfoType = {
 	code: LocaleType;
 	region: string | null;
 };
-export { locales, TranslationException, LocaleType, LocaleInfoType };
+type TranslationLeafType = Partial<Record<LocaleType, string>>;
+type TranslationDictType = {
+	[key: string]: TranslationDictType | TranslationLeafType;
+};
+type TransParamsType = Record<string, boolean | number | bigint | string>;
+type TransOptionsType = {
+	lang?: LocaleType;
+	params?: TransParamsType;
+	count?: number;
+};
+interface ITranslation {
+	getName: () => string;
+	getDict: () => TranslationDictType;
+	has: (key: string) => boolean;
+	trans: (key: string, options?: TransOptionsType) => string;
+}
+type TranslationClassType = new (...args: any[]) => ITranslation;
+declare const decorator: {
+	translation: (scope?: EContainerScope) => (target: TranslationClassType) => void;
+};
+declare abstract class Translation implements ITranslation {
+	has(key: string): boolean;
+	trans(key: string, options?: TransOptionsType): string;
+	abstract getDict(): TranslationDictType;
+}
+import { Exception } from "@ooneex/exception";
+declare class TranslationException extends Exception {
+	constructor(message: string, key: string, data?: Record<string, unknown>);
+}
+export { locales, decorator, TranslationLeafType, TranslationException, TranslationDictType, TranslationClassType, Translation, TransParamsType, TransOptionsType, LocaleType, LocaleInfoType, ITranslation };

package/dist/index.js

@@ -1,3 +1,13 @@
+// @bun
+// src/decorators.ts
+import { container, EContainerScope } from "@ooneex/container";
+var decorator = {
+  translation: (scope = EContainerScope.Singleton) => {
+    return (target) => {
+      container.add(target, scope);
+    };
+  }
+};
 // src/locales.ts
 var locales = [
   "ar",
@@ -32,6 +42,9 @@ var locales = [
   "zh",
   "zh-tw"
 ];
+// src/Translation.ts
+import { has, trans } from "@ooneex/utils/trans";
+
 // src/TranslationException.ts
 import { Exception } from "@ooneex/exception";
 import { HttpStatus } from "@ooneex/http-status";
@@ -46,9 +59,39 @@ class TranslationException extends Exception {
     this.name = "TranslationException";
   }
 }
+
+// src/Translation.ts
+var FALLBACK_LOCALE = "en";
+
+class Translation {
+  has(key) {
+    return has(this.getDict(), key);
+  }
+  trans(key, options = {}) {
+    const lang = options.lang ?? FALLBACK_LOCALE;
+    const result = trans(this.getDict(), key, {
+      lang,
+      fallbackLang: FALLBACK_LOCALE,
+      params: options.params,
+      count: options.count
+    });
+    if (result.found) {
+      return result.value;
+    }
+    if (result.reason === "key") {
+      throw new TranslationException(`Translation key "${key}" not found`, "KEY_NOT_FOUND", {
+        key,
+        lang
+      });
+    }
+    throw new TranslationException(`Translation "${key}" is missing for locale "${lang}" and fallback "${FALLBACK_LOCALE}"`, "LOCALE_NOT_FOUND", { key, lang });
+  }
+}
 export {
   locales,
-  TranslationException
+  decorator,
+  TranslationException,
+  Translation
 };
 
-//# debugId=C1414D2FD0C9D40C64756E2164756E21
+//# debugId=5CCB49308EB7696F64756E2164756E21

package/dist/index.js.map

@@ -1,11 +1,13 @@
 {
   "version": 3,
-  "sources": ["src/locales.ts", "src/TranslationException.ts"],
+  "sources": ["src/decorators.ts", "src/locales.ts", "src/Translation.ts", "src/TranslationException.ts"],
   "sourcesContent": [
+    "import { container, EContainerScope } from \"@ooneex/container\";\nimport type { TranslationClassType } from \"./types\";\n\nexport const decorator = {\n  translation: (scope: EContainerScope = EContainerScope.Singleton) => {\n    return (target: TranslationClassType): void => {\n      container.add(target, scope);\n    };\n  },\n};\n",
     "export const locales = [\n  \"ar\",\n  \"bg\",\n  \"cs\",\n  \"da\",\n  \"de\",\n  \"el\",\n  \"en\",\n  \"eo\",\n  \"es\",\n  \"et\",\n  \"eu\",\n  \"fi\",\n  \"fr\",\n  \"hu\",\n  \"hy\",\n  \"it\",\n  \"ja\",\n  \"ko\",\n  \"lt\",\n  \"nl\",\n  \"no\",\n  \"pl\",\n  \"pt\",\n  \"ro\",\n  \"ru\",\n  \"sk\",\n  \"sv\",\n  \"th\",\n  \"uk\",\n  \"zh\",\n  \"zh-tw\",\n] as const;\n",
+    "import { has, trans } from \"@ooneex/utils/trans\";\nimport { TranslationException } from \"./TranslationException\";\nimport type { ITranslation, LocaleType, TranslationDictType, TransOptionsType } from \"./types\";\n\nconst FALLBACK_LOCALE: LocaleType = \"en\";\n\nexport abstract class Translation implements ITranslation {\n  public has(key: string): boolean {\n    return has(this.getDict(), key);\n  }\n\n  public trans(key: string, options: TransOptionsType = {}): string {\n    const lang = options.lang ?? FALLBACK_LOCALE;\n    const result = trans(this.getDict(), key, {\n      lang,\n      fallbackLang: FALLBACK_LOCALE,\n      params: options.params,\n      count: options.count,\n    });\n\n    if (result.found) {\n      return result.value;\n    }\n\n    if (result.reason === \"key\") {\n      throw new TranslationException(`Translation key \"${key}\" not found`, \"KEY_NOT_FOUND\", {\n        key,\n        lang,\n      });\n    }\n\n    throw new TranslationException(\n      `Translation \"${key}\" is missing for locale \"${lang}\" and fallback \"${FALLBACK_LOCALE}\"`,\n      \"LOCALE_NOT_FOUND\",\n      { key, lang },\n    );\n  }\n\n  public abstract getName(): string;\n\n  public abstract getDict(): TranslationDictType;\n}\n",
     "import { Exception } from \"@ooneex/exception\";\nimport { HttpStatus } from \"@ooneex/http-status\";\n\nexport class TranslationException extends Exception {\n  constructor(message: string, key: string, data: Record<string, unknown> = {}) {\n    super(message, {\n      key,\n      status: HttpStatus.Code.NotFound,\n      data,\n    });\n    this.name = \"TranslationException\";\n  }\n}\n"
   ],
-  "mappings": ";AAAO,IAAM,UAAU;AAAA,EACrB;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AACF;;AChCA;AACA;AAAA;AAEO,MAAM,6BAA6B,UAAU;AAAA,EAClD,WAAW,CAAC,SAAiB,KAAa,OAAgC,CAAC,GAAG;AAAA,IAC5E,MAAM,SAAS;AAAA,MACb;AAAA,MACA,QAAQ,WAAW,KAAK;AAAA,MACxB;AAAA,IACF,CAAC;AAAA,IACD,KAAK,OAAO;AAAA;AAEhB;",
-  "debugId": "C1414D2FD0C9D40C64756E2164756E21",
+  "mappings": ";;AAAA;AAGO,IAAM,YAAY;AAAA,EACvB,aAAa,CAAC,QAAyB,gBAAgB,cAAc;AAAA,IACnE,OAAO,CAAC,WAAuC;AAAA,MAC7C,UAAU,IAAI,QAAQ,KAAK;AAAA;AAAA;AAGjC;;ACTO,IAAM,UAAU;AAAA,EACrB;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AACF;;AChCA;;;ACAA;AACA;AAAA;AAEO,MAAM,6BAA6B,UAAU;AAAA,EAClD,WAAW,CAAC,SAAiB,KAAa,OAAgC,CAAC,GAAG;AAAA,IAC5E,MAAM,SAAS;AAAA,MACb;AAAA,MACA,QAAQ,WAAW,KAAK;AAAA,MACxB;AAAA,IACF,CAAC;AAAA,IACD,KAAK,OAAO;AAAA;AAEhB;;;ADRA,IAAM,kBAA8B;AAAA;AAE7B,MAAe,YAAoC;AAAA,EACjD,GAAG,CAAC,KAAsB;AAAA,IAC/B,OAAO,IAAI,KAAK,QAAQ,GAAG,GAAG;AAAA;AAAA,EAGzB,KAAK,CAAC,KAAa,UAA4B,CAAC,GAAW;AAAA,IAChE,MAAM,OAAO,QAAQ,QAAQ;AAAA,IAC7B,MAAM,SAAS,MAAM,KAAK,QAAQ,GAAG,KAAK;AAAA,MACxC;AAAA,MACA,cAAc;AAAA,MACd,QAAQ,QAAQ;AAAA,MAChB,OAAO,QAAQ;AAAA,IACjB,CAAC;AAAA,IAED,IAAI,OAAO,OAAO;AAAA,MAChB,OAAO,OAAO;AAAA,IAChB;AAAA,IAEA,IAAI,OAAO,WAAW,OAAO;AAAA,MAC3B,MAAM,IAAI,qBAAqB,oBAAoB,kBAAkB,iBAAiB;AAAA,QACpF;AAAA,QACA;AAAA,MACF,CAAC;AAAA,IACH;AAAA,IAEA,MAAM,IAAI,qBACR,gBAAgB,+BAA+B,uBAAuB,oBACtE,oBACA,EAAE,KAAK,KAAK,CACd;AAAA;AAMJ;",
+  "debugId": "5CCB49308EB7696F64756E2164756E21",
   "names": []
 }

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@ooneex/translation",
   "description": "Internationalization framework with locale management, translation key resolution, and pluralization support for multi-language applications",
-  "version": "1.1.12",
+  "version": "1.2.0",
   "type": "module",
   "files": [
     "dist",
@@ -29,8 +29,10 @@
     "wuchale": "bunx wuchale"
   },
   "dependencies": {
-    "@ooneex/exception": "^1.2.8",
-    "@ooneex/http-status": "^1.1.10"
+    "@ooneex/container": "^1.5.1",
+    "@ooneex/exception": "^1.2.10",
+    "@ooneex/http-status": "^1.1.11",
+    "@ooneex/utils": "^0.5.0"
   },
   "devDependencies": {},
   "keywords": [