@contentstack/cli-migration 2.0.0-beta → 2.0.0-beta.2

package/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2024 Contentstack
+Copyright (c) 2026 Contentstack
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

package/README.md

@@ -21,7 +21,7 @@ $ npm install -g @contentstack/cli-migration
 $ csdx COMMAND
 running command...
 $ csdx (--version)
-@contentstack/cli-migration/2.0.0-beta darwin-arm64 node-v22.14.0
+@contentstack/cli-migration/2.0.0-beta.1 darwin-arm64 node-v24.12.0
 $ csdx --help [COMMAND]
 USAGE
   $ csdx COMMAND
@@ -33,50 +33,6 @@ USAGE
 
 <!-- commands -->
 * [`csdx cm:stacks:migration [-k <value>] [-a <value>] [--file-path <value>] [--branch <value>] [--config-file <value>] [--config <value>] [--multiple]`](#csdx-cmstacksmigration--k-value--a-value---file-path-value---branch-value---config-file-value---config-value---multiple)
-* [`csdx cm:stacks:migration [-k <value>] [-a <value>] [--file-path <value>] [--branch <value>] [--config-file <value>] [--config <value>] [--multiple]`](#csdx-cmstacksmigration--k-value--a-value---file-path-value---branch-value---config-file-value---config-value---multiple)
-
-## `csdx cm:stacks:migration [-k <value>] [-a <value>] [--file-path <value>] [--branch <value>] [--config-file <value>] [--config <value>] [--multiple]`
-
-Contentstack migration script.
-
-```
-USAGE
-  $ csdx cm:migration cm:stacks:migration [-k <value>] [-a <value>] [--file-path <value>] [--branch <value>]
-    [--config-file <value>] [--config <value>] [--multiple]
-
-FLAGS
-  -B, --branch=<value>         Use this flag to add the branch name where you want to perform the migration. (target
-                               branch name)
-  -a, --alias=<value>          Use this flag to add the management token alias. You must use either the --alias flag or
-                               the --stack-api-key flag.
-  -k, --stack-api-key=<value>  Use this flag to add the API key of your stack. You must use either the --stack-api-key
-                               flag or the --alias flag.
-      --config=<value>...      [optional] Inline configuration, <key1>:<value1>. Passing an external configuration makes
-                               the script re-usable.
-      --config-file=<value>    [optional] Path of the JSON configuration file.
-      --file-path=<value>      Use this flag to provide the path of the file of the migration script.
-      --multiple               This flag helps you to migrate multiple content files in a single instance. Mention the
-                               folder path where your migration script files are stored.
-
-DESCRIPTION
-  Contentstack migration script.
-
-ALIASES
-  $ csdx 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>
-```
 
 ## `csdx cm:stacks:migration [-k <value>] [-a <value>] [--file-path <value>] [--branch <value>] [--config-file <value>] [--config <value>] [--multiple]`
 
@@ -88,12 +44,12 @@ USAGE
     [--config <value>] [--multiple]
 
 FLAGS
-  -B, --branch=<value>         Use this flag to add the branch name where you want to perform the migration. (target
-                               branch name)
   -a, --alias=<value>          Use this flag to add the management token alias. You must use either the --alias flag or
                                the --stack-api-key flag.
   -k, --stack-api-key=<value>  Use this flag to add the API key of your stack. You must use either the --stack-api-key
                                flag or the --alias flag.
+      --branch=<value>         Use this flag to add the branch name where you want to perform the migration. (target
+                               branch name)
       --config=<value>...      [optional] Inline configuration, <key1>:<value1>. Passing an external configuration makes
                                the script re-usable.
       --config-file=<value>    [optional] Path of the JSON configuration file.
@@ -104,13 +60,10 @@ FLAGS
 DESCRIPTION
   Contentstack migration script.
 
-ALIASES
-  $ csdx cm:migration
-
 EXAMPLES
-  $ csdx cm:migration --file-path <migration/script/file/path> -k <api-key>
+  $ csdx cm:migration --file-path <migration/script/file/path> --stack-api-key <stack-api-key>
 
-  $ csdx cm:migration --file-path <migration/script/file/path> -k <api-key> --branch <target branch name>
+  $ csdx cm:migration --file-path <migration/script/file/path> --stack-api-key <stack-api-key> --branch <target branch name>
 
   $ csdx cm:migration --config <key1>:<value1> <key2>:<value2> ... --file-path <migration/script/file/path>
 
@@ -118,7 +71,7 @@ EXAMPLES
 
   $ csdx cm:migration --multiple --file-path <migration/scripts/dir/path> 
 
-  $ csdx cm:migration --alias --file-path <migration/script/file/path> -k <api-key>
+  $ csdx cm:migration --alias <management-token-alias> --file-path <migration/script/file/path>
 ```
 
 _See code: [src/commands/cm/stacks/migration.js](https://github.com/contentstack/cli/blob/main/packages/contentstack-migration/src/commands/cm/stacks/migration.js)_

package/package.json

@@ -1,11 +1,11 @@
 {
   "name": "@contentstack/cli-migration",
-  "version": "2.0.0-beta",
+  "version": "2.0.0-beta.2",
   "author": "@contentstack",
   "bugs": "https://github.com/contentstack/cli/issues",
   "dependencies": {
-    "@contentstack/cli-command": "~1.6.1",
-    "@contentstack/cli-utilities": "~1.15.0",
+    "@contentstack/cli-command": "~1.7.02",
+    "@contentstack/cli-utilities": "~1.17.0",
     "@oclif/core": "^4.3.0",
     "@oclif/plugin-help": "^6.2.28",
     "async": "^3.2.6",
@@ -22,9 +22,12 @@
     "eslint": "^8.57.1",
     "eslint-config-oclif": "^6.0.62",
     "jsdoc-to-markdown": "^8.0.3",
+    "mocha": "^10.8.2",
     "nock": "^13.5.6",
     "nyc": "^15.1.0",
-    "oclif": "^4.17.46"
+    "oclif": "^4.17.46",
+    "sinon": "^19.0.5",
+    "sinon-chai": "^3.7.0"
   },
   "engines": {
     "node": ">=8.3.0"
@@ -55,12 +58,8 @@
     "clean": "rm -rf ./node_modules tsconfig.build.tsbuildinfo"
   },
   "csdxConfig": {
-    "expiredCommands": {
-      "cm:migration": "csdx cm:stacks:migration"
-    },
     "shortCommandName": {
-      "cm:stacks:migration": "MGRTN",
-      "cm:migration": "O-MGRTN"
+      "cm:stacks:migration": "MGRTN"
     }
   }
 }

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

@@ -14,7 +14,6 @@ const fs = require('fs');
 const chalk = require('chalk');
 const isEmpty = require('lodash/isEmpty');
 const {
-  printFlagDeprecation,
   managementSDKClient,
   flags,
   isAuthenticated,
@@ -41,12 +40,12 @@ const {
 
 class MigrationCommand extends Command {
   static 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 --file-path <migration/script/file/path> --stack-api-key <stack-api-key>',
+    '$ csdx cm:migration --file-path <migration/script/file/path> --stack-api-key <stack-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>',
+    '$ csdx cm:migration --alias <management-token-alias> --file-path <migration/script/file/path>',
   ];
 
   async run() {
@@ -246,69 +245,37 @@ MigrationCommand.description = 'Contentstack migration script.';
 MigrationCommand.flags = {
   'stack-api-key': flags.string({
     char: 'k',
-    description: 'Use this flag to add the API key of your stack. You must use either the --stack-api-key flag or the --alias flag.',
+    description:
+      'Use this flag to add the API key of your stack. You must use either the --stack-api-key flag or the --alias flag.',
     exclusive: ['alias'],
   }),
   alias: flags.string({
     char: 'a',
-    description: 'Use this flag to add the management token alias. You must use either the --alias flag or the --stack-api-key flag.',
+    description:
+      'Use this flag to add the management token alias. You must use either the --alias flag or the --stack-api-key flag.',
+    exclusive: ['stack-api-key'],
   }),
   'file-path': flags.string({
     description: 'Use this flag to provide the path of the file of the migration script.',
   }),
   branch: flags.string({
-    char: 'B',
     description: 'Use this flag to add the branch name where you want to perform the migration. (target branch name)',
-    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>. Passing an external configuration makes the script re-usable.',
+    description:
+      '[optional] Inline configuration, <key1>:<value1>. Passing an external configuration makes the script re-usable.',
     multiple: true,
   }),
   multiple: flags.boolean({
-    description: 'This flag helps you to migrate multiple content files in a single instance. Mention the folder path where your migration script files are stored.',
-  }),
-
-  // 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',
-    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.',
-    dependsOn: ['api-key'],
-    exclusive: ['alias'],
-    parse: printFlagDeprecation(['-A', '--authtoken']),
-    hidden: true,
-  }),
-  'management-token-alias': flags.string({
-    description: 'Alias of the management token.',
-    exclusive: ['authtoken'],
-    hidden: true,
-    parse: printFlagDeprecation(['--management-token-alias'], ['-a', '--alias']),
-  }),
-  filePath: flags.string({
-    char: 'n',
-    description: 'Use this flag to provide the path of the file of the migration script provided by the user.',
-    parse: printFlagDeprecation(['-n', '--filePath'], ['--file-path']),
-    hidden: true,
-  }),
-  multi: flags.boolean({
-    description: 'This flag helps you to migrate multiple content files in a single instance.',
-    parse: printFlagDeprecation(['--multi'], ['--multiple']),
-    hidden: true,
+    description:
+      'This flag helps you to migrate multiple content files in a single instance. Mention the folder path where your migration script files are stored.',
   }),
 };
 
-MigrationCommand.aliases = ['cm:migration'];
+MigrationCommand.aliases = [];
 
 MigrationCommand.usage =
   'cm:stacks:migration [-k <value>] [-a <value>] [--file-path <value>] [--branch <value>] [--config-file <value>] [--config <value>] [--multiple]';

package/src/modules/fields.js

@@ -59,9 +59,9 @@ class Field extends Base {
    *   .data_type('text')
    *   .mandatory(false);
    * };
-   * 
+   *
    * Create a taxonomy field
-   * 
+   *
    *  module.exports =({ migration })=> {
    *  const blog = migration.editContentType('blog');
    *
@@ -333,6 +333,7 @@ class Field extends Base {
     allKeys.forEach((_key) => {
       this.buildSchema(_key, field, opts[_key]);
     });
+    return this;
   }
 }