@vocab/core 1.4.0 → 1.6.0

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/compile.d.ts

@@ -1,4 +1,4 @@
-import type { LoadedTranslation, UserConfig } from './types';
+import type { LoadedTranslation, UserConfig } from "./types.js";
 export declare function generateRuntime(loadedTranslation: LoadedTranslation): Promise<void>;
 export declare function watch(config: UserConfig): () => Promise<void>;
 export declare function compile({ watch: shouldWatch }: {

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

@@ -1,4 +1,4 @@
-import type { UserConfig } from './types';
+import type { UserConfig } from "./types.js";
 export declare function validateConfig(c: UserConfig): boolean;
 export declare function resolveConfig(customConfigFilePath?: string): Promise<UserConfig | null>;
 export declare function resolveConfigSync(customConfigFilePath?: string): UserConfig | null;

package/dist/declarations/src/icu-handler.d.ts

@@ -1,2 +1,2 @@
-import type { ParsedICUMessages, TranslationMessagesByKey } from './types';
+import type { ParsedICUMessages, TranslationMessagesByKey } from "./types.js";
 export declare const getParsedICUMessages: (m: TranslationMessagesByKey, locale: string) => ParsedICUMessages<any>;

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

@@ -1,6 +1,6 @@
-export { compile, watch } from './compile';
-export { validate } from './validate';
-export { resolveConfig, resolveConfigSync, validateConfig } from './config';
-export { getAltLanguages, getAltLanguageFilePath, getDevLanguageFileFromTsFile, } from './utils';
-export { getUniqueKey, loadAllTranslations, loadTranslation, } from './load-translations';
-export * from './types';
+export { compile, watch } from "./compile.js";
+export { validate } from "./validate/index.js";
+export { resolveConfig, resolveConfigSync, validateConfig } from "./config.js";
+export { getAltLanguages, getAltLanguageFilePath, getDevLanguageFileFromTsFile, } from "./utils.js";
+export { getUniqueKey, loadAllTranslations, loadTranslation, } from "./load-translations.js";
+export * from "./types.js";

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

@@ -1,5 +1,5 @@
-import type { TranslationsByKey, UserConfig, LoadedTranslation, LanguageTarget } from './types';
-import { type Fallback } from './utils';
+import type { TranslationsByKey, UserConfig, LoadedTranslation, LanguageTarget } from "./types.js";
+import { type Fallback } from "./utils.js";
 export declare function getUniqueKey(key: string, namespace: string): string;
 export declare function mergeWithDevLanguageTranslation({ translation, devTranslation, }: {
     translation: TranslationsByKey;

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

@@ -1,3 +1,3 @@
-import type { TranslationModule, TranslationMessagesByKey } from './types';
-export { createTranslationFile } from './translation-file';
+import type { TranslationModule, TranslationMessagesByKey } from "./types.js";
+export { createTranslationFile } from "./translation-file.js";
 export declare const createLanguage: (module: TranslationMessagesByKey) => TranslationModule<any>;

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

@@ -1,2 +1,2 @@
-import type { TranslationModuleByLanguage, LanguageName, ParsedFormatFnByKey, TranslationFile } from './types';
+import type { TranslationModuleByLanguage, LanguageName, ParsedFormatFnByKey, TranslationFile } from "./types.js";
 export declare function createTranslationFile<Language extends LanguageName, FormatFnByKey extends ParsedFormatFnByKey>(translationsByLanguage: TranslationModuleByLanguage<Language, FormatFnByKey>): TranslationFile<Language, FormatFnByKey>;

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

@@ -99,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/declarations/src/utils.d.ts

@@ -1,4 +1,4 @@
-import type { LanguageName, LanguageTarget, TranslationsByKey, TranslationMessagesByKey, UserConfig } from './types';
+import type { LanguageName, LanguageTarget, TranslationsByKey, TranslationMessagesByKey, UserConfig } from "./types.js";
 export declare const defaultTranslationDirSuffix = ".vocab";
 export declare const devTranslationFileName = "translations.json";
 export type Fallback = 'none' | 'valid' | 'all';

package/dist/declarations/src/validate/index.d.ts

@@ -1,3 +1,3 @@
-import type { UserConfig, LoadedTranslation, LanguageName } from '../types';
+import type { UserConfig, LoadedTranslation, LanguageName } from "../types.js";
 export declare function findMissingKeys(loadedTranslation: LoadedTranslation, devLanguageName: LanguageName, altLanguages: Array<LanguageName>): readonly [boolean, Record<string, string[]>];
 export declare function validate(config: UserConfig): Promise<boolean>;

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

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

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

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

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;
@@ -848,7 +855,7 @@ function createConfig(configFilePath) {
   };
 }
 async function resolveConfig(customConfigFilePath) {
-  const configFilePath = customConfigFilePath ? path__default["default"].resolve(customConfigFilePath) : await findUp__default["default"]('vocab.config.js');
+  const configFilePath = customConfigFilePath ? path__default["default"].resolve(customConfigFilePath) : await findUp__default["default"](['vocab.config.js', 'vocab.config.cjs']);
   if (configFilePath) {
     trace(`Resolved configuration file to ${configFilePath}`);
     return createConfig(configFilePath);
@@ -857,7 +864,7 @@ async function resolveConfig(customConfigFilePath) {
   return null;
 }
 function resolveConfigSync(customConfigFilePath) {
-  const configFilePath = customConfigFilePath ? path__default["default"].resolve(customConfigFilePath) : findUp__default["default"].sync('vocab.config.js');
+  const configFilePath = customConfigFilePath ? path__default["default"].resolve(customConfigFilePath) : findUp__default["default"].sync(['vocab.config.js', 'vocab.config.cjs']);
   if (configFilePath) {
     trace(`Resolved configuration file to ${configFilePath}`);
     return createConfig(configFilePath);

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;
@@ -848,7 +855,7 @@ function createConfig(configFilePath) {
   };
 }
 async function resolveConfig(customConfigFilePath) {
-  const configFilePath = customConfigFilePath ? path__default["default"].resolve(customConfigFilePath) : await findUp__default["default"]('vocab.config.js');
+  const configFilePath = customConfigFilePath ? path__default["default"].resolve(customConfigFilePath) : await findUp__default["default"](['vocab.config.js', 'vocab.config.cjs']);
   if (configFilePath) {
     trace(`Resolved configuration file to ${configFilePath}`);
     return createConfig(configFilePath);
@@ -857,7 +864,7 @@ async function resolveConfig(customConfigFilePath) {
   return null;
 }
 function resolveConfigSync(customConfigFilePath) {
-  const configFilePath = customConfigFilePath ? path__default["default"].resolve(customConfigFilePath) : findUp__default["default"].sync('vocab.config.js');
+  const configFilePath = customConfigFilePath ? path__default["default"].resolve(customConfigFilePath) : findUp__default["default"].sync(['vocab.config.js', 'vocab.config.cjs']);
   if (configFilePath) {
     trace(`Resolved configuration file to ${configFilePath}`);
     return createConfig(configFilePath);

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;
@@ -832,7 +839,7 @@ function createConfig(configFilePath) {
   };
 }
 async function resolveConfig(customConfigFilePath) {
-  const configFilePath = customConfigFilePath ? path.resolve(customConfigFilePath) : await findUp('vocab.config.js');
+  const configFilePath = customConfigFilePath ? path.resolve(customConfigFilePath) : await findUp(['vocab.config.js', 'vocab.config.cjs']);
   if (configFilePath) {
     trace(`Resolved configuration file to ${configFilePath}`);
     return createConfig(configFilePath);
@@ -841,7 +848,7 @@ async function resolveConfig(customConfigFilePath) {
   return null;
 }
 function resolveConfigSync(customConfigFilePath) {
-  const configFilePath = customConfigFilePath ? path.resolve(customConfigFilePath) : findUp.sync('vocab.config.js');
+  const configFilePath = customConfigFilePath ? path.resolve(customConfigFilePath) : findUp.sync(['vocab.config.js', 'vocab.config.cjs']);
   if (configFilePath) {
     trace(`Resolved configuration file to ${configFilePath}`);
     return createConfig(configFilePath);

package/icu-handler/dist/vocab-core-icu-handler.cjs.d.ts

@@ -1 +1,2 @@
 export * from "../../dist/declarations/src/icu-handler";
+//# sourceMappingURL=vocab-core-icu-handler.cjs.d.ts.map

package/icu-handler/dist/vocab-core-icu-handler.cjs.d.ts.map

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

package/package.json

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

package/runtime/dist/vocab-core-runtime.cjs.d.ts

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

package/runtime/dist/vocab-core-runtime.cjs.d.ts.map

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

package/translation-file/dist/vocab-core-translation-file.cjs.d.ts

@@ -1 +1,2 @@
 export * from "../../dist/declarations/src/translation-file";
+//# sourceMappingURL=vocab-core-translation-file.cjs.d.ts.map

package/translation-file/dist/vocab-core-translation-file.cjs.d.ts.map

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

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

@@ -1,5 +0,0 @@
-export declare class ValidationError extends Error {
-    code: string;
-    rawMessage: string;
-    constructor(code: string, message: string);
-}

package/dist/declarations/src/generate-language.d.ts

@@ -1,5 +0,0 @@
-import type { MessageGenerator, TranslationsByKey } from './types';
-export declare function generateLanguageFromTranslations({ baseTranslations, generator, }: {
-    baseTranslations: TranslationsByKey<string>;
-    generator: MessageGenerator;
-}): TranslationsByKey<string>;

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;