Implemented variants support (#45)

* Implemented variants support

* version update

* axios package bump

* version bump

Author: sunil-lakshman

CHANGELOG.md

@@ -1,5 +1,9 @@
 ## Change log
 
+### Version: 4.2.0
+#### Date: Septmber-04-2024
+Feat: Variants support added
+
 ### Version: 4.1.0
 #### Date: August-07-2024
 Feat: Live Preview configuration changes

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "@contentstack/delivery-sdk",
-  "version": "4.1.0",
+  "version": "4.2.0",
   "type": "commonjs",
   "main": "./dist/cjs/src/index.js",
   "types": "./dist/types/src/index.d.ts",
@@ -23,7 +23,7 @@
     "@contentstack/core": "^1.1.0",
     "@contentstack/utils": "^1.3.8",
     "@types/humps": "^2.0.6",
-    "axios": "^1.7.2",
+    "axios": "^1.7.4",
     "dotenv": "^16.3.1",
     "humps": "^2.0.1"
   },

package.json

@@ -184,4 +184,25 @@ export class Entries extends EntryQueryable {
 
     return new Query(this._client, this._parameters, this._queryParams, this._contentTypeUid);
   }
+
+  /**
+   * @method variants
+   * @memberof Entry
+   * @description The variant header will be added to axios client
+   * @returns {Entry}
+   * @example
+   * import contentstack from '@contentstack/delivery-sdk'
+   *
+   * const stack = contentstack.Stack({ apiKey: "apiKey", deliveryToken: "deliveryToken", environment: "environment" });
+   * const result = await stack.contentType('abc').entry().variant('xyz').find();
+   */
+  variants(variants: string | string[]): Entries {
+    if (Array.isArray(variants) && variants.length > 0) {
+      this._client.defaults.headers['x-cs-variant-uid'] = variants.join(',');
+    } else if (typeof variants == 'string' && variants.length > 0) {
+      this._client.defaults.headers['x-cs-variant-uid'] = variants;
+    }
+
+    return this;
+  }
 }

src/lib/entries.ts

@@ -4,7 +4,7 @@ interface EntryResponse<T> {
   entry: T;
 }
 export class Entry {
-  private _client: AxiosInstance;
+  protected _client: AxiosInstance;
   private _contentTypeUid: string;
   private _entryUid: string;
   private _urlPath: string;
@@ -34,6 +34,27 @@ export class Entry {
     return this;
   }
 
+  /**
+   * @method variants
+   * @memberof Entry
+   * @description The variant header will be added to axios client
+   * @returns {Entry}
+   * @example
+   * import contentstack from '@contentstack/delivery-sdk'
+   *
+   * const stack = contentstack.Stack({ apiKey: "apiKey", deliveryToken: "deliveryToken", environment: "environment" });
+   * const result = await stack.contentType('abc').entry('entry_uid').variant('xyz').fetch();
+   */
+  variants(variants: string | string[]): Entry {
+    if (Array.isArray(variants) && variants.length > 0) {
+      this._client.defaults.headers['x-cs-variant-uid'] = variants.join(',');
+    } else if (typeof variants == 'string' && variants.length > 0) {
+      this._client.defaults.headers['x-cs-variant-uid'] = variants;
+    }
+
+    return this;
+  }
+
   /**
    * @method includeMetadata
    * @memberof Entry

src/lib/entry.ts

@@ -137,3 +137,31 @@ describe('Entries class', () => {
       expect(query._parameters).toEqual({"taxonomies.taxonomy_uid": {"$above": "term_uid", "levels": 4 }});
     });
 });
+
+class TestVariants extends Entries {
+
+  constructor(client: AxiosInstance) {
+    super(client, 'xyz');
+    this._client = client;
+  }
+
+  getVariantsHeaders(): string {
+    return this._client.defaults.headers['x-cs-variant-uid'] || "";
+  }
+}
+
+describe('Variants test', () => {
+  let client: AxiosInstance;
+  let mockClient: MockAdapter;
+
+  beforeAll(() => {
+    client = httpClient(MOCK_CLIENT_OPTIONS);
+    mockClient = new MockAdapter(client as any);
+  });
+  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');
+  });
+})

test/unit/entries.spec.ts

@@ -62,3 +62,30 @@ describe('Entry class', () => {
     expect(returnedValue).toEqual(entryFetchMock.entry);
   });
 });
+
+class TestVariants extends Entry {
+  constructor(client: AxiosInstance) {
+    super(client, 'xyz', 'abc');
+    this._client = client;
+  }
+
+  getVariantsHeaders(): string {
+    return this._client.defaults.headers['x-cs-variant-uid'] || "";
+  }
+}
+
+describe('Variants test', () => {
+  let client: AxiosInstance;
+  let mockClient: MockAdapter;
+
+  beforeAll(() => {
+    client = httpClient(MOCK_CLIENT_OPTIONS);
+    mockClient = new MockAdapter(client as any);
+  });
+  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');
+  });
+})