@adminforth/i18n 1.0.11 → 1.0.13

package/Changelog.md

@@ -5,9 +5,29 @@ 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).
 
+
+
+
+## [1.0.13]
+
+- Deduplicate frontend strings before creating translations 
+
+
+## [1.0.12]
+
+### Fixed
+
+- live mode frontend translations loading when tmp dir is nopt preserver  (e.g. docker cached /tmp pipeline)
+
+## [1.0.11]
+
+### Fixed
+
+- cache invalidations on delete
+
 ## [v1.0.10]
 
-## Fixed
+### Fixed
 
 - fix automatic translations for duplicate strings
 - improve slavik pluralization generations by splitting the requests

package/custom/LanguageInUserMenu.vue

@@ -43,7 +43,7 @@
 import 'flag-icon-css/css/flag-icons.min.css';
 import { IconCaretDownSolid } from '@iconify-prerendered/vue-flowbite';
 
-import { setLang, getCountryCodeFromLangCode, getLocalLang } from './langCommon';
+import { setLang, getCountryCodeFromLangCode, getLocalLang, setLocalLang } from './langCommon';
 
 import { computed, ref, onMounted, watch } from 'vue';
 import { useI18n } from 'vue-i18n';
@@ -56,7 +56,7 @@ const props = defineProps(['meta', 'resource']);
 const selectedLanguage = ref('');
 
 function doChangeLang(lang) {
-  setLang({ setLocaleMessage, locale }, props.meta.pluginInstanceId, lang);
+  setLocalLang(lang);
   // unfortunately, we need this to recall all APIs
   document.location.reload();
 

package/dist/custom/LanguageInUserMenu.vue

@@ -43,7 +43,7 @@
 import 'flag-icon-css/css/flag-icons.min.css';
 import { IconCaretDownSolid } from '@iconify-prerendered/vue-flowbite';
 
-import { setLang, getCountryCodeFromLangCode, getLocalLang } from './langCommon';
+import { setLang, getCountryCodeFromLangCode, getLocalLang, setLocalLang } from './langCommon';
 
 import { computed, ref, onMounted, watch } from 'vue';
 import { useI18n } from 'vue-i18n';
@@ -56,7 +56,7 @@ const props = defineProps(['meta', 'resource']);
 const selectedLanguage = ref('');
 
 function doChangeLang(lang) {
-  setLang({ setLocaleMessage, locale }, props.meta.pluginInstanceId, lang);
+  setLocalLang(lang);
   // unfortunately, we need this to recall all APIs
   document.location.reload();
 

package/dist/index.js

@@ -287,7 +287,7 @@ export default class I18N extends AdminForthPlugin {
                         this.updateUntranslatedMenuBadge();
                         return {
                             ok: true, error: undefined,
-                            successMessage: yield tr(`Translated {count} items`, 'frontend', { count: selectedIds.length }),
+                            successMessage: yield tr(`Translated {count} items`, 'backend', { count: selectedIds.length }),
                         };
                     })
                 });
