@contentstack/cli-cm-clone 1.1.0 → 1.1.3

package/README.md

@@ -15,7 +15,7 @@ $ npm install -g @contentstack/cli-cm-clone
 $ csdx COMMAND
 running command...
 $ csdx (-v|--version|version)
-@contentstack/cli-cm-clone/0.1.0-beta-1 darwin-x64 node-v13.14.0
+@contentstack/cli-cm-clone/1.1.3 darwin-arm64 node-v18.11.0
 $ csdx --help [COMMAND]
 USAGE
   $ csdx COMMAND
@@ -33,23 +33,63 @@ USAGE
 ```
 # Commands
 <!-- commands -->
-* [`csdx cm:stacks:clone`](#csdx-cmstack-clone)
+* [`csdx cm:stacks:clone [--source-branch <value>] [--target-branch <value>] [--source-management-token-alias <value>] [--destination-management-token-alias <value>] [-n <value>] [--type a|b] [--source-stack-api-key <value>] [--destination-stack-api-key <value>] [--import-webhook-status disable|current]`](#csdx-cmstacksclone---source-branch-value---target-branch-value---source-management-token-alias-value---destination-management-token-alias-value--n-value---type-ab---source-stack-api-key-value---destination-stack-api-key-value---import-webhook-status-disablecurrent)
 
-## `csdx cm:stacks:clone`
+## `csdx cm:stacks:clone [--source-branch <value>] [--target-branch <value>] [--source-management-token-alias <value>] [--destination-management-token-alias <value>] [-n <value>] [--type a|b] [--source-stack-api-key <value>] [--destination-stack-api-key <value>] [--import-webhook-status disable|current]`
 
-This command allows you to migrate data (structure or content or both) from one stack to another stack (either new or existing)
+Clone data (structure/content or both) of a stack into another stack
 
 ```
 USAGE
-  $ csdx cm:stacks:clone
+  $ csdx cm:stacks:clone [--source-branch <value>] [--target-branch <value>] [--source-management-token-alias <value>] 
+  [--destination-management-token-alias <value>] [-n <value>] [--type a|b] [--source-stack-api-key <value>] 
+  [--destination-stack-api-key <value>] [--import-webhook-status disable|current]
+
+OPTIONS
+  -n, --stack-name=stack-name                                              Name for the new stack to store the cloned
+                                                                           content.
+
+  -y, --yes                                                                [optional] Override marketplace prompts
+
+  --destination-management-token-alias=destination-management-token-alias  Source API key of the target stack token
+                                                                           alias.
+
+  --destination-stack-api-key=destination-stack-api-key                    Destination stack API Key
+
+  --import-webhook-status=disable|current                                  [default: disable] Webhook state
+
+  --source-branch=source-branch                                            Branch of the source stack.
+
+  --source-management-token-alias=source-management-token-alias            Source API key of the target stack token
+                                                                           alias.
+
+  --source-stack-api-key=source-stack-api-key                              Source stack API Key
+
+  --target-branch=target-branch                                            Branch of the target stack.
+
+  --type=a|b                                                               Type of data to clone
+                                                                           a) Structure (all modules except entries &
+                                                                           assets)
+                                                                           b) Structure with content (all modules
+                                                                           including entries & assets)
 
 DESCRIPTION
-  ...
-  Use this plugin to automate the process of cloning a stack in a few steps.
+  Use this plugin to automate the process of cloning a stack in few steps.
+
+ALIASES
+  $ csdx cm:stack-clone
 
-EXAMPLE
+EXAMPLES
   csdx cm:stacks:clone
