convex 1.24.3 → 1.24.5

package/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Changelog
 
+## 1.24.4
+
+- `ConvexClient.mutation()` now accepts a third `options` argument that can
+  contain an optimistic update.
+
+- Log a warning when optimistic update handlers return a promise since they
+  should be sync.
+
 ## 1.24.3
 
 - Add `.url` property to ConvexReactClient.

package/dist/browser.bundle.js

@@ -28,7 +28,7 @@ var convex = (() => {
   });
 
   // src/index.ts
-  var version = "1.24.3";
+  var version = "1.24.5";
 
   // src/values/base64.ts
   var base64_exports = {};
@@ -2804,7 +2804,15 @@ var convex = (() => {
         const optimisticUpdate = options.optimisticUpdate;
         if (optimisticUpdate !== void 0) {
           const wrappedUpdate = (localQueryStore) => {
-            optimisticUpdate(localQueryStore, mutationArgs);
+            const result = optimisticUpdate(
+              localQueryStore,
+              mutationArgs
+            );
+            if (result instanceof Promise) {
+              this.logger.warn(
+                "Optimistic update handler returned a Promise. Optimistic updates should be synchronous."
+              );
+            }
           };
           const changedQueryTokens = this.optimisticQueryResults.applyOptimisticUpdate(
             wrappedUpdate,
@@ -3174,9 +3182,9 @@ var convex = (() => {
      * @param options - A {@link MutationOptions} options object for the mutation.
      * @returns A promise of the mutation's result.
      */
-    async mutation(mutation, args) {
+    async mutation(mutation, args, options) {
       if (this.disabled) throw new Error("ConvexClient is disabled");
-      return await this.client.mutation(getFunctionName(mutation), args);
+      return await this.client.mutation(getFunctionName(mutation), args, options);
     }
     /**
      * Execute an action function.