@contentstack/cli-cm-import 1.2.4 → 1.3.0

package/README.md

@@ -36,8 +36,8 @@ For switching to AZURE-NA region update the hosts at config/default.js
 $ npm install -g @contentstack/cli-cm-import
 $ csdx COMMAND
 running command...
-$ csdx (-v|--version|version)
-@contentstack/cli-cm-import/1.2.4 linux-x64 node-v16.18.1
+$ csdx (--version)
+@contentstack/cli-cm-import/1.3.0 linux-x64 node-v16.19.0
 $ csdx --help [COMMAND]
 USAGE
   $ csdx COMMAND
@@ -49,6 +49,7 @@ USAGE
 
 <!-- commands -->
 * [`csdx cm:stacks:import [-c <value>] [-k <value>] [-d <value>] [-a <value>] [--module <value>] [--backup-dir <value>] [--branch <value>] [--import-webhook-status disable|current]`](#csdx-cmstacksimport--c-value--k-value--d-value--a-value---module-value---backup-dir-value---branch-value---import-webhook-status-disablecurrent)
+* [`csdx cm:stacks:import [-c <value>] [-k <value>] [-d <value>] [-a <value>] [--module <value>] [--backup-dir <value>] [--branch <value>] [--import-webhook-status disable|current]`](#csdx-cmstacksimport--c-value--k-value--d-value--a-value---module-value---backup-dir-value---branch-value---import-webhook-status-disablecurrent-1)
 
 ## `csdx cm:stacks:import [-c <value>] [-k <value>] [-d <value>] [-a <value>] [--module <value>] [--backup-dir <value>] [--branch <value>] [--import-webhook-status disable|current]`
 
@@ -56,37 +57,96 @@ Import script for importing the content into the new stack
 
 ```
 USAGE
-  $ csdx cm:stacks:import [-c <value>] [-k <value>] [-d <value>] [-a <value>] [--module <value>] [--backup-dir <value>] 
-  [--branch <value>] [--import-webhook-status disable|current]
-
-OPTIONS
-  -B, --branch=branch                      [optional] branch name
-  -a, --alias=alias                        alias of the management token
-  -b, --backup-dir=backup-dir              [optional] backup directory name when using specific module
-  -c, --config=config                      [optional] path of config file
-  -d, --data-dir=data-dir                  path and location where data is stored
-  -k, --stack-api-key=stack-api-key        API key of the target stack
-  -m, --module=module                      [optional] specific module name
-  -y, --yes                                [optional] Override marketplace prompts
-  --import-webhook-status=disable|current  [default: disable] [optional] Webhook state
+  $ csdx cm:stacks:import [-c <value>] [-k <value>] [-d <value>] [-a <value>] [--module <value>] [--backup-dir <value>]
+    [--branch <value>] [--import-webhook-status disable|current]
+
+FLAGS
+  -B, --branch=<value>              [optional] branch name
+  -a, --alias=<value>               alias of the management token
+  -b, --backup-dir=<value>          [optional] backup directory name when using specific module
+  -c, --config=<value>              [optional] path of config file
+  -d, --data-dir=<value>            path and location where data is stored
+  -k, --stack-api-key=<value>       API key of the target stack
+  -m, --module=<value>              [optional] specific module name
+  -y, --yes                         [optional] Override marketplace prompts
+  --import-webhook-status=<option>  [default: disable] [optional] Webhook state
+                                    <options: disable|current>
 
 DESCRIPTION
+  Import script for importing the content into the new stack
   ...
-  Once you export content from the source stack, import it to your destination stack by using the cm:stacks:import 
+  Once you export content from the source stack, import it to your destination stack by using the cm:stacks:import
   command.
 
+
 ALIASES
   $ csdx cm:import
 
 EXAMPLES
-  csdx cm:stacks:import --stack-api-key <stack_api_key> --data-dir <path/of/export/destination/dir>
-  csdx cm:stacks:import --config <path/of/config/dir>
-  csdx cm:stacks:import --module <single module name>
-  csdx cm:stacks:import --module <single module name> --backup-dir <backup dir>
-  csdx cm:stacks:import --alias <management_token_alias>
-  csdx cm:stacks:import --alias <management_token_alias> --data-dir <path/of/export/destination/dir>
-  csdx cm:stacks:import --alias <management_token_alias> --config <path/of/config/file>
-  csdx cm:stacks:import --branch <branch name>  --yes
+  $ csdx cm:stacks:import --stack-api-key <stack_api_key> --data-dir <path/of/export/destination/dir>
+
+  $ csdx cm:stacks:import --config <path/of/config/dir>
+
+  $ csdx cm:stacks:import --module <single module name>
+
+  $ csdx cm:stacks:import --module <single module name> --backup-dir <backup dir>
+
+  $ csdx cm:stacks:import --alias <management_token_alias>
+
+  $ csdx cm:stacks:import --alias <management_token_alias> --data-dir <path/of/export/destination/dir>
+
+  $ csdx cm:stacks:import --alias <management_token_alias> --config <path/of/config/file>
+
+  $ csdx cm:stacks:import --branch <branch name>  --yes
+```
+
+## `csdx cm:stacks:import [-c <value>] [-k <value>] [-d <value>] [-a <value>] [--module <value>] [--backup-dir <value>] [--branch <value>] [--import-webhook-status disable|current]`
+
+Import script for importing the content into the new stack
+
+```
+USAGE
+  $ csdx cm:stacks:import [-c <value>] [-k <value>] [-d <value>] [-a <value>] [--module <value>] [--backup-dir <value>]
+    [--branch <value>] [--import-webhook-status disable|current]
+
+FLAGS
+  -B, --branch=<value>              [optional] branch name
+  -a, --alias=<value>               alias of the management token
+  -b, --backup-dir=<value>          [optional] backup directory name when using specific module
+  -c, --config=<value>              [optional] path of config file
+  -d, --data-dir=<value>            path and location where data is stored
+  -k, --stack-api-key=<value>       API key of the target stack
+  -m, --module=<value>              [optional] specific module name
+  -y, --yes                         [optional] Override marketplace prompts
+  --import-webhook-status=<option>  [default: disable] [optional] Webhook state
+                                    <options: disable|current>
+
+DESCRIPTION
+  Import script for importing the content into the new stack
+  ...
+  Once you export content from the source stack, import it to your destination stack by using the cm:stacks:import
+  command.
+
+
+ALIASES
+  $ csdx cm:import
+
+EXAMPLES
+  $ csdx cm:stacks:import --stack-api-key <stack_api_key> --data-dir <path/of/export/destination/dir>
+
+  $ csdx cm:stacks:import --config <path/of/config/dir>
+
+  $ csdx cm:stacks:import --module <single module name>
+
+  $ csdx cm:stacks:import --module <single module name> --backup-dir <backup dir>
+
+  $ csdx cm:stacks:import --alias <management_token_alias>
+
+  $ csdx cm:stacks:import --alias <management_token_alias> --data-dir <path/of/export/destination/dir>
+
+  $ csdx cm:stacks:import --alias <management_token_alias> --config <path/of/config/file>
+
+  $ csdx cm:stacks:import --branch <branch name>  --yes
 ```
 
 _See code: [src/commands/cm/stacks/import.js](https://github.com/contentstack/cli/blob/main/packages/contentstack-import/src/commands/cm/stacks/import.js)_

package/oclif.manifest.json

@@ -1 +1,129 @@
-{"version":"1.2.4","commands":{"cm:stacks:import":{"id":"cm:stacks:import","description":"Import script for importing the content into the new stack\n...\nOnce you export content from the source stack, import it to your destination stack by using the cm:stacks:import command.\n","usage":"cm:stacks:import [-c <value>] [-k <value>] [-d <value>] [-a <value>] [--module <value>] [--backup-dir <value>] [--branch <value>] [--import-webhook-status disable|current]","pluginName":"@contentstack/cli-cm-import","pluginType":"core","aliases":["cm:import"],"examples":["csdx cm:stacks:import --stack-api-key <stack_api_key> --data-dir <path/of/export/destination/dir>","csdx cm:stacks:import --config <path/of/config/dir>","csdx cm:stacks:import --module <single module name>","csdx cm:stacks:import --module <single module name> --backup-dir <backup dir>","csdx cm:stacks:import --alias <management_token_alias>","csdx cm:stacks:import --alias <management_token_alias> --data-dir <path/of/export/destination/dir>","csdx cm:stacks:import --alias <management_token_alias> --config <path/of/config/file>","csdx cm:stacks:import --branch <branch name>  --yes"],"flags":{"config":{"name":"config","type":"option","char":"c","description":"[optional] path of config file"},"stack-uid":{"name":"stack-uid","type":"option","char":"s","description":"API key of the target stack","hidden":true},"stack-api-key":{"name":"stack-api-key","type":"option","char":"k","description":"API key of the target stack"},"data":{"name":"data","type":"option","description":"path and location where data is stored","hidden":true},"data-dir":{"name":"data-dir","type":"option","char":"d","description":"path and location where data is stored"},"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"},"backup-dir":{"name":"backup-dir","type":"option","char":"b","description":"[optional] backup directory name when using specific module"},"branch":{"name":"branch","type":"option","char":"B","description":"[optional] branch name"},"import-webhook-status":{"name":"import-webhook-status","type":"option","description":"[optional] Webhook state","required":false,"options":["disable","current"],"default":"disable"},"yes":{"name":"yes","type":"boolean","char":"y","description":"[optional] Override marketplace prompts","required":false,"allowNo":false}},"args":[]}}}
+{
+  "version": "1.3.0",
+  "commands": {
+    "cm:stacks:import": {
+      "id": "cm:stacks:import",
+      "description": "Import script for importing the content into the new stack\n...\nOnce you export content from the source stack, import it to your destination stack by using the cm:stacks:import command.\n",
+      "strict": true,
+      "usage": "cm:stacks:import [-c <value>] [-k <value>] [-d <value>] [-a <value>] [--module <value>] [--backup-dir <value>] [--branch <value>] [--import-webhook-status disable|current]",
+      "pluginName": "@contentstack/cli-cm-import",
+      "pluginAlias": "@contentstack/cli-cm-import",
+      "pluginType": "core",
+      "aliases": [
+        "cm:import"
+      ],
+      "examples": [
+        "csdx cm:stacks:import --stack-api-key <stack_api_key> --data-dir <path/of/export/destination/dir>",
+        "csdx cm:stacks:import --config <path/of/config/dir>",
+        "csdx cm:stacks:import --module <single module name>",
+        "csdx cm:stacks:import --module <single module name> --backup-dir <backup dir>",
+        "csdx cm:stacks:import --alias <management_token_alias>",
+        "csdx cm:stacks:import --alias <management_token_alias> --data-dir <path/of/export/destination/dir>",
+        "csdx cm:stacks:import --alias <management_token_alias> --config <path/of/config/file>",
+        "csdx cm:stacks:import --branch <branch name>  --yes"
+      ],
+      "flags": {
+        "config": {
+          "name": "config",
+          "type": "option",
+          "char": "c",
+          "description": "[optional] path of config file",
+          "multiple": false
+        },
+        "stack-uid": {
+          "name": "stack-uid",
+          "type": "option",
+          "char": "s",
+          "description": "API key of the target stack",
+          "hidden": true,
+          "multiple": false
+        },
+        "stack-api-key": {
+          "name": "stack-api-key",
+          "type": "option",
+          "char": "k",
+          "description": "API key of the target stack",
+          "multiple": false
+        },
+        "data": {
+          "name": "data",
+          "type": "option",
+          "description": "path and location where data is stored",
+          "hidden": true,
+          "multiple": false
+        },
+        "data-dir": {
+          "name": "data-dir",
+          "type": "option",
+          "char": "d",
+          "description": "path and location where data is stored",
+          "multiple": false
+        },
+        "alias": {
+          "name": "alias",
+          "type": "option",
+          "char": "a",
+          "description": "alias of the management token",
+          "multiple": false
+        },
+        "management-token-alias": {
+          "name": "management-token-alias",
+          "type": "option",
+          "description": "alias of the management token",
+          "hidden": true,
+          "multiple": false
+        },
+        "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",
+          "multiple": false
+        },
+        "backup-dir": {
+          "name": "backup-dir",
+          "type": "option",
+          "char": "b",
+          "description": "[optional] backup directory name when using specific module",
+          "multiple": false
+        },
+        "branch": {
+          "name": "branch",
+          "type": "option",
+          "char": "B",
+          "description": "[optional] branch name",
+          "multiple": false
+        },
+        "import-webhook-status": {
+          "name": "import-webhook-status",
+          "type": "option",
+          "description": "[optional] Webhook state",
+          "required": false,
+          "multiple": false,
+          "options": [
+            "disable",
+            "current"
+          ],
+          "default": "disable"
+        },
+        "yes": {
+          "name": "yes",
+          "type": "boolean",
+          "char": "y",
+          "description": "[optional] Override marketplace prompts",
+          "required": false,
+          "allowNo": false
+        }
+      },
+      "args": {}
+    }
+  }
+}

package/package.json

@@ -1,14 +1,12 @@
 {
   "name": "@contentstack/cli-cm-import",
   "description": "Contentstack CLI plugin to import content into stack",
-  "version": "1.2.4",
+  "version": "1.3.0",
   "author": "Contentstack",
   "bugs": "https://github.com/contentstack/cli/issues",
   "dependencies": {
-    "@contentstack/cli-command": "^1.0.4",
-    "@contentstack/management": "^1.6.0",
-    "@contentstack/cli-utilities": "^1.0.5",
-    "@oclif/command": "^1.8.16",
+    "@contentstack/cli-command": "^1.1.0",
+    "@contentstack/cli-utilities": "^1.1.0",
     "@oclif/config": "^1.18.3",
     "big-json": "^3.2.0",
     "bluebird": "^3.7.2",
@@ -21,7 +19,7 @@
     "winston": "^3.7.2"
   },
   "devDependencies": {
-    "@oclif/dev-cli": "^1.22.2",
+    "oclif": "^3.1.2",
     "@oclif/test": "^1.2.6",
     "chai": "^4.2.0",
     "eslint": "^8.18.0",
@@ -48,9 +46,9 @@
   "scripts": {
     "pack": "npm pack && mv *.tgz ../../build",
     "postpack": "rm -f oclif.manifest.json",
-    "prepack": "oclif-dev manifest && oclif-dev readme",
+    "prepack": "oclif manifest && oclif readme",
     "test": "nyc mocha --forbid-only \"test/**/*.test.js\"",
-    "version": "oclif-dev readme && git add README.md"
+    "version": "oclif readme && git add README.md"
   },
   "csdxConfig": {
     "expiredCommands": {

package/src/app.js

@@ -4,30 +4,29 @@
  * MIT Licensed
  */
 
-let fs = require('fs');
-let ncp = require('ncp');
-let _ = require('lodash');
-let path = require('path');
+const fs = require('fs');
+const ncp = require('ncp');
+const path = require('path');
 const chalk = require('chalk');
-let util = require('./lib/util/index');
-let { formatError } = require('./lib/util');
-let login = require('./lib/util/login');
-let { addlogs } = require('./lib/util/log');
-const { HttpClient } = require('@contentstack/cli-utilities');
-const stack = require('./lib/util/contentstack-management-sdk');
+const util = require('./lib/util/index');
+const login = require('./lib/util/login');
+const { addlogs } = require('./lib/util/log');
+const { managementSDKClient } = require('@contentstack/cli-utilities');
 
-exports.initial = function (configData) {
-  return new Promise(async function (resolve, reject) {
-    let config = util.initialization(configData);
+exports.initial = (configData) => {
+  return new Promise(async (resolve, reject) => {
+    const config = util.initialization(configData);
     config.oldPath = config.data;
+    const APIClient = await managementSDKClient(config);
+    const stackAPIClient = APIClient.stack({ api_key: config.target_stack, management_token: config.management_token });
 
     if (configData.branchName) {
-      await validateIfBranchExist(configData, configData.branchName).catch(() => {
+      await validateIfBranchExist(stackAPIClient, configData, configData.branchName).catch(() => {
         process.exit();
       });
     }
 
-    const backupAndImportData = async () => {
+    const backupAndImportData = async (APIClient, stackAPIClient) => {
       if (fs.existsSync(config.data)) {
         let migrationBackupDirPath = path.join(process.cwd(), '_backup_' + Math.floor(Math.random() * 1000));
         return createBackup(migrationBackupDirPath, config)
@@ -40,15 +39,15 @@ exports.initial = function (configData) {
             const types = config.modules.types;
 
             if (config.moduleName) {
-              importRes = singleImport(config.moduleName, types, config);
+              importRes = singleImport(APIClient, stackAPIClient, config.moduleName, types, config);
             } else {
-              importRes = allImport(config, types);
+              importRes = allImport(APIClient, stackAPIClient, config, types);
             }
 
             importRes.then(resolve).catch(reject);
           })
           .catch((error) => {
-            addlogs(config, `Failed to import contents ${formatError(error)}`, 'error');
+            addlogs(config, `Failed to import contents ${util.formatError(error)}`, 'error');
             reject(e);
             process.exit(1);
           });
@@ -60,32 +59,28 @@ exports.initial = function (configData) {
 
     if (config) {
       if ((config.email && config.password) || config.auth_token) {
-        login(config).then(backupAndImportData).catch(reject);
+        login(config).then(backupAndImportData(APIClient, stackAPIClient)).catch(reject);
       } else if (config.management_token) {
-        await backupAndImportData();
+        await backupAndImportData(APIClient, stackAPIClient);
       }
     }
   });
 };
 
-let singleImport = async (moduleName, types, config) => {
+let singleImport = async (APIClient, stackAPIClient, moduleName, types, config) => {
   try {
-    const stackClient = stack
-      .Client(config)
-      .stack({ api_key: config.target_stack, management_token: config.management_token });
-
     if (types.indexOf(moduleName) > -1) {
       if (!config.master_locale) {
         try {
-          let masterLocalResponse = await util.masterLocalDetails(config);
+          let masterLocalResponse = await util.masterLocalDetails(stackAPIClient);
           let master_locale = { code: masterLocalResponse.code };
           config['master_locale'] = master_locale;
         } catch (error) {
-          addlogs(config, `Failed to get master locale detail from the stack ${formatError(error)}`, 'error');
+          addlogs(config, `Failed to get master locale detail from the stack ${util.formatError(error)}`, 'error');
         }
       }
       let ImportModule = require('./lib/import/' + moduleName);
-      const importResponse = await new ImportModule(config, stackClient).start(config);
+      const importResponse = await new ImportModule(config, stackAPIClient, APIClient).start();
       if (moduleName === 'content-types') {
         let ctPath = path.resolve(config.data, config.modules.content_types.dirName);
         let fieldPath = path.join(ctPath + '/field_rules_uid.json');
@@ -103,25 +98,22 @@ let singleImport = async (moduleName, types, config) => {
     }
   } catch (error) {
     addlogs(config, 'Failed to migrate ' + moduleName, 'error');
-    addlogs(config, formatError(error), 'error');
+    addlogs(config, util.formatError(error), 'error');
     addlogs(config, 'The log for this is stored at ' + path.join(config.oldPath, 'logs', 'import'), 'error');
   }
 };
 
-let allImport = async (config, types) => {
+let allImport = async (APIClient, stackAPIClient, config, types) => {
   try {
-    const stackClient = stack
-      .Client(config)
-      .stack({ api_key: config.target_stack, management_token: config.management_token });
     for (let i = 0; i < types.length; i++) {
       let type = types[i];
       if (i === 0 && !config.master_locale) {
-        let masterLocalResponse = await util.masterLocalDetails(config);
+        let masterLocalResponse = await util.masterLocalDetails(stackAPIClient);
         let master_locale = { code: masterLocalResponse.code };
         config['master_locale'] = master_locale;
       }
       let ImportModule = require('./lib/import/' + type);
-      await new ImportModule(config, stackClient).start(config);
+      await new ImportModule(config, stackAPIClient, APIClient).start(config);
     }
     if (config.target_stack && config.source_stack) {
       addlogs(
@@ -157,12 +149,12 @@ let allImport = async (config, types) => {
       ),
       'error',
     );
-    addlogs(config, formatError(error), 'error');
+    addlogs(config, util.formatError(error), 'error');
     addlogs(config, 'The log for this is stored at ' + path.join(config.oldPath, 'logs', 'import'), 'error');
   }
 };
 
-function createBackup(backupDirPath, config) {
+const createBackup = (backupDirPath, config) => {
   return new Promise((resolve, reject) => {
     if (config.hasOwnProperty('useBackedupDir') && fs.existsSync(config.useBackedupDir)) {
       return resolve(config.useBackedupDir);
@@ -184,33 +176,29 @@ function createBackup(backupDirPath, config) {
       });
     }
   });
-}
+};
 
-const validateIfBranchExist = async (config, branch) => {
-  return new Promise(async function (resolve, reject) {
-    const headers = { api_key: config.target_stack, authtoken: config.auth_token };
-    const httpClient = new HttpClient().headers(headers);
-    const result = await httpClient
-      .get(`https://${config.host}/v3/stacks/branches/${branch}`)
-      .then(({ data }) => {
+const validateIfBranchExist = async (stackAPIClient, config, branch) => {
+  return new Promise(async (resolve, reject) => {
+    try {
+      const data = await stackAPIClient
+        .branch(branch)
+        .fetch()
+        .catch((_err) => {});
+      if (data && typeof data === 'object') {
         if (data.error_message) {
           addlogs(config, chalk.red(data.error_message), 'error');
           addlogs(config, chalk.red('No branch found with the name ' + branch), 'error');
-          reject();
+          reject({ message: 'No branch found with the name ' + branch, error: error_message });
+        } else {
+          resolve(data);
         }
-
-        return data;
-      })
-      .catch((err) => {
-        console.log(err);
-        addlogs(config, chalk.red('No branch found with the name ' + branch), 'error');
-        reject();
-      });
-
-    if (result && typeof result === 'object' && typeof result.branch === 'object') {
-      resolve(result.branch);
-    } else {
-      reject({ message: 'No branch found with the name ' + branch });
+      } else {
+        reject({ message: 'No branch found with the name ' + branch, error: {} });
+      }
+    } catch (error) {
+      addlogs(config, chalk.red('No branch found with the name ' + branch), 'error');
+      reject({ message: 'No branch found with the name ' + branch, error });
     }
   });
 };

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

@@ -15,7 +15,7 @@ const { printFlagDeprecation } = require('@contentstack/cli-utilities');
 class ImportCommand extends Command {
   async run() {
     let self = this;
-    const importCommandFlags = self.parse(ImportCommand).flags;
+    const { flags: importCommandFlags } = await self.parse(ImportCommand);
     const extConfig = importCommandFlags.config;
     let targetStack = importCommandFlags['stack-uid'] || importCommandFlags['stack-api-key'];
     const data = importCommandFlags.data || importCommandFlags['data-dir'];

package/src/config/default.js

@@ -24,11 +24,11 @@ module.exports = {
       'marketplace-apps',
       'global-fields',
       'content-types',
+      'custom-roles',
       'workflows',
       'entries',
       'labels',
       'webhooks',
-      'custom-roles',
     ],
     locales: {
       dirName: 'locales',