@adminforth/i18n 1.1.3-next.5 → 1.2.0-next.2

package/build.log

@@ -16,5 +16,5 @@ custom/package-lock.json
 custom/package.json
 custom/tsconfig.json
 
-sent 24,824 bytes  received 229 bytes  50,106.00 bytes/sec
+sent 24,836 bytes  received 229 bytes  50,130.00 bytes/sec
 total size is 23,969  speedup is 0.96

package/dist/index.js

@@ -128,6 +128,7 @@ export default class I18nPlugin extends AdminForthPlugin {
                     throw new Error(`Invalid language code ${lang}, please define valid ISO 639-1 language code (2 lowercase letters)`);
                 }
             });
+            this.externalAppOnly = this.options.externalAppOnly === true;
             // find primary key field
             this.primaryKeyFieldName = (_a = resourceConfig.columns.find(c => c.primaryKey)) === null || _a === void 0 ? void 0 : _a.name;
             if (!this.primaryKeyFieldName) {
@@ -236,18 +237,20 @@ export default class I18nPlugin extends AdminForthPlugin {
                 }))
             };
             // add underLogin component
-            (adminforth.config.customization.loginPageInjections.underInputs).push({
-                file: this.componentPath('LanguageUnderLogin.vue'),
-                meta: compMeta
-            });
-            (adminforth.config.customization.globalInjections.userMenu).push({
-                file: this.componentPath('LanguageInUserMenu.vue'),
-                meta: compMeta
-            });
-            adminforth.config.customization.globalInjections.everyPageBottom.push({
-                file: this.componentPath('LanguageEveryPageLoader.vue'),
-                meta: compMeta
-            });
+            if (!this.externalAppOnly) {
+                (adminforth.config.customization.loginPageInjections.underInputs).push({
+                    file: this.componentPath('LanguageUnderLogin.vue'),
+                    meta: compMeta
+                });
+                (adminforth.config.customization.globalInjections.userMenu).push({
+                    file: this.componentPath('LanguageInUserMenu.vue'),
+                    meta: compMeta
+                });
+                adminforth.config.customization.globalInjections.everyPageBottom.push({
+                    file: this.componentPath('LanguageEveryPageLoader.vue'),
+                    meta: compMeta
+                });
+            }
             // disable create allowedActions for translations
             resourceConfig.options.allowedActions.create = false;
             // add hook to validate user did not screw up with template params
