feat(assets|INS-500): NPM library must parse an assets folder and sync it with Frontify

Author: Sébastien Van Eyck

assets/level_1/top-app-menu.png

@@ -1,4 +1,4 @@
 'use strict';
 
 var main = require('./src/main');
-main.init('./patterns');
+main.init();

index.js

@@ -16,7 +16,7 @@ function readDir(path) {
     return fs.readdirSync(path);
   }
   catch(err) {
-    var error = "Error:" + err.message;
+    var error = err.message;
     Logger.error(error);
     return null;
   }
@@ -37,7 +37,7 @@ function checkIfDir(path, silent) {
     if (silent) {
       return false;
     }
-    var error = "Error: " + err.message;
+    var error = err.message;
     Logger.error(error);
     return false;
   }

src/files.service.js

@@ -0,0 +1,51 @@
+'use strict';
+
+var _ = require('lodash');
+
+var frontifyApi = require('@frontify/frontify-api');
+var frontifyPattern = require('@frontify/frontify-api/lib/core/patterns.js');
+var Logger = require('./logger.service');
+
+/**
+ * Synchronize remote Frontify patterns
+ * @param  {Object} access    Frontify API credentials
+ * @param  {Array}  files     Array of JSON files to sync
+ */
+function syncPatterns(access, files) {
+  frontifyApi.syncPatterns(access, files)
+    .then(function(data) {
+      Logger.success('Patterns have been synchronized to Frontify');
+    })
+    .catch(function(err) {
+        Logger.error(err);
+    });
+}
+
+/**
+ * Synchronize remote Frontify assets
+ * @param  {Object} access    Frontify API credentials
+ * @param  {Array}  files     Array of files to sync
+ * @param  {String} target    Destination directory in Frontify
+ * @param  {String} cwd       Current local working directory
+ */
+function syncAssets(access, files, target, cwd) {
+  if (_.isString(target)) {
+    assets.target = target;
+  }
+  if (_.isString(cwd)) {
+    assets.cwd = cwd;
+  }
+
+  frontifyApi.syncAssets(access, files)
+    .then(function(data) {
+      Logger.success('Assets have been synchronized to Frontify');
+    })
+    .catch(function(err) {
+        Logger.error(err);
+    });
+}
+
+module.exports = {
+  syncPatterns: syncPatterns,
+  syncAssets: syncAssets
+};

src/frontify.service.js

@@ -41,9 +41,11 @@ function log(type, message) {
       color = "green";
       break;
     default:
+      type = '';
       color = "white";
   }
-  console.log(colors[color](message));
+  type += ':';
+  console.log(colors[color](type.toUpperCase()), message);
 }
 
 module.exports = {

src/logger.service.js

@@ -3,27 +3,42 @@
 var fs = require('fs');
 var _ = require('lodash');
 
-var frontifyApi = require('@frontify/frontify-api');
-var frontifyPattern = require('@frontify/frontify-api/lib/core/patterns.js');
-
 var Patterns = require('./patterns.service');
 var Files = require('./files.service');
+var Frontify = require('./frontify.service');
 var Logger = require('./logger.service');
 
-function init(patternsFolder) {
+
+var access = {
+  access_token: "frontify_access_token",
+  project: "frontify_project_id"
+};
+var patternsDir = './patterns';
+var patternsJSONFiles = [
+  'tmp-frontify/**/*.json'
+];
+var assetsFiles = [
+  'assets/**/*.*'
+];
+
+/**
+ * Generate patterns JSON files, then sync them and sync assets
+ */
+function init() {
   try {
-    generatePatterns(patternsFolder);
+    generatePatterns(patternsDir);
   }
   catch(err) {
     Logger.error(err);
     return;
   }
-  synchronizePatterns();
+  Frontify.syncPatterns(access, patternsJSONFiles);
+  Frontify.syncAssets(access, assetsFiles);
 }
 
-
 /**
  * Generate JSON files for found patterns
+ * @param  {String} patternsFolder    Root directory of patterns files
  */
 function generatePatterns(patternsFolder) {
   walk(patternsFolder);
@@ -83,23 +98,6 @@ function walk(dir, currentPattern, startPattern) {
   });
 }
 
-/**
- * Synchronize remote Frontify project
- */
-function synchronizePatterns() {
-  var access = {
-    access_token: "frontify_access_token",
-    project: "frontify_project_id"
-  };
-  frontifyApi.syncPatterns(access, ['tmp-frontify/**/*.json'])
-    .then(function(data) {
-      Logger.success('Success: Patterns have been synchronized to Frontify');
-    })
-    .catch(function(err) {
-        Logger.error(err);
-    });
-}
-
 module.exports = {
   init: init
 };