Added support for nested global fields (#230)

* Added support for nested global fields * Added updated method * Added update method testcases * Added mock file * Fixed PR comments
contentstack · Jan 7, 2025 · 494bb51 · 494bb51
1 parent 0e5105b
commit 494bb51
Show file tree

Hide file tree

Showing 9 changed files with 677 additions and 120 deletions.
diff --git a/lib/entity.js b/lib/entity.js
@@ -71,6 +71,10 @@ export const upload = async ({ http, urlPath, stackHeaders, formData, params, me
 
 export const create = ({ http, params }) => {
   return async function (data, param) {
+    this.stackHeaders = { 
+      ...this.stackHeaders, 
+      ...(http.httpClientParams.headers?.api_version && { api_version: http.httpClientParams.headers.api_version })
+    };
     const headers = {
       headers: {
         ...cloneDeep(params),

diff --git a/lib/stack/globalField/index.js b/lib/stack/globalField/index.js
@@ -11,6 +11,12 @@ import { createReadStream } from 'fs'
 
 export function GlobalField (http, data = {}) {
   this.stackHeaders = data.stackHeaders
+  this.apiVersion = data.api_version || undefined;
+
+  if (this.apiVersion) {
+    http.defaults.headers.api_version = this.apiVersion;
+    http.httpClientParams.headers.api_version = this.apiVersion;
+  }
   this.urlPath = `/global_fields`
 
   if (data.global_field) {
@@ -36,6 +42,56 @@ export function GlobalField (http, data = {}) {
      */
     this.update = update(http, 'global_field')
 
+    /**
+     * @description The Update GlobalField call lets you update the name and description of an existing GlobalField.
+     * @memberof GlobalField
+     * @func update
+     * @returns {Promise<GlobalField.GlobalField>} Promise for GlobalField instance
+     * @example
+     * import * as contentstack from '@contentstack/management'
+     * const client = contentstack.client()
+     * const data = {
+     *    "global_field": {
+     *        "title": "Nested Global Field33",
+     *        "uid": "nested_global_field33",
+     *        "schema": [
+     *            {
+     *                "data_type": "text",
+     *                "display_name": "Single Line Textbox",
+     *                "uid": "single_line"
+     *            },
+     *            {
+     *                "data_type": "global_field",
+     *                "display_name": "Global",
+     *                "uid": "global_field",
+     *                "reference_to": "nested_global_field_123"
+     *            }
+     *        ]
+     *    }
+     *  }
+     * client.stack({ api_key: 'api_key'}).globalField('global_field_uid').updateNestedGlobalField(data, { headers: { api_version: '3.2' }})
+     * .then((globalField) => {
+          console.log(globalField)
+     * })
+     */
+    this.updateNestedGlobalField = async (config, headers={}) => {
+      const apiVersion = {api_version: '3.2' }
+      this.stackHeaders = {...this.stackHeaders, ...apiVersion, ...headers}
+      try {
+        const headers = {
+          headers: { ...cloneDeep(this.stackHeaders) }
+        }
+        const response = await http.put(`${this.urlPath}`, config, headers)
+        if (response.data) {
+          return response.data
+        } else {
+          throw error(response)
+        }
+      } catch (err) {
+        throw error(err)
+      }
+    }
+
     /**
      * @description The Delete GlobalField call is used to delete an existing GlobalField permanently from your Stack.
      * @memberof GlobalField
@@ -119,8 +175,9 @@ export function GlobalField (http, data = {}) {
    * .then((globalField) => console.log(globalField))
    *
    */
-    this.import = async function (data, params = {}) {
+    this.import = async function (data, params = {}, headers = {}) {
       try {
+        this.stackHeaders = { ...this.stackHeaders, ...headers };
         const response = await upload({
           http: http,
           urlPath: `${this.urlPath}/import`,

diff --git a/lib/stack/index.js b/lib/stack/index.js
@@ -159,12 +159,28 @@ export function Stack (http, data) {
      *
      * client.stack({ api_key: 'api_key'}).globalField('globalField_uid').fetch()
      * .then((globalField) => console.log(globalField))
-     */
-    this.globalField = (globalFieldUid = null) => {
-      const data = { stackHeaders: this.stackHeaders }
-      if (globalFieldUid) {
-        data.global_field = { uid: globalFieldUid }
+     * 
+     * client.stack({ api_key: 'api_key'}).globalField('globalField_uid', { api_version: '3.2' }).fetch()
+     * .then((globalField) => console.log(globalField))
+     * 
+     */
+    this.globalField = (globalFieldUidOrOptions = null, options = {}) => {
+      let data = { 
+        stackHeaders: this.stackHeaders,
+      };
+      if (typeof globalFieldUidOrOptions === 'object' && globalFieldUidOrOptions !== null) {
+        options = globalFieldUidOrOptions;
+      } else if (globalFieldUidOrOptions) {
+        data.global_field = { uid: globalFieldUidOrOptions };
+      }
+
+      if (options?.api_version) {
+        data.api_version = options.api_version;
+        if (options.api_version === '3.2') {
+          data.nested_global_fields = true;
+        }
       }
+
       return new GlobalField(http, data)
     }
 

diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@contentstack/management",
-  "version": "1.18.4",
+  "version": "1.19.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",