Merge branch 'feature/content-branching' into feature/nested-publish

Author: uttamukkoji

.jsdoc.json

@@ -16,9 +16,12 @@
             "lib/stack/contentType/entry/index.js",
             "lib/stack/asset/index.js",
             "lib/stack/asset/folders/index.js",
+            "lib/stack/branch/index.js",
+            "lib/stack/branchAlias/index.js",
             "lib/stack/bulkOperation/index.js",
             "lib/stack/extension/index.js",
             "lib/stack/release/index.js",
+            "lib/stack/release/items/index.js",
             "lib/stack/label/index.js",
             "lib/stack/locale/index.js",
             "lib/stack/environment/index.js",

lib/contentstack.js

@@ -142,8 +142,7 @@ export function client (params = {}) {
     ...requiredHeaders
   }
   const http = httpClient(params)
-  const api = contentstackClient({
+  return contentstackClient({
     http: http
   })
-  return api
 }

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_uid: 'branch_uid' }).contentType('content_type_uid').fetch()
+   * .then((stack) => console.log(stack))
    */
   function stack (params = {}) {
     const stack = { ...cloneDeep(params) }

lib/entity.js

@@ -168,7 +168,7 @@ export const update = (http, type) => {
   }
 }
 
-export const deleteEntity = (http) => {
+export const deleteEntity = (http, force = false) => {
   return async function (param = {}) {
     try {
       const headers = {
@@ -177,12 +177,21 @@ export const deleteEntity = (http) => {
           ...cloneDeep(param)
         }
       } || {}
-
+      if (force === true) {
+        headers.params.force = true
+      }
       const response = await http.delete(this.urlPath, headers)
       if (response.data) {
         return response.data
       } else {
-        throw error(response)
+        if (response.status >= 200 && response.status < 300) {
+          return {
+            status: response.status,
+            statusText: response.statusText
+          }
+        } else {
+          throw error(response)
+        }
       }
     } catch (err) {
       throw error(err)

lib/stack/branch/index.js

@@ -0,0 +1,90 @@
+import cloneDeep from 'lodash/cloneDeep'
+import { create, query, fetch, deleteEntity } from '../../entity'
+
+/**
+ *
+ * @namespace Branch
+ */
+export function Branch (http, data = {}) {
+  this.stackHeaders = data.stackHeaders
+  this.urlPath = `/stacks/branches`
+
+  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}`
+
+    /**
+     * @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_uid').delete()
+     * .then((response) => console.log(response.notice))
+     */
+    this.delete = deleteEntity(http, true)
+
+    /**
+     * @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_uid').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.branches) || data.branch_aliases || []
+  return obj.map((branchData) => {
+    return new Branch(http, { branch: branchData, stackHeaders: data.stackHeaders })
+  })
+}

lib/stack/branchAlias/index.js

@@ -0,0 +1,114 @@
+import cloneDeep from 'lodash/cloneDeep'
+import error from '../../core/contentstackError'
+import { deleteEntity, fetchAll, parseData } from '../../entity'
+import { Branch, BranchCollection } from '../branch'
+
+/**
+ *
+ * @namespace BranchAlias
+ */
+export function BranchAlias (http, data = {}) {
+  this.stackHeaders = data.stackHeaders
+  this.urlPath = `/stacks/branch_aliases`
+  if (data.branch_alias) {
+    Object.assign(this, cloneDeep(data.branch_alias))
+    this.urlPath = `/stacks/branch_aliases/${this.uid}`
+
+    /**
+     * @description The Update BranchAlias call lets you update the name of an existing BranchAlias.
+     * @memberof BranchAlias
+     * @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'}).branchAlias('branch_alias_id').createOrUpdate('branch_uid')
+     * .then((branch) => {
+     *  branch.name = 'new_branch_name'
+     *  return branch.update()
+     * })
+     * .then((branch) => console.log(branch))
+     *
+     */
+    this.createOrUpdate = async (targetBranch) => {
+      try {
+        const response = await http.put(this.urlPath, { branch_alias: { target_branch: targetBranch } }, { headers: {
+          ...cloneDeep(this.stackHeaders)
+        }
+        })
+        if (response.data) {
+          return new Branch(http, parseData(response, this.stackHeaders))
+        } else {
+          throw error(response)
+        }
+      } catch (err) {
+        throw error(err)
+      }
+    }
+    /**
+     * @description The Delete BranchAlias call is used to delete an existing BranchAlias permanently from your Stack.
+     * @memberof BranchAlias
+     * @func delete
+     * @returns {Object} Response Object.
+     * @example
+     * import * as contentstack from '@contentstack/management'
+     * const client = contentstack.client()
+     *
+     * client.stack({ api_key: 'api_key'}).branchAlias('branch_alias_id').delete()
+     * .then((response) => console.log(response.notice))
+     */
+    this.delete = deleteEntity(http, true)
+
+    /**
+     * @description The fetch BranchAlias call fetches BranchAlias details.
+     * @memberof BranchAlias
+     * @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'}).branchAlias('branch_alias_id').fetch()
+     * .then((branch) => console.log(branch))
+     *
+     */
+    this.fetch = async function (param = {}) {
+      try {
+        const headers = {
+          headers: { ...cloneDeep(this.stackHeaders) },
+          params: {
+            ...cloneDeep(param)
+          }
+        } || {}
+        const response = await http.get(this.urlPath, headers)
+        if (response.data) {
+          return new Branch(http, parseData(response, this.stackHeaders))
+        } else {
+          throw error(response)
+        }
+      } catch (err) {
+        throw error(err)
+      }
+    }
+  } else {
+    /**
+     * @description The Get all BranchAlias request retrieves the details of all the Branch of a stack.
+     * @memberof BranchAlias
+     * @func fetchAll
+     * @param {Int} limit The limit parameter will return a specific number of Branch in the output.
+     * @param {Int} skip The skip parameter will skip a specific number of Branch in the output.
+     * @param {Boolean}include_count To retrieve the count of Branch.
+     * @returns {ContentstackCollection} Result collection of content of specified module.
+     * @example
+     * import * as contentstack from '@contentstack/management'
+     * const client = contentstack.client()
+     *
+     * client.stack({ api_key: 'api_key'}).branchAlias().fetchAll()
+     * .then((collection) => console.log(collection))
+     *
+     */
+    this.fetchAll = fetchAll(http, BranchCollection)
+  }
+  return this
+}

lib/stack/index.js

@@ -15,6 +15,8 @@ import { Workflow } from './workflow'
 import { Release } from './release'
 import { BulkOperation } from './bulkOperation'
 import { Label } from './label'
+import { Branch } from './branch'
+import { BranchAlias } from './branchAlias'
 // 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 +33,14 @@ 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
     }
+
+    if (this.branch_uid) {
+      this.stackHeaders.branch = this.branch_uid
+    }
     /**
      * @description The Update stack call lets you update the name and description of an existing stack.
      * @memberof Stack
@@ -178,6 +184,55 @@ export function Stack (http, data) {
       }
       return new Environment(http, data)
     }
+
+    /**
+     * @description Branch corresponds to Stack branch.
+     * @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('branch_uid').fetch()
+     * .then((branch) => console.log(branch))
+     *
+     */
+    this.branch = (branchUid = null) => {
+      const data = { stackHeaders: this.stackHeaders }
+      if (branchUid) {
+        data.branch = { uid: branchUid }
+      }
+      return new Branch(http, data)
+    }
+
+    /**
+     * @description Branch corresponds to Stack branch.
+     * @param {String}
+     * @returns {BranchAlias}
+     *
+     * @example
+     * import * as contentstack from '@contentstack/management'
+     * const client = contentstack.client()
+     *
+     * client.stack({ api_key: 'api_key'}).branchAlias().create()
+     * .then((branch) => console.log(branch))
+     *
+     * client.stack({ api_key: 'api_key' }).branchAlias('branch_alias_uid').fetch()
+     * .then((branch) => console.log(branch))
+     *
+     */
+    this.branchAlias = (branchUid = null) => {
+      const data = { stackHeaders: this.stackHeaders }
+      if (branchUid) {
+        data.branch_alias = { uid: branchUid }
+      }
+      return new BranchAlias(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.