test: changes based on PR feedback [CS-36688]

Author: nadeem-cs

lib/stack/branch/index.js

@@ -57,7 +57,7 @@ export function Branch (http, data = {}) {
      * import * as contentstack from '@contentstack/management'
      * const client = contentstack.client()
      *
-     * client.stack({ api_key: 'api_key'}).branch('branch_uid').compare()
+     * client.stack({ api_key: 'api_key'}).branch('branch_uid').compare('compare_uid')
      *
      */
     this.compare = (compareBranchUid) => {
@@ -113,21 +113,25 @@ export function Branch (http, data = {}) {
      * @example
      * import * as contentstack from '@contentstack/management'
      * const client = contentstack.client()
-     *
-     * client.stack({ api_key: 'api_key'}).branch().merge({
+     * 
+     * const params = {
      *   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: [ 
      *     {
      *       uid: "global_field_uid", 
      *       type: "global_field", 
      *       merge_strategy: "merge_prefer_base"
      *     }
      *   ],
-     *   merge_comment: "Merging dev into main", 
-     *   no_revert: true
-     * })
+     * }
+     *
+     * client.stack({ api_key: 'api_key'}).branch().merge(mergeObj, params)
      */
     this.merge = async (mergeObj, params) => {
       const url = '/merge';

test/unit/mock/objects.js

@@ -588,69 +588,69 @@ const installationMock = {
 }
 
 const globalFieldDiff = [{
-  "uid": "global_field_uid",
-  "title": "Global Field Title",
-  "type": "global_field",
-  "status": "base_only"
+  uid: 'global_field_uid',
+  title: 'Global Field Title',
+  type: 'global_field',
+  status: 'base_only'
 }]
 
 const contentTypeDiff = [{
-  "uid": "content_type_uid_1",
-  "title": "Content Type 1 Title",
-  "type": "content_type",
-  "status": "compare_only"
+  uid: 'content_type_uid_1',
+  title: 'Content Type 1 Title',
+  type: 'content_type',
+  status: 'compare_only'
 },
 {
-  "uid": "content_type_uid_2",
-  "title": "Content Type 2 Title",
-  "type": "content_type",
-  "status": "modified"
+  uid: 'content_type_uid_2',
+  title: 'Content Type 2 Title',
+  type: 'content_type',
+  status: 'modified'
 }]
 
 const branchCompareAllMock = {
-  "branches": {
-    "base_branch": "UID",
-    "compare_branch": "dev"
+  branches: {
+    base_branch: 'UID',
+    compare_branch: 'dev'
   },
-  "diff": [...globalFieldDiff, ...contentTypeDiff],
-  "next_url":"https://api.contentstack.io/v3/stacks/branches/compare?base_branch=main&compare_branch=dev&skip=0&limit=100"
+  diff: [...globalFieldDiff, ...contentTypeDiff],
+  next_url:'https://api.contentstack.io/v3/stacks/branches/compare?base_branch=main&compare_branch=dev&skip=0&limit=100'
 }
 
 const branchCompareContentTypeMock = {
-  "branches": {
-    "base_branch": "UID",
-    "compare_branch": "dev"
+  branches: {
+    base_branch: 'UID',
+    compare_branch: 'dev'
   },
-  "diff": [ ...contentTypeDiff ],
-  "next_url":"https://api.contentstack.io/v3/stacks/branches/compare?base_branch=main&compare_branch=dev&skip=0&limit=100"
+  diff: [ ...contentTypeDiff ],
+  next_url:'https://api.contentstack.io/v3/stacks/branches/compare?base_branch=main&compare_branch=dev&skip=0&limit=100'
 }
 
 const branchCompareGlobalFieldMock = {
-  "branches": {
-    "base_branch": "UID",
-    "compare_branch": "dev"
+  branches: {
+    base_branch: 'UID',
+    compare_branch: 'dev'
   },
-  "diff": [...globalFieldDiff],
-  "next_url":"https://api.contentstack.io/v3/stacks/branches/compare?base_branch=main&compare_branch=dev&skip=0&limit=100"
+  diff: [...globalFieldDiff],
+  next_url:'https://api.contentstack.io/v3/stacks/branches/compare?base_branch=main&compare_branch=dev&skip=0&limit=100'
 }
 
 const branchMergeAllMock = {
-  "uid": "UID",
-  "stack": "stack_uid",
-  "created_at": "created_at_date",
-  "updated_at": "updated_at_date",
-  "created_by": "created_by_user_uid",
-  "updated_by": "updated_by_user_uid",
-  "merge_details": {
-    "base_branch": "main",
-    "compare_branch": "dev",
-    "status": "in_progress"
+  uid: 'UID',
+  stack: 'stack_uid',
+  created_at: 'created_at_date',
+  updated_at: 'updated_at_date',
+  created_by: 'created_by_user_uid',
+  updated_by: 'updated_by_user_uid',
+  merge_details: {
+    base_branch: 'main',
+    compare_branch: 'dev',
+    status: 'in_progress'
   },
-  "merged_at": null,
-  "errors": [ 
+  merged_at: null,
+  errors: [ 
     {
-      "code": "error_code",
-      "message": "Error message"
+      code: 'error_code',
+      message: 'Error message'
     }
   ]
 }
@@ -660,7 +660,7 @@ const branchMergeQueueFetchMock = {
 }
 
 const branchMergeQueueFindMock = {
-  "queue": [
+  queue: [
     { ...branchMergeQueueFetchMock }
   ]
 }

types/stack/branch/compare.d.ts

@@ -1,11 +1,10 @@
-import { Response } from '../../contentstackCollection';
 import { AnyProperty } from '../../utility/fields';
 import { Pagination } from '../../utility/pagination';
 
 export interface Compare {
     all(params: Pagination & AnyProperty): Promise<AnyProperty>
-    contentTypes(params: Params) : Promise<Response>
-    globalFields(params: Params) : Promise<Response>
+    contentTypes(params: Params) : Promise<AnyProperty>
+    globalFields(params: Params) : Promise<AnyProperty>
 }
 
 export type Params = {

types/stack/branch/index.d.ts

@@ -1,7 +1,12 @@
 import { AnyProperty, SystemFields } from "../../utility/fields";
 import { Queryable, SystemFunction } from "../../utility/operations";
+import { Compare } from "./compare";
+import { MergeQueue, MergeQueues } from "./merge-queue";
 
 export interface Branch extends SystemFields, SystemFunction<Branch> {
+    compare(compareBranchUid: string): Compare
+    mergeQueue(mergeJobUid?: string): MergeQueue | MergeQueues
+    merge(mergeObj: IMergeObj, params: IMergeParams)
 }
 
 export interface Branches extends Queryable<Branch, {branch: BranchData}> {
@@ -10,4 +15,24 @@ export interface Branches extends Queryable<Branch, {branch: BranchData}> {
 export interface BranchData extends AnyProperty {
     uid: string
     source: string
+}
+
+export interface IMergeObj {
+    item_merge_strategies?: IMergeStrategy[]
+}
+
+export interface IMergeStrategy {
+    uid: string
+    type: string
+    merge_strategy: MergeStrategy
+}
+
+export type MergeStrategy = "merge_prefer_base" | "merge_prefer_compare" | "overwrite_with_compare" | "merge_new_only" | "merge_modified_only_prefer_base" | "merge_modified_only_prefer_compare" | "ignore"
+
+export interface IMergeParams {
+    base_branch: string
+    compare_branch: string
+    default_merge_strategy: MergeStrategy
+    merge_comment: string
+    no_revert?: boolean
 }

types/stack/branch/merge-queue.d.ts

@@ -1,4 +1,3 @@
-import { Response } from "../../contentstackCollection"
 import { AnyProperty } from "../../utility/fields"
 
 export interface MergeQueue {