@contentstack/cli-cm-branches 1.0.0

package/lib/commands/cm/branches/delete.js

@@ -0,0 +1,47 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const cli_command_1 = require("@contentstack/cli-command");
+const cli_utilities_1 = require("@contentstack/cli-utilities");
+const delete_branch_1 = require("../../../utils/delete-branch");
+const utils_1 = require("../../../utils");
+class BranchDeleteCommand extends cli_command_1.Command {
+    async run() {
+        const { flags: branchDeleteFlags } = await this.parse(BranchDeleteCommand);
+        let apiKey = branchDeleteFlags['stack-api-key'];
+        if (!apiKey) {
+            apiKey = await utils_1.interactive.askStackAPIKey();
+        }
+        if (!branchDeleteFlags.uid) {
+            branchDeleteFlags.uid = await utils_1.interactive.askBranchUid();
+        }
+        if (!branchDeleteFlags.yes) {
+            const confirmBranch = await utils_1.interactive.askBranchNameConfirmation();
+            if (confirmBranch !== branchDeleteFlags.uid) {
+                cli_utilities_1.cliux.error(`error: To delete the branch, enter a valid branch name '${branchDeleteFlags.uid}'`);
+                process.exit(1);
+            }
+        }
+        await (0, delete_branch_1.deleteBranch)(this.cmaHost, apiKey, branchDeleteFlags.uid);
+    }
+}
+exports.default = BranchDeleteCommand;
+BranchDeleteCommand.description = cli_utilities_1.messageHandler.parse('Delete a branch');
+BranchDeleteCommand.examples = [
+    'csdx cm:branches:delete',
+    'csdx cm:branches:delete --uid main -k bltxxxxxxxx',
+    'csdx cm:branches:delete --uid main --stack-api-key bltxxxxxxxx',
+    'csdx cm:branches:delete --uid main --stack-api-key bltxxxxxxxx --yes',
+];
+BranchDeleteCommand.usage = [
+    'cm:branches:delete [-uid <value>] [-k <value>]',
+    'cm:branches:delete [--uid <value>] [--stack-api-key <value>]',
+]; // Note: Add and modify the usage
+BranchDeleteCommand.flags = {
+    uid: cli_utilities_1.flags.string({ description: 'Branch UID to be deleted' }),
+    'stack-api-key': cli_utilities_1.flags.string({ char: 'k', description: 'Stack API key' }),
+    yes: cli_utilities_1.flags.boolean({
+        char: 'y',
+        description: 'Force the deletion of the branch by skipping the confirmation',
+    }),
+};
+BranchDeleteCommand.aliases = []; // Note: alternative usage if any

package/lib/commands/cm/branches/diff.js

@@ -0,0 +1,65 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const cli_command_1 = require("@contentstack/cli-command");
+const cli_utilities_1 = require("@contentstack/cli-utilities");
+const branch_1 = require("../../../branch");
+class BranchDiffCommand extends cli_command_1.Command {
+    async run() {
+        try {
+            const { flags: branchDiffFlags } = await this.parse(BranchDiffCommand);
+            let options = {
+                baseBranch: branchDiffFlags['base-branch'],
+                stackAPIKey: branchDiffFlags['stack-api-key'],
+                compareBranch: branchDiffFlags['compare-branch'],
+                module: branchDiffFlags.module,
+                format: branchDiffFlags.format,
+                host: this.cmaHost
+            };
+            const diffHandler = new branch_1.BranchDiffHandler(options);
+            await diffHandler.run();
+        }
+        catch (error) {
+            this.error(error, { exit: 1, suggestions: error.suggestions });
+        }
+    }
+}
+exports.default = BranchDiffCommand;
+BranchDiffCommand.description = cli_utilities_1.messageHandler.parse('Differences between two branches');
+BranchDiffCommand.examples = [
+    'csdx cm:branches:diff',
+    'csdx cm:branches:diff --stack-api-key "bltxxxxxxxx"',
+    'csdx cm:branches:diff --compare-branch "develop"',
+    'csdx cm:branches:diff --compare-branch "develop" --stack-api-key "bltxxxxxxxx"',
+    'csdx cm:branches:diff --compare-branch "develop" --module "content-types"',
+    'csdx cm:branches:diff --module "content-types" --format "detailed-text"',
+    'csdx cm:branches:diff --compare-branch "develop" --format "detailed-text"',
+    'csdx cm:branches:diff --stack-api-key "bltxxxxxxxx" --base-branch "main"',
+    'csdx cm:branches:diff --stack-api-key "bltxxxxxxxx" --base-branch "main" --compare-branch "develop"',
+    'csdx cm:branches:diff --stack-api-key "bltxxxxxxxx" --base-branch "main" --module "content-types"',
+    'csdx cm:branches:diff --stack-api-key "bltxxxxxxxx" --base-branch "main" --compare-branch "develop" --module "content-types"',
+    'csdx cm:branches:diff --stack-api-key "bltxxxxxxxx" --base-branch "main" --compare-branch "develop" --module "content-types" --format "detailed-text"',
+];
+BranchDiffCommand.usage = 'cm:branches:diff [--base-branch <value>] [--compare-branch <value>] [-k <value>][--module <value>]';
+BranchDiffCommand.flags = {
+    'base-branch': cli_utilities_1.flags.string({
+        description: 'Base branch',
+    }),
+    'compare-branch': cli_utilities_1.flags.string({
+        description: 'Compare branch',
+    }),
+    module: cli_utilities_1.flags.string({
+        description: 'Module',
+        options: ['content-types', 'global-fields', 'all'],
+    }),
+    'stack-api-key': cli_utilities_1.flags.string({
+        char: 'k',
+        description: 'Provide Stack API key to show difference between branches',
+    }),
+    format: cli_utilities_1.flags.string({
+        default: 'compact-text',
+        multiple: false,
+        options: ['compact-text', 'detailed-text'],
+        description: '[Optional] Type of flags to show branches differences',
+    }),
+};
+BranchDiffCommand.aliases = []; // Note: alternative usage if any

