@contentstack/cli-cm-branches 1.1.4 → 1.2.1

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.1.4 linux-x64 node-v18.20.4
+@contentstack/cli-cm-branches/1.2.1 linux-x64 node-v18.20.6
 $ csdx --help [COMMAND]
 USAGE
   $ csdx COMMAND
@@ -63,8 +63,8 @@ USAGE
   $ csdx cm:branches
 
 FLAGS
-  -k, --stack-api-key=<value>  Stack API Key
-  --verbose                    Verbose
+  -k, --stack-api-key=<value>  Stack API key
+  --verbose                    Verbose, display information in detailed format.
 
 DESCRIPTION
   List the branches
@@ -91,8 +91,8 @@ USAGE
 
 FLAGS
   -k, --stack-api-key=<value>  Stack API key
-  --source=<value>             Source branch from which new branch to be created
-  --uid=<value>                Branch UID to be created
+  --source=<value>             Source branch from which a new branch is to be created.
+  --uid=<value>                Branch UID (unique name) to be created.
 
 DESCRIPTION
   Create a new branch
@@ -145,12 +145,13 @@ USAGE
   $ csdx cm:branches:diff [--base-branch <value>] [--compare-branch <value>] [-k <value>][--module <value>]
 
 FLAGS
-  -k, --stack-api-key=<value>  Provide Stack API key to show difference between branches
-  --base-branch=<value>        Base branch
-  --compare-branch=<value>     Compare branch
-  --format=<option>            [default: compact-text] [Optional] Type of flags to show branches differences
+  -k, --stack-api-key=<value>  [optional] Provide the stack API key to show the difference between branches.
+  --base-branch=<value>        [optional] Base branch (Target branch).
+  --compare-branch=<value>     [optional] Compare branch (Source branch).
+  --format=<option>            [default: compact-text] [default: compact-text] [optional] Type of flags to show the
+                               difference between two branches. <options: compact-text, detailed-text>
                                <options: compact-text|detailed-text>
-  --module=<option>            Module
+  --module=<option>            [optional] Module. <options: content-types, global-fields, all>
                                <options: content-types|global-fields|all>
 
 DESCRIPTION
@@ -194,13 +195,13 @@ USAGE
     [--use-merge-summary <value>] [--comment <value>] [--base-branch <value>]
 
 FLAGS
-  -k, --stack-api-key=<value>    Provide Stack API key to show difference between branches
-  --base-branch=<value>          Base branch
-  --comment=<value>              Merge comment
-  --compare-branch=<value>       Compare branch name
-  --export-summary-path=<value>  Export summary file path
-  --no-revert                    If passed, will not create the new revert branch
-  --use-merge-summary=<value>    Path of merge summary file
+  -k, --stack-api-key=<value>    [optional] Provide stack API key to show the difference between the branches.
+  --base-branch=<value>          [optional] Base branch (Target branch).
+  --comment=<value>              [optional] Pass a comment.
+  --compare-branch=<value>       [optional] Compare branch (Source branch).
+  --export-summary-path=<value>  [optional] Export summary file path.
+  --no-revert                    [optional] If passed, will not create the new revert branch.
+  --use-merge-summary=<value>    [optional] Path of merge summary file.
 
 DESCRIPTION
   Merge changes from a branch

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

@@ -41,8 +41,8 @@ BranchCreateCommand.usage = [
     'cm:branches:create [--source <value>] [--uid <value>] [--stack-api-key <value>]',
 ]; // Note: Add and modify the usage
 BranchCreateCommand.flags = {
-    uid: cli_utilities_1.flags.string({ description: 'Branch UID to be created' }),
-    source: cli_utilities_1.flags.string({ description: 'Source branch from which new branch to be created' }),
+    uid: cli_utilities_1.flags.string({ description: 'Branch UID (unique name) to be created.' }),
+    source: cli_utilities_1.flags.string({ description: 'Source branch from which a new branch is to be created.' }),
     'stack-api-key': cli_utilities_1.flags.string({ char: 'k', description: 'Stack API key' }),
 };
 BranchCreateCommand.aliases = []; // Note: alternative usage if any

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

