@contentstack/cli-cm-import-setup 1.5.0 → 1.6.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.5.0 linux-x64 node-v22.19.0
+@contentstack/cli-cm-import-setup/1.6.1 linux-x64 node-v22.20.0
 $ csdx --help [COMMAND]
 USAGE
   $ csdx COMMAND
@@ -78,6 +78,8 @@ FLAGS
                                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
+      --branch-alias=<value>   Specify the branch alias where you want to import your content. If not specified, the
+                               content is imported into the main branch by default.
       --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>
@@ -113,6 +115,8 @@ FLAGS
                                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
+      --branch-alias=<value>   Specify the branch alias where you want to import your content. If not specified, the
+                               content is imported into the main branch by default.
       --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>

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

@@ -55,6 +55,11 @@ ImportSetupCommand.flags = {
         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']),
+        exclusive: ['branch-alias']
+    }),
+    'branch-alias': cli_utilities_1.flags.string({
+        description: "Specify the branch alias where you want to import your content. If not specified, the content is imported into the main branch by default.",
+        exclusive: ['branch'],
     }),
 };
 ImportSetupCommand.aliases = ['cm:import-setup'];

package/lib/import/import-setup.js

@@ -24,7 +24,6 @@ var __importStar = (this && this.__importStar) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 const utils_1 = require("../utils");
-const utils_2 = require("../utils");
 class ImportSetup {
     constructor(config, managementAPIClient) {
         this.dependencyTree = {};
@@ -107,9 +106,7 @@ 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 (0, utils_1.setupBranchConfig)(this.config, this.stackAPIClient);
             await this.generateDependencyTree();
             await this.runModuleImports();
         }

package/lib/types/import-config.d.ts

@@ -20,6 +20,7 @@ export default interface ImportConfig extends DefaultConfig, ExternalConfig {
     branches?: branch[];
     branchEnabled?: boolean;
     branchDir?: string;
+    branchAlias?: string;
     moduleName?: Modules;
     master_locale: masterLocale;
     headers?: {

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

@@ -75,6 +75,9 @@ const setupConfig = async (importCmdFlags) => {
     if (importCmdFlags['branch']) {
         config.branchName = importCmdFlags['branch'];
     }
+    if (importCmdFlags['branch-alias']) {
+        config.branchAlias = importCmdFlags['branch-alias'];
+    }
     config.selectedModules = importCmdFlags['module'] || [await (0, interactive_1.askSelectedModules)()];
     if (importCmdFlags['backup-dir']) {
         config.useBackedupDir = importCmdFlags['backup-dir'];

package/lib/utils/index.d.ts

@@ -6,3 +6,4 @@ export { default as backupHandler } from './backup-handler';
 export { log, unlinkFileLogger } from './logger';
 export * from './log';
 export * from './common-helper';
+export { setupBranchConfig } from './setup-branch';

package/lib/utils/index.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.unlinkFileLogger = exports.log = exports.backupHandler = exports.fsUtil = exports.fileHelper = exports.setupImportConfig = exports.interactive = void 0;
+exports.setupBranchConfig = exports.unlinkFileLogger = exports.log = exports.backupHandler = exports.fsUtil = exports.fileHelper = exports.setupImportConfig = exports.interactive = void 0;
 const tslib_1 = require("tslib");
 exports.interactive = tslib_1.__importStar(require("./interactive"));
 var import_config_handler_1 = require("./import-config-handler");
@@ -15,3 +15,5 @@ Object.defineProperty(exports, "log", { enumerable: true, get: function () { ret
 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);
+var setup_branch_1 = require("./setup-branch");
+Object.defineProperty(exports, "setupBranchConfig", { enumerable: true, get: function () { return setup_branch_1.setupBranchConfig; } });

package/lib/utils/setup-branch.d.ts

@@ -0,0 +1,3 @@
+import { ContentstackClient } from '@contentstack/cli-utilities';
+import { ImportConfig } from 'src/types';
+export declare const setupBranchConfig: (config: ImportConfig, stackAPIClient: ReturnType<ContentstackClient['stack']>) => Promise<void>;

package/lib/utils/setup-branch.js

@@ -0,0 +1,31 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.setupBranchConfig = void 0;
+const cli_utilities_1 = require("@contentstack/cli-utilities");
+const common_helper_1 = require("./common-helper");
+const setupBranchConfig = async (config, stackAPIClient) => {
+    if (config.branchName) {
+        await (0, common_helper_1.validateBranch)(stackAPIClient, config, config.branchName);
+        return;
+    }
+    if (config.branchAlias) {
+        config.branchName = await (0, cli_utilities_1.getBranchFromAlias)(stackAPIClient, config.branchAlias);
+        return;
+    }
+    try {
+        const branches = await stackAPIClient
+            .branch()
+            .query()
+            .find()
+            .then(({ items }) => items);
+        if (branches.length) {
+            cli_utilities_1.log.info(`The stack is branch-enabled, and branches exist. By default, content will be imported into the main branch.`);
+            config.branchName = 'main';
+            cli_utilities_1.log.debug(`Setting default target branch to 'main'`);
+        }
+    }
+    catch (error) {
+        cli_utilities_1.log.debug('Failed to fetch branches', { error });
+    }
+};
+exports.setupBranchConfig = setupBranchConfig;

package/oclif.manifest.json

@@ -51,10 +51,23 @@
         "branch": {
           "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.",
+          "exclusive": [
+            "branch-alias"
+          ],
           "name": "branch",
           "hasDynamicHelp": false,
           "multiple": false,
           "type": "option"
+        },
+        "branch-alias": {
+          "description": "Specify the branch alias where you want to import your content. If not specified, the content is imported into the main branch by default.",
+          "exclusive": [
+            "branch"
+          ],
+          "name": "branch-alias",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
         }
       },
       "hasDynamicHelp": false,
@@ -75,5 +88,5 @@
       ]
     }
   },
-  "version": "1.5.0"
+  "version": "1.6.1"
 }

package/package.json

@@ -1,12 +1,12 @@
 {
   "name": "@contentstack/cli-cm-import-setup",
   "description": "Contentstack CLI plugin to setup the mappers and configurations for the import command",
-  "version": "1.5.0",
+  "version": "1.6.1",
   "author": "Contentstack",
   "bugs": "https://github.com/contentstack/cli/issues",
   "dependencies": {
     "@contentstack/cli-command": "~1.6.1",
-    "@contentstack/cli-utilities": "~1.14.1",
+    "@contentstack/cli-utilities": "~1.15.0",
     "@oclif/core": "^4.3.0",
     "big-json": "^3.2.0",
     "chalk": "^4.1.2",