@contentstack/cli-cm-export 1.2.1 → 1.2.3

package/README.md

@@ -38,7 +38,7 @@ $ npm install -g @contentstack/cli-cm-export
 $ csdx COMMAND
 running command...
 $ csdx (-v|--version|version)
-@contentstack/cli-cm-export/1.2.1 darwin-arm64 node-v18.11.0
+@contentstack/cli-cm-export/1.2.3 linux-x64 node-v16.18.1
 $ csdx --help [COMMAND]
 USAGE
   $ csdx COMMAND
@@ -68,6 +68,7 @@ OPTIONS
   -k, --stack-api-key=stack-api-key  API key of the source stack
   -m, --module=module                [optional] specific module name
   -t, --content-types=content-types  [optional] content type
+  -y, --yes                          [optional] Override marketplace apps related prompts
   --secured-assets                   [optional] use when assets are secured
 
 ALIASES

package/oclif.manifest.json

@@ -1 +1 @@
-{"version":"1.2.1","commands":{"cm:stacks:export":{"id":"cm:stacks:export","description":"Export content from a stack","usage":"cm:stacks:export [-c <value>] [-k <value>] [-d <value>] [-a <value>] [--module <value>] [--content-types <value>] [--branch <value>] [--secured-assets]","pluginName":"@contentstack/cli-cm-export","pluginType":"core","aliases":["cm:export"],"examples":["csdx cm:stacks:export --stack-api-key <stack_api_key> --data-dir <path/of/export/destination/dir>","csdx cm:stacks:export --config <path/to/config/dir>","csdx cm:stacks:export --alias <management_token_alias>","csdx cm:stacks:export --alias <management_token_alias> --data-dir <path/to/export/destination/dir>","csdx cm:stacks:export --alias <management_token_alias> --config <path/to/config/file>","csdx cm:stacks:export --module <single module name>","csdx cm:stacks:export --branch [optional] branch name"],"flags":{"config":{"name":"config","type":"option","char":"c","description":"[optional] path of the config"},"stack-uid":{"name":"stack-uid","type":"option","char":"s","description":"API key of the source stack","hidden":true},"stack-api-key":{"name":"stack-api-key","type":"option","char":"k","description":"API key of the source stack"},"data":{"name":"data","type":"option","description":"path or location to store the data","hidden":true},"data-dir":{"name":"data-dir","type":"option","char":"d","description":"path or location to store the data"},"alias":{"name":"alias","type":"option","char":"a","description":"alias of the management token"},"management-token-alias":{"name":"management-token-alias","type":"option","description":"alias of the management token","hidden":true},"auth-token":{"name":"auth-token","type":"boolean","char":"A","description":"to use auth token","hidden":true,"allowNo":false},"module":{"name":"module","type":"option","char":"m","description":"[optional] specific module name"},"content-types":{"name":"content-types","type":"option","char":"t","description":"[optional] content type"},"branch":{"name":"branch","type":"option","char":"B","description":"[optional] branch name"},"secured-assets":{"name":"secured-assets","type":"boolean","description":"[optional] use when assets are secured","allowNo":false}},"args":[]}}}
+{"version":"1.2.3","commands":{"cm:stacks:export":{"id":"cm:stacks:export","description":"Export content from a stack","usage":"cm:stacks:export [-c <value>] [-k <value>] [-d <value>] [-a <value>] [--module <value>] [--content-types <value>] [--branch <value>] [--secured-assets]","pluginName":"@contentstack/cli-cm-export","pluginType":"core","aliases":["cm:export"],"examples":["csdx cm:stacks:export --stack-api-key <stack_api_key> --data-dir <path/of/export/destination/dir>","csdx cm:stacks:export --config <path/to/config/dir>","csdx cm:stacks:export --alias <management_token_alias>","csdx cm:stacks:export --alias <management_token_alias> --data-dir <path/to/export/destination/dir>","csdx cm:stacks:export --alias <management_token_alias> --config <path/to/config/file>","csdx cm:stacks:export --module <single module name>","csdx cm:stacks:export --branch [optional] branch name"],"flags":{"config":{"name":"config","type":"option","char":"c","description":"[optional] path of the config"},"stack-uid":{"name":"stack-uid","type":"option","char":"s","description":"API key of the source stack","hidden":true},"stack-api-key":{"name":"stack-api-key","type":"option","char":"k","description":"API key of the source stack"},"data":{"name":"data","type":"option","description":"path or location to store the data","hidden":true},"data-dir":{"name":"data-dir","type":"option","char":"d","description":"path or location to store the data"},"alias":{"name":"alias","type":"option","char":"a","description":"alias of the management token"},"management-token-alias":{"name":"management-token-alias","type":"option","description":"alias of the management token","hidden":true},"auth-token":{"name":"auth-token","type":"boolean","char":"A","description":"to use auth token","hidden":true,"allowNo":false},"module":{"name":"module","type":"option","char":"m","description":"[optional] specific module name"},"content-types":{"name":"content-types","type":"option","char":"t","description":"[optional] content type"},"branch":{"name":"branch","type":"option","char":"B","description":"[optional] branch name"},"secured-assets":{"name":"secured-assets","type":"boolean","description":"[optional] use when assets are secured","allowNo":false},"yes":{"name":"yes","type":"boolean","char":"y","description":"[optional] Override marketplace apps related prompts","required":false,"allowNo":false}},"args":[]}}}