@@ -47,24 +47,24 @@ BranchDiffCommand.examples = [
 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',
+        description: '[optional] Base branch (Target branch).',
     }),
     'compare-branch': cli_utilities_1.flags.string({
-        description: 'Compare branch',
+        description: '[optional] Compare branch (Source branch).',
     }),
     module: cli_utilities_1.flags.string({
-        description: 'Module',
+        description: '[optional] Module. <options: content-types, global-fields, all>',
         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',
+        description: '[optional] Provide the stack API key to show the 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',
+        description: '[default: compact-text] [optional] Type of flags to show the difference between two branches. <options: compact-text, detailed-text>',
     }),
 };
 BranchDiffCommand.aliases = []; // Note: alternative usage if any

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

@@ -79,7 +79,7 @@ BranchListCommand.description = cli_utilities_1.messageHandler.parse('List the b
 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' }),
+    'stack-api-key': cli_utilities_1.flags.string({ char: 'k', description: 'Stack API key' }),
+    verbose: cli_utilities_1.flags.boolean({ description: 'Verbose, display information in detailed format.' }),
 };
 BranchListCommand.aliases = []; // Note: alternative usage if any

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

@@ -64,39 +64,39 @@ BranchMergeCommand.usage = 'cm:branches:merge [-k <value>][--compare-branch <val
 // TBD improve flag descriptions
 BranchMergeCommand.flags = {
     'compare-branch': cli_utilities_1.flags.string({
-        description: 'Compare branch name',
+        description: '[optional] Compare branch (Source branch).',
     }),
     'base-branch': cli_utilities_1.flags.string({
-        description: 'Base branch',
+        description: '[optional] Base branch (Target branch).',
     }),
     comment: cli_utilities_1.flags.string({
-        description: 'Merge comment',
+        description: '[optional] Pass a comment.',
     }),
     'stack-api-key': cli_utilities_1.flags.string({
         char: 'k',
-        description: 'Provide Stack API key to show difference between branches',
+        description: '[optional] Provide stack API key to show the difference between the branches.',
     }),
     'export-summary-path': cli_utilities_1.flags.string({
-        description: 'Export summary file path',
+        description: '[optional] Export summary file path.',
     }),
     'use-merge-summary': cli_utilities_1.flags.string({
-        description: 'Path of merge summary file',
+        description: '[optional] Path of merge summary file.',
     }),
     'no-revert': cli_utilities_1.flags.boolean({
-        description: 'If passed, will not create the new revert branch',
+        description: '[optional] If passed, will not create the new revert branch.',
     }),
     strategy: cli_utilities_1.flags.string({
-        description: 'Merge strategy',
+        description: '[hidden] 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',
+        description: '[hidden] Merge strategy sub options.',
         options: ['new', 'modified', 'both'],
         hidden: true,
     }),
     'merge-action': cli_utilities_1.flags.string({
-        description: 'Merge strategy',
+        description: '[hidden] Merge action.',
         options: ['export', 'execute', 'both'],
         hidden: true,
     }),

package/lib/utils/entry-create-script.js

@@ -111,6 +111,13 @@ function entryCreateScript(contentType) {
           findAssetIdsFromJsonRte(entry, schema);
           parent.pop();
         }
+        if (
+        schema[i].data_type === 'json' &&
+        schema[i].field_metadata.extension &&
+        schema[i].field_metadata.is_asset
+        ) {
+          fetchAssetFromFileFields(parent,schema[i],entry);
+        }
         if (
           schema[i].data_type === 'text' &&
           schema[i].field_metadata &&
@@ -124,43 +131,47 @@ function entryCreateScript(contentType) {
           parent.pop();
         }
         if (schema[i].data_type === 'file') {
-          parent.push(schema[i].uid);
-          let updatedEntry = entry;
-          for (let i = 0; i < parent.length; i++) {
-            updatedEntry = updatedEntry[parent[i]];
-          }
-          const imgDetails = updatedEntry;
-          if (schema[i].multiple) {
-            if (imgDetails && imgDetails.length) {
-              imgDetails.forEach((img) => {
-                const obj = {
-                  uid: img.uid,
-                  parent_uid: img.parent_uid,
-                  description: img.description,
-                  title: img.title,
-                  filename: img.filename,
-                  url: img.url,
-                };
-                cAssetDetails.push(obj);
-              });
-            }
-          } else {
-            if (imgDetails) {
-              const obj = {
-                uid: imgDetails.uid,
-                parent_uid: imgDetails.parent_uid,
-                description: imgDetails.description,
-                title: imgDetails.title,
-                filename: imgDetails.filename,
-                url: imgDetails.url,
-              };
-              cAssetDetails.push(obj);
-            }
-          }
-          parent.pop();
+          fetchAssetFromFileFields(parent,schema[i],entry);
         }
       }
     };
