@vocab/core 1.3.1 → 1.5.0

package/README.md

@@ -450,7 +450,7 @@ $ vocab pull --branch my-branch
 
 When uploading translations, Phrase identifies keys that exist in the Phrase project, but were not
 referenced in the upload. These keys can be deleted from Phrase by providing the
-`---delete-unused-keys` flag to `vocab push`. E.g.
+`--delete-unused-keys` flag to `vocab push`. E.g.
 
 ```sh
 $ vocab push --branch my-branch --delete-unused-keys
@@ -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/types.d.ts

@@ -51,6 +51,7 @@ export type TranslationFile<Language extends LanguageName, FormatFnByKey extends
      */
     load: (language: Language) => Promise<void>;
 };
+export type TranslationKeys<Translations extends TranslationFile<any, ParsedFormatFnByKey>> = keyof Awaited<ReturnType<Translations['getMessages']>>;
 export interface LanguageTarget {
     name: LanguageName;
     extends?: LanguageName;
@@ -98,6 +99,7 @@ export interface TranslationData {
     message: TranslationMessage;
     description?: string;
     tags?: Tags;
+    globalKey?: string;
 }
 export type TranslationsByKey<Key extends TranslationKey = string> = Record<Key, TranslationData>;
 export type TranslationFileContents = TranslationsByKey & {

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

@@ -433,6 +433,13 @@ async function loadAllTranslations({
         throw new Error(`Duplicate keys found. Key with namespace ${loadedTranslation.namespace} and key ${key} was found multiple times.`);
       }
       keys.add(uniqueKey);
+      const globalKey = loadedTranslation.languages[config.devLanguage][key].globalKey;
+      if (globalKey) {
+        if (keys.has(globalKey)) {
+          throw new Error(`Duplicate keys found. Key with global key ${globalKey} and key ${key} was found multiple times`);
+        }
+        keys.add(globalKey);
+      }
     }
   }
   return result;

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

@@ -433,6 +433,13 @@ async function loadAllTranslations({
         throw new Error(`Duplicate keys found. Key with namespace ${loadedTranslation.namespace} and key ${key} was found multiple times.`);
       }
       keys.add(uniqueKey);
+      const globalKey = loadedTranslation.languages[config.devLanguage][key].globalKey;
+      if (globalKey) {
+        if (keys.has(globalKey)) {
+          throw new Error(`Duplicate keys found. Key with global key ${globalKey} and key ${key} was found multiple times`);
+        }
+        keys.add(globalKey);
+      }
     }
   }
   return result;

package/dist/vocab-core.esm.js

@@ -417,6 +417,13 @@ async function loadAllTranslations({
         throw new Error(`Duplicate keys found. Key with namespace ${loadedTranslation.namespace} and key ${key} was found multiple times.`);
       }
       keys.add(uniqueKey);
+      const globalKey = loadedTranslation.languages[config.devLanguage][key].globalKey;
+      if (globalKey) {
+        if (keys.has(globalKey)) {
+          throw new Error(`Duplicate keys found. Key with global key ${globalKey} and key ${key} was found multiple times`);
+        }
+        keys.add(globalKey);
+      }
     }
   }
   return result;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vocab/core",
-  "version": "1.3.1",
+  "version": "1.5.0",
   "main": "dist/vocab-core.cjs.js",
   "module": "dist/vocab-core.esm.js",
   "exports": {