@contentstack/cli-migration 0.1.1-beta.2 → 0.1.1-beta.3

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,24 +8,29 @@ 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.2 linux-x64 node-v12.22.7
+@contentstack/cli-migration/0.1.1-beta.3 linux-x64 node-v16.14.2
 $ csdx --help [COMMAND]
 USAGE
   $ csdx COMMAND
 ...
 ```
 <!-- usagestop -->
+
 # Commands
+
 <!-- commands -->
 * [`csdx cm:migration`](#csdx-cmmigration)
 
@@ -36,8 +39,6 @@ USAGE
 Contentstack migration script.
 
 ```
-Contentstack migration script.
-
 USAGE
   $ csdx cm:migration
 
@@ -55,15 +56,27 @@ OPTIONS
   -n, --filePath=filePath                              Use this flag to provide the path of the file of the migration
                                                        script provided by the user.
 
+  --config=config                                      [optional] inline configuration, <key1>:<value1>
+
+  --config-file=config-file                            [optional] Path of the JSON configuration file
+
   --multi                                              This flag helps you to migrate multiple content files in a single
                                                        instance.
+
+EXAMPLES
+  $ csdx cm:migration -A -n <migration/script/file/path> -k <api-key>
+  $ csdx cm:migration -A -n <migration/script/file/path> -k <api-key> -B <target branch name>
+  $ csdx cm:migration --config <key1>:<value1> <key2>:<value2> ... -n <migration/script/file/path>
+  $ csdx cm:migration --config-file <path/to/json/config/file> -n <migration/script/file/path>
+  $ csdx cm:migration --multi -n <migration/scripts/dir/path> 
+  $ csdx cm:migration -a -n <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.2/src/commands/cm/migration.js)_
+_See code: [src/commands/cm/migration.js](https://github.com/contentstack/cli-migration/blob/v0.1.1-beta.3/src/commands/cm/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.2","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":"0.1.1-beta.3","commands":{"cm:migration":{"id":"cm:migration","description":"Contentstack migration script.","pluginName":"@contentstack/cli-migration","pluginType":"core","aliases":[],"examples":["$ csdx cm:migration -A -n <migration/script/file/path> -k <api-key>","$ csdx cm:migration -A -n <migration/script/file/path> -k <api-key> -B <target branch name>","$ csdx cm:migration --config <key1>:<value1> <key2>:<value2> ... -n <migration/script/file/path>","$ csdx cm:migration --config-file <path/to/json/config/file> -n <migration/script/file/path>","$ csdx cm:migration --multi -n <migration/scripts/dir/path> ","$ csdx cm:migration -a -n <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."},"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."},"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.","allowNo":false}},"args":[]}}}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@contentstack/cli-migration",
-  "version": "0.1.1-beta.2",
+  "version": "0.1.1-beta.3",
   "author": "@contentstack",
   "bugs": "https://github.com/contentstack/cli/issues",
   "dependencies": {
@@ -65,4 +65,4 @@
     "test": "nyc mocha \"test/**/*.test.js\"",
     "version": "oclif-dev readme && git add README.md"
   }
-}
+}

package/src/commands/cm/migration.js

@@ -1,109 +1,165 @@
 /* eslint-disable no-unused-expressions */
 /* eslint-disable no-warning-comments */
 /* eslint-disable camelcase */
-'use strict'
+"use strict";
 
 // Dependencies
-const Listr = require('listr')
-const {resolve, extname} = require('path')
-const {Command, flags} = 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 Listr = require("listr");
+const { resolve, extname } = require("path");
+const { Command, flags } = 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 {ApiError, SchemaValidator, MigrationError, FieldValidator} = require('../../validators')
+const {
+  ApiError,
+  SchemaValidator,
+  MigrationError,
+  FieldValidator,
+} = require("../../validators");
 
 // Utils
-const {map: _map, constants, safePromise, errorHelper} = require('../../utils')
-const {success} = require('../../utils/logger')
+const {
+  map: _map,
+  constants,
+  safePromise,
+  errorHelper,
+} = require("../../utils");
+const { success } = require("../../utils/logger");
 
 // Properties
