Merge branch 'development' into sanity/update-token-expiry

Author: harshithad0703

.github/workflows/npm-publish.yml

@@ -13,7 +13,7 @@ jobs:
       - uses: actions/checkout@v3
       - uses: actions/setup-node@v3
         with:
-          node-version: '20.x'
+          node-version: '22.x'
           registry-url: 'https://registry.npmjs.org'
       - run: npm ci
       - run: npm publish
@@ -25,7 +25,7 @@ jobs:
       - uses: actions/checkout@v3
       - uses: actions/setup-node@v3
         with:
-          node-version: '20.x'
+          node-version: '22.x'
           registry-url: 'https://npm.pkg.github.com'
           scope: '@contentstack'
       - run: npm ci

.github/workflows/unit-test.yml

@@ -13,7 +13,7 @@ jobs:
       - uses: actions/checkout@v2     # checkout the repo
       - uses: actions/setup-node@v3
         with:
-          node-version: '20.x'
+          node-version: '22.x'
           registry-url: 'https://registry.npmjs.org'
       - run: npm ci                   # install packages
       - run: npm run test:unit:report:json                 # run tests (configured to use jest-junit reporter)

CHANGELOG.md

@@ -1,4 +1,14 @@
 # Changelog
+## [v1.18.4](https://github.com/contentstack/contentstack-management-javascript/tree/v1.18.4) (2024-11-22)
+ - Enhancement
+    - Added support for response headers.
+## [v1.18.3](https://github.com/contentstack/contentstack-management-javascript/tree/v1.18.3) (2024-11-8)
+ - Fix
+    - Fixed incorrect input type for bulk delete operation
+## [v1.18.2](https://github.com/contentstack/contentstack-management-javascript/tree/v1.18.2) (2024-10-3)
+ - Fix
+    - Variants testcases Added
+    - Node v22 support
 ## [v1.18.1](https://github.com/contentstack/contentstack-management-javascript/tree/v1.18.1) (2024-09-27)
  - Fix
     - Variants testcases Added

lib/contentstackCollection.js

