feat: add support for branch settings

Author: naman-contentstack

.talismanrc

@@ -36,8 +36,6 @@ fileignoreconfig:
     checksum: 2597efae3c1ab8cc173d5bf205f1c76932211f8e0eb2a16444e055d83481976c
   - filename: test/unit/concurrency-Queue-test.js
     checksum: 186438f9eb9ba4e7fd7f335dbea2afbae9ae969b7ae3ab1b517ec7a1633d255e
+  - filename: lib/stack/branch/index.js
+    checksum: f09b33c0a144139b7ffddcd7dc39fa6cee3bc42eadc06f11c8495c48d740341c
 version: "1.0"
-
-
-
-

lib/stack/branch/index.js

@@ -1,23 +1,23 @@
-import cloneDeep from 'lodash/cloneDeep'
-import { create, query, fetch, deleteEntity } from '../../entity'
-import { Compare } from './compare'
-import { MergeQueue } from './mergeQueue'
-import error from '../../core/contentstackError'
+import cloneDeep from "lodash/cloneDeep";
+import { create, query, fetch, deleteEntity } from "../../entity";
+import { Compare } from "./compare";
+import { MergeQueue } from "./mergeQueue";
+import error from "../../core/contentstackError";
 
 /**
  *
  * @namespace Branch
  */
-export function Branch (http, data = {}) {
-  this.stackHeaders = data.stackHeaders
-  this.urlPath = `/stacks/branches`
+export function Branch(http, data = {}) {
+  this.stackHeaders = data.stackHeaders;
+  this.urlPath = `/stacks/branches`;
 
-  data.branch = data.branch || data.branch_alias
-  delete data.branch_alias
+  data.branch = data.branch || data.branch_alias;
+  delete data.branch_alias;
 
   if (data.branch) {
-    Object.assign(this, cloneDeep(data.branch))
-    this.urlPath = `/stacks/branches/${this.uid}`
+    Object.assign(this, cloneDeep(data.branch));
+    this.urlPath = `/stacks/branches/${this.uid}`;
 
     /**
      * @description The Delete Branch call is used to delete an existing Branch permanently from your Stack.
@@ -31,7 +31,7 @@ export function Branch (http, data = {}) {
      * client.stack({ api_key: 'api_key'}).branch('branch_uid').delete()
      * .then((response) => console.log(response.notice))
      */
-    this.delete = deleteEntity(http, true)
+    this.delete = deleteEntity(http, true);
 
     /**
      * @description The fetch Branch call fetches Branch details.
@@ -46,7 +46,7 @@ export function Branch (http, data = {}) {
      * .then((branch) => console.log(branch))
      *
      */
-    this.fetch = fetch(http, 'branch')
+    this.fetch = fetch(http, "branch");
 
     /**
      * @description Compare allows you to compare any or specific ContentType or GlobalFields.
@@ -61,15 +61,39 @@ export function Branch (http, data = {}) {
      *
      */
     this.compare = (compareBranchUid) => {
-      const compareData = { stackHeaders: this.stackHeaders }
+      const compareData = { stackHeaders: this.stackHeaders };
       if (compareBranchUid) {
         compareData.branches = {
           base_branch: this.uid,
-          compare_branch: compareBranchUid
-        }
+          compare_branch: compareBranchUid,
+        };
       }
-      return new Compare(http, compareData)
-    }
+      return new Compare(http, compareData);
+    };
+
+    /**
+     * @description The Update Branch Settings call updates the settings of an existing Branch.
+     * @memberof Branch
+     * @func updateSettings
+     * @param {IBranchSettings} payload - The settings payload to update.
+     * @returns {Promise<Object>} Response Object.
+     * @example
+     * import * as contentstack from '@contentstack/management'
+     * const client = contentstack.client()
+     * client.stack({ api_key: 'api_key' }).branch('branch_uid').updateSettings(payload)
+     * .then((response) => console.log(response.notice))
+     */
+    this.updateSettings = async (payload) => {
+      try {
+        const response = await http.post(`${this.urlPath}/settings`, payload, {
+          headers: { ...cloneDeep(this.stackHeaders) },
+        });
+        if (response.data) return response.data;
+        else throw error(response);
+      } catch (e) {
+        throw error(e);
+      }
+    };
   } else {
     /**
      * @description The Create a Branch call creates a new branch in a particular stack of your Contentstack account.
@@ -87,7 +111,7 @@ export function Branch (http, data = {}) {
      * client.stack({ api_key: 'api_key'}).branch().create({ branch })
      * .then((branch) => { console.log(branch) })
      */
-    this.create = create({ http: http })
+    this.create = create({ http: http });
 
     /**
      * @description The 'Get all Branch' request returns comprehensive information about branches created in a Stack.
@@ -102,7 +126,7 @@ export function Branch (http, data = {}) {
      * client.stack({ api_key: 'api_key'}).branch().query().find()
      * .then((collection) => { console.log(collection) })
      */
-    this.query = query({ http, wrapperCollection: BranchCollection })
+    this.query = query({ http, wrapperCollection: BranchCollection });
 
     /**
      * @description Merge allows user to merge branches in a Stack.
@@ -135,19 +159,19 @@ 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 url = "/stacks/branches_merge";
       const header = {
         headers: { ...cloneDeep(this.stackHeaders) },
-        params: params
-      }
+        params: params,
+      };
       try {
-        const response = await http.post(url, mergeObj, header)
-        if (response.data) return response.data
-        else throw error(response)
+        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.
@@ -163,16 +187,19 @@ export function Branch (http, data = {}) {
      *
      */
     this.mergeQueue = (uid) => {
-      const mergeData = { stackHeaders: this.stackHeaders, uid }
-      return new MergeQueue(http, mergeData)
-    }
+      const mergeData = { stackHeaders: this.stackHeaders, uid };
+      return new MergeQueue(http, mergeData);
+    };
   }