-const {get, set, getMapInstance, resetMapInstance} = _map
-const {requests: _requests, actionMapper, MANAGEMENT_SDK, MANAGEMENT_TOKEN, AUTH_TOKEN, API_KEY, BRANCH} = constants
+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 -A -n <migration/script/file/path> -k <api-key>",
+    "$ csdx cm:migration -A -n <migration/script/file/path> -k <api-key> -B <target branch name>",
+    "$ csdx cm:migration --config <key1>:<value1> <key2>:<value2> ... -n <migration/script/file/path>",
+    "$ csdx cm:migration --config-file <path/to/json/config/file> -n <migration/script/file/path>",
+    "$ csdx cm:migration --multi -n <migration/scripts/dir/path> ",
+    "$ csdx cm:migration -a -n <migration/script/file/path> -k <api-key>",
+  ];
+
   async run() {
     // TODO: filePath validation required.
-    const migrationCommandFlags = this.parse(MigrationCommand).flags
-    const {filePath, multi, branch} = migrationCommandFlags
-    const authtoken = migrationCommandFlags.authtoken
-    const apiKey = migrationCommandFlags['api-key']
-    const alias = migrationCommandFlags['management-token-alias']
+    const migrationCommandFlags = this.parse(MigrationCommand).flags;
+    const { filePath, multi, branch } = migrationCommandFlags;
+    const authtoken = migrationCommandFlags.authtoken;
+    const apiKey = migrationCommandFlags["api-key"];
+    const alias = migrationCommandFlags["management-token-alias"];
+    const config = migrationCommandFlags["config"];
 
-    let stackSDKInstance
+    if (!filePath) {
+      this.log("Please provide the migration script file path, use -n or --filePath flag");
+      this.exit();
+    }
 
     // Reset map instance
-    const mapInstance = getMapInstance()
-    resetMapInstance(mapInstance)
+    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) => {
+        let objArr = v.split(":");
+        return { ...a, [objArr[0]]: objArr[1] };
+      }, {});
+      set("config", mapInstance, configObj);
+    }
+
+    let stackSDKInstance;
     if (branch) {
-      set(BRANCH, mapInstance, branch)
+      set(BRANCH, mapInstance, branch);
     }
 
     if (alias) {
-      let managementToken = this.getToken(alias)
+      let managementToken = this.getToken(alias);
       if (managementToken) {
-        set(MANAGEMENT_TOKEN, mapInstance, managementToken)
-        set(API_KEY, mapInstance, managementToken.apiKey)
+        set(MANAGEMENT_TOKEN, mapInstance, managementToken);
+        set(API_KEY, mapInstance, managementToken.apiKey);
         if (branch) {
-          stackSDKInstance = this.managementAPIClient.stack({management_token: managementToken.token, api_key: managementToken.apiKey, branch_uid: branch})
+          stackSDKInstance = this.managementAPIClient.stack({
+            management_token: managementToken.token,
+            api_key: managementToken.apiKey,
+            branch_uid: branch,
+          });
         } else {
-          stackSDKInstance = this.managementAPIClient.stack({management_token: managementToken.token, api_key: managementToken.apiKey})
+          stackSDKInstance = this.managementAPIClient.stack({
+            management_token: managementToken.token,
+            api_key: managementToken.apiKey,
+          });
         }
       }
     }
 
     if (authtoken) {
-      set(AUTH_TOKEN, mapInstance, authtoken)
-      set(API_KEY, mapInstance, apiKey)
-      this.managementAPIClient = {authtoken: this.authToken}
+      set(AUTH_TOKEN, mapInstance, authtoken);
+      set(API_KEY, mapInstance, apiKey);
+      this.managementAPIClient = { authtoken: this.authToken };
       if (branch) {
-        stackSDKInstance = this.managementAPIClient.stack({api_key: apiKey, branch_uid: branch})
+        stackSDKInstance = this.managementAPIClient.stack({
+          api_key: apiKey,
+          branch_uid: branch,
+        });
       } else {
-        stackSDKInstance = this.managementAPIClient.stack({api_key: apiKey})
+        stackSDKInstance = this.managementAPIClient.stack({ api_key: apiKey });
       }
     }
 
