floppy-disk 2.16.0 → 3.0.0-alpha.2

package/esm/index.d.mts

@@ -0,0 +1 @@
+export * from 'floppy-disk/vanilla';

package/esm/index.mjs

@@ -0,0 +1 @@
+export * from 'floppy-disk/vanilla';

package/esm/react/create-mutation.d.mts

@@ -0,0 +1,135 @@
+import { type InitStoreOptions, type SetState } from 'floppy-disk/vanilla';
+/**
+ * Represents the state of a mutation.
+ *
+ * @remarks
+ * A mutation does not cache results and only tracks the latest execution.
+ *
+ * The state transitions are:
+ * - `INITIAL` → before any execution
+ * - `SUCCESS` → when mutation resolves successfully
+ * - `ERROR` → when mutation fails
+ *
+ * Unlike queries:
+ * - No retry mechanism
+ * - No caching across executions
+ */
+export type MutationState<TData, TVariable> = {
+    isPending: boolean;
+} & ({
+    state: 'INITIAL';
+    isSuccess: false;
+    isError: false;
+    variable: undefined;
+    data: undefined;
+    dataUpdatedAt: undefined;
+    error: undefined;
+    errorUpdatedAt: undefined;
+} | {
+    state: 'SUCCESS';
+    isSuccess: true;
+    isError: false;
+    variable: TVariable;
+    data: TData;
+    dataUpdatedAt: number;
+    error: undefined;
+    errorUpdatedAt: undefined;
+} | {
+    state: 'ERROR';
+    isSuccess: false;
+    isError: true;
+    variable: TVariable;
+    data: undefined;
+    dataUpdatedAt: undefined;
+    error: any;
+    errorUpdatedAt: number;
+});
+/**
+ * Configuration options for a mutation.
+ *
+ * @remarks
+ * Lifecycle callbacks are triggered for each execution.
+ */
+export type MutationOptions<TData, TVariable> = InitStoreOptions<MutationState<TData, TVariable>> & {
+    /**
+     * Called when the mutation succeeds.
+     */
+    onSuccess?: (data: TData, variable: TVariable, stateBeforeExecute: MutationState<TData, TVariable>) => void;
+    /**
+     * Called when the mutation fails.
+     */
+    onError?: (error: any, variable: TVariable, stateBeforeExecute: MutationState<TData, TVariable>) => void;
+    /**
+     * Called after the mutation settles (either success or error).
+     */
+    onSettled?: (variable: TVariable, stateBeforeExecute: MutationState<TData, TVariable>) => void;
+};
+/**
+ * Creates a mutation store for handling async operations that modify data.
+ *
+ * @param mutationFn - Async function that performs the mutation
+ * @param options - Optional configuration and lifecycle callbacks
+ *
+ * @returns A function that acts as both:
+ * - A React hook for subscribing to mutation state
+ * - A mutation controller (execute, reset, etc.)
+ *
+ * @remarks
+ * - Mutations are **not cached** and only track the latest execution.
+ * - Designed for operations that change data (e.g. create, update, delete).
+ * - No retry mechanism is provided by default.
+ * - Each execution overwrites the previous state.
+ * - The mutation always resolves (never throws): the result contains either `data` or `error`.
+ *
+ * @example
+ * const useCreateUser = createMutation(async (input) => {
+ *   return api.createUser(input);
+ * });
+ *
+ * const { isPending } = useCreateUser();
+ * const result = await useCreateUser.execute({ name: 'John' });
+ */
+export declare const createMutation: <TData, TVariable = undefined>(mutationFn: (variable: TVariable, stateBeforeExecute: MutationState<TData, TVariable>) => Promise<TData>, options?: MutationOptions<TData, TVariable>) => (<TStateSlice = MutationState<TData, TVariable>>(selector?: (state: MutationState<TData, TVariable>) => TStateSlice) => TStateSlice) & {
+    subscribe: (subscriber: import("../vanilla.d.mts").Subscriber<MutationState<TData, TVariable>>) => () => void;
+    getSubscribers: () => Set<import("../vanilla.d.mts").Subscriber<MutationState<TData, TVariable>>>;
+    getState: () => MutationState<TData, TVariable>;
+    /**
+     * Manually updates the mutation state.
+     *
+     * @remarks
+     * - Intended for advanced use cases.
+     * - Prefer using provided mutation actions (`execute`, `reset`) instead.
+     */
+    setState: (value: SetState<MutationState<TData, TVariable>>) => void;
+    /**
+     * 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
+     * - 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.
+     */
+    execute: TVariable extends undefined ? () => Promise<{
+        variable: undefined;
+        data?: TData;
+        error?: any;
+    }> : (variable: TVariable) => Promise<{
+        variable: TVariable;
+        data?: TData;
+        error?: any;
+    }>;
+    /**
+     * 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.
+     */
+    reset: () => void;
+};