package/package.json

@@ -1,13 +1,13 @@
 {
   "name": "@contentstack/cli-cm-export",
   "description": "Contentstack CLI plugin to export content from stack",
-  "version": "1.2.1",
+  "version": "1.2.3",
   "author": "Contentstack",
   "bugs": "https://github.com/contentstack/cli/issues",
   "dependencies": {
-    "@contentstack/cli-command": "^1.0.2",
-    "@contentstack/cli-utilities": "^1.0.3",
-    "@contentstack/management": "^1.3.0",
+    "@contentstack/cli-command": "^1.0.4",
+    "@contentstack/cli-utilities": "^1.0.5",
+    "@contentstack/management": "^1.6.0",
     "@oclif/command": "^1.8.16",
     "@oclif/config": "^1.18.3",
     "async": "^3.2.4",
@@ -24,11 +24,10 @@
     "winston": "^3.7.2"
   },
   "devDependencies": {
-    "@contentstack/cli-auth": "^1.0.3",
-    "@contentstack/cli-config": "^1.0.2",
+    "@contentstack/cli-auth": "^1.0.6",
+    "@contentstack/cli-config": "^1.0.4",
     "@contentstack/cli-dev-dependencies": "^1.0.0",
     "@oclif/dev-cli": "^1.22.2",
-    "@oclif/plugin-help": "^5.1.12",
     "@oclif/test": "^1.2.6",
     "assert": "^2.0.0",
     "chai": "^4.2.0",
@@ -37,8 +36,8 @@
     "eslint": "^8.18.0",
     "eslint-config-oclif": "^3.1.0",
     "globby": "^10.0.2",
-    "mocha": "^10.0.0",
-    "nyc": "^14.1.1",
+    "mocha": "10.1.0",
+    "nyc": "^15.1.0",
     "sinon": "^9.0.2"
   },
   "engines": {
@@ -68,9 +67,6 @@
   "oclif": {
     "commands": "./src/commands",
     "bin": "csdx",
-    "devPlugins": [
-      "@oclif/plugin-help"
-    ],
     "repositoryPrefix": "<%- repo %>/blob/main/packages/contentstack-export/<%- commandPath %>"
   },
   "csdxConfig": {

package/src/app.js

@@ -73,13 +73,12 @@ exports.initial = async function (config) {
           } else {
             addlogs(config, `${formatError(error)}`, 'error');
           }
-          // reject(error);
         });
     } else if (config.management_token) {
       try {
         await fetchBranchAndExport();
       } catch (error) {
-        addlogs(config, `${formatError(error)}`, 'error');
+        addlogs(config, formatError(error), 'error');
       }
       resolve();
     }
