@wix/wix-data-items-common 1.0.305 → 1.0.307

package/dist/cjs/api/PagingMetadata.js

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

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

@@ -0,0 +1 @@
+{"version":3,"names":[],"sources":["../../../src/api/PagingMetadata.ts"],"sourcesContent":["export interface PagingMetadata {\n  /** Number of items returned in the response. */\n  count?: number | null\n  /** Offset that was requested. */\n  offset?: number | null\n  /** Total number of items that match the query. Returned if offset paging is used, `returnTotalCount` is `true` in the request, and `tooManyToCount` is false. */\n  total?: number | null\n  /** Whether the server failed to calculate the `total` field. */\n  tooManyToCount?: boolean | null\n  /** Cursors to navigate through the result pages using `next` and `prev`. Returned if cursor paging is used. */\n  cursors?: Cursors\n  /**\n   * Indicates if there are more results after the current page.\n   * If `true`, another page of results can be retrieved.\n   * If `false`, this is the last page.\n   */\n  hasNext?: boolean | null\n}\n\nexport interface Cursors {\n  /** Cursor pointing to next page in the list of results. */\n  next?: string | null\n  /** Cursor pointing to previous page in the list of results. */\n  prev?: string | null\n}\n"],"mappings":"","ignoreList":[]}

package/dist/cjs/api/WixDataAggregateOptionsBuilder.js

@@ -0,0 +1,90 @@
+"use strict";
+
+exports.__esModule = true;
+exports.AggregateOptionsBuilder = void 0;
+/**
+ * WixData aggregate options builder.
+ * @internal
+ */
+
+class WixDataAggregateOptionsBuilderImpl {
+  constructor(options = {}) {
+    this.options = options;
+  }
+  withSuppressHooks(value) {
+    return this.copy({
+      suppressHooks: value
+    });
+  }
+  withShowDrafts(value) {
+    return this.copy({
+      showDrafts: value
+    });
+  }
+  withAppOptions(value) {
+    return this.copy({
+      appOptions: {
+        ...value
+      }
+    });
+  }
+  withLanguage(value) {
+    return this.copy({
+      language: value
+    });
+  }
+  withConsistentRead(value) {
+    return this.copy({
+      consistentRead: value
+    });
+  }
+  withIncludeReferences(value) {
+    return this.copy({
+      includeReferences: value.map(includeReference => ({
+        ...includeReference
+      }))
+    });
+  }
+  withReturnTotalCount(value) {
+    return this.copy({
+      returnTotalCount: value
+    });
+  }
+  withIncludeFieldGroups(...value) {
+    return this.copy({
+      includeFieldGroups: [...value]
+    });
+  }
+  build() {
+    return {
+      ...this.options,
+      ...(this.options.appOptions ? {
+        appOptions: {
+          ...this.options.appOptions
+        }
+      } : {}),
+      ...(this.options.includeReferences ? {
+        includeReferences: this.options.includeReferences.map(includeReference => ({
+          ...includeReference
+        }))
+      } : {}),
+      ...(this.options.includeFieldGroups ? {
+        includeFieldGroups: [...this.options.includeFieldGroups]
+      } : {})
+    };
+  }
+  copy(options) {
+    return new WixDataAggregateOptionsBuilderImpl({
+      ...this.options,
+      ...options
+    });
+  }
+}
+
+/**
+ * Creates a new WixData aggregate options builder.
+ * @internal
+ */
+const AggregateOptionsBuilder = () => new WixDataAggregateOptionsBuilderImpl();
+exports.AggregateOptionsBuilder = AggregateOptionsBuilder;
+//# sourceMappingURL=WixDataAggregateOptionsBuilder.js.map

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