+  csdx cm:stacks:clone --source-branch <source-branch-name> --target-branch <target-branch-name> --yes
+  csdx cm:stacks:clone --source-stack-api-key <apiKey> --destination-stack-api-key <apiKey>
+  csdx cm:stacks:clone --source-management-token-alias <management token alias> --destination-management-token-alias 
+  <management token alias>
+  csdx cm:stacks:clone --source-branch --target-branch --source-management-token-alias <management token alias> 
+  --destination-management-token-alias <management token alias>
+  csdx cm:stacks:clone --source-branch --target-branch --source-management-token-alias <management token alias> 
+  --destination-management-token-alias <management token alias> --type <value a or b>
 ```
 
-_See code: [src/commands/cm/stacks/clone.js](https://github.com/contentstack/cli/blob/v0.1.0-beta-1/src/commands/cm/stack-clone.js)_
+_See code: [src/commands/cm/stacks/clone.js](https://github.com/contentstack/cli/blob/main/packages/contentstack-clone/src/commands/cm/stacks/clone.js)_
 <!-- commandsstop -->

package/oclif.manifest.json

@@ -0,0 +1 @@
+{"version":"1.1.3","commands":{"cm:stacks:clone":{"id":"cm:stacks:clone","description":"Clone data (structure/content or both) of a stack into another stack\nUse this plugin to automate the process of cloning a stack in few steps.\n","usage":"cm:stacks:clone [--source-branch <value>] [--target-branch <value>] [--source-management-token-alias <value>] [--destination-management-token-alias <value>] [-n <value>] [--type a|b] [--source-stack-api-key <value>] [--destination-stack-api-key <value>] [--import-webhook-status disable|current]","pluginName":"@contentstack/cli-cm-clone","pluginType":"core","aliases":["cm:stack-clone"],"examples":["csdx cm:stacks:clone","csdx cm:stacks:clone --source-branch <source-branch-name> --target-branch <target-branch-name> --yes","csdx cm:stacks:clone --source-stack-api-key <apiKey> --destination-stack-api-key <apiKey>","csdx cm:stacks:clone --source-management-token-alias <management token alias> --destination-management-token-alias <management token alias>","csdx cm:stacks:clone --source-branch --target-branch --source-management-token-alias <management token alias> --destination-management-token-alias <management token alias>","csdx cm:stacks:clone --source-branch --target-branch --source-management-token-alias <management token alias> --destination-management-token-alias <management token alias> --type <value a or b>"],"flags":{"source-branch":{"name":"source-branch","type":"option","description":"Branch of the source stack.","required":false},"target-branch":{"name":"target-branch","type":"option","description":"Branch of the target stack.","required":false},"source-management-token-alias":{"name":"source-management-token-alias","type":"option","description":"Source API key of the target stack token alias.","required":false},"destination-management-token-alias":{"name":"destination-management-token-alias","type":"option","description":"Source API key of the target stack token alias.","required":false},"stack-name":{"name":"stack-name","type":"option","char":"n","description":"Name for the new stack to store the cloned content.","required":false},"type":{"name":"type","type":"option","description":"Type of data to clone\na) Structure (all modules except entries & assets)\nb) Structure with content (all modules including entries & assets)\n    ","required":false,"options":["a","b"]},"source-stack-api-key":{"name":"source-stack-api-key","type":"option","description":"Source stack API Key"},"destination-stack-api-key":{"name":"destination-stack-api-key","type":"option","description":"Destination stack API Key"},"import-webhook-status":{"name":"import-webhook-status","type":"option","description":"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":[]}}}

package/package.json

@@ -1,14 +1,14 @@
 {
   "name": "@contentstack/cli-cm-clone",
   "description": "Contentstack stack clone plugin",
-  "version": "1.1.0",
+  "version": "1.1.3",
   "author": "Contentstack",
   "bugs": "https://github.com/rohitmishra209/cli-cm-clone/issues",
   "dependencies": {
-    "@contentstack/cli-cm-export": "^1.1.0",
-    "@contentstack/cli-cm-import": "^1.1.0",
-    "@contentstack/cli-command": "^1.0.1",
-    "@contentstack/cli-utilities": "^1.0.2",
+    "@contentstack/cli-cm-export": "^1.2.1",
+    "@contentstack/cli-cm-import": "^1.2.1",
+    "@contentstack/cli-command": "^1.0.2",
+    "@contentstack/cli-utilities": "^1.0.3",
     "@contentstack/management": "^1.3.0",
     "@oclif/command": "^1.8.16",
     "@oclif/config": "^1.18.3",
@@ -16,7 +16,7 @@
     "async": "^3.2.4",
     "child_process": "^1.0.2",
     "fancy-test": "^1.4.10",
-    "inquirer": "^7.3.3",
+    "inquirer": "^8.2.4",
     "ora": "^5.1.0",
     "rimraf": "^3.0.2",
     "winston": "^3.7.2"
@@ -54,11 +54,15 @@
     "bin": "csdx",
     "devPlugins": [
       "@oclif/plugin-help"
-    ]
+    ],
+    "repositoryPrefix": "<%- repo %>/blob/main/packages/contentstack-clone/<%- commandPath %>"
   },
   "repository": "https://github.com/contentstack/cli",
   "scripts": {
-    "test": "nyc --reporter=html mocha \"test/**/*.test.js\"",
+    "postpack": "rm -f oclif.manifest.json",
+    "prepack": "oclif-dev manifest && oclif-dev readme",
+    "test": "nyc --reporter=html mocha --forbid-only \"test/**/*.test.js\"",
+    "posttest": "eslint .",
     "version": "oclif-dev readme && git add README.md"
   },
   "csdxConfig": {
@@ -66,4 +70,4 @@
       "cm:stack-clone": "csdx cm:stacks:clone"
     }
   }
-}
+}

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

@@ -14,6 +14,7 @@ class StackCloneCommand extends Command {
       let _authToken = configHandler.get('authtoken');
       const cloneCommandFlags = self.parse(StackCloneCommand).flags;
       const {
+        yes,
         type: cloneType,
         'stack-name': stackName,
         'source-branch': sourceStackBranch,
@@ -23,12 +24,13 @@ class StackCloneCommand extends Command {
         'source-management-token-alias': sourceManagementTokenAlias,
         'destination-management-token-alias': destinationManagementTokenAlias,
         'import-webhook-status': importWebhookStatus,
-        'master-locale': masterLocale
       } = cloneCommandFlags;
 
       const handleClone = async () => {
         const listOfTokens = configHandler.get('tokens');
 
+        config.forceMarketplaceAppsImport = yes;
+
         if (cloneType) {
           config.cloneType = cloneType;
         }
@@ -68,16 +70,13 @@ class StackCloneCommand extends Command {
         await this.removeContentDirIfNotEmptyBeforeClone(pathdir); // NOTE remove if folder not empty before clone
         this.registerCleanupOnInterrupt(pathdir);
 
-        if (masterLocale) {
-          config.master_locale = { code: masterLocale }
-        }
         config.auth_token = _authToken;
         config.host = this.cmaHost;
         config.cdn = this.cdaHost;
         config.pathDir = pathdir;
         const cloneHandler = new CloneHandler(config);
         cloneHandler.execute().catch();
-      }
+      };
 
       if (sourceManagementTokenAlias && destinationManagementTokenAlias) {
         if (sourceStackBranch || targetStackBranch) {
@@ -151,7 +150,7 @@ class StackCloneCommand extends Command {
       if (exitOrError) {
         // eslint-disable-next-line no-console
         console.log('\nCleaning up');
-        await this.cleanUp(pathDir)
+        await this.cleanUp(pathDir);
         // eslint-disable-next-line no-console
         console.log('done');
         // eslint-disable-next-line no-process-exit
@@ -160,9 +159,9 @@ class StackCloneCommand extends Command {
           exitOrError.catch((error) => {
             console.log((error && error.message) || '');
           });
-        } else if (exitOrError && exitOrError.message) {
+        } else if (exitOrError.message) {
           console.log(exitOrError.message);
-        } else if (exitOrError && exitOrError.errorMessage) {
+        } else if (exitOrError.errorMessage) {
           console.log(exitOrError.message);
         }
 
@@ -181,7 +180,7 @@ Use this plugin to automate the process of cloning a stack in few steps.
 
 StackCloneCommand.examples = [
   'csdx cm:stacks:clone',
-  'csdx cm:stacks:clone --source-branch <source-branch-name> --target-branch <target-branch-name>',
+  'csdx cm:stacks:clone --source-branch <source-branch-name> --target-branch <target-branch-name> --yes',
   'csdx cm:stacks:clone --source-stack-api-key <apiKey> --destination-stack-api-key <apiKey>',
   'csdx cm:stacks:clone --source-management-token-alias <management token alias> --destination-management-token-alias <management token alias>',
   'csdx cm:stacks:clone --source-branch --target-branch --source-management-token-alias <management token alias> --destination-management-token-alias <management token alias>',
@@ -238,8 +237,10 @@ b) Structure with content (all modules including entries & assets)
     required: false,
     default: 'disable',
   }),
-  'master-locale': flags.string({
-    description: 'Master language for stack clone',
+  yes: flags.boolean({
+    char: 'y',
+    required: false,
+    description: '[optional] Override marketplace prompts',
   }),
 };
 

package/src/lib/helpers/command-helpers.js

@@ -29,7 +29,7 @@ const SetBranchCommand = function (params, parentContext) {
 };
 
 const CreateNewStackCommand = function (params, parentContext) {
-  return new CloneCommand(parentContext.createNewStack, null, params, parentContext);
+  return new CloneCommand(parentContext.createNewStack, parentContext.executeDestination, params, parentContext);
 };
 
 const CloneTypeSelectionCommand = function (params, parentContext) {

package/src/lib/util/clone-handler.js

@@ -6,7 +6,7 @@ const chalk = require('chalk');
 
 let exportCmd = require('@contentstack/cli-cm-export');
 let importCmd = require('@contentstack/cli-cm-import');
-const { HttpClient, chooseLocalePrompt } = require('@contentstack/cli-utilities');
+const { HttpClient } = require('@contentstack/cli-utilities');
 let sdkInstance = require('../../lib/util/contentstack-management-sdk');
 const defaultConfig = require('@contentstack/cli-cm-export/src/config/default');
 const { CustomAbortController } = require('./abort-controller');
@@ -88,7 +88,7 @@ class CloneHandler {
         const { org = {}, msg = '', isSource = true, stackAbortController } = options || {}
 
         keyPressHandler = async function (_ch, key) {
-          if (key.name === 'backspace') {
+          if (key.name === 'left' && key.shift) {
             stackAbortController.abort();
             console.clear();
             process.stdin.removeListener('keypress', keyPressHandler);
@@ -101,8 +101,7 @@ class CloneHandler {
 
         if (stackList) {
           const ui = new inquirer.ui.BottomBar();
-          // Use chalk to prettify the text.
-          ui.updateBottomBar(chalk.cyan('\nFor undo operation press backspace\n'));
+          ui.updateBottomBar(chalk.cyan('\nPress shift & left arrow together to undo the operation\n'));
 
           const selectedStack = await inquirer.prompt(stackList);
 
@@ -240,15 +239,6 @@ class CloneHandler {
             const sourceStack = await cloneCommand.execute(new HandleStackCommand({ org, isSource: true, msg: stackMsg, stackAbortController }, this));
 
             if (config.source_stack) {
-              if (!(config.master_locale && config.master_locale.code)) {
-
-                const res = await chooseLocalePrompt(client.stack({ api_key: config.source_stack }), 'Choose Master Locale', master_locale)
-                master_locale = res.code
-                config.master_locale = res
-              }
-              else {
-                master_locale = config.master_locale.code
-              }
               await cloneCommand.execute(
                 new HandleBranchCommand({ api_key: config.source_stack }, this)
               );
@@ -307,9 +297,10 @@ class CloneHandler {
             await cloneCommand.execute(new HandleBranchCommand({ isSource: false, api_key: config.target_stack }, this));
           }
         } else {
-          const destinationOrg = await this.handleOrgSelection({ isSource: false, msg: 'Choose an organization where you want to create a stack: ' });
+          const orgMsg = 'Choose an organization where you want to create a stack: ';
+          const destinationOrg = await cloneCommand.execute(new HandleOrgCommand({ msg: orgMsg }, this));
           const orgUid = orgUidList[destinationOrg.Organization];
-          await cloneCommand.execute(new CreateNewStackCommand(orgUid, this));
+          await cloneCommand.execute(new CreateNewStackCommand({ orgUid, stackAbortController }, this));
         }
         await cloneCommand.execute(new CloneTypeSelectionCommand(null, this));
         return resolve();
@@ -397,30 +388,63 @@ class CloneHandler {
     });
   };
 
-  async createNewStack(orgUid) {
+  async createNewStack(options) {
+    let keyPressHandler;
     return new Promise(async (resolve, reject) => {
-      let inputvalue;
+      try {
+        const { orgUid, stackAbortController } = options;
+        let inputvalue;
+        let uiPromise;
 
-      if (!config.stackName) {
-        inputvalue = await inquirer.prompt(stackName);
-      } else {
-        inputvalue = { stack: config.stackName };
-      }
+        keyPressHandler = async function (_ch, key) {
+          if (key.name === 'left' && key.shift) {
+            stackAbortController.abort();
+            // We need to close the inquirer promise correctly, otherwise the unclosed question/answer text is displayed in next line.
+            if (uiPromise) {
+              uiPromise.ui.close();
+            }
+            console.clear();
+            process.stdin.removeListener('keypress', keyPressHandler);
+            await cloneCommand.undo();
+          }
+        };
+        process.stdin.addListener('keypress', keyPressHandler);
+
+        const ui = new inquirer.ui.BottomBar();
+        ui.updateBottomBar(chalk.cyan('\nPress shift & left arrow together to undo the operation\n'));
 
-      let stack = { name: inputvalue.stack, master_locale: master_locale };
-      const spinner = ora('Creating New stack').start();
-      let newStack = client.stack().create({ stack }, { organization_uid: orgUid });
-      newStack
-        .then((result) => {
-          spinner.succeed('New Stack created Successfully name as ' + result.name);
-          config.target_stack = result.api_key;
-          config.destinationStackName = result.name;
-          return resolve(result);
-        })
-        .catch((error) => {
-          spinner.fail();
-          return reject(error.errorMessage + ' Contact the Organization owner for Stack Creation access.');
-        });
+        if (!config.stackName) {
+          uiPromise = inquirer.prompt(stackName);
+          inputvalue = await uiPromise;
+        } else {
+          inputvalue = { stack: config.stackName };
+        }
+
+        if (stackAbortController.signal.aborted) {
+          return reject();
+        }
+
+        let stack = { name: inputvalue.stack, master_locale: master_locale };
+        const spinner = ora('Creating New stack').start();
+        let newStack = client.stack().create({ stack }, { organization_uid: orgUid });
+        newStack
+          .then((result) => {
+            spinner.succeed('New Stack created Successfully name as ' + result.name);
+            config.target_stack = result.api_key;
+            config.destinationStackName = result.name;
+            return resolve(result);
+          })
+          .catch((error) => {
+            spinner.fail();
+            return reject(error.errorMessage + ' Contact the Organization owner for Stack Creation access.');
+          });
+      } catch (error) {
+        return reject(error);
+      } finally {
+        if (keyPressHandler) {
+          process.stdin.removeListener('keypress', keyPressHandler);
+        }
+      }
     });
   }
 
@@ -492,6 +516,8 @@ class CloneHandler {
         cmd.push('--import-webhook-status', config.importWebhookStatus);
       }
 
+      if (config.forceMarketplaceAppsImport) cmd.push('-y')
+
       await importCmd.run(cmd);
       return resolve();
     });