package/lib/commands/cm/branches/index.js

@@ -0,0 +1,81 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+const cli_command_1 = require("@contentstack/cli-command");
+const cli_utilities_1 = require("@contentstack/cli-utilities");
+const index_1 = require("../../../utils/index");
+const chalk_1 = tslib_1.__importDefault(require("chalk"));
+class BranchListCommand extends cli_command_1.Command {
+    async run() {
+        var _a;
+        try {
+            const managementAPIClient = await (0, cli_utilities_1.managementSDKClient)({ host: this.cmaHost });
+            const { flags: branchListFlags } = await this.parse(BranchListCommand);
+            let stackApiKey = branchListFlags['stack-api-key'];
+            let verbose = branchListFlags['verbose'];
+            if (!stackApiKey) {
+                stackApiKey = await index_1.interactive.askStackAPIKey();
+            }
+            const baseBranch = (0, index_1.getbranchConfig)(stackApiKey) || 'main';
+            const listOfBranch = await managementAPIClient
+                .stack({ api_key: stackApiKey })
+                .branch()
+                .query()
+                .find()
+                .then(({ items }) => items)
+                .catch((err) => {
+                (0, index_1.handleErrorMsg)(err);
+            });
+            if (listOfBranch && listOfBranch.length > 0) {
+                let { currentBranch, otherBranches, branches } = (0, index_1.getbranchesList)(listOfBranch, baseBranch);
+                if (!verbose) {
+                    ((_a = currentBranch[0]) === null || _a === void 0 ? void 0 : _a.Source)
+                        ? cli_utilities_1.cliux.print(`* ${chalk_1.default.bold(currentBranch[0].Branch)} (source: ${currentBranch[0].Source})`, {
+                            color: 'blue',
+                        })
+                        : cli_utilities_1.cliux.print(`* ${chalk_1.default.bold(currentBranch[0].Branch)}`, {
+                            color: 'blue',
+                        });
+                    otherBranches.map(({ Branch, Source }) => {
+                        Source
+                            ? cli_utilities_1.cliux.print(`${Branch} (source: ${Source})`, { color: 'blue' })
+                            : cli_utilities_1.cliux.print(Branch, { color: 'blue' });
+                    });
+                }
+                else {
+                    cli_utilities_1.cliux.table(branches, {
+                        Branch: {
+                            minWidth: 8,
+                        },
+                        Source: {
+                            minWidth: 8,
+                        },
+                        Aliases: {
+                            minWidth: 8,
+                        },
+                        Created: {
+                            minWidth: 8,
+                        },
+                        Updated: {
+                            minWidth: 8,
+                        },
+                    }, {
+                        printLine: cli_utilities_1.cliux.print,
+                    });
+                }
+            }
+        }
+        catch (error) {
+            cli_utilities_1.cliux.error('error', error);
+        }
+    }
+}
+exports.default = BranchListCommand;
+BranchListCommand.description = cli_utilities_1.messageHandler.parse('List the branches'); // Note: Update the description
+BranchListCommand.examples = ['csdx cm:branches', 'csdx cm:branches --verbose', 'csdx cm:branches -k <stack api key>']; // Note: Add and modify the examples
+BranchListCommand.usage = 'cm:branches'; // Note: Add and modify the usage
+BranchListCommand.flags = {
+    'stack-api-key': cli_utilities_1.flags.string({ char: 'k', description: 'Stack API Key' }),
+    verbose: cli_utilities_1.flags.boolean({ description: 'Verbose' }),
+};
+BranchListCommand.aliases = []; // Note: alternative usage if any

