1.0.2 - add scoped translation

GrandlineX · Sep 30, 2024 · 6b1aab7 · 6b1aab7
1 parent 19820ab
commit 6b1aab7
Show file tree

Hide file tree

Showing 4 changed files with 52 additions and 14 deletions.
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@grandlinex/bundle-multilang",
-  "version": "1.0.1",
+  "version": "1.0.2",
   "description": "",
   "type": "module",
   "exports": {

diff --git a/src/client/LangClient.ts b/src/client/LangClient.ts
@@ -26,18 +26,35 @@ export default class LangClient extends CoreClient<
     return !!(await this.getModule().getDb().lang.getObjById(code));
   }
 
-  async getLang(code: string): Promise<LangData | undefined> {
+  async getLang(
+    code: string,
+    scopes?: string[],
+  ): Promise<LangData | undefined> {
     const db = this.getModule().getDb();
     const lang = await db.lang.getObjById(code);
     if (!lang) {
       return undefined;
     }
+    let d: Translation[] = [];
+    if (!scopes) {
+      d = await db.translations.getObjList({
+        search: {
+          t_lang: lang.e_id,
+        },
+      });
+    } else {
+      for (const scope of scopes) {
+        d = d.concat(
+          await db.translations.getObjList({
+            search: {
+              t_lang: lang.e_id,
+              scope,
+            },
+          }),
+        );
+      }
+    }
 
-    const d = await db.translations.getObjList({
-      search: {
-        t_lang: lang.e_id,
-      },
-    });
     const nlang: LangData = {
       label: lang.label,
       code: lang.e_id,
@@ -47,16 +64,16 @@ export default class LangClient extends CoreClient<
     return nlang;
   }
 
-  async getDefault(): Promise<LangData | undefined> {
-    return this.getLang(await this.getDbLang());
+  async getDefault(scopes?: string[]): Promise<LangData | undefined> {
+    return this.getLang(await this.getDbLang(), scopes);
   }
 
-  async getCur(): Promise<LangData | null> {
+  async getCur(scopes?: string[]): Promise<LangData | null> {
     const db = this.getModule().getDb();
     if (await db.configExist(LangClient.DEFAULT_LANG_DB_KEY)) {
       const code = await db.getConfig(LangClient.DEFAULT_LANG_DB_KEY);
       if (code && (await this.hasLang(code.c_value))) {
-        const lang = await this.getLang(code.c_value);
+        const lang = await this.getLang(code.c_value, scopes);
         if (lang) {
           return lang;
         }
@@ -65,8 +82,8 @@ export default class LangClient extends CoreClient<
     return (await this.getDefault()) || null;
   }
 
-  async getCurTranslator(): Promise<GLang> {
-    return new GLang(await this.getCur(), this);
+  async getCurTranslator(scopes?: string[]): Promise<GLang> {
+    return new GLang(await this.getCur(scopes), this);
   }
 
   async getLangList(): Promise<{ code: string; label: string }[]> {
@@ -78,7 +95,7 @@ export default class LangClient extends CoreClient<
     );
   }
 
-  async loadLangFromFolder(path: string) {
+  async loadLangFromFolder(path: string, scope = 'default'): Promise<void> {
     const info = fs.statSync(path);
     const db = this.getModule().getDb();
     this.debug(path);
@@ -108,6 +125,7 @@ export default class LangClient extends CoreClient<
               await db.translations.createObject(
                 new Translation({
                   key,
+                  scope,
                   value: json[key],
                   t_lang: lang.e_id,
                 }),

diff --git a/src/db/entity/Translation.ts b/src/db/entity/Translation.ts
@@ -19,6 +19,11 @@ export default class Translation extends CoreEntity {
   })
   value: string;
 
+  @Column({
+    dataType: 'string',
+  })
+  scope: string;
+
   @EntityColumn(new Language())
   t_lang: string;
 
@@ -27,5 +32,6 @@ export default class Translation extends CoreEntity {
     this.key = props?.key || '';
     this.value = props?.value || '';
     this.t_lang = props?.t_lang || '';
+    this.scope = props?.scope || 'default';
   }
 }
diff --git a/src/tests/core.test.ts b/src/tests/core.test.ts
@@ -76,6 +76,20 @@ describe('TestDatabase', () => {
      expect(t.get("test.key.second")).toBe("helloWorldEn2")
      expect(t.get("test.key.third")).toBe("test.key.third")
    })
+   test("translator-default",async ()=>{
+     const client = mod.getClient()  as LangClient;
+     const t= await client.getCurTranslator(["default"]);
+     expect(t.get("test.key.first")).toBe("helloWorldEn")
+     expect(t.get("test.key.second")).toBe("helloWorldEn2")
+     expect(t.get("test.key.third")).toBe("test.key.third")
+   })
+   test("translator-missing",async ()=>{
+     const client = mod.getClient()  as LangClient;
+     const t= await client.getCurTranslator(["missing"]);
+     expect(t.get("test.key.first")).toBe("test.key.first")
+     expect(t.get("test.key.second")).toBe("test.key.second")
+     expect(t.get("test.key.third")).toBe("test.key.third")
+   })
    test("translator clear",async ()=>{
      const client = mod.getClient()  as LangClient;
      const t= await client.getCurTranslator();