@wix/wix-data-items-common 1.0.52

package/dist/types/api/WixDataApi.d.ts

@@ -0,0 +1,52 @@
+import { HttpApiClientFactory } from '../types/api';
+import * as apiTypes from '../types/data-item-types';
+import { Provider, WixDataBulkResult, WixDataItem, WixDataItemOrId, WixDataOptions, WixDataQueryReferencedOptions, WixDataReadOptions, WixDataReadWithProjectionOptions, WixDataReference, WixDataUpdateOptions } from './types';
+import { WixDataQuery } from './WixDataQuery';
+import { WixDataResultImpl } from './impl/WixDataResultImpl';
+import { WixDataPatch, WixDataBulkPatch } from './WixDataPatch';
+import { WixDataAggregate } from './WixDataAggregate';
+import { WixDataFilter } from './WixDataFilter';
+import { WixDataResult } from './WixDataResult';
+type ProvidedOpt<T> = T | undefined | Provider<T | undefined>;
+type TraceWith = (label: string, opts?: object) => <T>(fn: () => Promise<T>) => Promise<T>;
+export declare class WixDataApi {
+    private readonly environment?;
+    private readonly gridAppId?;
+    private readonly tracer?;
+    private client;
+    constructor(clientFactory: HttpApiClientFactory<any>, allowGet: boolean, environment?: apiTypes.Environment | undefined, gridAppId?: ProvidedOpt<string>, tracer?: TraceWith | undefined);
+    get wixData(): WixDataApi;
+    get filter(): WixDataFilter;
+    truncate: (collectionName: string, options?: WixDataOptions | undefined) => Promise<void>;
+    get: (collectionName: string, itemId: string, options?: WixDataReadWithProjectionOptions | undefined) => Promise<WixDataItem | null>;
+    insert: (collectionName: string, item: Partial<WixDataItem>, options?: WixDataUpdateOptions | undefined) => Promise<WixDataItem>;
+    save: (collectionName: string, item: Partial<WixDataItem>, options?: WixDataUpdateOptions | undefined) => Promise<WixDataItem>;
+    update: (collectionName: string, item: WixDataItem, options?: WixDataUpdateOptions | undefined) => Promise<WixDataItem>;
+    remove: (collectionName: string, itemId: string, options?: WixDataOptions | undefined) => Promise<WixDataItem | null>;
+    private toFieldUpdateApi;
+    patch: (collectionName: string, itemId: string) => WixDataPatch;
+    bulkPatch: (collectionName: string, itemIds: string[]) => WixDataBulkPatch;
+    query: (collectionName: string) => WixDataQuery;
+    fetch: (collectionName: string, cursor: string, limit?: number | undefined, options?: WixDataReadOptions | undefined) => Promise<WixDataResult<WixDataItem>>;
+    aggregate: (collectionName: string) => WixDataAggregate;
+    fetchAggregate: (collectionName: string, cursor: string, limit?: number | undefined, options?: WixDataReadOptions | undefined) => Promise<WixDataResultImpl<Record<string, any>>>;
+    bulkRemove: (collectionName: string, itemIds: string[], options?: WixDataOptions | undefined) => Promise<WixDataBulkResult>;
+    private runBulkSave;
+    bulkInsert: (collectionName: string, items: Partial<WixDataItem>[], options?: (WixDataOptions & {
+        overrideExisting?: boolean | undefined;
+    }) | undefined) => Promise<WixDataBulkResult>;
+    bulkSave: (collectionName: string, items: Partial<WixDataItem>[], options?: WixDataOptions | undefined) => Promise<WixDataBulkResult>;
+    bulkUpdate: (collectionName: string, items: WixDataItem[], options?: WixDataOptions | undefined) => Promise<WixDataBulkResult>;
+    fetchReferenced: (collectionName: string, cursor: string, limit?: number | undefined, options?: WixDataReadWithProjectionOptions | undefined) => Promise<WixDataResult<string | WixDataItem>>;
+    queryReferenced: (collectionName: string, holdingItem: WixDataItemOrId, relationshipAttribute: string, options?: WixDataQueryReferencedOptions | undefined) => Promise<WixDataResult<WixDataItem>>;
+    insertReference: {
+        (collectionName: string, refs: WixDataReference[], options?: WixDataOptions): Promise<void>;
+        (collectionName: string, relationshipAttribute: string, left: WixDataItemOrId, right: WixDataItemOrId | WixDataItemOrId[], options?: WixDataOptions): Promise<void>;
+    };
+    replaceReferences: (collectionName: string, relationshipAttribute: string, left: WixDataItemOrId, right: WixDataItemOrId | WixDataItemOrId[], options?: WixDataOptions | undefined) => Promise<void>;
+    removeReference: (collectionName: string, relationshipAttribute: string, left: WixDataItemOrId, right: WixDataItemOrId | WixDataItemOrId[], options?: WixDataOptions | undefined) => Promise<void>;
+    isReferenced: (collectionName: string, relationshipAttribute: string, left: WixDataItemOrId, right: WixDataItemOrId, options?: WixDataReadOptions | undefined) => Promise<boolean>;
+    private trace;
+}
+export {};
+//# sourceMappingURL=WixDataApi.d.ts.map

