react-hooks-global-states 15.0.4 → 15.0.6

package/createContext.d.ts

@@ -1,6 +1,7 @@
 import React, { type PropsWithChildren, Context as ReactContext } from 'react';
 import { GlobalStore } from './GlobalStore';
 import type { BaseMetadata, GlobalStoreCallbacks as GlobalStoreCallbacksBase, UseHookOptions, AnyFunction, StoreTools, ReadonlyStateApi, SelectHook, ObservableFragment, StateApi, UnsubscribeCallback } from './types';
+import { AnyActions } from 'createGlobalState';
 type GlobalStoreContextCallbacks<State, StateMutator, Metadata extends BaseMetadata> = {
     /**
      * @description Optional callback invoked after the context is created,
@@ -405,7 +406,7 @@ interface CreateContext {
     args: {
         name?: string;
         metadata?: Metadata | (() => Metadata);
-        callbacks?: GlobalStoreCallbacks<State, StateMutator, Metadata>;
+        callbacks?: GlobalStoreCallbacks<State, AnyActions, Metadata>;
         actions?: ActionsConfig;
     }): {
         /**
@@ -469,7 +470,7 @@ interface CreateContext {
      * - **`Context`** — The raw React `Context` object for advanced usage, such as integration with
      *   external tools or non-React consumers.
      */
-    <State, Metadata extends BaseMetadata, ActionsConfig extends ContextActionCollectionConfig<State, Metadata>, StateMutator = React.Dispatch<React.SetStateAction<State>>>(
+    <State, Metadata extends BaseMetadata, ActionsConfig extends ContextActionCollectionConfig<State, Metadata>>(
     /**
      * @description Initial state value or initializer function.
      */
@@ -484,7 +485,7 @@ interface CreateContext {
     args: {
         name?: string;
         metadata?: Metadata | (() => Metadata);
-        callbacks?: GlobalStoreCallbacks<State, StateMutator, Metadata>;
+        callbacks?: GlobalStoreCallbacks<State, AnyActions, Metadata>;
         actions: ActionsConfig;
     }): {
         /**

package/createGlobalState.d.ts

@@ -1,4 +1,28 @@
 import type { ActionCollectionConfig, ActionCollectionResult, StateHook, BaseMetadata, GlobalStoreCallbacks, StoreTools } from './types';
+/**
+ * Typescript is unable to infer the actions type correctly for the lifecycle callbacks
+ * so we use a generic AnyActions type here to bypass that limitation.
+ *
+ * The parameter could still be typed before using it with
+ * ```ts
+ * type StoreTools = InferStateApi<typeof <hook>>;
+ *
+ * onInit: (tools) => {
+ *   const storeTools = tools as StoreTools;
+ *   // ...
+ * }
+ *
+ * or when dealing with context:
+ *
+ * type ContextApi = InferContextApi<typeof <context>>;
+ *
+ * onInit: (tools) => {
+ *   const storeTools = tools as ContextApi;
+ *   // ...
+ * }
+ * ```
+ */
+export type AnyActions = Record<string, (...args: any[]) => any>;
 interface CreateGlobalState {
     /**
      * Creates a global state hook.
@@ -89,7 +113,7 @@ interface CreateGlobalState {
     <State, Metadata extends BaseMetadata, ActionsConfig extends ActionCollectionConfig<State, Metadata> | null | {}, PublicStateMutator = keyof ActionsConfig extends never | undefined ? React.Dispatch<React.SetStateAction<State>> : ActionCollectionResult<State, Metadata, NonNullable<ActionsConfig>>>(state: State, args: {
         name?: string;
         metadata?: Metadata;
-        callbacks?: GlobalStoreCallbacks<State, PublicStateMutator, Metadata>;
+        callbacks?: GlobalStoreCallbacks<State, AnyActions, Metadata>;
         actions?: ActionsConfig;
     }): StateHook<State, PublicStateMutator, Metadata>;
     /**
@@ -144,7 +168,7 @@ interface CreateGlobalState {
     <State, Metadata extends BaseMetadata, ActionsConfig extends ActionCollectionConfig<State, Metadata>, PublicStateMutator = ActionCollectionResult<State, Metadata, NonNullable<ActionsConfig>>>(state: State, args: {
         name?: string;
         metadata?: Metadata;
-        callbacks?: GlobalStoreCallbacks<State, PublicStateMutator, Metadata>;
+        callbacks?: GlobalStoreCallbacks<State, AnyActions, Metadata>;
         actions: ActionsConfig;
     }): StateHook<State, PublicStateMutator, Metadata>;
 }

package/index.d.ts

@@ -1,6 +1,6 @@
 export type { StateApi, ObservableFragment, MetadataSetter, StateChanges, StoreTools, ActionCollectionResult, GlobalStoreCallbacks, UseHookOptions, UnsubscribeCallback, SubscribeCallbackConfig, SubscribeCallback, BaseMetadata, MetadataGetter, SelectorCallback, SubscriberParameters, SubscriptionCallback, StateHook, ActionCollectionConfig, } from './types';
 export { GlobalStore } from './GlobalStore';
-export { createGlobalState, type InferActionsType, type InferStateApi } from './createGlobalState';
+export { createGlobalState, type InferActionsType, type InferStateApi, AnyActions, } from './createGlobalState';
 export { shallowCompare } from './shallowCompare';
 export { uniqueId, type BrandedId } from './uniqueId';
 export { throwWrongKeyOnActionCollectionConfig } from './throwWrongKeyOnActionCollectionConfig';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "react-hooks-global-states",
-  "version": "15.0.4",
+  "version": "15.0.6",
   "description": "This is a package to easily handling global-state across your react-components using hooks.",
   "main": "./bundle.js",
   "types": "./index.d.ts",

package/types.d.ts

@@ -180,7 +180,7 @@ export type StateChanges<State> = {
  **/
 export type StoreTools<State, StateMutator = React.Dispatch<React.SetStateAction<State>>, Metadata extends BaseMetadata = BaseMetadata> = {
     /**
-     * The actions available for the global state
+     * The actions available for the global state if provided
      */
     actions: StateMutator extends AnyFunction ? null : StateMutator;
     /**