@contentstack/cli-migration 0.1.1-beta.1 → 1.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 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
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,8 +1,6 @@
-@contentstack/cli-migration
-===========================
-
-The Contentstack CLI’s “Migration” plugin allows developers to automate the content migration process and easily migrate your content from your system to Contentstack. 
+# @contentstack/cli-migration
 
+The Contentstack CLI’s “Migration” plugin allows developers to automate the content migration process and easily migrate your content from your system to Contentstack.
 
 [![oclif](https://img.shields.io/badge/cli-oclif-brightgreen.svg)](https://oclif.io)
 [![Version](https://img.shields.io/npm/v/@contentstack/cli-migration.svg)](https://npmjs.org/package/@contentstack/cli-migration)
@@ -10,60 +8,70 @@ The Contentstack CLI’s “Migration” plugin allows developers to automate th
 [![License](https://img.shields.io/npm/l/@contentstack/cli-migration.svg)](https://github.com/ninadhatkar/cli-migration/blob/master/package.json)
 
 <!-- toc -->
+* [@contentstack/cli-migration](#contentstackcli-migration)
 * [Usage](#usage)
 * [Commands](#commands)
 <!-- tocstop -->
+
 # Usage
+
 <!-- usage -->
 ```sh-session
 $ npm install -g @contentstack/cli-migration
 $ csdx COMMAND
 running command...
 $ csdx (-v|--version|version)
-@contentstack/cli-migration/0.1.1-beta.1 linux-x64 node-v12.18.4
+@contentstack/cli-migration/1.0.0 linux-x64 node-v16.14.2
 $ csdx --help [COMMAND]
 USAGE
   $ csdx COMMAND
 ...
 ```
 <!-- usagestop -->
+
 # Commands
+
 <!-- commands -->
-* [`csdx cm:migration`](#csdx-cmmigration)
+* [`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:migration`
+## `csdx cm:stacks:migration [-k <value>] [-a <value>] [--file-path <value>] [--branch <value>] [--config-file <value>] [--config <value>] [--multiple]`
 
 Contentstack migration script.
 
 ```
-Contentstack migration script.
-
 USAGE
-  $ csdx cm:migration
+  $ csdx cm:stacks:migration [-k <value>] [-a <value>] [--file-path <value>] [--branch <value>] [--config-file <value>] 
+  [--config <value>] [--multiple]
 
 OPTIONS
-  -A, --authtoken                                      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.
+  -B, --branch=branch                Use this flag to add the branch name where you want to perform the migration.
+  -a, --alias=alias                  Use this flag to add the management token alias.
+  -k, --stack-api-key=stack-api-key  With this flag add the API key of your stack.
+  --config=config                    [optional] inline configuration, <key1>:<value1>
+  --config-file=config-file          [optional] Path of the JSON configuration file
 
-  -B, --branch=branch                                  Use this flag to add the branch name where you want to perform
-                                                       the migration.
+  --file-path=file-path              Use this flag to provide the path of the file of the migration script provided by
+                                     the user.
 
-  -a, --management-token-alias=management-token-alias  Use this flag to add the management token alias.
+  --multiple                         This flag helps you to migrate multiple content files in a single instance.
 
-  -k, --api-key=api-key                                With this flag add the API key of your stack.
-
-  -n, --filePath=filePath                              Use this flag to provide the path of the file of the migration
-                                                       script provided by the user.
+ALIASES
+  $ csdx cm:migration
 
-  --multi                                              This flag helps you to migrate multiple content files in a single
-                                                       instance.
+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>
 ```
 
-_See code: [src/commands/cm/migration.js](https://github.com/contentstack/cli-migration/blob/v0.1.1-beta.1/src/commands/cm/migration.js)_
+_See code: [src/commands/cm/stacks/migration.js](https://github.com/contentstack/cli-migration/blob/v1.0.0/src/commands/cm/stacks/migration.js)_
 <!-- commandsstop -->
 
 ### 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, 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/)

package/oclif.manifest.json

@@ -1 +1 @@
-{"version":"0.1.1-beta.1","commands":{"cm:migration":{"id":"cm:migration","description":"Contentstack migration script.","pluginName":"@contentstack/cli-migration","pluginType":"core","aliases":[],"flags":{"api-key":{"name":"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.","allowNo":false},"management-token-alias":{"name":"management-token-alias","type":"option","char":"a","description":"Use this flag to add the management token alias."},"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."},"branch":{"name":"branch","type":"option","char":"B","description":"Use this flag to add the branch name where you want to perform the migration."},"multi":{"name":"multi","type":"boolean","description":"This flag helps you to migrate multiple content files in a single instance.","allowNo":false}},"args":[]}}}
+{"version":"1.0.0","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":[]}}}

package/package.json

@@ -1,29 +1,29 @@
 {
   "name": "@contentstack/cli-migration",
-  "version": "0.1.1-beta.1",
+  "version": "1.0.0",
   "author": "@contentstack",
   "bugs": "https://github.com/contentstack/cli/issues",
   "dependencies": {
-    "@contentstack/cli-command": "^0.1.1-beta.2",
-    "@contentstack/management": "github:contentstack/contentstack-management-javascript#65e8588",
-    "@oclif/command": "^1.6.1",
-    "@oclif/config": "^1.15.1",
-    "async": "^3.2.0",
-    "axios": "^0.21.1",
+    "@contentstack/cli-command": "^1.0.0",
+    "@contentstack/management": "^1.3.0",
+    "@contentstack/cli-utilities": "^1.0.0",
+    "@oclif/command": "^1.8.16",
+    "@oclif/config": "^1.18.3",
+    "async": "^3.2.4",
     "callsites": "^3.1.0",
     "cardinal": "^2.1.1",
     "chalk": "^4.1.0",
     "dot-object": "^2.1.4",
     "dotenv": "^8.2.0",
     "listr": "^0.14.3",
-    "winston": "^3.3.3"
+    "winston": "^3.7.2"
   },
   "devDependencies": {
     "@oclif/dev-cli": "^1.26.0",
-    "@oclif/plugin-help": "^2.2.3",
+    "@oclif/plugin-help": "^5.1.12",
     "@oclif/test": "^1.2.8",
     "chai": "^4.3.4",
-    "eslint": "^5.16.0",
+    "eslint": "^8.18.0",
     "eslint-config-oclif": "^3.1.0",
     "eslint-config-oclif-typescript": "^0.2.0",
     "globby": "^10.0.2",
@@ -31,7 +31,7 @@
     "jsdoc": "^3.6.7",
     "jsdoc-to-markdown": "^7.0.1",
     "mkdirp": "^1.0.4",
-    "mocha": "^5.2.0",
+    "mocha": "^10.0.0",
     "nock": "^13.1.1",
     "nyc": "^14.1.1"
   },
@@ -64,5 +64,10 @@
     "prepack": "oclif-dev manifest && oclif-dev readme && npm run generate-api-ref-md-doc",
     "test": "nyc mocha \"test/**/*.test.js\"",
     "version": "oclif-dev readme && git add README.md"
+  },
+  "csdxConfig": {
+    "expiredCommands": {
+      "cm:migration": "csdx cm:stacks:migration"
+    }
   }
-}
+}

package/src/actions/action-list.js

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

package/src/actions/index.js

@@ -1,9 +1,9 @@
-'use strict'
+'use strict';
 
 // Utils
-const {constants} = require('../utils')
+const { constants } = require('../utils');
 // Properties
-const {actions, validationAction} = constants
+const { actions, validationAction } = constants;
 const {
   create,
   customTask,
@@ -16,11 +16,11 @@ const {
   schema,
   __migrationError,
   field,
-} = validationAction
+} = validationAction;
 
 const actionCreators = {
   customTasks: (callsite, opts) => {
-    const {CUSTOM_TASK} = actions
+    const { CUSTOM_TASK } = actions;
     return {
       type: customTask,
       meta: {
@@ -33,11 +33,11 @@ const actionCreators = {
         options: opts,
         action: CUSTOM_TASK,
       },
-    }
+    };
   },
   contentType: {
     create: (callsite, id, opts) => {
-      const {CREATE_CT} = actions
+      const { CREATE_CT } = actions;
       return {
         type: create,
         meta: {
@@ -51,10 +51,10 @@ const actionCreators = {
           options: opts,
           action: CREATE_CT,
         },
-      }
+      };
     },
     edit: (callsite, id, opts) => {
-      const {EDIT_CT} = actions
+      const { EDIT_CT } = actions;
 
       return {
         type: edit,
@@ -69,7 +69,7 @@ const actionCreators = {
           options: opts,
           action: EDIT_CT,
         },
-      }
+      };
     },
     // delete: () => { },
     transformEntries: (callsite, id, opts) => {
@@ -84,7 +84,7 @@ const actionCreators = {
         payload: {
           options: opts,
         },
-      }
+      };
     },
     deriveLinkedEntries: (callsite, id, opts) => {
       return {
@@ -98,7 +98,7 @@ const actionCreators = {
         payload: {
           options: opts,
         },
-      }
+      };
     },
     transformEntriesToType: (callsite, id, opts) => {
       return {
@@ -112,9 +112,9 @@ const actionCreators = {
         payload: {
           options: opts,
         },
-      }
+      };
     },
-    typeError: (callsite, id, {typeErrors}) => {
+    typeError: (callsite, id, { typeErrors }) => {
       return {
         type: typeError,
         meta: {
@@ -123,8 +123,8 @@ const actionCreators = {
             line: callsite.getLineNumber(),
           },
         },
-        payload: {typeErrors},
-      }
+        payload: { typeErrors },
+      };
     },
     apiError: (callsite, id, opts) => {
       return {
@@ -135,8 +135,8 @@ const actionCreators = {
             line: callsite.getLineNumber(),
           },
         },
-        payload: {apiError: opts},
-      }
+        payload: { apiError: opts },
+      };
     },
     fromFields: (callsite, id, opts) => {
       return {
@@ -147,8 +147,8 @@ const actionCreators = {
             line: callsite.getLineNumber(),
           },
         },
-        payload: {fromField: opts.fromField},
-      }
+        payload: { fromField: opts.fromField },
+      };
     },
     toFields: (callsite, id, opts) => {
       return {
@@ -159,8 +159,8 @@ const actionCreators = {
             line: callsite.getLineNumber(),
           },
         },
-        payload: {toField: opts.toField},
-      }
+        payload: { toField: opts.toField },
+      };
     },
     toReferenceFields: (callsite, id, opts) => {
       return {
@@ -171,8 +171,8 @@ const actionCreators = {
             line: callsite.getLineNumber(),
           },
         },
-        payload: {toField: opts.toReferenceField},
-      }
+        payload: { toField: opts.toReferenceField },
+      };
     },
     deriveFields: (callsite, id, opts) => {
       return {
@@ -183,8 +183,8 @@ const actionCreators = {
             line: callsite.getLineNumber(),
           },
         },
-        payload: {deriveField: opts.deriveField},
-      }
+        payload: { deriveField: opts.deriveField },
+      };
     },
     migrationError: (callsite, id, opts) => {
       return {
@@ -195,8 +195,8 @@ const actionCreators = {
             line: callsite.getLineNumber(),
           },
         },
-        payload: {migrationError: opts},
-      }
+        payload: { migrationError: opts },
+      };
     },
     field: (callsite, id, opts) => {
       return {
@@ -207,12 +207,11 @@ const actionCreators = {
             line: callsite.getLineNumber(),
           },
         },
-        payload: {field: opts},
-      }
+        payload: { field: opts },
+      };
     },
-
   },
-}
+};
 
-exports.actionCreators = actionCreators
-exports.ActionList = require('./action-list')
+exports.actionCreators = actionCreators;
+exports.ActionList = require('./action-list');