Handles unauth errors from Streamline

Author: cbrwizard

.npmignore

@@ -0,0 +1,26 @@
+.idea
+
+# dependencies
+/node_modules
+
+
+# misc
+.DS_Store
+
+.env
+
+tmp
+*.log*
+
+.eslintcache
+
+.babelrc
+.editorconfig
+.eslintignore
+.eslintrc.js
+.prettierrc.js
+rollup.config.js
+tsconfig.json
+
+docs/
+src/

README.md

@@ -0,0 +1,27 @@
+# Universal NPM package for Streamline icons and illustrations
+
+This is a small library which downloads Streamline assets you have access to into your local folder so that they can be used in your Javascript project.
+
+## How to install
+
+`yarn add XXX`
+
+## How to use
+
+1. Ensure that you have an active Streamline icons or illustrations subscription.
+2. In your project folder create a special `streamlinehq.json` settings file. Fill it with two keys:
+    - `families`: an array of strings with names of Streamline icons or illustrations families you want to include in your project.
+    - `secret`: XXX
+    
+Example:
+```json
+{
+  "families": ["streamline-regular", "streamline-light"],
+  "secret": "MY.AUTHTOKEN"
+}
+```
+3. Install your packages, eg with `yarn`
+
+The package will run a script during installation which will fetch requested icons in a form of SVG files and put them in the package's `images` folder. After this you will be able to import those images as usual in your project.
+
+If you have any questions please open an issue.

index.js

@@ -13,9 +13,9 @@ async function fetchFamilies(secret, families) {
       // https
       http
         .get(
-          // TODO: change for the real endpoint when it is ready
+          // TODO: change for the real endpoint when package is ready
           // `https://api.staging.streamlineicons.com/v3/icons/${family}`,
-          `http://localhost:8080/v3/icons/${family}`,
+          `http://localhost:8080/v3/icons/${family}?withSVG=true`,
           {
             headers: {
               Authorization: `Bearer ${secret}`,
@@ -31,7 +31,7 @@ async function fetchFamilies(secret, families) {
 
             // The whole response has been received. Print out the result.
             resp.on('end', () => {
-              resolve(JSON.parse(data))
+              resolve({ ...JSON.parse(data), familyName: family, statusCode: resp.statusCode })
             })
           }
         )
@@ -69,11 +69,22 @@ async function installStreamlineAssets() {
     const fetchedFamiliesResponses = await fetchFamilies(streamlineConfiguration.secret, streamlineConfiguration.families);
 
     fetchedFamiliesResponses.forEach((familyResponse) => {
-      familyResponse.data.forEach(async (icon) => {
-        const folderPath = `${__dirname}/images/${icon.family.slug}`
-        await mkdir(folderPath, {recursive: true})
-        await writeFile(`${folderPath}/${icon.slug}.svg`, icon.svg)
-      })
+      if (familyResponse.success) {
+        familyResponse.data.forEach(async (icon) => {
+          if (!icon.svg) {
+            throw new Error(`No SVG data is present, please report an issue to Streamline team about icon ${icon.slug} of family ${icon.family.slug}`)
+          }
+          const folderPath = `${__dirname}/images/${icon.family.slug}`
+          await mkdir(folderPath, {recursive: true})
+          await writeFile(`${folderPath}/${icon.slug}.svg`, icon.svg)
+        })
+      } else {
+        let errorMessage = `Got error "${familyResponse.error}" for family ${familyResponse.familyName}.`
+        if (familyResponse.statusCode === 401) {
+          errorMessage += ` Error code is 401 which means it's most likely related to the auth token which was provided. Please double check its value by following the instructions in the project's README file.`
+        }
+        throw new Error(errorMessage)
+      }
     })
 
     console.debug("Finished installation");