Added api version management

Author: sunil-lakshman

lib/core/serviceVersion.js

@@ -0,0 +1,14 @@
+export const DEFAULT_API_VERSION = '3.0'
+
+export const SERVICE_VERSIONS = {
+  bulk_publish: '3.2',
+  bulk_unpublish: '3.2',
+  bulk_job_status: '3.2',
+  bulk_job_items: '3.2',
+  global_field: '3.2',
+  release: '3.2'
+}
+
+export function getServiceVersion (serviceKey) {
+  return SERVICE_VERSIONS[serviceKey] ?? DEFAULT_API_VERSION
+}

lib/stack/bulkOperation/index.js

@@ -1,6 +1,7 @@
 import cloneDeep from 'lodash/cloneDeep'
 import { publishUnpublish } from '../../entity'
 import { bindModuleHeaders } from '../../core/moduleHeaderSupport.js'
+import { getServiceVersion } from '../../core/serviceVersion.js'
 
 /**
  * Bulk operations such as Publish, Unpublish, and Delete on multiple entries or assets.
@@ -101,7 +102,7 @@ export function BulkOperation (http, data = {}) {
    * .then((response) => { console.log(response) })
    */
   // eslint-disable-next-line camelcase
-  this.jobStatus = async ({ job_id, bulk_version = '', api_version = '' }) => {
+  this.jobStatus = async ({ job_id, bulk_version = '', api_version = getServiceVersion('bulk_job_status') }) => {
     // eslint-disable-next-line camelcase
     this.urlPath = `/bulk/jobs/${job_id}`
     const headers = {
@@ -112,17 +113,13 @@ export function BulkOperation (http, data = {}) {
     // eslint-disable-next-line camelcase
     if (bulk_version) headers.headers.bulk_version = bulk_version
     // eslint-disable-next-line camelcase
-    if (api_version) headers.headers.api_version = api_version
+    headers.headers.api_version = api_version
     try {
       const response = await http.get(this.urlPath, headers)
       if (response.data) {
-        // eslint-disable-next-line camelcase
-        if (api_version) delete headers.headers.api_version
         return response.data
       }
     } catch (error) {
-      // eslint-disable-next-line camelcase
-      if (api_version) delete headers.headers.api_version
       console.error(error)
     }
   }
@@ -145,7 +142,7 @@ export function BulkOperation (http, data = {}) {
   // eslint-disable-next-line camelcase
   this.getJobItems = async (job_id, params = {}) => {
     // eslint-disable-next-line camelcase
-    const { api_version = '3.2', ...queryParams } = cloneDeep(params)
+    const { api_version = getServiceVersion('bulk_job_items'), ...queryParams } = cloneDeep(params)
     // eslint-disable-next-line camelcase
     this.urlPath = `/bulk/jobs/${job_id}/items`
     const headers = {
@@ -154,18 +151,14 @@ export function BulkOperation (http, data = {}) {
       }
     }
     // eslint-disable-next-line camelcase
-    if (api_version) headers.headers.api_version = api_version
+    headers.headers.api_version = api_version
     if (Object.keys(queryParams).length > 0) headers.params = queryParams
     try {
       const response = await http.get(this.urlPath, headers)
       if (response.data) {
-        // eslint-disable-next-line camelcase
-        if (api_version) delete headers.headers.api_version
         return response.data
       }
     } catch (error) {
-      // eslint-disable-next-line camelcase
-      if (api_version) delete headers.headers.api_version
       console.error(error)
     }
   }
@@ -231,7 +224,7 @@ export function BulkOperation (http, data = {}) {
    *
    */
   // eslint-disable-next-line camelcase
-  this.publish = async ({ details, skip_workflow_stage = false, approvals = false, is_nested = false, api_version = '', publishAllLocalized = false }) => {
+  this.publish = async ({ details, skip_workflow_stage = false, approvals = false, is_nested = false, api_version = getServiceVersion('bulk_publish'), publishAllLocalized = false }) => {
     var httpBody = {}
     if (details) {
       httpBody = cloneDeep(details)
@@ -264,7 +257,7 @@ export function BulkOperation (http, data = {}) {
     }
 
     // eslint-disable-next-line camelcase
-    if (api_version) headers.headers.api_version = api_version
+    headers.headers.api_version = api_version
 
     return publishUnpublish(http, '/bulk/publish', httpBody, headers)
   }
@@ -329,7 +322,7 @@ export function BulkOperation (http, data = {}) {
    * .then((response) => {  console.log(response.notice) })
    */
   // eslint-disable-next-line camelcase
-  this.unpublish = async ({ details, skip_workflow_stage = false, approvals = false, is_nested = false, api_version = '', unpublishAllLocalized = false }) => {
+  this.unpublish = async ({ details, skip_workflow_stage = false, approvals = false, is_nested = false, api_version = getServiceVersion('bulk_unpublish'), unpublishAllLocalized = false }) => {
     var httpBody = {}
     if (details) {
       httpBody = cloneDeep(details)
@@ -355,7 +348,7 @@ export function BulkOperation (http, data = {}) {
       headers.headers.approvals = approvals
     }
     // eslint-disable-next-line camelcase
-    if (api_version) headers.headers.api_version = api_version
+    headers.headers.api_version = api_version
 
     if (unpublishAllLocalized) {
       if (!headers.params) {

lib/stack/globalField/index.js

@@ -4,6 +4,7 @@ import error from '../../core/contentstackError'
 import FormData from 'form-data'
 import { createReadStream } from 'fs'
 import { bindModuleHeaders } from '../../core/moduleHeaderSupport.js'
+import { getServiceVersion } from '../../core/serviceVersion.js'
 
 /**
  * GlobalField defines the structure or schema of a page or a section of your web or mobile property. To create global Fields for your application, you are required to first create a global field. Read more about <a href='https://www.contentstack.com/docs/guide/global-fields'>Global Fields</a>.
@@ -15,7 +16,7 @@ export function GlobalField (http, data = {}) {
 
   this.stackHeaders = {
     ...cloneDeep(rawHeaders),
-    ...(data.apiVersion ? { api_version: data.apiVersion } : {}),
+    api_version: data.apiVersion ?? getServiceVersion('global_field'),
     ...(data.branch ? { branch: data.branch } : {})
   }
 

lib/stack/release/index.js

@@ -8,6 +8,7 @@ import {
 import error from '../../core/contentstackError'
 import { bindModuleHeaders } from '../../core/moduleHeaderSupport.js'
 import { ReleaseItem, ReleaseItemCollection } from './items'
+import { getServiceVersion } from '../../core/serviceVersion.js'
 /**
  * @description You can pin a set of entries and assets (along with the deploy action, i.e., publish/unpublish) to a ‘release’, and then deploy this release to an environment.
  * This will publish/unpublish all the items of the release to the specified environment. Read more about <a href='https://www.contentstack.com/docs/developers/create-releases'>Releases</a>.
@@ -167,9 +168,10 @@ export function Release (http, data = {}) {
       var release = { environments, locales, scheduledAt, action }
       const headers = {
         headers: {
-          ...cloneDeep(this.stackHeaders)
+          ...cloneDeep(this.stackHeaders),
+          api_version: getServiceVersion('release')
         }
-      } || {}
+      }
 
       try {
         const response = await http.post(`${this.urlPath}/deploy`, { release }, headers)

test/unit/globalField-test.js

@@ -10,7 +10,7 @@ describe('Contentstack GlobalField test', () => {
   it('GlobalField test without uid', (done) => {
     const globalField = makeGlobalField()
     expect(globalField.urlPath).to.be.equal('/global_fields')
-    expect(globalField.stackHeaders).to.deep.equal({})
+    expect(globalField.stackHeaders).to.deep.equal({ api_version: '3.2' })
     expect(globalField.update).to.be.equal(undefined)
     expect(globalField.delete).to.be.equal(undefined)
     expect(globalField.fetch).to.be.equal(undefined)
@@ -27,7 +27,7 @@ describe('Contentstack GlobalField test', () => {
     })
 
     expect(globalField.urlPath).to.be.equal(`/global_fields/${systemUidMock.uid}`)
-    expect(globalField.stackHeaders).to.deep.equal({})
+    expect(globalField.stackHeaders).to.deep.equal({ api_version: '3.2' })
     expect(globalField.update).to.not.equal(undefined)
     expect(globalField.delete).to.not.equal(undefined)
     expect(globalField.fetch).to.not.equal(undefined)