floppy-disk 3.0.0-experimental.1 → 3.0.1

package/react/create-query.d.ts

@@ -0,0 +1,344 @@
+import { type InitStoreOptions, type SetState } from 'floppy-disk/vanilla';
+/**
+ * Represents the state of a query.
+ *
+ * @remarks
+ * A query manages cached results of an async operation with lifecycle awareness.
+ *
+ * State variants:
+ * - `INITIAL` → no execution has occurred yet
+ * - `SUCCESS` → execution completed successfully
+ * - `ERROR` → initial execution failed (no data available)
+ * - `SUCCESS_BUT_REVALIDATION_ERROR` → data exists, but a revalidation failed
+ *
+ * Flags:
+ * - `isPending` → an execution is currently in progress
+ * - `isRevalidating` → re-executing while already having data
+ * - `isRetrying` → retrying after a failure
+ *
+ * @remarks
+ * - Data and error are mutually exclusive except in `SUCCESS_BUT_REVALIDATION_ERROR`.
+ */
+export type QueryState<TData, TError> = {
+    isPending: boolean;
+    isRevalidating: boolean;
+    isRetrying: boolean;
+    retryCount: number;
+} & ({
+    state: 'INITIAL';
+    isSuccess: false;
+    isError: false;
+    data: undefined;
+    dataUpdatedAt: undefined;
+    error: undefined;
+    errorUpdatedAt: undefined;
+} | {
+    state: 'SUCCESS';
+    isSuccess: true;
+    isError: false;
+    data: TData;
+    dataUpdatedAt: number;
+    error: undefined;
+    errorUpdatedAt: undefined;
+} | {
+    state: 'ERROR';
+    isSuccess: false;
+    isError: true;
+    data: undefined;
+    dataUpdatedAt: undefined;
+    error: TError;
+    errorUpdatedAt: number;
+} | {
+    state: 'SUCCESS_BUT_REVALIDATION_ERROR';
+    isSuccess: true;
+    isError: false;
+    data: TData;
+    dataUpdatedAt: number;
+    error: TError;
+    errorUpdatedAt: number;
+});
+/**
+ * Configuration options for a query.
+ *
+ * @remarks
+ * Controls caching, retry behavior, lifecycle, and side effects of an async operation.
+ */
+export type QueryOptions<TData, TVariable extends Record<string, any>, TError = Error> = InitStoreOptions<QueryState<TData, TError>> & {
+    /**
+     * Time (in milliseconds) that data is considered fresh.
+     *
+     * While fresh, revalidation will be skipped unless explicitly invalidated.
+     *
+     * @default 2500 ms (2.5 seconds)
+     */
+    staleTime?: number;
+    /**
+     * Time (in milliseconds) before unused queries are garbage collected.
+     *
+     * Starts counting after the last subscriber unsubscribes.
+     *
+     * @default 5 minutes
+     */
+    gcTime?: number;
+    /**
+     * Whether to revalidate when the window gains focus.
+     *
+     * @default true
+     */
+    revalidateOnFocus?: boolean;
+    /**
+     * Whether to revalidate when the network reconnects.
+     *
+     * @default true
+     */
+    revalidateOnReconnect?: boolean;
+    /**
+     * Called when the query succeeds.
+     */
+    onSuccess?: (data: TData, variable: TVariable, stateBeforeExecute: QueryState<TData, TError>) => void;
+    /**
+     * Called when the query fails and will not retry.
+     */
+    onError?: (error: TError, variable: TVariable, stateBeforeExecute: QueryState<TData, TError>) => void;
+    /**
+     * Called after the query settles (success or final failure).
+     */
+    onSettled?: (variable: TVariable, stateBeforeExecute: QueryState<TData, TError>) => void;
+    /**
+     * Determines whether a failed query should retry.
+     *
+     * @returns
+     * - `[true, delay]` to retry after `delay` milliseconds
+     * - `[false]` to stop retrying
+     *
+     * @default Retries once after 1500ms
+     *
+     * @example
+     * shouldRetry: (error, state) => {
+     *   if (error?.status === 401 || error?.code === 'UNAUTHORIZED') return [false];
+     *   if (state.retryCount < 3) return [true, 1000 * 2 ** state.retryCount];
+     *   return [false];
+     * }
+     */
+    shouldRetry?: (error: TError, currentState: QueryState<TData, TError>) => [true, number] | [false];
+};
+/**
+ * Creates a query factory for managing cached async operations.
+ *
+ * @param queryFn - Async function to resolve data
+ * @param options - Optional configuration for caching, retry, and lifecycle
+ *
+ * @returns A function to retrieve or create a query instance by variable
+ *
+ * @remarks
+ * - Queries are **keyed by variable** (via deterministic hashing).
+ * - Each unique variable maps to its own store instance.
+ *
+ * Core features:
+ * - Caching via `staleTime`
+ * - Explicit invalidation (independent of freshness)
+ * - Retry logic via `shouldRetry`
+ * - Background revalidation (focus / reconnect)
+ * - Garbage collection via `gcTime`
+ *
+ * Execution behavior:
+ * - By default, executions **overwrite ongoing executions**
+ * - Set `overwriteOngoingExecution: false` to enable deduplication
+ * - Internal revalidation (focus/reconnect) uses deduplication by default
+ *
+ * @example
+ * const userQuery = createQuery<UserDetail, { id: string }>(async ({ id }) => {
+ *   return api.getUser(id);
+ * });
+ *
+ * function MyComponent({ id }: { id: string }) {
+ *   const useUserQuery = userQuery({ id });
+ *   const state = useUserQuery();
+ *   // ...
+ * }
+ */
+export declare const createQuery: <TData, TVariable extends Record<string, any> = never, TError = Error>(queryFn: (variable: TVariable, currentState: QueryState<TData, TError>) => Promise<TData>, options?: QueryOptions<TData, TVariable, TError>) => ((variable?: TVariable) => ((options?: {
+    /**
+     * Whether the query should be ravalidated automatically on mount.
+     *
+     * Revalidate means execute the queryFn **if stale/invalidated**.
+     *
+     * @default true
+     */
+    revalidateOnMount?: boolean;
+    /**
+     * Whether to keep previous successful data while a new variable is loading.
+     *
+     * @remarks
+     * - Only applies when the query is in the `INITIAL` state (no data & no error).
+     * - Intended for variable changes:
+     *   when switching from one variable to another, the previous data is temporarily shown
+     *   while the new execution is in progress.
+     * - Once the new execution resolves (success or error), the previous data is no longer used.
+     * - Prevents UI flicker (e.g. empty/loading state) during transitions.
+     *
+     * @example
+     * // Switching from userId=1 → userId=2
+     * // While loading userId=2, still show userId=1 data
+     * useQuery({ id: userId }, { keepPreviousData: true });
+     */ keepPreviousData?: boolean;
+}) => QueryState<TData, TError>) & {
+    metadata: {
+        isInvalidated?: boolean;
+        promise?: Promise<QueryState<TData, TError>> | undefined;
+        promiseResolver?: ((value: QueryState<TData, TError> | PromiseLike<QueryState<TData, TError>>) => void) | undefined;
+        retryTimeoutId?: number;
+        retryResolver?: ((value: QueryState<TData, TError> | PromiseLike<QueryState<TData, TError>>) => void) | undefined;
+        garbageCollectionTimeoutId?: number;
+        rollbackData?: TData | undefined;
+    };
+    /**
+     * Sets initial data for the query if it has not been initialized.
+     *
+     * @param data - Initial data
+     * @param revalidate - Whether to mark the data as invalidated (will trigger revalidation)
+     *
+     * @returns `true` if the data was set, `false` otherwise
+     *
+     * @remarks
+     * - Only applies when the query is in the `INITIAL` state.
+     * - Useful for hydration or preloaded data.
+     */
+    setInitialData: (data: TData, revalidate?: boolean) => boolean;
+    /**
+     * Executes the query function.
+     *
+     * @param options - Execution options
+     * @param options.overwriteOngoingExecution - Whether to start a new execution instead of reusing an ongoing one (default: `true`)
+     *
+     * @returns A promise resolving to the latest query state
+     *
+     * @remarks
+     * - By default, each call **starts a new execution** even if one is already in progress.
+     * - Set `overwriteOngoingExecution: false` to reuse an ongoing execution (deduplication).
+     * - Handles:
+     *   - Pending state
+     *   - Success state
+     *   - Error state
+     *   - Retry logic
+     */
+    execute: (options?: {
+        overwriteOngoingExecution?: boolean;
+    }) => Promise<QueryState<TData, TError>>;
+    /**
+     * Re-executes the query if needed based on freshness or invalidation.
+     *
+     * @param options - Revalidation options
+     * @param options.overwriteOngoingExecution - Whether to overwrite an ongoing execution (default: `true`)
+     *
+     * @returns The current state if still fresh, otherwise a promise of the new state
+     *
+     * @remarks
+     * - Skips execution if data is still fresh (`staleTime`) **AND** the query has not been invalidated.
+     * - If execution is not skipped, by default it will start a new execution even if one is already in progress.
+     * - Set `overwriteOngoingExecution: false` to reuse an ongoing execution (deduplication).
+     */
+    revalidate: (options?: {
+        overwriteOngoingExecution?: boolean;
+    }) => Promise<QueryState<TData, TError>>;
+    /**
+     * Marks the query as invalidated and optionally triggers re-execution.
+     *
+     * @param options - Invalidation options
+     * @param options.overwriteOngoingExecution - Whether to overwrite an ongoing execution (default: `true`)
+     *
+     * @returns `true` if execution was triggered, `false` otherwise
+     *
+     * @remarks
+     * - Invalidated queries are treated as stale regardless of `staleTime`.
+     * - The next `revalidate` will always execute until a successful result clears the invalidation.
+     * - If there are active subscribers: Execution is triggered immediately.
+     * - Otherwise: The query remains invalidated and will execute on the next revalidation.
+     * - By default, starts a new execution even if one is already in progress.
+     * - Set `overwriteOngoingExecution: false` to reuse an ongoing execution (deduplication).
+     */
+    invalidate: (options?: {
+        overwriteOngoingExecution?: boolean;
+    }) => boolean;
+    /**
+     * Resets the query state to its initial state.
+     *
+     * @remarks
+     * - Cancels retry logic and ignores any ongoing execution results.
+     */
+    reset: () => void;
+    /**
+     * Deletes the query store for the current variable.
+     *
+     * @returns `true` if deleted, `false` otherwise
+     *
+     * @remarks
+     * - Cannot delete while there are active subscribers.
+     */
+    delete: () => boolean;
+    /**
+     * Performs an optimistic update on the query data.
+     *
+     * @param data - Optimistic data to set
+     *
+     * @returns Controls for managing the optimistic update
+     *
+     * @remarks
+     * - Temporarily replaces the current data.
+     * - Stores previous data for rollback.
+     * - Commonly used with mutations for instant UI updates.
+     *
+     * @example
+     * const { rollback, revalidate } = query.optimisticUpdate(newData);
+     */
+    optimisticUpdate: (data: TData) => {
+        revalidate: () => Promise<QueryState<TData, TError>>;
+        rollback: () => TData;
+    };
+    /**
+     * Restores the data before the last optimistic update.
+     *
+     * @returns The restored data
+     *
+     * @remarks
+     * - Should be used if an optimistic update fails.
+     */
+    rollbackOptimisticUpdate: () => TData;
+    subscribe: (subscriber: import("../vanilla.ts").Subscriber<QueryState<TData, TError>>) => () => void;
+    getSubscribers: () => Set<import("../vanilla.ts").Subscriber<QueryState<TData, TError>>>;
+    getState: () => QueryState<TData, TError>;
+    setState: (value: SetState<QueryState<TData, TError>>) => void;
+}) & {
+    /**
+     * Executes all query instances.
+     *
+     * @remarks
+     * - Useful for bulk refetching.
+     */
+    executeAll: (options?: {
+        overwriteOngoingExecution?: boolean;
+    }) => void;
+    /**
+     * Revalidates all query instances.
+     *
+     * @remarks
+     * - Only re-fetches stale queries.
+     */
+    revalidateAll: (options?: {
+        overwriteOngoingExecution?: boolean;
+    }) => void;
+    /**
+     * Invalidates all query instances.
+     *
+     * @remarks
+     * - Marks all queries as invalidated and triggers revalidation if active.
+     * - Invalidated queries bypass `staleTime` until successfully executed again.
+     */
+    invalidateAll: (options?: {
+        overwriteOngoingExecution?: boolean;
+    }) => void;
+    /**
+     * Resets all query instances.
+     */
+    resetAll: () => void;
+};

