@wix/wix-data-items-common 1.0.52

package/dist/esm/utils/codec.js

@@ -0,0 +1,60 @@
+export function encode(value) {
+    return serializeDates(value);
+}
+export function decode(value) {
+    return parseDates(value);
+}
+function serializeDates(json) {
+    if (typeof json !== 'object' || isDate(json)) {
+        return json;
+    }
+    const obj = copyRoot(json);
+    for (const k in obj) {
+        const value = obj[k];
+        if (value && isDate(value)) {
+            obj[k] = stringifyDate(value);
+        }
+        else if (typeof obj[k] === 'object' && obj[k] !== null) {
+            obj[k] = serializeDates(obj[k]);
+        }
+    }
+    return obj;
+}
+function isDate(obj) {
+    if (Object.prototype.toString.call(obj) !== '[object Date]') {
+        return false;
+    }
+    return !isNaN(obj.getTime());
+}
+function isDateString(value) {
+    return isNaN(value) && !isNaN(new Date(value).getDate());
+}
+function parseDates(json) {
+    if (typeof json !== 'object' || isDate(json)) {
+        return json;
+    }
+    const obj = copyRoot(json);
+    for (const k in obj) {
+        if (obj[k] && obj[k].$date && isDateString(obj[k].$date)) {
+            obj[k] = new Date(obj[k].$date);
+        }
+        else if (typeof obj[k] === 'object' && obj[k] !== null) {
+            obj[k] = parseDates(obj[k]);
+        }
+    }
+    return obj;
+}
+function stringifyDate(d) {
+    return {
+        $date: d.toJSON(),
+    };
+}
+function copyRoot(obj) {
+    if (Array.isArray(obj)) {
+        return [...obj];
+    }
+    else {
+        return { ...obj };
+    }
+}
+//# sourceMappingURL=codec.js.map

package/dist/esm/utils/codec.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"codec.js","sourceRoot":"","sources":["../../../src/utils/codec.ts"],"names":[],"mappings":"AAAA,MAAM,UAAU,MAAM,CAAC,KAAU;IAC/B,OAAO,cAAc,CAAC,KAAK,CAAC,CAAA;AAC9B,CAAC;AAED,MAAM,UAAU,MAAM,CAAC,KAAU;IAC/B,OAAO,UAAU,CAAC,KAAK,CAAC,CAAA;AAC1B,CAAC;AAED,SAAS,cAAc,CAAC,IAAS;IAC/B,IAAI,OAAO,IAAI,KAAK,QAAQ,IAAI,MAAM,CAAC,IAAI,CAAC,EAAE;QAC5C,OAAO,IAAI,CAAA;KACZ;IAED,MAAM,GAAG,GAAG,QAAQ,CAAC,IAAI,CAAC,CAAA;IAC1B,KAAK,MAAM,CAAC,IAAI,GAAG,EAAE;QACnB,MAAM,KAAK,GAAG,GAAG,CAAC,CAAC,CAAC,CAAA;QACpB,IAAI,KAAK,IAAI,MAAM,CAAC,KAAK,CAAC,EAAE;YAC1B,GAAG,CAAC,CAAC,CAAC,GAAG,aAAa,CAAC,KAAK,CAAC,CAAA;SAC9B;aAAM,IAAI,OAAO,GAAG,CAAC,CAAC,CAAC,KAAK,QAAQ,IAAI,GAAG,CAAC,CAAC,CAAC,KAAK,IAAI,EAAE;YACxD,GAAG,CAAC,CAAC,CAAC,GAAG,cAAc,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAA;SAChC;KACF;IACD,OAAO,GAAG,CAAA;AACZ,CAAC;AAED,SAAS,MAAM,CAAC,GAAW;IACzB,IAAI,MAAM,CAAC,SAAS,CAAC,QAAQ,CAAC,IAAI,CAAC,GAAG,CAAC,KAAK,eAAe,EAAE;QAC3D,OAAO,KAAK,CAAA;KACb;IACD,OAAO,CAAC,KAAK,CAAE,GAAY,CAAC,OAAO,EAAE,CAAC,CAAA;AACxC,CAAC;AAED,SAAS,YAAY,CAAC,KAAU;IAC9B,OAAO,KAAK,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,IAAI,CAAC,KAAK,CAAC,CAAC,OAAO,EAAE,CAAC,CAAA;AAC1D,CAAC;AAED,SAAS,UAAU,CAAC,IAAS;IAC3B,IAAI,OAAO,IAAI,KAAK,QAAQ,IAAI,MAAM,CAAC,IAAI,CAAC,EAAE;QAC5C,OAAO,IAAI,CAAA;KACZ;IAED,MAAM,GAAG,GAAG,QAAQ,CAAC,IAAI,CAAC,CAAA;IAC1B,KAAK,MAAM,CAAC,IAAI,GAAG,EAAE;QACnB,IAAI,GAAG,CAAC,CAAC,CAAC,IAAI,GAAG,CAAC,CAAC,CAAC,CAAC,KAAK,IAAI,YAAY,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,EAAE;YACxD,GAAG,CAAC,CAAC,CAAC,GAAG,IAAI,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAA;SAChC;aAAM,IAAI,OAAO,GAAG,CAAC,CAAC,CAAC,KAAK,QAAQ,IAAI,GAAG,CAAC,CAAC,CAAC,KAAK,IAAI,EAAE;YACxD,GAAG,CAAC,CAAC,CAAC,GAAG,UAAU,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAA;SAC5B;KACF;IACD,OAAO,GAAG,CAAA;AACZ,CAAC;AAED,SAAS,aAAa,CAAC,CAAO;IAC5B,OAAO;QACL,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE;KAClB,CAAA;AACH,CAAC;AAED,SAAS,QAAQ,CAAC,GAAQ;IACxB,IAAI,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE;QACtB,OAAO,CAAC,GAAG,GAAG,CAAC,CAAA;KAChB;SAAM;QACL,OAAO,EAAE,GAAG,GAAG,EAAE,CAAA;KAClB;AACH,CAAC"}

package/dist/esm/utils/field-key-utils.js

@@ -0,0 +1,14 @@
+export function hasField(object, fieldNamePredicate) {
+    if (!object) {
+        return false;
+    }
+    if (Array.isArray(object)) {
+        return object.some((ele) => hasField(ele, fieldNamePredicate));
+    }
+    if (typeof object === 'object') {
+        const keys = Object.keys(object);
+        return keys.some((k) => fieldNamePredicate(k) || hasField(object[k], fieldNamePredicate));
+    }
+    return false;
+}
+//# sourceMappingURL=field-key-utils.js.map

