@vocab/phrase 1.2.7 → 1.3.0

package/README.md

@@ -506,6 +506,38 @@ Tags on keys in other languages will be ignored.
 [tags]: https://support.phrase.com/hc/en-us/articles/5822598372252-Tags-Strings-
 [configuration]: #Configuration
 
+#### Global key
+
+`vocab push` and `vocab pull` can support global keys mapping. When you want certain translations to use a specific/custom key in Phrase, add the `globalKey` to the structure.
+
+```jsonc
+// translations.json
+{
+  "Hello": {
+    "message": "Hello",
+    "globalKey": "hello"
+  },
+  "Goodbye": {
+    "message": "Goodbye",
+    "globalKey": "app.goodbye.label"
+  }
+}
+```
+
+In the above example,
+
+- `vocab push` will push the `hello` and `app.goodbye.label` keys to Phrase.
+- `vocab pull` will pull translations from Phrase and map them to the `hello` and `app.goodbye.label` keys.
+
+##### Error on no translation for global key
+
+By default, `vocab pull` will not error if a translation is missing in Phrase for a translation with a global key.
+If you want to throw an error in this situation, pass the `--error-on-no-global-key-translation` flag:
+
+```sh
+vocab pull --error-on-no-global-key-translation
+```
+
 ## Troubleshooting
 
 ### Problem: Passed locale is being ignored or using en-US instead

package/dist/declarations/src/pull-translations.d.ts

@@ -2,6 +2,7 @@ import type { UserConfig } from '@vocab/core';
 interface PullOptions {
     branch?: string;
     deleteUnusedKeys?: boolean;
+    errorOnNoGlobalKeyTranslation?: boolean;
 }
-export declare function pull({ branch }: PullOptions, config: UserConfig): Promise<void>;
+export declare function pull({ branch, errorOnNoGlobalKeyTranslation }: PullOptions, config: UserConfig): Promise<void>;
 export {};

package/dist/vocab-phrase.cjs.dev.js

