@contentstack/cli-cm-import-setup 1.0.0-beta.1 → 1.0.1

package/README.md

@@ -47,7 +47,7 @@ $ npm install -g @contentstack/cli-cm-import-setup
 $ csdx COMMAND
 running command...
 $ csdx (--version)
-@contentstack/cli-cm-import-setup/1.0.0-beta.1 linux-x64 node-v18.20.5
+@contentstack/cli-cm-import-setup/1.0.1 linux-x64 node-v18.20.6
 $ csdx --help [COMMAND]
 USAGE
   $ csdx COMMAND
@@ -63,52 +63,72 @@ USAGE
 
 ## `csdx cm:stacks:import-setup [-k <value>] [-d <value>] [-a <value>] [--modules <value,value>]`
 
-Import content from a stack
+Helps to generate mappers and backup folder for importing (overwriting) specific modules
 
 ```
 USAGE
   $ csdx cm:stacks:import-setup [-k <value>] [-d <value>] [-a <value>] [--modules <value,value>]
 
 FLAGS
-  -a, --alias=<value>          alias of the management token
-  -d, --data-dir=<value>       path and location where data is stored
+  -B, --branch=<value>         The name of the branch where you want to import your content. If you don't mention the
+                               branch name, then by default the content will be imported to the main branch.
+  -a, --alias=<value>          The management token of the destination stack where you will import the content.
+  -d, --data-dir=<value>       The path or the location in your file system where the content, you intend to import, is
+                               stored. For example, -d "C:\Users\Name\Desktop\cli\content". If the export folder has
+                               branches involved, then the path should point till the particular branch. For example,
+                               “-d "C:\Users\Name\Desktop\cli\content\branch_name"
   -k, --stack-api-key=<value>  API key of the target stack
-  --modules=<option>           [optional] specific module name
-                               <options: content-types|entries|both>
+  --module=<option>...         [optional] Specify the modules/module to import into the target stack. currently options
+                               are global-fields, content-types, entries
+                               <options: global-fields|content-types|entries>
 
 DESCRIPTION
-  Import content from a stack
+  Helps to generate mappers and backup folder for importing (overwriting) specific modules
 
 ALIASES
   $ csdx cm:import-setup
 
 EXAMPLES
-  $ csdx cm:stacks:import-setup --stack-api-key <stack_api_key> --data-dir <path/of/export/destination/dir> --modules <module_name, module_name>
+  $ csdx cm:stacks:import-setup --stack-api-key <target_stack_api_key> --data-dir <path/of/export/destination/dir> --modules <module_name, module_name>
+
+  $ csdx cm:stacks:import-setup -k <target_stack_api_key> -d <path/of/export/destination/dir> --modules <module_name, module_name>
+
+  $ csdx cm:stacks:import-setup -k <target_stack_api_key> -d <path/of/export/destination/dir> --modules <module_name, module_name> -b <branch_name>
 ```
 
 ## `csdx cm:stacks:import-setup [-k <value>] [-d <value>] [-a <value>] [--modules <value,value>]`
 