package/dist/types/api/WixDataApi.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"WixDataApi.d.ts","sourceRoot":"","sources":["../../../src/api/WixDataApi.ts"],"names":[],"mappings":"AAOA,OAAO,EAAE,oBAAoB,EAAE,MAAM,cAAc,CAAA;AACnD,OAAO,KAAK,QAAQ,MAAM,0BAA0B,CAAA;AAIpD,OAAO,EACL,QAAQ,EACR,iBAAiB,EACjB,WAAW,EACX,eAAe,EACf,cAAc,EACd,6BAA6B,EAC7B,kBAAkB,EAClB,gCAAgC,EAChC,gBAAgB,EAChB,oBAAoB,EACrB,MAAM,SAAS,CAAA;AAEhB,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAA;AAC7C,OAAO,EAAE,iBAAiB,EAAe,MAAM,0BAA0B,CAAA;AAIzE,OAAO,EAAE,YAAY,EAAe,gBAAgB,EAAE,MAAM,gBAAgB,CAAA;AAC5E,OAAO,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAA;AACrD,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAA;AAC/C,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAA;AAE/C,KAAK,WAAW,CAAC,CAAC,IAAI,CAAC,GAAG,SAAS,GAAG,QAAQ,CAAC,CAAC,GAAG,SAAS,CAAC,CAAA;AAC7D,KAAK,SAAS,GAAG,CACf,KAAK,EAAE,MAAM,EACb,IAAI,CAAC,EAAE,MAAM,KACV,CAAC,CAAC,EAAE,EAAE,EAAE,MAAM,OAAO,CAAC,CAAC,CAAC,KAAK,OAAO,CAAC,CAAC,CAAC,CAAA;AAE5C,qBAAa,UAAU;IAMnB,OAAO,CAAC,QAAQ,CAAC,WAAW,CAAC;IAC7B,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAC;IAC3B,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAC;IAP1B,OAAO,CAAC,MAAM,CAAW;gBAGvB,aAAa,EAAE,oBAAoB,CAAC,GAAG,CAAC,EACxC,QAAQ,EAAE,OAAO,EACA,WAAW,CAAC,kCAAsB,EAClC,SAAS,CAAC,qBAAqB,EAC/B,MAAM,CAAC,uBAAW;IAKrC,IAAI,OAAO,IAAI,UAAU,CAExB;IAED,IAAI,MAAM,IAAI,aAAa,CAE1B;IAID,QAAQ,kFAoBP;IAID,GAAG,kIA8BF;IAED,MAAM,2HA+BL;IAED,IAAI,2HA4BH;IAED,MAAM,kHA4BL;IAED,MAAM,gHA4BL;IAED,OAAO,CAAC,gBAAgB,CA0CvB;IAED,KAAK,mBAAoB,MAAM,UAAU,MAAM,KAAG,YAAY,CAsB7D;IAED,SAAS,mBAAoB,MAAM,WAAW,MAAM,EAAE,KAAG,gBAAgB,CAsBxE;IAID,KAAK,mBAAoB,MAAM,KAAG,YAAY,CAiH7C;IAID,KAAK,wJAmCJ;IAID,SAAS,mBAAoB,MAAM,KAAG,gBAAgB,CAgErD;IAED,cAAc,oKAkCb;IAID,UAAU,kHAyBT;YAEa,WAAW;IAuBzB,UAAU;;kDAyBT;IAED,QAAQ,8HAkBP;IAED,UAAU,qHA4BT;IAID,eAAe,+KAkCd;IAED,eAAe,oLA0Dd;IAED,eAAe,EAAE;QAEf,CACE,cAAc,EAAE,MAAM,EACtB,IAAI,EAAE,gBAAgB,EAAE,EACxB,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,IAAI,CAAC,CAAA;QAEhB,CACE,cAAc,EAAE,MAAM,EACtB,qBAAqB,EAAE,MAAM,EAC7B,IAAI,EAAE,eAAe,EACrB,KAAK,EAAE,eAAe,GAAG,eAAe,EAAE,EAC1C,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,IAAI,CAAC,CAAA;KACjB,CA+CA;IAED,iBAAiB,oLAiChB;IAED,eAAe,oLAmCd;IAED,YAAY,uKAiCX;IAED,OAAO,CAAC,KAAK;CAsBd"}

package/dist/types/api/WixDataFilter.d.ts

