Workflow Stage for entry

- Autorisation token
- Update User roles from Stack
- GitHub action for Package publish

Author: uttamukkoji

.github/workflows/npm-publish.yml

@@ -0,0 +1,34 @@
+# This workflow will publish a package to GitHub Packages when a release is created
+# For more information see: https://help.github.com/actions/language-and-framework-guides/publishing-nodejs-packages
+
+name: Publish package to NPM repository
+on:
+  release:
+    types: [created]
+
+jobs:
+  publish-npm:  
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-node@v3
+        with:
+          node-version: '12.x'
+          registry-url: 'https://registry.npmjs.org'
+      - run: npm ci
+      - run: npm publish
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
+  publish-git:  
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-node@v3
+        with:
+          node-version: '12.x'
+          registry-url: 'https://npm.pkg.github.com'
+          scope: '@contentstack'
+      - run: npm ci
+      - run: npm publish
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.GITHUB_TOKEN }}

lib/contentstack.js

@@ -34,6 +34,17 @@ import httpClient from './core/contentstackHTTPClient.js'
  * import * as contentstack from '@contentstack/management'
  * const client = contentstack.client({ headers: { 'headerkey': 'value'} })
  *
+ * 
+ * @prop {string=} params.authtoken - Optional Authtoken is a read-write token used to make authorized CMA requests, but it is a user-specific token.
+ * @example //Set the `authtoken`
+ * import * as contentstack from '@contentstack/management'
+ * const client = contentstack.client({ authtoken: 'value' })
+ * 
+ * @prop {string=} params.timeout - Optional authorization token is a read-write token used to make authorized CMA requests, but it is a user-specific token.
+ * @example //Set the `authorization`
+ * import * as contentstack from '@contentstack/management'
+ * const client = contentstack.client({ authorization: 'Bearer <token_value>' })
+ * 
  * @prop {number=} params.timeout - Optional number of milliseconds before the request times out. Default is 30000ms
  * @example //Set the `timeout` to 50000ms
  * import * as contentstack from '@contentstack/management'
