@vocab/phrase 0.0.0-add-support-for-vocab-cjs-20231109235141

package/LICENSE

@@ -0,0 +1,21 @@
+### MIT License
+
+Copyright (c) 2020 SEEK
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

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

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

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

@@ -0,0 +1,8 @@
+import { type UserConfig } from '@vocab/core';
+interface PullOptions {
+    branch?: string;
+    deleteUnusedKeys?: boolean;
+    errorOnNoGlobalKeyTranslation?: boolean;
+}
+export declare function pull({ branch, errorOnNoGlobalKeyTranslation }: PullOptions, config: UserConfig): Promise<void>;
+export {};

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

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

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

@@ -0,0 +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

@@ -0,0 +1,357 @@
+'use strict';
+
+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 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 debug__default = /*#__PURE__*/_interopDefault(debug);
+
+const mkdir = fs.promises.mkdir;
+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);
+};
+
+function translationsToCsv(translations, devLanguage) {
+  const languages = Object.keys(translations);
+  const altLanguages = languages.filter(language => language !== devLanguage);
+  const devLanguageTranslations = translations[devLanguage];
+  const csvFilesByLanguage = Object.fromEntries(languages.map(language => [language, []]));
+  Object.entries(devLanguageTranslations).map(([key, {
+    message,
+    description,
+    tags
+  }]) => {
+    const sharedData = [key, description, tags === null || tags === void 0 ? void 0 : tags.join(',')];
+    const devLanguageRow = [...sharedData, message];
+    csvFilesByLanguage[devLanguage].push(devLanguageRow);
+    altLanguages.map(language => {
+      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]);
+      }
+    });
+  });
+  const csvFileStrings = Object.fromEntries(Object.entries(csvFilesByLanguage)
+  // Ensure CSV files are only created if the language has at least 1 translation
+  .filter(([_, csvFile]) => csvFile.length > 0).map(([language, csvFile]) => {
+    const csvFileString = sync.stringify(csvFile, {
+      delimiter: ',',
+      header: false
+    });
+    return [language, csvFileString];
+  }));
+
+  // Column indices start at 1
+  const keyIndex = 1;
+  const commentIndex = keyIndex + 1;
+  const tagColumn = commentIndex + 1;
+  const messageIndex = tagColumn + 1;
+  return {
+    csvFileStrings,
+    keyIndex,
+    messageIndex,
+    commentIndex,
+    tagColumn
+  };
+}
+
+/* eslint-disable no-console */
+function _callPhrase(path, options = {}) {
+  const phraseApiToken = process.env.PHRASE_API_TOKEN;
+  if (!phraseApiToken) {
+    throw new Error('Missing PHRASE_API_TOKEN');
+  }
+  return fetch__default["default"](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)',
+      ...options.headers
+    }
+  }).then(async response => {
+    console.log(`${path}: ${response.status} - ${response.statusText}`);
+    const secondsUntilLimitReset = Math.ceil(Number.parseFloat(response.headers.get('X-Rate-Limit-Reset') || '0') - Date.now() / 1000);
+    console.log(`Rate Limit: ${response.headers.get('X-Rate-Limit-Remaining')} of ${response.headers.get('X-Rate-Limit-Limit')} remaining. (${secondsUntilLimitReset} seconds remaining)`);
+    trace('\nLink:', response.headers.get('Link'), '\n');
+    // Print All Headers:
+    // console.log(Array.from(r.headers.entries()));
+
+    try {
+      var _response$headers$get;
+      const result = await response.json();
+      trace(`Internal Result (Length: ${result.length})\n`);
+      if ((!options.method || options.method === 'GET') && (_response$headers$get = response.headers.get('Link')) !== null && _response$headers$get !== void 0 && _response$headers$get.includes('rel=next')) {
+        var _response$headers$get2, _response$headers$get3;
+        const [, nextPageUrl] = (_response$headers$get2 = (_response$headers$get3 = response.headers.get('Link')) === null || _response$headers$get3 === void 0 ? void 0 : _response$headers$get3.match(/<([^>]*)>; rel=next/)) !== null && _response$headers$get2 !== void 0 ? _response$headers$get2 : [];
+        if (!nextPageUrl) {
+          throw new Error("Can't parse next page URL");
+        }
+        console.log('Results received with next page: ', nextPageUrl);
+        const nextPageResult = await _callPhrase(nextPageUrl, options);
+        return [...result, ...nextPageResult];
+      }
+      return result;
+    } catch (e) {
+      console.error('Unable to parse response as JSON', e);
+      return response.text();
+    }
+  });
+}
+async function callPhrase(relativePath, options = {}) {
+  const projectId = process.env.PHRASE_PROJECT_ID;
+  if (!projectId) {
+    throw new Error('Missing PHRASE_PROJECT_ID');
+  }
+  return _callPhrase(`https://api.phrase.com/v2/projects/${projectId}/${relativePath}`, options).then(result => {
+    if (Array.isArray(result)) {
+      console.log('Result length:', result.length);
+    }
+    return result;
+  }).catch(error => {
+    console.error(`Error calling phrase for ${relativePath}:`, error);
+    throw Error;
+  });
+}
+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] = {};
+    }
+    translations[r.locale.code][r.key.name] = {
+      message: r.content
+    };
+  }
+  return translations;
+}
+async function pushTranslations(translationsByLanguage, {
+  devLanguage,
+  branch
+}) {
+  const {
+    csvFileStrings,
+    keyIndex,
+    commentIndex,
+    tagColumn,
+    messageIndex
+  } = 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`
+    });
+    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('format_options[enable_pluralization]', 'false');
+    log(`Uploading translations for language ${language}`);
+    const result = await callPhrase(`uploads`, {
+      method: 'POST',
+      body: formData
+    });
+    trace('Upload result:\n', result);
+    if (result && 'id' in result) {
+      log('Upload ID:', result.id, '\n');
+      log('Successfully Uploaded\n');
+    } else {
+      log(`Error uploading: ${result === null || result === void 0 ? void 0 : result.message}\n`);
+      log('Response:', result);
+      throw new Error('Error uploading');
+    }
+    if (language === devLanguage) {
+      devLanguageUploadId = result.id;
+    }
+  }
+  return {
+    devLanguageUploadId
+  };
+}
+async function deleteUnusedKeys(uploadId, branch) {
+  const query = `unmentioned_in_upload:${uploadId}`;
+  const {
+    records_affected
+  } = await callPhrase('keys', {
+    method: 'DELETE',
+    headers: {
+      'Content-Type': 'application/json'
+    },
+    body: JSON.stringify({
+      branch,
+      q: query
+    })
+  });
+  log('Successfully deleted', records_affected, 'unused keys from branch', branch);
+}
+async function ensureBranch(branch) {
+  await callPhrase(`branches`, {
+    method: 'POST',
+    headers: {
+      'Content-Type': 'application/json'
+    },
+    body: JSON.stringify({
+      name: branch
+    })
+  });
+  log('Created branch:', branch);
+}
+
+async function pull({
+  branch = 'local-development',
+  errorOnNoGlobalKeyTranslation
+}, config) {
+  trace(`Pulling translations from branch ${branch}`);
+  await ensureBranch(branch);
+  const alternativeLanguages = core.getAltLanguages(config);
+  const allPhraseTranslations = await pullAllTranslations(branch);
+  trace(`Pulling translations from Phrase for languages ${config.devLanguage} and ${alternativeLanguages.join(', ')}`);
+  const phraseLanguages = Object.keys(allPhraseTranslations);
+  trace(`Found Phrase translations for languages ${phraseLanguages.join(', ')}`);
+  if (!phraseLanguages.includes(config.devLanguage)) {
+    throw new Error(`Phrase did not return any translations for the configured development language "${config.devLanguage}".\nPlease ensure this language is present in your Phrase project's configuration.`);
+  }
+  const allVocabTranslations = await core.loadAllTranslations({
+    fallbacks: 'none',
+    includeNodeModules: false,
+    withTags: true
+  }, config);
+  for (const loadedTranslation of allVocabTranslations) {
+    const devTranslations = loadedTranslation.languages[config.devLanguage];
+    if (!devTranslations) {
+      throw new Error('No dev language translations loaded');
+    }
+    const defaultValues = {
+      ...devTranslations
+    };
+    const localKeys = Object.keys(defaultValues);
+    for (const key of localKeys) {
+      var _defaultValues$key$gl;
+      defaultValues[key] = {
+        ...defaultValues[key],
+        ...allPhraseTranslations[config.devLanguage][(_defaultValues$key$gl = defaultValues[key].globalKey) !== null && _defaultValues$key$gl !== void 0 ? _defaultValues$key$gl : core.getUniqueKey(key, loadedTranslation.namespace)]
+      };
+    }
+
+    // Only write a `_meta` field if necessary
+    if (Object.keys(loadedTranslation.metadata).length > 0) {
+      defaultValues._meta = loadedTranslation.metadata;
+    }
+    await writeFile(loadedTranslation.filePath, `${JSON.stringify(defaultValues, null, 2)}\n`);
+    for (const alternativeLanguage of alternativeLanguages) {
+      if (alternativeLanguage in allPhraseTranslations) {
+        const altTranslations = {
+          ...loadedTranslation.languages[alternativeLanguage]
+        };
+        const phraseAltTranslations = allPhraseTranslations[alternativeLanguage];
+        for (const key of localKeys) {
+          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] = {
+            ...altTranslations[key],
+            message: phraseTranslationMessage
+          };
+        }
+        const altTranslationFilePath = core.getAltLanguageFilePath(loadedTranslation.filePath, alternativeLanguage);
+        await mkdir(path__default["default"].dirname(altTranslationFilePath), {
+          recursive: true
+        });
+        await writeFile(altTranslationFilePath, `${JSON.stringify(altTranslations, null, 2)}\n`);
+      }
+    }
+  }
+}
+
+/**
+ * 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.
+ */
+async function push({
+  branch,
+  deleteUnusedKeys: deleteUnusedKeys$1
+}, config) {
+  const allLanguageTranslations = await core.loadAllTranslations({
+    fallbacks: 'none',
+    includeNodeModules: false,
+    withTags: true
+  }, config);
+  trace(`Pushing translations to branch ${branch}`);
+  const allLanguages = config.languages.map(v => v.name);
+  await ensureBranch(branch);
+  trace(`Pushing translations to phrase for languages ${allLanguages.join(', ')}`);
+  const phraseTranslations = {};
+  for (const loadedTranslation of allLanguageTranslations) {
+    for (const language of allLanguages) {
+      const localTranslations = loadedTranslation.languages[language];
+      if (!localTranslations) {
+        continue;
+      }
+      if (!phraseTranslations[language]) {
+        phraseTranslations[language] = {};
+      }
+      const {
+        metadata: {
+          tags: sharedTags = []
+        }
+      } = loadedTranslation;
+      for (const localKey of Object.keys(localTranslations)) {
+        const {
+          tags = [],
+          ...localTranslation
+        } = localTranslations[localKey];
+        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;
+      }
+    }
+  }
+  const {
+    devLanguageUploadId
+  } = await pushTranslations(phraseTranslations, {
+    devLanguage: config.devLanguage,
+    branch
+  });
+  if (deleteUnusedKeys$1) {
+    await deleteUnusedKeys(devLanguageUploadId, branch);
+  }
+}
+
+exports.pull = pull;
+exports.push = push;

