floppy-disk 3.0.0-beta.1 → 3.0.0-beta.3

package/react.js

@@ -5,28 +5,73 @@ var vanilla = require('floppy-disk/vanilla');
 
 const useIsomorphicLayoutEffect = vanilla.isClient ? react.useLayoutEffect : react.useEffect;
 
-const useStoreUpdateNotifier = (store, selector) => {
-  const [, reRender] = react.useState({});
-  const selectorRef = react.useRef(selector);
-  selectorRef.current = selector;
-  useIsomorphicLayoutEffect(
-    () => store.subscribe((state, prevState) => {
-      if (selectorRef.current === vanilla.identity) return reRender({});
-      const prevSlice = selectorRef.current(prevState);
-      const nextSlice = selectorRef.current(state);
-      if (!vanilla.shallow(prevSlice, nextSlice)) reRender({});
-    }),
-    [store]
-  );
+const getValueByPath = (obj, path) => path.reduce((acc, key) => acc == null ? void 0 : acc[key], obj);
+const isPrefixPath = (candidatePrefix, targetPath) => {
+  if (candidatePrefix.length >= targetPath.length) return false;
+  for (let i = 0; i < candidatePrefix.length; i++) {
+    if (candidatePrefix[i] !== targetPath[i]) return false;
+  }
+  return true;
+};
+const compressPaths = (paths) => {
+  const result = [];
+  let prev = null;
+  for (let i = paths.length - 1; i >= 0; i--) {
+    const current = paths[i];
+    if (!prev || !isPrefixPath(current, prev)) result.push(current);
+    prev = current;
+  }
+  return result;
 };
-const useStoreState = (store, selector = vanilla.identity) => {
-  useStoreUpdateNotifier(store, selector);
-  return selector(store.getState());
+const useStoreStateProxy = (storeState) => {
+  const usedPathsRef = react.useRef([]);
+  usedPathsRef.current = [];
+  const trackedState = react.useMemo(() => {
+    const track = (path) => usedPathsRef.current.push(path);
+    const proxyCache = /* @__PURE__ */ new WeakMap();
+    const createDeepProxy = (target, path = []) => {
+      if (typeof target !== "object" || target === null) {
+        return target;
+      }
+      if (proxyCache.has(target)) {
+        return proxyCache.get(target);
+      }
+      const proxy = new Proxy(target, {
+        get(obj, key) {
+          const newPath = [...path, key];
+          track(newPath);
+          const value = obj[key];
+          return createDeepProxy(value, newPath);
+        }
+      });
+      proxyCache.set(target, proxy);
+      return proxy;
+    };
+    return createDeepProxy(storeState);
+  }, [storeState]);
+  return [trackedState, usedPathsRef];
+};
+const useStoreState = (storeState, subscribe) => {
+  const [trackedState, usedPathsRef] = useStoreStateProxy(storeState);
+  const [, reRender] = react.useState({});
+  useIsomorphicLayoutEffect(() => {
+    return subscribe((nextState, prevState, changedKeys) => {
+      const paths = compressPaths(usedPathsRef.current);
+      for (const path of paths) {
+        const rootKey = path[0];
+        if (!changedKeys.includes(rootKey)) continue;
+        const prevVal = getValueByPath(prevState, path);
+        const nextVal = getValueByPath(nextState, path);
+        if (!Object.is(prevVal, nextVal)) return reRender({});
+      }
+    });
+  }, [subscribe]);
+  return trackedState;
 };
 
 const createStore = (initialState, options) => {
   const store = vanilla.initStore(initialState, options);
-  const useStore = (selector) => useStoreState(store, selector);
+  const useStore = () => useStoreState(store.getState(), store.subscribe);
   return Object.assign(useStore, store);
 };
 
@@ -41,9 +86,7 @@ const createStores = (initialState, options) => {
       store = vanilla.initStore(initialState, options);
       stores.set(keyHash, store);
     }
-    const useStore = (selector) => {
-      return useStoreState(store, selector);
-    };
+    const useStore = () => useStoreState(store.getState(), store.subscribe);
     return Object.assign(useStore, {
       ...store,
       delete: () => {
@@ -87,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,
@@ -325,30 +368,51 @@ const createQuery = (queryFn, options = {}) => {
       stores.set(variableHash, store);
       internals.set(store, configureInternals(store, variable, variableHash));
     }
-    function useStore(optionsOrSelector = {}, maybeSelector) {
-      let selector;
-      let options2;
-      if (typeof optionsOrSelector === "function") {
-        options2 = {};
-        selector = optionsOrSelector;
-      } else {
-        options2 = optionsOrSelector;
-        selector = maybeSelector || vanilla.identity;
-      }
-      useStoreUpdateNotifier(store, selector);
-      useIsomorphicLayoutEffect(() => {
-        if (options2.enabled !== false) revalidate(store, variable, false);
-      }, [store, options2.enabled]);
+    const useStore = (options2 = {}) => {
+      const { revalidateOnMount = true, keepPreviousData } = options2;
       const storeState = store.getState();
-      let storeStateToBeUsed = storeState;
       const prevState = react.useRef({});
-      if (storeState.isSuccess) {
-        prevState.current = { data: storeState.data, dataUpdatedAt: storeState.dataUpdatedAt };
-      } else if (storeState.state === "INITIAL" && options2.keepPreviousData) {
+      let storeStateToBeUsed = storeState;
+      if (storeState.state !== "INITIAL") {
+        prevState.current = {
+          data: storeState.data,
+          dataUpdatedAt: storeState.dataUpdatedAt
+        };
+      } else if (keepPreviousData) {
         storeStateToBeUsed = { ...storeState, ...prevState.current };
       }
-      return selector(storeStateToBeUsed);
-    }
+      const [trackedState, usedPathsRef] = useStoreStateProxy(
+        revalidateOnMount && storeState.state === "INITIAL" ? (
+          // Optimize rendering on initial state
+          // Do { isPending: true } → result
+          // instead of { isPending: false } → { isPending: true } → result
+          { ...storeStateToBeUsed, isPending: true }
+        ) : storeStateToBeUsed
+      );
+      const [, reRender] = react.useState({});
+      useIsomorphicLayoutEffect(() => {
+        return store.subscribe((nextState, prevState2, changedKeys) => {
+          if (prevState2.state === "INITIAL" && !prevState2.isPending && nextState.isPending) {
+            return;
+          }
+          const paths = compressPaths(usedPathsRef.current);
+          for (const path of paths) {
+            const rootKey = path[0];
+            if (!changedKeys.includes(rootKey)) continue;
+            const prevVal = getValueByPath(prevState2, path);
+            const nextVal = getValueByPath(nextState, path);
+            if (!Object.is(prevVal, nextVal)) return reRender({});
+          }
+        });
+      }, [store]);
+      useIsomorphicLayoutEffect(() => {
+        if (revalidateOnMount !== false) revalidate(store, variable, false);
+      }, [store, revalidateOnMount]);
+      if (keepPreviousData) {
+        !!trackedState.error;
+      }
+      return trackedState;
+    };
     return Object.assign(useStore, {
       subscribe: store.subscribe,
       getSubscribers: store.getSubscribers,
@@ -417,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 = (selector) => useStoreState(store, selector);
+  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,
@@ -442,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,
@@ -456,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,
@@ -488,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) {
@@ -511,10 +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;
-exports.useStoreUpdateNotifier = useStoreUpdateNotifier;

package/vanilla/basic.d.ts

@@ -6,14 +6,6 @@ export declare const isClient: boolean;
  * Empty function.
  */
 export declare const noop: () => void;
-/**
- * Identity function.
- *
- * It accepts 1 argument, and simply return it.
- *
- * `const identity = value => value`
- */
-export declare const identity: <T>(value: T) => T;
 /**
  * If the value is a function, it will invoke the function.\
  * If the value is not a function, it will just return it.

package/vanilla/store.d.ts

@@ -11,18 +11,21 @@ export type SetState<TState> = Partial<TState> | ((state: TState) => Partial<TSt
  *
  * @param state - The latest state
  * @param prevState - The previous state before the update
+ * @param changedKeys - The top-level keys that changed (shallow diff)
  *
  * @remarks
- * - Subscribers are only called when the state actually changes.
+ * - Subscribers are only called when at least one field changes.
  * - Change detection is performed per key using `Object.is`.
+ * - `changedKeys` only includes top-level keys; nested changes must be inferred by the consumer.
  */
-export type Subscriber<TState> = (state: TState, prevState: TState) => void;
+export type Subscriber<TState> = (state: TState, prevState: TState, changedKeys: Array<keyof TState>) => void;
 /**
  * Core store API for managing state.
  *
  * @remarks
  * - The store performs **shallow change detection per key** before notifying subscribers.
  * - Subscribers are only notified when at least one field changes.
+ * - State is treated as **immutable**. Mutating nested values directly will not trigger updates.
  * - Designed to be framework-agnostic (React bindings are built separately).
  * - By default, `setState` is **disabled on the server** to prevent accidental shared state between requests.
  */
@@ -48,13 +51,17 @@ export type InitStoreOptions<TState extends Record<string, any>> = {
     onSubscribe?: (state: TState, store: StoreApi<TState>) => void;
     onUnsubscribe?: (state: TState, store: StoreApi<TState>) => void;
     onLastUnsubscribe?: (state: TState, store: StoreApi<TState>) => void;
+    /**
+     * By default, calling `setState` on the server is disallowed to prevent shared state across requests.
+     * Set this to `true` only if you explicitly intend to mutate state during server execution.
+     */
     allowSetStateServerSide?: boolean;
 };
 /**
  * Creates a vanilla store with pub-sub capabilities.
  *
- * The store state is expected to be an **object**.\
- * Updates are applied as partial merges, so non-object states are not supported.
+ * The store state must be an **object**.\
+ * Updates are applied as shallow merges, so non-object states are not supported.
  *
  * @param initialState - The initial state of the store
  * @param options - Optional lifecycle hooks
@@ -64,11 +71,13 @@ export type InitStoreOptions<TState extends Record<string, any>> = {
  * @remarks
  * - State updates are **shallowly compared per key** before notifying subscribers.
  * - Subscribers are only notified when at least one updated field changes (using `Object.is` comparison).
- * - Subscribers receive both the new state and the previous state.
+ * - Subscribers receive the new state, previous state, and changed top-level keys.
+ * - State is expected to be treated as **immutable**.
+ *   - Mutating nested values directly will not trigger updates.
  * - Lifecycle hooks allow side-effect management tied to subscription count.
- * - By default, `setState` is **disabled on the server** to prevent accidental shared state between requests.
- *   - This avoids leaking data between users in server environments.
- *   - You can override this by setting `allowSetStateServerSide: true`.
+ * - By default, `setState` is **not allowed on the server** to prevent accidental shared state between requests.
+ *   - This helps avoid leaking data between users in server environments.
+ *   - If you intentionally want to allow this behavior, set `allowSetStateServerSide: true`.
  *
  * @example
  * const store = initStore({ count: 0 });

package/vanilla.d.ts

@@ -1,4 +1,3 @@
 export * from './vanilla/basic';
-export * from './vanilla/shallow';
 export * from './vanilla/hash';
 export * from './vanilla/store';

package/vanilla.js

@@ -3,7 +3,6 @@
 const isClient = typeof window !== "undefined" && !("Deno" in window);
 const noop = () => {
 };
-const identity = (value) => value;
 const getValue = (valueOrComputeValueFn, ...params) => {
   if (typeof valueOrComputeValueFn === "function") {
     return valueOrComputeValueFn(...params);
@@ -11,41 +10,6 @@ const getValue = (valueOrComputeValueFn, ...params) => {
   return valueOrComputeValueFn;
 };
 
-const shallow = (a, b) => {
-  if (Object.is(a, b)) {
-    return true;
-  }
-  if (typeof a !== "object" || a === null || typeof b !== "object" || b === null) {
-    return false;
-  }
-  if (a instanceof Map && b instanceof Map) {
-    if (a.size !== b.size) return false;
-    for (const [key, value] of a) {
-      if (!Object.is(value, b.get(key))) {
-        return false;
-      }
-    }
-    return true;
-  }
-  if (a instanceof Set && b instanceof Set) {
-    if (a.size !== b.size) return false;
-    for (const value of a) {
-      if (!b.has(value)) return false;
-    }
-    return true;
-  }
-  const keysA = Object.keys(a);
-  if (keysA.length !== Object.keys(b).length) {
-    return false;
-  }
-  for (let i = 0; i < keysA.length; i++) {
-    if (!Object.prototype.hasOwnProperty.call(b, keysA[i]) || !Object.is(a[keysA[i]], b[keysA[i]])) {
-      return false;
-    }
-  }
-  return true;
-};
-
 const hasObjectPrototype = (value) => {
   return Object.prototype.toString.call(value) === "[object Object]";
 };
@@ -98,13 +62,15 @@ const initStore = (initialState, options = {}) => {
     }
     const prevState = state;
     const newValue = getValue(value, state);
+    const changedKeys = [];
     for (const key in newValue) {
       if (!Object.is(prevState[key], newValue[key])) {
-        state = { ...prevState, ...newValue };
-        [...subscribers].forEach((subscriber) => subscriber(state, prevState));
-        return;
+        changedKeys.push(key);
       }
     }
+    if (changedKeys.length === 0) return;
+    state = { ...prevState, ...newValue };
+    [...subscribers].forEach((subscriber) => subscriber(state, prevState, changedKeys));
   };
   const storeApi = {
     getState,
@@ -117,9 +83,7 @@ const initStore = (initialState, options = {}) => {
 
 exports.getHash = getHash;
 exports.getValue = getValue;
-exports.identity = identity;
 exports.initStore = initStore;
 exports.isClient = isClient;
 exports.isPlainObject = isPlainObject;
 exports.noop = noop;
-exports.shallow = shallow;

package/esm/vanilla/shallow.d.mts

@@ -1,6 +0,0 @@
-/**
- * Shallow compare 2 values.
- *
- * Reference: https://github.com/pmndrs/zustand/blob/e414f7ccf41eae09517ee2dcb44c9f5ae8a35a25/src/vanilla/shallow.ts
- */
-export declare const shallow: <T>(a: T, b: T) => boolean;

package/vanilla/shallow.d.ts

@@ -1,6 +0,0 @@
-/**
- * Shallow compare 2 values.
- *
- * Reference: https://github.com/pmndrs/zustand/blob/e414f7ccf41eae09517ee2dcb44c9f5ae8a35a25/src/vanilla/shallow.ts
- */
-export declare const shallow: <T>(a: T, b: T) => boolean;