asset-query.ts

import { BaseQuery } from './base-query';
import { AxiosInstance } from '@contentstack/core';
import { Query } from './query';

export class AssetQuery extends BaseQuery {
  constructor(client: AxiosInstance) {
    super();
    this._client = client;
    this._urlPath = '/assets';
  }
  /**
   * @method version
   * @memberof AssetQuery
   * @description Retrieve a specific version of an asset in result
   * @returns {AssetQuery}
   * @example
   * import contentstack from '@contentstack/delivery-sdk'
   *
   * const stack = contentstack.stack({ apiKey: "apiKey", deliveryToken: "deliveryToken", environment: "environment" });
   * const result = await stack.asset().version(1).find();
   */
  version(version: number): AssetQuery {
    this._queryParams.version = String(version);

    return this;
  }

  /**
   * @method includeDimension
   * @memberof AssetQuery
   * @description Includes the dimensions (height and width) of the image in result
   * @returns {AssetQuery}
   * @example
   * import contentstack from '@contentstack/delivery-sdk'
   *
   * const stack = contentstack.stack({ apiKey: "apiKey", deliveryToken: "deliveryToken", environment: "environment" });
   * const result = await stack.asset().includeDimension().find();
   */
  includeDimension(): AssetQuery {
    this._queryParams.include_dimension = 'true';

    return this;
  }

  /**
   * @method includeBranch
   * @memberof AssetQuery
   * @description Includes the branch in result
   * @returns {AssetQuery}
   * @example
   * import contentstack from '@contentstack/delivery-sdk'
   *
   * const stack = contentstack.stack({ apiKey: "apiKey", deliveryToken: "deliveryToken", environment: "environment" });
   * const result = await stack.asset().includeBranch().find();
   */
  includeBranch(): AssetQuery {
    this._queryParams.include_branch = 'true';

    return this;
  }

  /**
   * @method includeMetadata
   * @memberof AssetQuery
   * @description Include the metadata for getting metadata content for the asset.
   * @returns {AssetQuery}
   * @example
   * import contentstack from '@contentstack/delivery-sdk'
   *
   * const stack = contentstack.stack({ apiKey: "apiKey", deliveryToken: "deliveryToken", environment: "environment" });
   * const result = await stack.asset().includeMetadata().find();
   */
  includeMetadata(): AssetQuery {
    this._queryParams.include_metadata = 'true';

    return this;
  }

  /**
   * @method relativeUrls
   * @memberof AssetQuery
   * @description Includes the relative URLs of the assets in result
   * @returns {AssetQuery}
   * @example
   * import contentstack from '@contentstack/delivery-sdk'
   *
   * const stack = contentstack.stack({ apiKey: "apiKey", deliveryToken: "deliveryToken", environment: "environment" });
   * const result = await stack.asset().relativeUrls().find();
   */
  relativeUrls(): AssetQuery {
    this._queryParams.relative_url = 'true';

    return this;
  }

  /**
   * @method includeFallback
   * @memberof AssetQuery
   * @description When an entry is not published in a specific language, content can be fetched from its fallback language
   * @returns {AssetQuery}
   * @example
   * import contentstack from '@contentstack/delivery-sdk'
   *
   * const stack = contentstack.stack({ apiKey: "apiKey", deliveryToken: "deliveryToken", environment: "environment" });
   * const result = await stack.asset().includeFallback().find();
   */
  includeFallback(): AssetQuery {
    this._queryParams.include_fallback = 'true';

    return this;
  }

  /**
   * @method locale
   * @memberof AssetQuery
   * @description The assets published in the locale will be fetched
   * @returns {AssetQuery}
   * @example
   * import contentstack from '@contentstack/delivery-sdk'
   *
   * const stack = contentstack.stack({ apiKey: "apiKey", deliveryToken: "deliveryToken", environment: "environment" });
   * const result = await stack.asset().locale('en-us').find();
   */
  locale(locale: string): AssetQuery {
    this._queryParams.locale = locale;

    return this;
  }

  /**
   * @method assetFields
   * @memberof AssetQuery
   * @description Include specific asset fields in the response (CDA getAssets).
   * Use with asset_fields[]: user_defined_fields, embedded_metadata, ai_generated_metadata, 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_metadata, ai_generated_metadata, 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
   * @description Fetches the asset data on the basis of the query
   * @returns {Query}
   * @example
   * import contentstack from '@contentstack/delivery-sdk'
   *
   * const stack = contentstack.stack({ apiKey: "apiKey", deliveryToken: "deliveryToken", environment: "environment" });
   * const result = await stack.asset().query().where('fieldUid', QueryOperation.EQUALS, 'value').find();
   */
  query() {
    return new Query(this._client, this._parameters, this._queryParams);
  }
}