@vocab/phrase 1.2.8 → 1.3.1

package/README.md

@@ -29,7 +29,7 @@ $ npm i --save @vocab/core @vocab/react
 
 ### Step 2: Configure Vocab
 
-You can configure Vocab directly when calling the API or via a `vocab.config.js` file.
+You can configure Vocab directly when calling the API or via a `vocab.config.js` or `vocab.config.cjs` file.
 
 In this example we've configured two languages, English and French, where our initial `translation.json` files will use English.
 
@@ -184,7 +184,7 @@ t('my key with component', {
 
 ## Configuration
 
-Configuration can either be passed into the Node API directly or be gathered from the nearest _vocab.config.js_ file.
+Configuration can either be passed into the Node API directly or be gathered from the nearest _vocab.config.js_ or _vocab.config.cjs_ file.
 
 **vocab.config.js**
 
@@ -341,7 +341,7 @@ functionality.
 
 ### Generating a pseudo-localized language using Vocab
 
-Vocab can generate a pseudo-localized language via the [`generatedLanguages` config][generated languages config], either via the webpack plugin or your `vocab.config.js` file.
+Vocab can generate a pseudo-localized language via the [`generatedLanguages` config][generated languages config], either via the webpack plugin or your `vocab.config.js` or `vocab.config.cjs` file.
 `@vocab/pseudo-localize` exports a `generator` that can be used directly in your config.
 
 **vocab.config.js**
@@ -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/index.d.ts

@@ -1,2 +1,2 @@
-export { pull } from './pull-translations';
-export { push } from './push-translations';
+export { pull } from "./pull-translations.js";
+export { push } from "./push-translations.js";

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

@@ -1,7 +1,8 @@
-import type { UserConfig } from '@vocab/core';
+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/declarations/src/push-translations.d.ts

@@ -1,4 +1,4 @@
-import type { UserConfig } from '@vocab/core';
+import { type UserConfig } from '@vocab/core';
 interface PushOptions {
     branch: string;
     deleteUnusedKeys?: boolean;

package/dist/vocab-phrase.cjs.d.ts

@@ -1 +1,2 @@
 export * from "./declarations/src/index";
+//# sourceMappingURL=vocab-phrase.cjs.d.ts.map

package/dist/vocab-phrase.cjs.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"vocab-phrase.cjs.d.ts","sourceRoot":"","sources":["./declarations/src/index.d.ts"],"names":[],"mappings":"AAAA"}

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

@@ -42,8 +42,8 @@ function translationsToCsv(translations, devLanguage) {
     const devLanguageRow = [...sharedData, message];
     csvFilesByLanguage[devLanguage].push(devLanguageRow);
     altLanguages.map(language => {
-      var _translations$languag, _translations$languag2;
-      const altTranslationMessage = (_translations$languag = translations[language]) === null || _translations$languag === void 0 ? void 0 : (_translations$languag2 = _translations$languag[key]) === null || _translations$languag2 === void 0 ? void 0 : _translations$languag2.message;
+      var _translations$languag;
+      const altTranslationMessage = (_translations$languag = translations[language]) === null || _translations$languag === void 0 || (_translations$languag = _translations$languag[key]) === null || _translations$languag === void 0 ? void 0 : _translations$languag.message;
       if (altTranslationMessage) {
         csvFilesByLanguage[language].push([...sharedData, altTranslationMessage]);
       }
@@ -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

@@ -42,8 +42,8 @@ function translationsToCsv(translations, devLanguage) {
     const devLanguageRow = [...sharedData, message];
     csvFilesByLanguage[devLanguage].push(devLanguageRow);
     altLanguages.map(language => {
-      var _translations$languag, _translations$languag2;
-      const altTranslationMessage = (_translations$languag = translations[language]) === null || _translations$languag === void 0 ? void 0 : (_translations$languag2 = _translations$languag[key]) === null || _translations$languag2 === void 0 ? void 0 : _translations$languag2.message;
+      var _translations$languag;
+      const altTranslationMessage = (_translations$languag = translations[language]) === null || _translations$languag === void 0 || (_translations$languag = _translations$languag[key]) === null || _translations$languag === void 0 ? void 0 : _translations$languag.message;
       if (altTranslationMessage) {
         csvFilesByLanguage[language].push([...sharedData, altTranslationMessage]);
       }
@@ -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

@@ -30,8 +30,8 @@ function translationsToCsv(translations, devLanguage) {
     const devLanguageRow = [...sharedData, message];
     csvFilesByLanguage[devLanguage].push(devLanguageRow);
     altLanguages.map(language => {
-      var _translations$languag, _translations$languag2;
-      const altTranslationMessage = (_translations$languag = translations[language]) === null || _translations$languag === void 0 ? void 0 : (_translations$languag2 = _translations$languag[key]) === null || _translations$languag2 === void 0 ? void 0 : _translations$languag2.message;
+      var _translations$languag;
+      const altTranslationMessage = (_translations$languag = translations[language]) === null || _translations$languag === void 0 || (_translations$languag = _translations$languag[key]) === null || _translations$languag === void 0 ? void 0 : _translations$languag.message;
       if (altTranslationMessage) {
         csvFilesByLanguage[language].push([...sharedData, altTranslationMessage]);
       }
@@ -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.8",
+  "version": "1.3.1",
   "main": "dist/vocab-phrase.cjs.js",
   "module": "dist/vocab-phrase.esm.js",
   "author": "SEEK",
   "license": "MIT",
   "dependencies": {
-    "@vocab/core": "^1.4.0",
+    "@vocab/core": "^1.6.0",
     "chalk": "^4.1.0",
     "csv-stringify": "^6.2.3",
     "debug": "^4.3.1",

package/dist/declarations/src/csv.d.ts

@@ -1,10 +0,0 @@
-import type { TranslationsByLanguage } from '@vocab/core';
-export declare function translationsToCsv(translations: TranslationsByLanguage, devLanguage: string): {
-    csvFileStrings: {
-        [k: string]: string;
-    };
-    keyIndex: number;
-    messageIndex: number;
-    commentIndex: number;
-    tagColumn: number;
-};

package/dist/declarations/src/file.d.ts

@@ -1,4 +0,0 @@
-/// <reference types="node" />
-import { promises as fs } from 'fs';
-export declare const mkdir: typeof fs.mkdir;
-export declare const writeFile: typeof fs.writeFile;

package/dist/declarations/src/logger.d.ts

@@ -1,3 +0,0 @@
-import debug from 'debug';
-export declare const trace: debug.Debugger;
-export declare const log: (...params: unknown[]) => void;

package/dist/declarations/src/phrase-api.d.ts

@@ -1,12 +0,0 @@
-import type { TranslationsByLanguage } from '@vocab/core';
-import fetch from 'node-fetch';
-export declare function callPhrase<T = any>(relativePath: string, options?: Parameters<typeof fetch>[1]): Promise<T>;
-export declare function pullAllTranslations(branch: string): Promise<TranslationsByLanguage>;
-export declare function pushTranslations(translationsByLanguage: TranslationsByLanguage, { devLanguage, branch }: {
-    devLanguage: string;
-    branch: string;
-}): Promise<{
-    devLanguageUploadId: string;
-}>;
-export declare function deleteUnusedKeys(uploadId: string, branch: string): Promise<void>;
-export declare function ensureBranch(branch: string): Promise<void>;