package/dist/esm/utils/field-key-utils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"field-key-utils.js","sourceRoot":"","sources":["../../../src/utils/field-key-utils.ts"],"names":[],"mappings":"AAAA,MAAM,UAAU,QAAQ,CACtB,MAAW,EACX,kBAA0C;IAE1C,IAAI,CAAC,MAAM,EAAE;QACX,OAAO,KAAK,CAAA;KACb;IACD,IAAI,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE;QACzB,OAAO,MAAM,CAAC,IAAI,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,QAAQ,CAAC,GAAG,EAAE,kBAAkB,CAAC,CAAC,CAAA;KAC/D;IACD,IAAI,OAAO,MAAM,KAAK,QAAQ,EAAE;QAC9B,MAAM,IAAI,GAAG,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,CAAA;QAChC,OAAO,IAAI,CAAC,IAAI,CACd,CAAC,CAAC,EAAE,EAAE,CAAC,kBAAkB,CAAC,CAAC,CAAC,IAAI,QAAQ,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,kBAAkB,CAAC,CACxE,CAAA;KACF;IACD,OAAO,KAAK,CAAA;AACd,CAAC"}

package/dist/esm/utils/index.js

@@ -0,0 +1,7 @@
+import { encode, decode } from './codec';
+import { isObject, isArray, isDate, isNumber, isBoolean, isString, isFunction, typeForDisplay, isUndefined, isNull, } from './type-utils';
+import { clone } from './clone';
+import { hasField } from './field-key-utils';
+import base64url from './base64url';
+export { encode, decode, isObject, isArray, isDate, isNumber, isBoolean, isString, isFunction, typeForDisplay, isUndefined, isNull, clone, hasField, base64url, };
+//# sourceMappingURL=index.js.map

package/dist/esm/utils/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/utils/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,SAAS,CAAA;AACxC,OAAO,EACL,QAAQ,EACR,OAAO,EACP,MAAM,EACN,QAAQ,EACR,SAAS,EACT,QAAQ,EACR,UAAU,EACV,cAAc,EACd,WAAW,EACX,MAAM,GACP,MAAM,cAAc,CAAA;AACrB,OAAO,EAAE,KAAK,EAAE,MAAM,SAAS,CAAA;AAC/B,OAAO,EAAE,QAAQ,EAAE,MAAM,mBAAmB,CAAA;AAC5C,OAAO,SAAS,MAAM,aAAa,CAAA;AAEnC,OAAO,EACL,MAAM,EACN,MAAM,EACN,QAAQ,EACR,OAAO,EACP,MAAM,EACN,QAAQ,EACR,SAAS,EACT,QAAQ,EACR,UAAU,EACV,cAAc,EACd,WAAW,EACX,MAAM,EACN,KAAK,EACL,QAAQ,EACR,SAAS,GACV,CAAA"}

package/dist/esm/utils/type-utils.js

@@ -0,0 +1,40 @@
+import getKind from 'kind-of';
+export function isObject(obj) {
+    return getKind(obj) === 'object';
+}
+export function isArray(arr) {
+    return getKind(arr) === 'array';
+}
+export function isDate(obj) {
+    return getKind(obj) === 'date';
+}
+export function isNumber(obj) {
+    return getKind(obj) === 'number';
+}
+export function isBoolean(obj) {
+    return getKind(obj) === 'boolean';
+}
+export function isString(obj) {
+    return getKind(obj) === 'string';
+}
+export function isFunction(obj) {
+    return getKind(obj) === 'function';
+}
+export function typeForDisplay(obj) {
+    return upperCaseFirst(getKind(obj));
+}
+export function isUndefined(obj) {
+    return getKind(obj) === 'undefined';
+}
+export function isNull(obj) {
+    return getKind(obj) === 'null';
+}
+function upperCaseFirst(str) {
+    if (!isString(str)) {
+        return str;
+    }
+    const first = str.slice(0, 1).toUpperCase();
+    const rest = str.slice(1, str.length);
+    return first + rest;
+}
+//# sourceMappingURL=type-utils.js.map

package/dist/esm/utils/type-utils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"type-utils.js","sourceRoot":"","sources":["../../../src/utils/type-utils.ts"],"names":[],"mappings":"AAAA,OAAO,OAAO,MAAM,SAAS,CAAA;AAE7B,MAAM,UAAU,QAAQ,CAAC,GAAQ;IAC/B,OAAO,OAAO,CAAC,GAAG,CAAC,KAAK,QAAQ,CAAA;AAClC,CAAC;AAED,MAAM,UAAU,OAAO,CAAC,GAAQ;IAC9B,OAAO,OAAO,CAAC,GAAG,CAAC,KAAK,OAAO,CAAA;AACjC,CAAC;AAED,MAAM,UAAU,MAAM,CAAC,GAAQ;IAC7B,OAAO,OAAO,CAAC,GAAG,CAAC,KAAK,MAAM,CAAA;AAChC,CAAC;AAED,MAAM,UAAU,QAAQ,CAAC,GAAQ;IAC/B,OAAO,OAAO,CAAC,GAAG,CAAC,KAAK,QAAQ,CAAA;AAClC,CAAC;AAED,MAAM,UAAU,SAAS,CAAC,GAAQ;IAChC,OAAO,OAAO,CAAC,GAAG,CAAC,KAAK,SAAS,CAAA;AACnC,CAAC;AAED,MAAM,UAAU,QAAQ,CAAC,GAAQ;IAC/B,OAAO,OAAO,CAAC,GAAG,CAAC,KAAK,QAAQ,CAAA;AAClC,CAAC;AAED,MAAM,UAAU,UAAU,CAAC,GAAQ;IACjC,OAAO,OAAO,CAAC,GAAG,CAAC,KAAK,UAAU,CAAA;AACpC,CAAC;AAED,MAAM,UAAU,cAAc,CAAC,GAAQ;IACrC,OAAO,cAAc,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAA;AACrC,CAAC;AAED,MAAM,UAAU,WAAW,CAAC,GAAQ;IAClC,OAAO,OAAO,CAAC,GAAG,CAAC,KAAK,WAAW,CAAA;AACrC,CAAC;AAED,MAAM,UAAU,MAAM,CAAC,GAAQ;IAC7B,OAAO,OAAO,CAAC,GAAG,CAAC,KAAK,MAAM,CAAA;AAChC,CAAC;AAED,SAAS,cAAc,CAAC,GAAQ;IAC9B,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE;QAClB,OAAO,GAAG,CAAA;KACX;IACD,MAAM,KAAK,GAAG,GAAG,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,WAAW,EAAE,CAAA;IAC3C,MAAM,IAAI,GAAG,GAAG,CAAC,KAAK,CAAC,CAAC,EAAE,GAAG,CAAC,MAAM,CAAC,CAAA;IACrC,OAAO,KAAK,GAAG,IAAI,CAAA;AACrB,CAAC"}

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

