@contentstack/cli-cm-export 1.1.0 → 1.2.0

package/src/lib/export/marketplace-apps.js

@@ -3,152 +3,151 @@
  * Copyright (c) 2019 Contentstack LLC
  * MIT Licensed
  */
-const _ = require('lodash')
+const _ = require('lodash');
 const path = require('path');
 const chalk = require('chalk');
 const mkdirp = require('mkdirp');
 const eachOf = require('async/eachOf');
-const { cliux, configHandler, HttpClient, NodeCrypto } = require('@contentstack/cli-utilities');
+const { cliux, HttpClient, NodeCrypto } = require('@contentstack/cli-utilities');
 
+const { formatError } = require('../util');
 let config = require('../../config/default');
 const { writeFile } = require('../util/helper');
 const { addlogs: log } = require('../util/log');
 let stack = require('../util/contentstack-management-sdk');
-const { getInstalledExtensions } = require('../util/marketplace-app-helper')
-
-let client
-let marketplaceAppConfig = config.modules.marketplace_apps;
-
-function exportMarketplaceApps() {
-  this.marketplaceAppPath = null
-  this.developerHuBaseUrl = null
-  this.start = async (credentialConfig) => {
-    config = credentialConfig;
-    client = stack.Client(config);
-    this.developerHuBaseUrl = await this.getDeveloperHubUrl()
-
-    if (!config.auth_token) {
-      cliux.print('WARNING!!! To export Marketplace apps, you must be logged in. Please check csdx auth:login --help to log in', { color: 'yellow' })
-      return Promise.resolve()
+const { getDeveloperHubUrl, getInstalledExtensions } = require('../util/marketplace-app-helper');
+
+module.exports = class ExportMarketplaceApps {
+  config;
+  marketplaceAppPath = null;
+  developerHubBaseUrl = null;
+  marketplaceAppConfig = config.modules.marketplace_apps;
+
+  constructor(credentialConfig) {
+    this.config = credentialConfig;
+  }
+
+  async start() {
+    this.developerHubBaseUrl = await getDeveloperHubUrl();
+
+    if (!this.config.auth_token) {
+      cliux.print(
+        'WARNING!!! To export Marketplace apps, you must be logged in. Please check csdx auth:login --help to log in',
+        { color: 'yellow' },
+      );
+      return Promise.resolve();
     }
 
-    log(credentialConfig, 'Starting marketplace app export', 'success');
+    log(this.config, 'Starting marketplace app export', 'success');
     this.marketplaceAppPath = path.resolve(
-      config.data, config.branchName || '',
-      marketplaceAppConfig.dirName
+      this.config.data,
+      this.config.branchName || '',
+      this.marketplaceAppConfig.dirName,
     );
     mkdirp.sync(this.marketplaceAppPath);
 
-    return this.exportInstalledExtensions()
+    return this.exportInstalledExtensions();
   }
 
-  this.exportInstalledExtensions = () => {
-    const self = this
+  exportInstalledExtensions = () => {
+    const self = this;
 
     return new Promise(async function (resolve, reject) {
-      getInstalledExtensions(config)
+      getInstalledExtensions(self.config)
         .then(async (items) => {
           const installedApps = _.map(
             _.filter(items, 'app_uid'),
-            ({ uid, title, app_uid, app_installation_uid, type }) => ({ title, uid, app_uid, app_installation_uid, type })
-          )
+            ({ uid, title, app_uid, app_installation_uid, type }) => ({
+              title,
+              uid,
+              app_uid,
+              app_installation_uid,
+              type,
+            }),
+          );
           const headers = {
-            authtoken: config.auth_token,
-            organization_uid: config.org_uid
-          }
+            authtoken: self.config.auth_token,
+            organization_uid: self.config.org_uid,
+          };
           const httpClient = new HttpClient().headers(headers);
-          const nodeCrypto = new NodeCrypto()
-          const developerHubApps = await httpClient.get(`${self.developerHuBaseUrl}/apps`)
-            .then(({ data: { data } }) => data)
-            .catch(err => {
-              console.log(err)
-            }) || []
-
-          eachOf(_.uniqBy(installedApps, 'app_uid'), (app, _key, cb) => {
-            log(config, `Exporting ${app.title} app and it's config.`, 'success')
-            const listOfIndexToBeUpdated = _.map(
-              installedApps,
-              ({ app_uid }, index) => (app_uid === app.app_uid ? index : undefined)
-            ).filter(val => val !== undefined)
-
-            httpClient.get(`${self.developerHuBaseUrl}/installations/${app.app_installation_uid}/installationData`)
-              .then(({ data: result }) => {
-                const { data, error } = result
-                const developerHubApp = _.find(developerHubApps, { uid: app.app_uid })
-
-                _.forEach(listOfIndexToBeUpdated, (index, i) => {
-                  if (developerHubApp) {
-                    installedApps[index]['visibility'] = developerHubApp.visibility
-                    installedApps[index]['manifest'] = _.pick(
-                      developerHubApp,
-                      ['name', 'description', 'icon', 'target_type', 'ui_location', 'webhook', 'oauth'] // NOTE keys can be passed to install new app in the developer hub
-                    )
-                  }
-
-                  if (_.has(data, 'configuration') || _.has(data, 'server_configuration')) {
-                    const { configuration, server_configuration } = data
-  
-                    if (!_.isEmpty(configuration)) {
-                      installedApps[index]['configuration'] = nodeCrypto.encrypt(configuration)
-                    }
-                    if (!_.isEmpty(server_configuration)) {
-                      installedApps[index]['server_configuration'] = nodeCrypto.encrypt(server_configuration)
+          const nodeCrypto = new NodeCrypto();
+          const developerHubApps =
+            (await httpClient
+              .get(`${self.developerHubBaseUrl}/apps`)
+              .then(({ data: { data } }) => data)
+              .catch((err) => {
+                console.log(err);
+              })) || [];
+
+          eachOf(
+            _.uniqBy(installedApps, 'app_uid'),
+            (app, _key, cb) => {
+              log(self.config, `Exporting ${app.title} app and it's config.`, 'success');
+              const listOfIndexToBeUpdated = _.map(installedApps, ({ app_uid }, index) =>
+                app_uid === app.app_uid ? index : undefined,
+              ).filter((val) => val !== undefined);
+
+              httpClient
+                .get(`${self.developerHubBaseUrl}/installations/${app.app_installation_uid}/installationData`)
+                .then(({ data: result }) => {
+                  const { data, error } = result;
+                  const developerHubApp = _.find(developerHubApps, { uid: app.app_uid });
+
+                  _.forEach(listOfIndexToBeUpdated, (index, i) => {
+                    if (developerHubApp) {
+                      installedApps[index]['visibility'] = developerHubApp.visibility;
+                      installedApps[index]['manifest'] = _.pick(
+                        developerHubApp,
+                        ['name', 'description', 'icon', 'target_type', 'ui_location', 'webhook', 'oauth'], // NOTE keys can be passed to install new app in the developer hub
+                      );
                     }
 
-                    if (i === 0) {
-                      log(config, `Exported ${app.title} app and it's config.`, 'success')
+                    if (_.has(data, 'configuration') || _.has(data, 'server_configuration')) {
+                      const { configuration, server_configuration } = data;
+
+                      if (!_.isEmpty(configuration)) {
+                        installedApps[index]['configuration'] = nodeCrypto.encrypt(configuration);
+                      }
+                      if (!_.isEmpty(server_configuration)) {
+                        installedApps[index]['server_configuration'] = nodeCrypto.encrypt(server_configuration);
+                      }
+
+                      if (i === 0) {
+                        log(self.config, `Exported ${app.title} app and it's config.`, 'success');
+                      }
+                    } else if (error) {
+                      console.log(error);
+                      if (i === 0) {
+                        log(self.config, `Error on exporting ${app.title} app and it's config.`, 'error');
+                      }
                     }
-                  } else if (error) {
-                    console.log(error)
-                    if (i === 0) {
-                      log(config, `Error on exporting ${app.title} app and it's config.`, 'error')
-                    }
-                  }
-                })
+                  });
 
-                cb()
-              })
-              .catch(err => {
-                console.log(err)
-                cb()
-              })
-          }, () => {
-            if (!_.isEmpty(installedApps)) {
-              writeFile(
-                path.join(self.marketplaceAppPath, marketplaceAppConfig.fileName),
-                installedApps
-              )
-
-              log(config, chalk.green('All the marketplace apps have been exported successfully'), 'success')
-            } else {
-              log(config, 'No marketplace apps found', 'success')
-            }
-
-            resolve()
-          })
-        }).catch(reject)
-    })
-  }
-
-  this.getDeveloperHubUrl = async () => {
-    const { cma, name } = configHandler.get('region') || {}
-    let developerHubBaseUrl = config.developerHubUrls[cma]
-
-    if (!developerHubBaseUrl) {
-      developerHubBaseUrl = await cliux.inquire({
-        type: 'input',
-        name: 'name',
-        validate: (url) => {
-          if (!url) return 'Developer-hub URL cant be empty.'
-
-          return true
-        },
-        message: `Enter the developer-hub base URL for the ${name} region - `,
-      })
-    }
-
-    return developerHubBaseUrl.startsWith('http') ? developerHubBaseUrl : `https://${developerHubBaseUrl}`
-  }
-}
-
-module.exports = new exportMarketplaceApps();
+                  cb();
+                })
+                .catch((err) => {
+                  addlogs(self.config, `Failed to export ${app.title} app config ${formatError(error)}`, 'error');
+                  console.log(err);
+                  cb();
+                });
+            },
+            () => {
+              if (!_.isEmpty(installedApps)) {
+                writeFile(path.join(self.marketplaceAppPath, self.marketplaceAppConfig.fileName), installedApps);
+
+                log(self.config, chalk.green('All the marketplace apps have been exported successfully'), 'success');
+              } else {
+                log(self.config, 'No marketplace apps found', 'success');
+              }
+
+              resolve();
+            },
+          );
+        })
+        .catch((error) => {
+          addlogs(self.config, `Failed to export marketplace-apps ${formatError(error)}`, 'error');
+          reject(error);
+        });
+    });
+  };
+};