package/react/create-store.d.ts

@@ -0,0 +1,28 @@
+import { type InitStoreOptions } from 'floppy-disk/vanilla';
+/**
+ * Creates a single store with a bound React hook.
+ *
+ * @param initialState - The initial state of the store
+ * @param options - Optional lifecycle hooks
+ *
+ * @returns A function that acts as both:
+ * - A React hook for subscribing to the store
+ * - The store API (getState, setState, subscribe, etc.)
+ *
+ * @remarks
+ * - Combines the vanilla store with React integration.
+ * - The returned function can be used directly as a hook.
+ *   - The hook uses Proxy-based tracking to automatically detect which state fields are used.
+ *   - Components will only re-render when the accessed values change.
+ *
+ * @example
+ * const useMyStore = createStore({ foo: 1, bar: 2 });
+ *
+ * function Component() {
+ *   const state = useMyStore();
+ *   return <div>{state.foo}</div>;
+ * }
+ *
+ * useMyStore.setState({ foo: 2 }); // only components using foo will re-render
+ */
+export declare const createStore: <TState extends Record<string, any>>(initialState: TState, options?: InitStoreOptions<TState>) => (() => TState) & import("../vanilla.ts").StoreApi<TState>;

package/react/create-stores.d.ts

@@ -0,0 +1,39 @@
+import { type InitStoreOptions } from 'floppy-disk/vanilla';
+/**
+ * Creates a factory for multiple stores identified by a key.
+ *
+ * @param initialState - The initial state for each store instance
+ * @param options - Optional lifecycle hooks
+ *
+ * @returns A function to retrieve or create a store by key
+ *
+ * @remarks
+ * - Each unique key maps to a separate store instance.
+ * - Keys are deterministically hashed, ensuring stable identity.
+ * - Stores are lazily created and cached.
+ * - Each store has its own state, subscribers, and lifecycle.
+ * - Each returned store includes:
+ *   - React hook (with Proxy-based tracking)
+ *   - Store API methods
+ *   - `delete()` for manual cleanup
+ * - Useful for scenarios like:
+ *   - Query caches
+ *   - Entity-based state
+ *   - Dynamic instances
+ *
+ * @example
+ * const userStore = createStores<{ name: string }, { id: number }>({ name: '' });
+ *
+ * function Component() {
+ *   const useUserStore = userStore({ id: 1 });
+ *   const state = useUserStore();
+ *   return <div>{state.name}</div>;
+ * }
+ */
+export declare const createStores: <TState extends Record<string, any>, TKey extends Record<string, any>>(initialState: TState, options?: InitStoreOptions<TState>) => (key?: TKey) => (() => TState) & {
+    delete: () => boolean;
+    setState: (value: import("../vanilla.ts").SetState<TState>) => void;
+    getState: () => TState;
+    subscribe: (subscriber: import("../vanilla.ts").Subscriber<TState>) => () => void;
+    getSubscribers: () => Set<import("../vanilla.ts").Subscriber<TState>>;
+};

