react-hooks-global-states 1.0.7 → 2.0.0

package/lib/src/GlobalStore.types.d.ts

@@ -26,7 +26,7 @@ setter: TState | ((state: TState) => TState),
  * The hook to use the global state
  * @returns {[State, StateSetter<TState>, TMetadata]} result - the state, the setter and the metadata
  */
-export type StateHook<TState, TSetter, TMetadata> = <State = TState>(selector?: (state: TState) => State, config?: UseHookConfig<State>) => [state: State, setter: TSetter, metadata: TMetadata];
+export type StateHook<TState, TSetter, TMetadata> = <State = TState>(selector?: (state: TState) => State, config?: UseHookConfig<State>) => [state: State, stateMutator: TSetter, metadata: TMetadata];
 /**
  * @description
  * Type that prevent ts issues with merging never with other types
@@ -113,7 +113,7 @@ export interface ActionCollectionConfig<TState, TMetadata = null> {
  * whatever data manipulation of the state should be executed through the custom actions with as access to the state and metadata
  * @template {TState} TState - The state type
  * @template {TMetadata} TMetadata - The metadata type
- * @template {TStateSetter} TStateSetter - The storeActionsConfig type (optional) - if you pass an storeActionsConfig the hook will return an object with the actions
+ * @template {TStateMutator} TStateMutator - The storeActionsConfig type (optional) - if you pass an storeActionsConfig the hook will return an object with the actions
  *
  * @example
  *
@@ -133,8 +133,8 @@ export interface ActionCollectionConfig<TState, TMetadata = null> {
  *
  * console.log(state); // 0
  */