+
+    function fetchAssetFromFileFields (parent, schema, entry) {
+      parent.push(schema.uid);
+      let updatedEntry = entry;
+      for (let i = 0; i < parent.length; i++) {
+        updatedEntry = updatedEntry[parent[i]];
+      }
+      const imgDetails = updatedEntry;
+      if (schema.multiple) {
+        if (imgDetails && imgDetails.length) {
+          imgDetails.forEach((img) => {
+            const obj = {
+              uid: img.uid,
+              parent_uid: img.parent_uid,
+              description: img.description,
+              title: img.title,
+              filename: img.filename,
+              url: img.url,
+            };
+            assetDetails.push(obj);
+          });
+        }
+      } else {
+        if (imgDetails) {
+          const obj = {
+            uid: imgDetails.uid,
+            parent_uid: imgDetails.parent_uid,
+            description: imgDetails.description,
+            title: imgDetails.title,
+            filename: imgDetails.filename,
+            url: imgDetails.url,
+          };
+          assetDetails.push(obj);
+        }
+      }
+      parent.pop();
+    }
   
     function findAssetIdsFromHtmlRte(entryObj, ctSchema) {
       const regex = /<img asset_uid=\\"([^"]+)\\"/g;

package/lib/utils/entry-create-update-script.js

@@ -133,6 +133,15 @@ function entryCreateUpdateScript(contentType) {
           findAssetIdsFromJsonRte(entry, schema);
           parent.pop();
         }
+
+        if (
+          schema[i].data_type === 'json' &&
+          schema[i].field_metadata.extension &&
+          schema[i].field_metadata.is_asset
+        ) {
+          fetchAssetFromFileFields(parent,schema[i],entry);
+        }
+
         if (
           schema[i].data_type === 'text' &&
           schema[i].field_metadata &&
@@ -146,44 +155,47 @@ function entryCreateUpdateScript(contentType) {
           parent.pop();
         }
         if (schema[i].data_type === 'file') {
-          parent.push(schema[i].uid);
-          let updatedEntry = entry;
-          for (let i = 0; i < parent.length; i++) {
-            updatedEntry = updatedEntry[parent[i]];
-          }
-          const imgDetails = updatedEntry;
-          if (schema[i].multiple) {
-            if (imgDetails && imgDetails.length) {
-              imgDetails.forEach((img) => {
-                const obj = {
-                  uid: img.uid,
-                  parent_uid: img.parent_uid,
-                  description: img.description,
-                  title: img.title,
-                  filename: img.filename,
-                  url: img.url,
-                };
-                assetDetails.push(obj);
-              });
-            }
-          } else {
-            if (imgDetails) {
-              const obj = {
-                uid: imgDetails.uid,
-                parent_uid: imgDetails.parent_uid,
-                description: imgDetails.description,
-                title: imgDetails.title,
-                filename: imgDetails.filename,
-                url: imgDetails.url,
-              };
-              assetDetails.push(obj);
-            }
-          }
-          parent.pop();
+          fetchAssetFromFileFields(parent,schema[i],entry);
         }
       }
     };
   