@@ -132,6 +143,9 @@ export function client (params = {}) {
   if (params.authtoken) {
     requiredHeaders.authtoken = params.authtoken
   }
+  if (params.authorization) {
+    requiredHeaders.authorization = params.authorization
+  }
   params = {
     ...defaultParameter,
     ...clonedeep(params)

lib/stack/contentType/entry/index.js

@@ -185,6 +185,58 @@ export function Entry (http, data) {
         throw error(err)
       }
     }
+
+    /**
+     * @description The Set Entry Workflow Stage request allows you to either set a particular workflow stage of an entry or update the workflow stage details of an entry.
+     * @memberof Entry
+     * @func setWorkflowStage
+     * @returns {Promise<Object>} Response Object.
+     * @param {Object} publishing_rule Details for the publish request
+     * @param {String} locale Enter the code of the locale that the entry belongs to.
+     * @example
+     * import * as contentstack from '@contentstack/management'
+     * const client = contentstack.client()
+     *
+     * const workflow_stage = {
+		 * 	"comment": "Workflow Comment",
+		 * 	"due_date": "Thu Dec 01 2018",
+		 * 	"notify": false,
+		 * 	"uid": "workflow_stage_uid",
+		 * 	"assigned_to": [{
+		 * 			"uid": "user_uid", 
+		 * 			"name": "Username", 
+		 * 			"email": "user_email_id"
+		 * 			}],
+		 * 	"assigned_by_roles": [{
+		 * 		"uid": "role_uid",
+		 * 		"name": "Role name"
+		 * 	}]		
+		 * }
+     * client.stack({ api_key: 'api_key'}).contentType('content_type_uid').entry('uid').publishRequest({ publishing_rule, locale: 'en-us'})
+     * .then((response) => console.log(response.notice)) 
+     */
+    this.setWorkflowStage = async ({workflow_stage, locale}) => { 
+      const publishDetails = {
+        workflow: { workflow_stage }
+      }
+      const headers = {}
+      if (this.stackHeaders) {
+        headers.headers = this.stackHeaders
+      }
+      headers.params = {
+        locale
+      }
+      try {
+        const response = await http.post(`${this.urlPath}/workflow`, publishDetails, headers)
+        if (response.data) {
+          return response.data
+        } else {
+          throw error(response)
+        }
+      } catch (err) {
+        throw error(err)
+      }
+    }
   } else {
   /**
    * @description The Create an entry call creates a new entry for the selected content type.

lib/stack/index.js

@@ -434,6 +434,43 @@ export function Stack (http, data) {
       }
     }
 
+    /**
+     * @description The Update User Role API Request updates the roles of an existing user account. 
+     * This API Request will override the existing roles assigned to a user
+     * @memberof Stack
+     * @func updateUsersRoles
+     * @param {*} users object containing userId and array of roles to assign user.
+     * @returns {Object} Response Object.
+     * @example
+     * import * as contentstack from '@contentstack/management'
+     * const client = contentstack.client()
+     * const users = {
+     *  user_uid: ['role_uid_1', 'role_uid_2' ]
+     * }
+     * 
+     * client.stack({ api_key: 'api_key'}).updateUsersRoles(users)
+     * .then((response) => console.log(response.notice))
+     *
+     */
+    this.updateUsersRoles = async (users) => {
+      try {
+        const response = await http.post(`${this.urlPath}/users/roles`, 
+          { users },
+          {
+          headers: {
+            ...cloneDeep(this.stackHeaders)
+          }
+        })
+        if (response.data) {
+          return UserCollection(http, response.data.stack)
+        } else {
+          return error(response)
+        }
+      } catch (err) {
+        return error(err)
+      }
+    }
+
     /**
      * @description The Transfer stack ownership to other users call sends the specified user an email invitation for accepting the ownership of a particular stack.
      * @memberof Stack

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@contentstack/management",
-  "version": "1.3.1",
+  "version": "1.4.0",
   "description": "The Content Management API is used to manage the content of your Contentstack account",
   "main": "./dist/node/contentstack-management.js",
   "browser": "./dist/web/contentstack-management.js",

test/unit/entry-test.js

@@ -290,6 +290,38 @@ describe('Contentstack Entry test', () => {
       .catch(done)
   })
 
+  it('Entry set Workflow stage test', done => {
+    var mock = new MockAdapter(Axios);
+
+    mock.post('/content_types/content_type_uid/entries/UID/workflow').reply(200, {
+      ...noticeMock
+    })
+
+    const workflow_stage = {
+      uid: 'uid',
+      comment: 'Please review this.',
+      due_date: 'Thu Dec 01 2018',
+      notify: true,
+      assigned_to: [{
+        uid: "user_uid", 
+        name: "Username", 
+        email: "user_email_id"
+        }],
+    assigned_by_roles: [{
+      uid: "role_uid",
+      name: "Role name"
+    }]
+    }
+
+    makeEntry({entry: { ...systemUidMock }})
+      .setWorkflowStage({workflow_stage, locale: 'en-us'})
+      .then((response) => {
+        expect(response.notice).to.be.equal(noticeMock.notice)
+        done()
+      })
+      .catch(done)
+  })
+
   it('Entry publish request test', done => {
     var mock = new MockAdapter(Axios)
     mock.onPost('/content_types/content_type_uid/entries/UID/workflow').reply(200, {

test/unit/stack-test.js

@@ -31,6 +31,7 @@ describe('Contentstack Stack test', () => {
     expect(stack.release).to.be.equal(undefined)
     expect(stack.bulkOperation).to.be.equal(undefined)
     expect(stack.users).to.be.equal(undefined)
+    expect(stack.updateUsersRoles).to.be.equal(undefined)
     expect(stack.transferOwnership).to.be.equal(undefined)
     expect(stack.settings).to.be.equal(undefined)
     expect(stack.resetSettings).to.be.equal(undefined)
@@ -66,6 +67,7 @@ describe('Contentstack Stack test', () => {
     expect(stack.release).to.be.equal(undefined)
     expect(stack.bulkOperation).to.be.equal(undefined)
     expect(stack.users).to.be.equal(undefined)
+    expect(stack.updateUsersRoles).to.be.equal(undefined)
     expect(stack.transferOwnership).to.be.equal(undefined)
     expect(stack.settings).to.be.equal(undefined)
     expect(stack.resetSettings).to.be.equal(undefined)
@@ -101,6 +103,7 @@ describe('Contentstack Stack test', () => {
     expect(stack.release).to.be.equal(undefined)
     expect(stack.bulkOperation).to.be.equal(undefined)
     expect(stack.users).to.be.equal(undefined)
+    expect(stack.updateUsersRoles).to.be.equal(undefined)
     expect(stack.transferOwnership).to.be.equal(undefined)
     expect(stack.settings).to.be.equal(undefined)
     expect(stack.resetSettings).to.be.equal(undefined)
@@ -136,6 +139,7 @@ describe('Contentstack Stack test', () => {
     expect(stack.release).to.be.equal(undefined)
     expect(stack.bulkOperation).to.be.equal(undefined)
     expect(stack.users).to.be.equal(undefined)
+    expect(stack.updateUsersRoles).to.be.equal(undefined)
     expect(stack.transferOwnership).to.be.equal(undefined)
     expect(stack.settings).to.be.equal(undefined)
     expect(stack.resetSettings).to.be.equal(undefined)
@@ -171,6 +175,7 @@ describe('Contentstack Stack test', () => {
     expect(stack.release).to.be.equal(undefined)
     expect(stack.bulkOperation).to.be.equal(undefined)
     expect(stack.users).to.be.equal(undefined)
+    expect(stack.updateUsersRoles).to.be.equal(undefined)
     expect(stack.transferOwnership).to.be.equal(undefined)
     expect(stack.settings).to.be.equal(undefined)
     expect(stack.resetSettings).to.be.equal(undefined)
@@ -208,6 +213,7 @@ describe('Contentstack Stack test', () => {
     expect(stack.release).to.not.equal(undefined)
     expect(stack.bulkOperation).to.not.equal(undefined)
     expect(stack.users).to.not.equal(undefined)
+    expect(stack.updateUsersRoles).to.not.equal(undefined)
     expect(stack.transferOwnership).to.not.equal(undefined)
     expect(stack.settings).to.not.equal(undefined)
     expect(stack.resetSettings).to.not.equal(undefined)
@@ -245,6 +251,7 @@ describe('Contentstack Stack test', () => {
     expect(stack.release).to.not.equal(undefined)
     expect(stack.bulkOperation).to.not.equal(undefined)
     expect(stack.users).to.not.equal(undefined)
+    expect(stack.updateUsersRoles).to.not.equal(undefined)
     expect(stack.transferOwnership).to.not.equal(undefined)
     expect(stack.settings).to.not.equal(undefined)
     expect(stack.resetSettings).to.not.equal(undefined)
@@ -282,6 +289,7 @@ describe('Contentstack Stack test', () => {
     expect(stack.release).to.not.equal(undefined)
     expect(stack.bulkOperation).to.not.equal(undefined)
     expect(stack.users).to.not.equal(undefined)
+    expect(stack.updateUsersRoles).to.not.equal(undefined)
     expect(stack.transferOwnership).to.not.equal(undefined)
     expect(stack.settings).to.not.equal(undefined)
     expect(stack.resetSettings).to.not.equal(undefined)
@@ -320,6 +328,7 @@ describe('Contentstack Stack test', () => {
     expect(stack.release).to.not.equal(undefined)
     expect(stack.bulkOperation).to.not.equal(undefined)
     expect(stack.users).to.not.equal(undefined)
+    expect(stack.updateUsersRoles).to.not.equal(undefined)
     expect(stack.transferOwnership).to.not.equal(undefined)
     expect(stack.settings).to.not.equal(undefined)
     expect(stack.resetSettings).to.not.equal(undefined)
@@ -835,6 +844,24 @@ describe('Contentstack Stack test', () => {
       })
       .catch(done)
   })
+  it('Update users roles in Stack test', done => {
+    const mock = new MockAdapter(Axios)
+    mock.onGet('/stacks').reply(200, {
+      notice: "The roles were applied successfully.",
+    })
+    makeStack({
+      stack: {
+        api_key: 'stack_api_key'
+      }
+    })
+    .updateUsersRoles({ user_id: ['role1', 'role2']})
+    .then((response) => {
+      expect(response.notice).to.be.equal(noticeMock.notice)
+      done()
+    })
+    .catch(done)
+  })
+
 
   it('Stack transfer ownership test', done => {
     const mock = new MockAdapter(Axios)

types/stack/contentType/entry.d.ts

@@ -1,10 +1,12 @@
+import { Response } from "../../contentstackCollection";
 import { AnyProperty, SystemFields } from "../../utility/fields";
 import { Queryable, SystemFunction } from "../../utility/operations";
 import { Publishable } from "../../utility/publish";
 import { Unpublishable } from "../../utility/unpublish";
 
 
 export interface Entry extends Publishable, Unpublishable, SystemFields, SystemFunction<Entry> {
+    setWorkflowStage(data: { workflow_stage: WorkflowStage, locale?:string}): Promise<Response>
 }
 
 export interface Entries extends Queryable<Entry, {entry: EntryData}> {
@@ -14,4 +16,13 @@ export interface Entries extends Queryable<Entry, {entry: EntryData}> {
 export interface EntryData extends AnyProperty {
     title: string
     url?: string
+}
+
+export interface WorkflowStage extends AnyProperty {
+    uid: string
+    comment: string
+    due_date?: string
+    notify?: boolean
+    assign_to?: Array<any>
+    assigned_by_roles?: Array<any>
 }

types/stack/index.d.ts

@@ -79,6 +79,7 @@ export interface Stack extends SystemFields {
     bulkOperation(): BulkOperation
 
     user(): Promise<Array<User>>
+    updateUsersRoles(users: AnyProperty): Promise<any>
     transferOwnership(email): Promise<Response>
     settings(): Promise<any>
     resetSettings(): Promise<any>