Merge pull request #92 from contentstack/next

Teams API support

Author: harshithad0703

.github/workflows/unit-test.yml

@@ -1,7 +1,10 @@
 name: Unit Test & Reports
 on:
   pull_request:
-  push:
+    branches:
+        - master
+        - main
+        - next
 jobs:
   build-test:
     name: Build & Test
@@ -23,6 +26,5 @@ jobs:
           reporter: mocha-json        # Format of test results
       - name: Coverage report 
         uses: lucassabreu/comment-coverage-clover@main
-        with:       
-          name: Unit test Coverage report   
+        with: 
           file: coverage/clover.xml       

.jsdoc.json

@@ -32,8 +32,10 @@
             "lib/stack/roles/index.js",
             "lib/stack/webhook/index.js",
             "lib/stack/workflow/index.js",
-            "lib/stack/workflow/publishRules/index.js"
-
+            "lib/stack/workflow/publishRules/index.js",
+            "lib/organization/teams/index.js",
+            "lib/organization/teams/stackRoleMappings/index.js",
+            "lib/organization/teams/teamUsers/index.js"
         ],
         "excludePattern": "(node_modules/|jsdocs)"
     },

.talismanrc

@@ -1,5 +1,5 @@
 threshold: medium
 fileignoreconfig:
 - filename: package-lock.json
-  checksum: ef5d374553f431b5a952069f46184ec7e49efd7d72143e1a1642994758db4359
+  checksum: 9a7bec9513834a0fc7db31b9a312ec35980600415c04f0d404e1370cfce1ef1b
 version: ""

CHANGELOG.md

@@ -1,5 +1,9 @@
 # Changelog
 
+## [v1.13.0](https://github.com/contentstack/contentstack-management-javascript/tree/v1.13.0) (2023-11-21)
+ - Feature
+   - Teams API support
+   - Early Access Header support
 ## [v1.12.0](https://github.com/contentstack/contentstack-management-javascript/tree/v1.12.0) (2023-10-17)
  - Feature
    - Types support for Taxonomy feature

lib/contentstack.js

@@ -39,6 +39,11 @@ import httpClient from './core/contentstackHTTPClient.js'
  * import * as contentstack from '@contentstack/management'
  * const client = contentstack.client({ authtoken: 'value' })
  *
+ * @prop {string=} params.early_access - Optional early_access is a token used for early access of new features in CMA requests.
+ * @example //Set the `early_access`
+ * import * as contentstack from '@contentstack/management'
+ * const client = contentstack.client({ early_access: ['ea1', 'ea2'] })
+ *
  * @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'
@@ -177,6 +182,9 @@ export function client (params = {}) {
   if (params.authorization) {
     requiredHeaders.authorization = params.authorization
   }
+  if (params.early_access) {
+    requiredHeaders.early_access = params.early_access.join(',')
+  }
   params = {
     ...defaultParameter,
     ...clonedeep(params)

lib/core/contentstackHTTPClient.js

@@ -44,6 +44,10 @@ export default function contentstackHttpClient (options) {
     config.headers['accessToken'] = config.accessToken
   }
 
+  if (config.early_access) {
+    config.headers['x-header-ea'] = config.early_access
+  }
+
   const protocol = config.insecure ? 'http' : 'https'
   let hostname = config.defaultHostName
   let port = config.port || 443

lib/entity.js

@@ -86,7 +86,14 @@ export const create = ({ http, params }) => {
       if (response.data) {
         return new this.constructor(http, parseData(response, this.stackHeaders, this.content_type_uid, this.taxonomy_uid))
       } 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)
@@ -301,4 +308,4 @@ export const move = (http, type, force = false, params = {}) => {
       throw error(err)
     }
   }
-}
+}

lib/organization/index.js

@@ -7,6 +7,7 @@ import { StackCollection } from '../stack'
 import { UserCollection } from '../user'
 import { App } from '../app'
 import { AppRequest } from '../app/request'
