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

package/dist/cjs/api/WixDataApi.js

@@ -73,105 +73,6 @@ class WixDataApi {
         });
       });
     }));
-    // --- single-item methods ---
-    (0, _defineProperty2.default)(this, "get", withArgs(async (args, collectionName, itemId, options) => {
-      await apiValidator().arity('get', args, 2, 3).collectionName(collectionName).itemId(itemId).options(options).validateAndReject();
-      return this.trace('get', {
-        collectionName,
-        itemId
-      })(async env => {
-        var _options$includeField;
-        const {
-          dataItem
-        } = await this.client.getDataItem({
-          ...env,
-          dataCollectionId: collectionName,
-          dataItemId: itemId,
-          ...toReadOptions(options),
-          fields: options == null ? void 0 : options.fields,
-          includeReferences: options == null ? void 0 : options.includeReferences,
-          ...(options != null && (_options$includeField = options.includeFieldGroups) != null && _options$includeField.length ? {
-            includeFieldGroups: options.includeFieldGroups
-          } : {})
-        }).catch(recover(ItemDoesNotExistCode, {}));
-        return dataItem ? toDataItem(dataItem) : null;
-      });
-    }));
-    (0, _defineProperty2.default)(this, "insert", withArgs(async (args, collectionName, item, options) => {
-      await apiValidator().arity('insert', args, 2, 3).collectionName(collectionName).item(item, collectionName, false).options(options).validateAndReject();
-      warnAboutBrokenFields(item);
-      return this.trace('insert', {
-        collectionName
-      })(async env => {
-        const {
-          dataItem
-        } = await this.client.insertDataItem({
-          ...env,
-          dataCollectionId: collectionName,
-          dataItem: {
-            id: item._id,
-            data: item
-          },
-          ...toInsertOptions(options)
-        });
-        return toDataItem(dataItem);
-      });
-    }));
-    (0, _defineProperty2.default)(this, "save", withArgs(async (args, collectionName, item, options) => {
-      await apiValidator().arity('save', args, 2, 3).collectionName(collectionName).item(item, collectionName, false).options(options).validateAndReject();
-      return this.trace('save', {
-        collectionName
-      })(async env => {
-        const {
-          dataItem
-        } = await this.client.saveDataItem({
-          ...env,
-          dataCollectionId: collectionName,
-          dataItem: {
-            id: item._id,
-            data: item
-          },
-          ...toSaveOptions(options)
-        });
-        return toDataItem(dataItem);
-      });
-    }));
-    (0, _defineProperty2.default)(this, "update", withArgs(async (args, collectionName, item, options) => {
-      await apiValidator().arity('update', args, 2, 3).collectionName(collectionName).item(item, collectionName, false).options(options).validateAndReject();
-      return this.trace('update', {
-        collectionName
-      })(async env => {
-        const {
-          dataItem
-        } = await this.client.updateDataItem({
-          ...env,
-          dataCollectionId: collectionName,
-          dataItem: {
-            id: item._id,
-            data: item
-          },
-          ...toUpdateOptions(options)
-        });
-        return toDataItem(dataItem);
-      });
-    }));
-    (0, _defineProperty2.default)(this, "remove", withArgs(async (args, collectionName, itemId, options) => {
-      await apiValidator().arity('remove', args, 2, 3).collectionName(collectionName).itemId(itemId).options(options).validateAndReject();
-      return this.trace('remove', {
-        collectionName,
-        itemId
-      })(async env => {
-        const {
-          dataItem
-        } = await this.client.removeDataItem({
-          ...env,
-          dataCollectionId: collectionName,
-          dataItemId: itemId,
-          ...toRemoveOptions(options)
-        }).catch(recover(ItemDoesNotExistCode, {}));
-        return dataItem ? toDataItem(dataItem) : null;
-      });
-    }));
     (0, _defineProperty2.default)(this, "toFieldModificationApi", fieldModification => {
       switch (fieldModification.action) {
         case 'SET_FIELD':
@@ -213,32 +114,27 @@ class WixDataApi {
           };
       }
     });
