floppy-disk 3.0.0-alpha.5 → 3.0.0-beta.2

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

@@ -14,7 +14,7 @@ import { type InitStoreOptions, type SetState } from 'floppy-disk/vanilla';
  * - No retry mechanism
  * - No caching across executions
  */
-export type MutationState<TData, TVariable> = {
+export type MutationState<TData, TVariable, TError> = {
     isPending: boolean;
 } & ({
     state: 'INITIAL';
@@ -41,7 +41,7 @@ export type MutationState<TData, TVariable> = {
     variable: TVariable;
     data: undefined;
     dataUpdatedAt: undefined;
-    error: any;
+    error: TError;
     errorUpdatedAt: number;
 });
 /**
@@ -50,19 +50,19 @@ export type MutationState<TData, TVariable> = {
  * @remarks
  * Lifecycle callbacks are triggered for each execution.
  */
-export type MutationOptions<TData, TVariable> = InitStoreOptions<MutationState<TData, TVariable>> & {
+export type MutationOptions<TData, TVariable, TError = Error> = InitStoreOptions<MutationState<TData, TVariable, TError>> & {
     /**
      * Called when the mutation succeeds.
      */
-    onSuccess?: (data: TData, variable: TVariable, stateBeforeExecute: MutationState<TData, TVariable>) => void;
+    onSuccess?: (data: TData, variable: TVariable, stateBeforeExecute: MutationState<TData, TVariable, TError>) => void;
     /**
      * Called when the mutation fails.
      */
-    onError?: (error: any, variable: TVariable, stateBeforeExecute: MutationState<TData, TVariable>) => void;
+    onError?: (error: TError, variable: TVariable, stateBeforeExecute: MutationState<TData, TVariable, TError>) => void;
     /**
      * Called after the mutation settles (either success or error).
      */
-    onSettled?: (variable: TVariable, stateBeforeExecute: MutationState<TData, TVariable>) => void;
+    onSettled?: (variable: TVariable, stateBeforeExecute: MutationState<TData, TVariable, TError>) => void;
 };
 /**
  * Creates a mutation store for handling async operations that modify data.
@@ -89,10 +89,10 @@ export type MutationOptions<TData, TVariable> = InitStoreOptions<MutationState<T
  * 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>) => (() => MutationState<TData, TVariable>) & {
-    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>;
+export declare const createMutation: <TData, TVariable = undefined, TError = Error>(mutationFn: (variable: TVariable, stateBeforeExecute: MutationState<TData, TVariable, TError>) => Promise<TData>, options?: MutationOptions<TData, TVariable, TError>) => (() => MutationState<TData, TVariable, TError>) & {
+    subscribe: (subscriber: import("../vanilla.d.mts").Subscriber<MutationState<TData, TVariable, TError>>) => () => void;
+    getSubscribers: () => Set<import("../vanilla.d.mts").Subscriber<MutationState<TData, TVariable, TError>>>;
+    getState: () => MutationState<TData, TVariable, TError>;
     /**
      * Manually updates the mutation state.
      *
@@ -100,7 +100,7 @@ export declare const createMutation: <TData, TVariable = undefined>(mutationFn:
      * - Intended for advanced use cases.
      * - Prefer using provided mutation actions (`execute`, `reset`) instead.
      */
-    setState: (value: SetState<MutationState<TData, TVariable>>) => void;
+    setState: (value: SetState<MutationState<TData, TVariable, TError>>) => void;
     /**
      * Executes the mutation.
      *
@@ -118,11 +118,11 @@ export declare const createMutation: <TData, TVariable = undefined>(mutationFn:
     execute: TVariable extends undefined ? () => Promise<{
         variable: undefined;
         data?: TData;
-        error?: any;
+        error?: TError;
     }> : (variable: TVariable) => Promise<{
         variable: TVariable;
         data?: TData;
-        error?: any;
+        error?: TError;
     }>;
     /**
      * Resets the mutation state back to its initial state.

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

@@ -19,7 +19,7 @@ import { type InitStoreOptions, type SetState } from 'floppy-disk/vanilla';
  * @remarks
  * - Data and error are mutually exclusive except in `SUCCESS_BUT_REVALIDATION_ERROR`.
  */
-export type QueryState<TData> = {
+export type QueryState<TData, TError> = {
     isPending: boolean;
     isRevalidating: boolean;
     isRetrying: boolean;
@@ -46,7 +46,7 @@ export type QueryState<TData> = {
     isError: true;
     data: undefined;
     dataUpdatedAt: undefined;
-    error: any;
+    error: TError;
     errorUpdatedAt: number;
 } | {
     state: 'SUCCESS_BUT_REVALIDATION_ERROR';
@@ -54,7 +54,7 @@ export type QueryState<TData> = {
     isError: false;
     data: TData;
     dataUpdatedAt: number;
-    error: any;
+    error: TError;
     errorUpdatedAt: number;
 });
 /**
@@ -63,7 +63,7 @@ export type QueryState<TData> = {
  * @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>> & {
+export type QueryOptions<TData, TVariable extends Record<string, any>, TError = Error> = InitStoreOptions<QueryState<TData, TError>> & {
     /**
      * Time (in milliseconds) that data is considered fresh.
      *
@@ -95,15 +95,15 @@ export type QueryOptions<TData, TVariable extends Record<string, any>> = InitSto
     /**
      * Called when the query succeeds.
      */
-    onSuccess?: (data: TData, variable: TVariable, stateBeforeExecute: QueryState<TData>) => void;
+    onSuccess?: (data: TData, variable: TVariable, stateBeforeExecute: QueryState<TData, TError>) => void;
     /**
      * Called when the query fails and will not retry.
      */
-    onError?: (error: any, variable: TVariable, stateBeforeExecute: QueryState<TData>) => void;
+    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>) => void;
+    onSettled?: (variable: TVariable, stateBeforeExecute: QueryState<TData, TError>) => void;
     /**
      * Determines whether a failed query should retry.
      *
@@ -120,7 +120,7 @@ export type QueryOptions<TData, TVariable extends Record<string, any>> = InitSto
      *   return [false];
      * }
      */
-    shouldRetry?: (error: any, currentState: QueryState<TData>) => [true, number] | [false];
+    shouldRetry?: (error: TError, currentState: QueryState<TData, TError>) => [true, number] | [false];
 };
 /**
  * Creates a query factory for managing cached async operations.
@@ -157,7 +157,7 @@ export type QueryOptions<TData, TVariable extends Record<string, any>> = InitSto
  *   // ...
  * }
  */
-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) => ((options?: {
+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 execute automatically on mount.
      *
@@ -180,13 +180,13 @@ export declare const createQuery: <TData, TVariable extends Record<string, any>
      * // While loading userId=2, still show userId=1 data
      * useQuery({ id: userId }, { keepPreviousData: true });
      */ keepPreviousData?: boolean;
-}) => QueryState<TData>) & {
+}) => QueryState<TData, TError>) & {
     metadata: {
         isInvalidated?: boolean;
-        promise?: Promise<QueryState<TData>> | undefined;
-        promiseResolver?: ((value: QueryState<TData> | PromiseLike<QueryState<TData>>) => void) | undefined;
+        promise?: Promise<QueryState<TData, TError>> | undefined;
+        promiseResolver?: ((value: QueryState<TData, TError> | PromiseLike<QueryState<TData, TError>>) => void) | undefined;
         retryTimeoutId?: number;
-        retryResolver?: ((value: QueryState<TData> | PromiseLike<QueryState<TData>>) => void) | undefined;
+        retryResolver?: ((value: QueryState<TData, TError> | PromiseLike<QueryState<TData, TError>>) => void) | undefined;
         garbageCollectionTimeoutId?: number;
         rollbackData?: TData | undefined;
     };
@@ -222,7 +222,7 @@ export declare const createQuery: <TData, TVariable extends Record<string, any>
      */
     execute: (options?: {
         overwriteOngoingExecution?: boolean;
-    }) => Promise<QueryState<TData>>;
+    }) => Promise<QueryState<TData, TError>>;
     /**
      * Re-executes the query if needed based on freshness or invalidation.
      *
@@ -238,7 +238,7 @@ export declare const createQuery: <TData, TVariable extends Record<string, any>
      */
     revalidate: (options?: {
         overwriteOngoingExecution?: boolean;
-    }) => Promise<QueryState<TData>>;
+    }) => Promise<QueryState<TData, TError>>;
     /**
      * Marks the query as invalidated and optionally triggers re-execution.
      *
@@ -290,7 +290,7 @@ export declare const createQuery: <TData, TVariable extends Record<string, any>
      * const { rollback, revalidate } = query.optimisticUpdate(newData);
      */
     optimisticUpdate: (data: TData) => {
-        revalidate: () => Promise<QueryState<TData>>;
+        revalidate: () => Promise<QueryState<TData, TError>>;
         rollback: () => TData;
     };
     /**
@@ -302,10 +302,10 @@ export declare const createQuery: <TData, TVariable extends Record<string, any>
      * - 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;
+    subscribe: (subscriber: import("../vanilla.d.mts").Subscriber<QueryState<TData, TError>>) => () => void;
+    getSubscribers: () => Set<import("../vanilla.d.mts").Subscriber<QueryState<TData, TError>>>;
+    getState: () => QueryState<TData, TError>;
+    setState: (value: SetState<QueryState<TData, TError>>) => void;
 }) & {
     /**
      * Executes all query instances.

package/package.json

@@ -2,9 +2,9 @@
   "name": "floppy-disk",
   "description": "Lightweight, simple, and powerful state management library",
   "private": false,
-  "version": "3.0.0-alpha.5",
+  "version": "3.0.0-beta.2",
   "publishConfig": {
-    "tag": "alpha"
+    "tag": "beta"
   },
   "keywords": [
     "utilities",

package/react/create-mutation.d.ts

@@ -14,7 +14,7 @@ import { type InitStoreOptions, type SetState } from 'floppy-disk/vanilla';
  * - No retry mechanism
  * - No caching across executions
  */
