@contentstack/delivery-sdk 4.11.2 → 5.0.1

package/dist/modern/base-query-B4_k3n_p.d.ts

@@ -1,548 +0,0 @@
-import { AxiosInstance } from '@contentstack/core';
-import { Pagination } from './lib/pagination.js';
-import { params, queryParams, QueryOperation, TaxonomyQueryOperation, QueryOperator, FindResponse } from './lib/types.js';
-
-declare class Query extends BaseQuery {
-    private _contentTypeUid?;
-    constructor(client: AxiosInstance, params: params, queryParams: queryParams, variants?: string, uid?: string, queryObj?: {
-        [key: string]: any;
-    });
-    private isValidAlphanumeric;
-    private isValidRegexPattern;
-    private isValidValue;
-    /**
-     * @method where
-     * @memberof Query
-     * @description Filters the results based on the specified criteria.
-     * @example
-     * import contentstack from '@contentstack/delivery-sdk'
-     *
-     * const stack = contentstack.stack({ apiKey: "apiKey", deliveryToken: "deliveryToken", environment: "environment" });
-     * const query = stack.contentType("contentTypeUid").entry().query();
-     * const result = await query.where("field_UID", QueryOperation.IS_LESS_THAN, ["field1", "field2"]).find()
-     * // OR
-     * const asset = await stack.asset().query().where("field_UID", QueryOperation.IS_LESS_THAN, ["field1", "field2"]).find()
-     * @example
-     * import contentstack from '@contentstack/delivery-sdk'
-     *
-     * const stack = contentstack.stack({ apiKey: "apiKey", deliveryToken: "deliveryToken", environment: "environment" });
-     * const query = stack.contentType("contentTypeUid").entry().query();
-     * const result = await query.where("field_UID", QueryOperation.MATCHES, ["field1", "field2"]).find()
-     * @returns {Query}
-     */
-    where(fieldUid: string, queryOperation: QueryOperation | TaxonomyQueryOperation, fields: string | string[] | number | number[] | object | boolean, additionalData?: object): Query;
-    /**
-     * @method regex
-     * @memberof Query
-     * @description Retrieve entries that match the provided regular expressions
-     * @example
-     * import contentstack from '@contentstack/delivery-sdk'
-     *
-     * const stack = contentstack.stack({ apiKey: "apiKey", deliveryToken: "deliveryToken", environment: "environment" });
-     * const query = stack.contentType("contentTypeUid").entry().query();
-     * const result = await query.regex('title','^Demo').find()
-     * // OR
-     * const result = await query.regex('title','^Demo', 'i').find() // regex with options
-     * @returns {Query}
-     */
-    regex(fieldUid: string, regexPattern: string, options?: string): Query;
-    /**
-     * @method whereIn
-     * @memberof Query
-     * @description Get entries having values based on referenced fields.
-     * The query retrieves all entries that satisfy the query conditions made on referenced fields
-     * This method sets the '$in_query' parameter to a reference field UID and a query instance in the API request.
-     * @example
-     * import contentstack from '@contentstack/delivery-sdk'
-     *
-     * const stack = contentstack.stack({ apiKey: "apiKey", deliveryToken: "deliveryToken", environment: "environment" });
-     * const query = stack.contentType("contentTypeUid").entry().query();
-     * const subQuery = stack.contentType("referencedContentTypeUid").entry().query().where("title", QueryOperation.EQUALS, "value");
-     * query.whereIn("brand", subQuery)
-     * const result = await query.find()
-     *
-     * @param {string} referenceUid - UID of the reference field to query.
-     * @param {Query} queryInstance - The Query instance to include in the where clause.
-     * @returns {Query} - Returns the Query instance for chaining.
-     */
-    whereIn(referenceUid: string, queryInstance: Query): Query;
-    /**
-     * @method whereNotIn
-     * @memberof Query
-     * @description Get entries having values based on referenced fields.
-     * This query works the opposite of $in_query and retrieves all entries that does not satisfy query conditions made on referenced fields.
-     * This method sets the '$nin_query' parameter to a reference field UID and a query instance in the API request.
-     * @example
-     * import contentstack from '@contentstack/delivery-sdk'
-     *
-     * const stack = contentstack.stack({ apiKey: "apiKey", deliveryToken: "deliveryToken", environment: "environment" });
-     * const query = stack.contentType("contentTypeUid").entry().query();
-     * const subQuery = stack.contentType("referencedContentTypeUid").entry().query().where("title", QueryOperation.EQUALS, "value");
-     * query.whereNotIn("brand", subQuery)
-     * const result = await query.find()
-     *
-     * @param {string} referenceUid - UID of the reference field to query.
-     * @param {Query} queryInstance - The Query instance to include in the where clause.
-     * @returns {Query} - Returns the Query instance for chaining.
-     */
-    whereNotIn(referenceUid: string, queryInstance: Query): Query;
-    /**
-     * @method queryOperator
-     * @memberof Query
-     * @description In case of '$and' get entries that satisfy all the conditions provided in the '$and' query and
-     * in case of '$or' query get all entries that satisfy at least one of the given conditions provided in the '$or' query.
-     * @example
-     * import contentstack from '@contentstack/delivery-sdk'
-     *
-     * const stack = contentstack.stack({ apiKey: "apiKey", deliveryToken: "deliveryToken", environment: "environment" });
-     * const query = stack.contentType("contentType1Uid").entry().query();
-     * const subQuery1 = stack.contentType("contentType2Uid").entry().query().where("price", QueryOperation.IS_LESS_THAN, 90);
-     * const subQuery2 = stack.contentType("contentType3Uid").entry().query().where("discount", QueryOperation.INCLUDES, [20, 45]);
-     * query.queryOperator(QueryOperator.AND, subQuery1, subQuery2)
-     * const result = await query.find()
-     *
-     * @param {QueryOperator} queryType - The type of query operator to apply.
-     * @param {...Query[]} queryObjects - The Query instances to apply the query to.
-     * @returns {Query} - Returns the Query instance for chaining.
-     */
-    queryOperator(queryType: QueryOperator, ...queryObjects: Query[]): Query;
-    /**
-     * @method getQuery
-     * @memberof Query
-     * @description Returns the raw (JSON) query based on the filters applied on Query object.
-     * @example
-     * import contentstack from '@contentstack/delivery-sdk'
-     *
-     * const stack = contentstack.stack({ apiKey: "apiKey", deliveryToken: "deliveryToken", environment: "environment" });
-     * const query = stack.contentType("contentTypeUid").entry().query();
-     * const result = query.getQuery()
-     * // OR
-     * const assetQuery = stack.asset().query();
-     * const assetResult = assetQuery.getQuery()
-     *
-     * @returns {{ [key: string]: any }} The raw query object
-     */
-    getQuery(): {
-        [key: string]: any;
-    };
-    /**
-     * @method containedIn
-     * @memberof Query
-     * @description Filters entries where the field value is contained in the provided array of values
-     * @param {string} key - The field UID to filter on
-     * @param {(string | number | boolean)[]} value - Array of values to match against
-     * @example
-     * import contentstack from '@contentstack/delivery-sdk'
-     *
-     * const stack = contentstack.stack({ apiKey: "apiKey", deliveryToken: "deliveryToken", environment: "environment" });
-     * const query = stack.contentType("contentTypeUid").entry().query();
-     * const result = await query.containedIn('fieldUid', ['value1', 'value2']).find()
-     *
-     * @returns {Query}
-     */
-    containedIn(key: string, value: (string | number | boolean)[]): Query;
-    /**
-     * @method notContainedIn
-     * @memberof Query
-     * @description Filters entries where the field value is not contained in the provided array of values
-     * @param {string} key - The field UID to filter on
-     * @param {(string | number | boolean)[]} value - Array of values to exclude
-     * @example
-     * import contentstack from '@contentstack/delivery-sdk'
-     *
-     * const stack = contentstack.stack({ apiKey: "apiKey", deliveryToken: "deliveryToken", environment: "environment" });
-     * const query = stack.contentType("contentTypeUid").entry().query();
-     * const result = await query.notContainedIn('fieldUid', ['value1', 'value2']).find()
-     *
-     * @returns {Query}
-     */
-    notContainedIn(key: string, value: (string | number | boolean)[]): Query;
-    /**
-     * @method exists
-     * @memberof Query
-     * @description Filters entries where the specified field exists
-     * @param {string} key - The field UID to check for existence
-     * @example
-     * import contentstack from '@contentstack/delivery-sdk'
-     *
-     * const stack = contentstack.stack({ apiKey: "apiKey", deliveryToken: "deliveryToken", environment: "environment" });
-     * const query = stack.contentType("contentTypeUid").entry().query();
-     * const result = await query.exists('fieldUid').find()
-     *
-     * @returns {Query}
-     */
-    exists(key: string): Query;
-    /**
-     * @method notExists
-     * @memberof Query
-     * @description Filters entries where the specified field does not exist
-     * @param {string} key - The field UID to check for non-existence
-     * @example
-     * import contentstack from '@contentstack/delivery-sdk'
-     *
-     * const stack = contentstack.stack({ apiKey: "apiKey", deliveryToken: "deliveryToken", environment: "environment" });
-     * const query = stack.contentType("contentTypeUid").entry().query();
-     * const result = await query.notExists('fieldUid').find()
-     *
-     * @returns {Query}
-     */
-    notExists(key: string): Query;
-    /**
-     * @method or
-     * @memberof Query
-     * @description Combines multiple queries with OR logic - returns entries that match at least one of the provided queries
-     * @param {...Query} queries - Query instances to combine with OR logic
-     * @example
-     * import contentstack from '@contentstack/delivery-sdk'
-     *
-     * const stack = contentstack.stack({ apiKey: "apiKey", deliveryToken: "deliveryToken", environment: "environment" });
-     * const query1 = stack.contentType('contenttype_uid').entry().query().containedIn('fieldUID', ['value']);
-     * const query2 = stack.contentType('contenttype_uid').entry().query().where('fieldUID', QueryOperation.EQUALS, 'value2');
-     * const result = await stack.contentType('contenttype_uid').entry().query().or(query1, query2).find();
-     *
-     * @returns {Query}
-     */
-    or(...queries: Query[]): Query;
-    /**
-     * @method and
-     * @memberof Query
-     * @description Combines multiple queries with AND logic - returns entries that match all of the provided queries
-     * @param {...Query} queries - Query instances to combine with AND logic
-     * @example
-     * import contentstack from '@contentstack/delivery-sdk'
-     *
-     * const stack = contentstack.stack({ apiKey: "apiKey", deliveryToken: "deliveryToken", environment: "environment" });
-     * const query1 = stack.contentType('contenttype_uid').entry().query().containedIn('fieldUID', ['value']);
-     * const query2 = stack.contentType('contenttype_uid').entry().query().where('fieldUID', QueryOperation.EQUALS, 'value2');
-     * const result = await stack.contentType('contenttype_uid').entry().query().and(query1, query2).find();
-     *
-     * @returns {Query}
-     */
-    and(...queries: Query[]): Query;
-    /**
-     * @method equalTo
-     * @memberof Query
-     * @description Filters entries where the field value equals the specified value
-     * @param {string} key - The field UID to filter on
-     * @param {string | number | boolean} value - The value to match
-     * @example
-     * import contentstack from '@contentstack/delivery-sdk'
-     *
-     * const stack = contentstack.stack({ apiKey: "apiKey", deliveryToken: "deliveryToken", environment: "environment" });
-     * const result = await stack.contentType('contenttype_uid').entry().query().equalTo('fieldUid', 'value').find();
-     *
-     * @returns {Query}
-     */
-    equalTo(key: string, value: string | number | boolean): Query;
-    /**
-     * @method notEqualTo
-     * @memberof Query
-     * @description Filters entries where the field value does not equal the specified value
-     * @param {string} key - The field UID to filter on
-     * @param {string | number | boolean} value - The value to exclude
-     * @example
-     * import contentstack from '@contentstack/delivery-sdk'
-     *
-     * const stack = contentstack.stack({ apiKey: "apiKey", deliveryToken: "deliveryToken", environment: "environment" });
-     * const result = await stack.contentType('contenttype_uid').entry().query().notEqualTo('fieldUid', 'value').find();
-     *
-     * @returns {Query}
-     */
-    notEqualTo(key: string, value: string | number | boolean): Query;
-    /**
-     * @method referenceIn
-     * @memberof Query
-     * @description Filters entries where the reference field matches entries from the provided query
-     * @param {string} key - The reference field UID to filter on
-     * @param {Query} query - Query instance to match referenced entries against
-     * @example
-     * import contentstack from '@contentstack/delivery-sdk'
-     *
-     * const stack = contentstack.stack({ apiKey: "apiKey", deliveryToken: "deliveryToken", environment: "environment" });
-     * const subQuery = stack.contentType('contenttype_uid').entry().query().where('title', QueryOperation.EQUALS, 'value');
-     * const result = await stack.contentType('contenttype_uid').entry().query().referenceIn('reference_uid', subQuery).find();
-     *
-     * @returns {Query}
-     */
-    referenceIn(key: string, query: Query): Query;
-    /**
-     * @method referenceNotIn
-     * @memberof Query
-     * @description Filters entries where the reference field does not match entries from the provided query
-     * @param {string} key - The reference field UID to filter on
-     * @param {Query} query - Query instance to exclude referenced entries against
-     * @example
-     * import contentstack from '@contentstack/delivery-sdk'
-     *
-     * const stack = contentstack.stack({ apiKey: "apiKey", deliveryToken: "deliveryToken", environment: "environment" });
-     * const subQuery = stack.contentType('contenttype_uid').entry().query().where('title', QueryOperation.EQUALS, 'value');
-     * const result = await stack.contentType('contenttype_uid').entry().query().referenceNotIn('reference_uid', subQuery).find();
-     *
-     * @returns {Query}
-     */
-    referenceNotIn(key: string, query: Query): Query;
-    /**
-     * @method tags
-     * @memberof Query
-     * @description Filters entries that have any of the specified tags
-     * @param {(string | number | boolean)[]} values - Array of tag values to filter by
-     * @example
-     * import contentstack from '@contentstack/delivery-sdk'
-     *
-     * const stack = contentstack.stack({ apiKey: "apiKey", deliveryToken: "deliveryToken", environment: "environment" });
-     * const result = await stack.contentType('contenttype_uid').entry().query().tags(['tag1']).find();
-     *
-     * @returns {Query}
-     */
-    tags(values: (string | number | boolean)[]): Query;
-    /**
-     * @method search
-     * @memberof Query
-     * @description Enables typeahead search functionality for the query
-     * @param {string} key - The search term to use for typeahead search
-     * @example
-     * import contentstack from '@contentstack/delivery-sdk'
-     *
-     * const stack = contentstack.stack({ apiKey: "apiKey", deliveryToken: "deliveryToken", environment: "environment" });
-     * const result = await stack.contentType('contenttype_uid').entry().query().search('key').find();
-     *
-     * @returns {Query}
-     */
-    search(key: string): Query;
-    /**
-     * @method lessThan
-     * @memberof Query
-     * @description Filters entries where the field value is less than the specified value
-     * @param {string} key - The field UID to filter on
-     * @param {string | number} value - The value to compare against
-     * @example
-     * import contentstack from '@contentstack/delivery-sdk'
-     *
-     * const stack = contentstack.stack({ apiKey: "apiKey", deliveryToken: "deliveryToken", environment: "environment" });
-     * const result = await stack.contentType('contenttype_uid').entry().query().lessThan('fieldUid', 100).find();
-     *
-     * @returns {Query}
-     */
-    lessThan(key: string, value: (string | number)): Query;
-    /**
-     * @method lessThanOrEqualTo
-     * @memberof Query
-     * @description Filters entries where the field value is less than or equal to the specified value
-     * @param {string} key - The field UID to filter on
-     * @param {string | number} value - The value to compare against
-     * @example
-     * import contentstack from '@contentstack/delivery-sdk'
-     *
-     * const stack = contentstack.stack({ apiKey: "apiKey", deliveryToken: "deliveryToken", environment: "environment" });
-     * const result = await stack.contentType('contenttype_uid').entry().query().lessThanOrEqualTo('fieldUid', 100).find();
-     *
-     * @returns {Query}
-     */
-    lessThanOrEqualTo(key: string, value: (string | number)): Query;
-    /**
-     * @method greaterThan
-     * @memberof Query
-     * @description Filters entries where the field value is greater than the specified value
-     * @param {string} key - The field UID to filter on
-     * @param {string | number} value - The value to compare against
-     * @example
-     * import contentstack from '@contentstack/delivery-sdk'
-     *
-     * const stack = contentstack.stack({ apiKey: "apiKey", deliveryToken: "deliveryToken", environment: "environment" });
-     * const result = await stack.contentType('contenttype_uid').entry().query().greaterThan('fieldUid', 100).find();
-     *
-     * @returns {Query}
-     */
-    greaterThan(key: string, value: (string | number)): Query;
-    /**
-     * @method greaterThanOrEqualTo
-     * @memberof Query
-     * @description Filters entries where the field value is greater than or equal to the specified value
-     * @param {string} key - The field UID to filter on
-     * @param {string | number} value - The value to compare against
-     * @example
-     * import contentstack from '@contentstack/delivery-sdk'
-     *
-     * const stack = contentstack.stack({ apiKey: "apiKey", deliveryToken: "deliveryToken", environment: "environment" });
-     * const result = await stack.contentType('contenttype_uid').entry().query().greaterThanOrEqualTo('fieldUid', 100).find();
-     *
-     * @returns {Query}
-     */
-    greaterThanOrEqualTo(key: string, value: (string | number)): Query;
-    /**
-     * Override find method to include content type UID directly for better caching
-     */
-    find<T>(encode?: boolean): Promise<FindResponse<T>>;
-}
-
-declare class BaseQuery extends Pagination {
-    _parameters: params;
-    protected _client: AxiosInstance;
-    protected _urlPath: string;
-    protected _variants: string;
-    /**
-     * Helper method to cast this instance to Query type
-     * @private
-     */
-    protected asQuery(): Query;
-    /**
-     * @method includeCount
-     * @memberof BaseQuery
-     * @description Retrieve count and data of objects in result
-     * @example
-     * import contentstack from '@contentstack/delivery-sdk'
-     *
-     * const stack = contentstack.stack({ apiKey: "apiKey", deliveryToken: "deliveryToken", environment: "environment" });
-     * const query = stack.contentType("contentTypeUid").entry().query();
-     * const result = await query.includeCount().find()
-     * // OR
-     * const asset = await stack.asset().includeCount().find()
-     *
-     * @returns {Query}
-     */
-    includeCount(): Query;
-    /**
-     * @method orderByAscending
-     * @memberof BaseQuery
-     * @description Sorts the results in ascending order based on the specified field UID.
-     * @example
-     * import contentstack from '@contentstack/delivery-sdk'
-     *
-     * const stack = contentstack.stack({ apiKey: "apiKey", deliveryToken: "deliveryToken", environment: "environment" });
-     * const query = stack.contentType("contentTypeUid").entry().query();
-     * const result = await query.orderByAscending("field_uid").find()
-     * // OR
-     * const asset = await stack.asset().orderByAscending("field_uid").find()
-     *
-     * @returns {Query}
-     */
-    orderByAscending(key: string): Query;
-    /**
-     * @method orderByDescending
-     * @memberof BaseQuery
-     * @description Sorts the results in descending order based on the specified key.
-     * @example
-     * import contentstack from '@contentstack/delivery-sdk'
-     *
-     * const stack = contentstack.stack({ apiKey: "apiKey", deliveryToken: "deliveryToken", environment: "environment" });
-     * const query = stack.contentType("contentTypeUid").entry().query();
-     * const result = await query.orderByDescending("field_uid").find()
-     * // OR
-     * const asset = await stack.asset().orderByDescending("field_uid").find()
-     *
-     * @returns {Query}
-     */
-    orderByDescending(key: string): Query;
-    /**
-     * @method limit
-     * @memberof BaseQuery
-     * @description Returns a specific number of entries based on the set limit
-     * @example
-     * import contentstack from '@contentstack/delivery-sdk'
-     *
-     * const stack = contentstack.stack({ apiKey: "apiKey", deliveryToken: "deliveryToken", environment: "environment" });
-     * const query = stack.contentType("contentTypeUid").entry().query();
-     * const result = await query.limit(10).find()
-     * // OR
-     * const asset = await stack.asset().limit(5).find()
-     *
-     * @returns {Query}
-     */
-    limit(key: number): Query;
-    /**
-     * @method skip
-     * @memberof BaseQuery
-     * @description Skips at specific number of entries.
-     * @example
-     * import contentstack from '@contentstack/delivery-sdk'
-     *
-     * const stack = contentstack.stack({ apiKey: "apiKey", deliveryToken: "deliveryToken", environment: "environment" });
-     * const query = stack.contentType("contentTypeUid").entry().query();
-     * const result = await query.skip(10).find()
-     * // OR
-     * const asset = await stack.asset().skip(5).find()
-     *
-     * @returns {Query}
-     */
-    skip(key: number): Query;
-    /**
-     * @method param
-     * @memberof BaseQuery
-     * @description Adds query parameters to the URL.
-     * @example
-     * import contentstack from '@contentstack/delivery-sdk'
-     *
-     * const stack = contentstack.stack({ apiKey: "apiKey", deliveryToken: "deliveryToken", environment: "environment" });
-     * const query = stack.contentType("contentTypeUid").entry().query();
-     * const result = await query.param("key", "value").find()
-     * // OR
-     * const asset = await stack.asset().param("key", "value").find()
-     *
-     * @returns {Query}
-     */
-    param(key: string, value: string | number): Query;
-    /**
-     * @method addParams
-     * @memberof BaseQuery
-     * @description Adds a query parameter to the query.
-     * @example
-     * import contentstack from '@contentstack/delivery-sdk'
-     *
-     * const stack = contentstack.stack({ apiKey: "apiKey", deliveryToken: "deliveryToken", environment: "environment" });
-     * const query = stack.contentType("contentTypeUid").entry().query();
-     * const result = await query.addParams({"key": "value"}).find()
-     * // OR
-     * const asset = await stack.asset().addParams({"key": "value"}).find()
-     *
-     * @returns {Query}
-     */
-    addParams(paramObj: {
-        [key: string]: string | boolean | number;
-    }): Query;
-    /**
-     * @method removeParam
-     * @memberof BaseQuery
-     * @description Removes a query parameter from the query.
-     * @example
-     * import contentstack from '@contentstack/delivery-sdk'
-     *
-     * const stack = contentstack.stack({ apiKey: "apiKey", deliveryToken: "deliveryToken", environment: "environment" });
-     * const query = stack.contentType("contentTypeUid").entry().query();
-     * const result = await query.removeParam("query_param_key").find()
-     * // OR
-     * const asset = await stack.asset().removeParam("query_param_key").find()
-     *
-     * @returns {Query}
-     */
-    removeParam(key: string): Query;
-    /**
-     * @method find
-     * @memberof BaseQuery
-     * @description Fetches the data based on the query parameters
-     * @param {boolean} encode - Whether to encode query parameters
-     * @returns {Promise<FindResponse<T>>} Promise that resolves to the find response
-     * @example
-     * import contentstack from '@contentstack/delivery-sdk'
-     *
-     * const stack = contentstack.stack({ apiKey: "apiKey", deliveryToken: "deliveryToken", environment: "environment" });
-     * const result = await stack.asset().find();
-     * @example
-     * import contentstack from '@contentstack/delivery-sdk'
-     *
-     * const stack = contentstack.stack({ apiKey: "apiKey", deliveryToken: "deliveryToken", environment: "environment" });
-     * const result = await stack.contentType("contentType1Uid").entry().query().find();
-     * @example
-     * import contentstack from '@contentstack/delivery-sdk'
-     *
-     * const stack = contentstack.stack({ apiKey: "apiKey", deliveryToken: "deliveryToken", environment: "environment" });
-     * const result = await stack.contentType("contentTypeUid").entry().query().find();
-     */
-    find<T>(encode?: boolean): Promise<FindResponse<T>>;
-    /**
-     * Extracts content type UID from the URL path
-     * @returns content type UID if found, null otherwise
-     */
-    private extractContentTypeUidFromUrl;
-}
-
-export { BaseQuery as B, Query as Q };