@@ -0,0 +1 @@
+{"version":3,"names":["WixDataAggregateOptionsBuilderImpl","constructor","options","withSuppressHooks","value","copy","suppressHooks","withShowDrafts","showDrafts","withAppOptions","appOptions","withLanguage","language","withConsistentRead","consistentRead","withIncludeReferences","includeReferences","map","includeReference","withReturnTotalCount","returnTotalCount","withIncludeFieldGroups","includeFieldGroups","build","AggregateOptionsBuilder","exports"],"sources":["../../../src/api/WixDataAggregateOptionsBuilder.ts"],"sourcesContent":["import type { WixDataAggregateOptions } from './types'\n\n/**\n * WixData aggregate options builder.\n * @internal\n */\nexport interface WixDataAggregateOptionsBuilder {\n  withSuppressHooks(value: boolean): WixDataAggregateOptionsBuilder\n  withShowDrafts(value: boolean): WixDataAggregateOptionsBuilder\n  withAppOptions(value: Record<string, any>): WixDataAggregateOptionsBuilder\n  withLanguage(value: string): WixDataAggregateOptionsBuilder\n  withConsistentRead(value: boolean): WixDataAggregateOptionsBuilder\n  withIncludeReferences(\n    value: { field: string; limit?: number }[]\n  ): WixDataAggregateOptionsBuilder\n  withReturnTotalCount(value: boolean): WixDataAggregateOptionsBuilder\n  withIncludeFieldGroups(...value: string[]): WixDataAggregateOptionsBuilder\n  build(): WixDataAggregateOptions\n}\n\nclass WixDataAggregateOptionsBuilderImpl\n  implements WixDataAggregateOptionsBuilder\n{\n  constructor(private readonly options: WixDataAggregateOptions = {}) {}\n\n  withSuppressHooks(value: boolean): WixDataAggregateOptionsBuilder {\n    return this.copy({ suppressHooks: value })\n  }\n\n  withShowDrafts(value: boolean): WixDataAggregateOptionsBuilder {\n    return this.copy({ showDrafts: value })\n  }\n\n  withAppOptions(value: Record<string, any>): WixDataAggregateOptionsBuilder {\n    return this.copy({ appOptions: { ...value } })\n  }\n\n  withLanguage(value: string): WixDataAggregateOptionsBuilder {\n    return this.copy({ language: value })\n  }\n\n  withConsistentRead(value: boolean): WixDataAggregateOptionsBuilder {\n    return this.copy({ consistentRead: value })\n  }\n\n  withIncludeReferences(\n    value: { field: string; limit?: number }[]\n  ): WixDataAggregateOptionsBuilder {\n    return this.copy({\n      includeReferences: value.map((includeReference) => ({\n        ...includeReference,\n      })),\n    })\n  }\n\n  withReturnTotalCount(value: boolean): WixDataAggregateOptionsBuilder {\n    return this.copy({ returnTotalCount: value })\n  }\n\n  withIncludeFieldGroups(...value: string[]): WixDataAggregateOptionsBuilder {\n    return this.copy({ includeFieldGroups: [...value] })\n  }\n\n  build(): WixDataAggregateOptions {\n    return {\n      ...this.options,\n      ...(this.options.appOptions\n        ? { appOptions: { ...this.options.appOptions } }\n        : {}),\n      ...(this.options.includeReferences\n        ? {\n            includeReferences: this.options.includeReferences.map(\n              (includeReference) => ({ ...includeReference })\n            ),\n          }\n        : {}),\n      ...(this.options.includeFieldGroups\n        ? { includeFieldGroups: [...this.options.includeFieldGroups] }\n        : {}),\n    }\n  }\n\n  private copy(\n    options: WixDataAggregateOptions\n  ): WixDataAggregateOptionsBuilder {\n    return new WixDataAggregateOptionsBuilderImpl({\n      ...this.options,\n      ...options,\n    })\n  }\n}\n\n/**\n * Creates a new WixData aggregate options builder.\n * @internal\n */\nexport const AggregateOptionsBuilder: () => WixDataAggregateOptionsBuilder =\n  () => new WixDataAggregateOptionsBuilderImpl()\n"],"mappings":";;;;AAEA;AACA;AACA;AACA;;AAeA,MAAMA,kCAAkC,CAExC;EACEC,WAAWA,CAAkBC,OAAgC,GAAG,CAAC,CAAC,EAAE;IAAA,KAAvCA,OAAgC,GAAhCA,OAAgC;EAAQ;EAErEC,iBAAiBA,CAACC,KAAc,EAAkC;IAChE,OAAO,IAAI,CAACC,IAAI,CAAC;MAAEC,aAAa,EAAEF;IAAM,CAAC,CAAC;EAC5C;EAEAG,cAAcA,CAACH,KAAc,EAAkC;IAC7D,OAAO,IAAI,CAACC,IAAI,CAAC;MAAEG,UAAU,EAAEJ;IAAM,CAAC,CAAC;EACzC;EAEAK,cAAcA,CAACL,KAA0B,EAAkC;IACzE,OAAO,IAAI,CAACC,IAAI,CAAC;MAAEK,UAAU,EAAE;QAAE,GAAGN;MAAM;IAAE,CAAC,CAAC;EAChD;EAEAO,YAAYA,CAACP,KAAa,EAAkC;IAC1D,OAAO,IAAI,CAACC,IAAI,CAAC;MAAEO,QAAQ,EAAER;IAAM,CAAC,CAAC;EACvC;EAEAS,kBAAkBA,CAACT,KAAc,EAAkC;IACjE,OAAO,IAAI,CAACC,IAAI,CAAC;MAAES,cAAc,EAAEV;IAAM,CAAC,CAAC;EAC7C;EAEAW,qBAAqBA,CACnBX,KAA0C,EACV;IAChC,OAAO,IAAI,CAACC,IAAI,CAAC;MACfW,iBAAiB,EAAEZ,KAAK,CAACa,GAAG,CAAEC,gBAAgB,KAAM;QAClD,GAAGA;MACL,CAAC,CAAC;IACJ,CAAC,CAAC;EACJ;EAEAC,oBAAoBA,CAACf,KAAc,EAAkC;IACnE,OAAO,IAAI,CAACC,IAAI,CAAC;MAAEe,gBAAgB,EAAEhB;IAAM,CAAC,CAAC;EAC/C;EAEAiB,sBAAsBA,CAAC,GAAGjB,KAAe,EAAkC;IACzE,OAAO,IAAI,CAACC,IAAI,CAAC;MAAEiB,kBAAkB,EAAE,CAAC,GAAGlB,KAAK;IAAE,CAAC,CAAC;EACtD;EAEAmB,KAAKA,CAAA,EAA4B;IAC/B,OAAO;MACL,GAAG,IAAI,CAACrB,OAAO;MACf,IAAI,IAAI,CAACA,OAAO,CAACQ,UAAU,GACvB;QAAEA,UAAU,EAAE;UAAE,GAAG,IAAI,CAACR,OAAO,CAACQ;QAAW;MAAE,CAAC,GAC9C,CAAC,CAAC,CAAC;MACP,IAAI,IAAI,CAACR,OAAO,CAACc,iBAAiB,GAC9B;QACEA,iBAAiB,EAAE,IAAI,CAACd,OAAO,CAACc,iBAAiB,CAACC,GAAG,CAClDC,gBAAgB,KAAM;UAAE,GAAGA;QAAiB,CAAC,CAChD;MACF,CAAC,GACD,CAAC,CAAC,CAAC;MACP,IAAI,IAAI,CAAChB,OAAO,CAACoB,kBAAkB,GAC/B;QAAEA,kBAAkB,EAAE,CAAC,GAAG,IAAI,CAACpB,OAAO,CAACoB,kBAAkB;MAAE,CAAC,GAC5D,CAAC,CAAC;IACR,CAAC;EACH;EAEQjB,IAAIA,CACVH,OAAgC,EACA;IAChC,OAAO,IAAIF,kCAAkC,CAAC;MAC5C,GAAG,IAAI,CAACE,OAAO;MACf,GAAGA;IACL,CAAC,CAAC;EACJ;AACF;;AAEA;AACA;AACA;AACA;AACO,MAAMsB,uBAA6D,GACxEA,CAAA,KAAM,IAAIxB,kCAAkC,CAAC,CAAC;AAAAyB,OAAA,CAAAD,uBAAA,GAAAA,uBAAA","ignoreList":[]}

