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

package/dist/cjs/api/FieldModification.js

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

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

@@ -0,0 +1 @@
+{"version":3,"names":[],"sources":["../../../src/api/FieldModification.ts"],"sourcesContent":["export interface SetField {\n  /**\n   * Path of the field ID to be modified. Nested fields can be specified using dot notation.\n   */\n  fieldPath: string\n  action: 'SET_FIELD'\n  value: any\n}\n\nexport interface RemoveField {\n  /**\n   * Path of the field ID to be modified. Nested fields can be specified using dot notation.\n   */\n  fieldPath: string\n  action: 'REMOVE_FIELD'\n}\n\nexport interface IncrementField {\n  /**\n   * Path of the field ID to be modified. Nested fields can be specified using dot notation.\n   */\n  fieldPath: string\n  action: 'INCREMENT_FIELD'\n  value: any\n}\n\nexport interface AppendToArray {\n  /**\n   * Path of the field ID to be modified. Nested fields can be specified using dot notation.\n   */\n  fieldPath: string\n  action: 'APPEND_TO_ARRAY'\n  value: any\n}\n\nexport interface RemoveFromArray {\n  /**\n   * Path of the field ID to be modified. Nested fields can be specified using dot notation.\n   */\n  fieldPath: string\n  action: 'REMOVE_FROM_ARRAY'\n  value: any\n}\n\nexport type FieldModification =\n  | SetField\n  | RemoveField\n  | IncrementField\n  | AppendToArray\n  | RemoveFromArray\n"],"mappings":"","ignoreList":[]}

package/dist/cjs/api/WixDataApi.js

@@ -176,7 +176,7 @@ class WixDataApi {
             action: apiTypes.ACTION.SET_FIELD,
             fieldPath: fieldModification.fieldPath,
             setFieldOptions: {
-              value: fieldModification.actionOptions
+              value: fieldModification.value
             }
           };
         case 'REMOVE_FIELD':
@@ -189,7 +189,7 @@ class WixDataApi {
             action: apiTypes.ACTION.INCREMENT_FIELD,
             fieldPath: fieldModification.fieldPath,
             incrementFieldOptions: {
-              value: fieldModification.actionOptions
+              value: fieldModification.value
             }
           };
         case 'APPEND_TO_ARRAY':
@@ -197,7 +197,7 @@ class WixDataApi {
             action: apiTypes.ACTION.APPEND_TO_ARRAY,
             fieldPath: fieldModification.fieldPath,
             appendToArrayOptions: {
-              value: fieldModification.actionOptions
+              value: fieldModification.value
             }
           };
         case 'REMOVE_FROM_ARRAY':
@@ -205,61 +205,11 @@ class WixDataApi {
             action: apiTypes.ACTION.REMOVE_FROM_ARRAY,
             fieldPath: fieldModification.fieldPath,
             removeFromArrayOptions: {
-              value: fieldModification.actionOptions
+              value: fieldModification.value
             }
           };
-        default:
-          throw new Error('Invalid patch action');
       }
     });
