@adminforth/i18n 1.0.7 → 1.0.9

package/dist/index.js

@@ -12,6 +12,19 @@ import iso6391 from 'iso-639-1';
 import path from 'path';
 import fs from 'fs-extra';
 import chokidar from 'chokidar';
+const SLAVIC_PLURAL_EXAMPLES = {
+    uk: 'яблук | Яблуко | Яблука | Яблук', // zero | singular | 2-4 | 5+
+    bg: 'ябълки | ябълка | ябълки | ябълки', // zero | singular | 2-4 | 5+
+    cs: 'jablek | jablko | jablka | jablek', // zero | singular | 2-4 | 5+
+    hr: 'jabuka | jabuka | jabuke | jabuka', // zero | singular | 2-4 | 5+
+    mk: 'јаболка | јаболко | јаболка | јаболка', // zero | singular | 2-4 | 5+
+    pl: 'jabłek | jabłko | jabłka | jabłek', // zero | singular | 2-4 | 5+
+    sk: 'jabĺk | jablko | jablká | jabĺk', // zero | singular | 2-4 | 5+
+    sl: 'jabolk | jabolko | jabolka | jabolk', // zero | singular | 2-4 | 5+
+    sr: 'јабука | јабука | јабуке | јабука', // zero | singular | 2-4 | 5+
+    be: 'яблыкаў | яблык | яблыкі | яблыкаў', // zero | singular | 2-4 | 5+
+    ru: 'яблок | яблоко | яблока | яблок', // zero | singular | 2-4 | 5+
+};
 class CachingAdapterMemory {
     constructor() {
         this.cache = {};
@@ -63,6 +76,17 @@ export default class I18N extends AdminForthPlugin {
             }, '');
         });
     }
+    updateUntranslatedMenuBadge() {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (this.menuItemWithBadgeId) {
+                const resource = this.adminforth.resource(this.resourceConfig.resourceId);
+                const count = yield resource.count([Filters.NEQ(this.options.completedFieldName, this.fullCompleatedFieldValue)]);
+                this.adminforth.websocket.publish(`/opentopic/update-menu-badge/${this.menuItemWithBadgeId}`, {
+                    badge: count || null
+                });
+            }
+        });
+    }
     modifyResourceConfig(adminforth, resourceConfig) {
         const _super = Object.create(null, {
             modifyResourceConfig: { get: () => super.modifyResourceConfig }
@@ -176,6 +200,7 @@ export default class I18N extends AdminForthPlugin {
                     for (const lang of langsChanged) {
                         this.cache.clear(`${this.resourceConfig.resourceId}:frontend:${lang}`);
                     }
+                    this.updateUntranslatedMenuBadge();
                 }
                 // clear frontend cache for all lan
                 return { ok: true };
@@ -249,6 +274,8 @@ export default class I18N extends AdminForthPlugin {
                                 return { ok: false, error: e.message };
                             }
                         }
+                        console.log('🪲bulkTranslate done', selectedIds);
+                        this.updateUntranslatedMenuBadge();
                         return {
                             ok: true, error: undefined,
                             successMessage: yield tr(`Translated {count} items`, 'frontend', { count: selectedIds.length }),
@@ -259,11 +286,11 @@ export default class I18N extends AdminForthPlugin {
             ;
             // if there is menu item with resourceId, add .badge function showing number of untranslated strings
             const addBadgeCountToMenuItem = (menuItem) => {
-                console.log('🪲menuItem, registring ', menuItem);
+                this.menuItemWithBadgeId = menuItem.itemId;
                 menuItem.badge = () => __awaiter(this, void 0, void 0, function* () {
                     const resource = adminforth.resource(menuItem.resourceId);
                     const count = yield resource.count([Filters.NEQ(this.options.completedFieldName, this.fullCompleatedFieldValue)]);
-                    return `${count}`;
+                    return count ? `${count}` : null;
                 });
                 menuItem.badgeTooltip = 'Untranslated count';
             };
@@ -313,8 +340,10 @@ export default class I18N extends AdminForthPlugin {
                     return;
                 }
                 const lang = langIsoCode;
+                const isSlavikPlural = Object.keys(SLAVIC_PLURAL_EXAMPLES).includes(lang);
                 const prompt = `
 I need to translate strings in JSON to ${lang} language from English for my web app.
+${isSlavikPlural ? `If string contains '|' it means it is plural form, you should provide 4 translations (zero | singular | 2-4 | 5+) e.g. ${SLAVIC_PLURAL_EXAMPLES[lang]}` : ''}
 Keep keys, as is, write translation into values! Here are the strings:
 
 \`\`\`json
@@ -324,8 +353,10 @@ ${JSON.stringify(strings.reduce((acc, s) => {
                 }, {}), null, 2)}
 \`\`\`
 `;
+                process.env.HEAVY_DEBUG && console.log('llm prompt', prompt);
                 // call OpenAI
                 const resp = yield this.options.completeAdapter.complete(prompt, [], 300);
+                process.env.HEAVY_DEBUG && console.log('llm resp', resp);
                 if (resp.error) {
                     throw new AiTranslateError(resp.error);
                 }
@@ -409,6 +440,8 @@ ${JSON.stringify(strings.reduce((acc, s) => {
                     console.error('🐛 Error creating record', e);
                 }
             })));
+            // updateBadge
+            this.updateUntranslatedMenuBadge();
         });
     }
     tryProcessAndWatch(adminforth) {
@@ -482,6 +515,7 @@ ${JSON.stringify(strings.reduce((acc, s) => {
                         [this.enFieldName]: msg,
                         [this.options.categoryFieldName]: category,
                     });
+                    this.updateUntranslatedMenuBadge();
                 }
                 // do this check here, to faster register missing translations
                 // also not cache it - no sense to cache english strings

package/index.ts

@@ -6,6 +6,20 @@ import path from 'path';
 import fs from 'fs-extra';
 import chokidar from 'chokidar';
 
+const SLAVIC_PLURAL_EXAMPLES = {
+  uk: 'яблук | Яблуко | Яблука | Яблук', // zero | singular | 2-4 | 5+
+  bg: 'ябълки | ябълка | ябълки | ябълки', // zero | singular | 2-4 | 5+
+  cs: 'jablek | jablko | jablka | jablek', // zero | singular | 2-4 | 5+
+  hr: 'jabuka | jabuka | jabuke | jabuka', // zero | singular | 2-4 | 5+
+  mk: 'јаболка | јаболко | јаболка | јаболка', // zero | singular | 2-4 | 5+
+  pl: 'jabłek | jabłko | jabłka | jabłek', // zero | singular | 2-4 | 5+
+  sk: 'jabĺk | jablko | jablká | jabĺk', // zero | singular | 2-4 | 5+
+  sl: 'jabolk | jabolko | jabolka | jabolk', // zero | singular | 2-4 | 5+
+  sr: 'јабука | јабука | јабуке | јабука', // zero | singular | 2-4 | 5+
+  be: 'яблыкаў | яблык | яблыкі | яблыкаў', // zero | singular | 2-4 | 5+
+  ru: 'яблок | яблоко | яблока | яблок', // zero | singular | 2-4 | 5+
+};
+
 interface ICachingAdapter {
   get(key: string): Promise<any>;
   set(key: string, value: any): Promise<void>;
@@ -43,6 +57,7 @@ export default class I18N extends AdminForthPlugin {
   enFieldName: string;
   cache: ICachingAdapter;
   primaryKeyFieldName: string;
+  menuItemWithBadgeId: string;
 
   adminforth: IAdminForth;
 
@@ -71,6 +86,18 @@ export default class I18N extends AdminForthPlugin {
     }, '');
   }
 
+  async updateUntranslatedMenuBadge() {
+    if (this.menuItemWithBadgeId) {
+      const resource = this.adminforth.resource(this.resourceConfig.resourceId);
+      const count = await resource.count([Filters.NEQ(this.options.completedFieldName, this.fullCompleatedFieldValue)]);
+
+      this.adminforth.websocket.publish(`/opentopic/update-menu-badge/${this.menuItemWithBadgeId}`, {
+        badge: count || null
+      });
+    }
+  }
+
+
   async modifyResourceConfig(adminforth: IAdminForth, resourceConfig: AdminForthResource) {
     super.modifyResourceConfig(adminforth, resourceConfig);
 
@@ -80,7 +107,6 @@ export default class I18N extends AdminForthPlugin {
         throw new Error(`Invalid language code ${lang}, please define valid ISO 639-1 language code (2 lowercase letters)`);
       }
     });
-
     
 
     // find primary key field
@@ -90,7 +116,6 @@ export default class I18N extends AdminForthPlugin {
       throw new Error(`Primary key field not found in resource ${resourceConfig.resourceId}`);
     }
 
-
     // parse trFieldNames
     for (const lang of this.options.supportedLanguages) {
       if (lang === 'en') {
@@ -201,6 +226,7 @@ export default class I18N extends AdminForthPlugin {
           this.cache.clear(`${this.resourceConfig.resourceId}:frontend:${lang}`);
         }
 
+        this.updateUntranslatedMenuBadge();
 
       }
       // clear frontend cache for all lan
@@ -286,6 +312,8 @@ export default class I18N extends AdminForthPlugin {
                 return { ok: false, error: e.message };
               }
             }
+            console.log('🪲bulkTranslate done', selectedIds);
+            this.updateUntranslatedMenuBadge();
             return { 
               ok: true, error: undefined, 
               successMessage: await tr(`Translated {count} items`, 'frontend', {count: selectedIds.length}),
@@ -295,15 +323,13 @@ export default class I18N extends AdminForthPlugin {
       );  
     };
 
-
     // if there is menu item with resourceId, add .badge function showing number of untranslated strings
-    
     const addBadgeCountToMenuItem = (menuItem: AdminForthConfigMenuItem) => {
-      console.log('🪲menuItem, registring ', menuItem);
+      this.menuItemWithBadgeId = menuItem.itemId;
       menuItem.badge = async () => {
         const resource = adminforth.resource(menuItem.resourceId);
         const count = await resource.count([Filters.NEQ(this.options.completedFieldName, this.fullCompleatedFieldValue)]);
-        return `${count}`;
+        return count ? `${count}` : null;
       };
       menuItem.badgeTooltip = 'Untranslated count';
     }
@@ -370,8 +396,12 @@ export default class I18N extends AdminForthPlugin {
         return;
       }
       const lang = langIsoCode;
+
+      const isSlavikPlural = Object.keys(SLAVIC_PLURAL_EXAMPLES).includes(lang);
+
       const prompt = `
 I need to translate strings in JSON to ${lang} language from English for my web app.
+${isSlavikPlural ? `If string contains '|' it means it is plural form, you should provide 4 translations (zero | singular | 2-4 | 5+) e.g. ${SLAVIC_PLURAL_EXAMPLES[lang]}` : ''}
 Keep keys, as is, write translation into values! Here are the strings:
 
 \`\`\`json
@@ -383,6 +413,9 @@ ${
 }
 \`\`\`
 `;
+
+      process.env.HEAVY_DEBUG && console.log('llm prompt', prompt);
+
       // call OpenAI
       const resp = await this.options.completeAdapter.complete(
         prompt,
@@ -390,6 +423,8 @@ ${
         300,
       );
 
+      process.env.HEAVY_DEBUG && console.log('llm resp', resp);
+
       if (resp.error) {
         throw new AiTranslateError(resp.error);
       }
@@ -488,7 +523,10 @@ ${
       } catch (e) {
         console.error('🐛 Error creating record', e);
       }
-    }))
+    }));
+
+    // updateBadge
+    this.updateUntranslatedMenuBadge()
 
 
   }
@@ -570,6 +608,7 @@ ${
             [this.enFieldName]: msg,
             [this.options.categoryFieldName]: category,
           });
+          this.updateUntranslatedMenuBadge();
         }
 
         // do this check here, to faster register missing translations

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@adminforth/i18n",
-  "version": "1.0.7",
+  "version": "1.0.9",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "type": "module",