@bquery/bquery 1.5.0 → 1.6.0

package/src/store/types.ts

@@ -1,94 +1,92 @@
-/**
- * Store types for bQuery's state module.
- * @module bquery/store
- */
-
-/**
- * Store state factory function.
- */
-export type StateFactory<S> = () => S;
-
-/**
- * Getter definition - derives computed values from state.
- */
-export type Getters<S, G> = {
-  [K in keyof G]: (state: S, getters: G) => G[K];
-};
-
-/**
- * Action definition - methods that can modify state.
- * The `this` context includes state, getters, and other actions.
- */
-export type Actions<S, G, A> = {
-  [K in keyof A]: A[K] extends (...args: infer P) => infer R
-    ? (this: S & G & A, ...args: P) => R
-    : never;
-};
-
-/**
- * Store definition for createStore.
- */
-export type StoreDefinition<
-  S extends Record<string, unknown> = Record<string, unknown>,
-  G extends Record<string, unknown> = Record<string, unknown>,
-  // eslint-disable-next-line @typescript-eslint/no-explicit-any
-  A extends Record<string, (...args: any[]) => any> = Record<string, never>,
-> = {
-  /** Unique store identifier for devtools */
-  id: string;
-  /** State factory function */
-  state: StateFactory<S>;
-  /** Computed getters */
-  getters?: Getters<S, G>;
-  /** Action methods */
-  actions?: Actions<S, G, A>;
-};
-
-/**
- * Store subscriber callback.
- */
-export type StoreSubscriber<S> = (state: S) => void;
-
-/**
- * Patch payload for store updates.
- */
-export type StorePatch<S> = Partial<S> | ((state: S) => void);
-
-/**
- * The returned store instance with state, getters, and actions merged.
- */
-export type Store<
-  S extends Record<string, unknown>,
-  G extends Record<string, unknown>,
-  // eslint-disable-next-line @typescript-eslint/no-explicit-any
-  A extends Record<string, (...args: any[]) => any>,
-> = S &
-  G &
-  A & {
-    /** Store identifier */
-    $id: string;
-    /** Reset state to initial values */
-    $reset: () => void;
-    /** Subscribe to state changes */
-    $subscribe: (callback: StoreSubscriber<S>) => () => void;
-    /** Patch multiple state properties at once (shallow) */
-    $patch: (partial: StorePatch<S>) => void;
-    /**
-     * Patch with deep reactivity support.
-     * Unlike $patch, this method deep-clones nested objects before mutation,
-     * ensuring that all changes trigger reactive updates.
-     */
-    $patchDeep: (partial: StorePatch<S>) => void;
-    /** Get raw state object (non-reactive snapshot) */
-    $state: S;
-  };
-
-/**
- * Plugin that can extend store functionality.
- */
-export type StorePlugin<S = unknown> = (context: {
-  // eslint-disable-next-line @typescript-eslint/no-explicit-any
-  store: Store<any, any, any>;
-  // eslint-disable-next-line @typescript-eslint/no-explicit-any
-  options: StoreDefinition<any, any, any>;
-}) => Partial<S> | void;
+/**
+ * Store types for bQuery's state module.
+ * @module bquery/store
+ */
+
+/**
+ * Store state factory function.
+ */
+export type StateFactory<S> = () => S;
+
+/**
+ * Getter definition - derives computed values from state.
+ */
+export type Getters<S, G> = {
+  [K in keyof G]: (state: S, getters: G) => G[K];
+};
+
+/**
+ * Action definition - methods that can modify state.
+ * The `this` context includes state, getters, and other actions.
+ */
+export type Actions<S, G, A> = {
+  [K in keyof A]: A[K];
+} & ThisType<S & G & A>;
+
+/**
+ * Store definition for createStore.
+ */
+export type StoreDefinition<
+  S extends Record<string, unknown> = Record<string, unknown>,
+  G extends Record<string, unknown> = Record<string, unknown>,
+  // eslint-disable-next-line @typescript-eslint/no-explicit-any
+  A extends Record<string, (...args: any[]) => any> = Record<string, never>,
+> = {
+  /** Unique store identifier for devtools */
+  id: string;
+  /** State factory function */
+  state: StateFactory<S>;
+  /** Computed getters */
+  getters?: Getters<S, G>;
+  /** Action methods */
+  actions?: Actions<S, G, A>;
+};
+
+/**
+ * Store subscriber callback.
+ */
+export type StoreSubscriber<S> = (state: S) => void;
+
+/**
+ * Patch payload for store updates.
+ */
+export type StorePatch<S> = Partial<S> | ((state: S) => void);
+
+/**
+ * The returned store instance with state, getters, and actions merged.
+ */
+export type Store<
+  S extends Record<string, unknown>,
+  G extends Record<string, unknown>,
+  // eslint-disable-next-line @typescript-eslint/no-explicit-any
+  A extends Record<string, (...args: any[]) => any>,
+> = S &
+  G &
+  A & {
+    /** Store identifier */
+    $id: string;
+    /** Reset state to initial values */
+    $reset: () => void;
+    /** Subscribe to state changes */
+    $subscribe: (callback: StoreSubscriber<S>) => () => void;
+    /** Patch multiple state properties at once (shallow) */
+    $patch: (partial: StorePatch<S>) => void;
+    /**
+     * Patch with deep reactivity support.
+     * Unlike $patch, this method deep-clones nested objects before mutation,
+     * ensuring that all changes trigger reactive updates.
+     */
+    $patchDeep: (partial: StorePatch<S>) => void;
+    /** Get raw state object (non-reactive snapshot) */
+    $state: S;
+  };
+
+/**
+ * Plugin that can extend store functionality.
+ */
+export type StorePlugin<S = unknown> = (context: {
+  // eslint-disable-next-line @typescript-eslint/no-explicit-any
+  store: Store<any, any, any>;
+  // eslint-disable-next-line @typescript-eslint/no-explicit-any
+  options: StoreDefinition<any, any, any>;
+}) => Partial<S> | void;