@@ -444,7 +444,13 @@ ${JSON.stringify(strings.reduce((acc, s) => {
                 return;
             }
             // loop over missingKeys[i].path and add them to database if not exists
-            yield Promise.all(messages.missingKeys.map((missingKey) => __awaiter(this, void 0, void 0, function* () {
+            const missingKeysDeduplicated = messages.missingKeys.reduce((acc, missingKey) => {
+                if (!acc.find((a) => a.path === missingKey.path)) {
+                    acc.push(missingKey);
+                }
+                return acc;
+            }, []);
+            yield Promise.all(missingKeysDeduplicated.map((missingKey) => __awaiter(this, void 0, void 0, function* () {
                 const key = missingKey.path;
                 const file = missingKey.file;
                 const category = 'frontend';
@@ -469,18 +475,20 @@ ${JSON.stringify(strings.reduce((acc, s) => {
     }
     tryProcessAndWatch(adminforth) {
         return __awaiter(this, void 0, void 0, function* () {
-            const spaDir = adminforth.codeInjector.spaTmpPath();
+            const serveDir = adminforth.codeInjector.getServeDir();
             // messages file is in i18n-messages.json
-            const messagesFile = path.join(spaDir, '..', 'spa_tmp', 'i18n-messages.json');
-            console.log('🪲messagesFile', messagesFile);
+            const messagesFile = path.join(serveDir, 'i18n-messages.json');
+            process.env.HEAVY_DEBUG && console.log('🪲🔔messagesFile read started', messagesFile);
             this.processExtractedMessages(adminforth, messagesFile);
             // we use watcher because file can't be yet created when we start - bundleNow can be done in build time or can be done now
             // that is why we make attempt to process it now and then watch for changes
             const w = chokidar.watch(messagesFile, { persistent: true });
             w.on('change', () => {
+                process.env.HEAVY_DEBUG && console.log('🪲🔔messagesFile change', messagesFile);
                 this.processExtractedMessages(adminforth, messagesFile);
             });
             w.on('add', () => {
+                process.env.HEAVY_DEBUG && console.log('🪲🔔messagesFile add', messagesFile);
                 this.processExtractedMessages(adminforth, messagesFile);
             });
         });
@@ -518,10 +526,15 @@ ${JSON.stringify(strings.reduce((acc, s) => {
             if (!msg) {
                 return msg;
             }
+            if (category === 'frontend') {
+                throw new Error(`Category 'frontend' is reserved for frontend messages, use any other category for backend messages`);
+            }
             // console.log('🪲tr', msg, category, lang);
             // if lang is not supported , throw
             if (!this.options.supportedLanguages.includes(lang)) {
-                throw new Error(`Language ${lang} is not entered to be supported by requested by browser in request headers accept-language`);
+                lang = 'en'; // for now simply fallback to english
+                // throwing like line below might be too strict, e.g. for custom apis made with fetch which don't pass accept-language
+                // throw new Error(`Language ${lang} is not entered to be supported by requested by browser in request headers accept-language`);
             }
             let result;
             // try to get translation from cache

package/index.ts

@@ -326,7 +326,7 @@ export default class I18N extends AdminForthPlugin {
             this.updateUntranslatedMenuBadge();
             return { 
               ok: true, error: undefined, 
-              successMessage: await tr(`Translated {count} items`, 'frontend', {count: selectedIds.length}),
+              successMessage: await tr(`Translated {count} items`, 'backend', {count: selectedIds.length}),
             };
           }
         }
@@ -535,7 +535,15 @@ ${
       return;
     }
     // loop over missingKeys[i].path and add them to database if not exists
-    await Promise.all(messages.missingKeys.map(async (missingKey: any) => {
+
+    const missingKeysDeduplicated = messages.missingKeys.reduce((acc: any[], missingKey: any) => {
+      if (!acc.find((a) => a.path === missingKey.path)) {
+        acc.push(missingKey);
+      }
+      return acc;
+    }, []);
+
+    await Promise.all(missingKeysDeduplicated.map(async (missingKey: any) => {
       const key = missingKey.path;
       const file = missingKey.file;
       const category = 'frontend';
@@ -560,24 +568,26 @@ ${
 
     // updateBadge
     this.updateUntranslatedMenuBadge()
-
-
   }
 
 
   async tryProcessAndWatch(adminforth: IAdminForth) {
-    const spaDir = adminforth.codeInjector.spaTmpPath();
+    const serveDir = adminforth.codeInjector.getServeDir();
     // messages file is in i18n-messages.json
-    const messagesFile = path.join(spaDir, '..', 'spa_tmp', 'i18n-messages.json');
-    console.log('🪲messagesFile', messagesFile);
+    const messagesFile = path.join(serveDir, 'i18n-messages.json');
+    process.env.HEAVY_DEBUG && console.log('🪲🔔messagesFile read started', messagesFile);
     this.processExtractedMessages(adminforth, messagesFile);
     // we use watcher because file can't be yet created when we start - bundleNow can be done in build time or can be done now
     // that is why we make attempt to process it now and then watch for changes
     const w = chokidar.watch(messagesFile, { persistent: true });
     w.on('change', () => {
+      process.env.HEAVY_DEBUG && console.log('🪲🔔messagesFile change', messagesFile);
+
       this.processExtractedMessages(adminforth, messagesFile);
     });
     w.on('add', () => {
+      process.env.HEAVY_DEBUG && console.log('🪲🔔messagesFile add', messagesFile);
+
       this.processExtractedMessages(adminforth, messagesFile);
     });
 
@@ -619,11 +629,18 @@ ${
       if (!msg) {
         return msg;
       }
+
+      if (category === 'frontend') {
+        throw new Error(`Category 'frontend' is reserved for frontend messages, use any other category for backend messages`);
+      }
       // console.log('🪲tr', msg, category, lang);
 
       // if lang is not supported , throw
       if (!this.options.supportedLanguages.includes(lang as LanguageCode)) {
-        throw new Error(`Language ${lang} is not entered to be supported by requested by browser in request headers accept-language`);
+        lang = 'en'; // for now simply fallback to english
+
+        // throwing like line below might be too strict, e.g. for custom apis made with fetch which don't pass accept-language
+        // throw new Error(`Language ${lang} is not entered to be supported by requested by browser in request headers accept-language`);
       }
 
       let result;

package/package.json

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