floppy-disk 3.4.0 → 3.5.1

package/README.md

@@ -96,6 +96,8 @@ function PlantDetail({ id }) {
 }
 ```
 
+<br>
+
 ---
 
 Read the docs → https://floppy-disk.vercel.app

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

@@ -1,4 +1,4 @@
-import { type InitStoreOptions, type SetState } from "../vanilla.mjs";
+import { type InitStoreOptions, type SetStateInput } from "../vanilla.mjs";
 /**
  * Represents the state of a mutation.
  *
@@ -105,7 +105,7 @@ export type MutationOptions<TData, TVariable, TError = Error> = InitStoreOptions
  * const { isPending } = useCreateUser();
  * const result = await useCreateUser.execute({ name: 'John' });
  *
- * @see https://floppy-disk.vercel.app/docs/async/mutation
+ * @see https://floppy-disk.vercel.app/docs/mutation
  */
 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;
@@ -118,7 +118,7 @@ export declare const createMutation: <TData, TVariable = undefined, TError = Err
      * - Intended for advanced use cases.
      * - Prefer using provided mutation actions (`execute`, `reset`) instead.
      */
-    setState: (value: SetState<MutationState<TData, TVariable, TError>>) => void;
+    setState: (value: SetStateInput<MutationState<TData, TVariable, TError>>) => void;
     /**
      * Executes the mutation.
      *

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

@@ -1,4 +1,5 @@
-import { type InitStoreOptions, type SetState } from "../vanilla.mjs";
+import { type InitStoreOptions, type SetStateInput } from "../vanilla.mjs";
+import type { StoreKey } from "./create-stores.mjs";
 /**
  * Represents the state of a query.
  *
@@ -68,7 +69,7 @@ export type QueryState<TData, TError> = {
  * @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>, {
+export type QueryOptions<TData, TVariable extends StoreKey, TError = Error> = InitStoreOptions<QueryState<TData, TError>, {
     variableHash: string;
 }> & {
     /**
@@ -164,9 +165,9 @@ export type QueryOptions<TData, TVariable extends Record<string, any>, TError =
  *   // ...
  * }
  *
- * @see https://floppy-disk.vercel.app/docs/async/query
+ * @see https://floppy-disk.vercel.app/docs/query
  */
-export declare const createQuery: <TData, TVariable extends Record<string, any> = never, TError = Error>(queryFn: (variable: TVariable, currentState: QueryState<TData, TError>, variableHash: string) => Promise<TData>, options?: QueryOptions<TData, TVariable, TError>) => ((variable?: TVariable) => ((options?: {
+export declare const createQuery: <TData, TVariable extends StoreKey = never, TError = Error>(queryFn: (variable: TVariable, currentState: QueryState<TData, TError>, variableHash: string) => Promise<TData>, options?: QueryOptions<TData, TVariable, TError>) => ((variable?: TVariable) => ((options?: {
     /**
      * Whether the query should be ravalidated automatically on mount.
      *
@@ -218,6 +219,7 @@ export declare const createQuery: <TData, TVariable extends Record<string, any>
     initialData?: never;
     initialDataIsStale?: never;
 })) => QueryState<TData, TError>) & {
+    variableHash: string;
     /**
      * Internal data, do not mutate!
      */
@@ -345,7 +347,7 @@ export declare const createQuery: <TData, TVariable extends Record<string, any>
     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;
+    setState: (value: SetStateInput<QueryState<TData, TError>>) => void;
 }) & {
     /**
      * Executes all query instances.

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

@@ -25,7 +25,7 @@ import { type InitStoreOptions } from "../vanilla.mjs";
  *
  * useMyStore.setState({ foo: 2 }); // only components using foo will re-render
  *
- * @see https://floppy-disk.vercel.app/docs/sync/store
+ * @see https://floppy-disk.vercel.app/docs/store
  */
 export declare const createStore: <TState extends Record<string, any>>(initialState: TState, options?: InitStoreOptions<TState>) => ((options?: {
     /**

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

@@ -1,4 +1,8 @@
 import { type InitStoreOptions } from "../vanilla.mjs";
+type GoodInputForHash = string | number | boolean | null | Date;
+export type StoreKey = GoodInputForHash | {
+    [key: string | number]: StoreKey | StoreKey[];
+};
 /**
  * Creates a factory for multiple stores identified by a key.
  *
@@ -30,9 +34,9 @@ import { type InitStoreOptions } from "../vanilla.mjs";
  *   return <div>{state.name}</div>;
  * }
  *
- * @see https://floppy-disk.vercel.app/docs/sync/stores
+ * @see https://floppy-disk.vercel.app/docs/stores
  */
-export declare const createStores: <TState extends Record<string, any>, TKey extends Record<string, any>>(initialState: TState, options?: InitStoreOptions<TState, {
+export declare const createStores: <TState extends Record<string, any>, TKey extends StoreKey>(initialState: TState, options?: InitStoreOptions<TState, {
     key: TKey;
     keyHash: string;
 }>) => (key?: TKey) => ((options?: {
@@ -44,10 +48,11 @@ export declare const createStores: <TState extends Record<string, any>, TKey ext
     initialState?: Partial<TState>;
 }) => TState) & {
     delete: () => boolean;
-    setState: (value: import("../vanilla.d.mts").SetState<TState>) => void;
+    setState: (value: import("../vanilla.d.mts").SetStateInput<TState>) => void;
     getState: () => TState;
     subscribe: (subscriber: import("../vanilla.d.mts").Subscriber<TState>) => () => void;
     getSubscribers: () => Set<import("../vanilla.d.mts").Subscriber<TState>>;
     key: TKey;
     keyHash: string;
 };
+export {};

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

@@ -21,7 +21,7 @@ import { type MutationOptions, type MutationState } from "./create-mutation.mjs"
  *   - Only the latest execution is allowed to update the state.
  *   - Results from previous executions are ignored if a newer one exists.
  *
- * @see https://floppy-disk.vercel.app/docs/async/mutation
+ * @see https://floppy-disk.vercel.app/docs/mutation
  */
 export declare const useMutation: <TData, TVariable = undefined, TError = Error>(
 /**

package/esm/react.mjs

@@ -482,7 +482,8 @@ const createQuery = (queryFn, options = {}) => {
         console.debug("Manual setState (not via provided actions) on query store");
         store.setState(value);
       },
-      ...internals.get(store)
+      ...internals.get(store),
+      variableHash
     });
   };
   return Object.assign(getStore, {

package/esm/vanilla/store.d.mts

@@ -1,11 +1,4 @@
-/**
- * Represents a partial state update.
- *
- * Can be either:
- * - A partial object to merge into the current state
- * - A function that receives the current state and returns a partial update
- */
-export type SetState<TState> = Partial<TState> | ((state: TState) => Partial<TState>);
+export type SetStateInput<TState> = Partial<TState> | ((state: TState) => Partial<TState>);
 /**
  * A subscriber function that is called whenever the state updates.
  *
@@ -30,7 +23,7 @@ export type Subscriber<TState> = (state: TState, prevState: TState, changedKeys:
  * - By default, `setState` is **disabled on the server** to prevent accidental shared state between requests.
  */
 export type StoreApi<TState extends Record<string, any>> = {
-    setState: (value: SetState<TState>) => void;
+    setState: (value: SetStateInput<TState>) => void;
     getState: () => TState;
     subscribe: (subscriber: Subscriber<TState>) => () => void;
     getSubscribers: () => Set<Subscriber<TState>>;

package/package.json

@@ -2,7 +2,7 @@
   "name": "floppy-disk",
   "description": "Lightweight unified state management for sync and async data.",
   "private": false,
-  "version": "3.4.0",
+  "version": "3.5.1",
   "keywords": [
     "utilities",
     "store",
@@ -68,6 +68,7 @@
       }
     }
   },
+  "packageManager": "pnpm@10.32.1",
   "peerDependencies": {
     "@types/react": ">=17.0",
     "react": ">=17.0"
@@ -80,4 +81,4 @@
       "optional": true
     }
   }
-}
+}

package/react/create-mutation.d.ts

@@ -1,4 +1,4 @@
-import { type InitStoreOptions, type SetState } from "../vanilla.ts";
+import { type InitStoreOptions, type SetStateInput } from "../vanilla.ts";
 /**
  * Represents the state of a mutation.
  *
@@ -105,7 +105,7 @@ export type MutationOptions<TData, TVariable, TError = Error> = InitStoreOptions
  * const { isPending } = useCreateUser();
  * const result = await useCreateUser.execute({ name: 'John' });
  *
- * @see https://floppy-disk.vercel.app/docs/async/mutation
+ * @see https://floppy-disk.vercel.app/docs/mutation
  */
 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;
@@ -118,7 +118,7 @@ export declare const createMutation: <TData, TVariable = undefined, TError = Err
      * - Intended for advanced use cases.
      * - Prefer using provided mutation actions (`execute`, `reset`) instead.
      */
-    setState: (value: SetState<MutationState<TData, TVariable, TError>>) => void;
+    setState: (value: SetStateInput<MutationState<TData, TVariable, TError>>) => void;
     /**
      * Executes the mutation.
      *

package/react/create-query.d.ts

@@ -1,4 +1,5 @@
-import { type InitStoreOptions, type SetState } from "../vanilla.ts";
+import { type InitStoreOptions, type SetStateInput } from "../vanilla.ts";
+import type { StoreKey } from "./create-stores.ts";
 /**
  * Represents the state of a query.
  *
@@ -68,7 +69,7 @@ export type QueryState<TData, TError> = {
  * @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>, {
+export type QueryOptions<TData, TVariable extends StoreKey, TError = Error> = InitStoreOptions<QueryState<TData, TError>, {
     variableHash: string;
 }> & {
     /**
@@ -164,9 +165,9 @@ export type QueryOptions<TData, TVariable extends Record<string, any>, TError =
  *   // ...
  * }
  *
- * @see https://floppy-disk.vercel.app/docs/async/query
+ * @see https://floppy-disk.vercel.app/docs/query
  */
-export declare const createQuery: <TData, TVariable extends Record<string, any> = never, TError = Error>(queryFn: (variable: TVariable, currentState: QueryState<TData, TError>, variableHash: string) => Promise<TData>, options?: QueryOptions<TData, TVariable, TError>) => ((variable?: TVariable) => ((options?: {
+export declare const createQuery: <TData, TVariable extends StoreKey = never, TError = Error>(queryFn: (variable: TVariable, currentState: QueryState<TData, TError>, variableHash: string) => Promise<TData>, options?: QueryOptions<TData, TVariable, TError>) => ((variable?: TVariable) => ((options?: {
     /**
      * Whether the query should be ravalidated automatically on mount.
      *
@@ -218,6 +219,7 @@ export declare const createQuery: <TData, TVariable extends Record<string, any>
     initialData?: never;
     initialDataIsStale?: never;
 })) => QueryState<TData, TError>) & {
+    variableHash: string;
     /**
      * Internal data, do not mutate!
      */
@@ -345,7 +347,7 @@ export declare const createQuery: <TData, TVariable extends Record<string, any>
     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;
+    setState: (value: SetStateInput<QueryState<TData, TError>>) => void;
 }) & {
     /**
      * Executes all query instances.

package/react/create-store.d.ts

@@ -25,7 +25,7 @@ import { type InitStoreOptions } from "../vanilla.ts";
  *
  * useMyStore.setState({ foo: 2 }); // only components using foo will re-render
  *
- * @see https://floppy-disk.vercel.app/docs/sync/store
+ * @see https://floppy-disk.vercel.app/docs/store
  */
 export declare const createStore: <TState extends Record<string, any>>(initialState: TState, options?: InitStoreOptions<TState>) => ((options?: {
     /**

package/react/create-stores.d.ts

@@ -1,4 +1,8 @@
 import { type InitStoreOptions } from "../vanilla.ts";
+type GoodInputForHash = string | number | boolean | null | Date;
+export type StoreKey = GoodInputForHash | {
+    [key: string | number]: StoreKey | StoreKey[];
+};
 /**
  * Creates a factory for multiple stores identified by a key.
  *
@@ -30,9 +34,9 @@ import { type InitStoreOptions } from "../vanilla.ts";
  *   return <div>{state.name}</div>;
  * }
  *
- * @see https://floppy-disk.vercel.app/docs/sync/stores
+ * @see https://floppy-disk.vercel.app/docs/stores
  */
-export declare const createStores: <TState extends Record<string, any>, TKey extends Record<string, any>>(initialState: TState, options?: InitStoreOptions<TState, {
+export declare const createStores: <TState extends Record<string, any>, TKey extends StoreKey>(initialState: TState, options?: InitStoreOptions<TState, {
     key: TKey;
     keyHash: string;
 }>) => (key?: TKey) => ((options?: {
@@ -44,10 +48,11 @@ export declare const createStores: <TState extends Record<string, any>, TKey ext
     initialState?: Partial<TState>;
 }) => TState) & {
     delete: () => boolean;
-    setState: (value: import("../vanilla.ts").SetState<TState>) => void;
+    setState: (value: import("../vanilla.ts").SetStateInput<TState>) => void;
     getState: () => TState;
     subscribe: (subscriber: import("../vanilla.ts").Subscriber<TState>) => () => void;
     getSubscribers: () => Set<import("../vanilla.ts").Subscriber<TState>>;
     key: TKey;
     keyHash: string;
 };
+export {};

package/react/use-mutation.d.ts

@@ -21,7 +21,7 @@ import { type MutationOptions, type MutationState } from "./create-mutation.ts";
  *   - Only the latest execution is allowed to update the state.
  *   - Results from previous executions are ignored if a newer one exists.
  *
- * @see https://floppy-disk.vercel.app/docs/async/mutation
+ * @see https://floppy-disk.vercel.app/docs/mutation
  */
 export declare const useMutation: <TData, TVariable = undefined, TError = Error>(
 /**

package/react.js

@@ -484,7 +484,8 @@ const createQuery = (queryFn, options = {}) => {
         console.debug("Manual setState (not via provided actions) on query store");
         store.setState(value);
       },
-      ...internals.get(store)
+      ...internals.get(store),
+      variableHash
     });
   };
   return Object.assign(getStore, {

package/vanilla/store.d.ts

@@ -1,11 +1,4 @@
-/**
- * Represents a partial state update.
- *
- * Can be either:
- * - A partial object to merge into the current state
- * - A function that receives the current state and returns a partial update
- */
-export type SetState<TState> = Partial<TState> | ((state: TState) => Partial<TState>);
+export type SetStateInput<TState> = Partial<TState> | ((state: TState) => Partial<TState>);
 /**
  * A subscriber function that is called whenever the state updates.
  *
@@ -30,7 +23,7 @@ export type Subscriber<TState> = (state: TState, prevState: TState, changedKeys:
  * - By default, `setState` is **disabled on the server** to prevent accidental shared state between requests.
  */
 export type StoreApi<TState extends Record<string, any>> = {
-    setState: (value: SetState<TState>) => void;
+    setState: (value: SetStateInput<TState>) => void;
     getState: () => TState;
     subscribe: (subscriber: Subscriber<TState>) => () => void;
     getSubscribers: () => Set<Subscriber<TState>>;