floppy-disk 3.0.0-alpha.5 → 3.0.0-alpha.6

package/react/use-mutation.d.ts

@@ -0,0 +1,82 @@
+import { type MutationOptions, type MutationState } from './create-mutation';
+/**
+ * A hook for managing async mutation state.
+ *
+ * @param mutationFn - Async function that performs the mutation.
+ * Receives the input variable and the state snapshot before execution.
+ *
+ * @param options - Optional lifecycle callbacks:
+ * - `onSuccess(data, variable, stateBeforeExecute)`
+ * - `onError(error, variable, stateBeforeExecute)`
+ * - `onSettled(variable, stateBeforeExecute)`
+ *
+ * @returns A tuple containing:
+ * - state: The current mutation state (render snapshot)
+ * - controls: An object with mutation actions and helpers
+ *
+ * @remarks
+ * - No retry mechanism is provided by default.
+ * - The mutation always resolves (never throws): the result contains either `data` or `error`.
+ * - If multiple executions triggered at the same time:
+ *   - Only the latest execution is allowed to update the state.
+ *   - Results from previous executions are ignored if a newer one exists.
+ */
+export declare const useMutation: <TData, TVariable = undefined, TError = Error>(
+/**
+ * Async function that performs the mutation.
+ *
+ * @remarks
+ * - Does NOT need to be memoized (e.g. `useCallback`).
+ * - The latest function reference is always used internally.
+ */
+mutationFn: (variable: TVariable, stateBeforeExecute: MutationState<TData, TVariable, TError>) => Promise<TData>, 
+/**
+ * Optional lifecycle callbacks.
+ *
+ * @remarks
+ * - Callbacks do NOT need to be memoized.
+ * - The latest callbacks are always used internally.
+ */
+options?: MutationOptions<TData, TVariable, TError>) => [MutationState<TData, TVariable, TError>, {
+    /**
+     * Executes the mutation.
+     *
+     * @param variable - Input passed to the mutation function
+     *
+     * @returns A promise that always resolves with:
+     * - `{ data, variable }` on success
+     * - `{ error, variable }` on failure
+     *
+     * @remarks
+     * - The promise never rejects to simplify async handling.
+     * - If a mutation is already in progress, a warning is logged.
+     * - When a new execution starts, all previous pending executions will resolve with the result of the latest execution.
+     */
+    execute: TVariable extends undefined ? () => Promise<{
+        variable: undefined;
+        data?: TData;
+        error?: TError;
+    }> : (variable: TVariable) => Promise<{
+        variable: TVariable;
+        data?: TData;
+        error?: TError;
+    }>;
+    /**
+     * Resets the mutation state back to its initial state.
+     *
+     * @remarks
+     * - Does not cancel any ongoing execution.
+     * - If an execution is still pending, its result may override the reset state.
+     */
+    reset: () => void;
+    /**
+     * Returns the latest mutation state directly from the internal ref.
+     *
+     * @returns The most up-to-date mutation state.
+     *
+     * @remarks
+     * - Unlike the `state` returned by the hook, this value is not tied to React render cycles.
+     * - Use this inside async flows or event handlers to avoid stale reads.
+     */
+    getLatestState: () => MutationState<TData, TVariable, TError>;
+}];

package/react.d.ts

@@ -3,4 +3,5 @@ export { useStoreState } from './react/use-store';
 export * from './react/create-store';
 export * from './react/create-stores';
 export * from './react/create-query';
-export * from './react/create-mutation';
+export { createMutation, type MutationOptions, type MutationState, } from './react/create-mutation';
+export * from './react/use-mutation';

package/react.js

@@ -130,7 +130,7 @@ const createQuery = (queryFn, options = {}) => {
     onSettled = vanilla.noop,
     shouldRetry: shouldRetryFn = (_, s) => s.retryCount === 0 ? [true, 1500] : [false]
   } = options;