package/react/use-isomorphic-layout-effect.d.ts

@@ -0,0 +1,6 @@
+import { useLayoutEffect } from 'react';
+/**
+ * Does exactly same as `useLayoutEffect`.\
+ * It will use `useEffect` in **server-side** to prevent warning when executed on server-side.
+ */
+export declare const useIsomorphicLayoutEffect: typeof useLayoutEffect;

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/use-store.d.ts

@@ -0,0 +1,28 @@
+import { type StoreApi } from 'floppy-disk/vanilla';
+type Path = Array<string | number | symbol>;
+export declare const getValueByPath: (obj: any, path: Path) => any;
+export declare const isPrefixPath: (candidatePrefix: Path, targetPath: Path) => boolean;
+export declare const compressPaths: (paths: Path[]) => Path[];
+export declare const useStoreStateProxy: <TState extends Record<string, any>>(storeState: TState) => readonly [TState, import("react").RefObject<Path[]>];
+/**
+ * React hook for subscribing to a store using automatic dependency tracking.
+ *
+ * @param store - The store instance to subscribe to
+ *
+ * @returns A proxied version of the store state
+ *
+ * @remarks
+ * - This hook uses a **Proxy-based tracking mechanism** to detect which parts of the state are accessed during render.
+ * - The component will only re-render when the **accessed values actually change**.
+ * - State must be treated as **immutable**:
+ *   - Updates must replace objects rather than mutate them
+ *   - Otherwise, changes may not be detected
+ * - No selector or memoization is needed.
+ *
+ * @example
+ * const state = useStoreState(store);
+ * return <div>{state.user.name}</div>;
+ * // Component will only re-render if `user.name` changes
+ */
+export declare const useStoreState: <TState extends Record<string, any>>(storeState: TState, subscribe: StoreApi<TState>["subscribe"]) => TState;
+export {};

package/react.d.ts

@@ -0,0 +1,7 @@
+export * from './react/use-isomorphic-layout-effect';
+export { useStoreState } from './react/use-store';
+export * from './react/create-store';
+export * from './react/create-stores';
+export * from './react/create-query';
+export { createMutation, type MutationOptions, type MutationState, } from './react/create-mutation';
+export * from './react/use-mutation';