@@ -0,0 +1,424 @@
+type Comparable = string | number | Date;
+/**
+ * @builder
+ */
+export interface WixDataFilter {
+    /**
+     * Refines a filter to match items whose specified property value equals the specified value.
+     *
+     * The `eq()` function refines this filter to only
+     * match items where the value of the specified property equals the specified `value`.
+     *
+     * It only matches values of the same type. For example, a number value stored
+     * as a String type does not match the same number stored as a Number type.
+     *
+     * Matching strings with `eq()` is case sensitive, so `"text"` is not equal to `"Text"`.
+     *
+     * If `field` points to a collection field of type Array, `eq()` includes the item
+     * as long as at least one Array element matches the specified `value`.
+     * @public
+     * @documentationMaturity preview
+     * @param field - The property whose value will be compared with `value`.
+     * @requiredField field
+     * @param value - The value to match against.
+     * @requiredField value
+     * @returns An object representing the refined filter.
+     */
+    eq(field: string, value: any): WixDataFilter;
+    /**
+     * Refines a filter to match items whose specified property value does not equal the specified value.
+     *
+     * The `ne()` function refines this filter to only
+     * match items where the value of the specified property does not equal the specified `value`.
+     *
+     * It only matches values of the same type. For example, a number value stored
+     * as a String type is considered not equal to the same number stored as a Number type.
+     *
+     * Matching strings with `ne()` is case sensitive, so `"text"` is not equal to `"Text"`.
+     *
+     * If the value of the `field` property is an Array, `ne()` includes items
+     * in which none of the elements of the Array match the specified `value`.
+     * @public
+     * @documentationMaturity preview
+     * @param field - The property whose value will be compared with `value`.
+     * @requiredField field
+     * @param value - The value to match against.
+     * @requiredField value
+     * @returns An object representing the refined filter.
+     */
+    ne(field: string, value: any): WixDataFilter;
+    /**
+     * Refines a filter to match items whose specified property value is greater than or equal to the specified
+     * value.
+     *
+     * The `ge()` function refines this filter to only
+     * match items where the value of the specified property is greater than or
+     * equal to the specified `value`.
+     *
+     * It only matches values of the same type. For example, a number value stored
+     * as a String type does not match the same number stored as a Number type.
+     *
+     * If a property contains a number as a String, that value will be compared
+     * alphabetically and not numerically. Items that do not have a value for the
+     * specified property are ranked lowest.
+     *
+     * The following types of properties can be compared:
+     * - Number: Compares numerically.
+     * - Date: Compares JavaScript Date objects.
+     * - String: Compares lexicographically,
+     *   so `"abc"` is greater than or equal to `"ABC"` (because of the greater than),
+     *   but `"ABC"` is not greater than or equal to `"abc"`.
+     * - Reference: Compares by the ID of the referenced item as a String.
+     * @public
+     * @documentationMaturity preview
+     * @param field - The property whose value will be compared with `value`.
+     * @requiredField field
+     * @param value - The value to match against.
+     * @requiredField value
+     * @returns An object representing the refined filter.
+     */
+    ge(field: string, value: Comparable): WixDataFilter;
+    /**
+     * Refines a filter to match items whose specified property value is greater than the specified value.
+     *
+     * The `gt()` function refines this filter to only match
+     * items where the value of the specified property is greater than the specified `value`.
+     *
+     * It only matches values of the same type. For example, a number value stored
+     * as a String type does not match the same number stored as a Number type.
+     *
+     * If a property contains a number as a String, that value will be compared
+     * alphabetically and not numerically. Items that do not have a value for the
+     * specified property are ranked lowest.
+     *
+     * The following types of properties can be compared:
+     * - Number: Compares numerically.
+     * - Date: Compares JavaScript Date objects.
+     * - String: Compares lexicographically, so `"text"` is greater than `"Text"`.
+     * - Reference: Compares by the ID of the referenced item as a String.
+     * @public
+     * @documentationMaturity preview
+     * @param field - The property whose value will be compared with `value`.
+     * @requiredField field
+     * @param value - The value to match against.
+     * @requiredField value
+     * @returns An object with the filter definition, based on the supplied parameters.
+     */
+    gt(field: string, value: Comparable): WixDataFilter;
+    /**
+     * Refines a filter to match items whose specified property value is less than or equal to the specified
+     * value.
+     *
+     * The `le()` function refines this filter to only match
+     * items where the value of the specified property is less than or equal to the
+     * specified `value`.
+     *
+     * It only matches values of the same type. For example, a number value stored
+     * as a String type does not match the same number stored as a Number type.
+     *
+     * If a property contains a number as a String, that value will be compared
+     * alphabetically and not numerically. Items that do not have a value for the
+     * specified property are ranked lowest.
+     *
+     * The following types of properties can be compared:
+     * - Number: Compares numerically.
+     * - Date: Compares JavaScript Date objects.
+     * - String: Compares lexicographically,
+     *   so `"ABC"` is less than or equal to `"abc"` (because of the less than),
+     *   but `"abc"` is not less than or equal to `"ABC"`.
+     * - Reference: Compares by the ID of the referenced item as a String.
+     * @public
+     * @documentationMaturity preview
+     * @param field - The property whose value will be compared with `value`.
+     * @requiredField field
+     * @param value - The value to match against.
+     * @requiredField value
+     * @returns An object representing the refined filter.
+     */
+    le(field: string, value: Comparable): WixDataFilter;
+    /**
+     * Refines a filter to match items whose specified property value is less than the specified value.
+     *
+     * The `lt()` function refines this filter to only match
+     * items where the value of the specified property is less than the specified `value`.
+     *
+     * It only matches values of the same type. For example, a number value stored
+     * as a String type does not match the same number stored as a Number type.
+     *
+     * If a property contains a number as a String, that value will be compared
+     * alphabetically and not numerically. Items that do not have a value for the
+     * specified property are ranked lowest.
+     *
+     * The following types of properties can be compared:
+     * - Number: Compares numerically.
+     * - Date: Compares JavaScript Date objects.
+     * - String: Compares lexicographically, so `"Text"` is less than `"text"`.
+     * - Reference: Compares by the ID of the referenced item as a String.
+     * @public
+     * @documentationMaturity preview
+     * @param field - The property whose value will be compared with `value`.
+     * @requiredField field
+     * @param value - The value to match against.
+     * @requiredField value
+     * @returns An object with the filter definition, based on the supplied parameters.
+     */
+    lt(field: string, value: Comparable): WixDataFilter;
+    /**
+     * Refines a filter to match items whose specified property has any value.
+     *
+     * The `isNotEmpty()` function refines this filter to only match items where the
+     * value of the specified property is not `null` or `undefined`.
+     *
+     * If the property contains any value at all for a given item, including the
+     * empty string or an invalid value, that item will match the filter.
+     * @public
+     * @documentationMaturity preview
+     * @param field - The property in which to check for a value.
+     * @requiredField field
+     * @returns An object representing the refined filter.
+     */
+    isNotEmpty(field: string): WixDataFilter;
+    /**
+     * Refines a filter to match items whose specified property does not exist or does not have any value.
+     *
+     * The `isEmpty()` function refines this filter to only match items where the
+     * value of the specified property is `null` or `undefined` or the property does
+     * not exist.
+     *
+     * If the property contains any value at all for a given item, including the
+     * empty string or an invalid value, that item will match the filter.
+     * @public
+     * @documentationMaturity preview
+     * @param field - The property in which to check for a value.
+     * @requiredField field
+     * @returns An object representing the refined filter.
+     */
+    isEmpty(field: string): WixDataFilter;
+    /**
+     * Refines a filter to match items whose specified property value starts with a specified string.
+     *
+     * The `startsWith()` function refines this filter to
+     * only match items where the value of the specified property starts with the
+     * defined `string`. Matching with `startsWith()` is not case sensitive, so `"TEXT"` starts
+     * with `"tex"`.
+     *
+     * You can only use `startsWith()` with a property whose value is a String or Reference.
+     * When using a Reference, `startsWith()` matches by the ID of the referenced item as Strings.
+     * @public
+     * @documentationMaturity preview
+     * @param field - The property whose value will be compared with the `value` parameter.
+     * @requiredField field
+     * @param value - The string to look for at the beginning of the specified property value.
+     * @requiredField value
+     * @returns An object representing the refined filter.
+     */
+    startsWith(field: string, value: string): WixDataFilter;
+    /**
+     * Refines a filter to match items whose specified property value ends with a specified string.
+     *
+     * The `endsWith()` function refines this filter to only
+     * match items where the value of the specified property ends with the specified
+     * `string`. Matching with `endsWith()` is not case sensitive, so `"TEXT"` ends
+     * with `"ext"`.
+     *
+     * You can only use `endsWith()` with a property whose value is a String or Reference.
+     * When using a Reference, `endsWith()` matches by the ID of the referenced item as Strings.
+     * @public
+     * @documentationMaturity preview
+     * @param field - The property whose value will be compared with the string.
+     * @requiredField field
+     * @param value - The string to look for at the end of the specified property value.
+     * @requiredField value
+     * @returns An object representing the refined filter.
+     */
+    endsWith(field: string, value: string): WixDataFilter;
+    /**
+     * Refines a filter to match items whose specified property value contains a specified string.
+     *
+     * The `contains()` function refines this filter to
+     * only match items where the value of the specified property contains the
+     * specified `string`. Matching with `contains()` is not case sensitive, so
+     * `"text"` does contain `"Tex"`.
+     *
+     * You can use `contains()` with a property whose value is a String or a Reference.
+     * For properties of type reference it is recommended that you use the [`eq()`](#eq)
+     * function instead of `contains()`. With properties that are References, `contains()`
+     * matches by the ID of the referenced item as a String.
+     * @public
+     * @documentationMaturity preview
+     * @param field - The property whose value will be compared with the string.
+     * @requiredField field
+     * @param value - The string to look for inside the specified property value.
+     * @requiredField value
+     * @returns An object representing the refined filter.
+     */
+    contains(field: string, value: string): WixDataFilter;
+    /**
+     * Refines a filter to match items whose specified property value equals any of the specified `values`
+     * parameters.
+     *
+     * The `hasSome()` function refines this filter to
+     * only match items where the value of the specified property equals any of
+     * the specified values.
+     *
+     * Matching strings with `hasSome()` is case sensitive, so `"text"` is not equal to `"Text"`.
+     *
+     * If the value of the specified property is an array, `hasSome()` will match
+     * if any of the elements of that array match any of the specified values.
+     *
+     * If the specified property contains multiple references, pass item IDs in the
+     * `value` property. In such a case, `hasSome()` will match if any of the
+     * multiple references match any of the specified ID values.
+     *
+     * You can specify a list of values to match by providing an array of
+     * String, Number, or Date types as the `value` parameters.
+     * @public
+     * @documentationMaturity preview
+     * @param field - The property whose value will be compared with `value`.
+     * @requiredField field
+     * @param values - The values to match against.
+     * @requiredField values
+     * @returns An object representing the refined filter.
+     */
+    hasSome(field: string, ...values: Comparable[]): WixDataFilter;
+    /**
+     * Overload for `hasSome()`
+     * @public
+     * @documentationMaturity preview
+     */
+    hasSome(field: string, values: Comparable[]): WixDataFilter;
+    /**
+     * Refines a filter to match items whose specified property values equals all of the specified `value`
+     * parameters.
+     *
+     * The `hasAll()` function refines this filter to
+     * only match items where the value of the specified property equals all of
+     * the specified values.
+     *
+     * Matching strings with `hasAll()` is case sensitive, so `"text"` is not equal to `"Text"`.
+     *
+     * If the value of the specified property is an array, `hasAll()` will match
+     * if there is a match in the elements of that array for all of the specified
+     * values.
+     *
+     * You can specify a list of values to match by providing an array of
+     * String, Number, or Date types as the `value` parameters.
+     * @public
+     * @documentationMaturity preview
+     * @param field - The property whose value will be compared with `value`.
+     * @requiredField field
+     * @param values - The values to match against.
+     * @requiredField values
+     * @returns An object representing the refined filter.
+     */
+    hasAll(field: string, ...values: Comparable[]): WixDataFilter;
+    /**
+     * Overload for `hasAll()`
+     * @public
+     * @documentationMaturity preview
+     */
+    hasAll(field: string, values: Comparable[]): WixDataFilter;
+    /**
+     * Adds an `or` condition to the filter.
+     *
+     * The `or()` function adds an inclusive `or` condition to this filter. A filter
+     * with an `or` returns all the items that match the filter as defined up to
+     * the `or` function, the items that match the filter passed to the `or`
+     * function, and the items that match both.
+     *
+     * The 'or()' function is designed to work with 2 or more queries or filters.
+     * If you use it on its own, it will return all the items in a collection.
+     * @public
+     * @documentationMaturity preview
+     * @param filter - A filter to add to the initial filter as an `or` condition.
+     * @requiredField filter
+     * @returns An object representing the refined filter.
+     */
+    or(filter: WixDataFilter): WixDataFilter;
+    /**
+     * Adds an `and` condition to the filter.
+     *
+     * The `and()` function adds an and condition to this filter. A filter with an `and` returns all the items
+     * that match the filter as defined up to the `and` function and also match the filter passed to
+     * the `and` function.
+     *
+     * Note that when chaining multiple `WixDataFilter` functions to a filter an and condition is assumed. In such cases,
+     * you do not need to add a call to the `and()` function. For example, this filter returns results where status is
+     * active **and** age is greater than 25.
+     * ```js
+     * wixClient.items.filter().eq("status", "active").gt("age", 25);
+     * ```
+     *
+     * The `and()` function is needed when performing compound queries. For example, the final filter in this set of
+     * queries returns results where status is either pending or rejected **and** age is either less than 25 or greater
+     * than 65.
+     * ```js
+     * let statusFilter = wixClient.items.filter()
+     *   .eq("status", "pending")
+     *   .or(wixClient.items.filter().eq("status", "rejected"));
+     *
+     * let ageFilter = wixClient.items.filter()
+     *   .lt("age", 25)
+     *   .or(wixData.items.filter().gt("age", 65));
+     *
+     * let statusAndAgeFilter = statusFilter.and(ageFilter);
+     * ```
+     *
+     * The `and()` function is designed to work with 2 or more queries or filters. If you use it on its own, it will
+     * return all the items in a collection.
+     * @public
+     * @documentationMaturity preview
+     * @param filter - A filter to add to the initial filter as an `and` condition.
+     * @requiredField filter
+     * @returns An object representing the refined filter.
+     */
+    and(filter: WixDataFilter): WixDataFilter;
+    /**
+     * Adds a `not` condition to the filter.
+     *
+     * The `not()` function adds a `not` condition to this filter. A filter with a `not`
+     * returns all the items that match the filter as defined up to the `not`
+     * function, but don't match the filter passed to the `not` function.
+     *
+     * If the filter only contains a `not()` function, it returns all the items
+     * that don't match the filter defined by the `not` method.
+     *
+     * @public
+     * @documentationMaturity preview
+     * @param filter - A filter to add to the initial filter as a `not` condition.
+     * @requiredField filter
+     * @returns An object representing the refined filter.
+     */
+    not(filter: WixDataFilter): WixDataFilter;
+    /**
+     * Refines a filter to match items whose specified property value is within a specified range.
+     *
+     * The `between()` function refines this filter to only match items where the value of the specified property is
+     * greater than or equal to `rangeStart` and less than `rangeEnd`.
+     *
+     * It only matches values of the same type. For example, a number value stored as a String type does not match the
+     * same number stored as a Number type.
+     *
+     * If a property contains a number as a String, that value will be compared alphabetically and not numerically. Items
+     * that do not have a value for the specified property are ranked lowest.
+     *
+     * The following types of properties can be compared:
+     * - Number: Compares numerically.
+     * - Date: Compares JavaScript Date objects.
+     * - String: Compares lexicographically, so
+     *   - `"A"` and `"M"` are between `"A"` and `"Z"`, but `"a"`, `"m"`, `"z"` and `"Z"` are not.
+     *   - `"A"`, `"M"`, `"Z"`, and `"a"` are between `"A"` and `"z"`, but `"z"` is not.
+     * @public
+     * @documentationMaturity preview
+     * @param field - The property whose value will be compared with rangeStart and rangeEnd.
+     * @requiredField field
+     * @param rangeStart - The beginning value of the range to match against.
+     * @requiredField rangeStart
+     * @param rangeEnd - The ending value of the range to match against.
+     * @requiredField rangeEnd
+     * @returns An object representing the refined filter.
+     */
+    between<T extends Comparable>(field: string, rangeStart: T, rangeEnd: T): WixDataFilter;
+}
+export {};
+//# sourceMappingURL=WixDataFilter.d.ts.map