-  const initialState = INITIAL_STATE$1;
+  const initialState = { ...INITIAL_STATE$1 };
   const stores = /* @__PURE__ */ new Map();
   const configureStoreEvents = () => ({
     ...options,
@@ -369,7 +369,7 @@ const createQuery = (queryFn, options = {}) => {
       internals.set(store, configureInternals(store, variable, variableHash));
     }
     const useStore = (options2 = {}) => {
-      const { enabled = true, keepPreviousData } = options2;
+      const { revalidateOnMount = true, keepPreviousData } = options2;
       const storeState = store.getState();
       const prevState = react.useRef({});
       let storeStateToBeUsed = storeState;
@@ -382,7 +382,7 @@ const createQuery = (queryFn, options = {}) => {
         storeStateToBeUsed = { ...storeState, ...prevState.current };
       }
       const [trackedState, usedPathsRef] = useStoreStateProxy(
-        enabled && storeState.state === "INITIAL" ? (
+        revalidateOnMount && storeState.state === "INITIAL" ? (
           // Optimize rendering on initial state
           // Do { isPending: true } → result
           // instead of { isPending: false } → { isPending: true } → result
@@ -406,8 +406,8 @@ const createQuery = (queryFn, options = {}) => {
         });
       }, [store]);
       useIsomorphicLayoutEffect(() => {
-        if (enabled !== false) revalidate(store, variable, false);
-      }, [store, enabled]);
+        if (revalidateOnMount !== false) revalidate(store, variable, false);
+      }, [store, revalidateOnMount]);
       if (keepPreviousData) {
         !!trackedState.error;
       }
@@ -481,19 +481,26 @@ const INITIAL_STATE = {
 };
 const createMutation = (mutationFn, options = {}) => {
   const { onSuccess = vanilla.noop, onError, onSettled = vanilla.noop } = options;
-  const initialState = INITIAL_STATE;
+  const initialState = { ...INITIAL_STATE };
+  let ongoingPromise;
+  const resolveFns = /* @__PURE__ */ new Set([]);
   const store = vanilla.initStore(initialState, options);
   const useStore = () => useStoreState(store.getState(), store.subscribe);
   const execute = (variable) => {
+    let currentResolveFn;
     const stateBeforeExecute = store.getState();
     if (stateBeforeExecute.isPending) {
       console.warn(
-        "Mutation executed while a previous execution is still pending. This may cause race conditions or unexpected state updates."
+        "A mutation was executed while a previous execution is still pending. The previous execution will be ignored (latest execution wins)."
       );
     }
     store.setState({ isPending: true });
-    return new Promise((resolve) => {
+    const promise = new Promise((resolve) => {
+      currentResolveFn = resolve;
       mutationFn(variable, stateBeforeExecute).then((data) => {
+        if (promise !== ongoingPromise) {
+          return resolve({ data, variable });
+        }
         store.setState({
           state: "SUCCESS",
           isPending: false,
@@ -506,8 +513,12 @@ const createMutation = (mutationFn, options = {}) => {
           errorUpdatedAt: void 0
         });
         resolve({ data, variable });
+        resolveFns.clear();
         onSuccess(data, variable, stateBeforeExecute);
       }).catch((error) => {
+        if (promise !== ongoingPromise) {
+          return resolve({ error, variable });
+        }
         store.setState({
           state: "ERROR",
           isPending: false,
@@ -520,12 +531,19 @@ const createMutation = (mutationFn, options = {}) => {
           errorUpdatedAt: Date.now()
         });
         resolve({ error, variable });
+        resolveFns.clear();
         if (onError) onError(error, variable, stateBeforeExecute);
         else console.error(store.getState());
       }).finally(() => {
+        if (promise !== ongoingPromise) return;
         onSettled(variable, stateBeforeExecute);
+        ongoingPromise = void 0;
       });
     });
+    if (ongoingPromise) resolveFns.forEach((resolveFn) => resolveFn(promise));
+    resolveFns.add(currentResolveFn);
+    ongoingPromise = promise;
+    return promise;
   };
   return Object.assign(useStore, {
     subscribe: store.subscribe,
@@ -552,17 +570,17 @@ const createMutation = (mutationFn, options = {}) => {
      * - `{ error, variable }` on failure
      *
      * @remarks
-     * - If a mutation is already in progress, a warning is logged.
-     * - Concurrent executions are allowed but may lead to race conditions.
      * - The promise never rejects to simplify async handling.
+     * - If a mutation is already in progress, a warning is logged.
+     * - When a new execution starts, all previous pending executions will resolve with the result of the latest execution.
      */
     execute,
     /**
      * Resets the mutation state back to its initial state.
      *
      * @remarks
-     * - Does not cancel any ongoing request.
-     * - If a request is still pending, its result may override the reset state.
+     * - Does not cancel any ongoing execution.
+     * - If an execution is still pending, its result may override the reset state.
      */
     reset: () => {
       if (store.getState().isPending) {
@@ -575,9 +593,113 @@ const createMutation = (mutationFn, options = {}) => {
   });
 };
 
+const useMutation = (mutationFn, options = {}) => {
+  const { onSuccess = vanilla.noop, onError, onSettled = vanilla.noop } = options;
+  const callbackRef = react.useRef({ onSuccess, onError, onSettled });
+  callbackRef.current.onSuccess = onSuccess;
+  callbackRef.current.onError = onError;
+  callbackRef.current.onSettled = onSettled;
+  const stateRef = react.useRef({ ...INITIAL_STATE });
+  const [, reRender] = react.useState({});
+  const refs = react.useRef({
+    mutationFn,
+    ongoingPromise: void 0,
+    resolveFns: /* @__PURE__ */ new Set()
+  });
+  refs.current.mutationFn = mutationFn;
+  const execute = react.useCallback((variable) => {
+    let currentResolveFn;
+    const stateBeforeExecute = stateRef.current;
+    if (stateBeforeExecute.isPending) {
+      console.warn(
+        "A mutation was executed while a previous execution is still pending. The previous execution will be ignored (latest execution wins)."
+      );
+    }
+    stateRef.current.isPending = true;
+    reRender({});
+    const promise = new Promise(
+      (resolve) => {
+        currentResolveFn = resolve;
+        refs.current.mutationFn(variable, stateBeforeExecute).then((data) => {
+          if (promise !== refs.current.ongoingPromise) {
+            return resolve({ data, variable });
+          }
+          stateRef.current = {
+            state: "SUCCESS",
+            isPending: false,
+            isSuccess: true,
+            isError: false,
+            variable,
+            data,
+            dataUpdatedAt: Date.now(),
+            error: void 0,
+            errorUpdatedAt: void 0
+          };
+          reRender({});
+          resolve({ data, variable });
+          refs.current.resolveFns.clear();
+          callbackRef.current.onSuccess(data, variable, stateBeforeExecute);
+        }).catch((error) => {
+          if (promise !== refs.current.ongoingPromise) {
+            return resolve({ error, variable });
+          }
+          stateRef.current = {
+            state: "ERROR",
+            isPending: false,
+            isSuccess: false,
+            isError: true,
+            variable,
+            data: void 0,
+            dataUpdatedAt: void 0,
+            error,
+            errorUpdatedAt: Date.now()
+          };
+          reRender({});
+          resolve({ error, variable });
+          refs.current.resolveFns.clear();
+          if (callbackRef.current.onError) {
+            callbackRef.current.onError(error, variable, stateBeforeExecute);
+          } else {
+            console.error(stateRef.current);
+          }
+        }).finally(() => {
+          if (promise !== refs.current.ongoingPromise) return;
+          callbackRef.current.onSettled(variable, stateBeforeExecute);
+          refs.current.ongoingPromise = void 0;
+        });
+      }
+    );
+    if (refs.current.ongoingPromise) {
+      refs.current.resolveFns.forEach((resolveFn) => resolveFn(promise));
+    }
+    refs.current.resolveFns.add(currentResolveFn);
+    refs.current.ongoingPromise = promise;
+    return promise;
+  }, []);
+  const reset = react.useCallback(() => {
+    if (stateRef.current.isPending) {
+      console.warn(
+        "Mutation state was reset while a request is still pending. The request will continue, but its result may override the reset state."
+      );
+    }
+    stateRef.current = { ...INITIAL_STATE };
+    reRender({});
+  }, []);
+  const r = [
+    stateRef.current,
+    {
+      execute,
+      reset,
+      getLatestState: () => stateRef.current
+    }
+  ];
+  return r;
+};
+
 exports.createMutation = createMutation;
 exports.createQuery = createQuery;
 exports.createStore = createStore;
 exports.createStores = createStores;
 exports.useIsomorphicLayoutEffect = useIsomorphicLayoutEffect;
+exports.useMutation = useMutation;
 exports.useStoreState = useStoreState;