@contentstack/cli-cm-branches 1.0.6 → 1.0.7

package/README.md

@@ -1,11 +1,10 @@
-# @contentstack/cli-cm-export
-
-It is Contentstack’s CLI plugin to export content from the stack. To learn how to export and import content in Contentstack, refer to the [Migration guide](https://www.contentstack.com/docs/developers/cli/migration/).
+# @contentstack/cli-cm-branches
 
+It is Contentstack’s CLI plugin to compare and merge content.
 [![License](https://img.shields.io/npm/l/@contentstack/cli)](https://github.com/contentstack/cli/blob/main/LICENSE)
 
 <!-- toc -->
-* [@contentstack/cli-cm-export](#contentstackcli-cm-export)
+* [@contentstack/cli-cm-branches](#contentstackcli-cm-branches)
 * [Usage](#usage)
 * [Commands](#commands)
 <!-- tocstop -->
@@ -38,7 +37,7 @@ $ npm install -g @contentstack/cli-cm-branches
 $ csdx COMMAND
 running command...
 $ csdx (--version)
-@contentstack/cli-cm-branches/1.0.6 linux-x64 node-v16.20.0
+@contentstack/cli-cm-branches/1.0.7 linux-x64 node-v16.20.1
 $ csdx --help [COMMAND]
 USAGE
   $ csdx COMMAND

package/lib/branch/merge-handler.js

@@ -15,7 +15,7 @@ class MergeHandler {
         this.branchCompareData = options.branchCompareData;
         this.displayFormat = options.format;
         this.exportSummaryPath = options.exportSummaryPath || path_1.default.resolve(process.cwd());
-        this.useMergeSummary = options.useMergeSummary;
+        this.mergeSummary = options.mergeSummary;
         this.userInputs = options;
         this.mergeSettings = {
             baseBranch: options.baseBranch,
@@ -28,10 +28,15 @@ class MergeHandler {
         this.enableEntryExp = options.enableEntryExp;
     }
     async start() {
+        if (this.mergeSummary) {
+            this.loadMergeSettings();
+            await this.displayMergeSummary();
+            return await this.executeMerge(this.mergeSummary.requestPayload);
+        }
         await this.collectMergeSettings();
-        // Merge final process
         const mergePayload = (0, utils_1.prepareMergeRequestPayload)(this.mergeSettings);
         if (this.executeOption === 'execute') {
+            await this.exportSummary(mergePayload);
             await this.executeMerge(mergePayload);
         }
         else if (this.executeOption === 'export') {
@@ -223,5 +228,13 @@ class MergeHandler {
         this.mergeSettings.itemMergeStrategies = [];
         await this.start();
     }
+    loadMergeSettings() {
+        this.mergeSettings.baseBranch = this.mergeSummary.requestPayload.base_branch;
+        this.mergeSettings.compareBranch = this.mergeSummary.requestPayload.compare_branch;
+        this.mergeSettings.strategy = this.mergeSummary.requestPayload.default_merge_strategy;
+        this.mergeSettings.itemMergeStrategies = this.mergeSummary.requestPayload.item_merge_strategies;
+        this.mergeSettings.noRevert = this.mergeSummary.requestPayload.no_revert;
+        this.mergeSettings.mergeComment = this.mergeSummary.requestPayload.merge_comment;
+    }
 }
 exports.default = MergeHandler;

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

@@ -29,7 +29,7 @@ class BranchMergeCommand extends cli_command_1.Command {
                 noRevert: branchMergeFlags['no-revert'],
                 format: 'compact-text',
                 exportSummaryPath: branchMergeFlags['export-summary-path'],
-                useMergeSummary: branchMergeFlags['use-merge-summary'],
+                mergeSummary: branchMergeFlags.mergeSummary,
                 host: this.cmaHost,
                 enableEntryExp: true,
             }).start();

package/lib/utils/branch-diff-utility.js

@@ -270,42 +270,63 @@ async function baseAndCompareBranchDiff(params) {
         await prepareModifiedDiff(params);
     }
     else if (baseBranchFieldExists && !compareBranchFieldExists) {
+        let displayName = baseBranchFieldExists === null || baseBranchFieldExists === void 0 ? void 0 : baseBranchFieldExists.display_name;
+        let path = baseBranchFieldExists === null || baseBranchFieldExists === void 0 ? void 0 : baseBranchFieldExists.uid;
+        let field = baseBranchFieldExists === null || baseBranchFieldExists === void 0 ? void 0 : baseBranchFieldExists.data_type;
+        if (baseBranchFieldExists.path === 'description') {
+            displayName = 'Description';
+            path = baseBranchFieldExists === null || baseBranchFieldExists === void 0 ? void 0 : baseBranchFieldExists.path;
+            field = 'metadata';
+        }
         params.listOfDeletedFields.push({
-            path: baseBranchFieldExists === null || baseBranchFieldExists === void 0 ? void 0 : baseBranchFieldExists.uid,
-            displayName: baseBranchFieldExists === null || baseBranchFieldExists === void 0 ? void 0 : baseBranchFieldExists.display_name,
+            path: path,
+            displayName: displayName,
             uid: baseBranchFieldExists === null || baseBranchFieldExists === void 0 ? void 0 : baseBranchFieldExists.uid,
-            field: baseBranchFieldExists === null || baseBranchFieldExists === void 0 ? void 0 : baseBranchFieldExists.data_type,
+            field: field,
         });
     }
     else if (!baseBranchFieldExists && compareBranchFieldExists) {
+        let displayName = compareBranchFieldExists === null || compareBranchFieldExists === void 0 ? void 0 : compareBranchFieldExists.display_name;
+        let path = compareBranchFieldExists === null || compareBranchFieldExists === void 0 ? void 0 : compareBranchFieldExists.uid;
+        let field = compareBranchFieldExists === null || compareBranchFieldExists === void 0 ? void 0 : compareBranchFieldExists.data_type;
+        if (compareBranchFieldExists.path === 'description') {
+            displayName = 'Description';
+            path = compareBranchFieldExists === null || compareBranchFieldExists === void 0 ? void 0 : compareBranchFieldExists.path;
+            field = 'metadata';
+        }
         params.listOfAddedFields.push({
-            path: compareBranchFieldExists === null || compareBranchFieldExists === void 0 ? void 0 : compareBranchFieldExists.uid,
-            displayName: compareBranchFieldExists === null || compareBranchFieldExists === void 0 ? void 0 : compareBranchFieldExists.display_name,
+            path: path,
+            displayName: displayName,
             uid: compareBranchFieldExists === null || compareBranchFieldExists === void 0 ? void 0 : compareBranchFieldExists.uid,
-            field: compareBranchFieldExists === null || compareBranchFieldExists === void 0 ? void 0 : compareBranchFieldExists.data_type,
+            field: field,
         });
     }
 }
 async function prepareModifiedDiff(params) {
     const { baseBranchFieldExists, compareBranchFieldExists } = params;
-    if (baseBranchFieldExists.path === 'description' ||
-        baseBranchFieldExists.path === 'title' ||
-        baseBranchFieldExists.path === 'options.singleton') {
+    if (compareBranchFieldExists.path === 'description' ||
+        compareBranchFieldExists.path === 'title' ||
+        compareBranchFieldExists.path === 'options.singleton') {
         let displayName;
         if (baseBranchFieldExists.path === 'options.singleton') {
-            displayName = 'Single/Multiple';
+            if (compareBranchFieldExists.value) {
+                displayName = 'Single';
+            }
+            else {
+                displayName = 'Multiple';
+            }
         }
         else if (baseBranchFieldExists.path === 'description') {
             displayName = 'Description';
         }
         else if (baseBranchFieldExists.path === 'title') {
-            displayName = 'Name';
+            displayName = 'Display Name';
         }
         params.listOfModifiedFields.push({
-            path: baseBranchFieldExists.path,
+            path: '',
             displayName: displayName,
             uid: baseBranchFieldExists.path,
-            field: 'metadata',
+            field: 'changed',
         });
     }
     else {
@@ -337,7 +358,7 @@ async function prepareModifiedDiff(params) {
                         path: field['path'],
                         displayName: field['displayName'],
                         uid: field['uid'],
-                        field: field['fieldType'],
+                        field: `${field['fieldType']} field`,
                     });
                 }
             }
@@ -377,14 +398,15 @@ exports.printVerboseTextView = printVerboseTextView;
 function printModifiedFields(modfiedFields) {
     var _a, _b, _c;
     if (((_a = modfiedFields.modified) === null || _a === void 0 ? void 0 : _a.length) || ((_b = modfiedFields.added) === null || _b === void 0 ? void 0 : _b.length) || ((_c = modfiedFields.deleted) === null || _c === void 0 ? void 0 : _c.length)) {
+        (0, forEach_1.default)(modfiedFields.modified, (diff) => {
+            const field = diff.field ? `${diff.field}` : 'field';
+            const fieldDetail = diff.path ? `(${diff.path}) ${field}` : `${field}`;
+            cli_utilities_1.cliux.print(`   ${chalk_1.default.blue(`± "${diff.displayName}" ${fieldDetail}`)}`);
+        });
         (0, forEach_1.default)(modfiedFields.added, (diff) => {
             const field = diff.field ? `${diff.field} field` : 'field';
             cli_utilities_1.cliux.print(`   ${chalk_1.default.green(`+ "${diff.displayName}" (${diff.path}) ${field}`)}`);
         });
-        (0, forEach_1.default)(modfiedFields.modified, (diff) => {
-            const field = diff.field ? `${diff.field} field` : 'field';
-            cli_utilities_1.cliux.print(`   ${chalk_1.default.blue(`± "${diff.displayName}" (${diff.path}) ${field}`)}`);
-        });
         (0, forEach_1.default)(modfiedFields.deleted, (diff) => {
             const field = diff.field ? `${diff.field} field` : 'field';
             cli_utilities_1.cliux.print(`   ${chalk_1.default.red(`- "${diff.displayName}" (${diff.path}) ${field}`)}`);

package/lib/utils/index.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.deleteBranchUtility = exports.branchDiffUtility = exports.interactive = exports.handleErrorMsg = exports.executeMergeRequest = exports.getMergeQueueStatus = exports.writeFile = exports.refreshbranchConfig = exports.getbranchConfig = exports.getbranchesList = void 0;
+exports.deleteBranchUtility = exports.branchDiffUtility = exports.interactive = exports.handleErrorMsg = exports.executeMergeRequest = exports.getMergeQueueStatus = exports.readFile = exports.writeFile = exports.refreshbranchConfig = exports.getbranchConfig = exports.getbranchesList = void 0;
 const tslib_1 = require("tslib");
 /**
  * Command specific utilities can be written here
@@ -47,6 +47,24 @@ const writeFile = (filePath, data) => {
     });
 };
 exports.writeFile = writeFile;
+// by default file type is json
+const readFile = (filePath, options = { type: 'json' }) => {
+    return new Promise((resolve, reject) => {
+        filePath = path_1.default.resolve(filePath);
+        fs_1.default.readFile(filePath, 'utf-8', (error, data) => {
+            if (error) {
+                reject(error);
+            }
+            else {
+                if (options.type !== 'json') {
+                    return resolve(data);
+                }
+                resolve(JSON.parse(data));
+            }
+        });
+    });
+};
+exports.readFile = readFile;
 async function getMergeQueueStatus(stackAPIClient, payload) {
     const mergeJobUID = payload.uid;
     return await stackAPIClient

package/lib/utils/merge-helper.js

@@ -18,20 +18,62 @@ const prepareMergeRequestPayload = (options) => {
     };
 };
 exports.prepareMergeRequestPayload = prepareMergeRequestPayload;
+function validateMergeSummary(mergeSummary) {
+    if (!mergeSummary) {
+        cli_utilities_1.cliux.error(`Error: Invalid merge summary`, { color: 'red' });
+        process.exit(1);
+    }
+    else if (!mergeSummary.requestPayload) {
+        cli_utilities_1.cliux.print(`Error: Invalid merge summary, required 'requestPayload'`, { color: 'red' });
+        process.exit(1);
+    }
+    else if (!mergeSummary.requestPayload.base_branch) {
+        cli_utilities_1.cliux.print(`Error: Invalid merge summary, required 'requestPayload.base_branch'`, { color: 'red' });
+        process.exit(1);
+    }
+    else if (!mergeSummary.requestPayload.compare_branch) {
+        cli_utilities_1.cliux.print(`Error: Invalid merge summary, required 'requestPayload.compare_branch'`, { color: 'red' });
+        process.exit(1);
+    }
+    else if (!mergeSummary.requestPayload.default_merge_strategy) {
+        cli_utilities_1.cliux.print(`Error: Invalid merge summary, required 'requestPayload.default_merge_strategy'`, { color: 'red' });
+        process.exit(1);
+    }
+    else if (!mergeSummary.requestPayload.default_merge_strategy) {
+        cli_utilities_1.cliux.print(`Error: Invalid merge summary, required 'requestPayload.default_merge_strategy'`, { color: 'red' });
+        process.exit(1);
+    }
+}
 const setupMergeInputs = async (mergeFlags) => {
+    if (mergeFlags['use-merge-summary']) {
+        let mergeSummary = (await (0, _1.readFile)(mergeFlags['use-merge-summary']));
+        validateMergeSummary(mergeSummary);
+        mergeFlags.mergeSummary = mergeSummary;
+    }
+    let { requestPayload: { base_branch = null, compare_branch = null } = {} } = mergeFlags.mergeSummary || {};
     if (!mergeFlags['stack-api-key']) {
         mergeFlags['stack-api-key'] = await (0, _1.askStackAPIKey)();
     }
     if (!mergeFlags['compare-branch']) {
-        mergeFlags['compare-branch'] = await (0, _1.askCompareBranch)();
+        if (!compare_branch) {
+            mergeFlags['compare-branch'] = await (0, _1.askCompareBranch)();
+        }
+        else {
+            mergeFlags['compare-branch'] = compare_branch;
+        }
     }
     if (!mergeFlags['base-branch']) {
-        mergeFlags['base-branch'] = (0, _1.getbranchConfig)(mergeFlags['stack-api-key']);
-        if (!mergeFlags['base-branch']) {
-            mergeFlags['base-branch'] = await (0, _1.askBaseBranch)();
+        if (!base_branch) {
+            mergeFlags['base-branch'] = (0, _1.getbranchConfig)(mergeFlags['stack-api-key']);
+            if (!mergeFlags['base-branch']) {
+                mergeFlags['base-branch'] = await (0, _1.askBaseBranch)();
+            }
+            else {
+                cli_utilities_1.cliux.print(`\nBase branch: ${mergeFlags['base-branch']}\n`, { color: 'grey' });
+            }
         }
         else {
-            cli_utilities_1.cliux.print(`\nBase branch: ${mergeFlags['base-branch']}\n`, { color: 'grey' });
+            mergeFlags['base-branch'] = base_branch;
         }
     }
     return mergeFlags;

package/oclif.manifest.json

@@ -1,5 +1,5 @@
 {
-  "version": "1.0.6",
+  "version": "1.0.7",
   "commands": {
     "cm:branches:create": {
       "id": "cm:branches:create",

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@contentstack/cli-cm-branches",
   "description": "Contentstack CLI plugin to do branches operations",
-  "version": "1.0.6",
+  "version": "1.0.7",
   "author": "Contentstack",
   "bugs": "https://github.com/contentstack/cli/issues",
   "dependencies": {
@@ -87,6 +87,13 @@
     "bin": "csdx",
     "repositoryPrefix": "<%- repo %>/blob/main/packages/contentstack-export/<%- commandPath %>"
   },
-  "csdxConfig": {},
+  "csdxConfig": {
+    "shortCommandName": {
+      "cm:branches:create": "BRCR",
+      "cm:branches:delete": "BRDEL",
+      "cm:branches:diff": "BRDIF",
+      "cm:branches:merge": "BRMRG"
+    }
+  },
   "repository": "https://github.com/contentstack/cli"
 }