@@ -0,0 +1,30 @@
+import type { RequestInterceptor, Request, HttpApiClientFactory } from '../types/api';
+import { AggregateDataItemsRequest, AggregateDataItemsResponse, BulkInsertDataItemReferencesRequest, BulkInsertDataItemReferencesResponse, BulkInsertDataItemsRequest, BulkInsertDataItemsResponse, BulkPatchDataItemsRequest, BulkPatchDataItemsResponse, BulkRemoveDataItemReferencesRequest, BulkRemoveDataItemReferencesResponse, BulkRemoveDataItemsRequest, BulkRemoveDataItemsResponse, BulkSaveDataItemsRequest, BulkSaveDataItemsResponse, BulkUpdateDataItemsRequest, BulkUpdateDataItemsResponse, CountDataItemsRequest, CountDataItemsResponse, GetDataItemRequest, GetDataItemResponse, InsertDataItemRequest, InsertDataItemResponse, IsReferencedDataItemRequest, IsReferencedDataItemResponse, PatchDataItemRequest, PatchDataItemResponse, QueryDataItemsRequest, QueryDataItemsResponse, QueryDistinctValuesRequest, QueryDistinctValuesResponse, QueryReferencedDataItemsRequest, QueryReferencedDataItemsResponse, RemoveDataItemRequest, RemoveDataItemResponse, ReplaceDataItemReferencesRequest, ReplaceDataItemReferencesResponse, SaveDataItemRequest, SaveDataItemResponse, TruncateDataItemsRequest, TruncateDataItemsResponse, UpdateDataItemRequest, UpdateDataItemResponse } from '../types/data-item-types';
+export declare function apiRequestInterceptor<R extends Request>(allowGet: boolean): RequestInterceptor<R>;
+export declare class ApiClient {
+    private httpApiClient;
+    constructor(clientFactory: HttpApiClientFactory<any>, allowGet: boolean);
+    getDataItem(r: GetDataItemRequest): Promise<GetDataItemResponse>;
+    insertDataItem(r: InsertDataItemRequest): Promise<InsertDataItemResponse>;
+    saveDataItem(r: SaveDataItemRequest): Promise<SaveDataItemResponse>;
+    updateDataItem(r: UpdateDataItemRequest): Promise<UpdateDataItemResponse>;
+    patchDataItem(r: PatchDataItemRequest): Promise<PatchDataItemResponse>;
+    bulkPatchDataItems(r: BulkPatchDataItemsRequest): Promise<BulkPatchDataItemsResponse>;
+    removeDataItem(r: RemoveDataItemRequest): Promise<RemoveDataItemResponse>;
+    countDataItems(r: CountDataItemsRequest): Promise<CountDataItemsResponse>;
+    queryDistinctValues(r: QueryDistinctValuesRequest): Promise<QueryDistinctValuesResponse>;
+    queryDataItems(r: QueryDataItemsRequest): Promise<QueryDataItemsResponse>;
+    aggregateDataItems(r: AggregateDataItemsRequest): Promise<AggregateDataItemsResponse>;
+    bulkInsertDataItems(r: BulkInsertDataItemsRequest): Promise<BulkInsertDataItemsResponse>;
+    bulkUpdateDataItems(r: BulkUpdateDataItemsRequest): Promise<BulkUpdateDataItemsResponse>;
+    bulkSaveDataItems(r: BulkSaveDataItemsRequest): Promise<BulkSaveDataItemsResponse>;
+    bulkRemoveDataItems(r: BulkRemoveDataItemsRequest): Promise<BulkRemoveDataItemsResponse>;
+    queryReferencedDataItems(r: QueryReferencedDataItemsRequest): Promise<QueryReferencedDataItemsResponse>;
+    bulkInsertDataItemReferences(r: BulkInsertDataItemReferencesRequest): Promise<BulkInsertDataItemReferencesResponse>;
+    replaceDataItemReferences(r: ReplaceDataItemReferencesRequest): Promise<ReplaceDataItemReferencesResponse>;
+    bulkRemoveDataItemReferences(r: BulkRemoveDataItemReferencesRequest): Promise<BulkRemoveDataItemReferencesResponse>;
+    isReferencedDataItem(r: IsReferencedDataItemRequest): Promise<IsReferencedDataItemResponse>;
+    truncateDataItems(r: TruncateDataItemsRequest): Promise<TruncateDataItemsResponse>;
+    private withErrorHandling;
+}
+//# sourceMappingURL=ApiClient.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"ApiClient.d.ts","sourceRoot":"","sources":["../../../src/api/ApiClient.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAEV,kBAAkB,EAClB,OAAO,EACP,oBAAoB,EACrB,MAAM,cAAc,CAAA;AASrB,OAAO,EACL,yBAAyB,EACzB,0BAA0B,EAC1B,mCAAmC,EACnC,oCAAoC,EACpC,0BAA0B,EAC1B,2BAA2B,EAC3B,yBAAyB,EACzB,0BAA0B,EAC1B,mCAAmC,EACnC,oCAAoC,EACpC,0BAA0B,EAC1B,2BAA2B,EAC3B,wBAAwB,EACxB,yBAAyB,EACzB,0BAA0B,EAC1B,2BAA2B,EAC3B,qBAAqB,EACrB,sBAAsB,EACtB,kBAAkB,EAClB,mBAAmB,EACnB,qBAAqB,EACrB,sBAAsB,EACtB,2BAA2B,EAC3B,4BAA4B,EAC5B,oBAAoB,EACpB,qBAAqB,EACrB,qBAAqB,EACrB,sBAAsB,EACtB,0BAA0B,EAC1B,2BAA2B,EAC3B,+BAA+B,EAC/B,gCAAgC,EAChC,qBAAqB,EACrB,sBAAsB,EACtB,gCAAgC,EAChC,iCAAiC,EACjC,mBAAmB,EACnB,oBAAoB,EACpB,wBAAwB,EACxB,yBAAyB,EACzB,qBAAqB,EACrB,sBAAsB,EACvB,MAAM,0BAA0B,CAAA;AAMjC,wBAAgB,qBAAqB,CAAC,CAAC,SAAS,OAAO,EACrD,QAAQ,EAAE,OAAO,GAChB,kBAAkB,CAAC,CAAC,CAAC,CAkBvB;AAED,qBAAa,SAAS;IACpB,OAAO,CAAC,aAAa,CAAe;gBAExB,aAAa,EAAE,oBAAoB,CAAC,GAAG,CAAC,EAAE,QAAQ,EAAE,OAAO;IAIjE,WAAW,CAAC,CAAC,EAAE,kBAAkB,GAAG,OAAO,CAAC,mBAAmB,CAAC;IAOhE,cAAc,CAClB,CAAC,EAAE,qBAAqB,GACvB,OAAO,CAAC,sBAAsB,CAAC;IAO5B,YAAY,CAAC,CAAC,EAAE,mBAAmB,GAAG,OAAO,CAAC,oBAAoB,CAAC;IAOnE,cAAc,CAClB,CAAC,EAAE,qBAAqB,GACvB,OAAO,CAAC,sBAAsB,CAAC;IAO5B,aAAa,CAAC,CAAC,EAAE,oBAAoB,GAAG,OAAO,CAAC,qBAAqB,CAAC;IAOtE,kBAAkB,CACtB,CAAC,EAAE,yBAAyB,GAC3B,OAAO,CAAC,0BAA0B,CAAC;IAOhC,cAAc,CAClB,CAAC,EAAE,qBAAqB,GACvB,OAAO,CAAC,sBAAsB,CAAC;IAO5B,cAAc,CAClB,CAAC,EAAE,qBAAqB,GACvB,OAAO,CAAC,sBAAsB,CAAC;IAO5B,mBAAmB,CACvB,CAAC,EAAE,0BAA0B,GAC5B,OAAO,CAAC,2BAA2B,CAAC;IAOjC,cAAc,CAClB,CAAC,EAAE,qBAAqB,GACvB,OAAO,CAAC,sBAAsB,CAAC;IAO5B,kBAAkB,CACtB,CAAC,EAAE,yBAAyB,GAC3B,OAAO,CAAC,0BAA0B,CAAC;IAOhC,mBAAmB,CACvB,CAAC,EAAE,0BAA0B,GAC5B,OAAO,CAAC,2BAA2B,CAAC;IAOjC,mBAAmB,CACvB,CAAC,EAAE,0BAA0B,GAC5B,OAAO,CAAC,2BAA2B,CAAC;IAOjC,iBAAiB,CACrB,CAAC,EAAE,wBAAwB,GAC1B,OAAO,CAAC,yBAAyB,CAAC;IAO/B,mBAAmB,CACvB,CAAC,EAAE,0BAA0B,GAC5B,OAAO,CAAC,2BAA2B,CAAC;IAOjC,wBAAwB,CAC5B,CAAC,EAAE,+BAA+B,GACjC,OAAO,CAAC,gCAAgC,CAAC;IAOtC,4BAA4B,CAChC,CAAC,EAAE,mCAAmC,GACrC,OAAO,CAAC,oCAAoC,CAAC;IAO1C,yBAAyB,CAC7B,CAAC,EAAE,gCAAgC,GAClC,OAAO,CAAC,iCAAiC,CAAC;IAOvC,4BAA4B,CAChC,CAAC,EAAE,mCAAmC,GACrC,OAAO,CAAC,oCAAoC,CAAC;IAO1C,oBAAoB,CACxB,CAAC,EAAE,2BAA2B,GAC7B,OAAO,CAAC,4BAA4B,CAAC;IAOlC,iBAAiB,CACrB,CAAC,EAAE,wBAAwB,GAC1B,OAAO,CAAC,yBAAyB,CAAC;YAOvB,iBAAiB;CAmBhC"}

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