package/dist/cjs/api/WixDataAggregateResponse.js

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

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

@@ -0,0 +1 @@
+{"version":3,"names":[],"sources":["../../../src/api/WixDataAggregateResponse.ts"],"sourcesContent":["import { PagingMetadata } from './PagingMetadata'\n\nexport interface WixDataAggregateResponse<Result = Record<string, any>> {\n  /** Aggregated results. */\n  results: Result[]\n\n  /** Paging information. */\n  pagingMetadata: PagingMetadata\n}\n"],"mappings":"","ignoreList":[]}

package/dist/cjs/api/WixDataApi.js

@@ -33,6 +33,9 @@ function createFilter(filter) {
   if (anyFilter.filterTree != null) {
     return anyFilter.filterTree;
   }
+  if ((0, _utils.isObject)(filter)) {
+    return filter;
+  }
   return {};
 }
 function createExplicitFilter(filter) {
@@ -248,7 +251,7 @@ class WixDataApi {
           ...env,
           dataCollectionId: collectionName,
           filter: apiFilter,
-          ...toAsyncByFilterOptions(options)
+          ...toAsyncRemoveByFilterOptions(options)
         });
         return {
           jobId: jobId
@@ -337,7 +340,7 @@ class WixDataApi {
       const limit = (options == null || (_options$paging = options.paging) == null ? void 0 : _options$paging.limit) ?? (options == null || (_options$cursorPaging = options.cursorPaging) == null ? void 0 : _options$cursorPaging.limit);
       const offset = (options == null || (_options$paging2 = options.paging) == null ? void 0 : _options$paging2.offset) ?? 0;
       const cursor = options == null || (_options$cursorPaging2 = options.cursorPaging) == null ? void 0 : _options$cursorPaging2.cursor;
-      const fetch = (cursorOrOffset, returnTotalCount) => this.trace('distinct', {
+      return this.trace('distinct', {
         collectionName,
         field: fieldName
       })(async env => {
@@ -348,21 +351,18 @@ class WixDataApi {
           ...env,
           dataCollectionId: collectionName,
           ...toReadOptions(options),
-          ...toPaging(limit, cursorOrOffset),
-          ...(isOffset(cursorOrOffset) ? {
+          ...toPaging(limit, cursor ?? offset),
+          ...(cursor === undefined ? {
             fieldName,
             filter: options == null ? void 0 : options.filter,
             order: options == null ? void 0 : options.order,
-            returnTotalCount
+            returnTotalCount: options == null ? void 0 : options.returnTotalCount
           } : {})
         });
-        return [distinctValues, pagingMetadata];
-      });
-      const [items, paging] = await fetch(cursor ?? offset, options == null ? void 0 : options.returnTotalCount);
-      return new _WixDataResultImpl.WixDataResultImpl(items, paging, fetch, {
-        collectionName,
-        limitNumber: limit,
-        skipNumber: offset
+        return {
+          values: distinctValues,
+          pagingMetadata: pagingMetadata
+        };
       });
     }));
     /** @internal */
@@ -498,6 +498,36 @@ class WixDataApi {
         skipNumber: (options == null ? void 0 : options.skip) ?? 0
       });
     }));