@@ -7,6 +7,12 @@ export default class ContentstackCollection {
     if (stackHeaders) {
       data.stackHeaders = stackHeaders
     }
+    if (http?.httpClientParams?.headers?.includeResHeaders === true) {
+      data.stackHeaders = {
+        ...data.stackHeaders,
+        responseHeaders: response.headers,
+      };
+    }
     if (wrapperCollection) {
       this.items = wrapperCollection(http, data)
     }

lib/entity.js

@@ -84,7 +84,7 @@ export const create = ({ http, params }) => {
     try {
       const response = await http.post(this.urlPath, data, headers)
       if (response.data) {
-        return new this.constructor(http, parseData(response, this.stackHeaders, this.content_type_uid, this.taxonomy_uid))
+        return new this.constructor(http, parseData(response, this.stackHeaders, this.content_type_uid, this.taxonomy_uid, http))
       } else {
         if (response.status >= 200 && response.status < 300) {
           return {
@@ -152,7 +152,7 @@ export const update = (http, type, params = {}) => {
       }
       })
       if (response.data) {
-        return new this.constructor(http, parseData(response, this.stackHeaders, this.content_type_uid, this.taxonomy_uid))
+        return new this.constructor(http, parseData(response, this.stackHeaders, this.content_type_uid, this.taxonomy_uid, http))
       } else {
         throw error(response)
       }
@@ -211,7 +211,7 @@ export const fetch = (http, type, params = {}) => {
           response.data[type]['content_type'] = response.data['content_type']
           response.data[type]['schema'] = response.data['schema']
         }
-        return new this.constructor(http, parseData(response, this.stackHeaders, this.content_type_uid, this.taxonomy_uid))
+        return new this.constructor(http, parseData(response, this.stackHeaders, this.content_type_uid, this.taxonomy_uid, http))
       } else {
         throw error(response)
       }
@@ -242,7 +242,7 @@ export const fetchAll = (http, wrapperCollection, params = {}) => {
   }
 }
 
-export function parseData (response, stackHeaders, contentTypeUID, taxonomy_uid) {
+export function parseData (response, stackHeaders, contentTypeUID, taxonomy_uid, http) {
   const data = response.data || {}
   if (stackHeaders) {
     data.stackHeaders = stackHeaders
@@ -253,6 +253,12 @@ export function parseData (response, stackHeaders, contentTypeUID, taxonomy_uid)
   if (taxonomy_uid) {
     data.taxonomy_uid = taxonomy_uid
   }
+  if (http?.httpClientParams?.headers?.includeResHeaders === true) {
+    data.stackHeaders = {
+      ...data.stackHeaders,
+      responseHeaders: response.headers,
+    };
+  }
   return data
 }
 
@@ -300,7 +306,7 @@ export const move = (http, type, force = false, params = {}) => {
       }
       const response = await http.put(`${this.urlPath}/move`, updateData, headers)
       if (response.data) {
-        return new this.constructor(http, parseData(response, this.stackHeaders, this.content_type_uid, this.taxonomy_uid))
+        return new this.constructor(http, parseData(response, this.stackHeaders, this.content_type_uid, this.taxonomy_uid, http))
       } else {
         throw error(response)
       }

lib/stack/variantGroup/index.js

@@ -59,22 +59,6 @@ export function VariantGroup (http, data = {}) {
        */
     this.delete = deleteEntity(http)
 
-    /**
-       * @description The fetch VariantGroup call fetches VariantGroup details.
-       * @memberof VariantGroup
-       * @func fetch
-       * @returns {Promise<VariantGroup.VariantGroup>} Promise for VariantGroup instance
-       * @param {Int} version Enter the unique ID of the content type of which you want to retrieve the details. The UID is generated based on the title of the content type. The unique ID of a content type is unique across a stack.
-       * @example
-       * import * as contentstack from '@contentstack/management'
-       * const client = contentstack.client()
-       *
-       * client.stack({ api_key: 'api_key'}).VariantGroup('variant_group_uid').fetch()
-       * .then((variant_group) => console.log(variant_group))
-       *
-       */
-    // this.fetch = fetch(http, 'variant_group')
-
     /**
      * @description Content type defines the structure or schema of a page or a section of your web or mobile property.
      * @param {String} uid The UID of the ContentType you want to get details.
@@ -115,7 +99,24 @@ export function VariantGroup (http, data = {}) {
      * client.stack().VariantGroup().create({ variant_group } )
      * .then((variant_group) => console.log(variant_group))
      */
-    this.create = create({ http: http })
+    this.create = async (data) => {
+      try {
+        const response = await http.post(`${this.urlPath}`,
+           data ,
+          {
+            headers: {
+              ...cloneDeep(this.stackHeaders)
+            }
+          })
+        if (response.data) {
+          return response.data
+        } else {
+          return error(response)
+        }
+      } catch (err) {
+        return error(err)
+      }
+    }
 
     /**
      * @description The Query on Variant Groups will allow to fetch details of all or specific Variant Groups

lib/stack/variantGroup/variants/index.js

@@ -60,7 +60,25 @@ export function Variants(http, data = {}) {
        * .then((variants) => console.log(variants))
        *
        */
-    this.fetch = fetch(http, 'variants')
+    this.fetch = async (param = {}) => {
+      try {
+        const headers = {
+          headers: { ...cloneDeep(this.stackHeaders) },
+          params: {
+            ...cloneDeep(param)
+          }
+        } || {}
+
+        const response = await http.get(this.urlPath, headers)
+        if (response.data) {
+          return response.data
+        } else {
+          throw error(response)
+        }
+      } catch (err) {
+        error(err) 
+      }
+    }
 
     /**
        * @description The Delete Variant call is used to delete an existing Variant permanently from your Stack.
@@ -98,7 +116,24 @@ export function Variants(http, data = {}) {
      * client.stack().VariantGroup('variant_group_uid').variants().create({ data } )
      * .then((variants) => console.log(variants))
      */
-    this.create = create({ http: http })
+    this.create = async (data) => {
+      try {
+        const response = await http.post(`${this.urlPath}`,
+           data ,
+          {
+            headers: {
+              ...cloneDeep(this.stackHeaders)
+            }
+          })
+        if (response.data) {
+          return response.data
+        } else {
+          return error(response)
+        }
+      } catch (err) {
+        return error(err)
+      }
+    }
 
     /**
      * @description The Query on Variant Groups will allow to fetch details of all or specific Variant Groups

lib/stack/variants/index.js

@@ -44,7 +44,25 @@ export function Variants (http, data) {
      * .then((variants) => console.log(variants))
      *
      */
-    this.fetch = fetch(http, 'variants')
+    this.fetch = async (param = {}) => {
+      try {
+        const headers = {
+          headers: { ...cloneDeep(this.stackHeaders) },
+          params: {
+            ...cloneDeep(param)
+          }
+        } || {}
+
+        const response = await http.get(this.urlPath, headers)
+        if (response.data) {
+          return response.data
+        } else {
+          throw error(response)
+        }
+      } catch (err) {
+        error(err) 
+      }
+    }
   } else {
     /**
      * @description The Create an variants call creates a new variants.
@@ -68,7 +86,24 @@ export function Variants (http, data) {
      * client.stack().variants().create({ variants })
      * .then((variants) => console.log(variants))
      */
-    this.create = create({ http })
+    this.create = async (data) => {
+      try {
+        const response = await http.post(`${this.urlPath}`,
+           data ,
+          {
+            headers: {
+              ...cloneDeep(this.stackHeaders)
+            }
+          })
+        if (response.data) {
+          return response.data
+        } else {
+          return error(response)
+        }
+      } catch (err) {
+        return error(err)
+      }
+    }
 
     /**
      * @description The Query on Variants will allow to fetch details of all or specific Variants.