@@ -140,13 +139,15 @@ const allExport = async (config, types, branchName) => {
     }
     addlogs(
       config,
-      chalk.green('The content of the ' + config.source_stack + ' has been exported successfully!'),
+      chalk.green(
+        'The content of stack ' + (config.sourceStackName || config.source_stack) + ' has been exported successfully!',
+      ),
       'success',
     );
     addlogs(config, 'The log for this is stored at ' + path.join(config.data, 'logs', 'export'), 'success');
     return true;
   } catch (error) {
-    addlogs(config, `${formatError(error)}`, 'error');
+    addlogs(config, formatError(error), 'error');
     addlogs(
       config,
       chalk.red('Failed to migrate stack: ' + config.source_stack + '. Please check error logs for more info'),

package/src/commands/cm/stacks/export.js

@@ -31,6 +31,8 @@ class ExportCommand extends Command {
     host.cma = cmaHost[1];
     host.cda = cdaHost[1];
 
+    config.forceStopMarketplaceAppsPrompt = exportCommandFlags.yes;
+
     if (alias) {
       let managementTokens = this.getToken(alias);
 
@@ -177,6 +179,11 @@ ExportCommand.flags = {
   'secured-assets': flags.boolean({
     description: '[optional] use when assets are secured',
   }),
+  yes: flags.boolean({
+    char: 'y',
+    required: false,
+    description: '[optional] Override marketplace apps related prompts',
+  }),
 };
 
 ExportCommand.aliases = ['cm:export'];

package/src/config/default.js

@@ -347,4 +347,6 @@ module.exports = {
   preserveStackVersion: false,
   fetchConcurrency: 5,
   writeConcurrency: 5,
+  developerHubBaseUrl: '',
+  marketplaceAppEncryptionKey: 'nF2ejRQcTv',
 };

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

@@ -12,22 +12,23 @@ const { cliux, HttpClient, NodeCrypto } = require('@contentstack/cli-utilities')
 
 const { formatError } = require('../util');
 let config = require('../../config/default');
-const { writeFile } = require('../util/helper');
+const { writeFileSync } = require('../util/helper');
 const { addlogs: log } = require('../util/log');
 const { getDeveloperHubUrl, getInstalledExtensions } = require('../util/marketplace-app-helper');
 
 module.exports = class ExportMarketplaceApps {
   config;
+  nodeCrypto;
   marketplaceAppPath = null;
   developerHubBaseUrl = null;
   marketplaceAppConfig = config.modules.marketplace_apps;
 
   constructor(credentialConfig) {
-    this.config = credentialConfig;
+    this.config = _.merge(config, credentialConfig);
   }
 
   async start() {
-    this.developerHubBaseUrl = await getDeveloperHubUrl();
+    this.developerHubBaseUrl = this.config.developerHubBaseUrl || (await getDeveloperHubUrl());
 
     if (!this.config.auth_token) {
       cliux.print(
@@ -48,8 +49,35 @@ module.exports = class ExportMarketplaceApps {
     return this.exportInstalledExtensions();
   }
 
+  async createNodeCryptoInstance() {
+    const cryptoArgs = {};
+
+    if (this.config.forceStopMarketplaceAppsPrompt) {
+      cryptoArgs['encryptionKey'] = this.config.marketplaceAppEncryptionKey;
+    } else {
+      cryptoArgs['encryptionKey'] = await cliux.inquire({
+        type: 'input',
+        name: 'name',
+        default: this.config.marketplaceAppEncryptionKey,
+        validate: (url) => {
+          if (!url) return "Encryption key can't be empty.";
+
+          return true;
+        },
+        message: 'Enter marketplace app configurations encryption key',
+      });
+    }
+
+    this.nodeCrypto = new NodeCrypto(cryptoArgs);
+  }
+
   exportInstalledExtensions = () => {
     const self = this;
+    const headers = {
+      authtoken: self.config.auth_token,
+      organization_uid: self.config.org_uid,
+    };
+    const httpClient = new HttpClient().headers(headers);
 
     return new Promise(async function (resolve, reject) {
       getInstalledExtensions(self.config)
@@ -64,84 +92,77 @@ module.exports = class ExportMarketplaceApps {
               type,
             }),
           );
-          const headers = {
-            authtoken: self.config.auth_token,
-            organization_uid: self.config.org_uid,
-          };
-          const httpClient = new HttpClient().headers(headers);
-          const nodeCrypto = new NodeCrypto();
+          const uniqApps = _.uniqBy(installedApps, 'app_uid');
+
           const developerHubApps =
             (await httpClient
               .get(`${self.developerHubBaseUrl}/apps`)
               .then(({ data: { data } }) => data)
               .catch((err) => {
-                console.log(err);
+                log(self.config, err, 'error');
               })) || [];
 
-          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
-                      );
+          for (const app of uniqApps) {
+            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);
+
+            await httpClient
+              .get(`${self.developerHubBaseUrl}/installations/${app.app_installation_uid}/installationData`)
+              .then(async ({ data: result }) => {
+                const { data, error } = result;
+                const developerHubApp = _.find(developerHubApps, { uid: app.app_uid });
+
+                if ((_.has(data, 'configuration') || _.has(data, 'server_configuration')) && !self.nodeCrypto) {
+                  await self.createNodeCryptoInstance();
+                }
+
+                _.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'] = self.nodeCrypto.encrypt(configuration);
+                    }
+                    if (!_.isEmpty(server_configuration)) {
+                      installedApps[index]['server_configuration'] = self.nodeCrypto.encrypt(server_configuration);
                     }
 
-                    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');
-                      }
+                    if (i === 0) {
+                      log(self.config, `Exported ${app.title} app and it's config.`, 'success');
                     }
-                  });
-
-                  cb();
-                })
-                .catch((err) => {
-                  log(self.config, `Failed to export ${app.title} app config ${formatError(error)}`, 'error');
-                  console.log(err);
-                  cb();
+                  } else if (error) {
+                    console.log(error);
+                    if (i === 0) {
+                      log(self.config, `Error on exporting ${app.title} app and it's config.`, 'error');
+                    }
+                  }
                 });
-            },
-            () => {
-              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((err) => {
+                log(self.config, `Failed to export ${app.title} app config ${formatError(error)}`, 'error');
+                console.log(err);
+              });
+          }
+
+          if (!_.isEmpty(installedApps)) {
+            await writeFileSync(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) => {
           log(self.config, `Failed to export marketplace-apps ${formatError(error)}`, 'error');