coaction 1.3.0 → 1.4.0

package/README.md

@@ -27,7 +27,12 @@ const useStore = create((set) => ({
 
 ### Store Shape Mode (`sliceMode`)
 
-`create()` uses `sliceMode: 'auto'` by default. You can force behavior explicitly:
+`create()` uses `sliceMode: 'auto'` by default. For backward compatibility,
+`auto` still treats a non-empty object whose enumerable values are all
+functions as slices. That shape is ambiguous with a plain store that only
+contains methods, so you should set `sliceMode` explicitly.
+
+You can force behavior explicitly:
 
 - `sliceMode: 'single'`: treat object input as a single store.
 - `sliceMode: 'slices'`: require object-of-slice-functions input.

package/dist/index.d.mts

@@ -6,6 +6,32 @@ type DeepPartial<T> = {
     [K in keyof T]?: T[K] extends object ? DeepPartial<T[K]> : T[K];
 };
 type Listener = () => void;
+interface PatchTransform {
+    patches: Patches;
+    inversePatches: Patches;
+}
+interface StoreTraceEvent {
+    /**
+     * The id of the method.
+     */
+    id: string;
+    /**
+     * The method name.
+     */
+    method: string;
+    /**
+     * The slice key.
+     */
+    sliceKey?: string;
+    /**
+     * The parameters of the method.
+     */
+    parameters?: any[];
+    /**
+     * The result of the method.
+     */
+    result?: any;
+}
 interface Store<T extends ISlices = ISlices> {
     /**
      * The name of the store.
@@ -60,40 +86,20 @@ interface Store<T extends ISlices = ISlices> {
      */
     getInitialState: () => T;
     /**
-     * The patch is used to update the state.
+     * @deprecated Middleware compatibility hook. Prefer typing middleware stores
+     * with `MiddlewareStore`.
      */
-    patch?: (option: {
-        patches: Patches;
-        inversePatches: Patches;
-    }) => {
-        patches: Patches;
-        inversePatches: Patches;
-    };
+    patch?: (option: PatchTransform) => PatchTransform;
     /**
-     * The trace is used to trace the action
+     * @deprecated Middleware compatibility hook. Prefer typing middleware stores
+     * with `MiddlewareStore`.
      */
-    trace?: (options: {
-        /**
-         * The id of the method.
-         */
-        id: string;
-        /**
-         * The method name.
-         */
-        method: string;
-        /**
-         * The slice key.
-         */
-        sliceKey?: string;
-        /**
-         * The parameters of the method.
-         */
-        parameters?: any[];
-        /**
-         * The result of the method.
-         */
-        result?: any;
-    }) => void;
+    trace?: (options: StoreTraceEvent) => void;
+}
+/**
+ * Semantic alias for middleware-facing stores.
+ */
+interface MiddlewareStore<T extends ISlices = ISlices> extends Store<T> {
 }
 interface Getter<T extends ISlices> {
     <P extends any[], R>(getDeps: (store: T) => readonly [...P] | [...P], selector: (...args: P) => R): R;
@@ -125,7 +131,7 @@ get: Getter<T>,
  * The store is used to store the state.
  */
 store: Store<T>) => T[K];
-type Middleware<T extends CreateState> = (store: Store<T>) => Store<T>;
+type Middleware<T extends CreateState> = (store: MiddlewareStore<T>) => MiddlewareStore<T>;
 type SliceState<T extends Record<string, Slice<any>>> = {
     [K in keyof T]: ReturnType<T[K]>;
 };
@@ -134,8 +140,15 @@ type StoreOptions<T extends CreateState> = {
      * The name of the store.
      */
     name?: string;
-    transport?: Transport;
+    /**
+     * @deprecated Internal worker-mode override retained for compatibility.
+     * Prefer passing `transport` or letting the runtime infer the environment.
+     */
     workerType?: 'SharedWorkerInternal' | 'WebWorkerInternal';
+    /**
+     * Inject a pre-built transport for advanced shared-store setups.
+     */
+    transport?: Transport;
     middlewares?: Middleware<T>[];
     /**
      * enable patches
@@ -143,7 +156,8 @@ type StoreOptions<T extends CreateState> = {
     enablePatches?: boolean;
     /**
      * control how createState should be interpreted.
-     * - auto: infer from createState shape.
+     * - auto: infer from createState shape. Object maps whose values are all
+     *   functions are ambiguous, so prefer setting `sliceMode` explicitly.
      * - slices: force slices mode.
      * - single: force single-store mode.
      */
@@ -157,15 +171,36 @@ type ClientStoreOptions<T extends CreateState> = {
     middlewares?: Middleware<T>[];
     /**
      * control how createState should be interpreted.
-     * - auto: infer from createState shape.
+     * - auto: infer from createState shape. Object maps whose values are all
+     *   functions are ambiguous, so prefer setting `sliceMode` explicitly.
      * - slices: force slices mode.
      * - single: force single-store mode.
      */
     sliceMode?: 'auto' | 'slices' | 'single';
 } & ClientTransportOptions;
 interface ClientTransportOptions {
+    /**
+     * @deprecated Internal worker-mode override retained for compatibility.
+     * Prefer passing `clientTransport` or `worker`.
+     */
     workerType?: 'WebWorkerClient' | 'SharedWorkerClient';
+    /**
+     * How long the client should wait for sequence catch-up before falling back
+     * to `fullSync`.
+     *
+     * Increase this when worker-side execution can complete before the matching
+     * incremental `update` message arrives under heavy load.
+     *
+     * @default 1500
+     */
+    executeSyncTimeoutMs?: number;
+    /**
+     * Inject a pre-built client transport.
+     */
     clientTransport?: Transport<any>;
+    /**
+     * Build a client transport from a Worker or SharedWorker instance.
+     */
     worker?: SharedWorker | Worker;
 }
 type Asyncify<T extends object, D extends true | false> = {
@@ -287,4 +322,4 @@ declare function createBinder<F = (...args: any[]) => any>({ handleState, handle
  */
 declare const wrapStore: <T extends object>(store: Store<T>, getState?: (...args: unknown[]) => T) => StoreReturn<T>;
 
-export { type StoreWithAsyncFunction as AsyncStore, type Asyncify, type ClientStoreOptions, type ISlices, type Middleware, type Slice, type SliceState, type Slices, type Store, type StoreOptions, create, createBinder, wrapStore };
+export { type StoreWithAsyncFunction as AsyncStore, type Asyncify, type ClientStoreOptions, type ISlices, type Middleware, type MiddlewareStore, type PatchTransform, type Slice, type SliceState, type Slices, type Store, type StoreOptions, type StoreTraceEvent, create, createBinder, wrapStore };

package/dist/index.d.ts

@@ -6,6 +6,32 @@ type DeepPartial<T> = {
     [K in keyof T]?: T[K] extends object ? DeepPartial<T[K]> : T[K];
 };
 type Listener = () => void;
+interface PatchTransform {
+    patches: Patches;
+    inversePatches: Patches;
+}
+interface StoreTraceEvent {
+    /**
+     * The id of the method.
+     */
+    id: string;
+    /**
+     * The method name.
+     */
+    method: string;
+    /**
+     * The slice key.
+     */
+    sliceKey?: string;
+    /**
+     * The parameters of the method.
+     */
+    parameters?: any[];
+    /**
+     * The result of the method.
+     */
+    result?: any;
+}
 interface Store<T extends ISlices = ISlices> {
     /**
      * The name of the store.
@@ -60,40 +86,20 @@ interface Store<T extends ISlices = ISlices> {
      */
     getInitialState: () => T;
     /**
-     * The patch is used to update the state.
+     * @deprecated Middleware compatibility hook. Prefer typing middleware stores
+     * with `MiddlewareStore`.
      */
-    patch?: (option: {
-        patches: Patches;
-        inversePatches: Patches;
-    }) => {
-        patches: Patches;
-        inversePatches: Patches;
-    };
+    patch?: (option: PatchTransform) => PatchTransform;
     /**
-     * The trace is used to trace the action
+     * @deprecated Middleware compatibility hook. Prefer typing middleware stores
+     * with `MiddlewareStore`.
      */
-    trace?: (options: {
-        /**
-         * The id of the method.
-         */
-        id: string;
-        /**
-         * The method name.
-         */
-        method: string;
-        /**
-         * The slice key.
-         */
-        sliceKey?: string;
-        /**
-         * The parameters of the method.
-         */
-        parameters?: any[];
-        /**
-         * The result of the method.
-         */
-        result?: any;
-    }) => void;
+    trace?: (options: StoreTraceEvent) => void;
+}
+/**
+ * Semantic alias for middleware-facing stores.
+ */
+interface MiddlewareStore<T extends ISlices = ISlices> extends Store<T> {
 }
 interface Getter<T extends ISlices> {
     <P extends any[], R>(getDeps: (store: T) => readonly [...P] | [...P], selector: (...args: P) => R): R;
@@ -125,7 +131,7 @@ get: Getter<T>,
  * The store is used to store the state.
  */
 store: Store<T>) => T[K];
-type Middleware<T extends CreateState> = (store: Store<T>) => Store<T>;
+type Middleware<T extends CreateState> = (store: MiddlewareStore<T>) => MiddlewareStore<T>;
 type SliceState<T extends Record<string, Slice<any>>> = {
     [K in keyof T]: ReturnType<T[K]>;
 };
@@ -134,8 +140,15 @@ type StoreOptions<T extends CreateState> = {
      * The name of the store.
      */
     name?: string;
-    transport?: Transport;
+    /**
+     * @deprecated Internal worker-mode override retained for compatibility.
+     * Prefer passing `transport` or letting the runtime infer the environment.
+     */
     workerType?: 'SharedWorkerInternal' | 'WebWorkerInternal';
+    /**
+     * Inject a pre-built transport for advanced shared-store setups.
+     */
+    transport?: Transport;
     middlewares?: Middleware<T>[];
     /**
      * enable patches
@@ -143,7 +156,8 @@ type StoreOptions<T extends CreateState> = {
     enablePatches?: boolean;
     /**
      * control how createState should be interpreted.
-     * - auto: infer from createState shape.
+     * - auto: infer from createState shape. Object maps whose values are all
+     *   functions are ambiguous, so prefer setting `sliceMode` explicitly.
      * - slices: force slices mode.
      * - single: force single-store mode.
      */
@@ -157,15 +171,36 @@ type ClientStoreOptions<T extends CreateState> = {
     middlewares?: Middleware<T>[];
     /**
      * control how createState should be interpreted.
-     * - auto: infer from createState shape.
+     * - auto: infer from createState shape. Object maps whose values are all
+     *   functions are ambiguous, so prefer setting `sliceMode` explicitly.
      * - slices: force slices mode.
      * - single: force single-store mode.
      */
     sliceMode?: 'auto' | 'slices' | 'single';
 } & ClientTransportOptions;
 interface ClientTransportOptions {
+    /**
+     * @deprecated Internal worker-mode override retained for compatibility.
+     * Prefer passing `clientTransport` or `worker`.
+     */
     workerType?: 'WebWorkerClient' | 'SharedWorkerClient';
+    /**
+     * How long the client should wait for sequence catch-up before falling back
+     * to `fullSync`.
+     *
+     * Increase this when worker-side execution can complete before the matching
+     * incremental `update` message arrives under heavy load.
+     *
+     * @default 1500
+     */
+    executeSyncTimeoutMs?: number;
+    /**
+     * Inject a pre-built client transport.
+     */
     clientTransport?: Transport<any>;
+    /**
+     * Build a client transport from a Worker or SharedWorker instance.
+     */
     worker?: SharedWorker | Worker;
 }
 type Asyncify<T extends object, D extends true | false> = {
@@ -287,4 +322,4 @@ declare function createBinder<F = (...args: any[]) => any>({ handleState, handle
  */
 declare const wrapStore: <T extends object>(store: Store<T>, getState?: (...args: unknown[]) => T) => StoreReturn<T>;
 
-export { type StoreWithAsyncFunction as AsyncStore, type Asyncify, type ClientStoreOptions, type ISlices, type Middleware, type Slice, type SliceState, type Slices, type Store, type StoreOptions, create, createBinder, wrapStore };
+export { type StoreWithAsyncFunction as AsyncStore, type Asyncify, type ClientStoreOptions, type ISlices, type Middleware, type MiddlewareStore, type PatchTransform, type Slice, type SliceState, type Slices, type Store, type StoreOptions, type StoreTraceEvent, create, createBinder, wrapStore };