package/dist/types/api/WixDataFilter.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"WixDataFilter.d.ts","sourceRoot":"","sources":["../../../src/api/WixDataFilter.ts"],"names":[],"mappings":"AAAA,KAAK,UAAU,GAAG,MAAM,GAAG,MAAM,GAAG,IAAI,CAAA;AAExC;;GAEG;AACH,MAAM,WAAW,aAAa;IAC5B;;;;;;;;;;;;;;;;;;;;OAoBG;IACH,EAAE,CAAC,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,GAAG,GAAG,aAAa,CAAA;IAE5C;;;;;;;;;;;;;;;;;;;;OAoBG;IACH,EAAE,CAAC,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,GAAG,GAAG,aAAa,CAAA;IAE5C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA6BG;IACH,EAAE,CAAC,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,UAAU,GAAG,aAAa,CAAA;IAEnD;;;;;;;;;;;;;;;;;;;;;;;;;OAyBG;IACH,EAAE,CAAC,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,UAAU,GAAG,aAAa,CAAA;IAEnD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA6BG;IACH,EAAE,CAAC,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,UAAU,GAAG,aAAa,CAAA;IAEnD;;;;;;;;;;;;;;;;;;;;;;;;;OAyBG;IACH,EAAE,CAAC,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,UAAU,GAAG,aAAa,CAAA;IAEnD;;;;;;;;;;;;;OAaG;IACH,UAAU,CAAC,KAAK,EAAE,MAAM,GAAG,aAAa,CAAA;IAExC;;;;;;;;;;;;;;OAcG;IACH,OAAO,CAAC,KAAK,EAAE,MAAM,GAAG,aAAa,CAAA;IAErC;;;;;;;;;;;;;;;;;OAiBG;IACH,UAAU,CAAC,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,aAAa,CAAA;IAEvD;;;;;;;;;;;;;;;;;OAiBG;IACH,QAAQ,CAAC,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,aAAa,CAAA;IAErD;;;;;;;;;;;;;;;;;;;OAmBG;IACH,QAAQ,CAAC,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,aAAa,CAAA;IAErD;;;;;;;;;;;;;;;;;;;;;;;;;;OA0BG;IACH,OAAO,CAAC,KAAK,EAAE,MAAM,EAAE,GAAG,MAAM,EAAE,UAAU,EAAE,GAAG,aAAa,CAAA;IAE9D;;;;OAIG;IACH,OAAO,CAAC,KAAK,EAAE,MAAM,EAAE,MAAM,EAAE,UAAU,EAAE,GAAG,aAAa,CAAA;IAE3D;;;;;;;;;;;;;;;;;;;;;;;OAuBG;IACH,MAAM,CAAC,KAAK,EAAE,MAAM,EAAE,GAAG,MAAM,EAAE,UAAU,EAAE,GAAG,aAAa,CAAA;IAE7D;;;;OAIG;IACH,MAAM,CAAC,KAAK,EAAE,MAAM,EAAE,MAAM,EAAE,UAAU,EAAE,GAAG,aAAa,CAAA;IAE1D;;;;;;;;;;;;;;;OAeG;IACH,EAAE,CAAC,MAAM,EAAE,aAAa,GAAG,aAAa,CAAA;IAExC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAoCG;IACH,GAAG,CAAC,MAAM,EAAE,aAAa,GAAG,aAAa,CAAA;IAEzC;;;;;;;;;;;;;;;OAeG;IACH,GAAG,CAAC,MAAM,EAAE,aAAa,GAAG,aAAa,CAAA;IAEzC;;;;;;;;;;;;;;;;;;;;;;;;;;;OA2BG;IACH,OAAO,CAAC,CAAC,SAAS,UAAU,EAC1B,KAAK,EAAE,MAAM,EACb,UAAU,EAAE,CAAC,EACb,QAAQ,EAAE,CAAC,GACV,aAAa,CAAA;CACjB"}

