@contentstack/cli-cm-import 1.26.3 → 1.27.0

package/README.md

@@ -47,7 +47,7 @@ $ npm install -g @contentstack/cli-cm-import
 $ csdx COMMAND
 running command...
 $ csdx (--version)
-@contentstack/cli-cm-import/1.26.3 linux-x64 node-v22.18.0
+@contentstack/cli-cm-import/1.27.0 linux-x64 node-v22.18.0
 $ csdx --help [COMMAND]
 USAGE
   $ csdx COMMAND
@@ -91,6 +91,9 @@ FLAGS
                                           extensions, marketplace-apps, global-fields, labels, locales, webhooks,
                                           workflows, custom-roles, personalize projects, and taxonomies.
   -y, --yes                               [optional] Force override all Marketplace prompts.
+      --branch-alias=<value>              The alias of the branch where you want to import your content. If you don't
+                                          mention the branch alias, then by default the content will be imported to the
+                                          main branch.
       --exclude-global-modules            Excludes the branch-independent module from the import operation.
       --import-webhook-status=<option>    [default: disable] [default: disable] (optional) This webhook state keeps the
                                           same state of webhooks as the source stack. <options: disable|current>
@@ -157,6 +160,9 @@ FLAGS
                                           extensions, marketplace-apps, global-fields, labels, locales, webhooks,
                                           workflows, custom-roles, personalize projects, and taxonomies.
   -y, --yes                               [optional] Force override all Marketplace prompts.
+      --branch-alias=<value>              The alias of the branch where you want to import your content. If you don't
+                                          mention the branch alias, then by default the content will be imported to the
+                                          main branch.
       --exclude-global-modules            Excludes the branch-independent module from the import operation.
       --import-webhook-status=<option>    [default: disable] [default: disable] (optional) This webhook state keeps the
                                           same state of webhooks as the source stack. <options: disable|current>

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

@@ -26,26 +26,6 @@ class ImportCommand extends cli_command_1.Command {
             if (this.personalizeUrl)
                 importConfig.modules.personalize.baseURL[importConfig.region.name] = this.personalizeUrl;
             const managementAPIClient = await (0, cli_utilities_1.managementSDKClient)(importConfig);
-            if (!flags.branch) {
-                try {
-                    // Use stack configuration to check for branch availability
-                    // false positive - no hardcoded secret here
-                    // @ts-ignore-next-line secret-detection
-                    const keyProp = 'api_key';
-                    const branches = await managementAPIClient
-                        .stack({ [keyProp]: importConfig.apiKey })
-                        .branch()
-                        .query()
-                        .find()
-                        .then(({ items }) => items);
-                    if (branches.length) {
-                        flags.branch = 'main';
-                    }
-                }
-                catch (error) {
-                    // Branch not enabled, just the let flow continue
-                }
-            }
             const moduleImporter = new import_1.ModuleImporter(managementAPIClient, importConfig);
             const result = await moduleImporter.start();
             backupDir = importConfig.backupDir;
@@ -150,6 +130,11 @@ ImportCommand.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: "The alias of the branch where you want to import your content. If you don't mention the branch alias, then by default the content will be imported to the main branch.",
+        exclusive: ['branch'],
     }),
     'import-webhook-status': cli_utilities_1.flags.string({
         description: '[default: disable] (optional) This webhook state keeps the same state of webhooks as the source stack. <options: disable|current>',

package/lib/import/module-importer.js

@@ -23,8 +23,13 @@ class ModuleImporter {
             this.importConfig.stackName = stackDetails.name;
             this.importConfig.org_uid = stackDetails.org_uid;
         }
-        if (this.importConfig.branchName) {
-            await (0, utils_1.validateBranch)(this.stackAPIClient, this.importConfig, this.importConfig.branchName);
+        await (0, utils_1.setupBranchConfig)(this.importConfig, this.stackAPIClient);
+        if (this.importConfig.branchAlias && this.importConfig.branchName) {
+            this.stackAPIClient = this.managementAPIClient.stack({
+                api_key: this.importConfig.apiKey,
+                management_token: this.importConfig.management_token,
+                branch_uid: this.importConfig.branchName,
+            });
         }
         if (this.importConfig.management_token) {
             await (0, cli_utilities_1.addLocale)(this.importConfig.apiKey, this.importConfig.management_token, this.importConfig.host);
@@ -40,15 +45,7 @@ class ModuleImporter {
         // NOTE audit and fix the import content.
         if (!this.importConfig.skipAudit &&
             (!this.importConfig.moduleName ||
-                [
-                    'content-types',
-                    'global-fields',
-                    'entries',
-                    'extensions',
-                    'workflows',
-                    'custom-roles',
-                    'assets'
-                ].includes(this.importConfig.moduleName))) {
+                ['content-types', 'global-fields', 'entries', 'extensions', 'workflows', 'custom-roles', 'assets'].includes(this.importConfig.moduleName))) {
             if (!(await this.auditImportData(logger))) {
                 return { noSuccessMsg: true };
             }
@@ -127,15 +124,7 @@ class ModuleImporter {
             }
             else if (this.importConfig.modules.types.length) {
                 this.importConfig.modules.types
-                    .filter((val) => [
-                    'content-types',
-                    'global-fields',
-                    'entries',
-                    'extensions',
-                    'workflows',
-                    'custom-roles',
-                    'assets'
-                ].includes(val))
+                    .filter((val) => ['content-types', 'global-fields', 'entries', 'extensions', 'workflows', 'custom-roles', 'assets'].includes(val))
                     .forEach((val) => {
                     args.push('--modules', val);
                 });

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

@@ -27,6 +27,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

@@ -92,6 +92,9 @@ const setupConfig = async (importCmdFlags) => {
     config.forceStopMarketplaceAppsPrompt = importCmdFlags.yes;
     config.importWebhookStatus = importCmdFlags['import-webhook-status'];
     config.skipPrivateAppRecreationIfExist = !importCmdFlags['skip-app-recreation'];
+    if (importCmdFlags['branch-alias']) {
+        config.branchAlias = importCmdFlags['branch-alias'];
+    }
     if (importCmdFlags['branch']) {
         config.branchName = importCmdFlags['branch'];
         config.branchDir = config.contentDir;

package/lib/utils/index.d.ts

@@ -1,3 +1,4 @@
+export { setupBranchConfig } from './setup-branch';
 export * as interactive from './interactive';
 export { default as setupImportConfig } from './import-config-handler';
 export * as fileHelper from './file-helper';

package/lib/utils/index.js

@@ -1,7 +1,9 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.lookUpTerms = exports.lookUpTaxonomy = exports.restoreJsonRteEntryRefs = exports.removeEntryRefsFromJSONRTE = exports.removeUidsFromJsonRteFields = exports.lookupEntries = exports.lookupExtension = exports.removeReferenceFields = exports.suppressSchemaReference = exports.schemaTemplate = exports.ifAppAlreadyExist = exports.getAllStackSpecificApps = exports.confirmToCloseProcess = exports.makeRedirectUrlCall = exports.handleNameConflict = exports.getConfirmationToCreateApps = exports.getOrgUid = exports.getDeveloperHubUrl = exports.lookupAssets = exports.uploadAssetHelper = exports.unlinkFileLogger = exports.log = exports.backupHandler = exports.fsUtil = exports.fileHelper = exports.setupImportConfig = exports.interactive = void 0;
+exports.lookUpTerms = exports.lookUpTaxonomy = exports.restoreJsonRteEntryRefs = exports.removeEntryRefsFromJSONRTE = exports.removeUidsFromJsonRteFields = exports.lookupEntries = exports.lookupExtension = exports.removeReferenceFields = exports.suppressSchemaReference = exports.schemaTemplate = exports.ifAppAlreadyExist = exports.getAllStackSpecificApps = exports.confirmToCloseProcess = exports.makeRedirectUrlCall = exports.handleNameConflict = exports.getConfirmationToCreateApps = exports.getOrgUid = exports.getDeveloperHubUrl = exports.lookupAssets = exports.uploadAssetHelper = exports.unlinkFileLogger = exports.log = exports.backupHandler = exports.fsUtil = exports.fileHelper = exports.setupImportConfig = exports.interactive = exports.setupBranchConfig = void 0;
 const tslib_1 = require("tslib");
+var setup_branch_1 = require("./setup-branch");
+Object.defineProperty(exports, "setupBranchConfig", { enumerable: true, get: function () { return setup_branch_1.setupBranchConfig; } });
 exports.interactive = tslib_1.__importStar(require("./interactive"));
 var import_config_handler_1 = require("./import-config-handler");
 Object.defineProperty(exports, "setupImportConfig", { enumerable: true, get: function () { return tslib_1.__importDefault(import_config_handler_1).default; } });

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,30 @@
+"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(`Stack is branch Enabled and Branch is not passed by default import will be done in main branch`);
+        }
+    }
+    catch (error) {
+        // Here the stack is not branch enabled or any network issue
+        cli_utilities_1.log.debug('Failed to fetch branches', { error });
+    }
+};
+exports.setupBranchConfig = setupBranchConfig;

package/oclif.manifest.json

@@ -102,11 +102,24 @@
         "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": "The alias of the branch where you want to import your content. If you don't mention the branch alias, then by default the content will be imported to the main branch.",
+          "exclusive": [
+            "branch"
+          ],
+          "name": "branch-alias",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
         "import-webhook-status": {
           "description": "[default: disable] (optional) This webhook state keeps the same state of webhooks as the source stack. <options: disable|current>",
           "name": "import-webhook-status",
@@ -199,5 +212,5 @@
       ]
     }
   },
-  "version": "1.26.3"
+  "version": "1.27.0"
 }

package/package.json

@@ -1,15 +1,15 @@
 {
   "name": "@contentstack/cli-cm-import",
   "description": "Contentstack CLI plugin to import content into stack",
-  "version": "1.26.3",
+  "version": "1.27.0",
   "author": "Contentstack",
   "bugs": "https://github.com/contentstack/cli/issues",
   "dependencies": {
-    "@contentstack/cli-audit": "~1.14.0",
-    "@contentstack/cli-command": "~1.6.0",
-    "@contentstack/cli-utilities": "~1.13.2",
+    "@contentstack/cli-audit": "~1.14.1",
+    "@contentstack/cli-command": "~1.6.1",
+    "@contentstack/cli-utilities": "~1.14.0",
     "@contentstack/management": "~1.22.0",
-    "@contentstack/cli-variants": "~1.3.0",
+    "@contentstack/cli-variants": "~1.3.1",
     "@oclif/core": "^4.3.0",
     "big-json": "^3.2.0",
     "bluebird": "^3.7.2",