@@ -0,0 +1,111 @@
+import { WithFilter, PlatformizedFilterBuilder, FilterTree } from '../filter';
+import { Sort } from '../sort/sortMixin';
+export declare abstract class QueryBase<Self extends WithFilter<Self>> implements WithFilter<Self> {
+    /**
+     * @internal
+     */
+    protected readonly filterBuilder: PlatformizedFilterBuilder;
+    /**
+     * @internal
+     */
+    protected readonly sort: Sort;
+    /**
+     * @internal
+     */
+    readonly collectionName: string;
+    protected constructor(origin: {
+        collectionName: string;
+        filterBuilder?: PlatformizedFilterBuilder;
+        sort?: Sort;
+    });
+    /**
+     * @internal
+     */
+    protected abstract copy(params: {
+        filterBuilder?: PlatformizedFilterBuilder;
+        sort?: Sort;
+    }): Self;
+    abstract get invalidArguments(): string[];
+    get filterTree(): Record<string, any>;
+    /**
+     * @internal
+     */
+    setFilterModel(filterTree: Record<string, any>): Self;
+    /**
+     * @internal
+     */
+    getFilterModel(): FilterTree;
+    private withFilter;
+    eq: WithFilter<Self>['eq'];
+    ne: WithFilter<Self>['ne'];
+    ge: WithFilter<Self>['ge'];
+    gt: WithFilter<Self>['gt'];
+    gte: WithFilter<Self>['gte'];
+    le: WithFilter<Self>['le'];
+    lt: WithFilter<Self>['lt'];
+    lte: WithFilter<Self>['lte'];
+    isNotEmpty: WithFilter<Self>['isNotEmpty'];
+    isEmpty: WithFilter<Self>['isEmpty'];
+    startsWith: WithFilter<Self>['startsWith'];
+    endsWith: WithFilter<Self>['endsWith'];
+    contains: WithFilter<Self>['contains'];
+    hasSome: WithFilter<Self>['hasSome'];
+    in: WithFilter<Self>['in'];
+    hasAll: WithFilter<Self>['hasAll'];
+    exists: WithFilter<Self>['exists'];
+    or: WithFilter<Self>['or'];
+    and: WithFilter<Self>['and'];
+    not: WithFilter<Self>['not'];
+    between: WithFilter<Self>['between'];
+    private extractFilter;
+    get orderBy(): {
+        [field: string]: 'asc' | 'desc';
+    }[];
+    /**
+     * Adds a sort to a query or sort, sorting by the specified properties in ascending order.
+     *
+     * The `ascending()` function refines this query in ascending order of the specified properties. If you specify more
+     * than one property, ascending() sorts the results in ascending order by each property in the order they are listed.
+     *
+     * You can sort the following types:
+     * - Number: Sorts numerically.
+     * - Date: Sorts by date and time.
+     * - String: Sorts lexicographically, so `"abc"` comes after `"XYZ"`.
+     * - Reference: Compares by the ID of the referenced item as a String.
+     *
+     * If a property contains a number as a String, that value will be sorted alphabetically and not numerically.
+     * Items that do not have a value for the specified sort property are ranked lowest.
+     * @public
+     * @documentationMaturity preview
+     * @param fields - The properties used in the sort.
+     * @requiredField fields
+     * @returns An object representing the refined query.
+     */
+    ascending(...fields: string[]): Self;
+    ascending(fields: string[]): Self;
+    /**
+     * Adds a sort to a query or sort, sorting by the specified properties in descending order.
+     *
+     * The `descending()` function refines this query to sort in descending order of the specified properties. If you
+     * specify more than one property, descending() sorts the results in descending order by each property in the order
+     * they are listed.
+     *
+     * You can sort the following types:
+     *
+     * Number: Sorts numerically.
+     * - Date: Sorts by date and time.
+     * - String: Sorts lexicographically, so `"abc"` comes before `"XYZ"`.
+     * - Reference: Compares by the ID of the referenced item as a String.
+     *
+     * If a property contains a number as a String, that value will be sorted alphabetically and not numerically. Items
+     * that do not have a value for the specified sort property are ranked lowest.
+     * @public
+     * @documentationMaturity preview
+     * @param fields - The properties used in the sort.
+     * @requiredField fields
+     * @returns An object representing the refined query.
+     */
+    descending(...fields: string[]): Self;
+    descending(fields: string[]): Self;
+}
+//# sourceMappingURL=QueryBase.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"QueryBase.d.ts","sourceRoot":"","sources":["../../../src/api/QueryBase.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,UAAU,EACV,yBAAyB,EAEzB,UAAU,EACX,MAAM,WAAW,CAAA;AAClB,OAAO,EAAE,IAAI,EAAE,MAAM,mBAAmB,CAAA;AAGxC,8BAAsB,SAAS,CAAC,IAAI,SAAS,UAAU,CAAC,IAAI,CAAC,CAC3D,YAAW,UAAU,CAAC,IAAI,CAAC;IAE3B;;OAEG;IACH,SAAS,CAAC,QAAQ,CAAC,aAAa,EAAE,yBAAyB,CAAA;IAE3D;;OAEG;IACH,SAAS,CAAC,QAAQ,CAAC,IAAI,EAAE,IAAI,CAAA;IAE7B;;OAEG;IACH,QAAQ,CAAC,cAAc,EAAE,MAAM,CAAA;IAE/B,SAAS,aAAa,MAAM,EAAE;QAC5B,cAAc,EAAE,MAAM,CAAA;QACtB,aAAa,CAAC,EAAE,yBAAyB,CAAA;QACzC,IAAI,CAAC,EAAE,IAAI,CAAA;KACZ;IAOD;;OAEG;IACH,SAAS,CAAC,QAAQ,CAAC,IAAI,CAAC,MAAM,EAAE;QAC9B,aAAa,CAAC,EAAE,yBAAyB,CAAA;QACzC,IAAI,CAAC,EAAE,IAAI,CAAA;KACZ,GAAG,IAAI;IAIR,QAAQ,KAAK,gBAAgB,IAAI,MAAM,EAAE,CAAA;IAEzC,IAAI,UAAU,IAAI,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAEpC;IAED;;OAEG;IACH,cAAc,CAAC,UAAU,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG,IAAI;IAQrD;;OAEG;IACH,cAAc,IAAI,UAAU;IAI5B,OAAO,CAAC,UAAU;IAYlB,EAAE,EAAE,UAAU,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,CAEzB;IACD,EAAE,EAAE,UAAU,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,CAEzB;IACD,EAAE,EAAE,UAAU,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,CAEzB;IACD,EAAE,EAAE,UAAU,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,CAEzB;IACD,GAAG,EAAE,UAAU,CAAC,IAAI,CAAC,CAAC,KAAK,CAAC,CAE3B;IACD,EAAE,EAAE,UAAU,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,CAEzB;IACD,EAAE,EAAE,UAAU,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,CAEzB;IACD,GAAG,EAAE,UAAU,CAAC,IAAI,CAAC,CAAC,KAAK,CAAC,CAE3B;IACD,UAAU,EAAE,UAAU,CAAC,IAAI,CAAC,CAAC,YAAY,CAAC,CAEzC;IACD,OAAO,EAAE,UAAU,CAAC,IAAI,CAAC,CAAC,SAAS,CAAC,CAEnC;IACD,UAAU,EAAE,UAAU,CAAC,IAAI,CAAC,CAAC,YAAY,CAAC,CAEzC;IACD,QAAQ,EAAE,UAAU,CAAC,IAAI,CAAC,CAAC,UAAU,CAAC,CAErC;IACD,QAAQ,EAAE,UAAU,CAAC,IAAI,CAAC,CAAC,UAAU,CAAC,CAErC;IACD,OAAO,EAAE,UAAU,CAAC,IAAI,CAAC,CAAC,SAAS,CAAC,CAElC;IACF,EAAE,EAAE,UAAU,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,CAEzB;IACD,MAAM,EAAE,UAAU,CAAC,IAAI,CAAC,CAAC,QAAQ,CAAC,CAEjC;IACD,MAAM,EAAE,UAAU,CAAC,IAAI,CAAC,CAAC,QAAQ,CAAC,CAEjC;IACD,EAAE,EAAE,UAAU,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,CAGzB;IACD,GAAG,EAAE,UAAU,CAAC,IAAI,CAAC,CAAC,KAAK,CAAC,CAG3B;IACD,GAAG,EAAE,UAAU,CAAC,IAAI,CAAC,CAAC,KAAK,CAAC,CAG3B;IACD,OAAO,EAAE,UAAU,CAAC,IAAI,CAAC,CAAC,SAAS,CAAC,CAEnC;IAED,OAAO,CAAC,aAAa;IAMrB,IAAI,OAAO,IAAI;QAAE,CAAC,KAAK,EAAE,MAAM,GAAG,KAAK,GAAG,MAAM,CAAA;KAAE,EAAE,CAEnD;IAED;;;;;;;;;;;;;;;;;;;OAmBG;IACH,SAAS,CAAC,GAAG,MAAM,EAAE,MAAM,EAAE,GAAG,IAAI;IACpC,SAAS,CAAC,MAAM,EAAE,MAAM,EAAE,GAAG,IAAI;IAMjC;;;;;;;;;;;;;;;;;;;;;OAqBG;IACH,UAAU,CAAC,GAAG,MAAM,EAAE,MAAM,EAAE,GAAG,IAAI;IACrC,UAAU,CAAC,MAAM,EAAE,MAAM,EAAE,GAAG,IAAI;CAKnC"}

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

