Merge pull request #305 from contentstack/enh/dx-3905

Added assetFields for DAM2.0 support

Author: sunil-lakshman

CHANGELOG.md

@@ -1,3 +1,7 @@
+### Version: 5.1.0
+#### Date: Mar-02-2026
+Fix: Added support of asset fields in assets & entries class.
+
 ### Version: 5.0.1
 #### Date: feb-23-2026
 Fix: Added support of special symbols in regex method with safe pattern.

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "@contentstack/delivery-sdk",
-  "version": "5.0.1",
+  "version": "5.1.0",
   "type": "module",
   "license": "MIT",
   "engines": {

package.json

@@ -3,7 +3,7 @@ import { AxiosInstance, getData } from '@contentstack/core';
 export class Asset {
   private _client: AxiosInstance;
   private _urlPath: string;
-  _queryParams: { [key: string]: string | number } = {};
+  _queryParams: { [key: string]: string | number | string[] } = {};
 
   constructor(client: AxiosInstance, assetUid: string) {
     this._client = client;
@@ -129,6 +129,27 @@ export class Asset {
     return this;
   }
 
+  /**
+   * @method assetFields
+   * @memberof Asset
+   * @description Include specific asset fields in the response (CDA getAssets - single asset).
+   * Use with asset_fields[]: user_defined_fields, embedded, ai_suggested, visual_markups.
+   * @example
+   * import contentstack from '@contentstack/delivery-sdk'
+   *
+   * const stack = contentstack.stack({ apiKey: "apiKey", deliveryToken: "deliveryToken", environment: "environment" });
+   * const result = await stack.asset("assetUid").assetFields("user_defined_fields", "embedded_metadata").fetch();
+   *
+   * @param {...string} fields - Asset field names to include (e.g. user_defined_fields, embedded, ai_suggested, visual_markups)
+   * @returns {Asset} - Returns the Asset instance for chaining.
+   */
+  assetFields(...fields: string[]): this {
+    if (fields.length > 0) {
+      this._queryParams['asset_fields[]'] = fields;
+    }
+    return this;
+  }
+
   /**
    * @method fetch
    * @memberof Asset

src/assets/asset.ts

@@ -277,6 +277,27 @@ export class Entries extends BaseQuery {
     return this;
   }
 
+  /**
+   * @method assetFields
+   * @memberof Entries
+   * @description Include specific asset fields in the response (CDA getEntry/entries).
+   * Use with asset_fields[]: user_defined_fields, embedded, ai_suggested, visual_markups.
+   * @example
+   * import contentstack from '@contentstack/delivery-sdk'
+   *
+   * const stack = contentstack.stack({ apiKey: "apiKey", deliveryToken: "deliveryToken", environment: "environment" });
+   * const result = await stack.contentType("contentTypeUid").entry().assetFields("user_defined_fields", "embedded_metadata").find();
+   *
+   * @param {...string} fields - Asset field names to include (e.g. user_defined_fields, embedded, ai_suggested, visual_markups)
+   * @returns {Entries} - Returns the Entries instance for chaining.
+   */
+  assetFields(...fields: string[]): this {
+    if (fields.length > 0) {
+      this._queryParams['asset_fields[]'] = fields;
+    }
+    return this;
+  }
+
   /**
    * Override find method to include content type UID directly for better caching
    */

src/entries/entries.ts

@@ -273,4 +273,25 @@ export class Entry {
     }
     return this;
   }
+
+  /**
+   * @method assetFields
+   * @memberof Entry
+   * @description Include specific asset fields in the response (CDA getEntry).
+   * Use with asset_fields[]: user_defined_fields, embedded, ai_suggested, visual_markups.
+   * @example
+   * import contentstack from '@contentstack/delivery-sdk'
+   *
+   * const stack = contentstack.stack({ apiKey: "apiKey", deliveryToken: "deliveryToken", environment: "environment" });
+   * const result = await stack.contentType("contentTypeUid").entry("entryUid").assetFields("user_defined_fields", "embedded_metadata").fetch();
+   *
+   * @param {...string} fields - Asset field names to include (e.g. user_defined_fields, embedded, ai_suggested, visual_markups)
+   * @returns {Entry} - Returns the Entry instance for chaining.
+   */
+  assetFields(...fields: string[]): this {
+    if (fields.length > 0) {
+      this._queryParams['asset_fields[]'] = fields;
+    }
+    return this;
+  }
 }

src/entries/entry.ts

@@ -126,6 +126,28 @@ export class AssetQuery extends BaseQuery {
 
     return this;
   }
+
+  /**
+   * @method assetFields
+   * @memberof AssetQuery
+   * @description Include specific asset fields in the response (CDA getAssets).
+   * Use with asset_fields[]: user_defined_fields, embedded, ai_suggested, visual_markups.
+   * @example
+   * import contentstack from '@contentstack/delivery-sdk'
+   *
+   * const stack = contentstack.stack({ apiKey: "apiKey", deliveryToken: "deliveryToken", environment: "environment" });
+   * const result = await stack.asset().assetFields("user_defined_fields", "embedded_metadata").find();
+   *
+   * @param {...string} fields - Asset field names to include (e.g. user_defined_fields, embedded, ai_suggested, visual_markups)
+   * @returns {AssetQuery} - Returns the AssetQuery instance for chaining.
+   */
+  assetFields(...fields: string[]): this {
+    if (fields.length > 0) {
+      this._queryParams['asset_fields[]'] = fields;
+    }
+    return this;
+  }
+
   /**
    * @method query
    * @memberof AssetQuery