+    (0, _defineProperty2.default)(this, "queryReferencedItems", withArgs(async (args, collectionName, referringItem, referringItemFieldName, options) => {
+      await apiValidator().arity('queryReferencedItems', args, 3, 4).collectionName(collectionName).referenceParameters(asArray(referringItem)).isNonEmptyString(referringItemFieldName, 'referringItemFieldName').options(options).validateAndReject();
+      const referringItemIds = asArray(referringItem).map(itemId);
+      return this.trace('queryReferencedItems', {
+        collectionName,
+        referringItemIds,
+        options,
+        referringItemFieldName
+      })(async env => {
+        const {
+          results,
+          pagingMetadata
+        } = await this.client.queryReferencedDataItems({
+          ...env,
+          ...toReadOptions(options),
+          dataCollectionId: collectionName,
+          referringItemIds,
+          referringItemFieldName,
+          order: options == null ? void 0 : options.order,
+          paging: options == null ? void 0 : options.paging,
+          cursorPaging: options == null ? void 0 : options.cursorPaging,
+          fields: options == null ? void 0 : options.fields,
+          returnTotalCount: options == null ? void 0 : options.returnTotalCount
+        });
+        return {
+          results: toReferencedResults(results ?? []),
+          pagingMetadata: pagingMetadata
+        };
+      });
+    }));
     (0, _defineProperty2.default)(this, "insertReference", withArgs(async (args, collectionName, refsOrAttr, leftOrOpts, right, options) => {
       let refs;
       let opts;
@@ -680,7 +710,7 @@ class WixDataApi {
               dataItemId: itemId,
               fieldModifications
             })),
-            ...toPatchOptions(options)
+            ...toBulkPatchOptions(options)
           });
           return toBulkResult(itemIds, results, ['WDE0073']);
         });
@@ -701,7 +731,7 @@ class WixDataApi {
           dataItemId: itemId,
           fieldModifications: apiFieldModifications
         })),
-        ...toPatchOptions(options)
+        ...toBulkPatchOptions(options)
       });
       return toBulkResult(itemIds, results, ['WDE0073']);
     });
@@ -839,7 +869,7 @@ class WixDataApi {
       field: inc.field,
       limit: inc.limit
     }));