-export type MutationState<TData, TVariable> = {
+export type MutationState<TData, TVariable, TError> = {
     isPending: boolean;
 } & ({
     state: 'INITIAL';
@@ -41,7 +41,7 @@ export type MutationState<TData, TVariable> = {
     variable: TVariable;
     data: undefined;
     dataUpdatedAt: undefined;
-    error: any;
+    error: TError;
     errorUpdatedAt: number;
 });
 /**
@@ -50,19 +50,19 @@ export type MutationState<TData, TVariable> = {
  * @remarks
  * Lifecycle callbacks are triggered for each execution.
  */
-export type MutationOptions<TData, TVariable> = InitStoreOptions<MutationState<TData, TVariable>> & {
+export type MutationOptions<TData, TVariable, TError = Error> = InitStoreOptions<MutationState<TData, TVariable, TError>> & {
     /**
      * Called when the mutation succeeds.
      */
-    onSuccess?: (data: TData, variable: TVariable, stateBeforeExecute: MutationState<TData, TVariable>) => void;
+    onSuccess?: (data: TData, variable: TVariable, stateBeforeExecute: MutationState<TData, TVariable, TError>) => void;
     /**
      * Called when the mutation fails.
      */
-    onError?: (error: any, variable: TVariable, stateBeforeExecute: MutationState<TData, TVariable>) => void;
+    onError?: (error: TError, variable: TVariable, stateBeforeExecute: MutationState<TData, TVariable, TError>) => void;
     /**
      * Called after the mutation settles (either success or error).
      */
-    onSettled?: (variable: TVariable, stateBeforeExecute: MutationState<TData, TVariable>) => void;
+    onSettled?: (variable: TVariable, stateBeforeExecute: MutationState<TData, TVariable, TError>) => void;
 };
 /**
  * Creates a mutation store for handling async operations that modify data.
@@ -89,10 +89,10 @@ export type MutationOptions<TData, TVariable> = InitStoreOptions<MutationState<T
  * 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>) => (() => MutationState<TData, TVariable>) & {
-    subscribe: (subscriber: import("../vanilla.ts").Subscriber<MutationState<TData, TVariable>>) => () => void;
-    getSubscribers: () => Set<import("../vanilla.ts").Subscriber<MutationState<TData, TVariable>>>;
-    getState: () => MutationState<TData, TVariable>;
+export declare const createMutation: <TData, TVariable = undefined, TError = Error>(mutationFn: (variable: TVariable, stateBeforeExecute: MutationState<TData, TVariable, TError>) => Promise<TData>, options?: MutationOptions<TData, TVariable, TError>) => (() => MutationState<TData, TVariable, TError>) & {
+    subscribe: (subscriber: import("../vanilla.ts").Subscriber<MutationState<TData, TVariable, TError>>) => () => void;
+    getSubscribers: () => Set<import("../vanilla.ts").Subscriber<MutationState<TData, TVariable, TError>>>;
+    getState: () => MutationState<TData, TVariable, TError>;
     /**
      * Manually updates the mutation state.
      *
@@ -100,7 +100,7 @@ export declare const createMutation: <TData, TVariable = undefined>(mutationFn:
      * - Intended for advanced use cases.
      * - Prefer using provided mutation actions (`execute`, `reset`) instead.
      */
-    setState: (value: SetState<MutationState<TData, TVariable>>) => void;
+    setState: (value: SetState<MutationState<TData, TVariable, TError>>) => void;
     /**
      * Executes the mutation.
      *
@@ -118,11 +118,11 @@ export declare const createMutation: <TData, TVariable = undefined>(mutationFn:
     execute: TVariable extends undefined ? () => Promise<{
         variable: undefined;
         data?: TData;
-        error?: any;
+        error?: TError;
     }> : (variable: TVariable) => Promise<{
         variable: TVariable;
         data?: TData;
-        error?: any;
+        error?: TError;
     }>;
     /**
      * Resets the mutation state back to its initial state.

package/react/create-query.d.ts

@@ -19,7 +19,7 @@ import { type InitStoreOptions, type SetState } from 'floppy-disk/vanilla';
  * @remarks
  * - Data and error are mutually exclusive except in `SUCCESS_BUT_REVALIDATION_ERROR`.
  */
-export type QueryState<TData> = {
+export type QueryState<TData, TError> = {
     isPending: boolean;
     isRevalidating: boolean;
     isRetrying: boolean;
@@ -46,7 +46,7 @@ export type QueryState<TData> = {
     isError: true;
     data: undefined;
     dataUpdatedAt: undefined;
-    error: any;
+    error: TError;
     errorUpdatedAt: number;
 } | {
     state: 'SUCCESS_BUT_REVALIDATION_ERROR';
@@ -54,7 +54,7 @@ export type QueryState<TData> = {
     isError: false;
     data: TData;
     dataUpdatedAt: number;
-    error: any;
+    error: TError;
     errorUpdatedAt: number;
 });
 /**
@@ -63,7 +63,7 @@ export type QueryState<TData> = {
  * @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>> & {
+export type QueryOptions<TData, TVariable extends Record<string, any>, TError = Error> = InitStoreOptions<QueryState<TData, TError>> & {
     /**
      * Time (in milliseconds) that data is considered fresh.
      *
@@ -95,15 +95,15 @@ export type QueryOptions<TData, TVariable extends Record<string, any>> = InitSto
     /**
      * Called when the query succeeds.
      */
-    onSuccess?: (data: TData, variable: TVariable, stateBeforeExecute: QueryState<TData>) => void;
+    onSuccess?: (data: TData, variable: TVariable, stateBeforeExecute: QueryState<TData, TError>) => void;
     /**
      * Called when the query fails and will not retry.
      */
-    onError?: (error: any, variable: TVariable, stateBeforeExecute: QueryState<TData>) => void;
+    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>) => void;
+    onSettled?: (variable: TVariable, stateBeforeExecute: QueryState<TData, TError>) => void;
     /**
      * Determines whether a failed query should retry.
      *
@@ -120,7 +120,7 @@ export type QueryOptions<TData, TVariable extends Record<string, any>> = InitSto
      *   return [false];
      * }
      */
-    shouldRetry?: (error: any, currentState: QueryState<TData>) => [true, number] | [false];
+    shouldRetry?: (error: TError, currentState: QueryState<TData, TError>) => [true, number] | [false];
 };
 /**
  * Creates a query factory for managing cached async operations.
@@ -157,7 +157,7 @@ export type QueryOptions<TData, TVariable extends Record<string, any>> = InitSto
  *   // ...
  * }
  */
-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) => ((options?: {
+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 execute automatically on mount.
      *
@@ -180,13 +180,13 @@ export declare const createQuery: <TData, TVariable extends Record<string, any>
      * // While loading userId=2, still show userId=1 data
      * useQuery({ id: userId }, { keepPreviousData: true });
      */ keepPreviousData?: boolean;
-}) => QueryState<TData>) & {
+}) => QueryState<TData, TError>) & {
     metadata: {
         isInvalidated?: boolean;
-        promise?: Promise<QueryState<TData>> | undefined;
-        promiseResolver?: ((value: QueryState<TData> | PromiseLike<QueryState<TData>>) => void) | undefined;
+        promise?: Promise<QueryState<TData, TError>> | undefined;
+        promiseResolver?: ((value: QueryState<TData, TError> | PromiseLike<QueryState<TData, TError>>) => void) | undefined;
         retryTimeoutId?: number;
-        retryResolver?: ((value: QueryState<TData> | PromiseLike<QueryState<TData>>) => void) | undefined;
+        retryResolver?: ((value: QueryState<TData, TError> | PromiseLike<QueryState<TData, TError>>) => void) | undefined;
         garbageCollectionTimeoutId?: number;
         rollbackData?: TData | undefined;
     };
@@ -222,7 +222,7 @@ export declare const createQuery: <TData, TVariable extends Record<string, any>
      */
     execute: (options?: {
         overwriteOngoingExecution?: boolean;
-    }) => Promise<QueryState<TData>>;
+    }) => Promise<QueryState<TData, TError>>;
     /**
      * Re-executes the query if needed based on freshness or invalidation.
      *
@@ -238,7 +238,7 @@ export declare const createQuery: <TData, TVariable extends Record<string, any>
      */
     revalidate: (options?: {
         overwriteOngoingExecution?: boolean;
-    }) => Promise<QueryState<TData>>;
+    }) => Promise<QueryState<TData, TError>>;
     /**
      * Marks the query as invalidated and optionally triggers re-execution.
      *
@@ -290,7 +290,7 @@ export declare const createQuery: <TData, TVariable extends Record<string, any>
      * const { rollback, revalidate } = query.optimisticUpdate(newData);
      */
     optimisticUpdate: (data: TData) => {
-        revalidate: () => Promise<QueryState<TData>>;
+        revalidate: () => Promise<QueryState<TData, TError>>;
         rollback: () => TData;
     };
     /**
@@ -302,10 +302,10 @@ export declare const createQuery: <TData, TVariable extends Record<string, any>
      * - Should be used if an optimistic update fails.
      */
     rollbackOptimisticUpdate: () => TData;
-    subscribe: (subscriber: import("../vanilla.ts").Subscriber<QueryState<TData>>) => () => void;
-    getSubscribers: () => Set<import("../vanilla.ts").Subscriber<QueryState<TData>>>;
-    getState: () => QueryState<TData>;
-    setState: (value: SetState<QueryState<TData>>) => void;
+    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.