floppy-disk 3.5.0 → 3.6.0

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.
  *
@@ -109,7 +109,7 @@ export type MutationOptions<TData, TVariable, TError = Error> = InitStoreOptions
  */
 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>>>;
+    getSubscriberCount: () => number;
     getState: () => MutationState<TData, TVariable, TError>;
     /**
      * Manually updates the mutation state.
@@ -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,4 @@
-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.
@@ -345,9 +345,9 @@ export declare const createQuery: <TData, TVariable extends StoreKey = never, TE
      */
     rollbackOptimisticUpdate: () => TData;
     subscribe: (subscriber: import("../vanilla.d.mts").Subscriber<QueryState<TData, TError>>) => () => void;
-    getSubscribers: () => Set<import("../vanilla.d.mts").Subscriber<QueryState<TData, TError>>>;
+    getSubscriberCount: () => number;
     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-stores.d.mts

@@ -48,10 +48,10 @@ 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>>;
+    getSubscriberCount: () => number;
     key: TKey;
     keyHash: string;
 };

package/esm/react.mjs

@@ -107,7 +107,7 @@ const createStores = (initialState, options) => {
     return Object.assign(useStore, {
       ...store,
       delete: () => {
-        if (store.getSubscribers().size > 0) {
+        if (store.getSubscriberCount() > 0) {
           console.warn(
             "Cannot delete store while it still has active subscribers. Unsubscribe all listeners before deleting the store."
           );
@@ -237,7 +237,7 @@ const createQuery = (queryFn, options = {}) => {
     invalidate: (options2) => {
       const { metadata } = internals.get(store);
       metadata.isInvalidated = true;
-      if (store.getSubscribers().size > 0) {
+      if (store.getSubscriberCount() > 0) {
         internals.get(store).execute(options2);
         return true;
       }
@@ -260,7 +260,7 @@ const createQuery = (queryFn, options = {}) => {
       store.setState(initialState);
     },
     delete: () => {
-      if (store.getSubscribers().size > 0) {
+      if (store.getSubscriberCount() > 0) {
         console.warn(
           "Cannot delete query store while it still has active subscribers. Unsubscribe all listeners before deleting the store."
         );
@@ -338,7 +338,7 @@ const createQuery = (queryFn, options = {}) => {
             isRetrying: false
           };
           const [shouldRetry, retryDelay] = shouldRetryFn(error, nextState);
-          const hasSubscriber = store.getSubscribers().size > 0;
+          const hasSubscriber = store.getSubscriberCount() > 0;
           if (shouldRetry && hasSubscriber) {
             metadata.retryResolver = resolve;
             metadata.retryTimeoutId = setTimeout(createPromise, retryDelay);
@@ -476,7 +476,7 @@ const createQuery = (queryFn, options = {}) => {
     };
     return Object.assign(useStore, {
       subscribe: store.subscribe,
-      getSubscribers: store.getSubscribers,
+      getSubscriberCount: store.getSubscriberCount,
       getState: store.getState,
       setState: (value) => {
         console.debug("Manual setState (not via provided actions) on query store");
@@ -609,7 +609,7 @@ const createMutation = (mutationFn, options = {}) => {
   };
   return Object.assign(useStore, {
     subscribe: store.subscribe,
-    getSubscribers: store.getSubscribers,
+    getSubscriberCount: store.getSubscriberCount,
     getState: store.getState,
     /**
      * Manually updates the mutation state.

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,10 +23,43 @@ 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;
+    /**
+     * Updates the state.
+     *
+     * @param value - Partial state or updater function
+     *
+     * @remarks
+     * - Accepts either a partial object or a function `(state) => partial`
+     * - Updates are shallowly merged into the current state
+     */
+    setState: (value: SetStateInput<TState>) => void;
+    /**
+     * Get the current state.
+     *
+     * @returns The latest state snapshot
+     */
     getState: () => TState;
+    /**
+     * Subscribes to state changes.
+     *
+     * @param subscriber - Function called when state updates
+     *
+     * @returns Unsubscribe function
+     *
+     * @remarks
+     * - Subscribers are only called when at least one root key changes
+     * - Receives `(state, prevState, changedKeys)`
+     */
     subscribe: (subscriber: Subscriber<TState>) => () => void;
-    getSubscribers: () => Set<Subscriber<TState>>;
+    /**
+     * Returns the number of active subscribers.
+     *
+     * @returns Total subscriber count
+     *
+     * @remarks
+     * - Can be used to determine if the store is currently in use
+     */
+    getSubscriberCount: () => number;
 };
 /**
  * Lifecycle hooks for the store.

package/esm/vanilla.mjs

@@ -39,7 +39,7 @@ const initStore = (initialState, options = {}) => {
     allowSetStateServerSide = false
   } = options;
   const subscribers = /* @__PURE__ */ new Set();
-  const getSubscribers = () => subscribers;
+  const getSubscriberCount = () => subscribers.size;
   const subscribe = (subscriber) => {
     subscribers.add(subscriber);
     if (subscribers.size === 1) onFirstSubscribe(state, storeApi);
@@ -76,7 +76,7 @@ const initStore = (initialState, options = {}) => {
     getState,
     setState,
     subscribe,
-    getSubscribers
+    getSubscriberCount
   };
   return storeApi;
 };

package/package.json

@@ -2,7 +2,7 @@
   "name": "floppy-disk",
   "description": "Lightweight unified state management for sync and async data.",
   "private": false,
-  "version": "3.5.0",
+  "version": "3.6.0",
   "keywords": [
     "utilities",
     "store",
@@ -68,7 +68,6 @@
       }
     }
   },
-  "packageManager": "pnpm@10.32.1",
   "peerDependencies": {
     "@types/react": ">=17.0",
     "react": ">=17.0"
@@ -81,4 +80,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.
  *
@@ -109,7 +109,7 @@ export type MutationOptions<TData, TVariable, TError = Error> = InitStoreOptions
  */
 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>>>;
+    getSubscriberCount: () => number;
     getState: () => MutationState<TData, TVariable, TError>;
     /**
      * Manually updates the mutation state.
@@ -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,4 @@
-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.
@@ -345,9 +345,9 @@ export declare const createQuery: <TData, TVariable extends StoreKey = never, TE
      */
     rollbackOptimisticUpdate: () => TData;
     subscribe: (subscriber: import("../vanilla.ts").Subscriber<QueryState<TData, TError>>) => () => void;
-    getSubscribers: () => Set<import("../vanilla.ts").Subscriber<QueryState<TData, TError>>>;
+    getSubscriberCount: () => number;
     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-stores.d.ts

@@ -48,10 +48,10 @@ 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>>;
+    getSubscriberCount: () => number;
     key: TKey;
     keyHash: string;
 };

package/react.js

@@ -109,7 +109,7 @@ const createStores = (initialState, options) => {
     return Object.assign(useStore, {
       ...store,
       delete: () => {
-        if (store.getSubscribers().size > 0) {
+        if (store.getSubscriberCount() > 0) {
           console.warn(
             "Cannot delete store while it still has active subscribers. Unsubscribe all listeners before deleting the store."
           );
@@ -239,7 +239,7 @@ const createQuery = (queryFn, options = {}) => {
     invalidate: (options2) => {
       const { metadata } = internals.get(store);
       metadata.isInvalidated = true;
-      if (store.getSubscribers().size > 0) {
+      if (store.getSubscriberCount() > 0) {
         internals.get(store).execute(options2);
         return true;
       }
@@ -262,7 +262,7 @@ const createQuery = (queryFn, options = {}) => {
       store.setState(initialState);
     },
     delete: () => {
-      if (store.getSubscribers().size > 0) {
+      if (store.getSubscriberCount() > 0) {
         console.warn(
           "Cannot delete query store while it still has active subscribers. Unsubscribe all listeners before deleting the store."
         );
@@ -340,7 +340,7 @@ const createQuery = (queryFn, options = {}) => {
             isRetrying: false
           };
           const [shouldRetry, retryDelay] = shouldRetryFn(error, nextState);
-          const hasSubscriber = store.getSubscribers().size > 0;
+          const hasSubscriber = store.getSubscriberCount() > 0;
           if (shouldRetry && hasSubscriber) {
             metadata.retryResolver = resolve;
             metadata.retryTimeoutId = setTimeout(createPromise, retryDelay);
@@ -478,7 +478,7 @@ const createQuery = (queryFn, options = {}) => {
     };
     return Object.assign(useStore, {
       subscribe: store.subscribe,
-      getSubscribers: store.getSubscribers,
+      getSubscriberCount: store.getSubscriberCount,
       getState: store.getState,
       setState: (value) => {
         console.debug("Manual setState (not via provided actions) on query store");
@@ -611,7 +611,7 @@ const createMutation = (mutationFn, options = {}) => {
   };
   return Object.assign(useStore, {
     subscribe: store.subscribe,
-    getSubscribers: store.getSubscribers,
+    getSubscriberCount: store.getSubscriberCount,
     getState: store.getState,
     /**
      * Manually updates the mutation state.

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,10 +23,43 @@ 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;
+    /**
+     * Updates the state.
+     *
+     * @param value - Partial state or updater function
+     *
+     * @remarks
+     * - Accepts either a partial object or a function `(state) => partial`
+     * - Updates are shallowly merged into the current state
+     */
+    setState: (value: SetStateInput<TState>) => void;
+    /**
+     * Get the current state.
+     *
+     * @returns The latest state snapshot
+     */
     getState: () => TState;
+    /**
+     * Subscribes to state changes.
+     *
+     * @param subscriber - Function called when state updates
+     *
+     * @returns Unsubscribe function
+     *
+     * @remarks
+     * - Subscribers are only called when at least one root key changes
+     * - Receives `(state, prevState, changedKeys)`
+     */
     subscribe: (subscriber: Subscriber<TState>) => () => void;
-    getSubscribers: () => Set<Subscriber<TState>>;
+    /**
+     * Returns the number of active subscribers.
+     *
+     * @returns Total subscriber count
+     *
+     * @remarks
+     * - Can be used to determine if the store is currently in use
+     */
+    getSubscriberCount: () => number;
 };
 /**
  * Lifecycle hooks for the store.

package/vanilla.js

@@ -41,7 +41,7 @@ const initStore = (initialState, options = {}) => {
     allowSetStateServerSide = false
   } = options;
   const subscribers = /* @__PURE__ */ new Set();
-  const getSubscribers = () => subscribers;
+  const getSubscriberCount = () => subscribers.size;
   const subscribe = (subscriber) => {
     subscribers.add(subscriber);
     if (subscribers.size === 1) onFirstSubscribe(state, storeApi);
@@ -78,7 +78,7 @@ const initStore = (initialState, options = {}) => {
     getState,
     setState,
     subscribe,
-    getSubscribers
+    getSubscriberCount
   };
   return storeApi;
 };