+    function fetchAssetFromFileFields (parent, schema, entry) {
+      parent.push(schema.uid);
+      let updatedEntry = entry;
+      for (let i = 0; i < parent.length; i++) {
+        updatedEntry = updatedEntry[parent[i]];
+      }
+      const imgDetails = updatedEntry;
+      if (schema.multiple) {
+        if (imgDetails && imgDetails.length) {
+          imgDetails.forEach((img) => {
+            const obj = {
+              uid: img.uid,
+              parent_uid: img.parent_uid,
+              description: img.description,
+              title: img.title,
+              filename: img.filename,
+              url: img.url,
+            };
+            assetDetails.push(obj);
+          });
+        }
+      } else {
+        if (imgDetails) {
+          const obj = {
+            uid: imgDetails.uid,
+            parent_uid: imgDetails.parent_uid,
+            description: imgDetails.description,
+            title: imgDetails.title,
+            filename: imgDetails.filename,
+            url: imgDetails.url,
+          };
+          assetDetails.push(obj);
+        }
+      }
+      parent.pop();
+    }
     function findAssetIdsFromHtmlRte(entryObj, ctSchema) {
       const regex = /<img asset_uid=\\"([^"]+)\\"/g;
       let match;

package/lib/utils/entry-update-script.js

@@ -133,6 +133,13 @@ function entryUpdateScript(contentType) {
           findAssetIdsFromJsonRte(entry, schema);
           parent.pop();
         }
+        if (
+          schema[i].data_type === 'json' &&
+          schema[i].field_metadata.extension &&
+          schema[i].field_metadata.is_asset
+        ) {
+          fetchAssetFromFileFields(parent,schema[i],entry);
+        }
         if (
           schema[i].data_type === 'text' &&
           schema[i].field_metadata &&
@@ -146,44 +153,48 @@ function entryUpdateScript(contentType) {
           parent.pop();
         }
         if (schema[i].data_type === 'file') {
-          parent.push(schema[i].uid);
-          let updatedEntry = entry;
-          for (let i = 0; i < parent.length; i++) {
-            updatedEntry = updatedEntry[parent[i]];
-          }
-          const imgDetails = updatedEntry;
-          if (schema[i].multiple) {
-            if (imgDetails && imgDetails.length) {
-              imgDetails.forEach((img) => {
-                const obj = {
-                  uid: img.uid,
-                  parent_uid: img.parent_uid,
-                  description: img.description,
-                  title: img.title,
-                  filename: img.filename,
-                  url: img.url,
-                };
-                assetDetails.push(obj);
-              });
-            }
-          } else {
-            if (imgDetails) {
-              const obj = {
-                uid: imgDetails.uid,
-                parent_uid: imgDetails.parent_uid,
-                description: imgDetails.description,
-                title: imgDetails.title,
-                filename: imgDetails.filename,
-                url: imgDetails.url,
-              };
-              assetDetails.push(obj);
-            }
-          }
-          parent.pop();
+          fetchAssetFromFileFields(parent,schema[i],entry);
         }
       }
     };
-  
+
+    function fetchAssetFromFileFields (parent, schema, entry) {
+      parent.push(schema.uid);
+      let updatedEntry = entry;
+      for (let i = 0; i < parent.length; i++) {
+        updatedEntry = updatedEntry[parent[i]];
+      }
+      const imgDetails = updatedEntry;
+      if (schema.multiple) {
+        if (imgDetails && imgDetails.length) {
+          imgDetails.forEach((img) => {
+            const obj = {
+              uid: img.uid,
+              parent_uid: img.parent_uid,
+              description: img.description,
+              title: img.title,
+              filename: img.filename,
+              url: img.url,
+            };
+            assetDetails.push(obj);
+          });
+        }
+      } else {
+        if (imgDetails) {
+          const obj = {
+            uid: imgDetails.uid,
+            parent_uid: imgDetails.parent_uid,
+            description: imgDetails.description,
+            title: imgDetails.title,
+            filename: imgDetails.filename,
+            url: imgDetails.url,
+          };
+          assetDetails.push(obj);
+        }
+      }
+      parent.pop();
+    }
+    
     function findAssetIdsFromHtmlRte(entryObj, ctSchema) {
       const regex = /<img asset_uid=\\"([^"]+)\\"/g;
       let match;

