@vocab/phrase 0.0.0-global-key-support-20231025223328 → 0.0.0-master-20250202230611

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,4 +1,4 @@
-import type { UserConfig } from '@vocab/core';
+import { type UserConfig } from '@vocab/core';
 interface PullOptions {
     branch?: string;
     deleteUnusedKeys?: boolean;

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

@@ -1,11 +1,12 @@
-import type { UserConfig } from '@vocab/core';
+import { type UserConfig } from '@vocab/core';
 interface PushOptions {
     branch: string;
     deleteUnusedKeys?: boolean;
+    ignore?: string[];
 }
 /**
  * Uploads translations to the Phrase API for each language.
  * A unique namespace is appended to each key using the file path the key came from.
  */
-export declare function push({ branch, deleteUnusedKeys }: PushOptions, config: UserConfig): Promise<void>;
+export declare function push({ branch, deleteUnusedKeys, ignore }: PushOptions, config: UserConfig): Promise<void>;
 export {};

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

@@ -1 +1,2 @@
-export * from "./declarations/src/index";
+export * from "./declarations/src/index.js";
+//# sourceMappingURL=data:application/json;charset=utf-8;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoidm9jYWItcGhyYXNlLmNqcy5kLnRzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi9kZWNsYXJhdGlvbnMvc3JjL2luZGV4LmQudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IkFBQUEifQ==

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

@@ -5,18 +5,14 @@ Object.defineProperty(exports, '__esModule', { value: true });
 var fs = require('fs');
 var path = require('path');
 var core = require('@vocab/core');
-var FormData = require('form-data');
-var fetch = require('node-fetch');
-var chalk = require('chalk');
+var pc = require('picocolors');
 var debug = require('debug');
 var sync = require('csv-stringify/sync');
 
 function _interopDefault (e) { return e && e.__esModule ? e : { 'default': e }; }
 
 var path__default = /*#__PURE__*/_interopDefault(path);
-var FormData__default = /*#__PURE__*/_interopDefault(FormData);
-var fetch__default = /*#__PURE__*/_interopDefault(fetch);
-var chalk__default = /*#__PURE__*/_interopDefault(chalk);
+var pc__default = /*#__PURE__*/_interopDefault(pc);
 var debug__default = /*#__PURE__*/_interopDefault(debug);
 
 const mkdir = fs.promises.mkdir;
@@ -25,7 +21,7 @@ const writeFile = fs.promises.writeFile;
 const trace = debug__default["default"](`vocab:phrase`);
 const log = (...params) => {
   // eslint-disable-next-line no-console
-  console.log(chalk__default["default"].yellow('Vocab'), ...params);
+  console.log(pc__default["default"].yellow('Vocab'), ...params);
 };
 
 function translationsToCsv(translations, devLanguage) {
@@ -42,8 +38,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]);
       }
