Added assetFields for DAM2.0 support

Author: sunil-lakshman

package-lock.json

@@ -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").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

src/lib/asset-query.ts

@@ -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").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/lib/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").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/lib/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").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/lib/entry.ts

@@ -130,6 +130,20 @@ describe("AssetQuery API tests", () => {
       console.log('No assets found in stack - test data dependent');
     }
   });
+  it("should query assets with asset_fields[] CDA param (user_defined_fields, embedded, ai_suggested, visual_markups)", async () => {
+    const result = await makeAssetQuery()
+      .assetFields("user_defined_fields", "embedded", "ai_suggested", "visual_markups")
+      .limit(2)
+      .find<TAsset>();
+    if (result.assets) {
+      expect(result.assets).toBeDefined();
+      if (result.assets.length > 0) {
+        expect(result.assets[0].uid).toBeDefined();
+        expect(result.assets[0]._version).toBeDefined();
+        expect(result.assets[0].content_type).toBeDefined();
+      }
+    }
+  });
 });
 function makeAssetQuery(): AssetQuery {
   const asset = stack.asset();

test/api/asset-query.spec.ts

@@ -103,6 +103,17 @@ describe('Asset API tests', () => {
     expect(result.created_by).toBeDefined();
     expect(result.updated_by).toBeDefined();
   });
+
+  it('should fetch asset with asset_fields[] CDA param (user_defined_fields, embedded, ai_suggested, visual_markups)', async () => {
+    const result = await makeAsset(assetUid)
+      .assetFields('user_defined_fields', 'embedded', 'ai_suggested', 'visual_markups')
+      .fetch<BaseAsset>();
+    expect(result).toBeDefined();
+    expect(result.uid).toBeDefined();
+    expect(result._version).toBeDefined();
+    expect(result.url).toBeDefined();
+    expect(result.filename).toBeDefined();
+  });
 });
 function makeAsset(uid = ''): Asset {
   const asset = stack.asset(uid);