-    const fetch = (cursorOrOffset, returnTotalCount) => this.trace('query', {
+    return this.trace('query', {
       collectionName
     })(async env => {
       var _options$includeField2;
@@ -851,28 +881,25 @@ class WixDataApi {
         dataCollectionId: collectionName,
         query: {
           fields: request.fields,
-          ...toPaging(limit, cursorOrOffset),
-          ...(isOffset(cursorOrOffset) ? {
+          ...toPaging(limit, cursor ?? offset),
+          ...(cursor === undefined ? {
             filter: request.filter,
             sort: toSort(sort)
           } : {})
         },
         includeReferences,
         ...toReadOptions(options),
-        ...(isOffset(cursorOrOffset) ? {
-          returnTotalCount
+        ...(cursor === undefined ? {
+          returnTotalCount: options == null ? void 0 : options.returnTotalCount
         } : {}),
         ...(options != null && (_options$includeField2 = options.includeFieldGroups) != null && _options$includeField2.length ? {
           includeFieldGroups: options.includeFieldGroups
         } : {})
       });
-      return [dataItems.map(toDataItem), pagingMetadata];
-    });
-    const [items, paging] = await fetch(cursor ?? offset, options == null ? void 0 : options.returnTotalCount);
-    return new _WixDataResultImpl.WixDataResultImpl(items, paging, fetch, {
-      collectionName,
-      limitNumber: limit,
-      skipNumber: offset
+      return {
+        items: dataItems.map(toDataItem),
+        pagingMetadata: pagingMetadata
+      };
     });
   }
 
@@ -950,7 +977,7 @@ class WixDataApi {
       field: inc.field,
       limit: inc.limit
     }));
-    const fetch = cursorOrOffset => this.trace('search', {
+    return this.trace('search', {
       collectionName,
       search: request.search
     })(async env => {
@@ -969,18 +996,15 @@ class WixDataApi {
             order: s.order
           })),
           search: request.search,
-          ...toPaging(limit, cursorOrOffset)
+          ...toPaging(limit, cursor ?? offset)
         },
         includeReferences,
         ...toReadOptions(options)
       });
-      return [dataItems.map(toDataItem), pagingMetadata];
-    });
-    const [items, paging] = await fetch(cursor ?? offset);
-    return new _WixDataResultImpl.WixDataResultImpl(items, paging, fetch, {
-      collectionName,
-      limitNumber: limit,
-      skipNumber: offset
+      return {
+        items: dataItems.map(toDataItem),
+        pagingMetadata: pagingMetadata
+      };
     });
   } // --- aggregate ---
   /**
@@ -993,7 +1017,7 @@ class WixDataApi {
    */
   aggregate(collectionName, pipeline, options) {
     if (pipeline !== undefined) {
-      return this.aggregatePipeline(collectionName, pipeline, options);
+      return this.executeDirectAggregate(collectionName, pipeline, options);
     }
     return new _WixDataAggregateImpl.WixDataAggregateImpl({
       collectionName,
@@ -1041,6 +1065,16 @@ class WixDataApi {
       }
     });
   }
+  async executeDirectAggregate(collectionName, pipeline, options) {
+    const {
+      results,
+      pagingMetadata
+    } = await this.aggregatePipeline(collectionName, pipeline, options);
+    return {
+      results: results,
+      pagingMetadata: pagingMetadata
+    };
+  }
   async runBulkSave(env, collectionName, items, options, overrideExisting = true) {
     const request = {
       ...env,
@@ -1089,7 +1123,19 @@ function toPatchOptions(options) {
     ...conditionOptions(options == null ? void 0 : options.condition)
   };
 }
+function toBulkPatchOptions(options) {
+  return {
+    ...toOptions(options),
+    ...conditionOptions(options == null ? void 0 : options.condition)
+  };
+}
 function toAsyncByFilterOptions(options) {
+  return toAsyncOptions(options);
+}
+function toAsyncRemoveByFilterOptions(options) {
+  return toAsyncOptions(options);
+}
+function toAsyncOptions(options) {
   return {
     suppressHooks: options == null ? void 0 : options.suppressHooks,
     ...draftsOptions(options == null ? void 0 : options.showDrafts)
@@ -1278,6 +1324,24 @@ function unwrapAggregationId(items) {
 function onlyReferencedItems(results) {
   return results.map(result => result.dataItem).filter(notEmpty).map(toDataItem);
 }
+function toReferencedResults(results) {
+  return results.map(result => {
+    const wireResult = result;
+    const unresolvedReference = wireResult.unresolvedReference;
+    const referencedResult = {
+      referringItemId: wireResult.referringItemId ?? (unresolvedReference == null ? void 0 : unresolvedReference.referringItemId)
+    };
+    if (result.dataItem) {
+      referencedResult.item = toDataItem(result.dataItem);
+    } else {
+      referencedResult.unresolvedReference = {
+        referencedItemId: unresolvedReference == null ? void 0 : unresolvedReference.referencedItemId,
+        unauthorized: (unresolvedReference == null ? void 0 : unresolvedReference.unauthorized) ?? false
+      };
+    }
+    return referencedResult;
+  });
+}
 function notEmpty(value) {
   return value != null;
 }