package/oclif.manifest.json

@@ -1,5 +1,5 @@
 {
-  "version": "1.1.4",
+  "version": "1.2.1",
   "commands": {
     "cm:branches:create": {
       "id": "cm:branches:create",
@@ -24,13 +24,13 @@
         "uid": {
           "name": "uid",
           "type": "option",
-          "description": "Branch UID to be created",
+          "description": "Branch UID (unique name) to be created.",
           "multiple": false
         },
         "source": {
           "name": "source",
           "type": "option",
-          "description": "Source branch from which new branch to be created",
+          "description": "Source branch from which a new branch is to be created.",
           "multiple": false
         },
         "stack-api-key": {
@@ -114,19 +114,19 @@
         "base-branch": {
           "name": "base-branch",
           "type": "option",
-          "description": "Base branch",
+          "description": "[optional] Base branch (Target branch).",
           "multiple": false
         },
         "compare-branch": {
           "name": "compare-branch",
           "type": "option",
-          "description": "Compare branch",
+          "description": "[optional] Compare branch (Source branch).",
           "multiple": false
         },
         "module": {
           "name": "module",
           "type": "option",
-          "description": "Module",
+          "description": "[optional] Module. <options: content-types, global-fields, all>",
           "multiple": false,
           "options": [
             "content-types",
@@ -138,13 +138,13 @@
           "name": "stack-api-key",
           "type": "option",
           "char": "k",
-          "description": "Provide Stack API key to show difference between branches",
+          "description": "[optional] Provide the stack API key to show the difference between branches.",
           "multiple": false
         },
         "format": {
           "name": "format",
           "type": "option",
-          "description": "[Optional] Type of flags to show branches differences",
+          "description": "[default: compact-text] [optional] Type of flags to show the difference between two branches. <options: compact-text, detailed-text>",
           "multiple": false,
           "options": [
             "compact-text",
@@ -175,13 +175,13 @@
           "name": "stack-api-key",
           "type": "option",
           "char": "k",
-          "description": "Stack API Key",
+          "description": "Stack API key",
           "multiple": false
         },
         "verbose": {
           "name": "verbose",
           "type": "boolean",
-          "description": "Verbose",
+          "description": "Verbose, display information in detailed format.",
           "allowNo": false
         }
       },
@@ -210,50 +210,50 @@
         "compare-branch": {
           "name": "compare-branch",
           "type": "option",
-          "description": "Compare branch name",
+          "description": "[optional] Compare branch (Source branch).",
           "multiple": false
         },
         "base-branch": {
           "name": "base-branch",
           "type": "option",
-          "description": "Base branch",
+          "description": "[optional] Base branch (Target branch).",
           "multiple": false
         },
         "comment": {
           "name": "comment",
           "type": "option",
-          "description": "Merge comment",
+          "description": "[optional] Pass a comment.",
           "multiple": false
         },
         "stack-api-key": {
           "name": "stack-api-key",
           "type": "option",
           "char": "k",
-          "description": "Provide Stack API key to show difference between branches",
+          "description": "[optional] Provide stack API key to show the difference between the branches.",
           "multiple": false
         },
         "export-summary-path": {
           "name": "export-summary-path",
           "type": "option",
-          "description": "Export summary file path",
+          "description": "[optional] Export summary file path.",
           "multiple": false
         },
         "use-merge-summary": {
           "name": "use-merge-summary",
           "type": "option",
-          "description": "Path of merge summary file",
+          "description": "[optional] Path of merge summary file.",
           "multiple": false
         },
         "no-revert": {
           "name": "no-revert",
           "type": "boolean",
-          "description": "If passed, will not create the new revert branch",
+          "description": "[optional] If passed, will not create the new revert branch.",
           "allowNo": false
         },
         "strategy": {
           "name": "strategy",
           "type": "option",
-          "description": "Merge strategy",
+          "description": "[hidden] Merge strategy.",
           "hidden": true,
           "multiple": false,
           "options": [
@@ -266,7 +266,7 @@
         "strategy-sub-options": {
           "name": "strategy-sub-options",
           "type": "option",
-          "description": "Merge strategy sub options",
+          "description": "[hidden] Merge strategy sub options.",
           "hidden": true,
           "multiple": false,
           "options": [
@@ -278,7 +278,7 @@
         "merge-action": {
           "name": "merge-action",
           "type": "option",
-          "description": "Merge strategy",
+          "description": "[hidden] Merge action.",
           "hidden": true,
           "multiple": false,
           "options": [

package/package.json

@@ -1,49 +1,32 @@
 {
   "name": "@contentstack/cli-cm-branches",
   "description": "Contentstack CLI plugin to do branches operations",
-  "version": "1.1.4",
+  "version": "1.2.1",
   "author": "Contentstack",
   "bugs": "https://github.com/contentstack/cli/issues",
   "dependencies": {
-    "@contentstack/cli-command": "~1.3.2",
-    "@contentstack/cli-utilities": "~1.8.0",
-    "@oclif/core": "^3.26.5",
-    "async": "^3.2.4",
-    "big-json": "^3.2.0",
-    "bluebird": "^3.7.2",
+    "@contentstack/cli-command": "~1.3.3",
+    "@contentstack/cli-utilities": "~1.8.1",
+    "@oclif/core": "^3.27.0",
     "chalk": "^4.1.2",
-    "is-valid-path": "^0.1.1",
     "just-diff": "^6.0.2",
-    "lodash": "^4.17.20",
-    "merge": "^2.1.1",
-    "mkdirp": "^1.0.4",
-    "path": "^0.12.7",
-    "progress-stream": "^2.0.0",
-    "promise-limit": "^2.7.0",
-    "proxyquire": "^2.1.3",
-    "tslib": "^2.4.1",
-    "winston": "^3.7.2"
+    "lodash": "^4.17.21"
   },
   "devDependencies": {
-    "@contentstack/cli-auth": "~1.3.22",
-    "@contentstack/cli-config": "~1.7.3",
     "@contentstack/cli-dev-dependencies": "~1.2.4",
-    "@oclif/plugin-help": "^5.1.19",
-    "@oclif/test": "^2.5.6",
-    "@types/flat": "^5.0.2",
-    "assert": "^2.0.0",
-    "chai": "^4.2.0",
-    "dotenv": "^16.0.1",
+    "@oclif/plugin-help": "^5.2.20",
+    "@types/flat": "^5.0.5",
+    "chai": "^4.5.0",
+    "dotenv": "^16.4.7",
     "dotenv-expand": "^9.0.0",
-    "eslint": "^8.18.0",
+    "eslint": "^8.57.1",
     "eslint-config-oclif": "^4.0.0",
-    "globby": "^10.0.2",
-    "mocha": "10.1.0",
+    "mocha": "10.8.2",
     "nyc": "^15.1.0",
-    "oclif": "^3.1.2",
-    "sinon": "^19.0.0",
-    "ts-node": "^10.9.1",
-    "typescript": "^4.9.3"
+    "oclif": "^3.17.2",
+    "sinon": "^19.0.2",
+    "ts-node": "^10.9.2",
+    "typescript": "^4.9.5"
   },
   "scripts": {
     "build": "npm run clean && npm run compile",