-export type ActionCollectionResult<TState, TMetadata, TStateSetter extends ActionCollectionConfig<TState, TMetadata> | StateSetter<TState> = StateSetter<TState>> = TStateSetter extends ActionCollectionConfig<TState, TMetadata> ? {
-    [key in keyof TStateSetter]: (...params: Parameters<TStateSetter[key]>) => ReturnType<ReturnType<TStateSetter[key]>>;
+export type ActionCollectionResult<TState, TMetadata, TStateMutator extends ActionCollectionConfig<TState, TMetadata> | StateSetter<TState> = StateSetter<TState>> = TStateMutator extends ActionCollectionConfig<TState, TMetadata> ? {
+    [key in keyof TStateMutator]: (...params: Parameters<TStateMutator[key]>) => ReturnType<ReturnType<TStateMutator[key]>>;
 } : null;
 /**
  * Common parameters of the store configuration callback functions
@@ -145,19 +145,19 @@ export type ActionCollectionResult<TState, TMetadata, TStateSetter extends Actio
  * @param {ActionCollectionResult<TState, ActionCollectionConfig<TState, TMetadata>> | null} actions - the actions object returned by the hook when you pass an storeActionsConfig configuration otherwise null
  * @template {TState} TState - The state type
  * @template {TMetadata} TMetadata - The metadata type
- * @template {TStateSetter} TStateSetter - The storeActionsConfig type (optional) - if you pass an storeActionsConfig the hook will return an object with the actions
- * @template {ActionCollectionResult<TState, TStateSetter>} TStateSetter - the result of the API (optional) - if you don't pass an API as a parameter, you can pass null
+ * @template {TStateMutator} TStateMutator - The storeActionsConfig type (optional) - if you pass an storeActionsConfig the hook will return an object with the actions
+ * @template {ActionCollectionResult<TState, TStateMutator>} TStateMutator - the result of the API (optional) - if you don't pass an API as a parameter, you can pass null
  * */
-export type StateConfigCallbackParam<TState = any, TMetadata = null, TStateSetter extends ActionCollectionConfig<TState, TMetadata> | StateSetter<TState> = StateSetter<TState>> = {
-    actions: ActionCollectionResult<TState, TMetadata, TStateSetter>;
+export type StateConfigCallbackParam<TState = any, TMetadata = null, TStateMutator extends ActionCollectionConfig<TState, TMetadata> | StateSetter<TState> = StateSetter<TState>> = {
+    actions: ActionCollectionResult<TState, TMetadata, TStateMutator>;
 } & StoreTools<TState, TMetadata>;
 /**
  * Parameters of the onStateChanged callback function
  * @template {TState} TState - The state type
  * @template {TMetadata} TMetadata - The metadata type
- * @template {TStateSetter} TStateSetter - The storeActionsConfig type (optional) - if you pass an storeActionsConfig the hook will return an object with the actions
+ * @template {TStateMutator} TStateMutator - The storeActionsConfig type (optional) - if you pass an storeActionsConfig the hook will return an object with the actions
  */
-export type StateChangesParam<TState = any, TMetadata = null, TStateSetter extends ActionCollectionConfig<TState, TMetadata> | StateSetter<TState> = StateSetter<TState>> = StateConfigCallbackParam<TState, TMetadata, TStateSetter> & StateChanges<TState>;
+export type StateChangesParam<TState = any, TMetadata = null, TStateMutator extends ActionCollectionConfig<TState, TMetadata> | StateSetter<TState> = StateSetter<TState>> = StateConfigCallbackParam<TState, TMetadata, TStateMutator> & StateChanges<TState>;
 /**
  * Configuration of the store (optional) - if you don't need to use the store configuration you don't need to pass this parameter
  * @param {StateConfigCallbackParam<TState, TMetadata> => void} onInit - callback function called when the store is initialized
@@ -166,9 +166,9 @@ export type StateChangesParam<TState = any, TMetadata = null, TStateSetter exten
  * @param {StateChangesParam<TState, TMetadata> => void} onStateChanged - callback function called every time the state is changed
  * @template TState - the type of the state
  * @template TMetadata - the type of the metadata (optional) - if you don't pass an metadata as a parameter, you can pass null
- * @template {ActionCollectionConfig<TState,TMetadata> | null} TStateSetter - the configuration of the API (optional) - if you don't pass an API as a parameter, you can pass null
+ * @template {ActionCollectionConfig<TState,TMetadata> | null} TStateMutator - the configuration of the API (optional) - if you don't pass an API as a parameter, you can pass null
  * */
-export type GlobalStoreConfig<TState, TMetadata, TStateSetter extends ActionCollectionConfig<TState, TMetadata> | StateSetter<TState> = StateSetter<TState>> = {
+export type GlobalStoreConfig<TState, TMetadata, TStateMutator extends ActionCollectionConfig<TState, TMetadata> | StateSetter<TState> = StateSetter<TState>> = {
     /**
      * @param {StateConfigCallbackParam<TState, TMetadata> => void} metadata - the initial value of the metadata
      * */
@@ -177,22 +177,22 @@ export type GlobalStoreConfig<TState, TMetadata, TStateSetter extends ActionColl
      * @param {StateConfigCallbackParam<TState, TMetadata> => void} onInit - callback function called when the store is initialized
      * @returns {void} result - void
      * */
-    onInit?: (parameters: StateConfigCallbackParam<TState, TMetadata, TStateSetter>) => void;
+    onInit?: (parameters: StateConfigCallbackParam<TState, TMetadata, TStateMutator>) => void;
     /**
      * @param {StateChangesParam<TState, TMetadata> => void} onStateChanged - callback function called every time the state is changed
      * @returns {void} result - void
      */
-    onStateChanged?: (parameters: StateChangesParam<TState, TMetadata, TStateSetter>) => void;
+    onStateChanged?: (parameters: StateChangesParam<TState, TMetadata, TStateMutator>) => void;
     /**
      * @param {StateConfigCallbackParam<TState, TMetadata> => void} onSubscribed - callback function called every time a component is subscribed to the store
      * @returns {void} result - void
      */
-    onSubscribed?: (parameters: StateConfigCallbackParam<TState, TMetadata, TStateSetter>) => void;
+    onSubscribed?: (parameters: StateConfigCallbackParam<TState, TMetadata, TStateMutator>) => void;
     /**
      * @param {StateChangesParam<TState, TMetadata> => boolean} computePreventStateChange - callback function called every time the state is about to change and it allows you to prevent the state change
      * @returns {boolean} result - true if you want to prevent the state change, false otherwise
      */
-    computePreventStateChange?: (parameters: StateChangesParam<TState, TMetadata, TStateSetter>) => boolean;
+    computePreventStateChange?: (parameters: StateChangesParam<TState, TMetadata, TStateMutator>) => boolean;
 } | null;
 export type UseHookConfig<TState> = {
     /**
@@ -200,6 +200,8 @@ export type UseHookConfig<TState> = {
      * If the function is not provided the derived state will perform a shallow comparison
      */
     isEqual?: (current: TState, next: TState) => boolean;
+    isEqualRoot?: (current: any, next: any) => boolean;
+    dependencies?: unknown[];
 };
 /**
  * Callback function to unsubscribe from the store
@@ -261,7 +263,7 @@ export type CustomGlobalHookBuilderParams<TInheritMetadata = null, TCustomConfig
      * @description
      * This function is called when the state is changed.
      */
-    onChange: ({ setState, setMetadata, getMetadata, getState, actions, }: StateChangesParam<any, TInheritMetadata>, config: TCustomConfig) => void;
+    onChange: ({ setState, setMetadata, getMetadata, getState, actions }: StateChangesParam<any, TInheritMetadata>, config: TCustomConfig) => void;
 };
 /**
  * @description

package/lib/src/GlobalStoreAbstract.d.ts

@@ -1,15 +1,15 @@
-import { StateSetter, StateConfigCallbackParam, StateChangesParam, ActionCollectionConfig, GlobalStoreConfig } from "./GlobalStore.types";
-import { GlobalStore } from "./GlobalStore";
+import { StateSetter, StateConfigCallbackParam, StateChangesParam, ActionCollectionConfig, GlobalStoreConfig } from './GlobalStore.types';
+import { GlobalStore } from './GlobalStore';
 /**
  * @description
  * Use this class to extends the capabilities of the GlobalStore.
  * by implementing the abstract methods onInitialize and onChange.
  * You can use this class to create a store with async storage.
  */
-export declare abstract class GlobalStoreAbstract<TState, TMetadata = null, TStateSetter extends ActionCollectionConfig<TState, TMetadata> | StateSetter<TState> = StateSetter<TState>> extends GlobalStore<TState, TMetadata, TStateSetter> {
-    constructor(state: TState, config?: GlobalStoreConfig<TState, TMetadata, TStateSetter>, actionsConfig?: TStateSetter | null);
-    protected onInit: (parameters: StateConfigCallbackParam<TState, TMetadata, TStateSetter>) => void;
-    protected onStateChanged: (parameters: StateChangesParam<TState, TMetadata, TStateSetter>) => void;
-    protected abstract onInitialize: ({ setState, setMetadata, getMetadata, getState, actions, }: StateConfigCallbackParam<TState, TMetadata, TStateSetter>) => void;
-    protected abstract onChange: ({ setState, setMetadata, getMetadata, getState, actions, }: StateChangesParam<TState, TMetadata, TStateSetter>) => void;
+export declare abstract class GlobalStoreAbstract<TState, TMetadata = null, TStateMutator extends ActionCollectionConfig<TState, TMetadata> | StateSetter<TState> = StateSetter<TState>> extends GlobalStore<TState, TMetadata, TStateMutator> {
+    constructor(state: TState, config?: GlobalStoreConfig<TState, TMetadata, TStateMutator>, actionsConfig?: TStateMutator | null);
+    protected onInit: (parameters: StateConfigCallbackParam<TState, TMetadata, TStateMutator>) => void;
+    protected onStateChanged: (parameters: StateChangesParam<TState, TMetadata, TStateMutator>) => void;
+    protected abstract onInitialize: ({ setState, setMetadata, getMetadata, getState, actions, }: StateConfigCallbackParam<TState, TMetadata, TStateMutator>) => void;
+    protected abstract onChange: ({ setState, setMetadata, getMetadata, getState, actions, }: StateChangesParam<TState, TMetadata, TStateMutator>) => void;
 }

package/package.json

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

package/lib/bundle.js.LICENSE.txt

@@ -1 +0,0 @@
-/*! regenerator-runtime -- Copyright (c) 2014-present, Facebook, Inc. -- license (MIT): https://github.com/facebook/regenerator/blob/main/LICENSE */