-    (0, _defineProperty2.default)(this, "patch", (collectionName, itemId) => {
-      return new _WixDataPatchImpl.WixDataPatchImpl({
-        collectionName,
-        itemId,
-        onRun: async (_args, patchParams, options) => {
-          const fieldModifications = patchParams.fieldModifications.map(this.toFieldModificationApi);
-          return this.trace('patch', {
-            collectionName
-          })(async env => {
-            const result = await this.client.patchDataItem({
-              ...env,
-              dataCollectionId: patchParams.collectionName,
-              patch: {
-                dataItemId: patchParams.itemId,
-                fieldModifications
-              },
-              ...toPatchOptions(options)
-            });
-            return result.dataItem ? toDataItem(result.dataItem) : null;
-          });
-        }
-      });
-    });
-    (0, _defineProperty2.default)(this, "bulkPatch", (collectionName, itemIds) => {
-      return new _WixDataPatchImpl.WixDataBulkPatchImpl({
-        collectionName,
-        itemIds,
-        onRun: async (_args, patchParams, options) => {
-          const fieldModifications = patchParams.fieldModifications.map(this.toFieldModificationApi);
-          return this.trace('bulkPatch', {
-            collectionName
-          })(async env => {
-            const {
-              results
-            } = await this.client.bulkPatchDataItems({
-              ...env,
-              dataCollectionId: patchParams.collectionName,
-              patches: patchParams.itemIds.map(itemId => ({
-                dataItemId: itemId,
-                fieldModifications
-              })),
-              ...toPatchOptions(options)
-            });
-            return toBulkResult(itemIds, results, ['WDE0073']);
-          });
-        }
-      });
-    });
     (0, _defineProperty2.default)(this, "asyncPatchByFilter", (collectionName, filter) => {
       const apiFilter = createExplicitFilter(filter);
       return new _WixDataPatchImpl.WixDataPatchByFilterImpl({
@@ -639,12 +589,132 @@ class WixDataApi {
   }
   get filter() {
     return (0, _common.filterBuilder)();
-  } // --- query, count, distinct ---
+  }
+  /**
+   * 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
+   * @param collectionName - Name of the collection containing the item to patch.
+   * @param itemId - ID of the item to patch.
+   * @param fieldModifications - Field modifications to apply to the item.
+   * @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);
+    }
+    return new _WixDataPatchImpl.WixDataPatchImpl({
+      collectionName,
+      itemId,
+      onRun: async (_args, patchParams, options) => {
+        const fieldModifications = patchParams.fieldModifications.map(this.toFieldModificationApi);
+        return this.trace('patch', {
+          collectionName
+        })(async env => {
+          const result = await this.client.patchDataItem({
+            ...env,
+            dataCollectionId: patchParams.collectionName,
+            patch: {
+              dataItemId: patchParams.itemId,
+              fieldModifications
+            },
+            ...toPatchOptions(options)
+          });
+          return result.dataItem ? toDataItem(result.dataItem) : null;
+        });
+      }
+    });
+  }
+  async executeDirectPatch(collectionName, itemId, fieldModifications, options) {
+    const apiFieldModifications = fieldModifications == null ? void 0 : fieldModifications.map(this.toFieldModificationApi);
+    return this.trace('patch', {
+      collectionName
+    })(async env => {
+      const result = await this.client.patchDataItem({
+        ...env,
+        dataCollectionId: collectionName,
+        patch: {
+          dataItemId: itemId,
+          fieldModifications: apiFieldModifications
+        },
+        ...toPatchOptions(options)
+      });
+      return result.dataItem ? toDataItem(result.dataItem) : null;
+    });
+  }
+
+  /**
+   * Executes a bulk patch directly without using the builder pattern.
+   * @internal
+   * @param collectionName - Name of the collection containing the items to patch.
+   * @param itemIds - IDs of the items to patch.
+   * @param fieldModifications - Field modifications to apply to the items.
+   * @param options - Additional options for the bulk patch operation.
+   * @returns Promise that resolves to bulk operation results.
+   */
+
+  bulkPatch(collectionName, itemIds, fieldModifications, options) {
+    if (arguments.length >= 3) {
+      return this.executeDirectBulkPatch(collectionName, itemIds, fieldModifications, options);
+    }
+    return new _WixDataPatchImpl.WixDataBulkPatchImpl({
+      collectionName,
+      itemIds,
+      onRun: async (_args, patchParams, options) => {
+        const fieldModifications = patchParams.fieldModifications.map(this.toFieldModificationApi);
+        return this.trace('bulkPatch', {
+          collectionName
+        })(async env => {
+          const {
+            results
+          } = await this.client.bulkPatchDataItems({
+            ...env,
+            dataCollectionId: patchParams.collectionName,
+            patches: patchParams.itemIds.map(itemId => ({
+              dataItemId: itemId,
+              fieldModifications
+            })),
+            ...toPatchOptions(options)
+          });
+          return toBulkResult(itemIds, results, ['WDE0073']);
+        });
+      }
+    });
+  }
+  async executeDirectBulkPatch(collectionName, itemIds, fieldModifications, options) {
+    const apiFieldModifications = fieldModifications == null ? void 0 : fieldModifications.map(this.toFieldModificationApi);
+    return this.trace('bulkPatch', {
+      collectionName
+    })(async env => {
+      const {
+        results
+      } = await this.client.bulkPatchDataItems({
+        ...env,
+        dataCollectionId: collectionName,
+        patches: itemIds.map(itemId => ({
+          dataItemId: itemId,
+          fieldModifications: apiFieldModifications
+        })),
+        ...toPatchOptions(options)
+      });
+      return toBulkResult(itemIds, results, ['WDE0073']);
+    });
+  }
+
+  // --- query, count, distinct ---
+
   /**
    * Returns a query builder for the specified collection.
    * @param collectionName - Name of the collection to query.
    * @returns A `WixDataQuery` builder object.
    */
+
   /**
    * Executes a query directly without using the builder pattern.
    * @internal
@@ -653,6 +723,7 @@ class WixDataApi {
    * @param options - Additional options including includeReferences.
    * @returns Promise that resolves to the query results.
    */
+
   query(collectionName, queryRequest, options) {
     // Direct query execution mode
     if (queryRequest !== undefined) {