package/dist/vocab-phrase.cjs.js

@@ -0,0 +1,7 @@
+'use strict';
+
+if (process.env.NODE_ENV === "production") {
+  module.exports = require("./vocab-phrase.cjs.prod.js");
+} else {
+  module.exports = require("./vocab-phrase.cjs.dev.js");
+}

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

@@ -0,0 +1,357 @@
+'use strict';
+
+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 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 debug__default = /*#__PURE__*/_interopDefault(debug);
+
+const mkdir = fs.promises.mkdir;
+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);
+};
+
+function translationsToCsv(translations, devLanguage) {
+  const languages = Object.keys(translations);
+  const altLanguages = languages.filter(language => language !== devLanguage);
+  const devLanguageTranslations = translations[devLanguage];
+  const csvFilesByLanguage = Object.fromEntries(languages.map(language => [language, []]));
+  Object.entries(devLanguageTranslations).map(([key, {
+    message,
+    description,
+    tags
+  }]) => {
+    const sharedData = [key, description, tags === null || tags === void 0 ? void 0 : tags.join(',')];
+    const devLanguageRow = [...sharedData, message];
+    csvFilesByLanguage[devLanguage].push(devLanguageRow);
+    altLanguages.map(language => {
+      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]);
+      }
+    });
+  });
+  const csvFileStrings = Object.fromEntries(Object.entries(csvFilesByLanguage)
+  // Ensure CSV files are only created if the language has at least 1 translation
+  .filter(([_, csvFile]) => csvFile.length > 0).map(([language, csvFile]) => {
+    const csvFileString = sync.stringify(csvFile, {
+      delimiter: ',',
+      header: false
+    });
+    return [language, csvFileString];
+  }));
+
+  // Column indices start at 1
+  const keyIndex = 1;
+  const commentIndex = keyIndex + 1;
+  const tagColumn = commentIndex + 1;
+  const messageIndex = tagColumn + 1;
+  return {
+    csvFileStrings,
+    keyIndex,
+    messageIndex,
+    commentIndex,
+    tagColumn
+  };
+}
+
+/* eslint-disable no-console */
+function _callPhrase(path, options = {}) {
+  const phraseApiToken = process.env.PHRASE_API_TOKEN;
+  if (!phraseApiToken) {
+    throw new Error('Missing PHRASE_API_TOKEN');
+  }
+  return fetch__default["default"](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)',
+      ...options.headers
+    }
+  }).then(async response => {
+    console.log(`${path}: ${response.status} - ${response.statusText}`);
+    const secondsUntilLimitReset = Math.ceil(Number.parseFloat(response.headers.get('X-Rate-Limit-Reset') || '0') - Date.now() / 1000);
+    console.log(`Rate Limit: ${response.headers.get('X-Rate-Limit-Remaining')} of ${response.headers.get('X-Rate-Limit-Limit')} remaining. (${secondsUntilLimitReset} seconds remaining)`);
+    trace('\nLink:', response.headers.get('Link'), '\n');
+    // Print All Headers:
+    // console.log(Array.from(r.headers.entries()));
+
+    try {
+      var _response$headers$get;
+      const result = await response.json();
+      trace(`Internal Result (Length: ${result.length})\n`);
+      if ((!options.method || options.method === 'GET') && (_response$headers$get = response.headers.get('Link')) !== null && _response$headers$get !== void 0 && _response$headers$get.includes('rel=next')) {
+        var _response$headers$get2, _response$headers$get3;
+        const [, nextPageUrl] = (_response$headers$get2 = (_response$headers$get3 = response.headers.get('Link')) === null || _response$headers$get3 === void 0 ? void 0 : _response$headers$get3.match(/<([^>]*)>; rel=next/)) !== null && _response$headers$get2 !== void 0 ? _response$headers$get2 : [];
+        if (!nextPageUrl) {
+          throw new Error("Can't parse next page URL");
+        }
+        console.log('Results received with next page: ', nextPageUrl);
+        const nextPageResult = await _callPhrase(nextPageUrl, options);
+        return [...result, ...nextPageResult];
+      }
+      return result;
+    } catch (e) {
+      console.error('Unable to parse response as JSON', e);
+      return response.text();
+    }
+  });
+}
+async function callPhrase(relativePath, options = {}) {
+  const projectId = process.env.PHRASE_PROJECT_ID;
+  if (!projectId) {
+    throw new Error('Missing PHRASE_PROJECT_ID');
+  }
+  return _callPhrase(`https://api.phrase.com/v2/projects/${projectId}/${relativePath}`, options).then(result => {
+    if (Array.isArray(result)) {
+      console.log('Result length:', result.length);
+    }
+    return result;
+  }).catch(error => {
+    console.error(`Error calling phrase for ${relativePath}:`, error);
+    throw Error;
+  });
+}
+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] = {};
+    }
+    translations[r.locale.code][r.key.name] = {
+      message: r.content
+    };
+  }
+  return translations;
+}
+async function pushTranslations(translationsByLanguage, {
+  devLanguage,
+  branch
+}) {
+  const {
+    csvFileStrings,
+    keyIndex,
+    commentIndex,
+    tagColumn,
+    messageIndex
+  } = 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`
+    });
+    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('format_options[enable_pluralization]', 'false');
+    log(`Uploading translations for language ${language}`);
+    const result = await callPhrase(`uploads`, {
+      method: 'POST',
+      body: formData
+    });
+    trace('Upload result:\n', result);
+    if (result && 'id' in result) {
+      log('Upload ID:', result.id, '\n');
+      log('Successfully Uploaded\n');
+    } else {
+      log(`Error uploading: ${result === null || result === void 0 ? void 0 : result.message}\n`);
+      log('Response:', result);
+      throw new Error('Error uploading');
+    }
+    if (language === devLanguage) {
+      devLanguageUploadId = result.id;
+    }
+  }
+  return {
+    devLanguageUploadId
+  };
+}
+async function deleteUnusedKeys(uploadId, branch) {
+  const query = `unmentioned_in_upload:${uploadId}`;
+  const {
+    records_affected
+  } = await callPhrase('keys', {
+    method: 'DELETE',
+    headers: {
+      'Content-Type': 'application/json'
+    },
+    body: JSON.stringify({
+      branch,
+      q: query
+    })
+  });
+  log('Successfully deleted', records_affected, 'unused keys from branch', branch);
+}
+async function ensureBranch(branch) {
+  await callPhrase(`branches`, {
+    method: 'POST',
+    headers: {
+      'Content-Type': 'application/json'
+    },
+    body: JSON.stringify({
+      name: branch
+    })
+  });
+  log('Created branch:', branch);
+}
+
+async function pull({
+  branch = 'local-development',
+  errorOnNoGlobalKeyTranslation
+}, config) {
+  trace(`Pulling translations from branch ${branch}`);
+  await ensureBranch(branch);
+  const alternativeLanguages = core.getAltLanguages(config);
+  const allPhraseTranslations = await pullAllTranslations(branch);
+  trace(`Pulling translations from Phrase for languages ${config.devLanguage} and ${alternativeLanguages.join(', ')}`);
+  const phraseLanguages = Object.keys(allPhraseTranslations);
+  trace(`Found Phrase translations for languages ${phraseLanguages.join(', ')}`);
+  if (!phraseLanguages.includes(config.devLanguage)) {
+    throw new Error(`Phrase did not return any translations for the configured development language "${config.devLanguage}".\nPlease ensure this language is present in your Phrase project's configuration.`);
+  }
+  const allVocabTranslations = await core.loadAllTranslations({
+    fallbacks: 'none',
+    includeNodeModules: false,
+    withTags: true
+  }, config);
+  for (const loadedTranslation of allVocabTranslations) {
+    const devTranslations = loadedTranslation.languages[config.devLanguage];
+    if (!devTranslations) {
+      throw new Error('No dev language translations loaded');
+    }
+    const defaultValues = {
+      ...devTranslations
+    };
+    const localKeys = Object.keys(defaultValues);
+    for (const key of localKeys) {
+      var _defaultValues$key$gl;
+      defaultValues[key] = {
+        ...defaultValues[key],
+        ...allPhraseTranslations[config.devLanguage][(_defaultValues$key$gl = defaultValues[key].globalKey) !== null && _defaultValues$key$gl !== void 0 ? _defaultValues$key$gl : core.getUniqueKey(key, loadedTranslation.namespace)]
+      };
+    }
+
+    // Only write a `_meta` field if necessary
+    if (Object.keys(loadedTranslation.metadata).length > 0) {
+      defaultValues._meta = loadedTranslation.metadata;
+    }
+    await writeFile(loadedTranslation.filePath, `${JSON.stringify(defaultValues, null, 2)}\n`);
+    for (const alternativeLanguage of alternativeLanguages) {
+      if (alternativeLanguage in allPhraseTranslations) {
+        const altTranslations = {
+          ...loadedTranslation.languages[alternativeLanguage]
+        };
+        const phraseAltTranslations = allPhraseTranslations[alternativeLanguage];
+        for (const key of localKeys) {
+          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] = {
+            ...altTranslations[key],
+            message: phraseTranslationMessage
+          };
+        }
+        const altTranslationFilePath = core.getAltLanguageFilePath(loadedTranslation.filePath, alternativeLanguage);
+        await mkdir(path__default["default"].dirname(altTranslationFilePath), {
+          recursive: true
+        });
+        await writeFile(altTranslationFilePath, `${JSON.stringify(altTranslations, null, 2)}\n`);
+      }
+    }
+  }
+}
+
+/**
+ * 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.
+ */
+async function push({
+  branch,
+  deleteUnusedKeys: deleteUnusedKeys$1
+}, config) {
+  const allLanguageTranslations = await core.loadAllTranslations({
+    fallbacks: 'none',
+    includeNodeModules: false,
+    withTags: true
+  }, config);
+  trace(`Pushing translations to branch ${branch}`);
+  const allLanguages = config.languages.map(v => v.name);
+  await ensureBranch(branch);
+  trace(`Pushing translations to phrase for languages ${allLanguages.join(', ')}`);
+  const phraseTranslations = {};
+  for (const loadedTranslation of allLanguageTranslations) {
+    for (const language of allLanguages) {
+      const localTranslations = loadedTranslation.languages[language];
+      if (!localTranslations) {
+        continue;
+      }
+      if (!phraseTranslations[language]) {
+        phraseTranslations[language] = {};
+      }
+      const {
+        metadata: {
+          tags: sharedTags = []
+        }
+      } = loadedTranslation;
+      for (const localKey of Object.keys(localTranslations)) {
+        const {
+          tags = [],
+          ...localTranslation
+        } = localTranslations[localKey];
+        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;
+      }
+    }
+  }
+  const {
+    devLanguageUploadId
+  } = await pushTranslations(phraseTranslations, {
+    devLanguage: config.devLanguage,
+    branch
+  });
+  if (deleteUnusedKeys$1) {
+    await deleteUnusedKeys(devLanguageUploadId, branch);
+  }
+}
+
+exports.pull = pull;
+exports.push = push;

