Merge pull request #51 from contentstack/next

Added array of values in includereference method

Author: cs-raj

CHANGELOG.md

@@ -1,5 +1,9 @@
 ## Change log
 
+### Version: 4.3.0
+#### Date: Septmber-09-2024
+Feat: Include refernce accepts array of values 
+
 ### Version: 4.2.0
 #### Date: Septmber-04-2024
 Feat: Variants support added

package-lock.json

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

package.json

@@ -111,9 +111,17 @@ export class Entries extends EntryQueryable {
    * @param {string} referenceFieldUid - UID of the reference field to include.
    * @returns {Entries} - Returns the Entries instance for chaining.
    */
-  includeReference(referenceFieldUid: string): Entries {
-    this._queryParams['include[]'] = referenceFieldUid;
-
+  includeReference(...referenceFieldUid: (string | string[])[]): Entries {
+    if (referenceFieldUid.length) {
+      referenceFieldUid.forEach(value => {
+        if (!Array.isArray(this._queryParams['include[]'])) {
+          this._queryParams['include[]'] = [];
+        }
+        (this._queryParams['include[]'] as string[]).push(...(Array.isArray(value) ? value : [value]));
+      });
+    } else {
+      console.error("Argument should be a String or an Array.");
+    }
     return this;
   }
 

src/lib/entries.ts

@@ -8,7 +8,7 @@ export class Entry {
   private _contentTypeUid: string;
   private _entryUid: string;
   private _urlPath: string;
-  _queryParams: { [key: string]: string | number } = {};
+  _queryParams: { [key: string]: string | number | string[] } = {};
 
   constructor(client: AxiosInstance, contentTypeUid: string, entryUid: string) {
     this._client = client;

src/lib/entry.ts

@@ -3,5 +3,5 @@ export type params = {
 }
 
 export type queryParams = { 
-    [key: string]: string | boolean | number 
+    [key: string]: string | boolean | number | string[]
 }

src/lib/internal-types.ts

@@ -35,9 +35,9 @@ describe('Entries class', () => {
   it('should set the include parameter to the given reference field UID', () => {
     const referenceFieldUid = 'referenceFieldUid';
     entry.includeReference(referenceFieldUid);
+    expect(entry._queryParams['include[]']).toContain(referenceFieldUid);
+});
 
-    expect(entry._queryParams['include[]']).toBe(referenceFieldUid);
-  });
 
   it('should add "include_fallback" in _queryParams when includeFallback method is called', () => {
     const returnedValue = entry.includeFallback();