@@ -79,12 +75,12 @@ function _callPhrase(path, options = {}) {
   if (!phraseApiToken) {
     throw new Error('Missing PHRASE_API_TOKEN');
   }
-  return fetch__default["default"](path, {
+  return fetch(path, {
     ...options,
     headers: {
       Authorization: `token ${phraseApiToken}`,
       // Provide identification via User Agent as requested in https://developers.phrase.com/api/#overview--identification-via-user-agent
-      'User-Agent': 'SEEK Demo Candidate App (jhope@seek.com.au)',
+      'User-Agent': 'Vocab Client (https://github.com/seek-oss/vocab)',
       ...options.headers
     }
   }).then(async response => {
@@ -135,10 +131,10 @@ async function pullAllTranslations(branch) {
   const phraseResult = await callPhrase(`translations?branch=${branch}&per_page=100`);
   const translations = {};
   for (const r of phraseResult) {
-    if (!translations[r.locale.code]) {
-      translations[r.locale.code] = {};
+    if (!translations[r.locale.name]) {
+      translations[r.locale.name] = {};
     }
-    translations[r.locale.code][r.key.name] = {
+    translations[r.locale.name][r.key.name] = {
       message: r.content
     };
   }
@@ -157,20 +153,18 @@ async function pushTranslations(translationsByLanguage, {
   } = translationsToCsv(translationsByLanguage, devLanguage);
   let devLanguageUploadId = '';
   for (const [language, csvFileString] of Object.entries(csvFileStrings)) {
-    const formData = new FormData__default["default"]();
-    const fileContents = Buffer.from(csvFileString);
-    formData.append('file', fileContents, {
-      contentType: 'text/csv',
-      filename: `${language}.translations.csv`
-    });
+    const formData = new FormData();
+    formData.append('file', new Blob([csvFileString], {
+      type: 'text/csv'
+    }), `${language}.translations.csv`);
     formData.append('file_format', 'csv');
     formData.append('branch', branch);
     formData.append('update_translations', 'true');
     formData.append('update_descriptions', 'true');
-    formData.append(`locale_mapping[${language}]`, messageIndex);
-    formData.append('format_options[key_index]', keyIndex);
-    formData.append('format_options[comment_index]', commentIndex);
-    formData.append('format_options[tag_column]', tagColumn);
+    formData.append(`locale_mapping[${language}]`, messageIndex.toString());
+    formData.append('format_options[key_index]', keyIndex.toString());
+    formData.append('format_options[comment_index]', commentIndex.toString());
+    formData.append('format_options[tag_column]', tagColumn.toString());
     formData.append('format_options[enable_pluralization]', 'false');
     log(`Uploading translations for language ${language}`);
     const result = await callPhrase(`uploads`, {
@@ -302,13 +296,20 @@ async function pull({
  */
 async function push({
   branch,
-  deleteUnusedKeys: deleteUnusedKeys$1
+  deleteUnusedKeys: deleteUnusedKeys$1,
+  ignore
 }, config) {
+  if (ignore) {
+    trace(`ignoring files on paths: ${ignore.join(', ')}`);
+  }
   const allLanguageTranslations = await core.loadAllTranslations({
     fallbacks: 'none',
     includeNodeModules: false,
     withTags: true
-  }, config);
+  }, {
+    ...config,
+    ignore: [...(config.ignore || []), ...(ignore || [])]
+  });
   trace(`Pushing translations to branch ${branch}`);
   const allLanguages = config.languages.map(v => v.name);
   await ensureBranch(branch);
@@ -329,7 +330,6 @@ async function push({
         }
       } = loadedTranslation;
       for (const localKey of Object.keys(localTranslations)) {
-        var _globalKey;
         const {
           tags = [],
           ...localTranslation
@@ -337,11 +337,8 @@ async function push({
         if (language === config.devLanguage) {
           localTranslation.tags = [...tags, ...sharedTags];
         }
-        let globalKey;
-        if (loadedTranslation.languages[config.devLanguage][localKey].globalKey) {
-          globalKey = loadedTranslation.languages[config.devLanguage][localKey].globalKey;
-        }
-        const phraseKey = (_globalKey = globalKey) !== null && _globalKey !== void 0 ? _globalKey : core.getUniqueKey(localKey, loadedTranslation.namespace);
+        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

@@ -5,18 +5,14 @@ Object.defineProperty(exports, '__esModule', { value: true });
 var fs = require('fs');
 var path = require('path');
 var core = require('@vocab/core');
-var FormData = require('form-data');
-var fetch = require('node-fetch');
-var chalk = require('chalk');
+var pc = require('picocolors');
 var debug = require('debug');
 var sync = require('csv-stringify/sync');
 
 function _interopDefault (e) { return e && e.__esModule ? e : { 'default': e }; }
 
 var path__default = /*#__PURE__*/_interopDefault(path);
-var FormData__default = /*#__PURE__*/_interopDefault(FormData);
-var fetch__default = /*#__PURE__*/_interopDefault(fetch);
-var chalk__default = /*#__PURE__*/_interopDefault(chalk);
+var pc__default = /*#__PURE__*/_interopDefault(pc);
 var debug__default = /*#__PURE__*/_interopDefault(debug);
 
 const mkdir = fs.promises.mkdir;
@@ -25,7 +21,7 @@ const writeFile = fs.promises.writeFile;
 const trace = debug__default["default"](`vocab:phrase`);
 const log = (...params) => {
   // eslint-disable-next-line no-console
-  console.log(chalk__default["default"].yellow('Vocab'), ...params);
+  console.log(pc__default["default"].yellow('Vocab'), ...params);
 };
 
 function translationsToCsv(translations, devLanguage) {
@@ -42,8 +38,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]);
       }
@@ -79,12 +75,12 @@ function _callPhrase(path, options = {}) {
   if (!phraseApiToken) {
     throw new Error('Missing PHRASE_API_TOKEN');
   }
-  return fetch__default["default"](path, {
+  return fetch(path, {
     ...options,
     headers: {
       Authorization: `token ${phraseApiToken}`,
       // Provide identification via User Agent as requested in https://developers.phrase.com/api/#overview--identification-via-user-agent
-      'User-Agent': 'SEEK Demo Candidate App (jhope@seek.com.au)',
+      'User-Agent': 'Vocab Client (https://github.com/seek-oss/vocab)',
       ...options.headers
     }
   }).then(async response => {
@@ -135,10 +131,10 @@ async function pullAllTranslations(branch) {
   const phraseResult = await callPhrase(`translations?branch=${branch}&per_page=100`);
   const translations = {};
   for (const r of phraseResult) {
-    if (!translations[r.locale.code]) {
-      translations[r.locale.code] = {};
+    if (!translations[r.locale.name]) {
+      translations[r.locale.name] = {};
     }
-    translations[r.locale.code][r.key.name] = {
+    translations[r.locale.name][r.key.name] = {
       message: r.content
     };
   }
@@ -157,20 +153,18 @@ async function pushTranslations(translationsByLanguage, {
   } = translationsToCsv(translationsByLanguage, devLanguage);
   let devLanguageUploadId = '';
   for (const [language, csvFileString] of Object.entries(csvFileStrings)) {
-    const formData = new FormData__default["default"]();
-    const fileContents = Buffer.from(csvFileString);
-    formData.append('file', fileContents, {
-      contentType: 'text/csv',
-      filename: `${language}.translations.csv`
-    });
+    const formData = new FormData();
+    formData.append('file', new Blob([csvFileString], {
+      type: 'text/csv'
+    }), `${language}.translations.csv`);
     formData.append('file_format', 'csv');
     formData.append('branch', branch);
     formData.append('update_translations', 'true');
     formData.append('update_descriptions', 'true');
-    formData.append(`locale_mapping[${language}]`, messageIndex);
-    formData.append('format_options[key_index]', keyIndex);
-    formData.append('format_options[comment_index]', commentIndex);
-    formData.append('format_options[tag_column]', tagColumn);
+    formData.append(`locale_mapping[${language}]`, messageIndex.toString());
+    formData.append('format_options[key_index]', keyIndex.toString());
+    formData.append('format_options[comment_index]', commentIndex.toString());
+    formData.append('format_options[tag_column]', tagColumn.toString());
     formData.append('format_options[enable_pluralization]', 'false');
     log(`Uploading translations for language ${language}`);
     const result = await callPhrase(`uploads`, {
@@ -302,13 +296,20 @@ async function pull({
  */
 async function push({
   branch,
-  deleteUnusedKeys: deleteUnusedKeys$1
+  deleteUnusedKeys: deleteUnusedKeys$1,
+  ignore
 }, config) {
+  if (ignore) {
+    trace(`ignoring files on paths: ${ignore.join(', ')}`);
+  }
   const allLanguageTranslations = await core.loadAllTranslations({
     fallbacks: 'none',
     includeNodeModules: false,
     withTags: true
-  }, config);
+  }, {
+    ...config,
+    ignore: [...(config.ignore || []), ...(ignore || [])]
+  });
   trace(`Pushing translations to branch ${branch}`);
   const allLanguages = config.languages.map(v => v.name);
   await ensureBranch(branch);
@@ -329,7 +330,6 @@ async function push({
         }
       } = loadedTranslation;
       for (const localKey of Object.keys(localTranslations)) {
-        var _globalKey;
         const {
           tags = [],
           ...localTranslation
@@ -337,11 +337,8 @@ async function push({
         if (language === config.devLanguage) {
           localTranslation.tags = [...tags, ...sharedTags];
         }
-        let globalKey;
-        if (loadedTranslation.languages[config.devLanguage][localKey].globalKey) {
-          globalKey = loadedTranslation.languages[config.devLanguage][localKey].globalKey;
-        }
-        const phraseKey = (_globalKey = globalKey) !== null && _globalKey !== void 0 ? _globalKey : core.getUniqueKey(localKey, loadedTranslation.namespace);
+        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

@@ -1,9 +1,7 @@
 import { promises } from 'fs';
 import path from 'path';
 import { getAltLanguages, loadAllTranslations, getUniqueKey, getAltLanguageFilePath } from '@vocab/core';
-import FormData from 'form-data';
-import fetch from 'node-fetch';
-import chalk from 'chalk';
+import pc from 'picocolors';
 import debug from 'debug';
 import { stringify } from 'csv-stringify/sync';
 
@@ -13,7 +11,7 @@ const writeFile = promises.writeFile;
 const trace = debug(`vocab:phrase`);
 const log = (...params) => {
   // eslint-disable-next-line no-console
-  console.log(chalk.yellow('Vocab'), ...params);
+  console.log(pc.yellow('Vocab'), ...params);
 };
 
 function translationsToCsv(translations, devLanguage) {
@@ -30,8 +28,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]);
       }
@@ -72,7 +70,7 @@ function _callPhrase(path, options = {}) {
     headers: {
       Authorization: `token ${phraseApiToken}`,
       // Provide identification via User Agent as requested in https://developers.phrase.com/api/#overview--identification-via-user-agent
-      'User-Agent': 'SEEK Demo Candidate App (jhope@seek.com.au)',
+      'User-Agent': 'Vocab Client (https://github.com/seek-oss/vocab)',
       ...options.headers
     }
   }).then(async response => {
@@ -123,10 +121,10 @@ async function pullAllTranslations(branch) {
   const phraseResult = await callPhrase(`translations?branch=${branch}&per_page=100`);
   const translations = {};
   for (const r of phraseResult) {
-    if (!translations[r.locale.code]) {
-      translations[r.locale.code] = {};
+    if (!translations[r.locale.name]) {
+      translations[r.locale.name] = {};
     }
-    translations[r.locale.code][r.key.name] = {
+    translations[r.locale.name][r.key.name] = {
       message: r.content
     };
   }
@@ -146,19 +144,17 @@ async function pushTranslations(translationsByLanguage, {
   let devLanguageUploadId = '';
   for (const [language, csvFileString] of Object.entries(csvFileStrings)) {
     const formData = new FormData();
-    const fileContents = Buffer.from(csvFileString);
-    formData.append('file', fileContents, {
-      contentType: 'text/csv',
-      filename: `${language}.translations.csv`
-    });
+    formData.append('file', new Blob([csvFileString], {
+      type: 'text/csv'
+    }), `${language}.translations.csv`);
     formData.append('file_format', 'csv');
     formData.append('branch', branch);
     formData.append('update_translations', 'true');
     formData.append('update_descriptions', 'true');
-    formData.append(`locale_mapping[${language}]`, messageIndex);
-    formData.append('format_options[key_index]', keyIndex);
-    formData.append('format_options[comment_index]', commentIndex);
-    formData.append('format_options[tag_column]', tagColumn);
+    formData.append(`locale_mapping[${language}]`, messageIndex.toString());
+    formData.append('format_options[key_index]', keyIndex.toString());
+    formData.append('format_options[comment_index]', commentIndex.toString());
+    formData.append('format_options[tag_column]', tagColumn.toString());
     formData.append('format_options[enable_pluralization]', 'false');
     log(`Uploading translations for language ${language}`);
     const result = await callPhrase(`uploads`, {
@@ -290,13 +286,20 @@ async function pull({
  */
 async function push({
   branch,
-  deleteUnusedKeys: deleteUnusedKeys$1
+  deleteUnusedKeys: deleteUnusedKeys$1,
+  ignore
 }, config) {
+  if (ignore) {
+    trace(`ignoring files on paths: ${ignore.join(', ')}`);
+  }
   const allLanguageTranslations = await loadAllTranslations({
     fallbacks: 'none',
     includeNodeModules: false,
     withTags: true
-  }, config);
+  }, {
+    ...config,
+    ignore: [...(config.ignore || []), ...(ignore || [])]
+  });
   trace(`Pushing translations to branch ${branch}`);
   const allLanguages = config.languages.map(v => v.name);
   await ensureBranch(branch);
@@ -317,7 +320,6 @@ async function push({
         }
       } = loadedTranslation;
       for (const localKey of Object.keys(localTranslations)) {
-        var _globalKey;
         const {
           tags = [],
           ...localTranslation
@@ -325,11 +327,8 @@ async function push({
         if (language === config.devLanguage) {
           localTranslation.tags = [...tags, ...sharedTags];
         }
-        let globalKey;
-        if (loadedTranslation.languages[config.devLanguage][localKey].globalKey) {
-          globalKey = loadedTranslation.languages[config.devLanguage][localKey].globalKey;
-        }
-        const phraseKey = (_globalKey = globalKey) !== null && _globalKey !== void 0 ? _globalKey : getUniqueKey(localKey, loadedTranslation.namespace);
+        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,21 +1,27 @@
 {
   "name": "@vocab/phrase",
-  "version": "0.0.0-global-key-support-20231025223328",
+  "version": "0.0.0-master-20250202230611",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/seek-oss/vocab.git",
+    "directory": "packages/phrase"
+  },
+  "engines": {
+    "node": ">=18"
+  },
   "main": "dist/vocab-phrase.cjs.js",
   "module": "dist/vocab-phrase.esm.js",
   "author": "SEEK",
   "license": "MIT",
   "dependencies": {
-    "@vocab/core": "0.0.0-global-key-support-20231025223328",
-    "chalk": "^4.1.0",
     "csv-stringify": "^6.2.3",
     "debug": "^4.3.1",
-    "form-data": "^3.0.0",
-    "node-fetch": "^2.6.1"
+    "picocolors": "^1.0.0",
+    "@vocab/core": "^1.6.3"
   },
   "devDependencies": {
     "@types/debug": "^4.1.5",
-    "@types/node-fetch": "^2.5.7"
+    "@types/node": "^18.11.9"
   },
   "files": [
     "dist"

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>;