@vocab/phrase 1.1.0 → 1.2.0

package/dist/vocab-phrase.esm.js

@@ -5,6 +5,7 @@ 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;
@@ -15,6 +16,44 @@ const log = (...params) => {
   console.log(chalk.yellow('Vocab'), ...params);
 };
 
+function translationsToCsv(translations, devLanguage) {
+  const languages = Object.keys(translations);
+  const altLanguages = languages.filter(language => language !== devLanguage); // Ensure languages are ordered for locale mapping
+
+  const orderedLanguages = [devLanguage, ...altLanguages];
+  const devLanguageTranslations = translations[devLanguage];
+  const csv = Object.entries(devLanguageTranslations).map(([key, {
+    message,
+    description,
+    tags
+  }]) => {
+    const altTranslationMessages = altLanguages.map(language => {
+      var _translations$languag, _translations$languag2;
+
+      return (_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;
+    });
+    return [message, ...altTranslationMessages, key, description, tags === null || tags === void 0 ? void 0 : tags.join(',')];
+  });
+  const csvString = stringify(csv, {
+    delimiter: ',',
+    header: false
+  }); // Column indices start at 1
+
+  const localeMapping = Object.fromEntries(orderedLanguages.map((language, index) => [language, index + 1]));
+  const keyIndex = orderedLanguages.length + 1;
+  const commentIndex = keyIndex + 1;
+  const tagColumn = commentIndex + 1;
+  return {
+    csvString,
+    localeMapping,
+    keyIndex,
+    commentIndex,
+    tagColumn
+  };
+}
+
+/* eslint-disable no-console */
+
 function _callPhrase(path, options = {}) {
   const phraseApiToken = process.env.PHRASE_API_TOKEN;
 
@@ -97,31 +136,56 @@ async function pullAllTranslations(branch) {
 
   return translations;
 }
-async function pushTranslationsByLocale(contents, locale, branch) {
+async function pushTranslations(translationsByLanguage, {
+  devLanguage,
+  branch
+}) {
   const formData = new FormData();
-  const fileContents = Buffer.from(JSON.stringify(contents));
+  const {
+    csvString,
+    localeMapping,
+    keyIndex,
+    commentIndex,
+    tagColumn
+  } = translationsToCsv(translationsByLanguage, devLanguage);
+  const fileContents = Buffer.from(csvString);
   formData.append('file', fileContents, {
-    contentType: 'application/json',
-    filename: `${locale}.json`
+    contentType: 'text/csv',
+    filename: 'translations.csv'
   });
-  formData.append('file_format', 'json');
-  formData.append('locale_id', locale);
+  formData.append('file_format', 'csv');
   formData.append('branch', branch);
   formData.append('update_translations', 'true');
-  log('Starting to upload:', locale, '\n');
-  const {
-    id
-  } = await callPhrase(`uploads`, {
+
+  for (const [locale, index] of Object.entries(localeMapping)) {
+    formData.append(`locale_mapping[${locale}]`, index);
+  }
+
+  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');
+  const result = await callPhrase(`uploads`, {
     method: 'POST',
     body: formData
   });
-  log('Upload ID:', id, '\n');
-  log('Successfully Uploaded:', locale, '\n');
+  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');
+  }
+
   return {
-    uploadId: id
+    uploadId: result.id
   };
 }
-async function deleteUnusedKeys(uploadId, locale, branch) {
+async function deleteUnusedKeys(uploadId, branch) {
   const query = `unmentioned_in_upload:${uploadId}`;
   const {
     records_affected
@@ -132,7 +196,6 @@ async function deleteUnusedKeys(uploadId, locale, branch) {
     },
     body: JSON.stringify({
       branch,
-      locale_id: locale,
       q: query
     })
   });
@@ -168,7 +231,8 @@ async function pull({
 
   const allVocabTranslations = await loadAllTranslations({
     fallbacks: 'none',
-    includeNodeModules: false
+    includeNodeModules: false,
+    withTags: true
   }, config);
 
   for (const loadedTranslation of allVocabTranslations) {
@@ -186,6 +250,11 @@ async function pull({
       defaultValues[key] = { ...defaultValues[key],
         ...allPhraseTranslations[config.devLanguage][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`);
@@ -223,7 +292,8 @@ async function pull({
 }
 
 /**
- * Uploading to the Phrase API for each language. Adding a unique namespace to each key using file path they key came from
+ * 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,
@@ -231,7 +301,8 @@ async function push({
 }, config) {
   const allLanguageTranslations = await loadAllTranslations({
     fallbacks: 'none',
-    includeNodeModules: false
+    includeNodeModules: false,
+    withTags: true
   }, config);
   trace(`Pushing translations to branch ${branch}`);
   const allLanguages = config.languages.map(v => v.name);
@@ -251,23 +322,37 @@ async function push({
         phraseTranslations[language] = {};
       }
 
+      const {
+        metadata: {
+          tags: sharedTags = []
+        }
+      } = loadedTranslation;
+
       for (const localKey of Object.keys(localTranslations)) {
         const phraseKey = getUniqueKey(localKey, loadedTranslation.namespace);
-        phraseTranslations[language][phraseKey] = localTranslations[localKey];
+        const {
+          tags = [],
+          ...localTranslation
+        } = localTranslations[localKey];
+
+        if (language === config.devLanguage) {
+          localTranslation.tags = [...tags, ...sharedTags];
+        }
+
+        phraseTranslations[language][phraseKey] = localTranslation;
       }
     }
   }
 
-  for (const language of allLanguages) {
-    if (phraseTranslations[language]) {
-      const {
-        uploadId
-      } = await pushTranslationsByLocale(phraseTranslations[language], language, branch);
+  const {
+    uploadId
+  } = await pushTranslations(phraseTranslations, {
+    devLanguage: config.devLanguage,
+    branch
+  });
 
-      if (deleteUnusedKeys$1) {
-        await deleteUnusedKeys(uploadId, language, branch);
-      }
-    }
+  if (deleteUnusedKeys$1) {
+    await deleteUnusedKeys(uploadId, branch);
   }
 }
 

package/package.json

@@ -1,19 +1,23 @@
 {
   "name": "@vocab/phrase",
-  "version": "1.1.0",
+  "version": "1.2.0",
   "main": "dist/vocab-phrase.cjs.js",
   "module": "dist/vocab-phrase.esm.js",
   "author": "SEEK",
   "license": "MIT",
   "dependencies": {
-    "@vocab/core": "^1.0.0",
-    "@vocab/types": "^1.0.0",
+    "@vocab/core": "^1.2.0",
+    "@vocab/types": "^1.1.2",
     "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/node-fetch": "^2.5.7"
-  }
+  },
+  "files": [
+    "dist"
+  ]
 }

package/CHANGELOG.md

@@ -1,145 +0,0 @@
-# @vocab/phrase
-
-## 1.1.0
-
-### Minor Changes
-
-- [`66ed22c`](https://github.com/seek-oss/vocab/commit/66ed22cac6f89018d5fd69fd6f6408e090e1a382) [#93](https://github.com/seek-oss/vocab/pull/93) Thanks [@askoufis](https://github.com/askoufis)! - Add an optional `deleteUnusedKeys` flag to the `push` function. If set to `true`, unused keys will be deleted from Phrase after translations are pushed.
-
-  **EXAMPLE USAGE**:
-
-  ```js
-  import { push } from '@vocab/phrase';
-
-  const vocabConfig = {
-    devLanguage: 'en',
-    language: ['en', 'fr'],
-  };
-
-  await push({ branch: 'myBranch', deleteUnusedKeys: true }, vocabConfig);
-  ```
-
-### Patch Changes
-
-- [`159d559`](https://github.com/seek-oss/vocab/commit/159d559c87c66c3e91c707fb45a1f67ebec07b4d) [#91](https://github.com/seek-oss/vocab/pull/91) Thanks [@askoufis](https://github.com/askoufis)! - Improve error message when Phrase doesn't return any translations for the dev language
-
-## 1.0.1
-
-### Patch Changes
-
-- [`20eec77`](https://github.com/seek-oss/vocab/commit/20eec770705d05048ad8b32575cb92720b887f5b) [#76](https://github.com/seek-oss/vocab/pull/76) Thanks [@askoufis](https://github.com/askoufis)! - `vocab pull` no longer errors when phrase returns no translations for a configured language
-
-## 1.0.0
-
-### Major Changes
-
-- [`3031054`](https://github.com/seek-oss/vocab/commit/303105440851db6126f0606e1607745b27dd981c) [#51](https://github.com/seek-oss/vocab/pull/51) Thanks [@jahredhope](https://github.com/jahredhope)! - Release v1.0.0
-
-  Release Vocab as v1.0.0 to signify a stable API and support future [semver versioning](https://semver.org/) releases.
-
-  Vocab has seen a lot of iteration and changes since it was first published on 20 November 2020. We are now confident with the API and believe Vocab is ready for common use.
-
-### Patch Changes
-
-- Updated dependencies [[`0074382`](https://github.com/seek-oss/vocab/commit/007438273ef70f5d5ded45777933651ad8df36f6), [`3031054`](https://github.com/seek-oss/vocab/commit/303105440851db6126f0606e1607745b27dd981c)]:
-  - @vocab/core@1.0.0
-  - @vocab/types@1.0.0
-
-## 0.0.11
-
-### Patch Changes
-
-- Updated dependencies [[`5b1fdc0`](https://github.com/seek-oss/vocab/commit/5b1fdc019522b12e7ef94b2fec57b54a9310d41c)]:
-  - @vocab/core@0.0.11
-  - @vocab/types@0.0.9
-
-## 0.0.10
-
-### Patch Changes
-
-- Updated dependencies [[`7c96a14`](https://github.com/seek-oss/vocab/commit/7c96a142f602132d38c1df1a47a1f4657dc5c94c)]:
-  - @vocab/core@0.0.10
-
-## 0.0.9
-
-### Patch Changes
-
-- Updated dependencies [[`3034bd3`](https://github.com/seek-oss/vocab/commit/3034bd3de610a9d1f3bfbd8caefa27064dee2710), [`c110745`](https://github.com/seek-oss/vocab/commit/c110745b79df1a8ade6b1d8a49e798b04a7b95e1)]:
-  - @vocab/core@0.0.9
-
-## 0.0.8
-
-### Patch Changes
-
-- Updated dependencies [[`f2fca67`](https://github.com/seek-oss/vocab/commit/f2fca679c66ae65405a0aa24f0a0e472026aad0d)]:
-  - @vocab/core@0.0.8
-  - @vocab/types@0.0.8
-
-## 0.0.7
-
-### Patch Changes
-
-- [`283bcad`](https://github.com/seek-oss/vocab/commit/283bcada06e622ab14ed891743ed3f55cf09e245) [#33](https://github.com/seek-oss/vocab/pull/33) Thanks [@mattcompiles](https://github.com/mattcompiles)! - Move all vocab files to single directory with configurable suffix
-
-- Updated dependencies [[`283bcad`](https://github.com/seek-oss/vocab/commit/283bcada06e622ab14ed891743ed3f55cf09e245), [`ad0d240`](https://github.com/seek-oss/vocab/commit/ad0d2404545ded8e11621eae8f29467ff3352366), [`f3992ef`](https://github.com/seek-oss/vocab/commit/f3992efbf08939ebf853fac650a49cc46dc51dfb), [`f3992ef`](https://github.com/seek-oss/vocab/commit/f3992efbf08939ebf853fac650a49cc46dc51dfb)]:
-  - @vocab/core@0.0.7
-  - @vocab/types@0.0.7
-
-## 0.0.6
-
-### Patch Changes
-
-- [`80a46c0`](https://github.com/seek-oss/vocab/commit/80a46c01a55408675f5822c3618519f80136c3ab) [#27](https://github.com/seek-oss/vocab/pull/27) Thanks [@mattcompiles](https://github.com/mattcompiles)! - Add `ignore` config for ignoring files/folders from cli scripts
-
-* [`80a46c0`](https://github.com/seek-oss/vocab/commit/80a46c01a55408675f5822c3618519f80136c3ab) [#27](https://github.com/seek-oss/vocab/pull/27) Thanks [@mattcompiles](https://github.com/mattcompiles)! - Ignore node_modules from push, pull and compile scripts
-
-* Updated dependencies [[`80a46c0`](https://github.com/seek-oss/vocab/commit/80a46c01a55408675f5822c3618519f80136c3ab), [`80a46c0`](https://github.com/seek-oss/vocab/commit/80a46c01a55408675f5822c3618519f80136c3ab)]:
-  - @vocab/core@0.0.6
-  - @vocab/types@0.0.6
-
-## 0.0.5
-
-### Patch Changes
-
-- Updated dependencies [[`371ed16`](https://github.com/seek-oss/vocab/commit/371ed16a232a04dab13afa7e2b352dfb6724eea4), [`c222d68`](https://github.com/seek-oss/vocab/commit/c222d68a3c0c24723a338eccb959798881f6a118)]:
-  - @vocab/core@0.0.5
-
-## 0.0.4
-
-### Patch Changes
-
-- [`5f5c581`](https://github.com/seek-oss/vocab/commit/5f5c581a65bff28729ee19e1ec0bdea488a9d6c2) [#19](https://github.com/seek-oss/vocab/pull/19) Thanks [@jahredhope](https://github.com/jahredhope)! - Compile useable TypeScript importable files with `vocab compile`.
-
-  The new `vocab compile` step replaces `vocab generate-types` in creating a fully functional **translations.ts** file.
-
-  This allows vocab to be used **without the Webpack Plugin**, however use of the plugin is still heavily advised to ensure optimal loading of translation content on the web.
-
-  Support for unit testing is now better than ever! The newly created **translations.ts** means your unit test code will see the same code as available while rendering.
-
-  See the [documentation](https://github.com/seek-oss/vocab) for further usage details.
-
-* [`02f943c`](https://github.com/seek-oss/vocab/commit/02f943ca892913b41f9e4720a72400777cf14b3d) [#17](https://github.com/seek-oss/vocab/pull/17) Thanks [@jahredhope](https://github.com/jahredhope)! - Add additional debug traces
-
-* Updated dependencies [[`5f5c581`](https://github.com/seek-oss/vocab/commit/5f5c581a65bff28729ee19e1ec0bdea488a9d6c2), [`02f943c`](https://github.com/seek-oss/vocab/commit/02f943ca892913b41f9e4720a72400777cf14b3d)]:
-  - @vocab/core@0.0.4
-  - @vocab/types@0.0.5
-
-## 0.0.3
-
-### Patch Changes
-
-- [`08de30d`](https://github.com/seek-oss/vocab/commit/08de30d338c2a5ebdcf14da7c736dddf22e7ca9e) [#14](https://github.com/seek-oss/vocab/pull/14) Thanks [@mattcompiles](https://github.com/mattcompiles)! - Add ability to override files namespace with \$namespace
-
-* [`26b52f4`](https://github.com/seek-oss/vocab/commit/26b52f4878ded440841e08c858bdc9e685500c2a) [#16](https://github.com/seek-oss/vocab/pull/16) Thanks [@jahredhope](https://github.com/jahredhope)! - Enable debugging with DEBUG environment variable
-
-* Updated dependencies [[`08de30d`](https://github.com/seek-oss/vocab/commit/08de30d338c2a5ebdcf14da7c736dddf22e7ca9e), [`ed6cf40`](https://github.com/seek-oss/vocab/commit/ed6cf408973f2e9c4d07a71fcb52f40294ebaf65), [`26b52f4`](https://github.com/seek-oss/vocab/commit/26b52f4878ded440841e08c858bdc9e685500c2a), [`b5a5a05`](https://github.com/seek-oss/vocab/commit/b5a5a05a5bb87b48e6e9160af75f555728143ea2)]:
-  - @vocab/core@0.0.3
-  - @vocab/types@0.0.4
-
-## 0.0.2
-
-### Patch Changes
-
-- Updated dependencies [[`4710f34`](https://github.com/seek-oss/vocab/commit/4710f341f2827643e3eff69ef7e26d44ec6e8a2b), [`4710f34`](https://github.com/seek-oss/vocab/commit/4710f341f2827643e3eff69ef7e26d44ec6e8a2b)]:
-  - @vocab/types@0.0.3
-  - @vocab/core@0.0.2

package/src/file.ts

@@ -1,4 +0,0 @@
-import { promises as fs } from 'fs';
-
-export const mkdir = fs.mkdir;
-export const writeFile = fs.writeFile;

package/src/index.ts

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

package/src/logger.ts

@@ -1,9 +0,0 @@
-import chalk from 'chalk';
-import debug from 'debug';
-
-export const trace = debug(`vocab:phrase`);
-
-export const log = (...params: unknown[]) => {
-  // eslint-disable-next-line no-console
-  console.log(chalk.yellow('Vocab'), ...params);
-};

package/src/phrase-api.ts

@@ -1,181 +0,0 @@
-import FormData from 'form-data';
-import { TranslationsByKey } from './../../types/src/index';
-/* eslint-disable no-console */
-import type { TranslationsByLanguage } from '@vocab/types';
-import fetch from 'node-fetch';
-import { log, trace } from './logger';
-
-function _callPhrase(path: string, options: Parameters<typeof fetch>[1] = {}) {
-  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}`);
-    console.log(
-      `Rate Limit: ${response.headers.get(
-        'X-Rate-Limit-Remaining',
-      )} of ${response.headers.get(
-        'X-Rate-Limit-Limit',
-      )} remaining. (${response.headers.get(
-        'X-Rate-Limit-Reset',
-      )} seconds remaining})`,
-    );
-    trace('\nLink:', response.headers.get('Link'), '\n');
-    // Print All Headers:
-    // console.log(Array.from(r.headers.entries()));
-
-    try {
-      const result = await response.json();
-
-      trace(`Internal Result (Length: ${result.length})\n`);
-
-      if (
-        (!options.method || options.method === 'GET') &&
-        response.headers.get('Link')?.includes('rel=next')
-      ) {
-        const [, nextPageUrl] =
-          response.headers.get('Link')?.match(/<([^>]*)>; rel=next/) ?? [];
-
-        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)) as any;
-
-        return [...result, ...nextPageResult];
-      }
-
-      return result;
-    } catch (e) {
-      console.error('Unable to parse response as JSON', e);
-      return response.text();
-    }
-  });
-}
-
-export async function callPhrase<T = any>(
-  relativePath: string,
-  options: Parameters<typeof fetch>[1] = {},
-): Promise<T> {
-  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;
-    });
-}
-
-export async function pullAllTranslations(
-  branch: string,
-): Promise<TranslationsByLanguage> {
-  const phraseResult = await callPhrase<
-    Array<{
-      key: { name: string };
-      locale: { code: string };
-      content: string;
-    }>
-  >(`translations?branch=${branch}&per_page=100`);
-
-  const translations: TranslationsByLanguage = {};
-
-  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;
-}
-
-export async function pushTranslationsByLocale(
-  contents: TranslationsByKey,
-  locale: string,
-  branch: string,
-) {
-  const formData = new FormData();
-  const fileContents = Buffer.from(JSON.stringify(contents));
-  formData.append('file', fileContents, {
-    contentType: 'application/json',
-    filename: `${locale}.json`,
-  });
-
-  formData.append('file_format', 'json');
-  formData.append('locale_id', locale);
-  formData.append('branch', branch);
-  formData.append('update_translations', 'true');
-
-  log('Starting to upload:', locale, '\n');
-
-  const { id } = await callPhrase<{ id: string }>(`uploads`, {
-    method: 'POST',
-    body: formData,
-  });
-  log('Upload ID:', id, '\n');
-  log('Successfully Uploaded:', locale, '\n');
-
-  return { uploadId: id };
-}
-
-export async function deleteUnusedKeys(
-  uploadId: string,
-  locale: string,
-  branch: string,
-) {
-  const query = `unmentioned_in_upload:${uploadId}`;
-  const { records_affected } = await callPhrase<{ records_affected: number }>(
-    'keys',
-    {
-      method: 'DELETE',
-      headers: {
-        'Content-Type': 'application/json',
-      },
-      body: JSON.stringify({ branch, locale_id: locale, q: query }),
-    },
-  );
-
-  log(
-    'Successfully deleted',
-    records_affected,
-    'unused keys from branch',
-    branch,
-  );
-}
-
-export async function ensureBranch(branch: string) {
-  await callPhrase(`branches`, {
-    method: 'POST',
-    headers: {
-      'Content-Type': 'application/json',
-    },
-    body: JSON.stringify({ name: branch }),
-  });
-
-  log('Created branch:', branch);
-}