@adminforth/i18n 1.0.23-next.0 → 1.0.23-next.1

package/Changelog.md

@@ -5,6 +5,15 @@ 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.23] - next
+
+### Improved
+
+- Better instructions for LLM pluralization Slavik messages
+
+### Added
+- support for pluralization in Backend `tr` function
+
 ## [1.0.22]
 
 ### Fixed

package/custom/LanguageUnderLogin.vue

@@ -32,6 +32,7 @@
 import Select from '@/afcl/Select.vue';
 import 'flag-icon-css/css/flag-icons.min.css';
 import { setLang, getCountryCodeFromLangCode, getLocalLang } from './langCommon';
+import { useCoreStore } from '@/stores/core';
 
 import { computed, ref, onMounted, watch } from 'vue';
 import { useI18n } from 'vue-i18n';
@@ -42,9 +43,11 @@ const { setLocaleMessage, locale } = useI18n();
 const props = defineProps(['meta', 'resource']);
 
 const selectedLanguage = ref('');
+const coreStore = useCoreStore();
 
-watch(() => selectedLanguage.value, (newVal) => {
-  setLang({ setLocaleMessage, locale }, props.meta.pluginInstanceId, newVal);
+watch(() => selectedLanguage.value, async (newVal) => {
+  await setLang({ setLocaleMessage, locale }, props.meta.pluginInstanceId, newVal);
+  coreStore.getPublicConfig();
 });
 
 

package/dist/custom/LanguageUnderLogin.vue

@@ -32,6 +32,7 @@
 import Select from '@/afcl/Select.vue';
 import 'flag-icon-css/css/flag-icons.min.css';
 import { setLang, getCountryCodeFromLangCode, getLocalLang } from './langCommon';
+import { useCoreStore } from '@/stores/core';
 
 import { computed, ref, onMounted, watch } from 'vue';
 import { useI18n } from 'vue-i18n';
@@ -42,9 +43,11 @@ const { setLocaleMessage, locale } = useI18n();
 const props = defineProps(['meta', 'resource']);
 
 const selectedLanguage = ref('');
+const coreStore = useCoreStore();
 
-watch(() => selectedLanguage.value, (newVal) => {
-  setLang({ setLocaleMessage, locale }, props.meta.pluginInstanceId, newVal);
+watch(() => selectedLanguage.value, async (newVal) => {
+  await setLang({ setLocaleMessage, locale }, props.meta.pluginInstanceId, newVal);
+  coreStore.getPublicConfig();
 });
 
 

package/dist/index.js

@@ -380,7 +380,7 @@ export default class I18nPlugin extends AdminForthPlugin {
             const requestSlavicPlurals = Object.keys(SLAVIC_PLURAL_EXAMPLES).includes(lang) && plurals;
             const prompt = `
 I need to translate strings in JSON to ${lang} (${langName}) language from English for my web app.
-${requestSlavicPlurals ? `You should provide 4 translations (in format zero | singular | 2-4 | 5+) e.g. ${SLAVIC_PLURAL_EXAMPLES[lang]}` : ''}
+${requestSlavicPlurals ? `You should provide 4 slavic forms (in format "zero count | singular count | 2-4 | 5+") e.g. "apple | apples" should become "${SLAVIC_PLURAL_EXAMPLES[lang]}"` : ''}
 Keep keys, as is, write translation into values! Here are the strings:
 
 \`\`\`json
@@ -474,8 +474,10 @@ ${JSON.stringify(strings.reduce((acc, s) => {
                 totalTranslated = totalTranslated.concat(noPluralKeys, pluralKeys);
             })));
             yield Promise.all(Object.entries(updateStrings).map((_c) => __awaiter(this, [_c], void 0, function* ([_, { updates, strId }]) {
+                // get old full record
+                const oldRecord = yield this.adminforth.resource(this.resourceConfig.resourceId).get([Filters.EQ(this.primaryKeyFieldName, strId)]);
                 // because this will translate all languages, we can set completedLangs to all languages
-                const futureCompletedFieldValue = yield this.computeCompletedFieldValue(updates);
+                const futureCompletedFieldValue = yield this.computeCompletedFieldValue(Object.assign(Object.assign({}, oldRecord), updates));
                 yield this.adminforth.resource(this.resourceConfig.resourceId).update(strId, Object.assign(Object.assign({}, updates), { [this.options.completedFieldName]: futureCompletedFieldValue }));
             })));
             for (const lang of langsInvolved) {
@@ -565,7 +567,7 @@ ${JSON.stringify(strings.reduce((acc, s) => {
         }
         // in this plugin we will use plugin to fill the database with missing language messages
         this.tryProcessAndWatch(adminforth);
-        adminforth.tr = (msg, category, lang, params) => __awaiter(this, void 0, void 0, function* () {
+        adminforth.tr = (msg, category, lang, params, pluralizationNumber) => __awaiter(this, void 0, void 0, function* () {
             if (!msg) {
                 return msg;
             }
@@ -612,6 +614,10 @@ ${JSON.stringify(strings.reduce((acc, s) => {
                 // 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);
@@ -620,6 +626,32 @@ ${JSON.stringify(strings.reduce((acc, s) => {
             return result;
         });
     }
+    applyPluralization(str, number, lang) {
+        const choices = str.split('|');
+        const choicesLength = choices.length;
+        if (choicesLength > 2) {
+            // this is slavic pluralization
+            return choices[this.slavicPluralRule(number, choicesLength)];
+        }
+        else {
+            return number === 1 ? choices[0] : choices[1];
+        }
+    }
+    // taken from here https://vue-i18n.intlify.dev/guide/essentials/pluralization.html#custom-pluralization
+    slavicPluralRule(choice, choicesLength) {
+        if (choice === 0) {
+            return 0;
+        }
+        const teen = choice > 10 && choice < 20;
+        const endsWithOne = choice % 10 === 1;
+        if (!teen && endsWithOne) {
+            return 1;
+        }
+        if (!teen && choice % 10 >= 2 && choice % 10 <= 4) {
+            return 2;
+        }
+        return choicesLength < 4 ? 2 : 3;
+    }
     instanceUniqueRepresentation(pluginOptions) {
         // optional method to return unique string representation of plugin instance. 
         // Needed if plugin can have multiple instances on one resource 

package/index.ts

@@ -429,7 +429,7 @@ export default class I18nPlugin extends AdminForthPlugin {
 
     const prompt = `
 I need to translate strings in JSON to ${lang} (${langName}) language from English for my web app.
-${requestSlavicPlurals ? `You should provide 4 translations (in format zero | singular | 2-4 | 5+) e.g. ${SLAVIC_PLURAL_EXAMPLES[lang]}` : ''}
+${requestSlavicPlurals ? `You should provide 4 slavic forms (in format "zero count | singular count | 2-4 | 5+") e.g. "apple | apples" should become "${SLAVIC_PLURAL_EXAMPLES[lang]}"` : ''}
 Keep keys, as is, write translation into values! Here are the strings:
 
 \`\`\`json
@@ -449,6 +449,7 @@ JSON.stringify(strings.reduce((acc: object, s: { en_string: string }): object =>
       300,
     );
 
+
     if (resp.error) {
       throw new AiTranslateError(resp.error);
     }
@@ -568,8 +569,11 @@ JSON.stringify(strings.reduce((acc: object, s: { en_string: string }): object =>
     await Promise.all(
       Object.entries(updateStrings).map(
         async ([_, { updates, strId }]: [string, { updates: any, category: string, strId: string }]) => {
+          // get old full record
+          const oldRecord = await this.adminforth.resource(this.resourceConfig.resourceId).get([Filters.EQ(this.primaryKeyFieldName, strId)]);
+
           // because this will translate all languages, we can set completedLangs to all languages
-          const futureCompletedFieldValue = await this.computeCompletedFieldValue(updates); 
+          const futureCompletedFieldValue = await this.computeCompletedFieldValue({ ...oldRecord, ...updates });
 
           await this.adminforth.resource(this.resourceConfig.resourceId).update(strId, {
             ...updates,
@@ -675,7 +679,7 @@ 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);
 
-    adminforth.tr = async (msg: string | null | undefined, category: string, lang: string, params): Promise<string> => {
+    adminforth.tr = async (msg: string | null | undefined, category: string, lang: string, params, pluralizationNumber: number): Promise<string> => {
       if (!msg) {
         return msg;
       }
@@ -726,6 +730,11 @@ JSON.stringify(strings.reduce((acc: object, s: { en_string: string }): object =>
         // 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);
@@ -735,6 +744,36 @@ JSON.stringify(strings.reduce((acc: object, s: { en_string: string }): object =>
     }
   }
 
+  applyPluralization(str: string, number: number, lang: string): string {
+    const choices = str.split('|');
+    const choicesLength = choices.length;
+
+    if (choicesLength > 2) {
+      // this is slavic pluralization
+      return choices[this.slavicPluralRule(number, choicesLength)];
+    } else {
+      return number === 1 ? choices[0] : choices[1];
+    }
+  }
+  
+    // taken from here https://vue-i18n.intlify.dev/guide/essentials/pluralization.html#custom-pluralization
+  slavicPluralRule(choice, choicesLength) {
+    if (choice === 0) {
+      return 0
+    }
+
+    const teen = choice > 10 && choice < 20
+    const endsWithOne = choice % 10 === 1
+
+    if (!teen && endsWithOne) {
+      return 1
+    }
+    if (!teen && choice % 10 >= 2 && choice % 10 <= 4) {
+      return 2
+    }
+
+    return choicesLength < 4 ? 2 : 3
+  }
   instanceUniqueRepresentation(pluginOptions: any) : string {
     // optional method to return unique string representation of plugin instance. 
     // Needed if plugin can have multiple instances on one resource 

package/package.json

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