-    set(MANAGEMENT_SDK, mapInstance, stackSDKInstance)
+    set(MANAGEMENT_SDK, mapInstance, stackSDKInstance);
+    set(MANAGEMENT_CLIENT, mapInstance, this.managementAPIClient);
 
     if (multi) {
-      await this.execMultiFiles(filePath, mapInstance)
+      await this.execMultiFiles(filePath, mapInstance);
     } else {
-      await this.execSingleFile(filePath, mapInstance)
+      await this.execSingleFile(filePath, mapInstance);
     }
   }
 
   async execSingleFile(filePath, mapInstance) {
     // Resolved absolute path
-    const resolvedMigrationPath = resolve(filePath)
+    const resolvedMigrationPath = resolve(filePath);
     // User provided migration function
-    const migrationFunc = require(resolvedMigrationPath)
+    const migrationFunc = require(resolvedMigrationPath);
 
-    const parser = new Parser()
+    const parser = new Parser();
 
     try {
-      const migrationParser = await parser.getMigrationParser(migrationFunc)
+      const migrationParser = await parser.getMigrationParser(migrationFunc);
       if (migrationParser.hasErrors) {
-        errorHelper(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)
+        if (process.send) process.send({ errorOccurred: true });
+        this.exit(1);
       }
 
       // Make calls from here
-      const requests = get(_requests, mapInstance)
+      const requests = get(_requests, mapInstance);
       // Fetches tasks array
-      const tasks = this.getTasks(requests)
+      const tasks = this.getTasks(requests);
 
-      const listr = new Listr(tasks)
+      const listr = new Listr(tasks);
 
-      await listr.run().catch(error => {
-        this.handleErrors(error)
+      await listr.run().catch((error) => {
+        this.handleErrors(error);
         // When the process is child, send error message to parent
-        if (process.send) process.send({errorOccurred: true})
-      })
-      requests.splice(0, requests.length)
+        if (process.send) process.send({ errorOccurred: true });
+      });
+      requests.splice(0, requests.length);
     } catch (error) {
       // errorHandler(null, null, null, error)
     }
@@ -111,72 +167,105 @@ class MigrationCommand extends Command {
 
   async execMultiFiles(filePath, mapInstance) {
     // Resolved absolute path
-    const resolvedMigrationPath = resolve(filePath)
+    const resolvedMigrationPath = resolve(filePath);
     try {
-      const files = fs.readdirSync(resolvedMigrationPath)
+      const files = fs.readdirSync(resolvedMigrationPath);
       for (let index = 0; index < files.length; index++) {
-        const file = files[index]
-        if (extname(file) === '.js') {
-          success(chalk`{white Executing file:} {grey {bold ${file}}}`)
+        const file = files[index];
+        if (extname(file) === ".js") {
+          success(chalk`{white Executing file:} {grey {bold ${file}}}`);
           // eslint-disable-next-line no-await-in-loop
-          await this.execSingleFile(resolve(filePath, file), mapInstance)
+          await this.execSingleFile(resolve(filePath, file), mapInstance);
         }
       }
     } catch (error) {
-      error(error)
+      error(error);
     }
   }
 
   getTasks(requests) {
-    const _tasks = []
-    const results = []
+    const _tasks = [];
+    const results = [];
 
     for (let i = 0; i < requests.length; i++) {
-      let reqObj = requests[i]
-      const {title, failedTitle, successTitle, tasks} = reqObj
+      let reqObj = requests[i];
+      const { title, failedTitle, successTitle, tasks } = reqObj;
       const task = {
         title: title,
         task: async (ctx, task) => {
-          const [err, result] = await safePromise(waterfall(tasks))
+          const [err, result] = await safePromise(waterfall(tasks));
           if (err) {
-            ctx.error = true
-            task.title = failedTitle
-            throw err
+            ctx.error = true;
+            task.title = failedTitle;
+            throw err;
           }
-          result && results.push(result)
-          task.title = successTitle
-          return result
+          result && results.push(result);
+          task.title = successTitle;
+          return result;
         },
-      }
-      _tasks.push(task)
+      };
+      _tasks.push(task);
     }
-    return _tasks
+    return _tasks;
   }
 
   handleErrors() {
-    const mapInstance = getMapInstance()
-    const actions = get(actionMapper, mapInstance)
-    const actionList = new ActionList(actions)
+    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())
+    actionList.addValidators(new ApiError());
+    actionList.addValidators(new SchemaValidator());
+    actionList.addValidators(new MigrationError());
+    actionList.addValidators(new FieldValidator());
 
-    const errors = actionList.validate()
-    errorHelper(errors)
+    const errors = actionList.validate();
+    errorHelper(errors);
   }
 }
 