-Import content from a stack
+Helps to generate mappers and backup folder for importing (overwriting) specific modules
 
 ```
 USAGE
   $ csdx cm:stacks:import-setup [-k <value>] [-d <value>] [-a <value>] [--modules <value,value>]
 
 FLAGS
-  -a, --alias=<value>          alias of the management token
-  -d, --data-dir=<value>       path and location where data is stored
+  -B, --branch=<value>         The name of the branch where you want to import your content. If you don't mention the
+                               branch name, then by default the content will be imported to the main branch.
+  -a, --alias=<value>          The management token of the destination stack where you will import the content.
+  -d, --data-dir=<value>       The path or the location in your file system where the content, you intend to import, is
+                               stored. For example, -d "C:\Users\Name\Desktop\cli\content". If the export folder has
+                               branches involved, then the path should point till the particular branch. For example,
+                               “-d "C:\Users\Name\Desktop\cli\content\branch_name"
   -k, --stack-api-key=<value>  API key of the target stack
-  --modules=<option>           [optional] specific module name
-                               <options: content-types|entries|both>
+  --module=<option>...         [optional] Specify the modules/module to import into the target stack. currently options
+                               are global-fields, content-types, entries
+                               <options: global-fields|content-types|entries>
 
 DESCRIPTION
-  Import content from a stack
+  Helps to generate mappers and backup folder for importing (overwriting) specific modules
 
 ALIASES
   $ csdx cm:import-setup
 
 EXAMPLES
-  $ csdx cm:stacks:import-setup --stack-api-key <stack_api_key> --data-dir <path/of/export/destination/dir> --modules <module_name, module_name>
+  $ csdx cm:stacks:import-setup --stack-api-key <target_stack_api_key> --data-dir <path/of/export/destination/dir> --modules <module_name, module_name>
+
+  $ csdx cm:stacks:import-setup -k <target_stack_api_key> -d <path/of/export/destination/dir> --modules <module_name, module_name>
+
+  $ csdx cm:stacks:import-setup -k <target_stack_api_key> -d <path/of/export/destination/dir> --modules <module_name, module_name> -b <branch_name>
 ```
 
 _See code: [src/commands/cm/stacks/import-setup.ts](https://github.com/contentstack/cli/blob/main/packages/contentstack-import-setup/src/commands/cm/stacks/import-setup.ts)_

package/lib/commands/cm/stacks/import-setup.js

@@ -18,18 +18,20 @@ class ImportSetupCommand extends cli_command_1.Command {
             const managementAPIClient = await (0, cli_utilities_1.managementSDKClient)(importSetupConfig);
             const importSetup = new import_1.ImportSetup(importSetupConfig, managementAPIClient);
             await importSetup.start();
-            (0, utils_1.log)(importSetupConfig, `Successfully created backup folder and mapper files for the stack with the API key ${importSetupConfig.apiKey}.`, 'success');
-            (0, utils_1.log)(importSetupConfig, `The backup folder created at '${(0, cli_utilities_1.pathValidator)(node_path_1.default.join(importSetupConfig.backupDir))}'`, 'success');
+            (0, utils_1.log)(importSetupConfig, `Backup folder and mapper files have been successfully created for the stack using the API key ${importSetupConfig.apiKey}.`, 'success');
+            (0, utils_1.log)(importSetupConfig, `The backup folder has been created at '${(0, cli_utilities_1.pathValidator)(node_path_1.default.join(importSetupConfig.backupDir))}'.`, 'success');
         }
         catch (error) {
-            (0, utils_1.log)({ data: '' }, `Failed to create backup folder and mapper files - ${(0, cli_utilities_1.formatError)(error)}`, 'error');
+            (0, utils_1.log)({ data: '' }, `Failed to create the backup folder and mapper files: ${(0, cli_utilities_1.formatError)(error)}`, 'error');
         }
     }
 }
 exports.default = ImportSetupCommand;