package/src/store/watch.ts

@@ -1,52 +1,53 @@
-/**
- * Store watch helpers.
- */
-
-import type { Store } from './types';
-import { deepEqual } from './utils';
-
-export type WatchStoreOptions<T> = {
-  /** Call the callback immediately with the current value. */
-  immediate?: boolean;
-  /** Use deep comparison when determining changes. */
-  deep?: boolean;
-  /** Custom equality check for selected values. */
-  equals?: (a: T, b: T) => boolean;
-};
-
-/**
- * Watch a selected slice of store state.
- *
- * @param store - The store instance
- * @param selector - Function to select the watched value
- * @param callback - Called when the selected value changes
- * @param options - Watch options
- * @returns Unsubscribe function
- */
-export const watchStore = <
-  S extends Record<string, unknown>,
-  G extends Record<string, unknown>,
-  A extends Record<string, (...args: unknown[]) => unknown>,
-  T,
->(
-  store: Store<S, G, A>,
-  selector: (state: S) => T,
-  callback: (value: T, previous: T | undefined) => void,
-  options: WatchStoreOptions<T> = {}
-): (() => void) => {
-  const equals = options.equals ?? (options.deep ? deepEqual : Object.is);
-  let previous = selector(store.$state);
-
-  if (options.immediate) {
-    callback(previous, undefined);
-  }
-
-  return store.$subscribe((state) => {
-    const current = selector(state);
-    if (!equals(current, previous)) {
-      const prev = previous;
-      previous = current;
-      callback(current, prev);
-    }
-  });
-};
+/**
+ * Store watch helpers.
+ */
+
+import type { Store } from './types';
+import { deepEqual } from './utils';
+
+export type WatchStoreOptions<T> = {
+  /** Call the callback immediately with the current value. */
+  immediate?: boolean;
+  /** Use deep comparison when determining changes. */
+  deep?: boolean;
+  /** Custom equality check for selected values. */
+  equals?: (a: T, b: T) => boolean;
+};
+
+/**
+ * Watch a selected slice of store state.
+ *
+ * @param store - The store instance
+ * @param selector - Function to select the watched value
+ * @param callback - Called when the selected value changes
+ * @param options - Watch options
+ * @returns Unsubscribe function
+ */
+export const watchStore = <
+  S extends Record<string, unknown>,
+  G extends Record<string, unknown>,
+  // eslint-disable-next-line @typescript-eslint/no-explicit-any -- actions may declare specific parameter types
+  A extends Record<string, (...args: any[]) => any>,
+  T,
+>(
+  store: Store<S, G, A>,
+  selector: (state: S) => T,
+  callback: (value: T, previous: T | undefined) => void,
+  options: WatchStoreOptions<T> = {}
+): (() => void) => {
+  const equals = options.equals ?? (options.deep ? deepEqual : Object.is);
+  let previous = selector(store.$state);
+
+  if (options.immediate) {
+    callback(previous, undefined);
+  }
+
+  return store.$subscribe((state) => {
+    const current = selector(state);
+    if (!equals(current, previous)) {
+      const prev = previous;
+      previous = current;
+      callback(current, prev);
+    }
+  });
+};