Merge pull request #62 from contentstack/fix/DX-1492

Fix: Variants headers to be added only on specific call

Author: nadeem-cs

CHANGELOG.md

@@ -1,3 +1,7 @@
+### Version: 4.4.1
+#### Date: October-21-2024
+Fix: getData to receive params and headers both in data
+
 ### Version: 4.4.0
 #### Date: October-21-2024
 Enh: Node version bump

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@contentstack/delivery-sdk",
-  "version": "4.4.0",
+  "version": "4.4.1",
   "type": "module",
   "main": "./dist/cjs/src/index.js",
   "types": "./dist/types/src/index.d.ts",

src/lib/asset.ts

@@ -141,7 +141,7 @@ export class Asset {
    * const result = await stack.asset('asset_uid').fetch();
    */
   async fetch<T>(): Promise<T> {
-    const response = await getData(this._client, this._urlPath, this._queryParams);
+    const response = await getData(this._client, this._urlPath, { params: this._queryParams});
 
     if (response.asset) return response.asset as T;
 

src/lib/base-query.ts

@@ -8,6 +8,7 @@ export class BaseQuery extends Pagination {
 
   protected _client!: AxiosInstance;
   protected _urlPath!: string;
+  protected _variants!: string;
 
   /**
    * @method includeCount
@@ -203,9 +204,21 @@ export class BaseQuery extends Pagination {
 
   async find<T>(): Promise<FindResponse<T>> {
     let requestParams: { [key: string]: any } = this._queryParams;
-    if (Object.keys(this._parameters)) requestParams = { ...this._queryParams, query: { ...this._parameters } };
 
-    const response = await getData(this._client, this._urlPath, requestParams);
+    if (Object.keys(this._parameters).length > 0) {
+      requestParams = { ...this._queryParams, query: { ...this._parameters } };
+    }
+
+    const getRequestOptions: any = { params: requestParams };
+
+    if (this._variants) {
+      getRequestOptions.headers = {
+        ...getRequestOptions.headers,
+        'x-cs-variant-uid': this._variants
+      };
+    }
+    
+    const response = await getData(this._client, this._urlPath, getRequestOptions);
 
     return response as FindResponse<T>;
   }

src/lib/contenttype-query.ts

@@ -40,7 +40,7 @@ export class ContentTypeQuery {
    * const result = await contentTypeQuery.find();
    */
   async find<T>(): Promise<FindResponse<T>> {
-    const response = await getData(this._client, this._urlPath, this._queryParams);
+    const response = await getData(this._client, this._urlPath, { params: this._queryParams });
 
     return response as FindResponse<T>;
   }

src/lib/entries.ts

@@ -10,6 +10,7 @@ export class Entries extends EntryQueryable {
     this._client = client;
     this._contentTypeUid = contentTypeUid;
     this._urlPath = `/content_types/${this._contentTypeUid}/entries`;
+    this._variants = '';
   }
 
   /**
@@ -206,11 +207,10 @@ export class Entries extends EntryQueryable {
    */
   variants(variants: string | string[]): Entries {
     if (Array.isArray(variants) && variants.length > 0) {
-      this._client.defaults.headers['x-cs-variant-uid'] = variants.join(',');
+      this._variants = variants.join(',');
     } else if (typeof variants == 'string' && variants.length > 0) {
-      this._client.defaults.headers['x-cs-variant-uid'] = variants;
+      this._variants = variants;
     }
-
     return this;
   }
 }

src/lib/entry.ts

@@ -8,13 +8,15 @@ export class Entry {
   private _contentTypeUid: string;
   private _entryUid: string;
   private _urlPath: string;
+  protected _variants: string;
   _queryParams: { [key: string]: string | number | string[] } = {};
 
   constructor(client: AxiosInstance, contentTypeUid: string, entryUid: string) {
     this._client = client;
     this._contentTypeUid = contentTypeUid;
     this._entryUid = entryUid;
     this._urlPath = `/content_types/${this._contentTypeUid}/entries/${this._entryUid}`;
+    this._variants = '';
   }
 
   /**
@@ -47,9 +49,9 @@ export class Entry {
    */
   variants(variants: string | string[]): Entry {
     if (Array.isArray(variants) && variants.length > 0) {
-      this._client.defaults.headers['x-cs-variant-uid'] = variants.join(',');
+      this._variants = variants.join(',');
     } else if (typeof variants == 'string' && variants.length > 0) {
-      this._client.defaults.headers['x-cs-variant-uid'] = variants;
+      this._variants = variants;
     }
 
     return this;
@@ -152,7 +154,15 @@ export class Entry {
    * const result = await stack.contentType(contentType_uid).entry(entry_uid).fetch();
    */
   async fetch<T>(): Promise<T> {
-    const response = await getData(this._client, this._urlPath, this._queryParams);
+    const getRequestOptions: any = { params: this._queryParams};
+    if (this._variants) {
+      getRequestOptions.headers = {
+        ...getRequestOptions.headers,
+        'x-cs-variant-uid': this._variants
+      };
+    }
+
+    const response = await getData(this._client, this._urlPath, getRequestOptions);
 
     if (response.entry) return response.entry as T;
 

src/lib/global-field.ts

@@ -35,7 +35,7 @@ export class GlobalField {
    * const result = globalField.fetch();
    */
   async fetch<T>(): Promise<T> {
-    const response = await getData(this._client, this._urlPath, this._queryParams);
+    const response = await getData(this._client, this._urlPath, { params: this._queryParams });
 
     return response.global_field as T;
   }

src/lib/synchronization.ts

@@ -15,7 +15,7 @@ export async function synchronization(client: AxiosInstance, params: SyncStack |
     config.params = { ...config.params, type: type.join(',') };
   }
 
-  let response: AxiosResponse = await getData(client, '/sync', humps.decamelizeKeys(config));
+  let response: AxiosResponse = await getData(client, '/sync', { params: humps.decamelizeKeys(config) });
   const data = response.data;
 
   while (recursive && 'pagination_token' in response.data) {

test/unit/entries.spec.ts

@@ -145,8 +145,9 @@ class TestVariants extends Entries {
     this._client = client;
   }
 
-  getVariantsHeaders(): string {
-    return this._client.defaults.headers['x-cs-variant-uid'] || "";
+  setAndGetVariantsHeaders(): string {
+    this.variants(['variant1', 'variant2']);
+    return this._variants || "";
   }
 }
 
@@ -161,7 +162,6 @@ describe('Variants test', () => {
   it('should get the correct variant headers added to client', async () => {
     const testVariantObj = new TestVariants(httpClient(MOCK_CLIENT_OPTIONS))
 
-    testVariantObj.variants(['variant1', 'variant2']);
-    expect(testVariantObj.getVariantsHeaders()).toBe('variant1,variant2');
+    expect(testVariantObj.setAndGetVariantsHeaders()).toBe('variant1,variant2');
   });
 })