@@ -0,0 +1,12 @@
+import { AggregatingValidator } from '../errors';
+export declare class QueryValidator extends AggregatingValidator {
+    operatorName: any;
+    constructor(operatorName: string, previousInvalidArguments: string[]);
+    _isNumber(specifier: string, operand: any): this;
+    isPositiveNumber(operand: number): this;
+    isNonNegativeNumber(operand: number): this;
+    isInteger(operand: number): this;
+    notGreaterThan(operand: number, value: number): this;
+    nonEmptyString(operand: any): this;
+}
+//# sourceMappingURL=QueryValidator.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"QueryValidator.d.ts","sourceRoot":"","sources":["../../../src/api/QueryValidator.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,oBAAoB,EAAY,MAAM,WAAW,CAAA;AAI1D,qBAAa,cAAe,SAAQ,oBAAoB;IACtD,YAAY,EAAE,GAAG,CAAA;gBAEL,YAAY,EAAE,MAAM,EAAE,wBAAwB,EAAE,MAAM,EAAE;IAKpE,SAAS,CAAC,SAAS,EAAE,MAAM,EAAE,OAAO,EAAE,GAAG;IAYzC,gBAAgB,CAAC,OAAO,EAAE,MAAM;IAQhC,mBAAmB,CAAC,OAAO,EAAE,MAAM;IAWnC,SAAS,CAAC,OAAO,EAAE,MAAM;IAYzB,cAAc,CAAC,OAAO,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM;IAY7C,cAAc,CAAC,OAAO,EAAE,GAAG;CAM5B"}

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