package/src/lib/export/stack.js

@@ -4,19 +4,16 @@
  * MIT Licensed
  */
 
-var chalk = require('chalk');
-var mkdirp = require('mkdirp');
-var path = require('path');
-
-var app = require('../../app');
-var helper = require('../util/helper');
-var { addlogs } = require('../util/log');
-const stack = require('../util/contentstack-management-sdk');
+let path = require('path');
+let mkdirp = require('mkdirp');
 
+let helper = require('../util/helper');
+let { addlogs } = require('../util/log');
 let config = require('../../config/default');
+const stack = require('../util/contentstack-management-sdk');
 
-var stackConfig = config.modules.stack;
 let client;
+let stackConfig = config.modules.stack;
 
 function ExportStack() {
   this.requestOption = {
@@ -29,7 +26,7 @@ function ExportStack() {
 ExportStack.prototype.start = async function (credentialConfig) {
   config = credentialConfig;
   client = stack.Client(config);
-  const self = this
+  const self = this;
 
   // NOTE get org uid
   if (config.auth_token) {
@@ -37,11 +34,12 @@ ExportStack.prototype.start = async function (credentialConfig) {
       .stack({ api_key: config.source_stack, authtoken: config.auth_token })
       .fetch()
       .catch((error) => {
-        console.log(error)
-      })
+        console.log(error);
+      });
 
     if (stack && stack.org_uid) {
-      config.org_uid = stack.org_uid
+      config.org_uid = stack.org_uid;
+      config.sourceStackName = stack.name;
     }
   }
 
@@ -50,8 +48,8 @@ ExportStack.prototype.start = async function (credentialConfig) {
       limit: 100,
       skip: 0,
       include_count: true,
-    }
-    return self.getLocales(apiDetails)
+    };
+    return self.getLocales(apiDetails);
   } else if (config.preserveStackVersion) {
     addlogs(config, 'Exporting stack details', 'success');
     let stackFolderPath = path.resolve(config.data, stackConfig.dirName);
@@ -74,12 +72,12 @@ ExportStack.prototype.start = async function (credentialConfig) {
 };
 
 ExportStack.prototype.getLocales = function (apiDetails) {
-  let self = this
+  let self = this;
   return new Promise((resolve, reject) => {
     const result = client
       .stack({ api_key: config.source_stack, management_token: config.management_token })
       .locale()
-      .query(apiDetails)
+      .query(apiDetails);
 
     result
       .find()
@@ -90,11 +88,11 @@ ExportStack.prototype.getLocales = function (apiDetails) {
           }
         });
         apiDetails.skip += apiDetails.limit;
-        if (masterLocalObj) { return resolve(masterLocalObj); }
-        else if (apiDetails.skip <= response.count) {
-          return resolve(self.getLocales(apiDetails))
-        }
-        else {
+        if (masterLocalObj) {
+          return resolve(masterLocalObj);
+        } else if (apiDetails.skip <= response.count) {
+          return resolve(self.getLocales(apiDetails));
+        } else {
           return reject('Master locale not found');
         }
       })
@@ -102,6 +100,6 @@ ExportStack.prototype.getLocales = function (apiDetails) {
         return reject(error);
       });
   });