-  return this
+  return this;
 }
 
-export function BranchCollection (http, data) {
-  const obj = cloneDeep(data.branches) || data.branch_aliases || []
+export function BranchCollection(http, data) {
+  const obj = cloneDeep(data.branches) || data.branch_aliases || [];
   return obj.map((branchData) => {
-    return new Branch(http, { branch: branchData, stackHeaders: data.stackHeaders })
-  })
+    return new Branch(http, {
+      branch: branchData,
+      stackHeaders: data.stackHeaders,
+    });
+  });
 }

test/unit/branch-test.js

@@ -166,6 +166,33 @@ describe('Contentstack Branch test', () => {
       .catch(done)
   })
 
+  it('Branch updateSettings test', done => {
+    var mock = new MockAdapter(axios)
+    mock.onPost('/stacks/branches/UID/settings').reply(200, { ...noticeMock })
+    makeBranch({
+      branch: {
+        ...systemUidMock
+      },
+      stackHeaders: stackHeadersMock
+    })
+      .updateSettings({
+        branch: {
+          settings: {
+            am_v2: {
+              linked_workspaces: [
+                { uid: 'branch_uid', space_uid: 'space_uid', is_default: true }
+              ]
+            }
+          }
+        }
+      })
+      .then((response) => {
+        expect(response.notice).to.be.equal(noticeMock.notice)
+        done()
+      })
+      .catch(done)
+  })
+
   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)

types/stack/branch/index.d.ts

@@ -5,6 +5,7 @@ import { MergeQueue, MergeQueues } from "./merge-queue";
 
 export interface Branch extends SystemFields, SystemFunction<Branch> {
     compare(compareBranchUid: string): Compare
+    updateSettings(payload: IBranchSettings): Promise<IBranchSettingsResponse>
 }
 
 export interface Branches extends Queryable<Branch, {branch: BranchData}> {
@@ -18,6 +19,29 @@ export interface BranchData extends AnyProperty {
     source: string
 }
 
+export interface ILinkedWorkspace {
+    uid: string
+    space_uid: string
+    is_default: boolean
+    operation?: string
+}
+
+export interface IBranchSettingsData {
+    am_v2?: {
+        linked_workspaces: ILinkedWorkspace[]
+    }
+}
+
+export interface IBranchSettings {
+    branch: {
+        settings: IBranchSettingsData
+    }
+}
+
+export interface IBranchSettingsResponse {
+    notice: string
+}
+
 export interface IMergeObj {
     item_merge_strategies?: IMergeStrategy[]
 }