@wix/wix-data-items-common 1.0.52

package/README.md

@@ -0,0 +1,8 @@
+# wix-data-items-common
+
+Library flow package generated with Yoshi.
+
+## Useful URLs
+
+- [Yoshi Library Flow Docs](https://bo.wix.com/pages/yoshi/docs/library-flow/overview)
+- [Falcon Packages Guide Docs](https://dev.wix.com/docs/rnd-general/devex/falcon/guide/packages)

package/dist/cjs/api/ApiClient.js

@@ -0,0 +1,186 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+exports.__esModule = true;
+exports.ApiClient = void 0;
+exports.apiRequestInterceptor = apiRequestInterceptor;
+var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
+var _utils = require("../utils");
+var _errors = require("../errors");
+var _errors2 = require("./errors");
+const SUPPORTS_GET_METHOD = {
+  'com.wixpress.cloud.data.api.data.DataItemService.QueryDataItems': true
+};
+function apiRequestInterceptor(allowGet) {
+  return request => {
+    const preferGet = allowGet && SUPPORTS_GET_METHOD[request.methodFqn ?? ''];
+    const data = (0, _utils.encode)(request.data);
+    if (preferGet) {
+      // https://github.com/wix-private/server-infra/tree/master/framework/grpc/rest#complex-requests-messages-with-get-mappings
+      const url = `${request.url}?.r=${(0, _utils.base64url)(data)}`;
+      if (url.length <= 2048) {
+        return {
+          ...request,
+          method: 'GET',
+          url,
+          data: undefined
+        };
+      }
+    }
+    return {
+      ...request,
+      data
+    };
+  };
+}
+class ApiClient {
+  constructor(clientFactory, allowGet) {
+    (0, _defineProperty2.default)(this, "httpApiClient", void 0);
+    this.httpApiClient = clientFactory(apiRequestInterceptor(allowGet));
+  }
+  async getDataItem(r) {
+    return this.withErrorHandling(async () => {
+      const response = await this.httpApiClient.getDataItem(r);
+      return (0, _utils.decode)(response.data);
+    });
+  }
+  async insertDataItem(r) {
+    return this.withErrorHandling(async () => {
+      const response = await this.httpApiClient.insertDataItem(r);
+      return (0, _utils.decode)(response.data);
+    });
+  }
+  async saveDataItem(r) {
+    return this.withErrorHandling(async () => {
+      const response = await this.httpApiClient.saveDataItem(r);
+      return (0, _utils.decode)(response.data);
+    });
+  }
+  async updateDataItem(r) {
+    return this.withErrorHandling(async () => {
+      const response = await this.httpApiClient.updateDataItem(r);
+      return (0, _utils.decode)(response.data);
+    });
+  }
+  async patchDataItem(r) {
+    return this.withErrorHandling(async () => {
+      const response = await this.httpApiClient.patchDataItem(r);
+      return (0, _utils.decode)(response.data);
+    });
+  }
+  async bulkPatchDataItems(r) {
+    return this.withErrorHandling(async () => {
+      const response = await this.httpApiClient.bulkPatchDataItems(r);
+      return (0, _utils.decode)(response.data);
+    });
+  }
+  async removeDataItem(r) {
+    return this.withErrorHandling(async () => {
+      const response = await this.httpApiClient.removeDataItem(r);
+      return (0, _utils.decode)(response.data);
+    });
+  }
+  async countDataItems(r) {
+    return this.withErrorHandling(async () => {
+      const response = await this.httpApiClient.countDataItems(r);
+      return (0, _utils.decode)(response.data);
+    });
+  }
+  async queryDistinctValues(r) {
+    return this.withErrorHandling(async () => {
+      const response = await this.httpApiClient.queryDistinctValues(r);
+      return (0, _utils.decode)(response.data);
+    });
+  }
+  async queryDataItems(r) {
+    return this.withErrorHandling(async () => {
+      const response = await this.httpApiClient.queryDataItems(r);
+      return (0, _utils.decode)(response.data);
+    });
+  }
+  async aggregateDataItems(r) {
+    return this.withErrorHandling(async () => {
+      const response = await this.httpApiClient.aggregateDataItems(r);
+      return (0, _utils.decode)(response.data);
+    });
+  }
+  async bulkInsertDataItems(r) {
+    return this.withErrorHandling(async () => {
+      const response = await this.httpApiClient.bulkInsertDataItems(r);
+      return (0, _utils.decode)(response.data);
+    });
+  }
+  async bulkUpdateDataItems(r) {
+    return this.withErrorHandling(async () => {
+      const response = await this.httpApiClient.bulkUpdateDataItems(r);
+      return (0, _utils.decode)(response.data);
+    });
+  }
+  async bulkSaveDataItems(r) {
+    return this.withErrorHandling(async () => {
+      const response = await this.httpApiClient.bulkSaveDataItems(r);
+      return (0, _utils.decode)(response.data);
+    });
+  }
+  async bulkRemoveDataItems(r) {
+    return this.withErrorHandling(async () => {
+      const response = await this.httpApiClient.bulkRemoveDataItems(r);
+      return (0, _utils.decode)(response.data);
+    });
+  }
+  async queryReferencedDataItems(r) {
+    return this.withErrorHandling(async () => {
+      const response = await this.httpApiClient.queryReferencedDataItems(r);
+      return (0, _utils.decode)(response.data);
+    });
+  }
+  async bulkInsertDataItemReferences(r) {
+    return this.withErrorHandling(async () => {
+      const response = await this.httpApiClient.bulkInsertDataItemReferences(r);
+      return (0, _utils.decode)(response.data);
+    });
+  }
+  async replaceDataItemReferences(r) {
+    return this.withErrorHandling(async () => {
+      const response = await this.httpApiClient.replaceDataItemReferences(r);
+      return (0, _utils.decode)(response.data);
+    });
+  }
+  async bulkRemoveDataItemReferences(r) {
+    return this.withErrorHandling(async () => {
+      const response = await this.httpApiClient.bulkRemoveDataItemReferences(r);
+      return (0, _utils.decode)(response.data);
+    });
+  }
+  async isReferencedDataItem(r) {
+    return this.withErrorHandling(async () => {
+      const response = await this.httpApiClient.isReferencedDataItem(r);
+      return (0, _utils.decode)(response.data);
+    });
+  }
+  async truncateDataItems(r) {
+    return this.withErrorHandling(async () => {
+      const response = await this.httpApiClient.truncateDataItems(r);
+      return (0, _utils.decode)(response.data);
+    });
+  }
+  async withErrorHandling(call) {
+    try {
+      return await call();
+    } catch (error) {
+      if ((0, _errors2.isHttpError)(error)) {
+        var _error$response, _error$response2;
+        if (((_error$response = error.response) == null ? void 0 : _error$response.status) === 413) {
+          throw (0, _errors.wixDataError)(_errors.messages.payloadIsTooLarge(), 'WDE0109');
+        }
+        const parsedError = (0, _errors2.parseError)((_error$response2 = error.response) == null ? void 0 : _error$response2.data);
+        if (parsedError) {
+          throw parsedError;
+        }
+      }
+      throw (0, _errors.wixDataError)(_errors.messages.internalError('Unknown error.'), _errors.codes.UnknownError);
+    }
+  }
+}
+exports.ApiClient = ApiClient;
+//# sourceMappingURL=ApiClient.js.map

package/dist/cjs/api/ApiClient.js.map

@@ -0,0 +1 @@
+{"version":3,"names":["_utils","require","_errors","_errors2","SUPPORTS_GET_METHOD","apiRequestInterceptor","allowGet","request","preferGet","methodFqn","data","serializeDates","url","base64url","length","method","undefined","ApiClient","constructor","clientFactory","_defineProperty2","default","httpApiClient","getDataItem","r","withErrorHandling","response","parseDates","insertDataItem","saveDataItem","updateDataItem","patchDataItem","bulkPatchDataItems","removeDataItem","countDataItems","queryDistinctValues","queryDataItems","aggregateDataItems","bulkInsertDataItems","bulkUpdateDataItems","bulkSaveDataItems","bulkRemoveDataItems","queryReferencedDataItems","bulkInsertDataItemReferences","replaceDataItemReferences","bulkRemoveDataItemReferences","isReferencedDataItem","truncateDataItems","call","error","isHttpError","_error$response","_error$response2","status","wixDataError","messages","payloadIsTooLarge","parsedError","parseError","internalError","codes","UnknownError","exports"],"sources":["../../../src/api/ApiClient.ts"],"sourcesContent":["import type {\n  HttpApiClient,\n  RequestInterceptor,\n  Request,\n  HttpApiClientFactory,\n} from '../types/api'\nimport {\n  decode as parseDates,\n  encode as serializeDates,\n  base64url,\n} from '../utils'\nimport { messages, wixDataError, codes } from '../errors'\n\nimport { isHttpError, parseError } from './errors'\nimport {\n  AggregateDataItemsRequest,\n  AggregateDataItemsResponse,\n  BulkInsertDataItemReferencesRequest,\n  BulkInsertDataItemReferencesResponse,\n  BulkInsertDataItemsRequest,\n  BulkInsertDataItemsResponse,\n  BulkPatchDataItemsRequest,\n  BulkPatchDataItemsResponse,\n  BulkRemoveDataItemReferencesRequest,\n  BulkRemoveDataItemReferencesResponse,\n  BulkRemoveDataItemsRequest,\n  BulkRemoveDataItemsResponse,\n  BulkSaveDataItemsRequest,\n  BulkSaveDataItemsResponse,\n  BulkUpdateDataItemsRequest,\n  BulkUpdateDataItemsResponse,\n  CountDataItemsRequest,\n  CountDataItemsResponse,\n  GetDataItemRequest,\n  GetDataItemResponse,\n  InsertDataItemRequest,\n  InsertDataItemResponse,\n  IsReferencedDataItemRequest,\n  IsReferencedDataItemResponse,\n  PatchDataItemRequest,\n  PatchDataItemResponse,\n  QueryDataItemsRequest,\n  QueryDataItemsResponse,\n  QueryDistinctValuesRequest,\n  QueryDistinctValuesResponse,\n  QueryReferencedDataItemsRequest,\n  QueryReferencedDataItemsResponse,\n  RemoveDataItemRequest,\n  RemoveDataItemResponse,\n  ReplaceDataItemReferencesRequest,\n  ReplaceDataItemReferencesResponse,\n  SaveDataItemRequest,\n  SaveDataItemResponse,\n  TruncateDataItemsRequest,\n  TruncateDataItemsResponse,\n  UpdateDataItemRequest,\n  UpdateDataItemResponse,\n} from '../types/data-item-types'\n\nconst SUPPORTS_GET_METHOD: Record<string, boolean> = {\n  'com.wixpress.cloud.data.api.data.DataItemService.QueryDataItems': true,\n}\n\nexport function apiRequestInterceptor<R extends Request>(\n  allowGet: boolean\n): RequestInterceptor<R> {\n  return (request) => {\n    const preferGet = allowGet && SUPPORTS_GET_METHOD[request.methodFqn ?? '']\n    const data = serializeDates(request.data)\n    if (preferGet) {\n      // https://github.com/wix-private/server-infra/tree/master/framework/grpc/rest#complex-requests-messages-with-get-mappings\n      const url = `${request.url}?.r=${base64url(data)}`\n      if (url.length <= 2048) {\n        return {\n          ...request,\n          method: 'GET',\n          url,\n          data: undefined,\n        }\n      }\n    }\n    return { ...request, data }\n  }\n}\n\nexport class ApiClient {\n  private httpApiClient: HttpApiClient\n\n  constructor(clientFactory: HttpApiClientFactory<any>, allowGet: boolean) {\n    this.httpApiClient = clientFactory(apiRequestInterceptor(allowGet))\n  }\n\n  async getDataItem(r: GetDataItemRequest): Promise<GetDataItemResponse> {\n    return this.withErrorHandling(async () => {\n      const response = await this.httpApiClient.getDataItem(r)\n      return parseDates(response.data)\n    })\n  }\n\n  async insertDataItem(\n    r: InsertDataItemRequest\n  ): Promise<InsertDataItemResponse> {\n    return this.withErrorHandling(async () => {\n      const response = await this.httpApiClient.insertDataItem(r)\n      return parseDates(response.data)\n    })\n  }\n\n  async saveDataItem(r: SaveDataItemRequest): Promise<SaveDataItemResponse> {\n    return this.withErrorHandling(async () => {\n      const response = await this.httpApiClient.saveDataItem(r)\n      return parseDates(response.data)\n    })\n  }\n\n  async updateDataItem(\n    r: UpdateDataItemRequest\n  ): Promise<UpdateDataItemResponse> {\n    return this.withErrorHandling(async () => {\n      const response = await this.httpApiClient.updateDataItem(r)\n      return parseDates(response.data)\n    })\n  }\n\n  async patchDataItem(r: PatchDataItemRequest): Promise<PatchDataItemResponse> {\n    return this.withErrorHandling(async () => {\n      const response = await this.httpApiClient.patchDataItem(r)\n      return parseDates(response.data)\n    })\n  }\n\n  async bulkPatchDataItems(\n    r: BulkPatchDataItemsRequest\n  ): Promise<BulkPatchDataItemsResponse> {\n    return this.withErrorHandling(async () => {\n      const response = await this.httpApiClient.bulkPatchDataItems(r)\n      return parseDates(response.data)\n    })\n  }\n\n  async removeDataItem(\n    r: RemoveDataItemRequest\n  ): Promise<RemoveDataItemResponse> {\n    return this.withErrorHandling(async () => {\n      const response = await this.httpApiClient.removeDataItem(r)\n      return parseDates(response.data)\n    })\n  }\n\n  async countDataItems(\n    r: CountDataItemsRequest\n  ): Promise<CountDataItemsResponse> {\n    return this.withErrorHandling(async () => {\n      const response = await this.httpApiClient.countDataItems(r)\n      return parseDates(response.data)\n    })\n  }\n\n  async queryDistinctValues(\n    r: QueryDistinctValuesRequest\n  ): Promise<QueryDistinctValuesResponse> {\n    return this.withErrorHandling(async () => {\n      const response = await this.httpApiClient.queryDistinctValues(r)\n      return parseDates(response.data)\n    })\n  }\n\n  async queryDataItems(\n    r: QueryDataItemsRequest\n  ): Promise<QueryDataItemsResponse> {\n    return this.withErrorHandling(async () => {\n      const response = await this.httpApiClient.queryDataItems(r)\n      return parseDates(response.data)\n    })\n  }\n\n  async aggregateDataItems(\n    r: AggregateDataItemsRequest\n  ): Promise<AggregateDataItemsResponse> {\n    return this.withErrorHandling(async () => {\n      const response = await this.httpApiClient.aggregateDataItems(r)\n      return parseDates(response.data)\n    })\n  }\n\n  async bulkInsertDataItems(\n    r: BulkInsertDataItemsRequest\n  ): Promise<BulkInsertDataItemsResponse> {\n    return this.withErrorHandling(async () => {\n      const response = await this.httpApiClient.bulkInsertDataItems(r)\n      return parseDates(response.data)\n    })\n  }\n\n  async bulkUpdateDataItems(\n    r: BulkUpdateDataItemsRequest\n  ): Promise<BulkUpdateDataItemsResponse> {\n    return this.withErrorHandling(async () => {\n      const response = await this.httpApiClient.bulkUpdateDataItems(r)\n      return parseDates(response.data)\n    })\n  }\n\n  async bulkSaveDataItems(\n    r: BulkSaveDataItemsRequest\n  ): Promise<BulkSaveDataItemsResponse> {\n    return this.withErrorHandling(async () => {\n      const response = await this.httpApiClient.bulkSaveDataItems(r)\n      return parseDates(response.data)\n    })\n  }\n\n  async bulkRemoveDataItems(\n    r: BulkRemoveDataItemsRequest\n  ): Promise<BulkRemoveDataItemsResponse> {\n    return this.withErrorHandling(async () => {\n      const response = await this.httpApiClient.bulkRemoveDataItems(r)\n      return parseDates(response.data)\n    })\n  }\n\n  async queryReferencedDataItems(\n    r: QueryReferencedDataItemsRequest\n  ): Promise<QueryReferencedDataItemsResponse> {\n    return this.withErrorHandling(async () => {\n      const response = await this.httpApiClient.queryReferencedDataItems(r)\n      return parseDates(response.data)\n    })\n  }\n\n  async bulkInsertDataItemReferences(\n    r: BulkInsertDataItemReferencesRequest\n  ): Promise<BulkInsertDataItemReferencesResponse> {\n    return this.withErrorHandling(async () => {\n      const response = await this.httpApiClient.bulkInsertDataItemReferences(r)\n      return parseDates(response.data)\n    })\n  }\n\n  async replaceDataItemReferences(\n    r: ReplaceDataItemReferencesRequest\n  ): Promise<ReplaceDataItemReferencesResponse> {\n    return this.withErrorHandling(async () => {\n      const response = await this.httpApiClient.replaceDataItemReferences(r)\n      return parseDates(response.data)\n    })\n  }\n\n  async bulkRemoveDataItemReferences(\n    r: BulkRemoveDataItemReferencesRequest\n  ): Promise<BulkRemoveDataItemReferencesResponse> {\n    return this.withErrorHandling(async () => {\n      const response = await this.httpApiClient.bulkRemoveDataItemReferences(r)\n      return parseDates(response.data)\n    })\n  }\n\n  async isReferencedDataItem(\n    r: IsReferencedDataItemRequest\n  ): Promise<IsReferencedDataItemResponse> {\n    return this.withErrorHandling(async () => {\n      const response = await this.httpApiClient.isReferencedDataItem(r)\n      return parseDates(response.data)\n    })\n  }\n\n  async truncateDataItems(\n    r: TruncateDataItemsRequest\n  ): Promise<TruncateDataItemsResponse> {\n    return this.withErrorHandling(async () => {\n      const response = await this.httpApiClient.truncateDataItems(r)\n      return parseDates(response.data)\n    })\n  }\n\n  private async withErrorHandling<T>(call: () => T): Promise<T> {\n    try {\n      return await call()\n    } catch (error: unknown) {\n      if (isHttpError(error)) {\n        if (error.response?.status === 413) {\n          throw wixDataError(messages.payloadIsTooLarge(), 'WDE0109')\n        }\n        const parsedError = parseError(error.response?.data)\n        if (parsedError) {\n          throw parsedError\n        }\n      }\n      throw wixDataError(\n        messages.internalError('Unknown error.'),\n        codes.UnknownError\n      )\n    }\n  }\n}\n"],"mappings":";;;;;;;AAMA,IAAAA,MAAA,GAAAC,OAAA;AAKA,IAAAC,OAAA,GAAAD,OAAA;AAEA,IAAAE,QAAA,GAAAF,OAAA;AA8CA,MAAMG,mBAA4C,GAAG;EACnD,iEAAiE,EAAE;AACrE,CAAC;AAEM,SAASC,qBAAqBA,CACnCC,QAAiB,EACM;EACvB,OAAQC,OAAO,IAAK;IAClB,MAAMC,SAAS,GAAGF,QAAQ,IAAIF,mBAAmB,CAACG,OAAO,CAACE,SAAS,IAAI,EAAE,CAAC;IAC1E,MAAMC,IAAI,GAAG,IAAAC,aAAc,EAACJ,OAAO,CAACG,IAAI,CAAC;IACzC,IAAIF,SAAS,EAAE;MACb;MACA,MAAMI,GAAG,GAAI,GAAEL,OAAO,CAACK,GAAI,OAAM,IAAAC,gBAAS,EAACH,IAAI,CAAE,EAAC;MAClD,IAAIE,GAAG,CAACE,MAAM,IAAI,IAAI,EAAE;QACtB,OAAO;UACL,GAAGP,OAAO;UACVQ,MAAM,EAAE,KAAK;UACbH,GAAG;UACHF,IAAI,EAAEM;QACR,CAAC;MACH;IACF;IACA,OAAO;MAAE,GAAGT,OAAO;MAAEG;IAAK,CAAC;EAC7B,CAAC;AACH;AAEO,MAAMO,SAAS,CAAC;EAGrBC,WAAWA,CAACC,aAAwC,EAAEb,QAAiB,EAAE;IAAA,IAAAc,gBAAA,CAAAC,OAAA;IACvE,IAAI,CAACC,aAAa,GAAGH,aAAa,CAACd,qBAAqB,CAACC,QAAQ,CAAC,CAAC;EACrE;EAEA,MAAMiB,WAAWA,CAACC,CAAqB,EAAgC;IACrE,OAAO,IAAI,CAACC,iBAAiB,CAAC,YAAY;MACxC,MAAMC,QAAQ,GAAG,MAAM,IAAI,CAACJ,aAAa,CAACC,WAAW,CAACC,CAAC,CAAC;MACxD,OAAO,IAAAG,aAAU,EAACD,QAAQ,CAAChB,IAAI,CAAC;IAClC,CAAC,CAAC;EACJ;EAEA,MAAMkB,cAAcA,CAClBJ,CAAwB,EACS;IACjC,OAAO,IAAI,CAACC,iBAAiB,CAAC,YAAY;MACxC,MAAMC,QAAQ,GAAG,MAAM,IAAI,CAACJ,aAAa,CAACM,cAAc,CAACJ,CAAC,CAAC;MAC3D,OAAO,IAAAG,aAAU,EAACD,QAAQ,CAAChB,IAAI,CAAC;IAClC,CAAC,CAAC;EACJ;EAEA,MAAMmB,YAAYA,CAACL,CAAsB,EAAiC;IACxE,OAAO,IAAI,CAACC,iBAAiB,CAAC,YAAY;MACxC,MAAMC,QAAQ,GAAG,MAAM,IAAI,CAACJ,aAAa,CAACO,YAAY,CAACL,CAAC,CAAC;MACzD,OAAO,IAAAG,aAAU,EAACD,QAAQ,CAAChB,IAAI,CAAC;IAClC,CAAC,CAAC;EACJ;EAEA,MAAMoB,cAAcA,CAClBN,CAAwB,EACS;IACjC,OAAO,IAAI,CAACC,iBAAiB,CAAC,YAAY;MACxC,MAAMC,QAAQ,GAAG,MAAM,IAAI,CAACJ,aAAa,CAACQ,cAAc,CAACN,CAAC,CAAC;MAC3D,OAAO,IAAAG,aAAU,EAACD,QAAQ,CAAChB,IAAI,CAAC;IAClC,CAAC,CAAC;EACJ;EAEA,MAAMqB,aAAaA,CAACP,CAAuB,EAAkC;IAC3E,OAAO,IAAI,CAACC,iBAAiB,CAAC,YAAY;MACxC,MAAMC,QAAQ,GAAG,MAAM,IAAI,CAACJ,aAAa,CAACS,aAAa,CAACP,CAAC,CAAC;MAC1D,OAAO,IAAAG,aAAU,EAACD,QAAQ,CAAChB,IAAI,CAAC;IAClC,CAAC,CAAC;EACJ;EAEA,MAAMsB,kBAAkBA,CACtBR,CAA4B,EACS;IACrC,OAAO,IAAI,CAACC,iBAAiB,CAAC,YAAY;MACxC,MAAMC,QAAQ,GAAG,MAAM,IAAI,CAACJ,aAAa,CAACU,kBAAkB,CAACR,CAAC,CAAC;MAC/D,OAAO,IAAAG,aAAU,EAACD,QAAQ,CAAChB,IAAI,CAAC;IAClC,CAAC,CAAC;EACJ;EAEA,MAAMuB,cAAcA,CAClBT,CAAwB,EACS;IACjC,OAAO,IAAI,CAACC,iBAAiB,CAAC,YAAY;MACxC,MAAMC,QAAQ,GAAG,MAAM,IAAI,CAACJ,aAAa,CAACW,cAAc,CAACT,CAAC,CAAC;MAC3D,OAAO,IAAAG,aAAU,EAACD,QAAQ,CAAChB,IAAI,CAAC;IAClC,CAAC,CAAC;EACJ;EAEA,MAAMwB,cAAcA,CAClBV,CAAwB,EACS;IACjC,OAAO,IAAI,CAACC,iBAAiB,CAAC,YAAY;MACxC,MAAMC,QAAQ,GAAG,MAAM,IAAI,CAACJ,aAAa,CAACY,cAAc,CAACV,CAAC,CAAC;MAC3D,OAAO,IAAAG,aAAU,EAACD,QAAQ,CAAChB,IAAI,CAAC;IAClC,CAAC,CAAC;EACJ;EAEA,MAAMyB,mBAAmBA,CACvBX,CAA6B,EACS;IACtC,OAAO,IAAI,CAACC,iBAAiB,CAAC,YAAY;MACxC,MAAMC,QAAQ,GAAG,MAAM,IAAI,CAACJ,aAAa,CAACa,mBAAmB,CAACX,CAAC,CAAC;MAChE,OAAO,IAAAG,aAAU,EAACD,QAAQ,CAAChB,IAAI,CAAC;IAClC,CAAC,CAAC;EACJ;EAEA,MAAM0B,cAAcA,CAClBZ,CAAwB,EACS;IACjC,OAAO,IAAI,CAACC,iBAAiB,CAAC,YAAY;MACxC,MAAMC,QAAQ,GAAG,MAAM,IAAI,CAACJ,aAAa,CAACc,cAAc,CAACZ,CAAC,CAAC;MAC3D,OAAO,IAAAG,aAAU,EAACD,QAAQ,CAAChB,IAAI,CAAC;IAClC,CAAC,CAAC;EACJ;EAEA,MAAM2B,kBAAkBA,CACtBb,CAA4B,EACS;IACrC,OAAO,IAAI,CAACC,iBAAiB,CAAC,YAAY;MACxC,MAAMC,QAAQ,GAAG,MAAM,IAAI,CAACJ,aAAa,CAACe,kBAAkB,CAACb,CAAC,CAAC;MAC/D,OAAO,IAAAG,aAAU,EAACD,QAAQ,CAAChB,IAAI,CAAC;IAClC,CAAC,CAAC;EACJ;EAEA,MAAM4B,mBAAmBA,CACvBd,CAA6B,EACS;IACtC,OAAO,IAAI,CAACC,iBAAiB,CAAC,YAAY;MACxC,MAAMC,QAAQ,GAAG,MAAM,IAAI,CAACJ,aAAa,CAACgB,mBAAmB,CAACd,CAAC,CAAC;MAChE,OAAO,IAAAG,aAAU,EAACD,QAAQ,CAAChB,IAAI,CAAC;IAClC,CAAC,CAAC;EACJ;EAEA,MAAM6B,mBAAmBA,CACvBf,CAA6B,EACS;IACtC,OAAO,IAAI,CAACC,iBAAiB,CAAC,YAAY;MACxC,MAAMC,QAAQ,GAAG,MAAM,IAAI,CAACJ,aAAa,CAACiB,mBAAmB,CAACf,CAAC,CAAC;MAChE,OAAO,IAAAG,aAAU,EAACD,QAAQ,CAAChB,IAAI,CAAC;IAClC,CAAC,CAAC;EACJ;EAEA,MAAM8B,iBAAiBA,CACrBhB,CAA2B,EACS;IACpC,OAAO,IAAI,CAACC,iBAAiB,CAAC,YAAY;MACxC,MAAMC,QAAQ,GAAG,MAAM,IAAI,CAACJ,aAAa,CAACkB,iBAAiB,CAAChB,CAAC,CAAC;MAC9D,OAAO,IAAAG,aAAU,EAACD,QAAQ,CAAChB,IAAI,CAAC;IAClC,CAAC,CAAC;EACJ;EAEA,MAAM+B,mBAAmBA,CACvBjB,CAA6B,EACS;IACtC,OAAO,IAAI,CAACC,iBAAiB,CAAC,YAAY;MACxC,MAAMC,QAAQ,GAAG,MAAM,IAAI,CAACJ,aAAa,CAACmB,mBAAmB,CAACjB,CAAC,CAAC;MAChE,OAAO,IAAAG,aAAU,EAACD,QAAQ,CAAChB,IAAI,CAAC;IAClC,CAAC,CAAC;EACJ;EAEA,MAAMgC,wBAAwBA,CAC5BlB,CAAkC,EACS;IAC3C,OAAO,IAAI,CAACC,iBAAiB,CAAC,YAAY;MACxC,MAAMC,QAAQ,GAAG,MAAM,IAAI,CAACJ,aAAa,CAACoB,wBAAwB,CAAClB,CAAC,CAAC;MACrE,OAAO,IAAAG,aAAU,EAACD,QAAQ,CAAChB,IAAI,CAAC;IAClC,CAAC,CAAC;EACJ;EAEA,MAAMiC,4BAA4BA,CAChCnB,CAAsC,EACS;IAC/C,OAAO,IAAI,CAACC,iBAAiB,CAAC,YAAY;MACxC,MAAMC,QAAQ,GAAG,MAAM,IAAI,CAACJ,aAAa,CAACqB,4BAA4B,CAACnB,CAAC,CAAC;MACzE,OAAO,IAAAG,aAAU,EAACD,QAAQ,CAAChB,IAAI,CAAC;IAClC,CAAC,CAAC;EACJ;EAEA,MAAMkC,yBAAyBA,CAC7BpB,CAAmC,EACS;IAC5C,OAAO,IAAI,CAACC,iBAAiB,CAAC,YAAY;MACxC,MAAMC,QAAQ,GAAG,MAAM,IAAI,CAACJ,aAAa,CAACsB,yBAAyB,CAACpB,CAAC,CAAC;MACtE,OAAO,IAAAG,aAAU,EAACD,QAAQ,CAAChB,IAAI,CAAC;IAClC,CAAC,CAAC;EACJ;EAEA,MAAMmC,4BAA4BA,CAChCrB,CAAsC,EACS;IAC/C,OAAO,IAAI,CAACC,iBAAiB,CAAC,YAAY;MACxC,MAAMC,QAAQ,GAAG,MAAM,IAAI,CAACJ,aAAa,CAACuB,4BAA4B,CAACrB,CAAC,CAAC;MACzE,OAAO,IAAAG,aAAU,EAACD,QAAQ,CAAChB,IAAI,CAAC;IAClC,CAAC,CAAC;EACJ;EAEA,MAAMoC,oBAAoBA,CACxBtB,CAA8B,EACS;IACvC,OAAO,IAAI,CAACC,iBAAiB,CAAC,YAAY;MACxC,MAAMC,QAAQ,GAAG,MAAM,IAAI,CAACJ,aAAa,CAACwB,oBAAoB,CAACtB,CAAC,CAAC;MACjE,OAAO,IAAAG,aAAU,EAACD,QAAQ,CAAChB,IAAI,CAAC;IAClC,CAAC,CAAC;EACJ;EAEA,MAAMqC,iBAAiBA,CACrBvB,CAA2B,EACS;IACpC,OAAO,IAAI,CAACC,iBAAiB,CAAC,YAAY;MACxC,MAAMC,QAAQ,GAAG,MAAM,IAAI,CAACJ,aAAa,CAACyB,iBAAiB,CAACvB,CAAC,CAAC;MAC9D,OAAO,IAAAG,aAAU,EAACD,QAAQ,CAAChB,IAAI,CAAC;IAClC,CAAC,CAAC;EACJ;EAEA,MAAce,iBAAiBA,CAAIuB,IAAa,EAAc;IAC5D,IAAI;MACF,OAAO,MAAMA,IAAI,CAAC,CAAC;IACrB,CAAC,CAAC,OAAOC,KAAc,EAAE;MACvB,IAAI,IAAAC,oBAAW,EAACD,KAAK,CAAC,EAAE;QAAA,IAAAE,eAAA,EAAAC,gBAAA;QACtB,IAAI,EAAAD,eAAA,GAAAF,KAAK,CAACvB,QAAQ,qBAAdyB,eAAA,CAAgBE,MAAM,MAAK,GAAG,EAAE;UAClC,MAAM,IAAAC,oBAAY,EAACC,gBAAQ,CAACC,iBAAiB,CAAC,CAAC,EAAE,SAAS,CAAC;QAC7D;QACA,MAAMC,WAAW,GAAG,IAAAC,mBAAU,GAAAN,gBAAA,GAACH,KAAK,CAACvB,QAAQ,qBAAd0B,gBAAA,CAAgB1C,IAAI,CAAC;QACpD,IAAI+C,WAAW,EAAE;UACf,MAAMA,WAAW;QACnB;MACF;MACA,MAAM,IAAAH,oBAAY,EAChBC,gBAAQ,CAACI,aAAa,CAAC,gBAAgB,CAAC,EACxCC,aAAK,CAACC,YACR,CAAC;IACH;EACF;AACF;AAACC,OAAA,CAAA7C,SAAA,GAAAA,SAAA"}

package/dist/cjs/api/QueryBase.js

@@ -0,0 +1,200 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+exports.__esModule = true;
+exports.QueryBase = void 0;
+var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
+var _filter = require("../filter");
+var _sortMixin = require("../sort/sortMixin");
+var _common = require("./common");
+class QueryBase {
+  constructor(origin) {
+    /**
+     * @internal
+     */
+    (0, _defineProperty2.default)(this, "filterBuilder", void 0);
+    /**
+     * @internal
+     */
+    (0, _defineProperty2.default)(this, "sort", void 0);
+    /**
+     * @internal
+     */
+    (0, _defineProperty2.default)(this, "collectionName", void 0);
+    // filterMethod: WithFilter<Self>['filterMethod'] allows keeping type signature while capturing
+    // all args as an array
+    (0, _defineProperty2.default)(this, "eq", (...args) => {
+      return this.withFilter('eq', args);
+    });
+    (0, _defineProperty2.default)(this, "ne", (...args) => {
+      return this.withFilter('ne', args);
+    });
+    (0, _defineProperty2.default)(this, "ge", (...args) => {
+      return this.withFilter('ge', args);
+    });
+    (0, _defineProperty2.default)(this, "gt", (...args) => {
+      return this.withFilter('gt', args);
+    });
+    (0, _defineProperty2.default)(this, "gte", (...args) => {
+      return this.withFilter('gte', args);
+    });
+    (0, _defineProperty2.default)(this, "le", (...args) => {
+      return this.withFilter('le', args);
+    });
+    (0, _defineProperty2.default)(this, "lt", (...args) => {
+      return this.withFilter('lt', args);
+    });
+    (0, _defineProperty2.default)(this, "lte", (...args) => {
+      return this.withFilter('lte', args);
+    });
+    (0, _defineProperty2.default)(this, "isNotEmpty", (...args) => {
+      return this.withFilter('isNotEmpty', args);
+    });
+    (0, _defineProperty2.default)(this, "isEmpty", (...args) => {
+      return this.withFilter('isEmpty', args);
+    });
+    (0, _defineProperty2.default)(this, "startsWith", (...args) => {
+      return this.withFilter('startsWith', args);
+    });
+    (0, _defineProperty2.default)(this, "endsWith", (...args) => {
+      return this.withFilter('endsWith', args);
+    });
+    (0, _defineProperty2.default)(this, "contains", (...args) => {
+      return this.withFilter('contains', args);
+    });
+    (0, _defineProperty2.default)(this, "hasSome", (...args) => {
+      return this.withFilter('hasSome', args);
+    });
+    (0, _defineProperty2.default)(this, "in", (...args) => {
+      return this.withFilter('in', args);
+    });
+    (0, _defineProperty2.default)(this, "hasAll", (...args) => {
+      return this.withFilter('hasAll', args);
+    });
+    (0, _defineProperty2.default)(this, "exists", (...args) => {
+      return this.withFilter('exists', args);
+    });
+    (0, _defineProperty2.default)(this, "or", (...args) => {
+      // @ts-expect-error
+      return this.withFilter('or', args.map(this.extractFilter));
+    });
+    (0, _defineProperty2.default)(this, "and", (...args) => {
+      // @ts-expect-error
+      return this.withFilter('and', args.map(this.extractFilter));
+    });
+    (0, _defineProperty2.default)(this, "not", (...args) => {
+      // @ts-expect-error
+      return this.withFilter('not', args.map(this.extractFilter));
+    });
+    (0, _defineProperty2.default)(this, "between", (...args) => {
+      return this.withFilter('between', args);
+    });
+    this.collectionName = origin.collectionName;
+    this.filterBuilder = (origin == null ? void 0 : origin.filterBuilder) ?? (0, _common.filterBuilder)({
+      filterTree: {}
+    });
+    this.sort = (origin == null ? void 0 : origin.sort) ?? new _sortMixin.Sort();
+  }
+
+  /**
+   * @internal
+   */
+
+  // --- filter ---
+
+  get filterTree() {
+    return this.filterBuilder.filterTree;
+  }
+
+  /**
+   * @internal
+   */
+  setFilterModel(filterTree) {
+    const filter = (0, _common.filterBuilder)({
+      filterTree,
+      invalidArguments: (0, _filter.validateFilterTree)(filterTree)
+    });
+    return this.copy({
+      filterBuilder: filter
+    });
+  }
+
+  /**
+   * @internal
+   */
+  getFilterModel() {
+    return this.filterBuilder.build();
+  }
+  withFilter(filter, args) {
+    return this.copy({
+      filterBuilder: this.filterBuilder[filter].apply(this.filterBuilder, args)
+    });
+  }
+  extractFilter(value) {
+    return value != null && value.filterBuilder ? value.filterBuilder : value;
+  }
+
+  // --- sort ---
+
+  get orderBy() {
+    return this.sort.orderBy;
+  }
+
+  /**
+   * 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) {
+    return this.copy({
+      sort: this.sort.ascending(...fields)
+    });
+  }
+
+  /**
+   * 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) {
+    return this.copy({
+      sort: this.sort.descending(...fields)
+    });
+  }
+}
+exports.QueryBase = QueryBase;
+//# sourceMappingURL=QueryBase.js.map

package/dist/cjs/api/QueryBase.js.map

@@ -0,0 +1 @@
+{"version":3,"names":["_filter","require","_sortMixin","_common","QueryBase","constructor","origin","_defineProperty2","default","args","withFilter","map","extractFilter","collectionName","filterBuilder","filterTree","sort","Sort","setFilterModel","filter","invalidArguments","validateFilterTree","copy","getFilterModel","build","apply","value","orderBy","ascending","fields","descending","exports"],"sources":["../../../src/api/QueryBase.ts"],"sourcesContent":["import {\n  WithFilter,\n  PlatformizedFilterBuilder,\n  validateFilterTree,\n  FilterTree,\n} from '../filter'\nimport { Sort } from '../sort/sortMixin'\nimport { filterBuilder } from './common'\n\nexport abstract class QueryBase<Self extends WithFilter<Self>>\n  implements WithFilter<Self>\n{\n  /**\n   * @internal\n   */\n  protected readonly filterBuilder: PlatformizedFilterBuilder\n\n  /**\n   * @internal\n   */\n  protected readonly sort: Sort\n\n  /**\n   * @internal\n   */\n  readonly collectionName: string\n\n  protected constructor(origin: {\n    collectionName: string\n    filterBuilder?: PlatformizedFilterBuilder\n    sort?: Sort\n  }) {\n    this.collectionName = origin.collectionName\n    this.filterBuilder =\n      origin?.filterBuilder ?? filterBuilder({ filterTree: {} })\n    this.sort = origin?.sort ?? new Sort()\n  }\n\n  /**\n   * @internal\n   */\n  protected abstract copy(params: {\n    filterBuilder?: PlatformizedFilterBuilder\n    sort?: Sort\n  }): Self\n\n  // --- filter ---\n\n  abstract get invalidArguments(): string[]\n\n  get filterTree(): Record<string, any> {\n    return this.filterBuilder.filterTree\n  }\n\n  /**\n   * @internal\n   */\n  setFilterModel(filterTree: Record<string, any>): Self {\n    const filter = filterBuilder({\n      filterTree,\n      invalidArguments: validateFilterTree(filterTree),\n    })\n    return this.copy({ filterBuilder: filter })\n  }\n\n  /**\n   * @internal\n   */\n  getFilterModel(): FilterTree {\n    return this.filterBuilder.build()\n  }\n\n  private withFilter<F extends keyof PlatformizedFilterBuilder>(\n    filter: F,\n    args: Parameters<PlatformizedFilterBuilder[F]>\n  ): Self {\n    return this.copy({\n      filterBuilder: this.filterBuilder[filter].apply(this.filterBuilder, args),\n    })\n  }\n\n  // filterMethod: WithFilter<Self>['filterMethod'] allows keeping type signature while capturing\n  // all args as an array\n\n  eq: WithFilter<Self>['eq'] = (...args) => {\n    return this.withFilter('eq', args)\n  }\n  ne: WithFilter<Self>['ne'] = (...args) => {\n    return this.withFilter('ne', args)\n  }\n  ge: WithFilter<Self>['ge'] = (...args) => {\n    return this.withFilter('ge', args)\n  }\n  gt: WithFilter<Self>['gt'] = (...args) => {\n    return this.withFilter('gt', args)\n  }\n  gte: WithFilter<Self>['gte'] = (...args) => {\n    return this.withFilter('gte', args)\n  }\n  le: WithFilter<Self>['le'] = (...args) => {\n    return this.withFilter('le', args)\n  }\n  lt: WithFilter<Self>['lt'] = (...args) => {\n    return this.withFilter('lt', args)\n  }\n  lte: WithFilter<Self>['lte'] = (...args) => {\n    return this.withFilter('lte', args)\n  }\n  isNotEmpty: WithFilter<Self>['isNotEmpty'] = (...args) => {\n    return this.withFilter('isNotEmpty', args)\n  }\n  isEmpty: WithFilter<Self>['isEmpty'] = (...args) => {\n    return this.withFilter('isEmpty', args)\n  }\n  startsWith: WithFilter<Self>['startsWith'] = (...args) => {\n    return this.withFilter('startsWith', args)\n  }\n  endsWith: WithFilter<Self>['endsWith'] = (...args) => {\n    return this.withFilter('endsWith', args)\n  }\n  contains: WithFilter<Self>['contains'] = (...args) => {\n    return this.withFilter('contains', args)\n  }\n  hasSome: WithFilter<Self>['hasSome'] = (...args) => {\n    return this.withFilter('hasSome', args)\n  };\n  in: WithFilter<Self>['in'] = (...args) => {\n    return this.withFilter('in', args)\n  }\n  hasAll: WithFilter<Self>['hasAll'] = (...args) => {\n    return this.withFilter('hasAll', args)\n  }\n  exists: WithFilter<Self>['exists'] = (...args) => {\n    return this.withFilter('exists', args)\n  }\n  or: WithFilter<Self>['or'] = (...args) => {\n    // @ts-expect-error\n    return this.withFilter('or', args.map(this.extractFilter))\n  }\n  and: WithFilter<Self>['and'] = (...args) => {\n    // @ts-expect-error\n    return this.withFilter('and', args.map(this.extractFilter))\n  }\n  not: WithFilter<Self>['not'] = (...args) => {\n    // @ts-expect-error\n    return this.withFilter('not', args.map(this.extractFilter))\n  }\n  between: WithFilter<Self>['between'] = (...args) => {\n    return this.withFilter('between', args)\n  }\n\n  private extractFilter(value: any): any {\n    return value?.filterBuilder ? value.filterBuilder : value\n  }\n\n  // --- sort ---\n\n  get orderBy(): { [field: string]: 'asc' | 'desc' }[] {\n    return this.sort.orderBy\n  }\n\n  /**\n   * Adds a sort to a query or sort, sorting by the specified properties in ascending order.\n   *\n   * The `ascending()` function refines this query in ascending order of the specified properties. If you specify more\n   * than one property, ascending() sorts the results in ascending order by each property in the order they are listed.\n   *\n   * You can sort the following types:\n   * - Number: Sorts numerically.\n   * - Date: Sorts by date and time.\n   * - String: Sorts lexicographically, so `\"abc\"` comes after `\"XYZ\"`.\n   * - Reference: Compares by the ID of the referenced item as a String.\n   *\n   * If a property contains a number as a String, that value will be sorted alphabetically and not numerically.\n   * Items that do not have a value for the specified sort property are ranked lowest.\n   * @public\n   * @documentationMaturity preview\n   * @param fields - The properties used in the sort.\n   * @requiredField fields\n   * @returns An object representing the refined query.\n   */\n  ascending(...fields: string[]): Self\n  ascending(fields: string[]): Self\n\n  ascending(...fields: any) {\n    return this.copy({ sort: this.sort.ascending(...fields) })\n  }\n\n  /**\n   * Adds a sort to a query or sort, sorting by the specified properties in descending order.\n   *\n   * The `descending()` function refines this query to sort in descending order of the specified properties. If you\n   * specify more than one property, descending() sorts the results in descending order by each property in the order\n   * they are listed.\n   *\n   * You can sort the following types:\n   *\n   * Number: Sorts numerically.\n   * - Date: Sorts by date and time.\n   * - String: Sorts lexicographically, so `\"abc\"` comes before `\"XYZ\"`.\n   * - Reference: Compares by the ID of the referenced item as a String.\n   *\n   * If a property contains a number as a String, that value will be sorted alphabetically and not numerically. Items\n   * that do not have a value for the specified sort property are ranked lowest.\n   * @public\n   * @documentationMaturity preview\n   * @param fields - The properties used in the sort.\n   * @requiredField fields\n   * @returns An object representing the refined query.\n   */\n  descending(...fields: string[]): Self\n  descending(fields: string[]): Self\n\n  descending(...fields: any) {\n    return this.copy({ sort: this.sort.descending(...fields) })\n  }\n}\n"],"mappings":";;;;;;AAAA,IAAAA,OAAA,GAAAC,OAAA;AAMA,IAAAC,UAAA,GAAAD,OAAA;AACA,IAAAE,OAAA,GAAAF,OAAA;AAEO,MAAeG,SAAS,CAE/B;EAgBYC,WAAWA,CAACC,MAIrB,EAAE;IAnBH;AACF;AACA;IAFE,IAAAC,gBAAA,CAAAC,OAAA;IAKA;AACF;AACA;IAFE,IAAAD,gBAAA,CAAAC,OAAA;IAKA;AACF;AACA;IAFE,IAAAD,gBAAA,CAAAC,OAAA;IA2DA;IACA;IAAA,IAAAD,gBAAA,CAAAC,OAAA,cAE6B,CAAC,GAAGC,IAAI,KAAK;MACxC,OAAO,IAAI,CAACC,UAAU,CAAC,IAAI,EAAED,IAAI,CAAC;IACpC,CAAC;IAAA,IAAAF,gBAAA,CAAAC,OAAA,cAC4B,CAAC,GAAGC,IAAI,KAAK;MACxC,OAAO,IAAI,CAACC,UAAU,CAAC,IAAI,EAAED,IAAI,CAAC;IACpC,CAAC;IAAA,IAAAF,gBAAA,CAAAC,OAAA,cAC4B,CAAC,GAAGC,IAAI,KAAK;MACxC,OAAO,IAAI,CAACC,UAAU,CAAC,IAAI,EAAED,IAAI,CAAC;IACpC,CAAC;IAAA,IAAAF,gBAAA,CAAAC,OAAA,cAC4B,CAAC,GAAGC,IAAI,KAAK;MACxC,OAAO,IAAI,CAACC,UAAU,CAAC,IAAI,EAAED,IAAI,CAAC;IACpC,CAAC;IAAA,IAAAF,gBAAA,CAAAC,OAAA,eAC8B,CAAC,GAAGC,IAAI,KAAK;MAC1C,OAAO,IAAI,CAACC,UAAU,CAAC,KAAK,EAAED,IAAI,CAAC;IACrC,CAAC;IAAA,IAAAF,gBAAA,CAAAC,OAAA,cAC4B,CAAC,GAAGC,IAAI,KAAK;MACxC,OAAO,IAAI,CAACC,UAAU,CAAC,IAAI,EAAED,IAAI,CAAC;IACpC,CAAC;IAAA,IAAAF,gBAAA,CAAAC,OAAA,cAC4B,CAAC,GAAGC,IAAI,KAAK;MACxC,OAAO,IAAI,CAACC,UAAU,CAAC,IAAI,EAAED,IAAI,CAAC;IACpC,CAAC;IAAA,IAAAF,gBAAA,CAAAC,OAAA,eAC8B,CAAC,GAAGC,IAAI,KAAK;MAC1C,OAAO,IAAI,CAACC,UAAU,CAAC,KAAK,EAAED,IAAI,CAAC;IACrC,CAAC;IAAA,IAAAF,gBAAA,CAAAC,OAAA,sBAC4C,CAAC,GAAGC,IAAI,KAAK;MACxD,OAAO,IAAI,CAACC,UAAU,CAAC,YAAY,EAAED,IAAI,CAAC;IAC5C,CAAC;IAAA,IAAAF,gBAAA,CAAAC,OAAA,mBACsC,CAAC,GAAGC,IAAI,KAAK;MAClD,OAAO,IAAI,CAACC,UAAU,CAAC,SAAS,EAAED,IAAI,CAAC;IACzC,CAAC;IAAA,IAAAF,gBAAA,CAAAC,OAAA,sBAC4C,CAAC,GAAGC,IAAI,KAAK;MACxD,OAAO,IAAI,CAACC,UAAU,CAAC,YAAY,EAAED,IAAI,CAAC;IAC5C,CAAC;IAAA,IAAAF,gBAAA,CAAAC,OAAA,oBACwC,CAAC,GAAGC,IAAI,KAAK;MACpD,OAAO,IAAI,CAACC,UAAU,CAAC,UAAU,EAAED,IAAI,CAAC;IAC1C,CAAC;IAAA,IAAAF,gBAAA,CAAAC,OAAA,oBACwC,CAAC,GAAGC,IAAI,KAAK;MACpD,OAAO,IAAI,CAACC,UAAU,CAAC,UAAU,EAAED,IAAI,CAAC;IAC1C,CAAC;IAAA,IAAAF,gBAAA,CAAAC,OAAA,mBACsC,CAAC,GAAGC,IAAI,KAAK;MAClD,OAAO,IAAI,CAACC,UAAU,CAAC,SAAS,EAAED,IAAI,CAAC;IACzC,CAAC;IAAA,IAAAF,gBAAA,CAAAC,OAAA,cAC4B,CAAC,GAAGC,IAAI,KAAK;MACxC,OAAO,IAAI,CAACC,UAAU,CAAC,IAAI,EAAED,IAAI,CAAC;IACpC,CAAC;IAAA,IAAAF,gBAAA,CAAAC,OAAA,kBACoC,CAAC,GAAGC,IAAI,KAAK;MAChD,OAAO,IAAI,CAACC,UAAU,CAAC,QAAQ,EAAED,IAAI,CAAC;IACxC,CAAC;IAAA,IAAAF,gBAAA,CAAAC,OAAA,kBACoC,CAAC,GAAGC,IAAI,KAAK;MAChD,OAAO,IAAI,CAACC,UAAU,CAAC,QAAQ,EAAED,IAAI,CAAC;IACxC,CAAC;IAAA,IAAAF,gBAAA,CAAAC,OAAA,cAC4B,CAAC,GAAGC,IAAI,KAAK;MACxC;MACA,OAAO,IAAI,CAACC,UAAU,CAAC,IAAI,EAAED,IAAI,CAACE,GAAG,CAAC,IAAI,CAACC,aAAa,CAAC,CAAC;IAC5D,CAAC;IAAA,IAAAL,gBAAA,CAAAC,OAAA,eAC8B,CAAC,GAAGC,IAAI,KAAK;MAC1C;MACA,OAAO,IAAI,CAACC,UAAU,CAAC,KAAK,EAAED,IAAI,CAACE,GAAG,CAAC,IAAI,CAACC,aAAa,CAAC,CAAC;IAC7D,CAAC;IAAA,IAAAL,gBAAA,CAAAC,OAAA,eAC8B,CAAC,GAAGC,IAAI,KAAK;MAC1C;MACA,OAAO,IAAI,CAACC,UAAU,CAAC,KAAK,EAAED,IAAI,CAACE,GAAG,CAAC,IAAI,CAACC,aAAa,CAAC,CAAC;IAC7D,CAAC;IAAA,IAAAL,gBAAA,CAAAC,OAAA,mBACsC,CAAC,GAAGC,IAAI,KAAK;MAClD,OAAO,IAAI,CAACC,UAAU,CAAC,SAAS,EAAED,IAAI,CAAC;IACzC,CAAC;IArHC,IAAI,CAACI,cAAc,GAAGP,MAAM,CAACO,cAAc;IAC3C,IAAI,CAACC,aAAa,GAChB,CAAAR,MAAM,oBAANA,MAAM,CAAEQ,aAAa,KAAI,IAAAA,qBAAa,EAAC;MAAEC,UAAU,EAAE,CAAC;IAAE,CAAC,CAAC;IAC5D,IAAI,CAACC,IAAI,GAAG,CAAAV,MAAM,oBAANA,MAAM,CAAEU,IAAI,KAAI,IAAIC,eAAI,CAAC,CAAC;EACxC;;EAEA;AACF;AACA;;EAME;;EAIA,IAAIF,UAAUA,CAAA,EAAwB;IACpC,OAAO,IAAI,CAACD,aAAa,CAACC,UAAU;EACtC;;EAEA;AACF;AACA;EACEG,cAAcA,CAACH,UAA+B,EAAQ;IACpD,MAAMI,MAAM,GAAG,IAAAL,qBAAa,EAAC;MAC3BC,UAAU;MACVK,gBAAgB,EAAE,IAAAC,0BAAkB,EAACN,UAAU;IACjD,CAAC,CAAC;IACF,OAAO,IAAI,CAACO,IAAI,CAAC;MAAER,aAAa,EAAEK;IAAO,CAAC,CAAC;EAC7C;;EAEA;AACF;AACA;EACEI,cAAcA,CAAA,EAAe;IAC3B,OAAO,IAAI,CAACT,aAAa,CAACU,KAAK,CAAC,CAAC;EACnC;EAEQd,UAAUA,CAChBS,MAAS,EACTV,IAA8C,EACxC;IACN,OAAO,IAAI,CAACa,IAAI,CAAC;MACfR,aAAa,EAAE,IAAI,CAACA,aAAa,CAACK,MAAM,CAAC,CAACM,KAAK,CAAC,IAAI,CAACX,aAAa,EAAEL,IAAI;IAC1E,CAAC,CAAC;EACJ;EAwEQG,aAAaA,CAACc,KAAU,EAAO;IACrC,OAAOA,KAAK,YAALA,KAAK,CAAEZ,aAAa,GAAGY,KAAK,CAACZ,aAAa,GAAGY,KAAK;EAC3D;;EAEA;;EAEA,IAAIC,OAAOA,CAAA,EAA0C;IACnD,OAAO,IAAI,CAACX,IAAI,CAACW,OAAO;EAC1B;;EAEA;AACF;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;EAIEC,SAASA,CAAC,GAAGC,MAAW,EAAE;IACxB,OAAO,IAAI,CAACP,IAAI,CAAC;MAAEN,IAAI,EAAE,IAAI,CAACA,IAAI,CAACY,SAAS,CAAC,GAAGC,MAAM;IAAE,CAAC,CAAC;EAC5D;;EAEA;AACF;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;EAIEC,UAAUA,CAAC,GAAGD,MAAW,EAAE;IACzB,OAAO,IAAI,CAACP,IAAI,CAAC;MAAEN,IAAI,EAAE,IAAI,CAACA,IAAI,CAACc,UAAU,CAAC,GAAGD,MAAM;IAAE,CAAC,CAAC;EAC7D;AACF;AAACE,OAAA,CAAA3B,SAAA,GAAAA,SAAA"}

package/dist/cjs/api/QueryValidator.js

@@ -0,0 +1,36 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+exports.__esModule = true;
+exports.QueryValidator = void 0;
+var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
+var _utils = require("../utils");
+var _errors = require("../errors");
+const MAX_SAFE_INTEGER = 9007199254740991;
+class QueryValidator extends _errors.AggregatingValidator {
+  constructor(operatorName, previousInvalidArguments) {
+    super(previousInvalidArguments);
+    (0, _defineProperty2.default)(this, "operatorName", void 0);
+    this.operatorName = operatorName;
+  }
+  _isNumber(specifier, operand) {
+    return this.addValidation(() => (0, _utils.isNumber)(operand), () => _errors.messages.queryValidations.isNumber(this.operatorName, specifier, operand));
+  }
+  isPositiveNumber(operand) {
+    return this._isNumber('positive', operand).addValidation(() => !Number.isNaN(operand) && operand > 0, () => _errors.messages.queryValidations.isPositiveNumber(this.operatorName, operand));
+  }
+  isNonNegativeNumber(operand) {
+    return this._isNumber('non-negative', operand).addValidation(() => !Number.isNaN(operand) && operand >= 0, () => _errors.messages.queryValidations.isNonNegativeNumber(this.operatorName, operand));
+  }
+  isInteger(operand) {
+    return this.addValidation(() => !Number.isNaN(operand) && Number.isFinite(operand) && Number.isInteger(operand) && operand < MAX_SAFE_INTEGER && operand > -MAX_SAFE_INTEGER, () => _errors.messages.queryValidations.isInteger(this.operatorName, operand));
+  }
+  notGreaterThan(operand, value) {
+    return this.addValidation(() => operand <= value, () => _errors.messages.queryValidations.notGreaterThan(this.operatorName, operand, value));
+  }
+  nonEmptyString(operand) {
+    return this.addValidation(() => typeof operand === 'string' && operand.length > 0, () => _errors.messages.queryValidations.isNonEmptyString(this.operatorName));
+  }
+}
+exports.QueryValidator = QueryValidator;
+//# sourceMappingURL=QueryValidator.js.map

package/dist/cjs/api/QueryValidator.js.map

@@ -0,0 +1 @@
+{"version":3,"names":["_utils","require","_errors","MAX_SAFE_INTEGER","QueryValidator","AggregatingValidator","constructor","operatorName","previousInvalidArguments","_defineProperty2","default","_isNumber","specifier","operand","addValidation","isNumber","messages","queryValidations","isPositiveNumber","Number","isNaN","isNonNegativeNumber","isInteger","isFinite","notGreaterThan","value","nonEmptyString","length","isNonEmptyString","exports"],"sources":["../../../src/api/QueryValidator.ts"],"sourcesContent":["import { isNumber } from '../utils'\nimport { AggregatingValidator, messages } from '../errors'\n\nconst MAX_SAFE_INTEGER = 9007199254740991\n\nexport class QueryValidator extends AggregatingValidator {\n  operatorName: any\n\n  constructor(operatorName: string, previousInvalidArguments: string[]) {\n    super(previousInvalidArguments)\n    this.operatorName = operatorName\n  }\n\n  _isNumber(specifier: string, operand: any) {\n    return this.addValidation(\n      () => isNumber(operand),\n      () =>\n        messages.queryValidations.isNumber(\n          this.operatorName,\n          specifier,\n          operand\n        )\n    )\n  }\n\n  isPositiveNumber(operand: number) {\n    return this._isNumber('positive', operand).addValidation(\n      () => !Number.isNaN(operand) && operand > 0,\n      () =>\n        messages.queryValidations.isPositiveNumber(this.operatorName, operand)\n    )\n  }\n\n  isNonNegativeNumber(operand: number) {\n    return this._isNumber('non-negative', operand).addValidation(\n      () => !Number.isNaN(operand) && operand >= 0,\n      () =>\n        messages.queryValidations.isNonNegativeNumber(\n          this.operatorName,\n          operand\n        )\n    )\n  }\n\n  isInteger(operand: number) {\n    return this.addValidation(\n      () =>\n        !Number.isNaN(operand) &&\n        Number.isFinite(operand) &&\n        Number.isInteger(operand) &&\n        operand < MAX_SAFE_INTEGER &&\n        operand > -MAX_SAFE_INTEGER,\n      () => messages.queryValidations.isInteger(this.operatorName, operand)\n    )\n  }\n\n  notGreaterThan(operand: number, value: number) {\n    return this.addValidation(\n      () => operand <= value,\n      () =>\n        messages.queryValidations.notGreaterThan(\n          this.operatorName,\n          operand,\n          value\n        )\n    )\n  }\n\n  nonEmptyString(operand: any) {\n    return this.addValidation(\n      () => typeof operand === 'string' && operand.length > 0,\n      () => messages.queryValidations.isNonEmptyString(this.operatorName)\n    )\n  }\n}\n"],"mappings":";;;;;;AAAA,IAAAA,MAAA,GAAAC,OAAA;AACA,IAAAC,OAAA,GAAAD,OAAA;AAEA,MAAME,gBAAgB,GAAG,gBAAgB;AAElC,MAAMC,cAAc,SAASC,4BAAoB,CAAC;EAGvDC,WAAWA,CAACC,YAAoB,EAAEC,wBAAkC,EAAE;IACpE,KAAK,CAACA,wBAAwB,CAAC;IAAA,IAAAC,gBAAA,CAAAC,OAAA;IAC/B,IAAI,CAACH,YAAY,GAAGA,YAAY;EAClC;EAEAI,SAASA,CAACC,SAAiB,EAAEC,OAAY,EAAE;IACzC,OAAO,IAAI,CAACC,aAAa,CACvB,MAAM,IAAAC,eAAQ,EAACF,OAAO,CAAC,EACvB,MACEG,gBAAQ,CAACC,gBAAgB,CAACF,QAAQ,CAChC,IAAI,CAACR,YAAY,EACjBK,SAAS,EACTC,OACF,CACJ,CAAC;EACH;EAEAK,gBAAgBA,CAACL,OAAe,EAAE;IAChC,OAAO,IAAI,CAACF,SAAS,CAAC,UAAU,EAAEE,OAAO,CAAC,CAACC,aAAa,CACtD,MAAM,CAACK,MAAM,CAACC,KAAK,CAACP,OAAO,CAAC,IAAIA,OAAO,GAAG,CAAC,EAC3C,MACEG,gBAAQ,CAACC,gBAAgB,CAACC,gBAAgB,CAAC,IAAI,CAACX,YAAY,EAAEM,OAAO,CACzE,CAAC;EACH;EAEAQ,mBAAmBA,CAACR,OAAe,EAAE;IACnC,OAAO,IAAI,CAACF,SAAS,CAAC,cAAc,EAAEE,OAAO,CAAC,CAACC,aAAa,CAC1D,MAAM,CAACK,MAAM,CAACC,KAAK,CAACP,OAAO,CAAC,IAAIA,OAAO,IAAI,CAAC,EAC5C,MACEG,gBAAQ,CAACC,gBAAgB,CAACI,mBAAmB,CAC3C,IAAI,CAACd,YAAY,EACjBM,OACF,CACJ,CAAC;EACH;EAEAS,SAASA,CAACT,OAAe,EAAE;IACzB,OAAO,IAAI,CAACC,aAAa,CACvB,MACE,CAACK,MAAM,CAACC,KAAK,CAACP,OAAO,CAAC,IACtBM,MAAM,CAACI,QAAQ,CAACV,OAAO,CAAC,IACxBM,MAAM,CAACG,SAAS,CAACT,OAAO,CAAC,IACzBA,OAAO,GAAGV,gBAAgB,IAC1BU,OAAO,GAAG,CAACV,gBAAgB,EAC7B,MAAMa,gBAAQ,CAACC,gBAAgB,CAACK,SAAS,CAAC,IAAI,CAACf,YAAY,EAAEM,OAAO,CACtE,CAAC;EACH;EAEAW,cAAcA,CAACX,OAAe,EAAEY,KAAa,EAAE;IAC7C,OAAO,IAAI,CAACX,aAAa,CACvB,MAAMD,OAAO,IAAIY,KAAK,EACtB,MACET,gBAAQ,CAACC,gBAAgB,CAACO,cAAc,CACtC,IAAI,CAACjB,YAAY,EACjBM,OAAO,EACPY,KACF,CACJ,CAAC;EACH;EAEAC,cAAcA,CAACb,OAAY,EAAE;IAC3B,OAAO,IAAI,CAACC,aAAa,CACvB,MAAM,OAAOD,OAAO,KAAK,QAAQ,IAAIA,OAAO,CAACc,MAAM,GAAG,CAAC,EACvD,MAAMX,gBAAQ,CAACC,gBAAgB,CAACW,gBAAgB,CAAC,IAAI,CAACrB,YAAY,CACpE,CAAC;EACH;AACF;AAACsB,OAAA,CAAAzB,cAAA,GAAAA,cAAA"}

package/dist/cjs/api/WixDataAggregate.js

@@ -0,0 +1,4 @@
+"use strict";
+
+exports.__esModule = true;
+//# sourceMappingURL=WixDataAggregate.js.map

package/dist/cjs/api/WixDataAggregate.js.map

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