feat: ✨ Content Branching feature

Author: uttamukkoji

lib/contentstackClient.js

@@ -61,7 +61,8 @@ export default function contentstackClient ({ http }) {
    * @memberof ContentstackClient
    * @func stack
    * @param {String} api_key - Stack API Key
-   * @param {String} management_token - Stack API Key
+   * @param {String} management_token - Management token for Stack.
+   * @param {String} branch_name - Branch name or alias to access specific branch. Default is master.
    * @returns {Stack} Instance of Stack
    *
    * @example
@@ -85,6 +86,12 @@ export default function contentstackClient ({ http }) {
    * client.stack({ api_key: 'api_key', management_token: 'management_token' }).contentType('content_type_uid').fetch()
    * .then((stack) => console.log(stack))
    *
+   * @example
+   * import * as contentstack from '@contentstack/management'
+   * const client = contentstack.client()
+   *
+   * client.stack({ api_key: 'api_key', management_token: 'management_token', branch_name: 'branch' }).contentType('content_type_uid').fetch()
+   * .then((stack) => console.log(stack))
    */
   function stack (params = {}) {
     const stack = { ...cloneDeep(params) }

lib/stack/branch/index.js

@@ -0,0 +1,105 @@
+import cloneDeep from 'lodash/cloneDeep'
+import { create, query, update, fetch, deleteEntity } from '../../entity'
+
+/**
+ *
+ * @namespace Branch
+ */
+export function Branch (http, data = {}) {
+  this.stackHeaders = data.stackHeaders
+  this.urlPath = `/stacks/branches`
+  if (data.branch) {
+    Object.assign(this, cloneDeep(data.branch))
+    this.urlPath = `/stacks/branches/${this.name}`
+
+    /**
+     * @description The Update Branch call lets you update the name of an existing Branch.
+     * @memberof Branch
+     * @func update
+     * @returns {Promise<Branch.Branch>} Promise for Branch instance
+     * @example
+     * import * as contentstack from '@contentstack/management'
+     * const client = contentstack.client()
+     *
+     * client.stack({ api_key: 'api_key'}).branch('branch_name').fetch()
+     * .then((branch) => {
+     *  branch.name = 'new_branch_name'
+     *  return branch.update()
+     * })
+     * .then((branch) => console.log(branch))
+     *
+     */
+    this.update = update(http, 'token')
+
+    /**
+     * @description The Delete Branch call is used to delete an existing Branch permanently from your Stack.
+     * @memberof Branch
+     * @func delete
+     * @returns {Object} Response Object.
+     * @example
+     * import * as contentstack from '@contentstack/management'
+     * const client = contentstack.client()
+     *
+     * client.stack({ api_key: 'api_key'}).branch('branch_name').delete()
+     * .then((response) => console.log(response.notice))
+     */
+    this.delete = deleteEntity(http)
+
+    /**
+     * @description The fetch Branch call fetches Branch details.
+     * @memberof Branch
+     * @func fetch
+     * @returns {Promise<Branch.Branch>} Promise for Branch instance
+     * @example
+     * import * as contentstack from '@contentstack/management'
+     * const client = contentstack.client()
+     *
+     * client.stack({ api_key: 'api_key'}).branch('branch_name').fetch()
+     * .then((branch) => console.log(branch))
+     *
+     */
+    this.fetch = fetch(http, 'branch')
+  } else {
+    /**
+     * @description The Create a Branch call creates a new branch in a particular stack of your Contentstack account.
+     * @memberof Branch
+     * @func create
+     * @returns {Promise<Branch.Branch>} Promise for Branch instance
+     *
+     * @example
+     * import * as contentstack from '@contentstack/management'
+     * const client = contentstack.client()
+     * const branch = {
+     *      name: 'branch_name',
+     *      source: 'master'
+     * }
+     * client.stack({ api_key: 'api_key'}).branch().create({ branch })
+     * .then((branch) => { console.log(branch) })
+     */
+    this.create = create({ http: http })
+
+    /**
+     * @description The 'Get all Branch' request returns comprehensive information about branch created in a Stack.
+     * @memberof Branch
+     * @func query
+     * @returns {Promise<ContentstackCollection.ContentstackCollection>} Promise for ContentstackCollection instance
+     *
+     * @example
+     * import * as contentstack from '@contentstack/management'
+     * const client = contentstack.client()
+     *
+     * client.stack({ api_key: 'api_key'}).branch().query().find()
+     * .then((collection) => { console.log(collection) })
+     */
+    this.query = query({ http, wrapperCollection: BranchCollection })
+  }
+  return this
+}
+
+export function BranchCollection (http, data) {
+  const obj = cloneDeep(data.branch) || []
+  const branchCollection = obj.map((userdata) => {
+    return new Branch(http, { branch: userdata, stackHeaders: data.stackHeaders })
+  })
+  return branchCollection
+}

lib/stack/index.js

@@ -15,6 +15,7 @@ import { Workflow } from './workflow'
 import { Release } from './release'
 import { BulkOperation } from './bulkOperation'
 import { Label } from './label'
+import { Branch } from './branch'
 // import { format } from 'util'
 /**
  * A stack is a space that stores the content of a project (a web or mobile property). Within a stack, you can create content structures, content entries, users, etc. related to the project. Read more about <a href='https://www.contentstack.com/docs/guide/stack'>Stacks</a>.
@@ -31,10 +32,11 @@ export function Stack (http, data) {
   }
   if (data && data.stack && data.stack.api_key) {
     this.stackHeaders = { api_key: this.api_key }
-    if (this.management_token && this.management_token) {
+    if (this.management_token && this.management_token !== undefined) {
       this.stackHeaders.authorization = this.management_token
       delete this.management_token
     }
+
     /**
      * @description The Update stack call lets you update the name and description of an existing stack.
      * @memberof Stack
@@ -178,6 +180,36 @@ export function Stack (http, data) {
       }
       return new Environment(http, data)
     }
+
+    /**
+     * @description
+     * @param {String}
+     * @returns {Branch}
+     *
+     * @example
+     * import * as contentstack from '@contentstack/management'
+     * const client = contentstack.client()
+     *
+     * client.stack({ api_key: 'api_key'}).branch().create()
+     * .then((branch) => console.log(branch))
+     *
+     * client.stack({ api_key: 'api_key', branch_name: 'branch'}).branch().fetch()
+     * .then((branch) => console.log(branch))
+     *
+     * client.stack({ api_key: 'api_key' }).branch('branch').fetch()
+     * .then((branch) => console.log(branch))
+     *
+     */
+    this.branch = (branchId = null) => {
+      const data = { stackHeaders: this.stackHeaders }
+      if (branchId) {
+        data.branch = { name: branchId }
+      } else if (this.branch_name) {
+        data.branch = { name: this.branch_name }
+      }
+      return new Branch(http, data)
+    }
+
     /**
      * @description Delivery Tokens provide read-only access to the associated environments.
      * @param {String} deliveryTokenUid The UID of the Delivery Token field you want to get details.