-ImportSetupCommand.description = cli_utilities_1.messageHandler.parse('Import content from a stack');
+ImportSetupCommand.description = cli_utilities_1.messageHandler.parse('Helps to generate mappers and backup folder for importing (overwriting) specific modules');
 ImportSetupCommand.examples = [
-    `csdx cm:stacks:import-setup --stack-api-key <stack_api_key> --data-dir <path/of/export/destination/dir> --modules <module_name, module_name>`,
+    `csdx cm:stacks:import-setup --stack-api-key <target_stack_api_key> --data-dir <path/of/export/destination/dir> --modules <module_name, module_name>`,
+    `csdx cm:stacks:import-setup -k <target_stack_api_key> -d <path/of/export/destination/dir> --modules <module_name, module_name>`,
+    `csdx cm:stacks:import-setup -k <target_stack_api_key> -d <path/of/export/destination/dir> --modules <module_name, module_name> -b <branch_name>`,
 ];
 ImportSetupCommand.flags = {
     'stack-api-key': cli_utilities_1.flags.string({
@@ -38,15 +40,21 @@ ImportSetupCommand.flags = {
     }),
     'data-dir': cli_utilities_1.flags.string({
         char: 'd',
-        description: 'path and location where data is stored',
+        description: `The path or the location in your file system where the content, you intend to import, is stored. For example, -d "C:\\Users\\Name\\Desktop\\cli\\content". If the export folder has branches involved, then the path should point till the particular branch. For example, “-d "C:\\Users\\Name\\Desktop\\cli\\content\\branch_name"`,
     }),
     alias: cli_utilities_1.flags.string({
         char: 'a',
-        description: 'alias of the management token',
+        description: 'The management token of the destination stack where you will import the content.',
     }),
-    modules: cli_utilities_1.flags.string({
-        options: ['content-types', 'entries', 'both'],
-        description: '[optional] specific module name',
+    module: cli_utilities_1.flags.string({
+        options: ['global-fields', 'content-types', 'entries'],
+        description: '[optional] Specify the modules/module to import into the target stack. currently options are global-fields, content-types, entries',
+        multiple: true,
+    }),
+    branch: cli_utilities_1.flags.string({
+        char: 'B',
+        description: "The name of the branch where you want to import your content. If you don't mention the branch name, then by default the content will be imported to the main branch.",
+        parse: (0, cli_utilities_1.printFlagDeprecation)(['-B'], ['--branch']),
     }),
 };
 ImportSetupCommand.aliases = ['cm:import-setup'];

package/lib/config/index.js

@@ -46,7 +46,7 @@ const config = {
         'global-fields': {
             dirName: 'global_fields',
             fileName: 'globalfields.json',
-            dependencies: ['marketplace-apps'],
+            dependencies: ['extensions', 'marketplace-apps'],
         },
         'marketplace-apps': {
             dirName: 'marketplace_apps',

package/lib/import/import-setup.js

@@ -24,7 +24,7 @@ var __importStar = (this && this.__importStar) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 const utils_1 = require("../utils");
-const cli_utilities_1 = require("@contentstack/cli-utilities");
+const utils_2 = require("../utils");
 class ImportSetup {
     constructor(config, managementAPIClient) {
         this.dependencyTree = {};
@@ -41,20 +41,27 @@ class ImportSetup {
      * @returns {Promise<Array<void | string>>}
      */
     async generateDependencyTree() {
-        const getAllDependencies = (module, visited = new Set()) => {
+        const visited = new Set();
+        const assignedDependencies = new Set(); // Track assigned dependencies
+        const getAllDependencies = (module) => {
             var _a;
             if (visited.has(module))
                 return [];
             visited.add(module);
-            let dependencies = ((_a = this.config.modules[module]) === null || _a === void 0 ? void 0 : _a.dependencies) || [];
+            const dependencies = ((_a = this.config.modules[module]) === null || _a === void 0 ? void 0 : _a.dependencies) || [];
+            let allDeps = [...dependencies];
             for (const dependency of dependencies) {
-                dependencies = dependencies.concat(getAllDependencies(dependency, visited));
+                allDeps.push(...getAllDependencies(dependency));
             }
-            return dependencies;
+            return allDeps;
         };
+        this.dependencyTree = {}; // Reset before building
         for (const module of this.config.selectedModules) {
-            const allDependencies = getAllDependencies(module);
-            this.dependencyTree[module] = Array.from(new Set(allDependencies));
+            let allDependencies = getAllDependencies(module);
+            allDependencies = allDependencies.filter((dep) => !assignedDependencies.has(dep)); // Remove assigned ones
+            this.dependencyTree[module] = allDependencies;
+            // Mark these dependencies as assigned so they won't be included in later modules
+            allDependencies.forEach((dep) => assignedDependencies.add(dep));
         }
     }
     /**
@@ -78,7 +85,7 @@ class ImportSetup {
                 await moduleInstance.start();
             }
             catch (error) {
-                (0, utils_1.log)(this.config, `Error importing '${moduleName}': ${(0, cli_utilities_1.formatError)(error)}`, 'error');
+                (0, utils_1.log)(this.config, `Error occurred while importing '${moduleName}'`, 'error');
                 throw error;
             }
         }
@@ -100,6 +107,9 @@ class ImportSetup {
             if (backupDir) {
                 this.config.backupDir = backupDir;
             }
+            if (this.config.branchName) {
+                await (0, utils_2.validateBranch)(this.stackAPIClient, this.config, this.config.branchName);
+            }
             await this.generateDependencyTree();
             await this.runModuleImports();
         }

package/lib/import/modules/assets.js

@@ -29,10 +29,10 @@ class AssetImportSetup extends base_setup_1.default {
         try {
             utils_1.fsUtil.makeDirectory(this.mapperDirPath);
             await this.fetchAndMapAssets();
-            (0, utils_1.log)(this.config, `Generated required setup files for asset`, 'success');
+            (0, utils_1.log)(this.config, `The required setup files for the asset have been generated successfully.`, 'success');
         }
         catch (error) {
-            (0, utils_1.log)(this.config, `Error generating asset mapper: ${(0, cli_utilities_1.formatError)(error)}`, 'error');
+            (0, utils_1.log)(this.config, `Error occurred while generating the asset mapper: ${(0, cli_utilities_1.formatError)(error)}.`, 'error');
         }
     }
     /**
@@ -51,20 +51,20 @@ class AssetImportSetup extends base_setup_1.default {
             if (items.length === 1) {
                 this.assetUidMapper[uid] = items[0].uid;
                 this.assetUrlMapper[url] = items[0].url;
-                (0, utils_1.log)(this.config, `Mapped asset: '${title}'`, 'info');
+                (0, utils_1.log)(this.config, `Mapped asset successfully: '${title}'`, 'info');
             }
             else if (items.length > 1) {
                 this.duplicateAssets[uid] = items.map((asset) => {
                     return { uid: asset.uid, title: asset.title, url: asset.url };
                 });
-                (0, utils_1.log)(this.config, `Multiple assets found with title '${title}'`, 'info');
+                (0, utils_1.log)(this.config, `Multiple assets found with the title '${title}'.`, 'info');
             }
             else {
                 (0, utils_1.log)(this.config, `Asset with title '${title}' not found in the stack!`, 'info');
             }
         };
         const onReject = ({ error, apiData: { title } = undefined }) => {
-            (0, utils_1.log)(this.config, `${title} asset mapping failed.!`, 'error');
+            (0, utils_1.log)(this.config, `Failed to map the asset '${title}'.`, 'error');
             (0, utils_1.log)(this.config, (0, cli_utilities_1.formatError)(error), 'error');
         };
         /* eslint-disable @typescript-eslint/no-unused-vars, guard-for-in */
@@ -95,7 +95,7 @@ class AssetImportSetup extends base_setup_1.default {
         }
         if (!(0, lodash_1.isEmpty)(this.duplicateAssets)) {
             utils_1.fsUtil.writeFile(this.duplicateAssetPath, this.duplicateAssets);
-            (0, utils_1.log)(this.config, `Duplicate asset files store here ${this.duplicateAssetPath}`, 'info');
+            (0, utils_1.log)(this.config, `Duplicate asset files are stored at: ${this.duplicateAssetPath}.`, 'info');
         }
     }
 }

package/lib/import/modules/content-types.js

@@ -10,10 +10,10 @@ class ContentTypesImportSetup extends base_setup_1.default {
     async start() {
         try {
             await this.setupDependencies();
-            (0, utils_1.log)(this.config, `Generate required setup files for content types`, 'success');
+            (0, utils_1.log)(this.config, `The required setup files for content types have been generated successfully.`, 'success');
         }
         catch (error) {
-            (0, utils_1.log)(this.config, `Error generating ${error.message}`, 'error');
+            (0, utils_1.log)(this.config, `Error occurred while generating the content type mapper: ${error.message}.`, 'error');
         }
     }
 }

package/lib/import/modules/entries.js

@@ -10,10 +10,10 @@ class EntriesImportSetup extends base_setup_1.default {
     async start() {
         try {
             await this.setupDependencies();
-            (0, utils_1.log)(this.config, `Generate required setup files for entries`, 'success');
+            (0, utils_1.log)(this.config, `The required setup files for entries have been generated successfully.`, 'success');
         }
         catch (error) {
-            (0, utils_1.log)(this.config, `Error generating ${error.message}`, 'error');
+            (0, utils_1.log)(this.config, `Error occurred while generating the entry mapper: ${error.message}.`, 'error');
         }
     }
 }

package/lib/import/modules/extensions.js

@@ -28,20 +28,20 @@ class ExtensionImportSetup {
                 for (const extension of Object.values(extensions)) {
                     const targetExtension = await this.getExtension(extension);
                     if (!targetExtension) {
-                        (0, utils_1.log)(this.config, `Extension with title '${extension.title}' not found in the stack!`, 'info');
+                        (0, utils_1.log)(this.config, `Extension with the title '${extension.title}' not found in the stack.`, 'info');
                         continue;
                     }
                     this.extensionMapper[extension.uid] = targetExtension.uid;
                 }
                 await utils_1.fsUtil.writeFile(this.extUidMapperPath, this.extensionMapper);
-                (0, utils_1.log)(this.config, `Generated required setup files for extension`, 'success');
+                (0, utils_1.log)(this.config, `The required setup files for extensions have been generated successfully.`, 'success');
             }
             else {
-                (0, utils_1.log)(this.config, 'No extensions found in the content folder!', 'error');
+                (0, utils_1.log)(this.config, 'No extensions found in the content folder.', 'info');
             }
         }
         catch (error) {
-            (0, utils_1.log)(this.config, `Error generating extension mapper: ${(0, cli_utilities_1.formatError)(error)}`, 'error');
+            (0, utils_1.log)(this.config, `Error occurred while generating the extension mapper: ${(0, cli_utilities_1.formatError)(error)}.`, 'error');
         }
     }
     async getExtension(extension) {

package/lib/import/modules/global-fields.d.ts

@@ -0,0 +1,6 @@
+import { ModuleClassParams } from '../../types';
+import BaseImportSetup from './base-setup';
+export default class GlobalFieldsImportSetup extends BaseImportSetup {
+    constructor(options: ModuleClassParams);
+    start(): Promise<void>;
+}

package/lib/import/modules/global-fields.js

@@ -0,0 +1,20 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+const utils_1 = require("../../utils");
+const base_setup_1 = tslib_1.__importDefault(require("./base-setup"));
+class GlobalFieldsImportSetup extends base_setup_1.default {
+    constructor(options) {
+        super(options);
+    }
+    async start() {
+        try {
+            await this.setupDependencies();
+            (0, utils_1.log)(this.config, `The required setup files for global fields have been generated successfully.`, 'success');
+        }
+        catch (error) {
+            (0, utils_1.log)(this.config, `Error occurred while generating the global field mapper: ${error.message}.`, 'error');
+        }
+    }
+}
+exports.default = GlobalFieldsImportSetup;

package/lib/import/modules/marketplace-apps.js

@@ -30,14 +30,14 @@ class marketplaceAppImportSetup {
                 const targetMarketplaceApps = await this.getMarketplaceApps();
                 this.createMapper(sourceMarketplaceApps, targetMarketplaceApps);
                 await utils_1.fsUtil.writeFile((0, path_1.join)(this.marketplaceAppsUidMapperPath, 'uid-mapping.json'), this.marketplaceAppMapper);
-                (0, utils_1.log)(this.config, `Generated required setup files for marketplaceApp`, 'success');
+                (0, utils_1.log)(this.config, `The required setup files for Marketplace apps have been generated successfully.`, 'success');
             }
             else {
-                (0, utils_1.log)(this.config, 'No marketplaceApps found in the content folder!', 'info');
+                (0, utils_1.log)(this.config, 'No Marketplace apps found in the content folder.', 'info');
             }
         }
         catch (error) {
-            (0, utils_1.log)(this.config, `Error generating marketplaceApp mapper: ${(0, cli_utilities_1.formatError)(error)}`, 'error');
+            (0, utils_1.log)(this.config, `Error occurred while generating the Marketplace app mapper: ${error.message}.`, 'error');
         }
     }
     async getMarketplaceApps() {
@@ -56,7 +56,12 @@ class marketplaceAppImportSetup {
     createMapper(sourceMarketplaceApps, targetMarketplaceApps) {
         sourceMarketplaceApps.forEach((sourceApp) => {
             // Find matching target item based on manifest.name
-            const targetApp = targetMarketplaceApps.find((targetApp) => (0, lodash_1.get)(targetApp, 'manifest.name') === (0, lodash_1.get)(sourceApp, 'manifest.name'));
+            // TBD: This logic is not foolproof, need to find a better way to match source and target apps
+            // Reason: While importing apps, if an app exist in the target with the same name, it will be a conflict and will not be imported
+            // So, import command gives an option to import the app with a different name by appending ◈ to the app name. Considering this we are matching the app name without the ◈ character
+            const getAppName = (app) => (0, lodash_1.get)(app, 'manifest.name', '').split('◈')[0];
+            const sourceAppName = getAppName(sourceApp);
+            const targetApp = targetMarketplaceApps.find((app) => getAppName(app) === sourceAppName);
             if (targetApp) {
                 // Map app_uid from source and target
                 this.marketplaceAppMapper.app_uid[sourceApp.manifest.uid] = targetApp.manifest.uid;
@@ -75,6 +80,9 @@ class marketplaceAppImportSetup {
                     }
                 });
             }
+            else {
+                (0, utils_1.log)(this.config, `No matching Marketplace app found in the target stack with name ${sourceAppName}`, 'info');
+            }
         });
     }
 }

package/lib/import/modules/taxonomies.js

@@ -51,10 +51,10 @@ class TaxonomiesImportSetup {
                 if (this.termsMapper !== undefined && !(0, isEmpty_1.default)(this.termsMapper)) {
                     utils_1.fsUtil.writeFile(this.termsSuccessPath, this.termsMapper);
                 }
-                (0, utils_1.log)(this.config, `Generated required setup files for taxonomies`, 'success');
+                (0, utils_1.log)(this.config, `The required setup files for taxonomies have been generated successfully.`, 'success');
             }
             else {
-                (0, utils_1.log)(this.config, 'No taxonomies found in the content folder!', 'info');
+                (0, utils_1.log)(this.config, 'No taxonomies found in the content folder.', 'info');
             }
         }
         catch (error) {

package/lib/utils/common-helper.d.ts

@@ -0,0 +1,2 @@
+import { ImportConfig } from 'src/types';
+export declare const validateBranch: (stackAPIClient: any, config: ImportConfig, branch: any) => Promise<unknown>;

package/lib/utils/common-helper.js

@@ -0,0 +1,31 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.validateBranch = void 0;
+const tslib_1 = require("tslib");
+const chalk_1 = tslib_1.__importDefault(require("chalk"));
+const utils_1 = require("../utils");
+const validateBranch = async (stackAPIClient, config, branch) => {
+    return new Promise(async (resolve, reject) => {
+        try {
+            const data = await stackAPIClient.branch(branch).fetch();
+            if (data && typeof data === 'object') {
+                if (data.error_message) {
+                    (0, utils_1.log)(config, chalk_1.default.red(data.error_message), 'error');
+                    (0, utils_1.log)(config, chalk_1.default.red('No branch found with the name ' + branch), 'error');
+                    reject({ message: 'No branch found with the name ' + branch, error: data.error_message });
+                }
+                else {
+                    resolve(data);
+                }
+            }
+            else {
+                reject({ message: 'No branch found with the name ' + branch, error: {} });
+            }
+        }
+        catch (error) {
+            (0, utils_1.log)(config, chalk_1.default.red('No branch found with the name ' + branch), 'error');
+            reject({ message: 'No branch found with the name ' + branch, error });
+        }
+    });
+};
+exports.validateBranch = validateBranch;

package/lib/utils/import-config-handler.js

@@ -74,15 +74,8 @@ const setupConfig = async (importCmdFlags) => {
     // config.skipPrivateAppRecreationIfExist = importCmdFlags['skip-app-recreation'];
     if (importCmdFlags['branch']) {
         config.branchName = importCmdFlags['branch'];
-        config.branchDir = path.join((0, cli_utilities_1.sanitizePath)(config.contentDir), (0, cli_utilities_1.sanitizePath)(config.branchName));
-    }
-    const selectedModule = importCmdFlags['modules'] || (await (0, interactive_1.askSelectedModules)());
-    if (selectedModule === 'both') {
-        config.selectedModules = ['content-types', 'entries'];
-    }
-    else {
-        config.selectedModules = [selectedModule];
     }
+    config.selectedModules = importCmdFlags['module'] || [await (0, interactive_1.askSelectedModules)()];
     if (importCmdFlags['backup-dir']) {
         config.useBackedupDir = importCmdFlags['backup-dir'];
     }

package/lib/utils/index.d.ts

@@ -5,3 +5,4 @@ export { fsUtil } from './file-helper';
 export { default as backupHandler } from './backup-handler';
 export { log, unlinkFileLogger } from './logger';
 export * from './log';
+export * from './common-helper';

package/lib/utils/index.js

@@ -14,3 +14,4 @@ var logger_1 = require("./logger");
 Object.defineProperty(exports, "log", { enumerable: true, get: function () { return logger_1.log; } });
 Object.defineProperty(exports, "unlinkFileLogger", { enumerable: true, get: function () { return logger_1.unlinkFileLogger; } });
 tslib_1.__exportStar(require("./log"), exports);
+tslib_1.__exportStar(require("./common-helper"), exports);

package/lib/utils/interactive.js

@@ -19,11 +19,11 @@ const askSelectedModules = async () => {
     return cli_utilities_1.cliux.inquire({
         type: 'list',
         name: 'selectedModule',
-        message: 'Please select a module to generate the mapper files',
+        message: 'Please select a module to generate the mapper files.',
         choices: [
+            { name: 'Global Fields', value: 'global-fields' },
             { name: 'Content types', value: 'content-types' },
             { name: 'Entries', value: 'entries' },
-            { name: 'Both', value: 'both' },
         ],
     });
 };

package/oclif.manifest.json

@@ -1,9 +1,9 @@
 {
-  "version": "1.0.0-beta.1",
+  "version": "1.0.1",
   "commands": {
     "cm:stacks:import-setup": {
       "id": "cm:stacks:import-setup",
-      "description": "Import content from a stack",
+      "description": "Helps to generate mappers and backup folder for importing (overwriting) specific modules",
       "strict": true,
       "usage": "cm:stacks:import-setup [-k <value>] [-d <value>] [-a <value>] [--modules <value,value>]",
       "pluginName": "@contentstack/cli-cm-import-setup",
@@ -14,7 +14,9 @@
       ],
       "hiddenAliases": [],
       "examples": [
-        "csdx cm:stacks:import-setup --stack-api-key <stack_api_key> --data-dir <path/of/export/destination/dir> --modules <module_name, module_name>"
+        "csdx cm:stacks:import-setup --stack-api-key <target_stack_api_key> --data-dir <path/of/export/destination/dir> --modules <module_name, module_name>",
+        "csdx cm:stacks:import-setup -k <target_stack_api_key> -d <path/of/export/destination/dir> --modules <module_name, module_name>",
+        "csdx cm:stacks:import-setup -k <target_stack_api_key> -d <path/of/export/destination/dir> --modules <module_name, module_name> -b <branch_name>"
       ],
       "flags": {
         "stack-api-key": {
@@ -28,26 +30,33 @@
           "name": "data-dir",
           "type": "option",
           "char": "d",
-          "description": "path and location where data is stored",
+          "description": "The path or the location in your file system where the content, you intend to import, is stored. For example, -d \"C:\\Users\\Name\\Desktop\\cli\\content\". If the export folder has branches involved, then the path should point till the particular branch. For example, “-d \"C:\\Users\\Name\\Desktop\\cli\\content\\branch_name\"",
           "multiple": false
         },
         "alias": {
           "name": "alias",
           "type": "option",
           "char": "a",
-          "description": "alias of the management token",
+          "description": "The management token of the destination stack where you will import the content.",
           "multiple": false
         },
-        "modules": {
-          "name": "modules",
+        "module": {
+          "name": "module",
           "type": "option",
-          "description": "[optional] specific module name",
-          "multiple": false,
+          "description": "[optional] Specify the modules/module to import into the target stack. currently options are global-fields, content-types, entries",
+          "multiple": true,
           "options": [
+            "global-fields",
             "content-types",
-            "entries",
-            "both"
+            "entries"
           ]
+        },
+        "branch": {
+          "name": "branch",
+          "type": "option",
+          "char": "B",
+          "description": "The name of the branch where you want to import your content. If you don't mention the branch name, then by default the content will be imported to the main branch.",
+          "multiple": false
         }
       },
       "args": {}

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@contentstack/cli-cm-import-setup",
   "description": "Contentstack CLI plugin to setup the mappers and configurations for the import command",
-  "version": "1.0.0-beta.1",
+  "version": "1.0.1",
   "author": "Contentstack",
   "bugs": "https://github.com/contentstack/cli/issues",
   "dependencies": {
@@ -23,7 +23,7 @@
     "winston": "^3.17.0"
   },
   "devDependencies": {
-    "@oclif/test": "^4.1.3",
+    "@oclif/test": "^4.1.6",
     "@types/big-json": "^3.2.5",
     "@types/bluebird": "^3.5.42",
     "@types/chai": "^4.3.20",