Added variants support (#211)

* Added variants support

* version bump

* updated changelog file

* type support added

* fixed PR comments

* Fixed testcases

* Added typescript testcases

* uncommented code

Author: sunil-lakshman

CHANGELOG.md

@@ -1,5 +1,10 @@
 ## Change log
 
+### Version: 3.21.0
+#### Date:  September-09-2024
+##### Fix:
+ - Feat Variants support added
+
 ### Version: 3.20.4
 #### Date:  August-14-2024
 ##### Fix:

index.d.ts

@@ -236,6 +236,7 @@ export class Entry {
     includeOwner(): this;
     toJSON(): this;
     addParam(key: string, value: any): this;
+    variants(variant_headers: string | string[]): this;
     fetch(fetchOptions?: object): Promise<any>;
 }
 

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "contentstack",
-  "version": "3.20.5",
+  "version": "3.21.0",
   "description": "Contentstack Javascript SDK",
   "homepage": "https://www.contentstack.com/",
   "author": {
@@ -100,10 +100,10 @@
   },
   "dependencies": {
     "@contentstack/utils": "^1.3.10",
-    "cheerio": "^1.0.0-rc.12",
+    "cheerio": "^1.0.0",
     "es6-promise": "^4.1.1",
     "isomorphic-fetch": "^3.0.0",
     "localStorage": "1.0.4",
-    "qs": "^6.12.1"
+    "qs": "^6.12.3"
   }
 }

package.json

@@ -342,6 +342,22 @@ export default class Entry {
         }
     }
 
+    /**
+     * @method Variants
+     * @memberOf Entry
+     * @param {String} uid - uid of the variants entry 
+     * @description An initializer is responsible for creating Variants Entry object
+     * @returns {Variants}
+     * @instance 
+     */
+    variants(variant_headers) {
+        if (Array.isArray(variant_headers) && variant_headers.length > 0) {
+            this.headers['x-cs-variant-uid'] = variant_headers.join(',')
+        }else{
+            this.headers['x-cs-variant-uid'] = variant_headers;
+        }
+        return this;
+     }
 
     /**
      * @method fetch

src/core/modules/entry.js

@@ -790,6 +790,22 @@ export default class Query extends Entry {
         var options = Utils.mergeDeep(this.fetchOptions, fetchOptions);
         return Utils.sendRequest(Utils.mergeDeep({}, this), options);
     }
+    /**
+     * @method Variants
+     * @memberOf Query
+     * @param {String} uid - uid of the variants entry 
+     * @description An initializer is responsible for creating Variants Entry object
+     * @returns {Variants}
+     * @instance 
+     */
+    variants(variant_headers) {
+        if (Array.isArray(variant_headers) && variant_headers.length > 0) {
+            this.headers['x-cs-variant-uid'] = variant_headers.join(',')
+        }else{
+            this.headers['x-cs-variant-uid'] = variant_headers;
+        }
+        return this;
+    }
 
      /**
      * @method findOne

src/core/modules/query.js

@@ -1658,4 +1658,19 @@ test('CT Taxonomies Query: Get Entries With Taxonomy Terms Parent and Excluding
             assert.fail("CT Taxonomies Query: Get Entries With Taxonomy Terms Parent and Excluding the term itself ($above, level)");
             assert.end();
         })
-})
+})
+test('Variants in entry', function (t) {
+    let Query = Stack.ContentType('source').Query();
+    Query
+        .variants(['variant_entry_1', 'variant_entry_2'])
+        .toJSON()
+        .find()
+        .then(entries => {
+            assert.ok(entries[0].length, 'Variant entries present in the resultset');
+            assert.end();
+        }, err => {
+            console.error("error :", err);
+            assert.fail("Variant Entries are not present in the CT");
+            assert.end();
+        })
+});

test/entry/find.js

@@ -455,6 +455,11 @@ describe('Entry Query Test', () => {
         done();
     });
 
+    test('Variants Query: Get variant Entries', done => {
+        makeEntryQuery().variants(['variantEntryUid1', 'variantEntryUid2']).find().then((response) => done()).catch((error) => done());
+        done();
+    });
+
     test('Taxonomy find test', done => {
         makeTaxonomyQuery().find().then((response) => done()).catch((error) => done());
     });
@@ -466,4 +471,4 @@ function makeEntryQuery() {
 
 function makeTaxonomyQuery() {
     return stack.Taxonomies()
-}
+}