@contentstack/cli-migration 1.0.2 → 1.0.4

package/README.md

@@ -21,7 +21,7 @@ $ npm install -g @contentstack/cli-migration
 $ csdx COMMAND
 running command...
 $ csdx (-v|--version|version)
-@contentstack/cli-migration/1.0.2 darwin-arm64 node-v18.11.0
+@contentstack/cli-migration/1.0.4 linux-x64 node-v16.18.1
 $ csdx --help [COMMAND]
 USAGE
   $ csdx COMMAND
@@ -72,6 +72,6 @@ _See code: [src/commands/cm/stacks/migration.js](https://github.com/contentstack
 
 ### Points to remember
 
-- Currently, the Migration plugin does not support Group fields migration. You can pass a custom schema to the createField method to migrate Group fields. [here](packages/contentstack-migration/examples/)
-- Currently, the Migration plugin does not support Global fields migration. You can migrate Global fields by creating an SDK instance and adding it to content types using the createField method.[here](packages/contentstack-migration/examples/)
-- Currently, the Migration plugin does not support migration of Entries. You can migrate entries by creating an SDK instance to create/ update/ delete entries for your content type. [here](packages/contentstack-migration/examples/)
+- Currently, you can pass a custom schema to the createField method to migrate group fields.
+- You can migrate global fields by creating an SDK instance and adding it to content types using the createField method.
+- Currently, you can migrate entries by creating an SDK instance to create/update/delete entries for your content type.

package/oclif.manifest.json

@@ -1 +1 @@
-{"version":"1.0.2","commands":{"cm:stacks:migration":{"id":"cm:stacks:migration","description":"Contentstack migration script.","usage":"cm:stacks:migration [-k <value>] [-a <value>] [--file-path <value>] [--branch <value>] [--config-file <value>] [--config <value>] [--multiple]","pluginName":"@contentstack/cli-migration","pluginType":"core","aliases":["cm:migration"],"examples":["$ csdx cm:migration --file-path <migration/script/file/path> -k <api-key>","$ csdx cm:migration --file-path <migration/script/file/path> -k <api-key> --branch <target branch name>","$ csdx cm:migration --config <key1>:<value1> <key2>:<value2> ... --file-path <migration/script/file/path>","$ csdx cm:migration --config-file <path/to/json/config/file> --file-path <migration/script/file/path>","$ csdx cm:migration --multiple --file-path <migration/scripts/dir/path> ","$ csdx cm:migration --alias --file-path <migration/script/file/path> -k <api-key>"],"flags":{"api-key":{"name":"api-key","type":"option","char":"k","description":"With this flag add the API key of your stack.","hidden":true},"stack-api-key":{"name":"stack-api-key","type":"option","char":"k","description":"With this flag add the API key of your stack."},"authtoken":{"name":"authtoken","type":"boolean","char":"A","description":"Use this flag to use the auth token of the current session. After logging in CLI, an auth token is generated for each new session.","hidden":true,"allowNo":false},"alias":{"name":"alias","type":"option","char":"a","description":"Use this flag to add the management token alias."},"management-token-alias":{"name":"management-token-alias","type":"option","description":"alias of the management token","hidden":true},"filePath":{"name":"filePath","type":"option","char":"n","description":"Use this flag to provide the path of the file of the migration script provided by the user.","hidden":true},"file-path":{"name":"file-path","type":"option","description":"Use this flag to provide the path of the file of the migration script provided by the user."},"branch":{"name":"branch","type":"option","char":"B","description":"Use this flag to add the branch name where you want to perform the migration."},"config-file":{"name":"config-file","type":"option","description":"[optional] Path of the JSON configuration file"},"config":{"name":"config","type":"option","description":"[optional] inline configuration, <key1>:<value1>"},"multi":{"name":"multi","type":"boolean","description":"This flag helps you to migrate multiple content files in a single instance.","hidden":true,"allowNo":false},"multiple":{"name":"multiple","type":"boolean","description":"This flag helps you to migrate multiple content files in a single instance.","allowNo":false}},"args":[]}}}
+{"version":"1.0.4","commands":{"cm:stacks:migration":{"id":"cm:stacks:migration","description":"Contentstack migration script.","usage":"cm:stacks:migration [-k <value>] [-a <value>] [--file-path <value>] [--branch <value>] [--config-file <value>] [--config <value>] [--multiple]","pluginName":"@contentstack/cli-migration","pluginType":"core","aliases":["cm:migration"],"examples":["$ csdx cm:migration --file-path <migration/script/file/path> -k <api-key>","$ csdx cm:migration --file-path <migration/script/file/path> -k <api-key> --branch <target branch name>","$ csdx cm:migration --config <key1>:<value1> <key2>:<value2> ... --file-path <migration/script/file/path>","$ csdx cm:migration --config-file <path/to/json/config/file> --file-path <migration/script/file/path>","$ csdx cm:migration --multiple --file-path <migration/scripts/dir/path> ","$ csdx cm:migration --alias --file-path <migration/script/file/path> -k <api-key>"],"flags":{"stack-api-key":{"name":"stack-api-key","type":"option","char":"k","description":"With this flag add the API key of your stack."},"alias":{"name":"alias","type":"option","char":"a","description":"Use this flag to add the management token alias."},"file-path":{"name":"file-path","type":"option","description":"Use this flag to provide the path of the file of the migration script provided by the user."},"branch":{"name":"branch","type":"option","char":"B","description":"Use this flag to add the branch name where you want to perform the migration."},"config-file":{"name":"config-file","type":"option","description":"[optional] Path of the JSON configuration file"},"config":{"name":"config","type":"option","description":"[optional] inline configuration, <key1>:<value1>"},"multiple":{"name":"multiple","type":"boolean","description":"This flag helps you to migrate multiple content files in a single instance.","allowNo":false},"api-key":{"name":"api-key","type":"option","char":"k","description":"With this flag add the API key of your stack.","hidden":true},"authtoken":{"name":"authtoken","type":"boolean","char":"A","description":"Use this flag to use the auth token of the current session. After logging in CLI, an auth token is generated for each new session.","hidden":true,"allowNo":false},"management-token-alias":{"name":"management-token-alias","type":"option","description":"alias of the management token","hidden":true},"filePath":{"name":"filePath","type":"option","char":"n","description":"Use this flag to provide the path of the file of the migration script provided by the user.","hidden":true},"multi":{"name":"multi","type":"boolean","description":"This flag helps you to migrate multiple content files in a single instance.","hidden":true,"allowNo":false}},"args":[]}}}

package/package.json

@@ -1,12 +1,12 @@
 {
   "name": "@contentstack/cli-migration",
-  "version": "1.0.2",
+  "version": "1.0.4",
   "author": "@contentstack",
   "bugs": "https://github.com/contentstack/cli/issues",
   "dependencies": {
-    "@contentstack/cli-command": "^1.0.2",
-    "@contentstack/management": "^1.3.0",
-    "@contentstack/cli-utilities": "^1.0.3",
+    "@contentstack/cli-command": "^1.0.4",
+    "@contentstack/management": "^1.6.0",
+    "@contentstack/cli-utilities": "^1.0.5",
     "@oclif/command": "^1.8.16",
     "@oclif/config": "^1.18.3",
     "async": "^3.2.4",
@@ -20,7 +20,6 @@
   },
   "devDependencies": {
     "@oclif/dev-cli": "^1.26.0",
-    "@oclif/plugin-help": "^5.1.12",
     "@oclif/test": "^1.2.8",
     "chai": "^4.3.4",
     "eslint": "^8.18.0",
@@ -33,7 +32,7 @@
     "mkdirp": "^1.0.4",
     "mocha": "^10.0.0",
     "nock": "^13.1.1",
-    "nyc": "^14.1.1"
+    "nyc": "^15.1.0"
   },
   "engines": {
     "node": ">=8.3.0"
@@ -52,9 +51,6 @@
   "oclif": {
     "commands": "./src/commands",
     "bin": "csdx",
-    "devPlugins": [
-      "@oclif/plugin-help"
-    ],
     "repositoryPrefix": "<%- repo %>/blob/main/packages/contentstack-migration/<%- commandPath %>"
   },
   "repository": "contentstack/cli-migration",

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

@@ -200,15 +200,15 @@ class MigrationCommand extends Command {
         result && results.push(result);
         task.title = successTitle;
         return result;
-      }
-    }
+      };
+    };
 
     for (const element of requests) {
       let reqObj = element;
       const { title } = reqObj;
       const taskObj = {
         title: title,
-        task: taskFn(reqObj)
+        task: taskFn(reqObj),
       };
       _tasks.push(taskObj);
     }
