@contentstack/cli-cm-branches 1.0.10 → 1.0.11

package/README.md

@@ -37,7 +37,7 @@ $ npm install -g @contentstack/cli-cm-branches
 $ csdx COMMAND
 running command...
 $ csdx (--version)
-@contentstack/cli-cm-branches/1.0.10 linux-x64 node-v18.17.0
+@contentstack/cli-cm-branches/1.0.11 linux-x64 node-v18.17.1
 $ csdx --help [COMMAND]
 USAGE
   $ csdx COMMAND

package/lib/branch/merge-handler.js

@@ -5,7 +5,6 @@ const path_1 = tslib_1.__importDefault(require("path"));
 const forEach_1 = tslib_1.__importDefault(require("lodash/forEach"));
 const cli_utilities_1 = require("@contentstack/cli-utilities");
 const utils_1 = require("../utils");
-const enableEntryExp = false;
 class MergeHandler {
     constructor(options) {
         this.stackAPIKey = options.stackAPIKey;
@@ -42,6 +41,14 @@ class MergeHandler {
         else if (this.executeOption === 'export') {
             await this.exportSummary(mergePayload);
         }
+        else if (this.executeOption === 'merge_n_scripts') {
+            this.enableEntryExp = true;
+            await this.executeMerge(mergePayload);
+        }
+        else if (this.executeOption === 'summary_n_scripts') {
+            this.enableEntryExp = true;
+            await this.exportSummary(mergePayload);
+        }
         else {
             await this.exportSummary(mergePayload);
             await this.executeMerge(mergePayload);
@@ -183,6 +190,9 @@ class MergeHandler {
         };
         await (0, utils_1.writeFile)(path_1.default.join(this.exportSummaryPath, 'merge-summary.json'), summary);
         cli_utilities_1.cliux.success('Exported the summary successfully');
+        if (this.enableEntryExp) {
+            this.executeEntryExpFlow(this.stackAPIKey, mergePayload);
+        }
     }
     async executeMerge(mergePayload) {
         let spinner;
@@ -204,11 +214,52 @@ class MergeHandler {
             cli_utilities_1.cliux.error('Failed to merge the changes', error.message || error);
         }
     }
-    executeEntryExpFlow(mergeJobUID, mergePayload) {
-        let scriptFolderPath = (0, utils_1.generateMergeScripts)(this.mergeSettings.mergeContent, mergeJobUID);
+    async executeEntryExpFlow(mergeJobUID, mergePayload) {
+        const { mergeContent } = this.mergeSettings;
+        let mergePreference = await (0, utils_1.selectContentMergePreference)();
+        let selectedMergePreference;
+        const updateEntryMergeStrategy = (items, mergeStrategy) => {
+            items &&
+                items.forEach((item) => {
+                    item.entry_merge_strategy = mergeStrategy;
+                });
+        };
+        switch (mergePreference) {
+            case 'existing_new':
+                selectedMergePreference = 'merge_existing_new';
+                updateEntryMergeStrategy(mergeContent.content_types.added, selectedMergePreference);
+                updateEntryMergeStrategy(mergeContent.content_types.modified, selectedMergePreference);
+                break;
+            case 'new':
+                selectedMergePreference = 'merge_new';
+                updateEntryMergeStrategy(mergeContent.content_types.added, selectedMergePreference);
+                break;
+            case 'existing':
+                selectedMergePreference = 'merge_existing';
+                updateEntryMergeStrategy(mergeContent.content_types.modified, selectedMergePreference);
+                break;
+            case 'ask_preference':
+                selectedMergePreference = 'custom';
+                const selectedMergeItems = await (0, utils_1.selectContentMergeCustomPreferences)(mergeContent.content_types);
+                mergeContent.content_types = {
+                    added: [],
+                    modified: [],
+                    deleted: [],
+                };
+                selectedMergeItems.forEach((item) => {
+                    mergeContent.content_types[item.status].push(item.value);
+                });
+                break;
+            default:
+                cli_utilities_1.cliux.error(`error: Invalid preference ${mergePreference}`);
+                process.exit(1);
+        }
+        let scriptFolderPath = (0, utils_1.generateMergeScripts)(mergeContent.content_types, mergeJobUID);
         if (scriptFolderPath !== undefined) {
             cli_utilities_1.cliux.success(`\nSuccess! We have generated entry migration files in the folder ${scriptFolderPath}`);
-            cli_utilities_1.cliux.print(`\nKindly follow the steps in the guide "https://www.contentstack.com/docs/developers/cli/migrate-branch-entries" to update the migration scripts, and then run the command \n\ncsdx cm:stacks:migration --multiple --file-path ./${scriptFolderPath} --config compare-branch:${mergePayload.compare_branch} --branch ${mergePayload.base_branch} --stack-api-key ${this.stackAPIKey}`, { color: 'blue' });
+            cli_utilities_1.cliux.print('\nWARNING!!! Migration is not intended to be run more than once. Migrated(entries/assets) will be duplicated if run more than once', { color: 'yellow' });
+            const migrationCommand = `csdx cm:stacks:migration --multiple --file-path ./${scriptFolderPath} --config {compare-branch:${mergePayload.compare_branch},file-path:./${scriptFolderPath}} --branch ${mergePayload.base_branch} --stack-api-key ${this.stackAPIKey}`;
+            cli_utilities_1.cliux.print(`\nKindly follow the steps in the guide "https://www.contentstack.com/docs/developers/cli/migrate-branch-entries" to update the migration scripts, and then run the command:\n\n${migrationCommand}`, { color: 'blue' });
         }
     }
     async restartMergeProcess() {

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

@@ -35,7 +35,7 @@ class BranchMergeCommand extends cli_command_1.Command {
                 exportSummaryPath: branchMergeFlags['export-summary-path'],
                 mergeSummary: branchMergeFlags.mergeSummary,
                 host: this.cmaHost,
-                enableEntryExp: true,
+                enableEntryExp: false,
             }).start();
         }
         catch (error) {

package/lib/utils/asset-folder-create-script.js

@@ -0,0 +1,161 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.assetFolderCreateScript = void 0;
+function assetFolderCreateScript(contentType) {
+    return `
+  const fs = require('fs');
+  const path = require('path');
+  module.exports = async ({ migration, stackSDKInstance, managementAPIClient, config, branch, apiKey }) => {
+  let filePath = config['file-path'] || process.cwd();
+  let compareBranch = config['compare-branch'];
+  let folderMapper = {};
+  let folderBucket = [];
+
+  const getAssetCount = async function (branchName, isDir = false) {
+    const queryParam = {
+      asc: 'created_at',
+      include_count: true,
+      skip: 10 ** 100,
+    };
+
+    if (isDir) queryParam.query = { is_dir: true };
+
+    return await managementAPIClient
+      .stack({ api_key: stackSDKInstance.api_key, branch_uid: branchName })
+      .asset()
+      .query(queryParam)
+      .count()
+      .then(({ assets }) => assets)
+      .catch((error) => {});
+  };
+
+  async function getFolderJSON(skip, fCount, branchName, folderData = []) {
+    const queryRequestObj = {
+      skip,
+      include_folders: true,
+      query: { is_dir: true },
+    };
+
+    return await managementAPIClient
+      .stack({ api_key: stackSDKInstance.api_key, branch_uid: branchName })
+      .asset()
+      .query(queryRequestObj)
+      .find()
+      .then(async (response) => {
+        skip += 100;
+        folderData = [...folderData, ...response.items];
+        if (skip >= fCount) {
+          return folderData;
+        }
+        return await getFolderJSON(skip, fCount, branchName, folderData);
+      })
+      .catch((error) => {});
+  }
+
+  function buildTree(coll) {
+    let tree = {};
+    for (let i = 0; i < coll.length; i++) {
+      if (coll[i].parent_uid === null || !coll[i].hasOwnProperty('parent_uid')) {
+        tree[coll[i].uid] = {};
+      }
+    }
+    findBranches(tree, Object.keys(tree), coll);
+    return tree;
+  }
+
+  function findBranches(tree, branches, coll) {
+    branches.forEach((branch) => {
+      for (const element of coll) {
+        if (branch === element.parent_uid) {
+          let childUid = element.uid;
+          tree[branch][childUid] = {};
+          return findBranches(tree[branch], [childUid], coll);
+        }
+      }
+    });
+  }
+
+  function buildFolderReqObjs(baseFolderUIDs, compareAssetsFolder, tree, parent_uid) {
+    for (let leaf in tree) {
+      //folder doesn't exists
+      if (baseFolderUIDs.indexOf(leaf) === -1) {
+        let folderObj = compareAssetsFolder.filter((folder) => folder.uid === leaf);
+        if (folderObj && folderObj.length) {
+          let requestOption = {
+            folderReq: {
+              asset: {
+                name: folderObj[0].name,
+                parent_uid: parent_uid || null,
+              },
+            },
+            oldUid: leaf,
+          };
+          folderBucket.push(requestOption);
+        }
+      }
+      if (Object.keys(tree[leaf]).length > 0) {
+        buildFolderReqObjs(baseFolderUIDs, compareAssetsFolder, tree[leaf], leaf, folderBucket);
+      }
+    }
+  }
+
+  async function createFolder(payload) {
+    if (folderMapper.hasOwnProperty(payload.folderReq.asset.parent_uid)) {
+      // replace old uid with new
+      payload.folderReq.asset.parent_uid = folderMapper[payload.folderReq.asset.parent_uid];
+    }
+    await managementAPIClient
+      .stack({ api_key: apiKey, branch_uid: branch })
+      .asset()
+      .folder()
+      .create(payload.folderReq)
+      .then((res) => {
+        folderMapper[payload.oldUid] = res.uid;
+      })
+      .catch((err) => console.log(err));
+  }
+
+  const createAssetTask = () => {
+    return {
+      title: 'Create Assets Folder',
+      successTitle: 'Assets folder Created Successfully',
+      failedTitle: 'Failed to create assets folder',
+      task: async () => {
+        try {
+          const baseAssetsFolderCount = await getAssetCount(branch, true);
+          const compareAssetsFolderCount = await getAssetCount(compareBranch, true);
+          const baseAssetsFolder = await getFolderJSON(0, baseAssetsFolderCount, branch);
+          const compareAssetsFolder = await getFolderJSON(0, compareAssetsFolderCount, compareBranch);
+          if (Array.isArray(compareAssetsFolder) && Array.isArray(baseAssetsFolder)) {
+            const baseAssetUIDs = baseAssetsFolder.map((bAsset) => bAsset.uid);
+            //create new asset folder in base branch and update it in mapper
+            const tree = buildTree(compareAssetsFolder);
+            buildFolderReqObjs(baseAssetUIDs, compareAssetsFolder, tree, null);
+            for (let i = 0; i < folderBucket.length; i++) {
+              await createFolder(folderBucket[i]);
+            }
+            fs.writeFileSync(path.resolve(filePath, 'folder-mapper.json'), JSON.stringify(folderMapper));
+          }
+        } catch (error) {
+          throw error;
+        }
+      },
+    };
+  };
+  if (compareBranch && branch.length !== 0 && apiKey.length !== 0) {
+    migration.addTask(createAssetTask());
+  } else {
+    if (apiKey.length === 0) {
+      console.error('Please provide api key using --stack-api-key flag');
+    }
+    if (!compareBranch) {
+      console.error('Please provide compare branch through --config compare-branch:<value> flag');
+    }
+    if (branch.length === 0) {
+      console.error('Please provide branch name through --branch flag');
+    }
+  }
+}
+`;
+}
+exports.assetFolderCreateScript = assetFolderCreateScript;

package/lib/utils/create-merge-scripts.js

@@ -1,26 +1,49 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.createMergeScripts = exports.getContentypeMergeStatus = exports.generateMergeScripts = void 0;
+exports.createMergeScripts = exports.getContentTypeMergeStatus = exports.generateMergeScripts = void 0;
 const tslib_1 = require("tslib");
 const fs_1 = tslib_1.__importDefault(require("fs"));
+const cli_utilities_1 = require("@contentstack/cli-utilities");
 const entry_create_script_1 = require("./entry-create-script");
 const entry_update_script_1 = require("./entry-update-script");
+const entry_create_update_script_1 = require("./entry-create-update-script");
+const asset_folder_create_script_1 = require("./asset-folder-create-script");
 function generateMergeScripts(mergeSummary, mergeJobUID) {
-    var _a, _b, _c;
     try {
         let scriptFolderPath;
-        if (mergeSummary.content_types.modified && ((_a = mergeSummary.content_types.modified) === null || _a === void 0 ? void 0 : _a.length) !== 0) {
-            mergeSummary.content_types.modified.map((contentType) => {
-                let data = (0, entry_update_script_1.entryUpdateScript)(contentType.uid);
-                scriptFolderPath = createMergeScripts(contentType, data, mergeJobUID);
-            });
-        }
-        if (mergeSummary.content_types.added && ((_b = mergeSummary.content_types.added) === null || _b === void 0 ? void 0 : _b.length) !== 0) {
-            (_c = mergeSummary.content_types.added) === null || _c === void 0 ? void 0 : _c.map((contentType) => {
-                let data = (0, entry_create_script_1.entryCreateScript)(contentType.uid);
-                scriptFolderPath = createMergeScripts(contentType, data, mergeJobUID);
-            });
-        }
+        const processContentType = (contentType, scriptFunction) => {
+            let data;
+            if (contentType.uid) {
+                data = scriptFunction(contentType.uid);
+            }
+            else {
+                data = scriptFunction();
+            }
+            scriptFolderPath = createMergeScripts(contentType, mergeJobUID, data);
+        };
+        const mergeStrategies = {
+            asset_create_folder: asset_folder_create_script_1.assetFolderCreateScript,
+            merge_existing_new: entry_create_update_script_1.entryCreateUpdateScript,
+            merge_existing: entry_update_script_1.entryUpdateScript,
+            merge_new: entry_create_script_1.entryCreateScript,
+            ignore: entry_create_update_script_1.entryCreateUpdateScript,
+        };
+        const processContentTypes = (contentTypes, messageType) => {
+            if (contentTypes && contentTypes.length > 0) {
+                processContentType({ type: 'assets', uid: '', entry_merge_strategy: '' }, mergeStrategies['asset_create_folder']);
+                contentTypes.forEach((contentType) => {
+                    const mergeStrategy = contentType.entry_merge_strategy;
+                    if (mergeStrategies.hasOwnProperty(mergeStrategy)) {
+                        processContentType(contentType, mergeStrategies[mergeStrategy]);
+                    }
+                });
+            }
+            else {
+                cli_utilities_1.cliux.print(`No ${messageType} entries selected for merge`, { color: 'yellow' });
+            }
+        };
+        processContentTypes(mergeSummary.modified, 'Modified');
+        processContentTypes(mergeSummary.added, 'New');
         return scriptFolderPath;
     }
     catch (error) {
@@ -28,19 +51,22 @@ function generateMergeScripts(mergeSummary, mergeJobUID) {
     }
 }
 exports.generateMergeScripts = generateMergeScripts;
-function getContentypeMergeStatus(status) {
-    if (status === 'modified') {
+function getContentTypeMergeStatus(status) {
+    if (status === 'merge_existing') {
         return 'updated';
     }
-    else if (status === 'compare_only') {
+    else if (status === 'merge_new') {
         return 'created';
     }
+    else if (status === 'merge_existing_new') {
+        return 'created_updated';
+    }
     else {
         return '';
     }
 }
-exports.getContentypeMergeStatus = getContentypeMergeStatus;
-function createMergeScripts(contentType, content, mergeJobUID) {
+exports.getContentTypeMergeStatus = getContentTypeMergeStatus;
+function createMergeScripts(contentType, mergeJobUID, content) {
     const date = new Date();
     const rootFolder = 'merge_scripts';
     const fileCreatedAt = `${date.getFullYear()}${date.getMonth().toString.length === 1 ? `0${date.getMonth() + 1}` : date.getMonth() + 1}${date.getUTCDate()}${date.getHours()}${date.getMinutes()}${date.getSeconds()}`;
@@ -56,7 +82,14 @@ function createMergeScripts(contentType, content, mergeJobUID) {
             if (!fs_1.default.existsSync(fullPath)) {
                 fs_1.default.mkdirSync(fullPath);
             }
-            fs_1.default.writeFileSync(`${fullPath}/${fileCreatedAt}_${getContentypeMergeStatus(contentType.status)}_${contentType.uid}.js`, content, 'utf-8');
+            let filePath;
+            if (contentType.type === 'assets') {
+                filePath = `${fullPath}/${fileCreatedAt}_create_assets_folder.js`;
+            }
+            else {
+                filePath = `${fullPath}/${fileCreatedAt}_${getContentTypeMergeStatus(contentType.entry_merge_strategy)}_${contentType.uid}.js`;
+            }
+            fs_1.default.writeFileSync(filePath, content, 'utf-8');
         }
         return fullPath;
     }