package/lib/commands/cm/branches/merge.js

@@ -0,0 +1,94 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const cli_command_1 = require("@contentstack/cli-command");
+const cli_utilities_1 = require("@contentstack/cli-utilities");
+const utils_1 = require("../../../utils");
+const branch_1 = require("../../../branch");
+class BranchMergeCommand extends cli_command_1.Command {
+    async run() {
+        try {
+            let { flags: branchMergeFlags } = await this.parse(BranchMergeCommand);
+            branchMergeFlags = await (0, utils_1.setupMergeInputs)(branchMergeFlags);
+            // display branch status
+            const branchCompareData = await (0, utils_1.displayBranchStatus)({
+                stackAPIKey: branchMergeFlags['stack-api-key'],
+                baseBranch: branchMergeFlags['base-branch'],
+                compareBranch: branchMergeFlags['compare-branch'],
+                host: this.cmaHost,
+                format: 'compact-text',
+            });
+            await new branch_1.MergeHandler({
+                stackAPIKey: branchMergeFlags['stack-api-key'],
+                compareBranch: branchMergeFlags['compare-branch'],
+                strategy: branchMergeFlags.strategy,
+                strategySubOption: branchMergeFlags['strategy-sub-options'],
+                baseBranch: branchMergeFlags['base-branch'],
+                branchCompareData: branchCompareData,
+                mergeComment: branchMergeFlags.comment,
+                executeOption: branchMergeFlags['merge-action'],
+                noRevert: branchMergeFlags['no-revert'],
+                format: 'compact-text',
+                exportSummaryPath: branchMergeFlags['export-summary-path'],
+                useMergeSummary: branchMergeFlags['use-merge-summary'],
+                host: this.cmaHost,
+                enableEntryExp: true,
+            }).start();
+        }
+        catch (error) {
+            console.log('Error in Merge operations', error);
+        }
+    }
+}
+exports.default = BranchMergeCommand;
+BranchMergeCommand.description = 'Merge changes from a branch'; //TBD update the description
+BranchMergeCommand.examples = [
+    'csdx cm:branches:merge --stack-api-key bltxxxxxxxx --compare-branch feature-branch',
+    'csdx cm:branches:merge --stack-api-key bltxxxxxxxx --comment "merge comment"',
+    'csdx cm:branches:merge -k bltxxxxxxxx --base-branch base-branch',
+    'csdx cm:branches:merge --export-summary-path file/path',
+    'csdx cm:branches:merge --use-merge-summary file-path',
+    'csdx cm:branches:merge -k bltxxxxxxxx --no-revert',
+    'csdx cm:branches:merge -k bltxxxxxxxx --compare-branch feature-branch --no-revert',
+];
+BranchMergeCommand.usage = 'cm:branches:merge [-k <value>][--compare-branch <value>] [--no-revert] [--export-summary-path <value>] [--use-merge-summary <value>] [--comment <value>] [--base-branch <value>]';
+// TBD improve flag descriptions
+BranchMergeCommand.flags = {
+    'compare-branch': cli_utilities_1.flags.string({
+        description: 'Compare branch name',
+    }),
+    'base-branch': cli_utilities_1.flags.string({
+        description: 'Base branch',
+    }),
+    comment: cli_utilities_1.flags.string({
+        description: 'Merge comment',
+    }),
+    'stack-api-key': cli_utilities_1.flags.string({
+        char: 'k',
+        description: 'Provide Stack API key to show difference between branches',
+    }),
+    'export-summary-path': cli_utilities_1.flags.string({
+        description: 'Export summary file path',
+    }),
+    'use-merge-summary': cli_utilities_1.flags.string({
+        description: 'Path of merge summary file',
+    }),
+    'no-revert': cli_utilities_1.flags.boolean({
+        description: 'If passed, will not create the new revert branch',
+    }),
+    strategy: cli_utilities_1.flags.string({
+        description: 'Merge strategy',
+        options: ['merge_prefer_base', 'merge_prefer_compare', 'overwrite_with_compare', 'custom_preferences'],
+        hidden: true,
+    }),
+    'strategy-sub-options': cli_utilities_1.flags.string({
+        description: 'Merge strategy sub options',
+        options: ['new', 'modified', 'both'],
+        hidden: true,
+    }),
+    'merge-action': cli_utilities_1.flags.string({
+        description: 'Merge strategy',
+        options: ['export', 'execute', 'both'],
+        hidden: true,
+    }),
+};
+BranchMergeCommand.aliases = []; // Note: alternative usage if any

package/lib/config/index.js

@@ -0,0 +1,7 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const config = {
+    skip: 0,
+    limit: 100
+};
+exports.default = config;

package/lib/interfaces/index.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });