@adminforth/i18n 1.0.9 → 1.0.11

package/Changelog.md

@@ -0,0 +1,13 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [v1.0.10]
+
+## Fixed
+
+- fix automatic translations for duplicate strings
+- improve slavik pluralization generations by splitting the requests

package/custom/langCommon.ts

@@ -54,6 +54,7 @@ const countryISO31661ByLangISO6391 = {
     ko: 'kr', // Korean → South Korea
     ja: 'jp', // Japanese → Japan
     uk: 'ua', // Ukrainian → Ukraine
+    ur: 'pk', // Urdu → Pakistan
 };
 
 export function getCountryCodeFromLangCode(langCode) {

package/dist/custom/langCommon.ts

@@ -54,6 +54,7 @@ const countryISO31661ByLangISO6391 = {
     ko: 'kr', // Korean → South Korea
     ja: 'jp', // Japanese → Japan
     uk: 'ua', // Ukrainian → Ukraine
+    ur: 'pk', // Urdu → Pakistan
 };
 
 export function getCountryCodeFromLangCode(langCode) {

package/dist/index.js

@@ -205,29 +205,38 @@ export default class I18N extends AdminForthPlugin {
                 // clear frontend cache for all lan
                 return { ok: true };
             }));
+            // add hook on delete of any translation to reset cache
+            resourceConfig.hooks.delete.afterSave.push((_d) => __awaiter(this, [_d], void 0, function* ({ record }) {
+                for (const lang of this.options.supportedLanguages) {
+                    this.cache.clear(`${this.resourceConfig.resourceId}:frontend:${lang}`);
+                    this.cache.clear(`${this.resourceConfig.resourceId}:${record[this.options.categoryFieldName]}:${lang}:${record[this.enFieldName]}`);
+                }
+                this.updateUntranslatedMenuBadge();
+                return { ok: true };
+            }));
             if (this.options.completedFieldName) {
                 // on show and list add a list hook which will add incomplete field to record if translation is missing for at least one language
                 const addIncompleteField = (record) => {
                     // form list of all langs, sorted by alphabet, without en, to get 'al|ro|uk'
                     record.fully_translated = this.fullCompleatedFieldValue === record[this.options.completedFieldName];
                 };
-                resourceConfig.hooks.list.afterDatasourceResponse.push((_d) => __awaiter(this, [_d], void 0, function* ({ response }) {
+                resourceConfig.hooks.list.afterDatasourceResponse.push((_e) => __awaiter(this, [_e], void 0, function* ({ response }) {
                     response.forEach(addIncompleteField);
                     return { ok: true };
                 }));
-                resourceConfig.hooks.show.afterDatasourceResponse.push((_e) => __awaiter(this, [_e], void 0, function* ({ response }) {
+                resourceConfig.hooks.show.afterDatasourceResponse.push((_f) => __awaiter(this, [_f], void 0, function* ({ response }) {
                     addIncompleteField(response.length && response[0]);
                     return { ok: true };
                 }));
                 // also add edit hook beforeSave to update completedFieldName
-                resourceConfig.hooks.edit.beforeSave.push((_f) => __awaiter(this, [_f], void 0, function* ({ record, oldRecord }) {
+                resourceConfig.hooks.edit.beforeSave.push((_g) => __awaiter(this, [_g], void 0, function* ({ record, oldRecord }) {
                     const futureRecord = Object.assign(Object.assign({}, oldRecord), record);
                     const futureCompletedFieldValue = yield this.computeCompletedFieldValue(futureRecord);
                     record[this.options.completedFieldName] = futureCompletedFieldValue;
                     return { ok: true };
                 }));
                 // add list hook to support filtering by fully_translated virtual field
-                resourceConfig.hooks.list.beforeDatasourceRequest.push((_g) => __awaiter(this, [_g], void 0, function* ({ query }) {
+                resourceConfig.hooks.list.beforeDatasourceRequest.push((_h) => __awaiter(this, [_h], void 0, function* ({ query }) {
                     if (!query.filters || query.filters.length === 0) {
                         query.filters = [];
                     }
@@ -265,7 +274,7 @@ export default class I18N extends AdminForthPlugin {
                     // if optional `confirm` is provided, user will be asked to confirm action
                     confirm: 'Are you sure you want to translate selected items?',
                     state: 'selected',
-                    action: (_h) => __awaiter(this, [_h], void 0, function* ({ selectedIds, tr }) {
+                    action: (_j) => __awaiter(this, [_j], void 0, function* ({ selectedIds, tr }) {
                         try {
                             yield this.bulkTranslate({ selectedIds });
                         }
@@ -308,6 +317,7 @@ export default class I18N extends AdminForthPlugin {
             });
         });
     }
+    // returns translated count
     bulkTranslate(_a) {
         return __awaiter(this, arguments, void 0, function* ({ selectedIds }) {
             const needToTranslateByLang = {};
@@ -331,19 +341,24 @@ export default class I18N extends AdminForthPlugin {
             }
             const maxKeysInOneReq = 10;
             const updateStrings = {};
-            const translateToLang = (langIsoCode, strings) => __awaiter(this, void 0, void 0, function* () {
+            const translateToLang = (langIsoCode_1, strings_1, ...args_1) => __awaiter(this, [langIsoCode_1, strings_1, ...args_1], void 0, function* (langIsoCode, strings, plurals = false) {
+                if (strings.length === 0) {
+                    return 0;
+                }
                 if (strings.length > maxKeysInOneReq) {
+                    let totalTranslated = 0;
                     for (let i = 0; i < strings.length; i += maxKeysInOneReq) {
                         const slicedStrings = strings.slice(i, i + maxKeysInOneReq);
-                        yield translateToLang(langIsoCode, slicedStrings);
+                        console.log('🪲🔪slicedStrings ', slicedStrings);
+                        totalTranslated += yield translateToLang(langIsoCode, slicedStrings, plurals);
                     }
-                    return;
+                    return totalTranslated;
                 }
                 const lang = langIsoCode;
-                const isSlavikPlural = Object.keys(SLAVIC_PLURAL_EXAMPLES).includes(lang);
+                const requestSlavicPlurals = Object.keys(SLAVIC_PLURAL_EXAMPLES).includes(lang) && plurals;
                 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]}` : ''}
+${requestSlavicPlurals ? `You should provide 4 translations (in format zero | singular | 2-4 | 5+) e.g. ${SLAVIC_PLURAL_EXAMPLES[lang]}` : ''}
 Keep keys, as is, write translation into values! Here are the strings:
 
 \`\`\`json
@@ -378,22 +393,29 @@ ${JSON.stringify(strings.reduce((acc, s) => {
                     const translationsTargeted = translations.filter(t => t[this.enFieldName] === enStr);
                     // might be several with same en_string
                     for (const translation of translationsTargeted) {
-                        translation[this.trFieldNames[lang]] = translatedStr;
+                        //translation[this.trFieldNames[lang]] = translatedStr;
                         // process.env.HEAVY_DEBUG && console.log(`🪲translated to ${lang} ${translation.en_string}, ${translatedStr}`)
-                        if (!updateStrings[enStr]) {
-                            updateStrings[enStr] = {
+                        if (!updateStrings[translation[this.primaryKeyFieldName]]) {
+                            updateStrings[translation[this.primaryKeyFieldName]] = {
                                 updates: {},
+                                translatedStr,
                                 category: translation[this.options.categoryFieldName],
                                 strId: translation[this.primaryKeyFieldName],
                             };
                         }
-                        updateStrings[enStr].updates[this.trFieldNames[lang]] = translatedStr;
+                        updateStrings[translation[this.primaryKeyFieldName]].updates[this.trFieldNames[lang]] = translatedStr;
                     }
                 }
+                return res.length;
             });
             const langsInvolved = new Set(Object.keys(needToTranslateByLang));
+            let totalTranslated = 0;
             yield Promise.all(Object.entries(needToTranslateByLang).map((_b) => __awaiter(this, [_b], void 0, function* ([lang, strings]) {
-                yield translateToLang(lang, strings);
+                // first translate without plurals
+                const stringsWithoutPlurals = strings.filter(s => !s.en_string.includes('|'));
+                totalTranslated += yield translateToLang(lang, stringsWithoutPlurals, false);
+                const stringsWithPlurals = strings.filter(s => s.en_string.includes('|'));
+                totalTranslated += yield translateToLang(lang, stringsWithPlurals, true);
             })));
             yield Promise.all(Object.entries(updateStrings).map((_c) => __awaiter(this, [_c], void 0, function* ([_, { updates, strId }]) {
                 // because this will translate all languages, we can set completedLangs to all languages
@@ -406,6 +428,7 @@ ${JSON.stringify(strings.reduce((acc, s) => {
                     this.cache.clear(`${this.resourceConfig.resourceId}:${category}:${lang}:${enStr}`);
                 }
             }
+            return totalTranslated;
         });
     }
     processExtractedMessages(adminforth, filePath) {

package/index.ts

@@ -234,6 +234,16 @@ export default class I18N extends AdminForthPlugin {
       return { ok: true };
     });
 
+    // add hook on delete of any translation to reset cache
+    resourceConfig.hooks.delete.afterSave.push(async ({ record }: { record: any }): Promise<{ ok: boolean, error?: string }> => {
+      for (const lang of this.options.supportedLanguages) {
+        this.cache.clear(`${this.resourceConfig.resourceId}:frontend:${lang}`);
+        this.cache.clear(`${this.resourceConfig.resourceId}:${record[this.options.categoryFieldName]}:${lang}:${record[this.enFieldName]}`);
+      }
+      this.updateUntranslatedMenuBadge();
+      return { ok: true };
+    });
+
     if (this.options.completedFieldName) {
       // on show and list add a list hook which will add incomplete field to record if translation is missing for at least one language
       const addIncompleteField = (record: any) => {
@@ -347,7 +357,8 @@ export default class I18N extends AdminForthPlugin {
     });
   }
 
-  async bulkTranslate({ selectedIds }: { selectedIds: string[] }) {
+  // returns translated count
+  async bulkTranslate({ selectedIds }: { selectedIds: string[] }): Promise<number> {
 
     const needToTranslateByLang : Partial<
       Record<
@@ -382,26 +393,33 @@ export default class I18N extends AdminForthPlugin {
     const maxKeysInOneReq = 10;
 
     const updateStrings: Record<string, { 
-      updates: any, category: string, strId: string
+      updates: any, 
+      category: string,
+      strId: string,
+      translatedStr: string
      }> = {};
 
-    const translateToLang = async (langIsoCode: LanguageCode, strings: { en_string: string, category: string }[]) => {
-
+    const translateToLang = async (langIsoCode: LanguageCode, strings: { en_string: string, category: string }[], plurals=false): Promise<number> => {
+      if (strings.length === 0) {
+        return 0;
+      }
 
       if (strings.length > maxKeysInOneReq) {
+        let totalTranslated = 0;
         for (let i = 0; i < strings.length; i += maxKeysInOneReq) {
           const slicedStrings = strings.slice(i, i + maxKeysInOneReq);
-          await translateToLang(langIsoCode, slicedStrings);
+          console.log('🪲🔪slicedStrings ', slicedStrings);
+          totalTranslated += await translateToLang(langIsoCode, slicedStrings, plurals);
         }
-        return;
+        return totalTranslated;
       }
       const lang = langIsoCode;
 
-      const isSlavikPlural = Object.keys(SLAVIC_PLURAL_EXAMPLES).includes(lang);
+      const requestSlavicPlurals = Object.keys(SLAVIC_PLURAL_EXAMPLES).includes(lang) && plurals;
 
       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]}` : ''}
+${requestSlavicPlurals ? `You should provide 4 translations (in format zero | singular | 2-4 | 5+) e.g. ${SLAVIC_PLURAL_EXAMPLES[lang]}` : ''}
 Keep keys, as is, write translation into values! Here are the strings:
 
 \`\`\`json
@@ -442,29 +460,42 @@ ${
         return;
       }
       res = JSON.parse(res);
-      for (const [enStr, translatedStr] of Object.entries(res)) {
+
+
+      for (const [enStr, translatedStr] of Object.entries(res) as [string, string][]) {
         const translationsTargeted = translations.filter(t => t[this.enFieldName] === enStr);
         // might be several with same en_string
         for (const translation of translationsTargeted) {
-          translation[this.trFieldNames[lang]] = translatedStr;
+          //translation[this.trFieldNames[lang]] = translatedStr;
           // process.env.HEAVY_DEBUG && console.log(`🪲translated to ${lang} ${translation.en_string}, ${translatedStr}`)
-          if (!updateStrings[enStr]) {
-            updateStrings[enStr] = {
+          if (!updateStrings[translation[this.primaryKeyFieldName]]) {
+
+            updateStrings[translation[this.primaryKeyFieldName]] = {
               updates: {},
+              translatedStr,
               category: translation[this.options.categoryFieldName],
               strId: translation[this.primaryKeyFieldName],
             };
           }
-          updateStrings[enStr].updates[this.trFieldNames[lang]] = translatedStr;
+          updateStrings[
+            translation[this.primaryKeyFieldName]
+          ].updates[this.trFieldNames[lang]] = translatedStr;
         }
       }
 
+      return res.length;
     }
 
     const langsInvolved = new Set(Object.keys(needToTranslateByLang));
 
+    let totalTranslated = 0;
     await Promise.all(Object.entries(needToTranslateByLang).map(async ([lang, strings]: [LanguageCode, { en_string: string, category: string }[]]) => {
-      await translateToLang(lang, strings);
+      // first translate without plurals
+      const stringsWithoutPlurals = strings.filter(s => !s.en_string.includes('|'));
+      totalTranslated += await translateToLang(lang, stringsWithoutPlurals, false);
+
+      const stringsWithPlurals = strings.filter(s => s.en_string.includes('|'));
+      totalTranslated += await translateToLang(lang, stringsWithPlurals, true);
     }));    
 
     await Promise.all(
@@ -488,6 +519,8 @@ ${
       }
     }
 
+    return totalTranslated;
+
   }
 
   async processExtractedMessages(adminforth: IAdminForth, filePath: string) {

package/package.json

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