-    (0, _defineProperty2.default)(this, "asyncPatchByFilter", (collectionName, filter) => {
+    (0, _defineProperty2.default)(this, "asyncPatchByFilter", withArgs(async (args, collectionName, filter, fieldModifications, options) => {
+      await apiValidator().arity('asyncPatchByFilter', args, 3, 4).collectionName(collectionName).options(options).validateAndReject();
       const apiFilter = createExplicitFilter(filter);
-      return new _WixDataPatchImpl.WixDataPatchByFilterImpl({
-        collectionName,
-        filter: apiFilter,
-        onRun: async (_args, patchParams, options) => {
-          const fieldModifications = patchParams.fieldModifications.map(this.toFieldModificationApi);
-          return this.trace('asyncPatchByFilter', {
-            collectionName
-          })(async env => {
-            const {
-              jobId
-            } = await this.client.asyncPatchDataItemsByFilter({
-              ...env,
-              dataCollectionId: patchParams.collectionName,
-              filter: patchParams.filter,
-              fieldModifications,
-              ...toAsyncByFilterOptions(options)
-            });
-            return {
-              jobId: jobId
-            };
-          });
-        }
+      const apiFieldModifications = fieldModifications.map(this.toFieldModificationApi);
+      return this.trace('asyncPatchByFilter', {
+        collectionName
+      })(async env => {
+        const {
+          jobId
+        } = await this.client.asyncPatchDataItemsByFilter({
+          ...env,
+          dataCollectionId: collectionName,
+          filter: apiFilter,
+          fieldModifications: apiFieldModifications,
+          ...toAsyncPatchByFilterOptions(options)
+        });
+        return {
+          jobId: jobId
+        };
       });
-    });
+    }));
     (0, _defineProperty2.default)(this, "asyncRemoveByFilter", withArgs(async (args, collectionName, filter, options) => {
       await apiValidator().arity('asyncRemoveByFilter', args, 2, 3).collectionName(collectionName).options(options).validateAndReject();
       const apiFilter = createExplicitFilter(filter);
@@ -334,37 +230,6 @@ class WixDataApi {
         return this.client.aggregatePipelineDataItems(request);
       });
     }));
-    (0, _defineProperty2.default)(this, "distinct", withArgs(async (args, collectionName, fieldName, options) => {
-      var _options$paging, _options$cursorPaging, _options$paging2, _options$cursorPaging2;
-      await apiValidator().arity('distinct', args, 2, 3).collectionName(collectionName).fieldName(fieldName).options(options).validateAndReject();
-      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;
-      return this.trace('distinct', {
-        collectionName,
-        field: fieldName
-      })(async env => {
-        const {
-          distinctValues,
-          pagingMetadata
-        } = await this.client.queryDistinctValues({
-          ...env,
-          dataCollectionId: collectionName,
-          ...toReadOptions(options),
-          ...toPaging(limit, cursor ?? offset),
-          ...(cursor === undefined ? {
-            fieldName,
-            filter: options == null ? void 0 : options.filter,
-            order: options == null ? void 0 : options.order,
-            returnTotalCount: options == null ? void 0 : options.returnTotalCount
-          } : {})
-        });
-        return {
-          values: distinctValues,
-          pagingMetadata: pagingMetadata
-        };
-      });
-    }));
     /** @internal */
     (0, _defineProperty2.default)(this, "count", withArgs(async (args, collectionName, options) => {
       await apiValidator().arity('count', args, 1, 2).collectionName(collectionName).options(options).validateAndReject();
@@ -406,39 +271,6 @@ class WixDataApi {
         return toBulkResult(itemIds, results, ['WDE0073']);
       });
     }));
