fix: ♻️ change url path for compare and merge apis

Author: uttamukkoji

lib/stack/branch/compare.js

@@ -6,7 +6,7 @@ import { get } from '../../entity'
  */
 export function Compare (http, data = {}) {
   this.stackHeaders = data.stackHeaders
-  this.urlPath = `/stacks/branches/compare`
+  this.urlPath = `/stacks/branches_compare`
 
   /**
      * @description List of content types and global fields that exist in only one branch or are different between the two branches.
@@ -23,7 +23,7 @@ export function Compare (http, data = {}) {
      *
    */
   this.all = async (params = {}) => {
-    return await get(http, this.urlPath, params, data)
+    return get(http, this.urlPath, params, data)
   }
 
   /**
@@ -47,7 +47,7 @@ export function Compare (http, data = {}) {
       url = `${url}/${params.uid}`
       delete params.uid
     }
-    return await get(http, url, params, data)
+    return get(http, url, params, data)
   }
 
   /**
@@ -71,7 +71,7 @@ export function Compare (http, data = {}) {
       url = `${url}/${params.uid}`
       delete params.uid
     }
-    return await get(http, url, params, data)
+    return get(http, url, params, data)
   }
 
   return this

lib/stack/branch/index.js

@@ -113,19 +113,19 @@ export function Branch (http, data = {}) {
      * @example
      * import * as contentstack from '@contentstack/management'
      * const client = contentstack.client()
-     * 
+     *
      * const params = {
      *   base_branch: "main",
      *   compare_branch: "dev",
      *   default_merge_strategy: "merge_prefer_base",
-     *   merge_comment: "Merging dev into main", 
+     *   merge_comment: "Merging dev into main",
      *   no_revert: true,
      * }
      * const mergeObj = {
-     *   item_merge_strategies: [ 
+     *   item_merge_strategies: [
      *     {
-     *       uid: "global_field_uid", 
-     *       type: "global_field", 
+     *       uid: "global_field_uid",
+     *       type: "global_field",
      *       merge_strategy: "merge_prefer_base"
      *     }
      *   ],
@@ -134,32 +134,32 @@ export function Branch (http, data = {}) {
      * client.stack({ api_key: 'api_key'}).branch().merge(mergeObj, params)
      */
     this.merge = async (mergeObj, params) => {
-      const url = '/stacks/branches/merge';
-      const header = { 
-        headers: { ...cloneDeep(this.stackHeaders)},
+      const url = '/stacks/branches_merge'
+      const header = {
+        headers: { ...cloneDeep(this.stackHeaders) },
         params: params
       }
       try {
-        const response = await http.post(url, mergeObj, header);
-        if (response.data) return response.data;
+        const response = await http.post(url, mergeObj, header)
+        if (response.data) return response.data
         else throw error(response)
       } catch (e) {
-        throw error(e);
+        throw error(e)
       }
     }
 
     /**
      * @description Merge Queue provides list of all recent merge jobs in a Stack.
      * @memberof Branch
      * @func mergeQueue
-     * @returns {MergeQueue} Instance of MergeQueue 
+     * @returns {MergeQueue} Instance of MergeQueue
      *
      * @example
      * import * as contentstack from '@contentstack/management'
      * const client = contentstack.client()
      *
      * client.stack({ api_key: 'api_key'}).branch().mergeQueue()
-     *    
+     *
      */
     this.mergeQueue = (uid) => {
       const mergeData = { stackHeaders: this.stackHeaders, uid }
@@ -174,4 +174,4 @@ export function BranchCollection (http, data) {
   return obj.map((branchData) => {
     return new Branch(http, { branch: branchData, stackHeaders: data.stackHeaders })
   })
-}
+}

lib/stack/branch/mergeQueue.js

@@ -2,7 +2,7 @@ import { get } from '../../entity'
 
 export function MergeQueue (http, data = {}) {
   this.stackHeaders = data.stackHeaders
-  this.urlPath = `/stacks/branches/merge-queue`
+  this.urlPath = `/stacks/branches_queue`
 
   if (data.uid) {
     /**
@@ -21,7 +21,7 @@ export function MergeQueue (http, data = {}) {
     */
     this.fetch = async () => {
       const url = `${this.urlPath}/${data.uid}`
-      return await get(http, url, {}, data)
+      return get(http, url, {}, data)
     }
   } else {
     /**
@@ -39,9 +39,9 @@ export function MergeQueue (http, data = {}) {
      *
     */
     this.find = async (params = {}) => {
-      return await get(http, this.urlPath, params, data)
+      return get(http, this.urlPath, params, data)
     }
   }
 
   return this
-}
+}

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "@contentstack/management",
-  "version": "1.7.0",
+  "version": "1.8.0",
   "description": "The Content Management API is used to manage the content of your Contentstack account",
   "main": "./dist/node/contentstack-management.js",
   "browser": "./dist/web/contentstack-management.js",

package.json

@@ -3,18 +3,18 @@ import { expect } from 'chai'
 import { describe, it } from 'mocha'
 import MockAdapter from 'axios-mock-adapter'
 import { Branch, BranchCollection } from '../../lib/stack/branch'
-import { 
-  branchCompareAllMock, 
-  branchCompareContentTypeMock, 
-  branchCompareGlobalFieldMock, 
+import {
+  branchCompareAllMock,
+  branchCompareContentTypeMock,
+  branchCompareGlobalFieldMock,
   branchMergeAllMock,
   branchMergeQueueFindMock,
   branchMergeQueueFetchMock,
-  branchMock, 
-  checkSystemFields, 
-  noticeMock, 
-  stackHeadersMock, 
-  systemUidMock 
+  branchMock,
+  checkSystemFields,
+  noticeMock,
+  stackHeadersMock,
+  systemUidMock
 } from './mock/objects'
 
 describe('Contentstack Branch test', () => {
@@ -168,12 +168,12 @@ describe('Contentstack Branch test', () => {
 
   it('Branch compare all test', done => {
     var mock = new MockAdapter(axios)
-    mock.onGet('/stacks/branches/compare', { params: { base_branch: 'UID', compare_branch:'dev', skip:0, limit:100}}).reply(200, branchCompareAllMock)
+    mock.onGet('/stacks/branches_compare', { params: { base_branch: 'UID', compare_branch: 'dev', skip: 0, limit: 100 } }).reply(200, branchCompareAllMock)
     makeBranch({
       branch: {
         ...systemUidMock
       },
-      stackHeaders: { ...stackHeadersMock, authtoken: 'authtoken'}
+      stackHeaders: { ...stackHeadersMock, authtoken: 'authtoken' }
     })
       .compare('dev')
       .all({ skip: 0, limit: 100 })
@@ -189,12 +189,12 @@ describe('Contentstack Branch test', () => {
 
   it('Branch compare content types test', done => {
     var mock = new MockAdapter(axios)
-    mock.onGet('/stacks/branches/compare/content_types', { params: { base_branch: 'UID', compare_branch:'dev', skip:0, limit:100}}).reply(200, branchCompareContentTypeMock)
+    mock.onGet('/stacks/branches_compare/content_types', { params: { base_branch: 'UID', compare_branch: 'dev', skip: 0, limit: 100 } }).reply(200, branchCompareContentTypeMock)
     makeBranch({
       branch: {
         ...systemUidMock
       },
-      stackHeaders: { ...stackHeadersMock, authtoken: 'authtoken'}
+      stackHeaders: { ...stackHeadersMock, authtoken: 'authtoken' }
     })
       .compare('dev')
       .contentTypes({ skip: 0, limit: 100 })
@@ -210,12 +210,12 @@ describe('Contentstack Branch test', () => {
 
   it('Branch compare global fields test', done => {
     var mock = new MockAdapter(axios)
-    mock.onGet('/stacks/branches/compare/global_fields', { params: { base_branch: 'UID', compare_branch:'dev', skip:0, limit:100 }}).reply(200, branchCompareGlobalFieldMock)
+    mock.onGet('/stacks/branches_compare/global_fields', { params: { base_branch: 'UID', compare_branch: 'dev', skip: 0, limit: 100 } }).reply(200, branchCompareGlobalFieldMock)
     makeBranch({
       branch: {
         ...systemUidMock
       },
-      stackHeaders: { ...stackHeadersMock, authtoken: 'authtoken'}
+      stackHeaders: { ...stackHeadersMock, authtoken: 'authtoken' }
     })
       .compare('dev')
       .globalFields({ skip: 0, limit: 100 })
@@ -232,23 +232,23 @@ describe('Contentstack Branch test', () => {
   it('Branch Merge All test', done => {
     var mock = new MockAdapter(axios)
     const params = {
-      base_branch: "main",
-      compare_branch: "dev",
-      default_merge_strategy: "merge_prefer_base",
-      merge_comment: "Merging dev into main", 
-      no_revert: true,
+      base_branch: 'main',
+      compare_branch: 'dev',
+      default_merge_strategy: 'merge_prefer_base',
+      merge_comment: 'Merging dev into main',
+      no_revert: true
     }
     const mergeObj = {
-      item_merge_strategies: [ 
+      item_merge_strategies: [
         {
-          uid: "global_field_uid", 
-          type: "global_field", 
-          merge_strategy: "merge_prefer_base"
+          uid: 'global_field_uid',
+          type: 'global_field',
+          merge_strategy: 'merge_prefer_base'
         }
-      ],
+      ]
     }
-    mock.onPost('/stacks/branches/merge').reply(200, branchMergeAllMock)
-    makeBranch({ stackHeaders: { ...stackHeadersMock, authtoken: 'authtoken'} })
+    mock.onPost('/stacks/branches_merge').reply(200, branchMergeAllMock)
+    makeBranch({ stackHeaders: { ...stackHeadersMock, authtoken: 'authtoken' } })
       .merge(mergeObj, params)
       .then((response) => {
         checkBranch(response)
@@ -261,7 +261,7 @@ describe('Contentstack Branch test', () => {
 
   it('Branch MergeQueue find test', done => {
     var mock = new MockAdapter(axios)
-    mock.onGet('/stacks/branches/merge-queue').reply(200, branchMergeQueueFindMock)
+    mock.onGet('/stacks/branches_queue').reply(200, branchMergeQueueFindMock)
     makeBranch()
       .mergeQueue()
       .find()
@@ -276,7 +276,7 @@ describe('Contentstack Branch test', () => {
 
   it('Branch MergeQueue fetch test', done => {
     var mock = new MockAdapter(axios)
-    mock.onGet('/stacks/branches/merge-queue/UID').reply(200, branchMergeQueueFetchMock)
+    mock.onGet('/stacks/branches_queue/UID').reply(200, branchMergeQueueFetchMock)
     makeBranch()
       .mergeQueue('UID')
       .fetch()