-MigrationCommand.description = 'Contentstack migration script.'
+MigrationCommand.description = "Contentstack migration script.";
 
 MigrationCommand.flags = {
-  'api-key': flags.string({char: 'k', description: 'With this flag add the API key of your stack.', dependsOn: ['authtoken'], exclusive: ['management-token-alias']}),
-  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: ['management-token-alias']}),
-  'management-token-alias': flags.string({char: 'a', description: 'Use this flag to add the management token alias.', exclusive: ['authtoken']}), // Add a better description
-  filePath: flags.string({char: 'n', 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.'}),
-  multi: flags.boolean({description: 'This flag helps you to migrate multiple content files in a single instance.'}), // Add a better description
-}
+  "api-key": flags.string({
+    char: "k",
+    description: "With this flag add the API key of your stack.",
+    dependsOn: ["authtoken"],
+    exclusive: ["management-token-alias"],
+  }),
+  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: ["management-token-alias"],
+  }),
+  "management-token-alias": flags.string({
+    char: "a",
+    description: "Use this flag to add the management token alias.",
+    exclusive: ["authtoken"],
+  }), // Add a better description
+  filePath: flags.string({
+    char: "n",
+    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.",
+  }),
+  "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.",
+  }), // Add a better description
+};
 
-module.exports = MigrationCommand
+module.exports = MigrationCommand;

package/src/config/api-config.js

@@ -1,19 +1,19 @@
 /* eslint-disable camelcase */
-'use strict'
+"use strict";
 
-const {CONTENTSTACK_API_KEY, CONTENTSTACK_AUTHTOKEN} = process.env
-const {version} = require('../../package.json')
+const { CONTENTSTACK_API_KEY, CONTENTSTACK_AUTHTOKEN } = process.env;
+const { version } = require("../../package.json");
 module.exports = {
-  hostname: 'dev9-api.contentstack.com',
+  hostname: "dev9-app.contentstack.com",
   // hostname: 'stag-app.contentstack.com',
-  version: '/v3',
-  method: 'GET', // Default Http method
+  version: "/v3",
+  method: "GET", // Default Http method
   headers: {
-    'Content-Type': 'application/json',
-    'Content-Length': null,
-    'X-User-Agent': `@contentstack-migration/v${version}`,
+    "Content-Type": "application/json",
+    "Content-Length": null,
+    "X-User-Agent": `@contentstack-migration/v${version}`,
     authtoken: CONTENTSTACK_AUTHTOKEN,
     api_key: CONTENTSTACK_API_KEY,
     // management_token: CONTENTSTACK_MANAGEMENT_TOKEN
   },
-}
+};

package/src/modules/parser.js

@@ -14,11 +14,11 @@ const Base = require('./base')
 
 const {ActionList} = require('../actions')
 // Utils
-const {map: _map, constants} = require('../utils')
+const {map: _map, constants, fsHelper} = require('../utils')
 // map properties
 const {getMapInstance, get} = _map
 // Constants