@@ -0,0 +1,320 @@
+import { WixDataFilter } from './WixDataFilter';
+import { WixDataReadOptions } from './types';
+import { WixDataResult } from './WixDataResult';
+/**
+ * @builder
+ */
+export interface WixDataAggregate {
+    /**
+     * Refines a `WixDataAggregate` to contain the sum from each aggregation group.
+     *
+     * The `sum()` function refines a `WixDataAggregate` to contain the sum of the
+     * values from the specified property for each aggregated group or from the
+     * whole collection if no group is defined.
+     *
+     * When the aggregation is `run()`, the returned `WixDataAggregateResult`
+     * object contains an item for each group with the following key:value pairs:
+     * - If a value was passed for the optional `projectedName`, the key is named
+     *   using that value. Otherwise, the key is named using the following format:
+     *   `"propertyNameSum"`, where `propertyName` is the name of the specified property.
+     * - The value is the sum of the values found in the specified property.
+     *
+     * Sums can only be calculated on properties of type Number.
+     *
+     * > **Note:** Aggregations can only be used on collections you have created. They cannot be
+     * > used on [Wix App Collections](https://support.wix.com/en/article/cms-formerly-content-manager-working-with-wix-app-collections).
+     * @public
+     * @documentationMaturity preview
+     * @param fieldName - The property in which to find the sum.
+     * @requiredField fieldName
+     * @param projectedField - The name of the property in the aggregation results containing the sum.
+     * @returns A `WixDataAggregate` object representing the refined aggregation.
+     */
+    sum(fieldName: string, projectedField?: string): WixDataAggregate;
+    /**
+     * Refines a `WixDataAggregate` to only contain the average value from each aggregation group.
+     *
+     * The `avg()` function refines a `WixDataAggregate` to contain the average
+     * value from the specified property for each aggregated group or from the
+     * whole collection if no group is defined.
+     *
+     * When the aggregation is `run()`, the returned `WixDataAggregateResult`
+     * object contains an item for each group with the following key:value pairs:
+     * - If a value was passed for the optional `projectedName`, the key is named
+     *   using that value. Otherwise, the key is named using the following format:
+     *   `"propertyNameAvg"`, where `propertyName` is the name of the specified property.
+     * - The value is the average of the values found in the specified property.
+     *
+     *  Averages can only be calculated on properties of type Number.
+     *
+     * > **Note:** Aggregations can only be used on collections you have created. They cannot be
+     * > used on [Wix App Collections](https://support.wix.com/en/article/cms-formerly-content-manager-working-with-wix-app-collections).
+     * @public
+     * @documentationMaturity preview
+     * @param fieldName - The property in which to find the average value.
+     * @requiredField fieldName
+     * @param projectedField - The name of the property in the aggregation results containing the average value.
+     * @returns A `WixDataAggregate` object representing the refined aggregation.
+     */
+    avg(fieldName: string, projectedField?: string): WixDataAggregate;
+    /**
+     * Refines a `WixDataAggregate` to only contain the minimum value from each aggregation group.
+     *
+     * The `min()` function refines a `WixDataAggregate` to contain the minimum
+     * value from the specified property for each aggregated group or from the
+     * whole collection if no group is defined.
+     *
+     * When the aggregation is `run()`, the returned `WixDataAggregateResult`
+     * object contains an item for each group with the following key:value pairs:
+     * - If a value was passed for the optional `projectedName`, the key is named
+     *   using that value. Otherwise, the key is named using the following format:
+     *   `"propertyNameMin"`, where `propertyName` is the name of the specified property.
+     * - The value is the minimum value found in the specified property.
+     *
+     * The following types of properties can be compared to determine a minimum value:
+     * - Number: Compares numerically.
+     * - Date and Time: Compares JavaScript Date objects.
+     * - Text: Compares lexicographically, so `"text"` is greater than `"Text"`.
+     * - Rich Text: Compares HTML source as text.
+     * - URL: Compares as text.
+     * - Image: Compares image source as text.
+     * - Video: Compares video source as text.
+     * - Document: Compares document source as text.
+     * - Reference: Compares by the ID of the referenced item as a String.
+     *
+     * > **Note:** Aggregations can only be used on collections you have created. They cannot be
+     * > used on [Wix App Collections](https://support.wix.com/en/article/cms-formerly-content-manager-working-with-wix-app-collections).
+     * @public
+     * @documentationMaturity preview
+     * @param fieldName - The property in which to find the minimum value.
+     * @requiredField fieldName
+     * @param projectedField - The name of the property in the aggregation results containing the minimum value.
+     * @returns A `WixDataAggregate` object representing the refined aggregation.
+     */
+    min(fieldName: string, projectedField?: string): WixDataAggregate;
+    /**
+     * Refines a `WixDataAggregate` to only contain the maximum value from each aggregation group.
+     *
+     * The `max()` function refines a `WixDataAggregate` to contain the maximum
+     * value from the specified property for each aggregated group or from the
+     * whole collection if no group is defined.
+     *
+     * When the aggregation is `run()`, the returned `WixDataAggregateResult`
+     * object contains an item for each group with the following key:value pairs:
+     * - If a value was passed for the optional `projectedName`, the key is named
+     *   using that value. Otherwise, the key is named using the following format:
+     *   `"propertyNameMax"`, where `propertyName` is the name of the specified property.
+     * - The value is the maximum value found in the specified property.
+     *
+     * The following types of properties can be compared to determine a maximum value:
+     * - Number: Compares numerically.
+     * - Date and Time: Compares JavaScript Date objects.
+     * - Text: Compares lexicographically, so `"text"` is greater than `"Text"`.
+     * - Rich Text: Compares HTML source as text.
+     * - URL: Compares as text.
+     * - Image: Compares image source as text.
+     * - Video: Compares video source as text.
+     * - Document: Compares document source as text.
+     * - Reference: Compares by the ID of the referenced item as a String.
+     *
+     * > **Note:** Aggregations can only be used on collections you have created. They cannot be
+     * > used on [Wix App Collections](https://support.wix.com/en/article/cms-formerly-content-manager-working-with-wix-app-collections).
+     * @public
+     * @documentationMaturity preview
+     * @param fieldName - The property in which to find the maximum value.
+     * @requiredField fieldName
+     * @param projectedField - The name of the property in the aggregation results containing the maximum value.
+     * @returns A `WixDataAggregate` object representing the refined aggregation.
+     */
+    max(fieldName: string, projectedField?: string): WixDataAggregate;
+    /**
+     * Refines a `WixDataAggregate` to contain the item count of each group in the aggregation.
+     *
+     * The `count()` function refines a `WixDataAggregate` to contain the item
+     * count in each of the aggregate's groups.
+     *
+     * When the aggregation is `run()`, the returned `WixDataAggregateResult`
+     * object contains items with the following additional key:value pair:
+     * - The key is named `"count"`.
+     * - The value is the count of items aggregated in the group.
+     *
+     * > **Note:** Aggregations can only be used on collections you have created. They cannot be
+     * > used on [Wix App Collections](https://support.wix.com/en/article/cms-formerly-content-manager-working-with-wix-app-collections).
+     * @public
+     * @documentationMaturity preview
+     * @param projectedField - The name of the property in the aggregation results containing the count value.
+     * @returns A `WixDataAggregate` object representing the refined aggregation.
+     */
+    count(projectedField?: string): WixDataAggregate;
+    /**
+     * Filters out items from being used in an aggregation.
+     *
+     * The `filter()` function refines a `WixDataAggregate` so that it only
+     * includes items from the aggregate's collection which match the specified
+     * filter criteria.
+     *
+     * To create a filter, use the wix-data `filter()` function.
+     *
+     * Filtering using `filter()` takes place before grouping is performed on the
+     * aggregation. To filter grouped results, use the `having()` function.
+     *
+     * > **Note:** Aggregations can only be used on collections you have created. They cannot be
+     * > used on [Wix App Collections](https://support.wix.com/en/article/cms-formerly-content-manager-working-with-wix-app-collections).
+     * @public
+     * @documentationMaturity preview
+     * @param filterBuilder - The filter to use to filter out items from being used in the aggregation.
+     * @requiredField filterBuilder
+     * @returns A `WixDataAggregate` object representing the refined aggregation.
+     */
+    filter(filterBuilder: WixDataFilter): WixDataAggregate;
+    /**
+     * Groups items together in an aggregation.
+     *
+     * The `group()` function refines a `WixDataAggregate` so that its items are
+     * grouped by the specified property or properties.
+     *
+     * You can perform aggregations on the groups using the following functions:
+     * - `avg()`
+     * - `count()`
+     * - `max()`
+     * - `min()`
+     * - `sum()`
+     *
+     * To filter grouped results, use the `having()` function.
+     *
+     * > **Notes:**
+     * > - Aggregations can only be used on collections you have created. They cannot be used on [Wix App Collections](https://dev.wix.com/docs/develop-websites/articles/databases/wix-data/collections/working-with-wix-app-collections-and-code).
+     * > - You can only call the `group()` function once per aggregate query.
+     * @public
+     * @documentationMaturity preview
+     * @param fieldName - The property or properties to group on.
+     * @requiredField fieldName
+     * @returns A `WixDataAggregate` object representing the refined aggregation.
+     */
+    group(...fieldName: string[]): WixDataAggregate;
+    /**
+     * Filters out groups from being returned from an aggregation.
+     *
+     * The `having()` function refines a `WixDataAggregate` so that it only
+     * includes groups from the aggregate's grouping which match the specified
+     * filter criteria.
+     *
+     * To create a filter, use the wix-data `filter()` function.
+     *
+     * Filtering using `having()` takes place after grouping is performed on the
+     * aggregation. To filter items before grouping, use the `filter()` function.
+     *
+     * > **Note:** Aggregations can only be used on collections you have created. They cannot be
+     * > used on [Wix App Collections](https://support.wix.com/en/article/cms-formerly-content-manager-working-with-wix-app-collections).
+     * @public
+     * @documentationMaturity preview
+     * @param filterBuilder - The filter to use to filter out groups from being returned from the aggregation.
+     * @requiredField filterBuilder
+     * @returns A `WixDataAggregate` object representing the refined aggregation.
+     */
+    having(filterBuilder: WixDataFilter): WixDataAggregate;
+    /**
+     * Limits the number of items or groups the aggregation returns.
+     *
+     * The `limit()` function defines the number of results an aggregation returns in each
+     * page. Only one page of results is retrieved at a time. The `next()`
+     * function is used to navigate the pages of a query result.
+     *
+     * By default, `limit` is set to `50`.
+     *
+     * The maximum value that `limit()` can accept is `1000`.
+     *
+     * > **Note:** Aggregations can only be used on collections you have created. They cannot be
+     * > used on [Wix App Collections](https://support.wix.com/en/article/cms-formerly-content-manager-working-with-wix-app-collections).
+     * @public
+     * @documentationMaturity preview
+     * @param limitNumber - The number of items or groups to return.
+     * @requiredField limitNumber
+     * @returns A `WixDataAggregate` object representing the refined aggregation.
+     */
+    limit(limitNumber: number): WixDataAggregate;
+    /**
+     * Sets the number of items or groups to skip before returning aggregation results.
+     *
+     * The `skip()` function defines the number of results to skip in the aggregation
+     * results before returning new aggregation results.
+     *
+     * For example, if you perform an aggregation on a collection and 10 groups match
+     * your aggregation, but you set `skip` to 3, the results returned will skip
+     * the first 3 groups that match and return the 4th through 10th items.
+     *
+     * By default, `skip` is set to 0.
+     *
+     * > **Note:** Aggregations can only be used on collections you have created. They cannot be
+     * > used on [Wix App Collections](https://support.wix.com/en/article/cms-formerly-content-manager-working-with-wix-app-collections).
+     * @public
+     * @documentationMaturity preview
+     * @param skipNumber - The number of items or groups to skip in the aggregation results before returning the results.
+     * @requiredField skipNumber
+     * @returns A `WixDataAggregate` object representing the refined aggregation.
+     */
+    skip(skipNumber: number): WixDataAggregate;
+    /**
+     * Adds a sort to a query or sort, sorting by the specified properties in descending order.
+     *
+     * The `descending()` function refines this query to sort in descending order of the specified properties. If you
+     * specify more than one property, descending() sorts the results in descending order by each property in the order
+     * they are listed.
+     *
+     * You can sort the following types:
+     *
+     * Number: Sorts numerically.
+     * - Date: Sorts by date and time.
+     * - String: Sorts lexicographically, so `"abc"` comes before `"XYZ"`.
+     * - Reference: Compares by the ID of the referenced item as a String.
+     *
+     * If a property contains a number as a String, that value will be sorted alphabetically and not numerically. Items
+     * that do not have a value for the specified sort property are ranked lowest.
+     * @public
+     * @documentationMaturity preview
+     * @param fields - The properties used in the sort.
+     * @requiredField fields
+     * @returns An object representing the refined query.
+     */
+    descending(...fields: string[]): WixDataAggregate;
+    descending(fields: string[]): WixDataAggregate;
+    descending(...fields: any): WixDataAggregate;
+    /**
+     * Adds a sort to a query or sort, sorting by the specified properties in ascending order.
+     *
+     * The `ascending()` function refines this query in ascending order of the specified properties. If you specify more
+     * than one property, ascending() sorts the results in ascending order by each property in the order they are listed.
+     *
+     * You can sort the following types:
+     * - Number: Sorts numerically.
+     * - Date: Sorts by date and time.
+     * - String: Sorts lexicographically, so `"abc"` comes after `"XYZ"`.
+     * - Reference: Compares by the ID of the referenced item as a String.
+     *
+     * If a property contains a number as a String, that value will be sorted alphabetically and not numerically.
+     * Items that do not have a value for the specified sort property are ranked lowest.
+     * @public
+     * @documentationMaturity preview
+     * @param fields - The properties used in the sort.
+     * @requiredField fields
+     * @returns An object representing the refined query.
+     */
+    ascending(...fields: string[]): WixDataAggregate;
+    ascending(fields: string[]): WixDataAggregate;
+    ascending(...fields: any): WixDataAggregate;
+    /**
+     * Runs the aggregation and returns the results.
+     *
+     * The `run()` function returns a Promise that resolves to the results found
+     * by the aggregation and some information about the results.
+     *
+     * > **Note:** Aggregations can only be used on collections you have created. They cannot be
+     * > used on [Wix App Collections](https://support.wix.com/en/article/cms-formerly-content-manager-working-with-wix-app-collections).
+     * @public
+     * @documentationMaturity preview
+     * @param options - Options to use when running an aggregation.
+     * @returns A Promise that resolves to the results of the aggregation.
+     */
+    run(options?: WixDataReadOptions): Promise<WixDataResult<Record<string, any>>>;
+}
+//# sourceMappingURL=WixDataAggregate.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"WixDataAggregate.d.ts","sourceRoot":"","sources":["../../../src/api/WixDataAggregate.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAA;AAC/C,OAAO,EAAE,kBAAkB,EAAE,MAAM,SAAS,CAAA;AAC5C,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAA;AAE/C;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC/B;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;IACH,GAAG,CAAC,SAAS,EAAE,MAAM,EAAE,cAAc,CAAC,EAAE,MAAM,GAAG,gBAAgB,CAAA;IAEjE;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;IACH,GAAG,CAAC,SAAS,EAAE,MAAM,EAAE,cAAc,CAAC,EAAE,MAAM,GAAG,gBAAgB,CAAA;IAEjE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAiCG;IACH,GAAG,CAAC,SAAS,EAAE,MAAM,EAAE,cAAc,CAAC,EAAE,MAAM,GAAG,gBAAgB,CAAA;IAEjE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAiCG;IACH,GAAG,CAAC,SAAS,EAAE,MAAM,EAAE,cAAc,CAAC,EAAE,MAAM,GAAG,gBAAgB,CAAA;IAEjE;;;;;;;;;;;;;;;;;OAiBG;IACH,KAAK,CAAC,cAAc,CAAC,EAAE,MAAM,GAAG,gBAAgB,CAAA;IAEhD;;;;;;;;;;;;;;;;;;;OAmBG;IACH,MAAM,CAAC,aAAa,EAAE,aAAa,GAAG,gBAAgB,CAAA;IAEtD;;;;;;;;;;;;;;;;;;;;;;;OAuBG;IACH,KAAK,CAAC,GAAG,SAAS,EAAE,MAAM,EAAE,GAAG,gBAAgB,CAAA;IAE/C;;;;;;;;;;;;;;;;;;;OAmBG;IACH,MAAM,CAAC,aAAa,EAAE,aAAa,GAAG,gBAAgB,CAAA;IAEtD;;;;;;;;;;;;;;;;;;OAkBG;IACH,KAAK,CAAC,WAAW,EAAE,MAAM,GAAG,gBAAgB,CAAA;IAE5C;;;;;;;;;;;;;;;;;;;OAmBG;IACH,IAAI,CAAC,UAAU,EAAE,MAAM,GAAG,gBAAgB,CAAA;IAE1C;;;;;;;;;;;;;;;;;;;;;OAqBG;IACH,UAAU,CAAC,GAAG,MAAM,EAAE,MAAM,EAAE,GAAG,gBAAgB,CAAA;IAEjD,UAAU,CAAC,MAAM,EAAE,MAAM,EAAE,GAAG,gBAAgB,CAAA;IAE9C,UAAU,CAAC,GAAG,MAAM,EAAE,GAAG,GAAG,gBAAgB,CAAA;IAE5C;;;;;;;;;;;;;;;;;;;OAmBG;IACH,SAAS,CAAC,GAAG,MAAM,EAAE,MAAM,EAAE,GAAG,gBAAgB,CAAA;IAEhD,SAAS,CAAC,MAAM,EAAE,MAAM,EAAE,GAAG,gBAAgB,CAAA;IAE7C,SAAS,CAAC,GAAG,MAAM,EAAE,GAAG,GAAG,gBAAgB,CAAA;IAE3C;;;;;;;;;;;;OAYG;IACH,GAAG,CAAC,OAAO,CAAC,EAAE,kBAAkB,GAAG,OAAO,CAAC,aAAa,CAAC,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC,CAAC,CAAA;CAC/E"}