Merge pull request #25 from contentstack/bugs/entry-workflow-stage

Entry workflow stage, Asset Download

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 }}

.npmignore

@@ -22,4 +22,5 @@ docdash-template/
 .babel-preset.js
 .eslintrc.js
 .talismanrc
-lib/
+lib/
+.github

lib/contentstack.js

@@ -34,6 +34,16 @@ 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.authorization - 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 +142,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/asset/index.js

@@ -217,11 +217,52 @@ export function Asset (http, data = {}) {
    * import * as contentstack from '@contentstack/management'
    * const client = contentstack.client()
    *
-   * client.stack().asset().query({ query: { filename: 'Asset Name' } }).find()
+   * client.stack({ api_key: 'api_key'}).asset().query({ query: { filename: 'Asset Name' } }).find()
    * .then((asset) => console.log(asset))
    */
     this.query = query({ http: http, wrapperCollection: AssetCollection })
   }
+  /**
+   * @description The Download function will get downloadable file in specified format.
+   * @memberof Asset
+   * @func download
+   * @returns {Array<AssetResponse>} Array of Asset.
+   * @param {*} param.url The url for the asset to download
+   * @param {*} param.responseType Optional parameter to specify the response type.
+   * @example
+   *
+   * import * as contentstack from '@contentstack/management'
+   * const client = contentstack.client()
+   *
+   * client.stack({ api_key: 'api_key'}).asset('uid').fetch()
+   * .then((asset) => asset.download({responseType: 'blob'}))
+   * .then((response) => // Write response data to destination file. )
+   * @example
+   *
+   * import * as contentstack from '@contentstack/management'
+   * const client = contentstack.client()
+   *
+   * client.stack({ api_key: 'api_key'}).asset().download({url: 'asset_url_to_download', responseType: 'blob'})
+   * .then((response) => // Write response data to destination file. )
+   */
+  this.download = async function ({ url, responseType, params }) {
+    try {
+      const headers = {
+        headers: {
+          ...params,
+          ...cloneDeep(this.stackHeaders)
+        },
+        responseType
+      } || { responseType }
+      const requestUrl = url || this.url
+      if (!requestUrl || requestUrl === undefined) {
+        throw new Error('Asset URL can not be empty')
+      }
+      return http.get(requestUrl, headers)
+    } catch (err) {
+      throw error(err)
+    }
+  }
   return this
 }
 

lib/stack/contentType/entry/index.js

@@ -58,6 +58,34 @@ export function Entry (http, data) {
      * })
      * .then((entry) => console.log(entry))
      *
+     * @example
+     * // To update entry with asset field
+     * import * as contentstack from '@contentstack/management'
+     * const client = contentstack.client()
+     *
+     * client.stack({ api_key: 'api_key'}).contentType('content_type_uid').entry('uid').fetch()
+     * .then((entry) => {
+     *  entry.title = 'My New Entry'
+     *  entry.file = entry.file.uid // for single asset pass asset uid to entry asset field value
+     *  entry.multiple_file = ['asset_uid_1', 'asset_uid_2'] // for multiple asset pass array of asset uid to entry asset field values
+     *  return entry.update({ locale: 'en-at' })
+     * })
+     * .then((entry) => console.log(entry))
+     *
+     * @example
+     * // To update entry with reference field
+     * import * as contentstack from '@contentstack/management'
+     * const client = contentstack.client()
+     *
+     * client.stack({ api_key: 'api_key'}).contentType('content_type_uid').entry('uid').fetch()
+     * .then((entry) => {
+     *  entry.title = 'My New Entry'
+     *  entry.reference = entry.reference.uid // for single reference pass reference uid to entry reference field value
+     *  entry.multiple_reference = ['reference_uid_1', 'reference_uid_2'] // for multiple reference pass array of reference uid to entry reference field values
+     *  entry.multiple_content_type_reference = [{_content_type_uid: 'content_type_uid_1', uid: 'reference_uid_1'}, {_content_type_uid: 'content_type_uid_2', uid: 'reference_uid_2'}] // for multiple reference pass array of reference uid to entry reference field values
+     *  return entry.update({ locale: 'en-at' })
+     * })
+     * .then((entry) => console.log(entry))
      */
     this.update = update(http, 'entry')
 
