@vocab/phrase 0.0.0-phrase-pull-dev-language-202281412540

package/CHANGELOG.md

@@ -0,0 +1,128 @@
+# @vocab/phrase
+
+## 0.0.0-phrase-pull-dev-language-202281412540
+
+### Patch Changes
+
+- [`ac206c8`](https://github.com/seek-oss/vocab/commit/ac206c8ba997551d960f0b72474568c1850f9561) [#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/dist/declarations/src/file.d.ts

@@ -0,0 +1,4 @@
+/// <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/index.d.ts

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

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

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

@@ -0,0 +1,7 @@
+import { TranslationsByKey } from './../../types/src/index';
+import type { TranslationsByLanguage } from '@vocab/types';
+import fetch from 'node-fetch';
+export declare function callPhrase(relativePath: string, options?: Parameters<typeof fetch>[1]): Promise<any>;
+export declare function pullAllTranslations(branch: string): Promise<TranslationsByLanguage>;
+export declare function pushTranslationsByLocale(contents: TranslationsByKey, locale: string, branch: string): Promise<void>;
+export declare function ensureBranch(branch: string): Promise<void>;

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

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

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

@@ -0,0 +1,9 @@
+import { UserConfig } from '@vocab/types';
+interface PushOptions {
+    branch: string;
+}
+/**
+ * Uploading to the Phrase API for each language. Adding a unique namespace to each key using file path they key came from
+ */
+export declare function push({ branch }: PushOptions, config: UserConfig): Promise<void>;
+export {};

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

@@ -0,0 +1 @@
+export * from "./declarations/src/index";

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

@@ -0,0 +1,261 @@
+'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');
+
+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 _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}`);
+    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})`);
+    console.log('\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();
+      console.log(`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('Cant parse next page URL');
+        }
+
+        console.log('Results recieved 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 pushTranslationsByLocale(contents, locale, branch) {
+  const formData = new FormData__default['default']();
+  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');
+  trace('Starting to upload:', locale);
+  await callPhrase(`uploads`, {
+    method: 'POST',
+    body: formData
+  });
+  log('Successfully Uploaded:', locale, '\n');
+}
+async function ensureBranch(branch) {
+  await callPhrase(`branches`, {
+    method: 'POST',
+    headers: {
+      'Content-Type': 'application/json'
+    },
+    body: JSON.stringify({
+      name: branch
+    })
+  });
+  trace('Created branch:', branch);
+}
+
+async function pull({
+  branch = 'local-development'
+}, 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);
+  const phraseLanguagesWithTranslations = phraseLanguages.filter(language => {
+    const phraseTranslationsForLanguage = allPhraseTranslations[language];
+    return Object.keys(phraseTranslationsForLanguage).length > 0;
+  });
+  trace(`Found Phrase translations for languages ${phraseLanguagesWithTranslations.join(', ')}`);
+
+  if (!phraseLanguagesWithTranslations.includes(config.devLanguage)) {
+    throw new Error(`Phrase did not return any translations for dev language "${config.devLanguage}".\nEnsure you have configured your Phrase project for your dev language, and have pushed your translations.`);
+  }
+
+  const allVocabTranslations = await core.loadAllTranslations({
+    fallbacks: 'none',
+    includeNodeModules: false
+  }, 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) {
+      defaultValues[key] = { ...defaultValues[key],
+        ...allPhraseTranslations[config.devLanguage][core.getUniqueKey(key, loadedTranslation.namespace)]
+      };
+    }
+
+    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 _phraseAltTranslation;
+
+          const phraseKey = 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}.`);
+            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`);
+      }
+    }
+  }
+}
+
+/**
+ * Uploading to the Phrase API for each language. Adding a unique namespace to each key using file path they key came from
+ */
+async function push({
+  branch
+}, config) {
+  const allLanguageTranslations = await core.loadAllTranslations({
+    fallbacks: 'none',
+    includeNodeModules: false
+  }, 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] = {};
+      }
+
+      for (const localKey of Object.keys(localTranslations)) {
+        const phraseKey = core.getUniqueKey(localKey, loadedTranslation.namespace);
+        phraseTranslations[language][phraseKey] = localTranslations[localKey];
+      }
+    }
+  }
+
+  for (const language of allLanguages) {
+    if (phraseTranslations[language]) {
+      await pushTranslationsByLocale(phraseTranslations[language], language, 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");
+}