@@ -224,7 +224,8 @@ async function ensureBranch(branch) {
 }
 
 async function pull({
-  branch = 'local-development'
+  branch = 'local-development',
+  errorOnNoGlobalKeyTranslation
 }, config) {
   trace(`Pulling translations from branch ${branch}`);
   await ensureBranch(branch);
@@ -251,9 +252,10 @@ async function pull({
     };
     const localKeys = Object.keys(defaultValues);
     for (const key of localKeys) {
+      var _defaultValues$key$gl;
       defaultValues[key] = {
         ...defaultValues[key],
-        ...allPhraseTranslations[config.devLanguage][core.getUniqueKey(key, loadedTranslation.namespace)]
+        ...allPhraseTranslations[config.devLanguage][(_defaultValues$key$gl = defaultValues[key].globalKey) !== null && _defaultValues$key$gl !== void 0 ? _defaultValues$key$gl : core.getUniqueKey(key, loadedTranslation.namespace)]
       };
     }
 
@@ -269,11 +271,14 @@ async function pull({
         };
         const phraseAltTranslations = allPhraseTranslations[alternativeLanguage];
         for (const key of localKeys) {
-          var _phraseAltTranslation;
-          const phraseKey = core.getUniqueKey(key, loadedTranslation.namespace);
+          var _defaultValues$key$gl2, _phraseAltTranslation;
+          const phraseKey = (_defaultValues$key$gl2 = defaultValues[key].globalKey) !== null && _defaultValues$key$gl2 !== void 0 ? _defaultValues$key$gl2 : core.getUniqueKey(key, loadedTranslation.namespace);
           const phraseTranslationMessage = (_phraseAltTranslation = phraseAltTranslations[phraseKey]) === null || _phraseAltTranslation === void 0 ? void 0 : _phraseAltTranslation.message;
           if (!phraseTranslationMessage) {
             trace(`Missing translation. No translation for key ${key} in phrase as ${phraseKey} in language ${alternativeLanguage}.`);
+            if (errorOnNoGlobalKeyTranslation && defaultValues[key].globalKey) {
+              throw new Error(`Missing translation for global key ${key} in language ${alternativeLanguage}`);
+            }
             continue;
           }
           altTranslations[key] = {
@@ -324,7 +329,6 @@ async function push({
         }
       } = loadedTranslation;
       for (const localKey of Object.keys(localTranslations)) {
-        const phraseKey = core.getUniqueKey(localKey, loadedTranslation.namespace);
         const {
           tags = [],
           ...localTranslation
@@ -332,6 +336,8 @@ async function push({
         if (language === config.devLanguage) {
           localTranslation.tags = [...tags, ...sharedTags];
         }
+        const globalKey = loadedTranslation.languages[config.devLanguage][localKey].globalKey;
+        const phraseKey = globalKey !== null && globalKey !== void 0 ? globalKey : core.getUniqueKey(localKey, loadedTranslation.namespace);
         phraseTranslations[language][phraseKey] = localTranslation;
       }
     }

package/dist/vocab-phrase.cjs.prod.js

@@ -224,7 +224,8 @@ async function ensureBranch(branch) {
 }
 
 async function pull({
-  branch = 'local-development'
+  branch = 'local-development',
+  errorOnNoGlobalKeyTranslation
 }, config) {
   trace(`Pulling translations from branch ${branch}`);
   await ensureBranch(branch);
@@ -251,9 +252,10 @@ async function pull({
     };
     const localKeys = Object.keys(defaultValues);
     for (const key of localKeys) {
+      var _defaultValues$key$gl;
       defaultValues[key] = {
         ...defaultValues[key],
-        ...allPhraseTranslations[config.devLanguage][core.getUniqueKey(key, loadedTranslation.namespace)]
+        ...allPhraseTranslations[config.devLanguage][(_defaultValues$key$gl = defaultValues[key].globalKey) !== null && _defaultValues$key$gl !== void 0 ? _defaultValues$key$gl : core.getUniqueKey(key, loadedTranslation.namespace)]
       };
     }
 
@@ -269,11 +271,14 @@ async function pull({
         };
         const phraseAltTranslations = allPhraseTranslations[alternativeLanguage];
         for (const key of localKeys) {
-          var _phraseAltTranslation;
-          const phraseKey = core.getUniqueKey(key, loadedTranslation.namespace);
+          var _defaultValues$key$gl2, _phraseAltTranslation;
+          const phraseKey = (_defaultValues$key$gl2 = defaultValues[key].globalKey) !== null && _defaultValues$key$gl2 !== void 0 ? _defaultValues$key$gl2 : core.getUniqueKey(key, loadedTranslation.namespace);
           const phraseTranslationMessage = (_phraseAltTranslation = phraseAltTranslations[phraseKey]) === null || _phraseAltTranslation === void 0 ? void 0 : _phraseAltTranslation.message;
           if (!phraseTranslationMessage) {
             trace(`Missing translation. No translation for key ${key} in phrase as ${phraseKey} in language ${alternativeLanguage}.`);
+            if (errorOnNoGlobalKeyTranslation && defaultValues[key].globalKey) {
+              throw new Error(`Missing translation for global key ${key} in language ${alternativeLanguage}`);
+            }
             continue;
           }
           altTranslations[key] = {
@@ -324,7 +329,6 @@ async function push({
         }
       } = loadedTranslation;
       for (const localKey of Object.keys(localTranslations)) {
-        const phraseKey = core.getUniqueKey(localKey, loadedTranslation.namespace);
         const {
           tags = [],
           ...localTranslation
@@ -332,6 +336,8 @@ async function push({
         if (language === config.devLanguage) {
           localTranslation.tags = [...tags, ...sharedTags];
         }
+        const globalKey = loadedTranslation.languages[config.devLanguage][localKey].globalKey;
+        const phraseKey = globalKey !== null && globalKey !== void 0 ? globalKey : core.getUniqueKey(localKey, loadedTranslation.namespace);
         phraseTranslations[language][phraseKey] = localTranslation;
       }
     }

package/dist/vocab-phrase.esm.js

@@ -212,7 +212,8 @@ async function ensureBranch(branch) {
 }
 
 async function pull({
-  branch = 'local-development'
+  branch = 'local-development',
+  errorOnNoGlobalKeyTranslation
 }, config) {
   trace(`Pulling translations from branch ${branch}`);
   await ensureBranch(branch);
@@ -239,9 +240,10 @@ async function pull({
     };
     const localKeys = Object.keys(defaultValues);
     for (const key of localKeys) {
+      var _defaultValues$key$gl;
       defaultValues[key] = {
         ...defaultValues[key],
-        ...allPhraseTranslations[config.devLanguage][getUniqueKey(key, loadedTranslation.namespace)]
+        ...allPhraseTranslations[config.devLanguage][(_defaultValues$key$gl = defaultValues[key].globalKey) !== null && _defaultValues$key$gl !== void 0 ? _defaultValues$key$gl : getUniqueKey(key, loadedTranslation.namespace)]
       };
     }
 
@@ -257,11 +259,14 @@ async function pull({
         };
         const phraseAltTranslations = allPhraseTranslations[alternativeLanguage];
         for (const key of localKeys) {
-          var _phraseAltTranslation;
-          const phraseKey = getUniqueKey(key, loadedTranslation.namespace);
+          var _defaultValues$key$gl2, _phraseAltTranslation;
+          const phraseKey = (_defaultValues$key$gl2 = defaultValues[key].globalKey) !== null && _defaultValues$key$gl2 !== void 0 ? _defaultValues$key$gl2 : getUniqueKey(key, loadedTranslation.namespace);
           const phraseTranslationMessage = (_phraseAltTranslation = phraseAltTranslations[phraseKey]) === null || _phraseAltTranslation === void 0 ? void 0 : _phraseAltTranslation.message;
           if (!phraseTranslationMessage) {
             trace(`Missing translation. No translation for key ${key} in phrase as ${phraseKey} in language ${alternativeLanguage}.`);
+            if (errorOnNoGlobalKeyTranslation && defaultValues[key].globalKey) {
+              throw new Error(`Missing translation for global key ${key} in language ${alternativeLanguage}`);
+            }
             continue;
           }
           altTranslations[key] = {
@@ -312,7 +317,6 @@ async function push({
         }
       } = loadedTranslation;
       for (const localKey of Object.keys(localTranslations)) {
-        const phraseKey = getUniqueKey(localKey, loadedTranslation.namespace);
         const {
           tags = [],
           ...localTranslation
@@ -320,6 +324,8 @@ async function push({
         if (language === config.devLanguage) {
           localTranslation.tags = [...tags, ...sharedTags];
         }
+        const globalKey = loadedTranslation.languages[config.devLanguage][localKey].globalKey;
+        const phraseKey = globalKey !== null && globalKey !== void 0 ? globalKey : getUniqueKey(localKey, loadedTranslation.namespace);
         phraseTranslations[language][phraseKey] = localTranslation;
       }
     }

package/package.json

@@ -1,12 +1,12 @@
 {
   "name": "@vocab/phrase",
-  "version": "1.2.7",
+  "version": "1.3.0",
   "main": "dist/vocab-phrase.cjs.js",
   "module": "dist/vocab-phrase.esm.js",
   "author": "SEEK",
   "license": "MIT",
   "dependencies": {
-    "@vocab/core": "^1.3.1",
+    "@vocab/core": "^1.5.0",
     "chalk": "^4.1.0",
     "csv-stringify": "^6.2.3",
     "debug": "^4.3.1",