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

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.1 darwin-arm64 node-v24.12.0
+@contentstack/cli-migration/2.0.0-beta.4 darwin-arm64 node-v24.12.0
 $ csdx --help [COMMAND]
 USAGE
   $ csdx COMMAND
@@ -33,6 +33,50 @@ 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
+  -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.
+      --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 <management-token-alias> --file-path <migration/script/file/path>
+```
 
 ## `csdx cm:stacks:migration [-k <value>] [-a <value>] [--file-path <value>] [--branch <value>] [--config-file <value>] [--config <value>] [--multiple]`
 
@@ -60,10 +104,13 @@ FLAGS
 DESCRIPTION
   Contentstack migration script.
 
+ALIASES
+  $ csdx cm:migration
+
 EXAMPLES
-  $ 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>
 
-  $ csdx cm:migration --file-path <migration/script/file/path> --stack-api-key <stack-api-key> --branch <target branch name>
+  $ 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>
 
@@ -74,7 +121,7 @@ EXAMPLES
   $ 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)_
+_See code: [src/commands/cm/stacks/migration.ts](https://github.com/contentstack/cli/blob/main/packages/contentstack-migration/src/commands/cm/stacks/migration.ts)_
 <!-- commandsstop -->
 
 ### Points to remember

package/package.json

@@ -1,11 +1,11 @@
 {
   "name": "@contentstack/cli-migration",
-  "version": "2.0.0-beta.2",
+  "version": "2.0.0-beta.4",
   "author": "@contentstack",
   "bugs": "https://github.com/contentstack/cli/issues",
   "dependencies": {
-    "@contentstack/cli-command": "~1.7.02",
-    "@contentstack/cli-utilities": "~1.17.0",
+    "@contentstack/cli-command": "~1.7.2",
+    "@contentstack/cli-utilities": "~1.17.2",
     "@oclif/core": "^4.3.0",
     "@oclif/plugin-help": "^6.2.28",
     "async": "^3.2.6",
@@ -18,6 +18,8 @@
   },
   "devDependencies": {
     "@oclif/test": "^4.1.13",
+    "@types/mocha": "^8.2.3",
+    "@types/node": "^14.18.63",
     "chai": "^4.5.0",
     "eslint": "^8.57.1",
     "eslint-config-oclif": "^6.0.62",
@@ -26,17 +28,18 @@
     "nock": "^13.5.6",
     "nyc": "^15.1.0",
     "oclif": "^4.17.46",
-    "sinon": "^19.0.5",
-    "sinon-chai": "^3.7.0"
+    "sinon": "^21.0.1",
+    "source-map-support": "^0.5.21",
+    "ts-node": "^10.9.2",
+    "typescript": "^4.9.5"
   },
   "engines": {
     "node": ">=8.3.0"
   },
   "files": [
+    "/lib",
     "/npm-shrinkwrap.json",
-    "/oclif.manifest.json",
-    "/src",
-    "/yarn.lock"
+    "/oclif.manifest.json"
   ],
   "homepage": "https://github.com/contentstack/cli",
   "keywords": [
@@ -44,16 +47,20 @@
   ],
   "license": "MIT",
   "oclif": {
-    "commands": "./src/commands",
+    "commands": "./lib/commands",
     "bin": "csdx",
     "repositoryPrefix": "<%- repo %>/blob/main/packages/contentstack-migration/<%- commandPath %>"
   },
   "repository": "contentstack/cli",
   "scripts": {
     "postpack": "rm -f oclif.manifest.json",
-    "generate-api-ref-md-doc": "nyc jsdoc2md ./src/modules/* > ./docs/api-reference.md",
-    "prepack": "oclif manifest && oclif readme && pnpm generate-api-ref-md-doc",
-    "test": "nyc mocha --timeout 3000 \"test/**/*.test.js\"",
+    "generate-api-ref-md-doc": "nyc jsdoc2md ./src/modules/*.ts > ./docs/api-reference.md || true",
+    "compile": "tsc -b tsconfig.json",
+    "prepack": "pnpm compile && oclif manifest && oclif readme",
+    "pretest": "tsc -p test",
+    "test": "mocha --forbid-only \"test/unit/**/*.test.ts\"",
+    "test:unit": "mocha --timeout 10000 --forbid-only \"test/unit/**/*.test.ts\"",
+    "test:unit:report": "nyc --extension .ts mocha --forbid-only \"test/unit/**/*.test.ts\"",
     "version": "oclif readme && git add README.md",
     "clean": "rm -rf ./node_modules tsconfig.build.tsbuildinfo"
   },
@@ -62,4 +69,4 @@
       "cm:stacks:migration": "MGRTN"
     }
   }
-}
+}

package/src/actions/action-list.js

@@ -1,32 +0,0 @@
-/* eslint-disable no-unused-expressions */
-'use strict';
-
-class ActionList {
-  constructor(actionList, typeErrors) {
-    typeErrors && (this.typeErrors = typeErrors);
-    actionList && (this.actionList = actionList);
-    this.validators = [];
-  }
-
-  addValidators(validator) {
-    this.validators.push(validator);
-  }
-
-  validate() {
-    const { validators, actionList } = this;
-
-    let errors = [];
-    for (const action of actionList) {
-      for (const validator of validators) {
-        if (validator.isApplicable(action)) {
-          errors = validator.validate(action);
-          break;
-        }
-      }
-    }
-
-    return errors;
-  }
-}
-
-module.exports = ActionList;

package/src/actions/index.js

@@ -1,217 +0,0 @@
-'use strict';
-
-// Utils
-const { constants } = require('../utils');
-// Properties
-const { actions, validationAction } = constants;
-const {
-  create,
-  customTask,
-  edit,
-  transformEntries,
-  deriveLinkedEntries,
-  transformEntriesToType,
-  typeError,
-  apiError,
-  schema,
-  __migrationError,
-  field,
-} = validationAction;
-
-const actionCreators = {
-  customTasks: (callsite, opts) => {
-    const { CUSTOM_TASK } = actions;
-    return {
-      type: customTask,
-      meta: {
-        callsite: {
-          file: callsite.getFileName(),
-          line: callsite.getLineNumber(),
-        },
-      },
-      payload: {
-        options: opts,
-        action: CUSTOM_TASK,
-      },
-    };
-  },
-  contentType: {
-    create: (callsite, id, opts) => {
-      const { CREATE_CT } = actions;
-      return {
-        type: create,
-        meta: {
-          callsite: {
-            file: callsite.getFileName(),
-            line: callsite.getLineNumber(),
-          },
-        },
-        payload: {
-          contentTypeId: id,
-          options: opts,
-          action: CREATE_CT,
-        },
-      };
-    },
-    edit: (callsite, id, opts) => {
-      const { EDIT_CT } = actions;
-
-      return {
-        type: edit,
-        meta: {
-          callsite: {
-            file: callsite.getFileName(),
-            line: callsite.getLineNumber(),
-          },
-        },
-        payload: {
-          contentTypeId: id,
-          options: opts,
-          action: EDIT_CT,
-        },
-      };
-    },
-    // delete: () => { },
-    transformEntries: (callsite, id, opts) => {
-      return {
-        type: transformEntries,
-        meta: {
-          callsite: {
-            file: callsite.getFileName(),
-            line: callsite.getLineNumber(),
-          },
-        },
-        payload: {
-          options: opts,
-        },
-      };
-    },
-    deriveLinkedEntries: (callsite, id, opts) => {
-      return {
-        type: deriveLinkedEntries,
-        meta: {
-          callsite: {
-            file: callsite.getFileName(),
-            line: callsite.getLineNumber(),
-          },
-        },
-        payload: {
-          options: opts,
-        },
-      };
-    },
-    transformEntriesToType: (callsite, id, opts) => {
-      return {
-        type: transformEntriesToType,
-        meta: {
-          callsite: {
-            file: callsite.getFileName(),
-            line: callsite.getLineNumber(),
-          },
-        },
-        payload: {
-          options: opts,
-        },
-      };
-    },
-    typeError: (callsite, id, { typeErrors }) => {
-      return {
-        type: typeError,
-        meta: {
-          callsite: {
-            file: callsite.getFileName(),
-            line: callsite.getLineNumber(),
-          },
-        },
-        payload: { typeErrors },
-      };
-    },
-    apiError: (callsite, id, opts) => {
-      return {
-        type: apiError,
-        meta: {
-          callsite: {
-            file: callsite.getFileName(),
-            line: callsite.getLineNumber(),
-          },
-        },
-        payload: { apiError: opts },
-      };
-    },
-    fromFields: (callsite, id, opts) => {
-      return {
-        type: schema,
-        meta: {
-          callsite: {
-            file: callsite.getFileName(),
-            line: callsite.getLineNumber(),
-          },
-        },
-        payload: { fromField: opts.fromField },
-      };
-    },
-    toFields: (callsite, id, opts) => {
-      return {
-        type: schema,
-        meta: {
-          callsite: {
-            file: callsite.getFileName(),
-            line: callsite.getLineNumber(),
-          },
-        },
-        payload: { toField: opts.toField },
-      };
-    },
-    toReferenceFields: (callsite, id, opts) => {
-      return {
-        type: schema,
-        meta: {
-          callsite: {
-            file: callsite.getFileName(),
-            line: callsite.getLineNumber(),
-          },
-        },
-        payload: { toField: opts.toReferenceField },
-      };
-    },
-    deriveFields: (callsite, id, opts) => {
-      return {
-        type: schema,
-        meta: {
-          callsite: {
-            file: callsite.getFileName(),
-            line: callsite.getLineNumber(),
-          },
-        },
-        payload: { deriveField: opts.deriveField },
-      };
-    },
-    migrationError: (callsite, id, opts) => {
-      return {
-        type: __migrationError,
-        meta: {
-          callsite: {
-            file: callsite.getFileName(),
-            line: callsite.getLineNumber(),
-          },
-        },
-        payload: { migrationError: opts },
-      };
-    },
-    field: (callsite, id, opts) => {
-      return {
-        type: field,
-        meta: {
-          callsite: {
-            file: callsite.getFileName(),
-            line: callsite.getLineNumber(),
-          },
-        },
-        payload: { field: opts },
-      };
-    },
-  },
-};
-
-exports.actionCreators = actionCreators;
-exports.ActionList = require('./action-list');

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

@@ -1,283 +0,0 @@
-/* eslint-disable no-unused-expressions */
-/* eslint-disable no-warning-comments */
-/* eslint-disable camelcase */
-'use strict';
-
-// Dependencies
-const Listr = require('listr');
-const { resolve, extname } = require('path');
-const { Command } = require('@contentstack/cli-command');
-const { waterfall } = require('async');
-const { Parser } = require('../../../modules');
-const { ActionList } = require('../../../actions');
-const fs = require('fs');
-const chalk = require('chalk');
-const isEmpty = require('lodash/isEmpty');
-const {
-  managementSDKClient,
-  flags,
-  isAuthenticated,
-  pathValidator,
-  sanitizePath,
-} = require('@contentstack/cli-utilities');
-
-const { ApiError, SchemaValidator, MigrationError, FieldValidator } = require('../../../validators');
-
-// Utils
-const { map: _map, constants, safePromise, errorHelper, installModules } = require('../../../utils');
-// Properties
-const { get, set, getMapInstance, resetMapInstance } = _map;
-const {
-  requests: _requests,
-  actionMapper,
-  MANAGEMENT_SDK,
-  MANAGEMENT_TOKEN,
-  AUTH_TOKEN,
-  API_KEY,
-  BRANCH,
-  MANAGEMENT_CLIENT,
-} = constants;
-
-class MigrationCommand extends Command {
-  static examples = [
-    '$ 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 <management-token-alias> --file-path <migration/script/file/path>',
-  ];
-
-  async run() {
-    // TODO: filePath validation required.
-    const { flags: migrationCommandFlags } = await this.parse(MigrationCommand);
-    const { branch } = migrationCommandFlags || {};
-    const filePath = migrationCommandFlags['file-path'] || migrationCommandFlags.filePath;
-    const multi = migrationCommandFlags.multiple || migrationCommandFlags.multi;
-    const authtoken = isAuthenticated();
-    const apiKey = migrationCommandFlags['api-key'] || migrationCommandFlags['stack-api-key'];
-    const alias = migrationCommandFlags['alias'] || migrationCommandFlags['management-token-alias'];
-    const config = migrationCommandFlags['config'];
-
-    if (!authtoken && !alias) {
-      this.log(
-        "AuthToken is not present in local drive, Hence use 'csdx auth:login' command for login or provide management token alias",
-      );
-      this.exit();
-    }
-
-    if (!filePath || !fs.existsSync(filePath)) {
-      this.log('Please provide the migration script file path, use --file-path flag');
-      this.exit();
-    }
-
-    // Reset map instance
-    const mapInstance = getMapInstance();
-    resetMapInstance(mapInstance);
-    if (migrationCommandFlags['config-file']) {
-      set('config-path', mapInstance, migrationCommandFlags['config-file']);
-    }
-
-    if (Array.isArray(config) && config.length > 0) {
-      let configObj = config.reduce((a, v) => {
-        //NOTE: Temp code to handle only one spilt(Window absolute path issue).Need to replace with hardcoded config key
-        let [key, ...value] = v.split(':');
-        value = value?.length > 1 ? value?.join(':') : value?.join();
-        return { ...a, [key]: value };
-      }, {});
-      set('config', mapInstance, configObj);
-    }
-
-    const APIClient = await managementSDKClient({ host: this.cmaHost });
-    let stackSDKInstance;
-    if (branch) {
-      set(BRANCH, mapInstance, branch);
-    }
-
-    if (alias) {
-      let managementToken = this.getToken(alias);
-      if (managementToken) {
-        set(MANAGEMENT_TOKEN, mapInstance, managementToken);
-        set(API_KEY, mapInstance, managementToken.apiKey);
-        if (branch) {
-          stackSDKInstance = APIClient.stack({
-            management_token: managementToken.token,
-            api_key: managementToken.apiKey,
-            branch_uid: branch,
-          });
-        } else {
-          stackSDKInstance = APIClient.stack({
-            management_token: managementToken.token,
-            api_key: managementToken.apiKey,
-          });
-        }
-      }
-    } else if (authtoken) {
-      set(AUTH_TOKEN, mapInstance, authtoken);
-      set(API_KEY, mapInstance, apiKey);
-      if (branch) {
-        stackSDKInstance = APIClient.stack({
-          api_key: apiKey,
-          branch_uid: branch,
-        });
-      } else {
-        stackSDKInstance = APIClient.stack({ api_key: apiKey });
-      }
-    }
-
-    set(MANAGEMENT_SDK, mapInstance, stackSDKInstance);
-    set(MANAGEMENT_CLIENT, mapInstance, APIClient);
-
-    if (!(await installModules(filePath, multi))) {
-      this.log(`Error: Failed to install dependencies for the specified scripts.`);
-      process.exit(1);
-    }
-
-    if (multi) {
-      await this.execMultiFiles(filePath, mapInstance);
-    } else {
-      await this.execSingleFile(filePath, mapInstance);
-    }
-    const errLogPath = `${process.cwd()}/migration-logs`;
-    if (fs.existsSync(errLogPath)) {
-      this.log(`The log has been stored at: `, errLogPath);
-    }
-  }
-
-  async execSingleFile(filePath, mapInstance) {
-    // Resolved absolute path
-    const resolvedMigrationPath = pathValidator(filePath);
-    // User provided migration function
-    const migrationFunc = require(resolvedMigrationPath);
-
-    const parser = new Parser();
-
-    try {
-      const migrationParser = await parser.getMigrationParser(migrationFunc);
-      if (migrationParser.hasErrors) {
-        errorHelper(migrationParser.hasErrors);
-        // When the process is child, send error message to parent
-        if (process.send) process.send({ errorOccurred: true });
-        this.exit(1);
-      }
-
-      // Make calls from here
-      const requests = get(_requests, mapInstance);
-      // Fetches tasks array
-      const tasks = this.getTasks(requests);
-
-      const listr = new Listr(tasks);
-
-      await listr.run();
-      requests.splice(0, requests.length);
-    } catch (error) {
-      errorHelper(error, filePath);
-      if (process.send) process.send({ errorOccurred: true });
-    }
-  }
-
-  async execMultiFiles(filePath, mapInstance) {
-    // Resolved absolute path
-    const resolvedMigrationPath = pathValidator(filePath);
-    try {
-      const files = fs.readdirSync(resolvedMigrationPath);
-      for (const element of files) {
-        const file = element;
-        if (extname(file) === '.js') {
-          // eslint-disable-next-line no-await-in-loop
-          await this.execSingleFile(pathValidator(resolve(sanitizePath(filePath), sanitizePath(file))), mapInstance);
-        }
-      }
-    } catch (error) {
-      errorHelper(error);
-    }
-  }
-
-  getTasks(requests) {
-    const _tasks = [];
-    const results = [];
-
-    const taskFn = (reqObj) => {
-      const { failedTitle, successTitle, tasks } = reqObj;
-
-      return async (ctx, task) => {
-        const [err, result] = await safePromise(waterfall(tasks));
-        if (err) {
-          ctx.error = true;
-          task.title = failedTitle;
-          throw err;
-        }
-        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),
-      };
-      _tasks.push(taskObj);
-    }
-    return _tasks;
-  }
-
-  handleErrors() {
-    const mapInstance = getMapInstance();
-    const actions = get(actionMapper, mapInstance);
-    const actionList = new ActionList(actions);
-
-    actionList.addValidators(new ApiError());
-    actionList.addValidators(new SchemaValidator());
-    actionList.addValidators(new MigrationError());
-    actionList.addValidators(new FieldValidator());
-
-    const errors = actionList.validate();
-    errorHelper(errors);
-  }
-}
-
-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.',
-    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.',
-    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({
-    description: 'Use this flag to add the branch name where you want to perform the migration. (target branch name)',
-  }),
-  '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.',
-    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.',
-  }),
-};
-
-MigrationCommand.aliases = [];
-
-MigrationCommand.usage =
-  'cm:stacks:migration [-k <value>] [-a <value>] [--file-path <value>] [--branch <value>] [--config-file <value>] [--config <value>] [--multiple]';
-
-module.exports = MigrationCommand;