@@ -185,6 +213,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').setWorkflowStage({ workflow_stage, 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.
@@ -197,7 +277,12 @@ export function Entry (http, data) {
    * const client = contentstack.client()
    * const entry  = {
    *  title: 'Sample Entry',
-   *  url: '/sampleEntry'
+   *  url: '/sampleEntry',
+   *  file: 'asset_uid', // for single asset pass asset uid to entry asset field value
+   *  multiple_file = ['asset_uid_1', 'asset_uid_2'], // for multiple asset pass array of asset uid to entry asset field values
+   *  reference: reference.uid, // for single reference pass reference uid to entry reference field value
+   *  multiple_reference: ['reference_uid_1', 'reference_uid_2'], // for multiple reference pass array of reference uid to entry reference field values
+   *  multiple_content_type_reference: [{_content_type_uid: 'content_type_uid_1', uid: 'reference_uid_1'}, {_content_type_uid: 'content_type_uid_2', uid: 'reference_uid_2'}] // for multiple reference pass array of reference uid to entry reference field values
    * }
    * client.stack().contentType('content_type_uid').entry().create({ entry })
    * .then((entry) => console.log(entry))
@@ -239,7 +324,7 @@ export function Entry (http, data) {
    * client.stack({ api_key: 'api_key'}).contentType('content_type_uid').entry()
    * .import({
    *  entry: 'path/to/file.json',
-   *  overright: true
+   *  overwrite: true
    * })
    * .then((entry) => console.log(entry))
    *

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/api/asset-test.js

@@ -1,7 +1,7 @@
 import path from 'path'
 import { expect } from 'chai'
 import { describe, it, setup } from 'mocha'
-import { jsonReader } from '../utility/fileOperations/readwrite'
+import { jsonReader, writeDownloadedFile } from '../utility/fileOperations/readwrite'
 import { contentstackClient } from '../utility/ContentstackClient.js'
 
 var client = {}
@@ -10,6 +10,7 @@ var stack = {}
 var folderUID = ''
 var assetUID = ''
 var publishAssetUID = ''
+var assetURL = ''
 describe('Assets api Test', () => {
   setup(() => {
     const user = jsonReader('loggedinuser.json')
@@ -27,6 +28,7 @@ describe('Assets api Test', () => {
     makeAsset().create(asset)
       .then((asset) => {
         assetUID = asset.uid
+        assetURL = asset.url
         expect(asset.uid).to.be.not.equal(null)
         expect(asset.url).to.be.not.equal(null)
         expect(asset.filename).to.be.equal('customUpload.html')
@@ -38,6 +40,22 @@ describe('Assets api Test', () => {
       .catch(done)
   })
 
+  it('Download asset from URL.', done => {
+    makeAsset().download({ url: assetURL, responseType: 'stream' })
+      .then((response) => {
+        writeDownloadedFile(response, 'asset1')
+        done()
+      }).catch(done)
+  })
+  it('Download asset from fetch details ', done => {
+    makeAsset(assetUID).fetch()
+      .then((asset) => asset.download({ responseType: 'stream' }))
+      .then((response) => {
+        writeDownloadedFile(response, 'asset2')
+        done()
+      }).catch(done)
+  })
+
   it('Create folder ', done => {
     makeAsset().folder().create({ asset: { name: 'Sample Folder' } })
       .then((asset) => {

test/typescript/asset.ts

@@ -4,7 +4,7 @@ import path from "path";
 var assetUID = ''
 var folderUID = ''
 var publishAssetUID = ''
-
+var assetURL = ''
 export function createAsset(stack: Stack) {
     describe('Asset create', () => {
         test('Asset Upload', done => {
@@ -17,6 +17,7 @@ export function createAsset(stack: Stack) {
             stack.asset().create(asset)
             .then((asset) => {
                 assetUID = asset.uid
+                assetURL = asset.url
                 expect(asset.uid).to.be.not.equal(null)
                 expect(asset.url).to.be.not.equal(null)
                 expect(asset.filename).to.be.equal('customUpload.html')
@@ -67,6 +68,27 @@ export function createAsset(stack: Stack) {
     })
 }
 
+export function downloadAsset(stack: Stack) {
+    describe('Asset download', () => {
+        test('Download asset from url', done => {
+            stack.asset().download({url: assetURL, responseType: 'stream'})
+            .then((_) => {
+                done()
+            })
+            .catch(done)
+        })
+
+        test('Download asset from uid', done => {
+            stack.asset(assetUID).fetch()
+            .then((asset) => asset.download({responseType: 'stream'}))
+            .then((_) => {
+                done()
+            })
+            .catch(done)
+        })
+    })
+}
+
 export function replaceAsset(stack: Stack) {
     describe('Asset replace', () => {
         test('Replace Asset', done => {