package/dist/types/api/WixDataPatch.d.ts

@@ -0,0 +1,80 @@
+import { WixDataOptions, WixDataItem, WixDataBulkResult } from './types';
+import { AggregatingValidator } from '../errors';
+export interface FieldUpdate {
+    fieldPath: string;
+    action: 'SET_FIELD' | 'REMOVE_FIELD' | 'INCREMENT_FIELD' | 'APPEND_TO_ARRAY' | 'REMOVE_FROM_ARRAY';
+    actionOptions?: any;
+}
+interface BulkPatchParams {
+    collectionName: string;
+    itemIds: string[];
+    invalidArguments: string[];
+    fieldUpdates: FieldUpdate[];
+}
+interface PatchParams {
+    collectionName: string;
+    itemId: string;
+    invalidArguments: string[];
+    fieldUpdates: FieldUpdate[];
+}
+type OnRun = (args: IArguments, params: PatchParams, options?: WixDataOptions) => Promise<WixDataItem | null>;
+type OnBulkRun = (args: IArguments, params: BulkPatchParams, options?: WixDataOptions) => Promise<WixDataBulkResult>;
+declare abstract class WixDataPatchBase<Self> {
+    protected readonly fieldUpdates: FieldUpdate[];
+    protected readonly collectionName: string;
+    protected readonly ownInvalidArguments: string[];
+    constructor(origin: {
+        collectionName: string;
+        invalidArguments?: string[];
+        fieldUpdates?: FieldUpdate[];
+    });
+    protected abstract copy(params: {
+        invalidArguments?: string[];
+        addFieldUpdate: FieldUpdate;
+    }): Self;
+    incrementField(fieldName: string, by: number): Self;
+    setField(fieldName: string, value: any): Self;
+    appendToArray(fieldName: string, value: any): Self;
+    removeFromArray(fieldName: string, value: any): Self;
+    removeField(fieldName: string): Self;
+    private patchValidator;
+}
+export declare class WixDataBulkPatch extends WixDataPatchBase<WixDataBulkPatch> {
+    private readonly onRun;
+    readonly itemIds: string[];
+    constructor(origin: {
+        collectionName: string;
+        itemIds: string[];
+        invalidArguments?: string[];
+        fieldUpdates?: FieldUpdate[];
+        onRun: OnBulkRun;
+    });
+    protected copy(params: {
+        invalidArguments?: string[];
+        addFieldUpdate: FieldUpdate;
+    }): WixDataBulkPatch;
+    run(options?: WixDataOptions): Promise<WixDataBulkResult>;
+}
+export declare class WixDataPatch extends WixDataPatchBase<WixDataPatch> {
+    private readonly onRun;
+    readonly itemId: string;
+    constructor(origin: {
+        collectionName: string;
+        itemId: string;
+        invalidArguments?: string[];
+        fieldUpdates?: FieldUpdate[];
+        onRun: OnRun;
+    });
+    protected copy(params: {
+        invalidArguments?: string[];
+        addFieldUpdate: FieldUpdate;
+    }): WixDataPatch;
+    run(options?: WixDataOptions): Promise<WixDataItem | null>;
+}
+export declare class PatchValidator extends AggregatingValidator {
+    operatorName: string;
+    constructor(operatorName: string, previousInvalidArguments: string[]);
+    isNumber(specifier: string, operand: any): this;
+}
+export {};
+//# sourceMappingURL=WixDataPatch.d.ts.map