package/dist/vocab-phrase.esm.js

@@ -0,0 +1,344 @@
+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 debug from 'debug';
+import { stringify } from 'csv-stringify/sync';
+
+const mkdir = promises.mkdir;
+const writeFile = promises.writeFile;
+
+const trace = debug(`vocab:phrase`);
+const log = (...params) => {
+  // eslint-disable-next-line no-console
+  console.log(chalk.yellow('Vocab'), ...params);
+};
+
+function translationsToCsv(translations, devLanguage) {
+  const languages = Object.keys(translations);
+  const altLanguages = languages.filter(language => language !== devLanguage);
+  const devLanguageTranslations = translations[devLanguage];
+  const csvFilesByLanguage = Object.fromEntries(languages.map(language => [language, []]));
+  Object.entries(devLanguageTranslations).map(([key, {
+    message,
+    description,
+    tags
+  }]) => {
+    const sharedData = [key, description, tags === null || tags === void 0 ? void 0 : tags.join(',')];
+    const devLanguageRow = [...sharedData, message];
+    csvFilesByLanguage[devLanguage].push(devLanguageRow);
+    altLanguages.map(language => {
+      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]);
+      }
+    });
+  });
+  const csvFileStrings = Object.fromEntries(Object.entries(csvFilesByLanguage)
+  // Ensure CSV files are only created if the language has at least 1 translation
+  .filter(([_, csvFile]) => csvFile.length > 0).map(([language, csvFile]) => {
+    const csvFileString = stringify(csvFile, {
+      delimiter: ',',
+      header: false
+    });
+    return [language, csvFileString];
+  }));
+
+  // Column indices start at 1
+  const keyIndex = 1;
+  const commentIndex = keyIndex + 1;
+  const tagColumn = commentIndex + 1;
+  const messageIndex = tagColumn + 1;
+  return {
+    csvFileStrings,
+    keyIndex,
+    messageIndex,
+    commentIndex,
+    tagColumn
+  };
+}
+
+/* eslint-disable no-console */
+function _callPhrase(path, options = {}) {
+  const phraseApiToken = process.env.PHRASE_API_TOKEN;
+  if (!phraseApiToken) {
+    throw new Error('Missing PHRASE_API_TOKEN');
+  }
+  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)',
+      ...options.headers
+    }
+  }).then(async response => {
+    console.log(`${path}: ${response.status} - ${response.statusText}`);
+    const secondsUntilLimitReset = Math.ceil(Number.parseFloat(response.headers.get('X-Rate-Limit-Reset') || '0') - Date.now() / 1000);
+    console.log(`Rate Limit: ${response.headers.get('X-Rate-Limit-Remaining')} of ${response.headers.get('X-Rate-Limit-Limit')} remaining. (${secondsUntilLimitReset} seconds remaining)`);
+    trace('\nLink:', response.headers.get('Link'), '\n');
+    // Print All Headers:
+    // console.log(Array.from(r.headers.entries()));
+
+    try {
+      var _response$headers$get;
+      const result = await response.json();
+      trace(`Internal Result (Length: ${result.length})\n`);
+      if ((!options.method || options.method === 'GET') && (_response$headers$get = response.headers.get('Link')) !== null && _response$headers$get !== void 0 && _response$headers$get.includes('rel=next')) {
+        var _response$headers$get2, _response$headers$get3;
+        const [, nextPageUrl] = (_response$headers$get2 = (_response$headers$get3 = response.headers.get('Link')) === null || _response$headers$get3 === void 0 ? void 0 : _response$headers$get3.match(/<([^>]*)>; rel=next/)) !== null && _response$headers$get2 !== void 0 ? _response$headers$get2 : [];
+        if (!nextPageUrl) {
+          throw new Error("Can't parse next page URL");
+        }
+        console.log('Results received with next page: ', nextPageUrl);
+        const nextPageResult = await _callPhrase(nextPageUrl, options);
+        return [...result, ...nextPageResult];
+      }
+      return result;
+    } catch (e) {
+      console.error('Unable to parse response as JSON', e);
+      return response.text();
+    }
+  });
+}
+async function callPhrase(relativePath, options = {}) {
+  const projectId = process.env.PHRASE_PROJECT_ID;
+  if (!projectId) {
+    throw new Error('Missing PHRASE_PROJECT_ID');
+  }
+  return _callPhrase(`https://api.phrase.com/v2/projects/${projectId}/${relativePath}`, options).then(result => {
+    if (Array.isArray(result)) {
+      console.log('Result length:', result.length);
+    }
+    return result;
+  }).catch(error => {
+    console.error(`Error calling phrase for ${relativePath}:`, error);
+    throw Error;
+  });
+}
+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] = {};
+    }
+    translations[r.locale.code][r.key.name] = {
+      message: r.content
+    };
+  }
+  return translations;
+}
+async function pushTranslations(translationsByLanguage, {
+  devLanguage,
+  branch
+}) {
+  const {
+    csvFileStrings,
+    keyIndex,
+    commentIndex,
+    tagColumn,
+    messageIndex
+  } = translationsToCsv(translationsByLanguage, devLanguage);
+  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_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('format_options[enable_pluralization]', 'false');
+    log(`Uploading translations for language ${language}`);
+    const result = await callPhrase(`uploads`, {
+      method: 'POST',
+      body: formData
+    });
+    trace('Upload result:\n', result);
+    if (result && 'id' in result) {
+      log('Upload ID:', result.id, '\n');
+      log('Successfully Uploaded\n');
+    } else {
+      log(`Error uploading: ${result === null || result === void 0 ? void 0 : result.message}\n`);
+      log('Response:', result);
+      throw new Error('Error uploading');
+    }
+    if (language === devLanguage) {
+      devLanguageUploadId = result.id;
+    }
+  }
+  return {
+    devLanguageUploadId
+  };
+}
+async function deleteUnusedKeys(uploadId, branch) {
+  const query = `unmentioned_in_upload:${uploadId}`;
+  const {
+    records_affected
+  } = await callPhrase('keys', {
+    method: 'DELETE',
+    headers: {
+      'Content-Type': 'application/json'
+    },
+    body: JSON.stringify({
+      branch,
+      q: query
+    })
+  });
+  log('Successfully deleted', records_affected, 'unused keys from branch', branch);
+}
+async function ensureBranch(branch) {
+  await callPhrase(`branches`, {
+    method: 'POST',
+    headers: {
+      'Content-Type': 'application/json'
+    },
+    body: JSON.stringify({
+      name: branch
+    })
+  });
+  log('Created branch:', branch);
+}
+
+async function pull({
+  branch = 'local-development',
+  errorOnNoGlobalKeyTranslation
+}, config) {
+  trace(`Pulling translations from branch ${branch}`);
+  await ensureBranch(branch);
+  const alternativeLanguages = getAltLanguages(config);
+  const allPhraseTranslations = await pullAllTranslations(branch);
+  trace(`Pulling translations from Phrase for languages ${config.devLanguage} and ${alternativeLanguages.join(', ')}`);
+  const phraseLanguages = Object.keys(allPhraseTranslations);
+  trace(`Found Phrase translations for languages ${phraseLanguages.join(', ')}`);
+  if (!phraseLanguages.includes(config.devLanguage)) {
+    throw new Error(`Phrase did not return any translations for the configured development language "${config.devLanguage}".\nPlease ensure this language is present in your Phrase project's configuration.`);
+  }
+  const allVocabTranslations = await loadAllTranslations({
+    fallbacks: 'none',
+    includeNodeModules: false,
+    withTags: true
+  }, config);
+  for (const loadedTranslation of allVocabTranslations) {
+    const devTranslations = loadedTranslation.languages[config.devLanguage];
+    if (!devTranslations) {
+      throw new Error('No dev language translations loaded');
+    }
+    const defaultValues = {
+      ...devTranslations
+    };
+    const localKeys = Object.keys(defaultValues);
+    for (const key of localKeys) {
+      var _defaultValues$key$gl;
+      defaultValues[key] = {
+        ...defaultValues[key],
+        ...allPhraseTranslations[config.devLanguage][(_defaultValues$key$gl = defaultValues[key].globalKey) !== null && _defaultValues$key$gl !== void 0 ? _defaultValues$key$gl : getUniqueKey(key, loadedTranslation.namespace)]
+      };
+    }
+
+    // Only write a `_meta` field if necessary
+    if (Object.keys(loadedTranslation.metadata).length > 0) {
+      defaultValues._meta = loadedTranslation.metadata;
+    }
+    await writeFile(loadedTranslation.filePath, `${JSON.stringify(defaultValues, null, 2)}\n`);
+    for (const alternativeLanguage of alternativeLanguages) {
+      if (alternativeLanguage in allPhraseTranslations) {
+        const altTranslations = {
+          ...loadedTranslation.languages[alternativeLanguage]
+        };
+        const phraseAltTranslations = allPhraseTranslations[alternativeLanguage];
+        for (const key of localKeys) {
+          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] = {
+            ...altTranslations[key],
+            message: phraseTranslationMessage
+          };
+        }
+        const altTranslationFilePath = getAltLanguageFilePath(loadedTranslation.filePath, alternativeLanguage);
+        await mkdir(path.dirname(altTranslationFilePath), {
+          recursive: true
+        });
+        await writeFile(altTranslationFilePath, `${JSON.stringify(altTranslations, null, 2)}\n`);
+      }
+    }
+  }
+}
+
+/**
+ * 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.
+ */
+async function push({
+  branch,
+  deleteUnusedKeys: deleteUnusedKeys$1
+}, config) {
+  const allLanguageTranslations = await loadAllTranslations({
+    fallbacks: 'none',
+    includeNodeModules: false,
+    withTags: true
+  }, config);
+  trace(`Pushing translations to branch ${branch}`);
+  const allLanguages = config.languages.map(v => v.name);
+  await ensureBranch(branch);
+  trace(`Pushing translations to phrase for languages ${allLanguages.join(', ')}`);
+  const phraseTranslations = {};
+  for (const loadedTranslation of allLanguageTranslations) {
+    for (const language of allLanguages) {
+      const localTranslations = loadedTranslation.languages[language];
+      if (!localTranslations) {
+        continue;
+      }
+      if (!phraseTranslations[language]) {
+        phraseTranslations[language] = {};
+      }
+      const {
+        metadata: {
+          tags: sharedTags = []
+        }
+      } = loadedTranslation;
+      for (const localKey of Object.keys(localTranslations)) {
+        const {
+          tags = [],
+          ...localTranslation
+        } = localTranslations[localKey];
+        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;
+      }
+    }
+  }
+  const {
+    devLanguageUploadId
+  } = await pushTranslations(phraseTranslations, {
+    devLanguage: config.devLanguage,
+    branch
+  });
+  if (deleteUnusedKeys$1) {
+    await deleteUnusedKeys(devLanguageUploadId, branch);
+  }
+}
+
+export { pull, push };

package/package.json

@@ -0,0 +1,23 @@
+{
+  "name": "@vocab/phrase",
+  "version": "0.0.0-add-support-for-vocab-cjs-20231109235141",
+  "main": "dist/vocab-phrase.cjs.js",
+  "module": "dist/vocab-phrase.esm.js",
+  "author": "SEEK",
+  "license": "MIT",
+  "dependencies": {
+    "@vocab/core": "0.0.0-add-support-for-vocab-cjs-20231109235141",
+    "chalk": "^4.1.0",
+    "csv-stringify": "^6.2.3",
+    "debug": "^4.3.1",
+    "form-data": "^3.0.0",
+    "node-fetch": "^2.6.1"
+  },
+  "devDependencies": {
+    "@types/debug": "^4.1.5",
+    "@types/node-fetch": "^2.5.7"
+  },
+  "files": [
+    "dist"
+  ]
+}