-    (0, _defineProperty2.default)(this, "bulkInsert", withArgs(async (args, collectionName, items, options) => {
-      await apiValidator().arity('bulkInsert', args, 2, 3).items(items, collectionName).bulkInsertOptions(options).collectionName(collectionName).validateAndReject();
-      return this.trace('bulkInsert', {
-        collectionName,
-        options
-      })(async appId => this.runBulkSave(appId, collectionName, items, options, (options == null ? void 0 : options.overrideExisting) ?? false));
-    }));
-    (0, _defineProperty2.default)(this, "bulkSave", withArgs(async (args, collectionName, items, options) => {
-      await apiValidator().arity('bulkSave', args, 2, 3).bulkInsertOptions(options).collectionName(collectionName).items(items, collectionName).validateAndReject();
-      return this.trace('bulkSave', {
-        collectionName
-      })(async env => this.runBulkSave(env, collectionName, items, options));
-    }));
-    (0, _defineProperty2.default)(this, "bulkUpdate", withArgs(async (args, collectionName, items, options) => {
-      await apiValidator().arity('bulkUpdate', args, 2, 3).bulkUpdateOptions(options).collectionName(collectionName).items(items, collectionName).validateAndReject();
-      return this.trace('bulkUpdate', {
-        collectionName
-      })(async env => {
-        const {
-          results
-        } = await this.client.bulkUpdateDataItems({
-          ...env,
-          dataCollectionId: collectionName,
-          dataItems: items.map(data => ({
-            id: data._id,
-            data
-          })),
-          ...toBulkUpdateOptions(options)
-        });
-        // Non-existing items are skipped and not reported as errors.
-        return toBulkResult(items, results, ['WDE0073']);
-      });
-    }));
     // --- references ---
     (0, _defineProperty2.default)(this, "fetchReferenced", withArgs(async (args, collectionName, cursor, limit, options) => {
       await apiValidator().arity('fetchReferenced', args, 2, 4).isNonEmptyString(cursor, 'cursor').collectionName(collectionName).validateAndReject();
@@ -498,36 +330,6 @@ 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;
@@ -620,12 +422,116 @@ class WixDataApi {
   get filter() {
     return (0, _common.filterBuilder)();
   }
+  // --- single-item methods ---
+
+  async get(collectionName, itemId, options) {
+    await apiValidator().arity('get', arguments, 2, 3).collectionName(collectionName).itemId(itemId).options(options).validateAndReject();
+    return this.trace('get', {
+      collectionName,
+      itemId
+    })(async env => {
+      var _options$includeField;
+      const {
+        dataItem
+      } = await this.client.getDataItem({
+        ...env,
+        dataCollectionId: collectionName,
+        dataItemId: itemId,
+        ...toReadOptions(options),
+        fields: options == null ? void 0 : options.fields,
+        includeReferences: options == null ? void 0 : options.includeReferences,
+        ...(options != null && (_options$includeField = options.includeFieldGroups) != null && _options$includeField.length ? {
+          includeFieldGroups: options.includeFieldGroups
+        } : {})
+      }).catch(recover(ItemDoesNotExistCode, {}));
+      return dataItem ? toDataItem(dataItem) : null;
+    });
+  }
+  async insert(collectionName, item, options) {
+    const itemAsWixData = item;
+    await apiValidator().arity('insert', arguments, 2, 3).collectionName(collectionName).item(itemAsWixData, collectionName, false).options(options).validateAndReject();
+    warnAboutBrokenFields(itemAsWixData);
+    return this.trace('insert', {
+      collectionName
+    })(async env => {
+      const {
+        dataItem
+      } = await this.client.insertDataItem({
+        ...env,
+        dataCollectionId: collectionName,
+        dataItem: {
+          id: itemAsWixData._id,
+          data: itemAsWixData
+        },
+        ...toInsertOptions(options)
+      });
+      return toDataItem(dataItem);
+    });
+  }
+  async save(collectionName, item, options) {
+    const itemAsWixData = item;
+    await apiValidator().arity('save', arguments, 2, 3).collectionName(collectionName).item(itemAsWixData, collectionName, false).options(options).validateAndReject();
+    return this.trace('save', {
+      collectionName
+    })(async env => {
+      const {
+        dataItem
+      } = await this.client.saveDataItem({
+        ...env,
+        dataCollectionId: collectionName,
+        dataItem: {
+          id: itemAsWixData._id,
+          data: itemAsWixData
+        },
+        ...toSaveOptions(options)
+      });
+      return toDataItem(dataItem);
+    });
+  }
+  async update(collectionName, item, options) {
+    await apiValidator().arity('update', arguments, 2, 3).collectionName(collectionName).item(item, collectionName, false).options(options).validateAndReject();
+    return this.trace('update', {
+      collectionName
+    })(async env => {
+      const {
+        dataItem
+      } = await this.client.updateDataItem({
+        ...env,
+        dataCollectionId: collectionName,
+        dataItem: {
+          id: item._id,
+          data: item
+        },
+        ...toUpdateOptions(options)
+      });
+      return toDataItem(dataItem);
+    });
+  }
+  async remove(collectionName, itemId, options) {
+    await apiValidator().arity('remove', arguments, 2, 3).collectionName(collectionName).itemId(itemId).options(options).validateAndReject();
+    return this.trace('remove', {
+      collectionName,
+      itemId
+    })(async env => {
+      const {
+        dataItem
+      } = await this.client.removeDataItem({
+        ...env,
+        dataCollectionId: collectionName,
+        dataItemId: itemId,
+        ...toRemoveOptions(options)
+      }).catch(recover(ItemDoesNotExistCode, {}));
+      return dataItem ? toDataItem(dataItem) : null;
+    });
+  }
+
   /**
    * Returns a patch builder for the specified collection and item.
    * @param collectionName - Name of the collection containing the item to patch.
    * @param itemId - ID of the item to patch.
    * @returns A `WixDataPatch` builder object.
    */
+
   /**
    * Executes a patch directly without using the builder pattern.
    * @internal
@@ -635,6 +541,7 @@ class WixDataApi {
    * @param options - Additional options for the patch operation.
    * @returns Promise that resolves to the patched item, or `null` if no item was returned.
    */
+
   patch(collectionName, itemId, fieldModifications, options) {
     if (arguments.length >= 3) {
       return this.executeDirectPatch(collectionName, itemId, fieldModifications, options);
@@ -1075,6 +982,37 @@ class WixDataApi {
       pagingMetadata: pagingMetadata
     };
   }
+  async distinct(collectionName, fieldName, options) {
+    var _options$paging, _options$cursorPaging, _options$paging2, _options$cursorPaging2;
+    await apiValidator().arity('distinct', arguments, 2, 3).collectionName(collectionName).fieldName(fieldName).options(options).validateAndReject();
+    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;
+    return this.trace('distinct', {
+      collectionName,
+      field: fieldName
+    })(async env => {
+      const {
+        distinctValues,
+        pagingMetadata
+      } = await this.client.queryDistinctValues({
+        ...env,
+        dataCollectionId: collectionName,
+        ...toReadOptions(options),
+        ...toPaging(limit, cursor ?? offset),
+        ...(cursor === undefined ? {
+          fieldName,
+          filter: options == null ? void 0 : options.filter,
+          order: options == null ? void 0 : options.order,
+          returnTotalCount: options == null ? void 0 : options.returnTotalCount
+        } : {})
+      });
+      return {
+        values: distinctValues,
+        pagingMetadata: pagingMetadata
+      };
+    });
+  }
   async runBulkSave(env, collectionName, items, options, overrideExisting = true) {
     const request = {
       ...env,
@@ -1092,6 +1030,71 @@ class WixDataApi {
     const ignoreCodes = overrideExisting ? [] : ['WDE0074'];
     return toBulkResult(items, results, ignoreCodes);
   }
+  async bulkInsert(collectionName, items, options) {
+    const itemsAsWixData = items;
+    await apiValidator().arity('bulkInsert', arguments, 2, 3).items(itemsAsWixData, collectionName).bulkInsertOptions(options).collectionName(collectionName).validateAndReject();
+    return this.trace('bulkInsert', {
+      collectionName,
+      options
+    })(async appId => this.runBulkSave(appId, collectionName, itemsAsWixData, options, (options == null ? void 0 : options.overrideExisting) ?? false));
+  }
+  async bulkSave(collectionName, items, options) {
+    const itemsAsWixData = items;
+    await apiValidator().arity('bulkSave', arguments, 2, 3).bulkInsertOptions(options).collectionName(collectionName).items(itemsAsWixData, collectionName).validateAndReject();
+    return this.trace('bulkSave', {
+      collectionName
+    })(async env => this.runBulkSave(env, collectionName, itemsAsWixData, options));
+  }
+  async bulkUpdate(collectionName, items, options) {
+    await apiValidator().arity('bulkUpdate', arguments, 2, 3).bulkUpdateOptions(options).collectionName(collectionName).items(items, collectionName).validateAndReject();
+    return this.trace('bulkUpdate', {
+      collectionName
+    })(async env => {
+      const {
+        results
+      } = await this.client.bulkUpdateDataItems({
+        ...env,
+        dataCollectionId: collectionName,
+        dataItems: items.map(data => ({
+          id: data._id,
+          data
+        })),
+        ...toBulkUpdateOptions(options)
+      });
+      // Non-existing items are skipped and not reported as errors.
+      return toBulkResult(items, results, ['WDE0073']);
+    });
+  }
+  async queryReferencedItems(collectionName, referringItem, referringItemFieldName, options) {
+    await apiValidator().arity('queryReferencedItems', arguments, 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
+      };
+    });
+  }
   trace(action, opts) {
     return async fn => {
       const gridAppId = await get(this.gridAppId);
@@ -1129,10 +1132,10 @@ function toBulkPatchOptions(options) {
     ...conditionOptions(options == null ? void 0 : options.condition)
   };
 }
-function toAsyncByFilterOptions(options) {
+function toAsyncRemoveByFilterOptions(options) {
   return toAsyncOptions(options);
 }
-function toAsyncRemoveByFilterOptions(options) {
+function toAsyncPatchByFilterOptions(options) {
   return toAsyncOptions(options);
 }
 function toAsyncOptions(options) {