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

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/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

@@ -337,7 +337,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 +348,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 +495,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;
@@ -839,7 +866,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 +878,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 +974,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 +993,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 +1014,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 +1062,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,
@@ -1278,6 +1309,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;
 }