@kununu/phraseapp-cli 3.1.0-beta.1 → 3.1.0-beta.3

package/README.md

@@ -1,59 +1,58 @@
 # phraseapp-cli
-> phraseapp-cli for https://phraseapp.com/
+>
+> phraseapp-cli for <https://phraseapp.com/>
 
 ## Installation
 
+### Add `@kununu/phraseapp-cli` to your project
+
+```bash
+npm install @kununu/phraseapp-cli --save
+```
+
+### Add `update-translations` to your project
+
 Add to ```package.json```
+
 ```json
-"phraseapp-cli": "kununu/phraseapp-cli"
-```
-```sh
-$ npm i
-```
-```sh
-$ npm link
+"update-translations": "node ./node_modules/@kununu/phraseapp-cli/index.js",
 ```
+
+### Add env vars
+
+Make sure PHRASEAPP_PROJECT_ID and PHRASEAPP_ACCESS_TOKEN are properly configured.
+
 ## Configuration file
 
-You have to use the ```.phraseapp.json``` to store repeating command line arguments like [phraseapp-config]
+You have to add the ```.phraseapp.json``` file
 
 **For example**:
+
 ```json
 {
-  "access_token": "YOUR_ACCESS_TOKEN",
   "project_id": "YOUR_PROJECT_ID",
   "path": "YOUR_TRANSLATIONS_PATH",
-  "locales":[
+  "locales": [
     {
-      "locale_id": "pl_PL",
-      "tags":[
+      "locale_id": "de_DE",
+      "tags": [
         "TAG1",
         "TAG2",
         "TAG3"
       ]
     },
     {
-      "locale_id": "en_US"
-    }
+      "locale_id": "de_AT",
+      "tags": [
+        (...)
+      ],
+      "fallback_locale_id": "de_DE"
+    },
+    (...)
   ]
 }
-
-  ```
-## Config parameters
- - locale_id (**required**) - for example **pl_PL**
- - tags (*optional array*) - project tag
-## Usage
-
-```js
-phraseapp-cli
 ```
 
-
 ## License
 
 Apache-2.0 © [kununu](https://kununu.com)
-
-
-[npm-image]: https://badge.fury.io/js/kununu.svg
-[npm-url]: https://npmjs.org/package/kununu
-[phraseapp-config]: https://phraseapp.com/docs/developers/cli/configuration/

package/index.js

@@ -36,11 +36,16 @@ function loadConfig() {
   try {
     const phrase = JSON.parse(fs.readFileSync(configPath));
 
-    // override accesstoken with env var, if available
+    // override access token with env var, if available
     if (process.env.PHRASEAPP_ACCESS_TOKEN) {
       phrase.access_token = process.env.PHRASEAPP_ACCESS_TOKEN;
     }
 
+    // override project id with env var, if available
+    if (process.env.PHRASEAPP_PROJECT_ID) {
+      phrase.project_id = process.env.PHRASEAPP_PROJECT_ID;
+    }
+
     if (!phrase.locales) {
       errors.push(
         'Error: please provide locales in config file ( for example:  locales: "pl_PL" ).',
@@ -90,14 +95,13 @@ const getFilePath = (path, filePrefix, localeId) =>
   `${path}${getFileName(filePrefix, localeId)}`;
 
 function getPhraseAppDownloadUrl(
-  accessToken,
   projectId,
   localeId,
   tags,
   fallbackLocaleId,
   branch,
 ) {
-  return `https://${accessToken}@api.phraseapp.com/api/v2/projects/${projectId}/locales/${localeId}/download?${getPhraseAppQueryParams(tags, fallbackLocaleId, branch)}`;
+  return `https://api.phraseapp.com/api/v2/projects/${projectId}/locales/${localeId}/download?${getPhraseAppQueryParams(tags, fallbackLocaleId, branch)}`;
 }
 
 function downloadLocaleFile(phrase, locale) {
@@ -120,7 +124,6 @@ function downloadLocaleFile(phrase, locale) {
 
   return new Promise((resolve, reject) => {
     const url = getPhraseAppDownloadUrl(
-      accessToken,
       projectId,
       localeId,
       tags,
@@ -128,27 +131,39 @@ function downloadLocaleFile(phrase, locale) {
       branch,
     );
 
-    fetch(url, (error, response, body) => {
-      if (!error && response.statusCode === 200) {
-        fs.writeFileSync(filepath, body);
+    const headers = new Headers({
+      Authorization: `Basic ${btoa(accessToken)}`,
+    });
+
+    fetch(url, {headers})
+      .then(response => {
+        if (!response.ok) {
+          throw new Error(response);
+        }
+        return response.json();
+      })
+      .then(data => {
+        // Handle the JSON response
+        fs.writeFileSync(filepath, JSON.stringify(data));
         console.info(
           `Success: locale file ${getFileName(filePrefix, localeId)} was updated`
             .green.bold,
         );
         return resolve();
-      }
-
-      if (response.statusCode === 401) {
-        console.error('Error: Please check your access_token'.red.bold);
-      } else {
-        console.error(
-          `Error: locale file ${getFileName(filePrefix, localeId)}. Message: ${JSON.parse(body).message}`
-            .red,
-        );
-      }
-
-      return reject(response);
-    });
+      })
+      .catch(error => {
+        if (error.status === 401) {
+          console.error('Error: Please check your access_token'.red.bold);
+        } else {
+          // Handle any errors
+          console.error(
+            `Error: locale file ${getFileName(filePrefix, localeId)}. Message: ${error.json()}`
+              .red,
+          );
+        }
+
+        return reject();
+      });
   });
 }
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@kununu/phraseapp-cli",
-  "version": "3.1.0-beta.1",
+  "version": "3.1.0-beta.3",
   "description": "",
   "main": "index.js",
   "author": "kununu",
@@ -13,7 +13,6 @@
     "dotenv": "16.4.5"
   },
   "devDependencies": {
-    "@babel/eslint-plugin": "7.23.5",
     "@kununu/eslint-config": "5.0.1"
   }
 }