-}
+};
 
-module.exports = new ExportStack();
+module.exports = ExportStack;

package/src/lib/export/webhooks.js

@@ -4,72 +4,77 @@
  * MIT Licensed
  */
 
-const mkdirp = require('mkdirp');
 const path = require('path');
 const chalk = require('chalk');
+const mkdirp = require('mkdirp');
+const { merge } = require('lodash');
 
 const helper = require('../util/helper');
+const { formatError } = require('../util');
 const { addlogs } = require('../util/log');
-
-let config = require('../../config/default');
+const config = require('../../config/default');
 const stack = require('../util/contentstack-management-sdk');
-const webhooksConfig = config.modules.webhooks;
-let client;
 
 // Create folder for environments
 
-function ExportWebhooks() {
-  this.requestOptions = {
+module.exports = class ExportWebhooks {
+  config;
+  master = {};
+  webhooks = {};
+  requestOptions = {
     include_count: true,
     asc: 'updated_at',
   };
-  this.master = {};
-  this.webhooks = {};
-}
+  webhooksConfig = config.modules.webhooks;
+
+  constructor(credentialConfig) {
+    this.config = merge(config, credentialConfig);
+  }
 
-ExportWebhooks.prototype.start = function (credentialConfig) {
-  addlogs(config, 'Starting webhooks export', 'success');
-  this.master = {};
-  this.webhooks = {};
-  let self = this;
-  config = credentialConfig;
-  client = stack.Client(config);
-  const webhooksFolderPath = path.resolve(config.data, config.branchName || '', webhooksConfig.dirName);
-  mkdirp.sync(webhooksFolderPath);
-  return new Promise(function (resolve, reject) {
-    client
-      .stack({ api_key: config.source_stack, management_token: config.management_token })
-      .webhook()
-      .fetchAll(self.requestOptions)
-      .then((webhooks) => {
-        if (webhooks.items.length !== 0) {
-          for (var i = 0, total = webhooks.count; i < total; i++) {
-            const webUid = webhooks.items[i].uid;
-            self.master[webUid] = '';
-            self.webhooks[webUid] = webhooks.items[i];
-            delete self.webhooks[webUid].uid;
-            delete self.webhooks[webUid].SYS_ACL;
+  start() {
+    addlogs(this.config, 'Starting webhooks export', 'success');
+
+    const self = this;
+    const client = stack.Client(this.config);
+    const webhooksFolderPath = path.resolve(
+      this.config.data,
+      this.config.branchName || '',
+      self.webhooksConfig.dirName,
+    );
+    mkdirp.sync(webhooksFolderPath);
+    return new Promise((resolve, reject) => {
+      client
+        .stack({ api_key: self.config.source_stack, management_token: self.config.management_token })
+        .webhook()
+        .fetchAll(self.requestOptions)
+        .then((webhooks) => {
+          if (webhooks.items.length !== 0) {
+            for (let i = 0, total = webhooks.count; i < total; i++) {
+              const webUid = webhooks.items[i].uid;
+              self.master[webUid] = '';
+              self.webhooks[webUid] = webhooks.items[i];
+              delete self.webhooks[webUid].uid;
+              delete self.webhooks[webUid].SYS_ACL;
+            }
+            helper.writeFileSync(path.join(webhooksFolderPath, self.webhooksConfig.fileName), self.webhooks);
+            addlogs(self.config, chalk.green('All the webhooks have been exported successfully'), 'success');
+            return resolve();
+          }
+          addlogs(self.config, 'No webhooks found', 'success');
+          resolve();
+        })
+        .catch(function (error) {
+          if (error.statusCode === 401) {
+            addlogs(
+              self.config,
+              chalk.red('You are not allowed to export webhooks, Unless you provide email and password in config'),
+              'error',
+            );
+            return resolve();
           }
-          helper.writeFile(path.join(webhooksFolderPath, webhooksConfig.fileName), self.webhooks);
-          addlogs(config, chalk.green('All the webhooks have been exported successfully'), 'success');
-          return resolve();
-        }
-        addlogs(config, 'No webhooks found', 'success');
-        return resolve();
-      })
-      .catch(function (error) {
-        if (error.statusCode === 401) {
-          addlogs(
-            config,
-            chalk.red('You are not allowed to export webhooks, Unless you provide email and password in config'),
-            'error',
-          );
-          return resolve();
-        }
-        addlogs(config, error, 'error');
-        return reject();
-      });
-  });
+          addlogs(self.config, formatError(error), 'error');
+          reject('Failed export webhooks');
+        });
+    });
+  }
 };
-
-module.exports = new ExportWebhooks();