package/dist/types/api/WixDataPatch.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"WixDataPatch.d.ts","sourceRoot":"","sources":["../../../src/api/WixDataPatch.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,WAAW,EAAE,iBAAiB,EAAE,MAAM,SAAS,CAAA;AACxE,OAAO,EAAE,oBAAoB,EAAY,MAAM,WAAW,CAAA;AAG1D,MAAM,WAAW,WAAW;IAC1B,SAAS,EAAE,MAAM,CAAA;IACjB,MAAM,EACF,WAAW,GACX,cAAc,GACd,iBAAiB,GACjB,iBAAiB,GACjB,mBAAmB,CAAA;IACvB,aAAa,CAAC,EAAE,GAAG,CAAA;CACpB;AAED,UAAU,eAAe;IACvB,cAAc,EAAE,MAAM,CAAA;IACtB,OAAO,EAAE,MAAM,EAAE,CAAA;IACjB,gBAAgB,EAAE,MAAM,EAAE,CAAA;IAC1B,YAAY,EAAE,WAAW,EAAE,CAAA;CAC5B;AAED,UAAU,WAAW;IACnB,cAAc,EAAE,MAAM,CAAA;IACtB,MAAM,EAAE,MAAM,CAAA;IACd,gBAAgB,EAAE,MAAM,EAAE,CAAA;IAC1B,YAAY,EAAE,WAAW,EAAE,CAAA;CAC5B;AAED,KAAK,KAAK,GAAG,CACX,IAAI,EAAE,UAAU,EAChB,MAAM,EAAE,WAAW,EACnB,OAAO,CAAC,EAAE,cAAc,KACrB,OAAO,CAAC,WAAW,GAAG,IAAI,CAAC,CAAA;AAEhC,KAAK,SAAS,GAAG,CACf,IAAI,EAAE,UAAU,EAChB,MAAM,EAAE,eAAe,EACvB,OAAO,CAAC,EAAE,cAAc,KACrB,OAAO,CAAC,iBAAiB,CAAC,CAAA;AAE/B,uBAAe,gBAAgB,CAAC,IAAI;IAClC,SAAS,CAAC,QAAQ,CAAC,YAAY,EAAE,WAAW,EAAE,CAAA;IAC9C,SAAS,CAAC,QAAQ,CAAC,cAAc,EAAE,MAAM,CAAA;IACzC,SAAS,CAAC,QAAQ,CAAC,mBAAmB,EAAE,MAAM,EAAE,CAAA;gBAEpC,MAAM,EAAE;QAClB,cAAc,EAAE,MAAM,CAAA;QACtB,gBAAgB,CAAC,EAAE,MAAM,EAAE,CAAA;QAC3B,YAAY,CAAC,EAAE,WAAW,EAAE,CAAA;KAC7B;IAMD,SAAS,CAAC,QAAQ,CAAC,IAAI,CAAC,MAAM,EAAE;QAC9B,gBAAgB,CAAC,EAAE,MAAM,EAAE,CAAA;QAC3B,cAAc,EAAE,WAAW,CAAA;KAC5B,GAAG,IAAI;IAER,cAAc,CAAC,SAAS,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,GAAG,IAAI;IAgBnD,QAAQ,CAAC,SAAS,EAAE,MAAM,EAAE,KAAK,EAAE,GAAG,GAAG,IAAI;IAe7C,aAAa,CAAC,SAAS,EAAE,MAAM,EAAE,KAAK,EAAE,GAAG,GAAG,IAAI;IAelD,eAAe,CAAC,SAAS,EAAE,MAAM,EAAE,KAAK,EAAE,GAAG,GAAG,IAAI;IAepD,WAAW,CAAC,SAAS,EAAE,MAAM,GAAG,IAAI;IAcpC,OAAO,CAAC,cAAc;CAGvB;AAED,qBAAa,gBAAiB,SAAQ,gBAAgB,CAAC,gBAAgB,CAAC;IACtE,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAW;IACjC,QAAQ,CAAC,OAAO,EAAE,MAAM,EAAE,CAAA;gBAEd,MAAM,EAAE;QAClB,cAAc,EAAE,MAAM,CAAA;QACtB,OAAO,EAAE,MAAM,EAAE,CAAA;QACjB,gBAAgB,CAAC,EAAE,MAAM,EAAE,CAAA;QAC3B,YAAY,CAAC,EAAE,WAAW,EAAE,CAAA;QAC5B,KAAK,EAAE,SAAS,CAAA;KACjB;IAMD,SAAS,CAAC,IAAI,CAAC,MAAM,EAAE;QACrB,gBAAgB,CAAC,EAAE,MAAM,EAAE,CAAA;QAC3B,cAAc,EAAE,WAAW,CAAA;KAC5B,GAAG,gBAAgB;IASpB,GAAG,CAAC,OAAO,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,iBAAiB,CAAC;CAY1D;AAED,qBAAa,YAAa,SAAQ,gBAAgB,CAAC,YAAY,CAAC;IAC9D,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAO;IAC7B,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAA;gBAEX,MAAM,EAAE;QAClB,cAAc,EAAE,MAAM,CAAA;QACtB,MAAM,EAAE,MAAM,CAAA;QACd,gBAAgB,CAAC,EAAE,MAAM,EAAE,CAAA;QAC3B,YAAY,CAAC,EAAE,WAAW,EAAE,CAAA;QAC5B,KAAK,EAAE,KAAK,CAAA;KACb;IAMD,SAAS,CAAC,IAAI,CAAC,MAAM,EAAE;QACrB,gBAAgB,CAAC,EAAE,MAAM,EAAE,CAAA;QAC3B,cAAc,EAAE,WAAW,CAAA;KAC5B,GAAG,YAAY;IAShB,GAAG,CAAC,OAAO,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,WAAW,GAAG,IAAI,CAAC;CAY3D;AAED,qBAAa,cAAe,SAAQ,oBAAoB;IACnC,YAAY,EAAE,MAAM;gBAApB,YAAY,EAAE,MAAM,EAAE,wBAAwB,EAAE,MAAM,EAAE;IAK3E,QAAQ,CAAC,SAAS,EAAE,MAAM,EAAE,OAAO,EAAE,GAAG;CAWzC"}