+import { Teams } from './teams'
 /**
  * Organization is the top-level entity in the hierarchy of Contentstack, consisting of stacks and stack resources, and users. Organization allows easy management of projects as well as users within the Organization. Read more about <a href='https://www.contentstack.com/docs/guide/organization'>Organizations.</a>.
  * @namespace Organization
@@ -18,6 +19,26 @@ export function Organization (http, data) {
     Object.assign(this, cloneDeep(data.organization))
     this.urlPath = `/organizations/${this.uid}`
 
+    /**
+     * @description The teams call fetches teams details.
+     * @memberof Organization
+     * @func teams
+     * @returns {Promise<Organization.Organization>} Promise for Organization instance
+     * @example
+     * import * as contentstack from '@contentstack/management'
+     * const client = contentstack.client()
+     *
+     * client.organization('organization_uid').teams('teamsUid').fetch()
+     * .then((organization) => console.log(organization))
+     *
+     */
+    this.teams = (teamUid = null) => {
+      data.organizationUid = this.uid
+      if (teamUid) {
+        data.uid = teamUid
+      }
+      return new Teams(http, data)
+    }
     /**
      * @description The fetch Organization call fetches Organization details.
      * @memberof Organization

lib/organization/teams/index.js

@@ -0,0 +1,165 @@
+import cloneDeep from 'lodash/cloneDeep'
+import {
+  create,
+  fetch,
+  deleteEntity,
+  fetchAll
+} from '../../entity'
+import { TeamUsers } from './teamUsers'
+import { StackRoleMappings } from './stackRoleMappings'
+import error from '../../core/contentstackError'
+
+export function Teams (http, data) {
+  this.organizationUid = data.organizationUid
+  this.urlPath = `/organizations/${this.organizationUid}/teams`
+  if (data && data.uid) {
+    Object.assign(this, cloneDeep(data))
+
+    this.urlPath = `/organizations/${this.organizationUid}/teams/${this.uid}`
+
+    /**
+     * @description The update call on team will allow to update details of team.
+     * @memberof Teams
+     * @func update
+     * @returns {Promise<Teams.Teams>} Response Object.
+     * @example
+     * import * as contentstack from '@contentstack/management'
+     * const client = contentstack.client()
+     * const updateData = {
+     *    name: 'updatedname',
+     *    users: [
+     *      {
+     *          email: 'abc@abc.com'
+     *      }
+     *    ],
+     *    organizationRole: 'blt09e5dfced326aaea',
+     *    stackRoleMapping: []
+     *   }
+     * client.organization(s'organizationUid').teams('teamUid').update(updateData)
+     * .then((response) => console.log(response))
+     *
+     */
+    this.update = async (updateData) => {
+      try {
+        const response = await http.put(this.urlPath, updateData)
+        if (response.data) {
+          return response.data
+        }
+      } catch (err) {
+        throw error(err)
+      }
+    }
+
+    /**
+     * @description The delete call on team will delete the existing team.
+     * @memberof Teams
+     * @func delete
+     * @returns {Promise<Teams.Teams>} Response Object.
+     * @example
+     * import * as contentstack from '@contentstack/management'
+     * const client = contentstack.client()
+     * client.organization('organizationUid').teams('teamUid').delete()
+     * .then((response) => console.log(response))
+     *
+     */
+    this.delete = deleteEntity(http)
+
+    /**
+     * @description The fetch call on team will delete the existing team.
+     * @memberof Teams
+     * @func fetch
+     * @returns {Promise<Teams.Teams>} Response Object.
+     * @example
+     * import * as contentstack from '@contentstack/management'
+     * const client = contentstack.client()
+     * client.organization('organizationUid').teams('teamUid').fetch()
+     * .then((response) => console.log(response))
+     *
+     */
+    this.fetch = fetch(http, 'team')
+
+    /**
+     * @description The users call on team will get users details.
+     * @memberof Teams
+     * @func users
+     * @returns {Promise<Teams.Teams>} Response Object.
+     * @example
+     * import * as contentstack from '@contentstack/management'
+     * const client = contentstack.client()
+     * client.organization('organizationUid').teams('teamUid').teamUsers().fetchAll()
+     *  .then((response) => console.log(response))
+     *
+     */
+    this.teamUsers = (userId = null) => {
+      data.organizationUid = this.organizationUid
+      data.teamUid = this.uid
+      if (userId) {
+        data.userId = userId
+      }
+      return new TeamUsers(http, data)
+    }
+
+    /**
+     * @description The stackRoleMappings call on team will get the stack role Mapping.
+     * @memberof Teams
+     * @func users
+     * @returns {Promise<Teams.Teams>} Response Object.
+     * @example
+     * import * as contentstack from '@contentstack/management'
+     * const client = contentstack.client()
+     * client.organization('organizationUid').teams('teamUid').stackRoleMappings().fetchAll()
+     *  .then((response) => console.log(response))
+     *
+     */
+    this.stackRoleMappings = (stackApiKey = null) => {
+      data.organizationUid = this.organizationUid
+      data.teamUid = this.uid
+      if (stackApiKey) {
+        data.stackApiKey = stackApiKey
+      }
+      return new StackRoleMappings(http, data)
+    }
+  } else {
+    /**
+     * @description The fetch call on team will delete the existing team.
+     * @memberof Teams
+     * @func create
+     * @returns {Promise<Teams.Teams>} Response Object.
+     * @example
+     * import * as contentstack from '@contentstack/management'
+     * const client = contentstack.client()
+     * const team = {
+     *    name: 'name',
+     *    organizationUid: 'organization_uid',
+     *    users: [],
+     *    stackRoleMapping: [],
+     *    organizationRole: 'organizationRole'
+     * }
+     * client.organization('organizationUid').teams().create(team)
+     * .then((response) => console.log(response))
+     *
+     */
+    this.create = create({ http })
+
+    /**
+     * @description The fetchAll on team will allow to fetch details of all teams.
+     * @memberof Teams
+     * @func fetchAll
+     * @returns {Promise<Teams.Teams>} Response Object.
+     * @example
+     * import * as contentstack from '@contentstack/management'
+     * const client = contentstack.client()
+     *
+     * client.organization('organizationUid').teams().fetchAll()
+     * .then((response) => console.log(response))
+     */
+    this.fetchAll = fetchAll(http, TeamsCollection, { api_version: 1.1 })
+  }
+}
+export function TeamsCollection (http, teamsData) {
+  const obj = cloneDeep(teamsData.teams) || []
+  const teamsCollection = obj.map((team) => {
+    return new Teams(http, team)
+  })
+  return teamsCollection
+}