@vocab/phrase 1.0.0 → 1.1.0

package/dist/vocab-phrase.esm.js

@@ -32,14 +32,14 @@ function _callPhrase(path, options = {}) {
   }).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:
+    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();
-      console.log(`Internal Result (Length: ${result.length})\n`);
+      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;
@@ -47,10 +47,10 @@ function _callPhrase(path, options = {}) {
         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');
+          throw new Error("Can't parse next page URL");
         }
 
-        console.log('Results recieved with next page: ', nextPageUrl);
+        console.log('Results received with next page: ', nextPageUrl);
         const nextPageResult = await _callPhrase(nextPageUrl, options);
         return [...result, ...nextPageResult];
       }
@@ -71,7 +71,6 @@ async function callPhrase(relativePath, options = {}) {
   }
 
   return _callPhrase(`https://api.phrase.com/v2/projects/${projectId}/${relativePath}`, options).then(result => {
-    // console.log('Result:', result);
     if (Array.isArray(result)) {
       console.log('Result length:', result.length);
     }
@@ -109,12 +108,35 @@ async function pushTranslationsByLocale(contents, locale, branch) {
   formData.append('locale_id', locale);
   formData.append('branch', branch);
   formData.append('update_translations', 'true');
-  trace('Starting to upload:', locale);
-  await callPhrase(`uploads`, {
+  log('Starting to upload:', locale, '\n');
+  const {
+    id
+  } = await callPhrase(`uploads`, {
     method: 'POST',
     body: formData
   });
+  log('Upload ID:', id, '\n');
   log('Successfully Uploaded:', locale, '\n');
+  return {
+    uploadId: id
+  };
+}
+async function deleteUnusedKeys(uploadId, locale, branch) {
+  const query = `unmentioned_in_upload:${uploadId}`;
+  const {
+    records_affected
+  } = await callPhrase('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);
 }
 async function ensureBranch(branch) {
   await callPhrase(`branches`, {
@@ -126,7 +148,7 @@ async function ensureBranch(branch) {
       name: branch
     })
   });
-  trace('Created branch:', branch);
+  log('Created branch:', branch);
 }
 
 async function pull({
@@ -137,6 +159,13 @@ async function pull({
   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
@@ -162,31 +191,33 @@ async function pull({
     await writeFile(loadedTranslation.filePath, `${JSON.stringify(defaultValues, null, 2)}\n`);
 
     for (const alternativeLanguage of alternativeLanguages) {
-      const altTranslations = { ...loadedTranslation.languages[alternativeLanguage]
-      };
-      const phraseAltTranslations = allPhraseTranslations[alternativeLanguage];
+      if (alternativeLanguage in allPhraseTranslations) {
+        const altTranslations = { ...loadedTranslation.languages[alternativeLanguage]
+        };
+        const phraseAltTranslations = allPhraseTranslations[alternativeLanguage];
+
+        for (const key of localKeys) {
+          var _phraseAltTranslation;
 
-      for (const key of localKeys) {
-        var _phraseAltTranslation;
+          const phraseKey = getUniqueKey(key, loadedTranslation.namespace);
+          const phraseTranslationMessage = (_phraseAltTranslation = phraseAltTranslations[phraseKey]) === null || _phraseAltTranslation === void 0 ? void 0 : _phraseAltTranslation.message;
 
-        const phraseKey = 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;
+          }
 
-        if (!phraseTranslationMessage) {
-          trace(`Missing translation. No translation for key ${key} in phrase as ${phraseKey} in language ${alternativeLanguage}.`);
-          continue;
+          altTranslations[key] = { ...altTranslations[key],
+            message: phraseTranslationMessage
+          };
         }
 
-        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`);
       }
-
-      const altTranslationFilePath = getAltLanguageFilePath(loadedTranslation.filePath, alternativeLanguage);
-      await mkdir(path.dirname(altTranslationFilePath), {
-        recursive: true
-      });
-      await writeFile(altTranslationFilePath, `${JSON.stringify(altTranslations, null, 2)}\n`);
     }
   }
 }
@@ -195,7 +226,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
  */
 async function push({
-  branch
+  branch,
+  deleteUnusedKeys: deleteUnusedKeys$1
 }, config) {
   const allLanguageTranslations = await loadAllTranslations({
     fallbacks: 'none',
@@ -228,7 +260,13 @@ async function push({
 
   for (const language of allLanguages) {
     if (phraseTranslations[language]) {
-      await pushTranslationsByLocale(phraseTranslations[language], language, branch);
+      const {
+        uploadId
+      } = await pushTranslationsByLocale(phraseTranslations[language], language, branch);
+
+      if (deleteUnusedKeys$1) {
+        await deleteUnusedKeys(uploadId, language, branch);
+      }
     }
   }
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vocab/phrase",
-  "version": "1.0.0",
+  "version": "1.1.0",
   "main": "dist/vocab-phrase.cjs.js",
   "module": "dist/vocab-phrase.esm.js",
   "author": "SEEK",

package/src/phrase-api.ts

@@ -31,14 +31,14 @@ function _callPhrase(path: string, options: Parameters<typeof fetch>[1] = {}) {
         'X-Rate-Limit-Reset',
       )} seconds remaining})`,
     );
-    console.log('\nLink:', response.headers.get('Link'), '\n');
+    trace('\nLink:', response.headers.get('Link'), '\n');
     // Print All Headers:
     // console.log(Array.from(r.headers.entries()));
 
     try {
       const result = await response.json();
 
-      console.log(`Internal Result (Length: ${result.length})\n`);
+      trace(`Internal Result (Length: ${result.length})\n`);
 
       if (
         (!options.method || options.method === 'GET') &&
@@ -48,10 +48,10 @@ function _callPhrase(path: string, options: Parameters<typeof fetch>[1] = {}) {
           response.headers.get('Link')?.match(/<([^>]*)>; rel=next/) ?? [];
 
         if (!nextPageUrl) {
-          throw new Error('Cant parse next page URL');
+          throw new Error("Can't parse next page URL");
         }
 
-        console.log('Results recieved with next page: ', nextPageUrl);
+        console.log('Results received with next page: ', nextPageUrl);
 
         const nextPageResult = (await _callPhrase(nextPageUrl, options)) as any;
 
@@ -66,10 +66,10 @@ function _callPhrase(path: string, options: Parameters<typeof fetch>[1] = {}) {
   });
 }
 
-export async function callPhrase(
+export async function callPhrase<T = any>(
   relativePath: string,
   options: Parameters<typeof fetch>[1] = {},
-) {
+): Promise<T> {
   const projectId = process.env.PHRASE_PROJECT_ID;
 
   if (!projectId) {
@@ -80,7 +80,6 @@ export async function callPhrase(
     options,
   )
     .then((result) => {
-      // console.log('Result:', result);
       if (Array.isArray(result)) {
         console.log('Result length:', result.length);
       }
@@ -95,18 +94,23 @@ export async function callPhrase(
 export async function pullAllTranslations(
   branch: string,
 ): Promise<TranslationsByLanguage> {
-  const phraseResult: Array<{
-    key: { name: string };
-    locale: { code: string };
-    content: string;
-  }> = await callPhrase(`translations?branch=${branch}&per_page=100`);
+  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;
 }
 
@@ -127,13 +131,41 @@ export async function pushTranslationsByLocale(
   formData.append('branch', branch);
   formData.append('update_translations', 'true');
 
-  trace('Starting to upload:', locale);
+  log('Starting to upload:', locale, '\n');
 
-  await callPhrase(`uploads`, {
+  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) {
@@ -144,5 +176,6 @@ export async function ensureBranch(branch: string) {
     },
     body: JSON.stringify({ name: branch }),
   });
-  trace('Created branch:', branch);
+
+  log('Created branch:', branch);
 }

package/src/pull-translations.test.ts

@@ -2,6 +2,7 @@ import path from 'path';
 import { pull } from './pull-translations';
 import { pullAllTranslations } from './phrase-api';
 import { writeFile } from './file';
+import { GeneratedLanguageTarget, LanguageTarget } from '@vocab/types';
 
 jest.mock('./file', () => ({
   writeFile: jest.fn(() => Promise.resolve),
@@ -13,68 +14,201 @@ jest.mock('./phrase-api', () => ({
   pullAllTranslations: jest.fn(() => Promise.resolve({ en: {}, fr: {} })),
 }));
 
-function runPhrase() {
+const devLanguage = 'en';
+
+function runPhrase(options: {
+  languages: LanguageTarget[];
+  generatedLanguages: GeneratedLanguageTarget[];
+}) {
   return pull(
     { branch: 'tester' },
     {
-      devLanguage: 'en',
-      languages: [{ name: 'en' }, { name: 'fr' }],
+      ...options,
+      devLanguage,
       projectRoot: path.resolve(__dirname, '..', '..', '..', 'fixtures/phrase'),
     },
   );
 }
 
-describe('pull', () => {
-  beforeEach(() => {
-    (pullAllTranslations as jest.Mock).mockClear();
-    (writeFile as jest.Mock).mockClear();
-  });
-  it('should resolve', async () => {
-    await expect(runPhrase()).resolves.toBeUndefined();
+describe('pull translations', () => {
+  describe('when pulling translations for languages that already have translations', () => {
+    beforeEach(() => {
+      jest.mocked(pullAllTranslations).mockClear();
+      jest.mocked(writeFile).mockClear();
+      jest.mocked(pullAllTranslations).mockImplementation(() =>
+        Promise.resolve({
+          en: {
+            'hello.mytranslations': {
+              message: 'Hi there',
+            },
+          },
+          fr: {
+            'hello.mytranslations': {
+              message: 'merci',
+            },
+          },
+        }),
+      );
+    });
 
-    expect(writeFile as jest.Mock).toHaveBeenCalledTimes(2);
-  });
-  it('should update keys', async () => {
-    (pullAllTranslations as jest.Mock).mockImplementation(() =>
-      Promise.resolve({
-        en: {
-          'hello.mytranslations': {
-            message: 'Hi there',
+    const options = {
+      languages: [{ name: 'en' }, { name: 'fr' }],
+      generatedLanguages: [
+        {
+          name: 'generatedLanguage',
+          extends: 'en',
+          generator: {
+            transformMessage: (message: string) => `[${message}]`,
           },
         },
-        fr: {
-          'hello.mytranslations': {
-            message: 'merci',
+      ],
+    };
+
+    it('should resolve', async () => {
+      await expect(runPhrase(options)).resolves.toBeUndefined();
+
+      expect(jest.mocked(writeFile)).toHaveBeenCalledTimes(2);
+    });
+
+    it('should update keys', async () => {
+      await expect(runPhrase(options)).resolves.toBeUndefined();
+
+      expect(
+        jest
+          .mocked(writeFile)
+          .mock.calls.map(([_filePath, contents]) =>
+            JSON.parse(contents as string),
+          ),
+      ).toMatchInlineSnapshot(`
+        [
+          {
+            "hello": {
+              "message": "Hi there",
+            },
+            "world": {
+              "message": "world",
+            },
           },
-        },
-      }),
-    );
-
-    await expect(runPhrase()).resolves.toBeUndefined();
-
-    expect(
-      (writeFile as jest.Mock).mock.calls.map(
-        ([_filePath, contents]: [string, string]) => JSON.parse(contents),
-      ),
-    ).toMatchInlineSnapshot(`
-      Array [
-        Object {
-          "hello": Object {
-            "message": "Hi there",
+          {
+            "hello": {
+              "message": "merci",
+            },
+            "world": {
+              "message": "monde",
+            },
+          },
+        ]
+      `);
+    });
+  });
+
+  describe('when pulling translations and some languages do not have any translations', () => {
+    beforeEach(() => {
+      jest.mocked(pullAllTranslations).mockClear();
+      jest.mocked(writeFile).mockClear();
+      jest.mocked(pullAllTranslations).mockImplementation(() =>
+        Promise.resolve({
+          en: {
+            'hello.mytranslations': {
+              message: 'Hi there',
+            },
           },
-          "world": Object {
-            "message": "world",
+          fr: {
+            'hello.mytranslations': {
+              message: 'merci',
+            },
+          },
+        }),
+      );
+    });
+
+    const options = {
+      languages: [{ name: 'en' }, { name: 'fr' }, { name: 'ja' }],
+      generatedLanguages: [
+        {
+          name: 'generatedLanguage',
+          extends: 'en',
+          generator: {
+            transformMessage: (message: string) => `[${message}]`,
           },
         },
-        Object {
-          "hello": Object {
-            "message": "merci",
+      ],
+    };
+
+    it('should resolve', async () => {
+      await expect(runPhrase(options)).resolves.toBeUndefined();
+
+      expect(jest.mocked(writeFile)).toHaveBeenCalledTimes(2);
+    });
+
+    it('should update keys', async () => {
+      await expect(runPhrase(options)).resolves.toBeUndefined();
+
+      expect(
+        jest
+          .mocked(writeFile)
+          .mock.calls.map(([_filePath, contents]) =>
+            JSON.parse(contents as string),
+          ),
+      ).toMatchInlineSnapshot(`
+        [
+          {
+            "hello": {
+              "message": "Hi there",
+            },
+            "world": {
+              "message": "world",
+            },
+          },
+          {
+            "hello": {
+              "message": "merci",
+            },
+            "world": {
+              "message": "monde",
+            },
           },
-          "world": Object {
-            "message": "monde",
+        ]
+      `);
+    });
+  });
+
+  describe('when pulling translations and the project has not configured translations for the dev language', () => {
+    beforeEach(() => {
+      jest.mocked(pullAllTranslations).mockClear();
+      jest.mocked(writeFile).mockClear();
+      jest.mocked(pullAllTranslations).mockImplementation(() =>
+        Promise.resolve({
+          fr: {
+            'hello.mytranslations': {
+              message: 'merci',
+            },
+          },
+        }),
+      );
+    });
+
+    const options = {
+      languages: [{ name: 'en' }, { name: 'fr' }],
+      generatedLanguages: [
+        {
+          name: 'generatedLanguage',
+          extends: 'en',
+          generator: {
+            transformMessage: (message: string) => `[${message}]`,
           },
         },
-      ]
-    `);
+      ],
+    };
+
+    it('should throw an error', async () => {
+      await expect(runPhrase(options)).rejects.toThrow(
+        new Error(
+          `Phrase did not return any translations for the configured development language "en".\nPlease ensure this language is present in your Phrase project's configuration.`,
+        ),
+      );
+
+      expect(jest.mocked(writeFile)).toHaveBeenCalledTimes(0);
+    });
   });
 });

package/src/pull-translations.ts

@@ -14,6 +14,7 @@ import { trace } from './logger';
 
 interface PullOptions {
   branch?: string;
+  deleteUnusedKeys?: boolean;
 }
 
 export async function pull(
@@ -30,6 +31,17 @@ export async function pull(
     } 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 },
     config,
@@ -59,41 +71,44 @@ export async function pull(
     );
 
     for (const alternativeLanguage of alternativeLanguages) {
-      const altTranslations = {
-        ...loadedTranslation.languages[alternativeLanguage],
-      };
-      const phraseAltTranslations = allPhraseTranslations[alternativeLanguage];
-
-      for (const key of localKeys) {
-        const phraseKey = getUniqueKey(key, loadedTranslation.namespace);
-        const phraseTranslationMessage =
-          phraseAltTranslations[phraseKey]?.message;
-
-        if (!phraseTranslationMessage) {
-          trace(
-            `Missing translation. No translation for key ${key} in phrase as ${phraseKey} in language ${alternativeLanguage}.`,
-          );
-          continue;
+      if (alternativeLanguage in allPhraseTranslations) {
+        const altTranslations = {
+          ...loadedTranslation.languages[alternativeLanguage],
+        };
+        const phraseAltTranslations =
+          allPhraseTranslations[alternativeLanguage];
+
+        for (const key of localKeys) {
+          const phraseKey = getUniqueKey(key, loadedTranslation.namespace);
+          const phraseTranslationMessage =
+            phraseAltTranslations[phraseKey]?.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,
+          };
         }
 
-        altTranslations[key] = {
-          ...altTranslations[key],
-          message: phraseTranslationMessage,
-        };
-      }
+        const altTranslationFilePath = getAltLanguageFilePath(
+          loadedTranslation.filePath,
+          alternativeLanguage,
+        );
 
-      const altTranslationFilePath = getAltLanguageFilePath(
-        loadedTranslation.filePath,
-        alternativeLanguage,
-      );
-
-      await mkdir(path.dirname(altTranslationFilePath), {
-        recursive: true,
-      });
-      await writeFile(
-        altTranslationFilePath,
-        `${JSON.stringify(altTranslations, null, 2)}\n`,
-      );
+        await mkdir(path.dirname(altTranslationFilePath), {
+          recursive: true,
+        });
+        await writeFile(
+          altTranslationFilePath,
+          `${JSON.stringify(altTranslations, null, 2)}\n`,
+        );
+      }
     }
   }
 }