package/esm/react/create-query.d.mts

@@ -0,0 +1,319 @@
+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> = {
+    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: any;
+    errorUpdatedAt: number;
+} | {
+    state: 'SUCCESS_BUT_REVALIDATION_ERROR';
+    isSuccess: true;
+    isError: false;
+    data: TData;
+    dataUpdatedAt: number;
+    error: any;
+    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>> = InitStoreOptions<QueryState<TData>> & {
+    /**
+     * Time (in milliseconds) that data is considered fresh.
+     *
+     * While fresh, revalidation will be skipped.
+     *
+     * @default 2500 ms (2.5 minutes)
+     */
+    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>) => void;
+    /**
+     * Called when the query fails and will not retry.
+     */
+    onError?: (error: any, variable: TVariable, stateBeforeExecute: QueryState<TData>) => void;
+    /**
+     * Called after the query settles (success or final failure).
+     */
+    onSettled?: (variable: TVariable, stateBeforeExecute: QueryState<TData>) => 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: any, currentState: QueryState<TData>) => [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 cached by a deterministic key derived from `variable`.
+ * - Each unique variable maps to its own store instance.
+ * - Queries support:
+ *   - Caching with `staleTime`
+ *   - Explicit invalidation independent of freshness
+ *   - Automatic garbage collection (`gcTime`)
+ *   - Retry logic via `shouldRetry`
+ *   - Background revalidation (focus / reconnect)
+ * - Execution is deduplicated: multiple calls share the same in-flight promise.
+ * - Ongoing executions can be optionally overwritten.
+ *
+ * @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>(queryFn: (variable: TVariable, currentState: QueryState<TData>) => Promise<TData>, options?: QueryOptions<TData, TVariable>) => ((variable?: TVariable) => (<TStateSlice = QueryState<TData>>(options?: {
+    /**
+     * Whether the query should execute automatically on mount.
+     *
+     * @default true
+     */
+    enabled?: 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;
+}, selector?: (state: QueryState<TData>) => TStateSlice) => TStateSlice) & {
+    metadata: {
+        isInvalidated?: boolean;
+        promise?: Promise<QueryState<TData>> | undefined;
+        promiseResolver?: ((value: QueryState<TData> | PromiseLike<QueryState<TData>>) => void) | undefined;
+        retryTimeoutId?: number;
+        retryResolver?: ((value: QueryState<TData> | PromiseLike<QueryState<TData>>) => 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 overwriteOngoingExecution - Whether to start a new execution instead of reusing an ongoing one
+     *
+     * @returns A promise resolving to the latest query state
+     *
+     * @remarks
+     * - Deduplicates concurrent executions by default.
+     * - If `overwriteOngoingExecution` is true, a new execution replaces the current one.
+     * - Handles:
+     *   - Pending state
+     *   - Success state
+     *   - Error state
+     *   - Retry logic
+     */
+    execute: (overwriteOngoingExecution?: boolean) => Promise<QueryState<TData>>;
+    /**
+     * Re-executes the query if the data is stale.
+     *
+     * @param overwriteOngoingExecution - Whether to overwrite an ongoing execution
+     *
+     * @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.
+     * - Used for automatic revalidation (e.g. focus or reconnect).
+     */
+    revalidate: (overwriteOngoingExecution?: boolean) => Promise<QueryState<TData>>;
+    /**
+     * Marks the query as invalidated and optionally triggers re-execution.
+     *
+     * @param overwriteOngoingExecution - Whether to overwrite an ongoing execution
+     *
+     * @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 will be triggered immediately.
+     */
+    invalidate: (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>>;
+        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.d.mts").Subscriber<QueryState<TData>>) => () => void;
+    getSubscribers: () => Set<import("../vanilla.d.mts").Subscriber<QueryState<TData>>>;
+    getState: () => QueryState<TData>;
+    setState: (value: SetState<QueryState<TData>>) => void;
+}) & {
+    /**
+     * Executes all query instances.
+     *
+     * @remarks
+     * - Useful for bulk refetching.
+     */
+    executeAll: (overwriteOngoingExecution?: boolean) => void;
+    /**
+     * Revalidates all query instances.
+     *
+     * @remarks
+     * - Only re-fetches stale queries.
+     */
+    revalidateAll: (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: (overwriteOngoingExecution?: boolean) => void;
+    /**
+     * Resets all query instances.
+     */
+    resetAll: () => void;
+};

package/esm/react/create-store.d.mts

@@ -0,0 +1,25 @@
+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.
+ *
+ * @example
+ * const useCounter = createStore({ count: 0 });
+ *
+ * function Component() {
+ *   const count = useCounter((s) => s.count);
+ * }
+ *
+ * useCounter.setState({ count: 1 });
+ */
+export declare const createStore: <TState extends Record<string, any>>(initialState: TState, options?: InitStoreOptions<TState>) => (<TStateSlice = TState>(selector?: (state: TState) => TStateSlice) => TStateSlice) & import("../vanilla.d.mts").StoreApi<TState>;

package/esm/react/create-stores.d.mts

@@ -0,0 +1,32 @@
+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.
+ * - Useful for scenarios like:
+ *   - Query caches
+ *   - Entity-based state
+ *   - Dynamic instances
+ *
+ * @example
+ * const getUserStore = createStores({ name: '' });
+ *
+ * const userStore = getUserStore({ id: 1 });
+ * const name = userStore((s) => s.name);
+ */
+export declare const createStores: <TState extends Record<string, any>, TKey extends Record<string, any>>(initialState: TState, options?: InitStoreOptions<TState>) => (key?: TKey) => (<TStateSlice = TState>(selector?: (state: TState) => TStateSlice) => TStateSlice) & {
+    delete: () => boolean;
+    setState: (value: import("../vanilla.d.mts").SetState<TState>) => void;
+    getState: () => TState;
+    subscribe: (subscriber: import("../vanilla.d.mts").Subscriber<TState>) => () => void;
+    getSubscribers: () => Set<import("../vanilla.d.mts").Subscriber<TState>>;
+};

package/esm/react/use-isomorphic-layout-effect.d.mts

@@ -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/esm/react/use-store.d.mts

@@ -0,0 +1,18 @@
+import { type StoreApi } from 'floppy-disk/vanilla';
+export declare const useStoreUpdateNotifier: <TState extends Record<string, any>, TStateSlice = TState>(store: StoreApi<TState>, selector: (state: TState) => TStateSlice) => void;
+/**
+ * React hook for subscribing to a store with optional state selection.
+ *
+ * @param store - The store instance to subscribe to
+ * @param selector - Optional selector to derive a slice of state
+ *
+ * @returns The selected state slice (or full state if no selector is provided)
+ *
+ * @remarks
+ * - The selector does **not** need to be memoized.
+ * - The hook internally keeps the latest selector reference to avoid re-subscription.
+ *
+ * @example
+ * const count = useStoreState(store, (s) => s.count);
+ */
+export declare const useStoreState: <TState extends Record<string, any>, TStateSlice = TState>(store: StoreApi<TState>, selector?: (state: TState) => TStateSlice) => TStateSlice;

package/esm/react.d.mts

@@ -0,0 +1,6 @@
+export * from './react/use-isomorphic-layout-effect.mjs';
+export * from './react/use-store.mjs';
+export * from './react/create-store.mjs';
+export * from './react/create-stores.mjs';
+export * from './react/create-query.mjs';
+export * from './react/create-mutation.mjs';