@@ -618,65 +621,67 @@ ${JSON.stringify(strings.reduce((acc, s) => {
             throw new Error(`Field ${this.options.categoryFieldName} should be of type string in resource ${resourceConfig.resourceId}, but it is ${categoryColumn.type}`);
         }
         // in this plugin we will use plugin to fill the database with missing language messages
-        this.tryProcessAndWatch(adminforth);
-        adminforth.tr = (msg, category, lang, params, pluralizationNumber) => __awaiter(this, void 0, void 0, function* () {
-            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)) {
-                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
-            const cacheKey = `${resourceConfig.resourceId}:${category}:${lang}:${msg}`;
-            const cached = yield this.cache.get(cacheKey);
-            if (cached) {
-                result = cached;
-            }
-            if (!result) {
-                const resource = adminforth.resource(resourceConfig.resourceId);
-                const translation = yield resource.get([Filters.EQ(this.enFieldName, msg), Filters.EQ(this.options.categoryFieldName, category)]);
-                if (!translation) {
-                    yield resource.create({
-                        [this.enFieldName]: msg,
-                        [this.options.categoryFieldName]: category,
-                    });
-                    this.updateUntranslatedMenuBadge();
+        if (!this.externalAppOnly) {
+            this.tryProcessAndWatch(adminforth);
+            adminforth.tr = (msg, category, lang, params, pluralizationNumber) => __awaiter(this, void 0, void 0, function* () {
+                if (!msg) {
+                    return msg;
                 }
-                // do this check here, to faster register missing translations
-                // also not cache it - no sense to cache english strings
-                if (lang === 'en') {
-                    // set to cache to return faster next time
-                    result = msg;
+                if (category === 'frontend') {
+                    throw new Error(`Category 'frontend' is reserved for frontend messages, use any other category for backend messages`);
                 }
-                else {
-                    result = translation === null || translation === void 0 ? void 0 : translation[this.trFieldNames[lang]];
-                    if (!result) {
-                        // return english
+                // console.log('🪲tr', msg, category, lang);
+                // if lang is not supported , throw
+                if (!this.options.supportedLanguages.includes(lang)) {
+                    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
+                const cacheKey = `${resourceConfig.resourceId}:${category}:${lang}:${msg}`;
+                const cached = yield this.cache.get(cacheKey);
+                if (cached) {
+                    result = cached;
+                }
+                if (!result) {
+                    const resource = adminforth.resource(resourceConfig.resourceId);
+                    const translation = yield resource.get([Filters.EQ(this.enFieldName, msg), Filters.EQ(this.options.categoryFieldName, category)]);
+                    if (!translation) {
+                        yield resource.create({
+                            [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
+                    if (lang === 'en') {
+                        // set to cache to return faster next time
                         result = msg;
                     }
+                    else {
+                        result = translation === null || translation === void 0 ? void 0 : translation[this.trFieldNames[lang]];
+                        if (!result) {
+                            // return english
+                            result = msg;
+                        }
+                    }
+                    // cache so even if key does not exist, we will not hit database
+                    yield this.cache.set(cacheKey, result);
                 }
-                // cache so even if key does not exist, we will not hit database
-                yield this.cache.set(cacheKey, result);
-            }
-            // if msg has '|' in it, then we need to aplly pluralization
-            if (msg.includes('|')) {
-                result = this.applyPluralization(result, pluralizationNumber, lang);
-            }
-            if (params) {
-                for (const [key, value] of Object.entries(params)) {
-                    result = result.replace(`{${key}}`, value);
+                // if msg has '|' in it, then we need to aplly pluralization
+                if (msg.includes('|')) {
+                    result = this.applyPluralization(result, pluralizationNumber, lang);
                 }
-            }
-            return result;
-        });
+                if (params) {
+                    for (const [key, value] of Object.entries(params)) {
+                        result = result.replace(`{${key}}`, value);
+                    }
+                }
+                return result;
+            });
+        }
     }
     applyPluralization(str, number, lang) {
         const choices = str.split('|');

package/index.ts

@@ -94,6 +94,8 @@ export default class I18nPlugin extends AdminForthPlugin {
 
   adminforth: IAdminForth;
 
+  externalAppOnly: boolean;
+
   // sorted by name list of all supported languages, without en e.g. 'al|ro|uk'
   fullCompleatedFieldValue: string;
 
@@ -140,7 +142,8 @@ export default class I18nPlugin extends AdminForthPlugin {
         throw new Error(`Invalid language code ${lang}, please define valid ISO 639-1 language code (2 lowercase letters)`);
       }
     });
-    
+
+    this.externalAppOnly = this.options.externalAppOnly === true;
 
     // find primary key field
     this.primaryKeyFieldName = resourceConfig.columns.find(c => c.primaryKey)?.name;
@@ -265,20 +268,22 @@ export default class I18nPlugin extends AdminForthPlugin {
       ))
     };
     // add underLogin component
-    (adminforth.config.customization.loginPageInjections.underInputs).push({ 
-      file: this.componentPath('LanguageUnderLogin.vue'),
-      meta: compMeta
-    });
+    if (!this.externalAppOnly) {
+      (adminforth.config.customization.loginPageInjections.underInputs).push({ 
+        file: this.componentPath('LanguageUnderLogin.vue'),
+        meta: compMeta
+      });
 
-    (adminforth.config.customization.globalInjections.userMenu).push({
-      file: this.componentPath('LanguageInUserMenu.vue'),
-      meta: compMeta
-    });
+      (adminforth.config.customization.globalInjections.userMenu).push({
+        file: this.componentPath('LanguageInUserMenu.vue'),
+        meta: compMeta
+      });
 
-    adminforth.config.customization.globalInjections.everyPageBottom.push({
-      file: this.componentPath('LanguageEveryPageLoader.vue'),
-      meta: compMeta
-    });
+      adminforth.config.customization.globalInjections.everyPageBottom.push({
+        file: this.componentPath('LanguageEveryPageLoader.vue'),
+        meta: compMeta
+      });
+    }
 
     // disable create allowedActions for translations
     resourceConfig.options.allowedActions.create = false;
@@ -735,70 +740,72 @@ JSON.stringify(strings.reduce((acc: object, s: { en_string: string }): object =>
     }
 
     // in this plugin we will use plugin to fill the database with missing language messages
-    this.tryProcessAndWatch(adminforth);
+    if (!this.externalAppOnly) {
+      this.tryProcessAndWatch(adminforth);
 
-    adminforth.tr = async (msg: string | null | undefined, category: string, lang: string, params, pluralizationNumber: number): Promise<string> => {
-      if (!msg) {
-        return msg;
-      }
+      adminforth.tr = async (msg: string | null | undefined, category: string, lang: string, params, pluralizationNumber: number): Promise<string> => {
+        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 (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)) {
-        lang = 'en'; // for now simply fallback to english
+        // if lang is not supported , throw
+        if (!this.options.supportedLanguages.includes(lang as LanguageCode)) {
+          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`);
-      }
+          // 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
-      const cacheKey = `${resourceConfig.resourceId}:${category}:${lang}:${msg}`;
-      const cached = await this.cache.get(cacheKey);
-      if (cached) {
-        result = cached;
-      }
-      if (!result) {
-        const resource = adminforth.resource(resourceConfig.resourceId);
-        const translation = await resource.get([Filters.EQ(this.enFieldName, msg), Filters.EQ(this.options.categoryFieldName, category)]);
-        if (!translation) {
-          await resource.create({
-            [this.enFieldName]: msg,
-            [this.options.categoryFieldName]: category,
-          });
-          this.updateUntranslatedMenuBadge();
+        let result;
+        // try to get translation from cache
+        const cacheKey = `${resourceConfig.resourceId}:${category}:${lang}:${msg}`;
+        const cached = await this.cache.get(cacheKey);
+        if (cached) {
+          result = cached;
         }
+        if (!result) {
+          const resource = adminforth.resource(resourceConfig.resourceId);
+          const translation = await resource.get([Filters.EQ(this.enFieldName, msg), Filters.EQ(this.options.categoryFieldName, category)]);
+          if (!translation) {
+            await resource.create({
+              [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
-        if (lang === 'en') {
-          // set to cache to return faster next time
-          result = msg;
-        } else {
-          result = translation?.[this.trFieldNames[lang]];
-          if (!result) {
-            // return english
+          // do this check here, to faster register missing translations
+          // also not cache it - no sense to cache english strings
+          if (lang === 'en') {
+            // set to cache to return faster next time
             result = msg;
+          } else {
+            result = translation?.[this.trFieldNames[lang]];
+            if (!result) {
+              // return english
+              result = msg;
+            }
           }
+          // cache so even if key does not exist, we will not hit database
+          await this.cache.set(cacheKey, result);
+        }
+        // if msg has '|' in it, then we need to aplly pluralization
+        if (msg.includes('|')) {
+          result = this.applyPluralization(result, pluralizationNumber, lang);
         }
-        // cache so even if key does not exist, we will not hit database
-        await this.cache.set(cacheKey, result);
-      }
-      // if msg has '|' in it, then we need to aplly pluralization
-      if (msg.includes('|')) {
-        result = this.applyPluralization(result, pluralizationNumber, lang);
-      }
 
-      if (params) {
-        for (const [key, value] of Object.entries(params)) {
-          result = result.replace(`{${key}}`, value);
+        if (params) {
+          for (const [key, value] of Object.entries(params)) {
+            result = result.replace(`{${key}}`, value);
+          }
         }
+        return result;
       }
-      return result;
     }
   }
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@adminforth/i18n",
-  "version": "1.1.3-next.5",
+  "version": "1.2.0-next.2",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "type": "module",

package/types.ts

@@ -36,4 +36,10 @@ export interface PluginOptions {
    * semiautomatically (creates a bulk action for generating translations)
    */
   completeAdapter?: CompletionAdapter
+
+  /**
+   * Optionally translation plugin available to translate only external applications (like SEO-facing or user-facing services),
+   *  not AdminForth applications
+   */
+  externalAppOnly?: boolean;
 }