Added include reference support for entry UID (#97)

Author: sunil-lakshman

CHANGELOG.md

@@ -1,3 +1,7 @@
+### Version: 4.4.4
+#### Date: January-06-2025
+Enh: Include References on Entry UID
+
 ### Version: 4.4.3
 #### Date: November-30-2024
 Fix: regex method fixed for validation

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "@contentstack/delivery-sdk",
-  "version": "4.4.3",
+  "version": "4.4.4",
   "type": "module",
   "license": "MIT",
   "main": "./dist/legacy/index.cjs",

package.json

@@ -91,6 +91,33 @@ export class Entry {
     return this;
   }
 
+  /**
+   * @method includeReference
+   * @memberof Entry
+   * @description To include the content of the referred entry in your response,
+   * you need to use the include[] parameter and specify the UID of the reference field as value.
+   * This function sets the include parameter to a reference field UID in the API request.
+   * @example
+   * const stack = contentstack.stack("apiKey", "deliveryKey", "environment");
+   * const query = stack.contentType("contentTypeUid").entry(entry_uid).includeReference("brand").fetch()
+   *
+   * @param {string} referenceFieldUid - UID of the reference field to include.
+   * @returns {Entry} - Returns the Entry instance for chaining.
+   */
+  includeReference(...referenceFieldUid: (string | string[])[]): Entry {
+    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;
+  }
+
   /**
    * @method includeContentType
    * @memberof Entry

src/lib/entry.ts

@@ -50,6 +50,15 @@ describe('Entry API tests', () => {
     expect(result.created_by).toBeDefined();
     expect(result.updated_by).toBeDefined();
   });
+  it('should check for include reference', async () => {
+    const result = await makeEntry(entryUid).includeReference('author').fetch<TEntry>();
+    expect(result.title).toBeDefined();
+    expect(result.author).toBeDefined();
+    expect(result.title).toBeDefined();
+    expect(result.url).toBeDefined();
+    expect(result._version).toBeDefined();
+    expect(result.publish_details).toBeDefined();
+  });
 });
 function makeEntry(uid = ''): Entry {
   const entry = stack.contentType('author').entry(uid);

test/api/entry.spec.ts

@@ -37,6 +37,13 @@ describe('Entry class', () => {
     expect(entry._queryParams.include_fallback).toBe('true');
   });
 
+  it('should set the include parameter to the given reference field UID', () => {
+    const referenceFieldUid = 'referenceFieldUid';
+    const returnedValue = entry.includeReference(referenceFieldUid);
+    expect(returnedValue).toBeInstanceOf(Entry);
+    expect(entry._queryParams['include[]']).toContain(referenceFieldUid);
+  });
+
   it('should add "include_metadata" in _queryParams when includeMetadata method is called', () => {
     const returnedValue = entry.includeMetadata();
     expect(returnedValue).toBeInstanceOf(Entry);