-const {actionMapper, MANAGEMENT_SDK, MANAGEMENT_TOKEN, AUTH_TOKEN, API_KEY, BRANCH} = constants
+const {actionMapper, MANAGEMENT_SDK, MANAGEMENT_TOKEN, AUTH_TOKEN, API_KEY, BRANCH, MANAGEMENT_CLIENT, SOURCE_BRANCH} = constants
 
 class Parser {
   async getMigrationParser(migrationFunc) {
@@ -33,7 +33,15 @@ class Parser {
       const authToken = get(AUTH_TOKEN, mapInstance)
       const apiKey = get(API_KEY, mapInstance)
       const branch = get(BRANCH, mapInstance)
-      await migrationFunc({migration, stackSDKInstance, managementToken, authToken, apiKey, branch})
+      const managementAPIClient = get(MANAGEMENT_CLIENT, mapInstance)
+      const externalConfigPath = get("config-path", mapInstance)
+      const externalConfig = get("config", mapInstance)
+      let externalFileConfig
+      if (typeof externalConfigPath == "string") {
+        externalFileConfig = await fsHelper.readJSONFile(externalConfigPath);
+      }
+      const config = Object.assign({}, externalFileConfig, externalConfig);
+      await migrationFunc({migration, stackSDKInstance, managementAPIClient, managementToken, authToken, apiKey, branch, config})
     } catch (error) {
       if (error instanceof TypeError) {
         if (error.message.includes('is not a function')) {

package/src/utils/constants.js

@@ -1,219 +1,228 @@
-'use strict'
+"use strict";
 
-exports.mapObject = new Map()
+exports.mapObject = new Map();
 
-exports.version = 3 // TODO: Fetch it from CMA
+exports.version = 3; // TODO: Fetch it from CMA
 
-exports.defaultDataType = 'text'
+exports.defaultDataType = "text";
 
-exports.MANAGEMENT_SDK = 'MANAGEMENT_SDK'
-exports.MANAGEMENT_SDK = 'MANAGEMENT_TOKEN'
-exports.AUTH_TOKEN = 'AUTH_TOKEN'
-exports.API_KEY = 'API_KEY'
-exports.BRANCH = 'BRANCH'
+exports.MANAGEMENT_SDK = "MANAGEMENT_SDK";
+exports.MANAGEMENT_CLIENT = "MANAGEMENT_CLIENT";
+exports.MANAGEMENT_SDK = "MANAGEMENT_TOKEN";
+exports.AUTH_TOKEN = "AUTH_TOKEN";
+exports.API_KEY = "API_KEY";
+exports.BRANCH = "BRANCH";
+exports.SOURCE_BRANCH = "SOURCE_BRANCH";
 
-exports.data_type = 'data_type'
-exports.mandatory = 'mandatory'
-exports._default = 'default'
-exports.unique = 'unique'
-exports.display_name = 'display_name'
-exports.reference_to = 'reference_to'
-exports.field_metadata = 'field_metadata'
+exports.data_type = "data_type";
+exports.mandatory = "mandatory";
+exports._default = "default";
+exports.unique = "unique";
+exports.display_name = "display_name";
+exports.reference_to = "reference_to";
+exports.field_metadata = "field_metadata";
 
 exports.actions = {
-  CUSTOM_TASK: 'CUSTOM_TASK',
-  CREATE_CT: 'CREATE_CT',
-  DELETE_CT: 'DELETE_CT',
-  EDIT_CT: 'EDIT_CT',
-  LOCALES: 'LOCALES',
-  EDIT_FIELD: 'EDIT_FIELD',
-  DELETE_FIELD: 'DELETE_FIELD',
-  MOVE_FIELD: 'MOVE_FIELD',
-}
+  CUSTOM_TASK: "CUSTOM_TASK",
+  CREATE_CT: "CREATE_CT",
+  DELETE_CT: "DELETE_CT",
+  EDIT_CT: "EDIT_CT",
+  LOCALES: "LOCALES",
+  EDIT_FIELD: "EDIT_FIELD",
+  DELETE_FIELD: "DELETE_FIELD",
+  MOVE_FIELD: "MOVE_FIELD",
+};
 
 // Http call max retry
-exports.MAX_RETRY = 3
+exports.MAX_RETRY = 3;
 
 // This key holds the value for http objects in map
-exports.requests = 'REQUESTS'
+exports.requests = "REQUESTS";
 
-exports.limit = 1 // Limit for concurrent tasks executed parallely
+exports.limit = 1; // Limit for concurrent tasks executed parallely
 
-exports.nonWritableMethods = ['GET', 'DELETE']
+exports.nonWritableMethods = ["GET", "DELETE"];
 
-exports.ContentType = 'Content type'
-exports.Entry = 'Entry'
+exports.ContentType = "Content type";
+exports.Entry = "Entry";
 
 exports.errorMessageHandler = {
-  POST: 'saving',
-  GET: 'fetching',
-  PUT: 'updating',
-  DELETE: 'deleting',
-}
+  POST: "saving",
+  GET: "fetching",
+  PUT: "updating",
+  DELETE: "deleting",
+};
 
 exports.successMessageHandler = {
-  POST: 'saved',
-  GET: 'fetched',
-  PUT: 'updated',
-  DELETE: 'deleted',
-}
+  POST: "saved",
+  GET: "fetched",
+  PUT: "updated",
+  DELETE: "deleted",
+};
 // map key
-exports.actionMapper = 'actions'
+exports.actionMapper = "actions";
 
-exports.batchLimit = 20
+exports.batchLimit = 20;
 
-exports.contentTypeProperties = ['description', 'title', 'uid', 'options', 'force', 'schema']
+exports.contentTypeProperties = [
+  "description",
+  "title",
+  "uid",
+  "options",
+  "force",
+  "schema",
+];
 
 exports.validationAction = {
-  create: 'create',
-  edit: 'edit',
-  customTask: 'customTask',
-  transformEntries: 'transformEntries',
-  deriveLinkedEntries: 'deriveLinkedEntries',
-  transformEntriesToType: 'transformEntriesToType',
-  typeError: 'typeError',
-  apiError: 'apiError',
-  schema: 'schema',
-  __migrationError: 'migrationError',
-  field: 'field',
-}
+  create: "create",
+  edit: "edit",
+  customTask: "customTask",
+  transformEntries: "transformEntries",
+  deriveLinkedEntries: "deriveLinkedEntries",
+  transformEntriesToType: "transformEntriesToType",
+  typeError: "typeError",
+  apiError: "apiError",
+  schema: "schema",
+  __migrationError: "migrationError",
+  field: "field",
+};
 
 exports.transformEntriesProperties = [
   {
-    name: 'contentType',
-    type: 'string',
+    name: "contentType",
+    type: "string",
     mandatory: true,
   },
   {
-    name: 'from',
-    type: 'array',
+    name: "from",
+    type: "array",
     mandatory: true,
   },
   {
-    name: 'to',
-    type: 'array',
+    name: "to",
+    type: "array",
     mandatory: true,
   },
   {
-    name: 'shouldPublish',
-    type: 'boolean',
+    name: "shouldPublish",
+    type: "boolean",
     mandatory: false,
-    dependsOn: 'environments',
+    dependsOn: "environments",
   },
   {
-    name: 'environments',
-    type: 'array',
+    name: "environments",
+    type: "array",
     mandatory: false,
   },
   {
-    name: 'transformEntryForLocale',
-    type: 'function',
+    name: "transformEntryForLocale",
+    type: "function",
     mandatory: true,
   },
-]
+];
 
 exports.deriveLinkedEntriesProperties = [
   {
-    name: 'contentType',
-    type: 'string',
+    name: "contentType",
+    type: "string",
     mandatory: true,
   },
   {
-    name: 'derivedContentType',
-    type: 'string',
+    name: "derivedContentType",
+    type: "string",
     mandatory: true,
   },
   {
-    name: 'from',
-    type: 'array',
+    name: "from",
+    type: "array",
     mandatory: true,
   },
   {
-    name: 'toReferenceField',
-    type: 'string',
+    name: "toReferenceField",
+    type: "string",
     mandatory: true,
   },
   {
-    name: 'derivedFields',
-    type: 'array',
+    name: "derivedFields",
+    type: "array",
     mandatory: true,
   },
   {
-    name: 'identityKey',
-    type: 'function',
+    name: "identityKey",
+    type: "function",
     mandatory: true,
   },
   {
-    name: 'shouldPublish',
-    type: 'boolean',
+    name: "shouldPublish",
+    type: "boolean",
     mandatory: false,
-    dependsOn: 'environments',
+    dependsOn: "environments",
   },
   {
-    name: 'environments',
-    type: 'array',
+    name: "environments",
+    type: "array",
     mandatory: false,
   },
   {
-    name: 'deriveEntryForLocale',
-    type: 'function',
+    name: "deriveEntryForLocale",
+    type: "function",
     mandatory: true,
   },
-]
+];
 
 exports.transformEntriesToTypeProperties = [
   {
-    name: 'sourceContentType',
-    type: 'string',
+    name: "sourceContentType",
+    type: "string",
     mandatory: true,
   },
   {
-    name: 'targetContentType',
-    type: 'string',
+    name: "targetContentType",
+    type: "string",
     mandatory: true,
   },
   {
-    name: 'from',
-    type: 'array',
+    name: "from",
+    type: "array",
     mandatory: true,
   },
   {
-    name: 'shouldPublish',
-    type: 'boolean',
+    name: "shouldPublish",
+    type: "boolean",
     mandatory: false,
-    dependsOn: 'environments',
+    dependsOn: "environments",
   },
   {
-    name: 'environments',
-    type: 'array',
+    name: "environments",
+    type: "array",
     mandatory: false,
   },
   {
-    name: 'removeOldEntries',
-    type: 'boolean',
+    name: "removeOldEntries",
+    type: "boolean",
     mandatory: false,
   },
   {
-    name: 'identityKey',
-    type: 'function',
+    name: "identityKey",
+    type: "function",
     mandatory: true,
   },
   {
-    name: 'transformEntryForLocale',
-    type: 'function',
+    name: "transformEntryForLocale",
+    type: "function",
     mandatory: true,
   },
-]
+];
 
 exports.SDK_ACTIONS = {
-  CONTENTTYPE_GET: 'CONTENTTYPE_GET',
-  CONTENTTYPE_POST: 'CONTENTTYPE_POST',
-  CONTENTTYPE_DELETE: 'CONTENTTYPE_GET',
-  CONTENTTYPE_PUT: 'CONTENTTYPE_PUT',
-  LOCALES_GET: 'LOCALES_GET',
-  ENTRY_GET: 'ENTRY_GET',
-  ENTRY_POST: 'ENTRY_POST',
-  ENTRY_PUT: 'ENTRY_PUT',
-  ENTRY_DELETE: 'ENTRY_DELETE',
-  ENTRY_PUBLISH: 'ENTRY_PUBLISH',
-}
+  CONTENTTYPE_GET: "CONTENTTYPE_GET",
+  CONTENTTYPE_POST: "CONTENTTYPE_POST",
+  CONTENTTYPE_DELETE: "CONTENTTYPE_GET",
+  CONTENTTYPE_PUT: "CONTENTTYPE_PUT",
+  LOCALES_GET: "LOCALES_GET",
+  ENTRY_GET: "ENTRY_GET",
+  ENTRY_POST: "ENTRY_POST",
+  ENTRY_PUT: "ENTRY_PUT",
+  ENTRY_DELETE: "ENTRY_DELETE",
+  ENTRY_PUBLISH: "ENTRY_PUBLISH",
+};

package/src/utils/fs-helper.js

@@ -1,6 +1,7 @@
 'use strict'
 
-const {existsSync, mkdirSync, readFileSync} = require('fs')
+const { existsSync, mkdirSync, readFileSync, readFile } = require('fs')
+const path = require("path")
 
 exports.makeDir = dirname => {
   !this.existsSync(dirname) && mkdirSync(dirname)
@@ -12,3 +13,16 @@ exports.readFile = filePath => {
   if (!existsSync(filePath)) throw new Error('File does not exist')
   return readFileSync(filePath, 'utf-8')
 }
+
+exports.readJSONFile = (filePath) => {
+  return new Promise((resolve, reject) => {
+    filePath = path.resolve(filePath);
+    readFile(filePath, 'utf-8', (error, data) => {
+      if (error) {
+        reject(error);
+      } else {
+        resolve(JSON.parse(data));
+      }
+    });
+  });
+};