@vocab/react 1.1.7 → 1.1.9

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,5 +1,5 @@
 import type { TranslationFile, LanguageName, ParsedFormatFnByKey, ParsedFormatFn } from '@vocab/core';
-import { type ReactNode } from 'react';
+import React, { type ReactNode } from 'react';
 type Locale = string;
 interface TranslationsValue {
     language: LanguageName;
@@ -8,7 +8,7 @@ interface TranslationsValue {
 interface VocabProviderProps extends TranslationsValue {
     children: ReactNode;
 }
-export declare const VocabProvider: ({ children, language, locale, }: VocabProviderProps) => JSX.Element;
+export declare const VocabProvider: ({ children, language, locale, }: VocabProviderProps) => React.JSX.Element;
 export declare const useLanguage: () => TranslationsValue;
 type FormatXMLElementReactNodeFn = (parts: ReactNode[]) => ReactNode;
 type MapToReactNodeFunction<Params extends Record<string, any>> = {

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

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

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

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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vocab/react",
-  "version": "1.1.7",
+  "version": "1.1.9",
   "main": "dist/vocab-react.cjs.js",
   "module": "dist/vocab-react.esm.js",
   "author": "SEEK",
@@ -12,7 +12,7 @@
     "dist"
   ],
   "dependencies": {
-    "@vocab/core": "^1.4.0",
+    "@vocab/core": "^1.6.0",
     "intl-messageformat": "^10.0.0"
   },
   "devDependencies": {