@@ -233,19 +233,45 @@ class MigrationCommand extends Command {
 MigrationCommand.description = 'Contentstack migration script.';
 
 MigrationCommand.flags = {
-  'api-key': flags.string({
+  'stack-api-key': flags.string({
     char: 'k',
     description: 'With this flag add the API key of your stack.',
     dependsOn: ['authtoken'],
     exclusive: ['alias'],
-    parse: printFlagDeprecation(['--api-key'], ['-k', '--stack-api-key']),
-    hidden: true,
   }),
-  'stack-api-key': flags.string({
+  alias: flags.string({
+    char: 'a',
+    description: 'Use this flag to add the management token alias.',
+    exclusive: ['authtoken'],
+  }),
+  'file-path': flags.string({
+    description: 'Use this flag to provide the path of the file of the migration script provided by the user.',
+  }),
+  branch: flags.string({
+    char: 'B',
+    description: 'Use this flag to add the branch name where you want to perform the migration.',
+    parse: printFlagDeprecation(['-B'], ['--branch']),
+  }),
+  'config-file': flags.string({
+    description: '[optional] Path of the JSON configuration file',
+  }),
+  config: flags.string({
+    description: '[optional] inline configuration, <key1>:<value1>',
+    multiple: true,
+  }),
+
+  multiple: flags.boolean({
+    description: 'This flag helps you to migrate multiple content files in a single instance.',
+  }),
+
+  //To be  deprecated
+  'api-key': flags.string({
     char: 'k',
     description: 'With this flag add the API key of your stack.',
     dependsOn: ['authtoken'],
     exclusive: ['alias'],
+    parse: printFlagDeprecation(['--api-key'], ['-k', '--stack-api-key']),
+    hidden: true,
   }),
   authtoken: flags.boolean({
     char: 'A',
@@ -256,11 +282,6 @@ MigrationCommand.flags = {
     parse: printFlagDeprecation(['-A', '--authtoken']),
     hidden: true,
   }),
-  alias: flags.string({
-    char: 'a',
-    description: 'Use this flag to add the management token alias.',
-    exclusive: ['authtoken'],
-  }),
   'management-token-alias': flags.string({
     description: 'alias of the management token',
     exclusive: ['authtoken'],
@@ -273,33 +294,16 @@ MigrationCommand.flags = {
     parse: printFlagDeprecation(['-n', '--filePath'], ['--file-path']),
     hidden: true,
   }),
-  'file-path': flags.string({
-    description: 'Use this flag to provide the path of the file of the migration script provided by the user.',
-  }),
-  branch: flags.string({
-    char: 'B',
-    description: 'Use this flag to add the branch name where you want to perform the migration.',
-    parse: printFlagDeprecation(['-B'], ['--branch']),
-  }),
-  'config-file': flags.string({
-    description: '[optional] Path of the JSON configuration file',
-  }),
-  config: flags.string({
-    description: '[optional] inline configuration, <key1>:<value1>',
-    multiple: true,
-  }),
   multi: flags.boolean({
     description: 'This flag helps you to migrate multiple content files in a single instance.',
     parse: printFlagDeprecation(['--multi'], ['--multiple']),
     hidden: true,
   }),
-  multiple: flags.boolean({
-    description: 'This flag helps you to migrate multiple content files in a single instance.',
-  }),
 };
 
 MigrationCommand.aliases = ['cm:migration'];
 
-MigrationCommand.usage = 'cm:stacks:migration [-k <value>] [-a <value>] [--file-path <value>] [--branch <value>] [--config-file <value>] [--config <value>] [--multiple]';
+MigrationCommand.usage =
+  'cm:stacks:migration [-k <value>] [-a <value>] [--file-path <value>] [--branch <value>] [--config-file <value>] [--config <value>] [--multiple]';
 
 module.exports = MigrationCommand;