Merge pull request #213 from contentstack/next

Added variants support

Author: cs-raj

CHANGELOG.md

@@ -1,5 +1,14 @@
 ## Change log
 
+### Version: 3.21.0
+#### Date:  September-09-2024
+##### Fix:
+ - Feat Variants support added
+
+### Version: 3.20.4
+#### Date:  August-14-2024
+##### Fix:
+ - Fix file upload function in sanity report file
 
 ### Version: 3.20.3
 #### Date:  August-02-2024

README.md

@@ -19,11 +19,11 @@ For browsers, we recommend to download the library via npm or yarn to ensure 100
 If you'd like to use a standalone built file you can use the following script tag or download it from [jsDelivr](https://www.jsdelivr.com/package/npm/contentstack), under the `dist` directory:
 
 ```html
-<script src="https://cdn.jsdelivr.net/npm/contentstack@latest/dist/web/contentstack.min.js"></script>
+<script src="https://cdn.jsdelivr.net/npm/contentstack@latest/dist/web/contentstack.min.js" integrity="9u29niwIJG3dEc7vPUc1ZA1Dl/uaiR4+s7k55kb/CCkzTzyFuZHNM165BQ10+Hiw%" crossorigin="anonymous"></script>
 ```
 You can also specify a specific version number.
 ```html
-<script src="https://cdn.jsdelivr.net/npm/contentstack@3.16.0/dist/web/contentstack.min.js"></script>
+<script src="https://cdn.jsdelivr.net/npm/contentstack@3.20.3/dist/web/contentstack.min.js" integrity="9u29niwIJG3dEc7vPUc1ZA1Dl/uaiR4+s7k55kb/CCkzTzyFuZHNM165BQ10+Hiw%" crossorigin="anonymous"></script>
 ```
 
 To initialize the SDK, you will need to specify the API Key, Delivery Token, and Environment Name of your stack.

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.3",
+  "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

@@ -50,9 +50,9 @@ async function publishMessage (text, report) {
     channel: process.env.SLACK_CHANNEL,
     text: text
   })
-  await app.client.files.upload({
+  await app.client.files.uploadV2({
     token: process.env.SLACK_BOT_TOKEN,
-    channels: process.env.SLACK_CHANNEL,
+    channel_id: process.env.SLACK_CHANNEL_ID,
     initial_comment: '*Here is the report generated*',
     filetype: 'html',
     filename: 'tap-html.html',

sanity-report.js

@@ -9,28 +9,25 @@ export default function Request(stack, fetchOptions) {
     let requestParams = stack.requestParams;
     return new Promise(function(resolve, reject) {
         let queryParams;
-        let serialize = function(obj, prefix) {
-
-            let str = [],
-                p;
-            if (typeof obj === "object" && obj.length !== undefined) {
-                for (var i = 0, _i = obj.length; i < _i; i++) {
-                    str.push(prefix + '[]=' + obj[i]);
-                }
-            } else {
-                for (const p in obj) {
-                    let k = prefix ? prefix + "[" + p + "]" : p,
-                        v = obj[p];
-                    str.push((v !== null && typeof v === "object" && p !== 'query') ?
-                        serialize(v, k) :
-                        k + "=" + encodeURIComponent(p !== 'query' ? v : JSON.stringify(v)));
-                }
+        
+        const params = new URLSearchParams();
+        let serialize = function (obj, prefix) {
+          if (typeof obj === 'object' && obj.length !== undefined) {
+            for (let i = 0, _i = obj.length; i < _i; i++) {
+              params.append(prefix + '[]', obj[i]);
+            }
+          } else {
+            for (const p in obj) {
+              let k = prefix ? prefix + '[' + p + ']' : p,
+                v = obj[p];
+              v !== null && typeof v === 'object' && p !== 'query'
+                ? serialize(v, k)
+                : params.append(k, p !== 'query' ? v : JSON.stringify(v));
             }
-            return str.join("&");
+          }
+          return params.toString();
         };
 
-        
-
         // setting headers
         requestParams.headers['Content-Type'] = 'application/json; charset=UTF-8';
         requestParams.headers['X-User-Agent'] = 'contentstack-delivery-javascript-{{PLATFORM}}/' + version;

src/core/lib/request.js

@@ -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()
-}
+}