docs: 📝 Update Documentation for workflow

Author: uttamukkoji

.jsdoc.json

@@ -24,7 +24,10 @@
             "lib/stack/environment/index.js",
             "lib/stack/deliveryToken/index.js",
             "lib/stack/roles/index.js",
-            "lib/stack/webhook/index.js"
+            "lib/stack/webhook/index.js",
+            "lib/stack/workflow/index.js",
+            "lib/stack/workflow/publishRules/index.js"
+
         ],
         "excludePattern": "(node_modules/|jsdocs)"
     },

lib/stack/workflow/index.js

@@ -3,13 +3,9 @@ import {
   create,
   update,
   deleteEntity,
-  fetch,
-  upload,
-  parseData
+  fetch
 } from '../../entity'
 import error from '../../core/contentstackError'
-import FormData from 'form-data'
-import { createReadStream } from 'fs'
 import ContentstackCollection from '../../contentstackCollection'
 import { PublishRules, PublishRulesCollection } from './publishRules'
 
@@ -60,20 +56,20 @@ export function Workflow (http, data = {}) {
      *
      */
     this.disable = async function () {
-        try {
-            const response = await http.get(`/workflows/${this.uid}/disable`, { 
-                headers: {
-                    ...cloneDeep(this.stackHeaders)
-                },
-            })
-            if (response.data) {
-                return response.data
-            } else {
-                throw error(response)
-            }
-        } catch (err) {
-            throw error(err)
+      try {
+        const response = await http.get(`/workflows/${this.uid}/disable`, {
+          headers: {
+            ...cloneDeep(this.stackHeaders)
+          }
+        })
+        if (response.data) {
+          return response.data
+        } else {
+          throw error(response)
         }
+      } catch (err) {
+        throw error(err)
+      }
     }
 
     /**
@@ -90,23 +86,22 @@ export function Workflow (http, data = {}) {
      *
      */
     this.enable = async function () {
-        try {
-            const response = await http.get(`/workflows/${this.uid}/enable`, { 
-                headers: {
-                    ...cloneDeep(this.stackHeaders)
-                },
-            })
-            if (response.data) {
-                return response.data
-            } else {
-                throw error(response)
-            }
-        } catch (err) {
-            throw error(err)
+      try {
+        const response = await http.get(`/workflows/${this.uid}/enable`, {
+          headers: {
+            ...cloneDeep(this.stackHeaders)
+          }
+        })
+        if (response.data) {
+          return response.data
+        } else {
+          throw error(response)
         }
+      } catch (err) {
+        throw error(err)
+      }
     }
 
-
     /**
      * @description The Delete Workflow call is used to delete an existing Workflow permanently from your Stack.
      * @memberof Workflow
@@ -135,11 +130,10 @@ export function Workflow (http, data = {}) {
      *
      */
     this.fetch = fetch(http, 'workflow')
-
   } else {
     this.contentType = (contentTypeUID) => {
-        if (contentTypeUID) {
-            /**
+      if (contentTypeUID) {
+        /**
              * @description The Delete Workflow call is used to delete an existing Workflow permanently from your Stack.
              * @memberof Workflow
              * @func getPublishRules
@@ -155,34 +149,34 @@ export function Workflow (http, data = {}) {
              * client.stack({ api_key: 'api_key'}).workflow('workflow_uid').contentType('contentType_uid').getPublishRules()
              * .then((collection) => console.log(collection))
              */
-            async function getPublishRules(params) {
-                const headers = {}
-                if (this.stackHeaders) {
-                    headers.headers = this.stackHeaders
-                }
-                if (params) {
-                    headers.params = {
-                        ...cloneDeep(params)
-                    }
-                }
-                try {
-                const response = await http.get(`/workflows/content_type/${contentTypeUID}`, headers)
-                if (response.data) {
-                    return new ContentstackCollection(response, http, this.stackHeaders, PublishRulesCollection)
-                } else {
-                    throw error(response)
-                }
-                } catch (err) {
-                    throw error(err)
-                }
+        async function getPublishRules (params) {
+          const headers = {}
+          if (this.stackHeaders) {
+            headers.headers = this.stackHeaders
+          }
+          if (params) {
+            headers.params = {
+              ...cloneDeep(params)
             }
-            return {
-                getPublishRules,
-                stackHeaders: {...this.stackHeaders}
+          }
+          try {
+            const response = await http.get(`/workflows/content_type/${contentTypeUID}`, headers)
+            if (response.data) {
+              return new ContentstackCollection(response, http, this.stackHeaders, PublishRulesCollection)
+            } else {
+              throw error(response)
             }
+          } catch (err) {
+            throw error(err)
+          }
         }
+        return {
+          getPublishRules,
+          stackHeaders: { ...this.stackHeaders }
+        }
+      }
     }
-        /**
+    /**
          * @description The Create a Workflow request allows you to create a Workflow.
          * @memberof Workflow
          * @func create
@@ -191,7 +185,7 @@ export function Workflow (http, data = {}) {
          * @example
          * import * as contentstack from '@contentstack/management'
          * const client = contentstack.client()
-         * 
+         *
          * const workflow = {
          *	"workflow_stages": [
          *      {
@@ -251,11 +245,11 @@ export function Workflow (http, data = {}) {
          *		]
          *	}
          *  client.stack().workflow().create({ workflow })
-         * .then((workflow) => console.log(workflow))    
+         * .then((workflow) => console.log(workflow))
          */
-        this.create = create({ http: http })
+    this.create = create({ http: http })
 
-        /**
+    /**
          * @description The Get all Workflows request retrieves the details of all the Workflows of a stack.
          * @memberof Workflow
          * @func fetchAll
@@ -271,29 +265,29 @@ export function Workflow (http, data = {}) {
          * .then((collection) => console.log(collection))
          *
          */
-        this.fetchAll = async (params) => {
-            const headers = {}
-            if (this.stackHeaders) {
-                headers.headers = this.stackHeaders
-            }
-            if (params) {
-                headers.params = {
-                    ...cloneDeep(params)
-                }
-            }
-            try {
-                const response = await http.get(this.urlPath, headers)
-                if (response.data) {
-                    return new ContentstackCollection(response, http, null, WorkflowCollection)
-                } else {
-                    throw error(response)
-                }
-            } catch (err) {
-             throw error(err)
-            }
+    this.fetchAll = async (params) => {
+      const headers = {}
+      if (this.stackHeaders) {
+        headers.headers = this.stackHeaders
+      }
+      if (params) {
+        headers.params = {
+          ...cloneDeep(params)
+        }
+      }
+      try {
+        const response = await http.get(this.urlPath, headers)
+        if (response.data) {
+          return new ContentstackCollection(response, http, null, WorkflowCollection)
+        } else {
+          throw error(response)
         }
+      } catch (err) {
+        throw error(err)
+      }
+    }
 
-        /**
+    /**
          * @description The Publish rule allow you to create, fetch, delete, update the publish rules.
          * @memberof Workflow
          * @func publishRule
@@ -305,25 +299,25 @@ export function Workflow (http, data = {}) {
          *
          * client.stack({ api_key: 'api_key'}).workflow().publishRule().fetchAll()
          * .then((collection) => console.log(collection))
-         * 
+         *
          * client.stack({ api_key: 'api_key'}).workflow().publishRule('rule_uid').fetch()
          * .then((publishrule) => console.log(publishrule))
          *
          */
-        this.publishRule = (ruleUid = null) => {
-            const publishInfo = { stackHeaders: this.stackHeaders }
-            if (ruleUid) {
-                publishInfo.publishing_rule = { uid: ruleUid }
-            }
-            return new PublishRules(http, publishInfo)
-        }
+    this.publishRule = (ruleUid = null) => {
+      const publishInfo = { stackHeaders: this.stackHeaders }
+      if (ruleUid) {
+        publishInfo.publishing_rule = { uid: ruleUid }
+      }
+      return new PublishRules(http, publishInfo)
     }
+  }
 }
 
 export function WorkflowCollection (http, data) {
-    const obj = cloneDeep(data.workflows) || []
-    const workflowCollection = obj.map((userdata) => {
-        return new Workflow(http, { workflow: userdata, stackHeaders: data.stackHeaders })
-    })
-    return workflowCollection
-}
+  const obj = cloneDeep(data.workflows) || []
+  const workflowCollection = obj.map((userdata) => {
+    return new Workflow(http, { workflow: userdata, stackHeaders: data.stackHeaders })
+  })
+  return workflowCollection
+}

lib/stack/workflow/publishRules/index.js

@@ -7,7 +7,6 @@ import {
 } from '../../../entity'
 import error from '../../../core/contentstackError'
 import ContentstackCollection from '../../../contentstackCollection'
-import loader from 'string-replace-loader'
 
 /**
  * PublishRules is a tool that allows you to streamline the process of content creation and publishing, and lets you manage the content lifecycle of your project smoothly. Read more about <a href='https://www.contentstack.com/docs/developers/set-up-publish ruless-and-publish-rules'>PublishRuless and Publish Rules</a>.
@@ -26,7 +25,7 @@ export function PublishRules (http, data = {}) {
      * @description The Update Publish Rules request allows you to add a publish rules stage or update the details of the existing stages of a publish rules.
      * @memberof Publish Rules
      * @func update
-     * @returns {Promise<Publish Rules.Publish Rules>} Promise for Publish Rules instance
+     * @returns {Promise<PublishRules.PublishRules>} Promise for Publish Rules instance
      * @example
      * import * as contentstack from '@contentstack/management'
      * const client = contentstack.client()
@@ -60,7 +59,7 @@ export function PublishRules (http, data = {}) {
      * @description The fetch publish rules retrieves the comprehensive details of a specific Publish Rules of a stack.
      * @memberof Publish Rules
      * @func fetch
-     * @returns {Promise<Publish Rules.Publish Rules>} Promise for Publish Rules instance
+     * @returns {Promise<PublishRules.PublishRules>} Promise for Publish Rules instance
      * @example
      * import * as contentstack from '@contentstack/management'
      * const client = contentstack.client()