react-native-global-state-hooks 2.0.1 → 2.0.3

package/README.advance.md

@@ -1,61 +1,105 @@
-
-## Customize persist storage
-
-Let suppose you don't like **async-storage** or you also want to implement some kind of encrypt-process. You could easily extend the **GlobalStore** Class, and customize your persist store implementation. 
-
 ## Creating hooks with reusable actions
 
-Let's say you want to have a STATE with a specific set of actions that you could be reused. With this library is pretty easy to accomplish. Let's create **increase** and **decrease** actions to our COUNT-store. **useCountGlobal.ts**:
+Let's say you want to have a STATE with a specific set of actions that you could be reused. With this library is pretty easy to accomplish. Let's create **increase** and **decrease** actions to our count-store. **useCountGlobal.ts**:
 
 ```JSX
-import * as IGlobalState from 'react-native-global-state-hooks/lib/GlobalStoreTypes';
-import GlobalStore from 'react-native-global-state-hooks';
+import {
+  IActionCollectionConfig,
+  IActionCollectionResult,
+  StateSetter,
+} from 'react-native-global-state-hooks/lib/GlobalStoreTypes';
+
+/**
+ * When using a custom api, the getHook and getHookDecoupled will not longer return directly the setter,
+ * intead they will return and api with the specific actions and mutations defined for the store
+ * Creating a configuration object for our api
+ */
+const countActionsApi: IActionCollectionConfig<number> = {
+  /* Decrease the value of the count */
+  decrease(decrease: number) {
+    /**
+     * We need to return the async function that is gonna take care of the state mutation or actions
+     */
+    return async (setter: StateSetter<number>, state: number) => {
+      /**
+       * Next, we perfom whatever modification we want on top of the store
+       */
+      return setter(state - decrease);
+    };
+  },
 
-export interface ICountActionsConfig extends IGlobalState.IActionCollectionConfig<number> {
-  decrease: (decrease: number) => (setter: IGlobalState.StateSetter<number>, state: number) => Promise<void>,
-  increase: (increase: number) => (setter: IGlobalState.StateSetter<number>, state: number) => Promise<void>,
-}
+  //* Lets add a new action to increase the value of the count */
+  increase(increase: number) {
 
-export interface ICountActions extends IGlobalState.IActionCollectionResult {
-  decrease: (decrease: number) => Promise<void>,
-  increase: (increase: number) => Promise<void>,
-}
+    return async (setter: StateSetter<number>, state: number) => {
+      return setter(state + increase);
+    };
+  },
+};
+
+/**
+ *  Now our getHook and getHookDecoupled are gonna return our custom api instead of the StateSetter,
+ *  This will allow us to have more control over our store since the mutations of the same are gonna be limitated 
+*/
+const countStore = new GlobalStore(0, countActionsApi);
+```
 
-const countActions: IActionCollectionConfig<number> = {
-  decrease: (decrease: number) => async (setter: IGlobalState.StateSetter<number>, state: number) => {
-    setter(state - decrease);
+If we remove all the explanatory comments the code will look like this:
+
+```TS
+const countStore = new GlobalStore(0, {
+  decrease(decrease: number) {
+    return (setter: StateSetter<number>, state: number) =>
+      setter(state - decrease);
   },
-  increase: (increase: number) => async (setter: IGlobalState.StateSetter<number>, state: number) => {
-    setter(state + increase);
+
+  increase(increase: number) {
+    return (setter: StateSetter<number>, state: number) =>
+      setter(state + increase);
   },
-};
+} as IActionCollectionConfig<number>);
+```
 
-const countStore = new GlobalStore(0, countActions);
+Now lets get our new global hook with specific API
 
-export const useCountGlobal = countStore.getHook<ICountActions>();
+```TS
+export interface ICountActions
+  extends IActionCollectionResult<number, IActionCollectionConfig<number>> {
+  decrease: (decrease: number) => Promise<number>;
+  increase: (increase: number) => Promise<number>;
+}
 
+/**
+ * The ICountActions interface is optional but it allow you yo get more accurate results for the typescript autocompletes and validations, ignore this if you are not using TS
+ */
+export const useCountGlobal = countStore.getHook<ICountActions>();
 ```
 
-Now the result of our useCountGlobal will return our actions instead of a simple setter... Let's see:
+And that's it! the result of our useCountGlobal will return our actions instead of a simple setter... Let's see how that will look:
 
 ```JSX
 import { useCountGlobal } from './useCountGlobal'
 
-function Stage1() {
-  const [count, actions] = useCountGlobal();
+const MyComponent: Reac.FC = () => {
+  const [count, countActions] = useCountGlobal();
 
-  const increaseClick = () => actions.increase(1);
-  const decreaseClick = () => actions.decrease(1);
+  // this functions are strongly typed 
+  const increaseClick = () => countActions.increase(1);
+  const decreaseClick = () => countActions.decrease(1);
 
   return (<>
-      <label>{count}<label/><br/>
-      <button onPress={increaseClick}>increase<button/>
-      <button onPress={decreaseClick}>decrease<button/>
+      <Text>{count}<Text/>
+      <Button onPress={increaseClick} title={'increase'} />
+      <Button onPress={decreaseClick} title={'decrease'} />
     </>);
 }
 
 ```
 
+## Customize persist storage
+
+Let suppose you don't like **async-storage** or you also want to implement some kind of encrypt-process. You could easily extend the **GlobalStore** Class, and customize your persist store implementation. 
+
 ```JSX
 import GlobalState from 'react-native-global-state-hooks';
 import secureStorage from 'react-native-secure-storage';
@@ -70,6 +114,7 @@ export class SecureGlobalState<
 
   protected asyncStorageGetItem = () => secureStorage.getItem(this.persistStoreAs as string, config);
 
+  /** value is a json string*/
   protected asyncStorageSetItem = (value: string) => secureStorage.setItem(this.persistStoreAs as string, value, config);
   
 }

package/README.md

@@ -1,7 +1,7 @@
 # react-native-global-state-hooks
-This is a package to easily handling global-state across your react-native-components **No-redux**.
+This is a package to easily handling global-state across your react-native-components **No-redux**, **No-context**
 
-This utility follows the same style as the default **useState** hook, this in order to be intuitive and easy to use
+This utility follows the same style as the default **useState** hook, with a subscription pattern and **HOFs** to create a more intuitive, atomic and easy way of sharing state between components
 
 **after version 1.0.4, we migrated to @react-native-async-storage/async-storage, because @react-native-async-storage/async-storage has been deprecated!!**
 
@@ -10,104 +10,132 @@ This utility follows the same style as the default **useState** hook, this in or
 We are gonna create a global count example **useCountGlobal.ts**:
 
 ```JSX
+// Import the store costructor
 import GlobalStore from 'react-native-global-state-hooks';
 
+// initialize your store with the default value of the same.
 const countStore = new GlobalStore(0);
 
+// you'll use this function the same way you'll use the **useState**
 export const useCountGlobal = countStore.getHook();
+
+// That's it, that's a global store... Strongly typed, with a global-hook that we could reuse cross all our react-components.
 ```
 
-That's it, that's a global store... Strongly typed, with a global-hook that we could reuse cross all our react-components.
+## Implementing your global hook into your components
+Let's say we have two components **MyFirstComponent**, **MySecondComponent**, in order to use our global hook they will look just like: 
 
-## Consuming global hook
-Let's say we have two components **Stage1**, **Stage2**, in order to use our global hook they will look just like: 
 ```JSX
 import { useCountGlobal } from './useCountGlobal'
 
-const Stage1: React.FC = () => {
+const MyFirstComponent: React.FC = () => {
   const [count, setter] = useCountGlobal();
   const onClickAddOne = () => setter(count + 1);
 
-  return (<button onPress={onClickAddOne}>count: {count}<button/>);
+  return (<Button title={`count: ${count}`} onPress={onClickAddOne} />);
 }
 
-const Stage2: React.FC = () => {
+const MySecondComponent: React.FC = () => {
   const [count, setter] = useCountGlobal();
   const onClickAddTwo = () => setter(count + 2);
   
-  return (<button onPress={onClickAddTwo}>count: {count}<button/>);
+  return (<Button title={`count: ${count}`} onPress={onClickAddOne} />);
 }
-```
 
-Just like that! You now are using a global state. 
+// Just like that! You are now using a global state!!
+```
 
 Note that the only difference between this and the default **useState** hook is that you are not adding the initial value, cause you already did that when you created the store:
+
 ```JSX
 const countStore = new GlobalStore(0);
 ```
 
 ## Persisted store
 
-You could persist the state in the **async-storage** by just adding the **key-name** to the constructor of your global-store, for example: 
+You could persist the state with **@react-native-async-storage** by just adding the **storage-key** to the constructor of your global-store, for example: 
+
 ```JSX
 // The FIRST parameter is the initial value of the state
-// The Second parameter is an API to restrict access to the state, will talk about that later.
-// The Third parameter is the key that will use on the async-storage
+// The Second parameter is an API to restrict access to the state, will talk about that later on [README]:./README.advance.md
+// The Third parameter is the key that will be used on the async-storage
 const countStore = new GlobalStore(0, null, 'GLOBAL_COUNT');
 ```
 
 ## Consuming Persisted Store
 
 ```JSX
-const [count, setCount, isCountUpdated] = useCountGlobal();
+const MyComponent: React.FC = () => {
+  // connect the component to the global persisted storage
+  const [count, setCount, isCountReady] = useCountGlobal();
+  const onClickAddOne = () => setCount(count + 1);
+  
+  /**
+   *  since the async storage is ASYNC, the first time the hook is called into a component we may get the default value, instead of the one from the storage.
+   * 
+   *  We are able to validate this with the third value returned in the hook array **isCountReady**, which is a boolean which let us now if the async storage already was reached out.
+  */
+  const countLabel = isCountReady ? `count: ${count}` : 'Loading async storage...';
+
+  return (<Button title={countLabel} onPress={onClickAddOne} />);
+}
 ```
 
-**isCountUpdated**: With the persist storage, the first time the hooks is called the same is gonna return the default value declared in the **new GlobalStore**, at the same time will perform an **async** request to the **async-storage** in order to get the stored value, to validate if that call was already performed, youl'll get an extra boolean value.
-
 ## Decoupled hook
 
+If you want to access the global state outside a component or outside a hook, or without subscribing the component to the state changes... 
+
+This is especially useful when you want to create components that have edition access to a certain store, but they actually don't need to be reactive to the state changes, like a search component that just need to get the current state every time that is going to search the data; but actually don't need to be subscribed to the changes over the collection he is going to be filtering. 
+
+
 ```JSX
 import GlobalStore from 'react-native-global-state-hooks';
 
 const countStore = new GlobalStore(0);
 
+// remember this should be used as the **useState** hook.
 export const useCountGlobal = countStore.getHook();
 
+// this functions are not hooks, and they can be used in whatever place into your code, ClassComponents, OtherHooks, Services etc.
 export const [getCountGlobalValue, setCountGlobalValue] = countStore.getHookDecoupled();
 
 ```
 
-If you want to access the global state outside a component or outside a hook, or without subscribing the component to the state changes... 
-
-This is especially useful when you want to create components that have edition access to a certain store, but they actually don't need to be reactive to the state changes, like a search component that just need to get the current state every time that is going to search the data; but actually don't need to be subscribed to the changes over the collection he is going to be filtering. 
-
-
 Let's see a trivial example: 
+
 ```JSX
 import { useCountGlobal, setCountGlobalValue } from './useCountGlobal'
 
-const Stage1: React.FC = () => {
+const CountDisplayerComponent: React.FC = () => {
   const [count] = useCountGlobal();
 
-  return (<label>{count}<label/><br/>);
+  return (<Text>{count}<Text/>);
 }
 
 // Stage2 does not need to be updated once the global count changes
-const Stage2: React.FC = () => {
+const CountManagerComponent: React.FC = () => {
   const increaseClick = () => setCountGlobalValue(count => count + 1);
   const decreaseClick = () => setCountGlobalValue(count => count - 1);
 
   return (<>
-      <button onPress={increaseClick}>increase<button/>
-      <button onPress={decreaseClick}>decrease<button/>
+      <Button onPress={increaseClick} title={'increase'} />
+      <Button onPress={decreaseClick} title={'decrease'}/>
     </>);
 }
 ```
 
+## Advance Config
+Here you can see more information how to create more complex services for your global stores.
+[README]:./README.advance.md
+
 ## Advantages:
 1. Using REACT's simplest and default way to deal with the state.
-2. This library also is taking care of batching multiple stores updates by using **React unstable_batchedUpdates**; this is a problem that the **useState** have when you call multiple **setStates** into async flows as setTimeout
-3. This tool also take care for you to avoid **async-storage*** data to lose the data types that you stored. For example when you are using datetimes
+2. Adding partial state designations (This is not on useState default functionality)
+3. Added availability to create actions and decoupled access to the states, no more connects, and dispatches, just call your actions as a normal service of whatever other libraries.
+4. This library is already taking care of avoiding re-renders if the new state does not have changes
+5. This tool also take care for you to avoid **async-storage*** data to lose the data types that you stored. For example when you are using datetimes
 
-## Advance Config
-[README]:./README.advance.md
+# Finallly notes:
+Are concern about performance? this library is for you, instead of handling huge complex stores with options like redux, or by passing the setState to a context Provider (because of the limitations that the context has)... You should just use this library, we are using the more atomic and 'native' way that REACT gives to handle the state, and that is the hook **useState**... 
+
+This utility is just including the implementation of the use state into a subscriber pattern, to enable you to create hooks that will be subscribed to specific store changes, does how we'll be creating a global state hook. 

package/lib/GlobalStore.d.ts

@@ -18,20 +18,23 @@ export declare class GlobalStore<IState, IPersist extends string | null = null,
     protected asyncStorageSetItem(valueToStore: string): Promise<void>;
     protected setAsyncStoreItem(): Promise<void>;
     protected getStateCopy: () => IState;
-    getHook: <IApi extends IGlobalStore.ActionCollectionResult<IState, IActions> | null = IActions extends null ? null : IGlobalStore.ActionCollectionResult<IState, IActions>>() => () => [IState, IGlobalStore.IHookResult<IState, IActions, IApi>, IsPersist extends true ? boolean : null];
-    getHookDecoupled: <IApi extends IGlobalStore.ActionCollectionResult<IState, IActions> | null = IActions extends null ? null : IGlobalStore.ActionCollectionResult<IState, IActions>>() => [() => IPersist extends string ? Promise<IState> : IState, IGlobalStore.IHookResult<IState, IActions, IApi>];
+    getHook: <IApi extends IGlobalStore.IActionCollectionResult<IState, IActions> | null = IActions extends null ? null : IGlobalStore.IActionCollectionResult<IState, IActions>>() => () => [IState, IGlobalStore.IHookResult<IState, IActions, IApi>, IsPersist extends true ? boolean : null];
+    getHookDecoupled: <IApi extends IGlobalStore.IActionCollectionResult<IState, IActions> | null = IActions extends null ? null : IGlobalStore.IActionCollectionResult<IState, IActions>>() => [() => IPersist extends string ? Promise<IState> : IState, IGlobalStore.IHookResult<IState, IActions, IApi>];
     private _stateOrchestrator;
-    protected get stateOrchestrator(): IGlobalStore.StateSetter<IState> | IGlobalStore.ActionCollectionResult<IState, IActions>;
+    protected get stateOrchestrator(): IGlobalStore.StateSetter<IState> | IGlobalStore.IActionCollectionResult<IState, IActions>;
     /**
     **  [subscriber-update-callback, hook]
     */
     protected static batchedUpdates: [() => void, object][];
     protected globalSetter: (setter: IState | ((state: IState) => IState), callback: () => void) => void;
-    protected globalSetterAsync: (setter: IState | ((state: IState) => IState)) => Promise<void>;
-    protected globalSetterToPersistStoreAsync: (setter: IState | ((state: IState) => IState)) => Promise<void>;
+    protected globalSetterAsync: (setter: IState | ((state: IState) => IState)) => Promise<IState>;
+    protected globalSetterToPersistStoreAsync: (setter: IState | ((state: IState) => IState)) => Promise<IState>;
     static ExecutePendingBatchesCallbacks: (() => void)[];
+    /**
+     * React native cannot use unstable_batchedUpdates, it does not have any effect
+    */
     static ExecutePendingBatches: import("lodash").DebouncedFunc<() => void>;
-    protected getActions: <IApi extends IGlobalStore.ActionCollectionResult<IState, IGlobalStore.IActionCollectionConfig<IState>>>() => IApi;
+    protected getActions: <IApi extends IGlobalStore.IActionCollectionResult<IState, IGlobalStore.IActionCollectionConfig<IState>>>() => IApi;
 }
 export default GlobalStore;
 //# sourceMappingURL=GlobalStore.d.ts.map

package/lib/GlobalStore.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"GlobalStore.d.ts","sourceRoot":"","sources":["../src/GlobalStore.ts"],"names":[],"mappings":";AAMA,OAAO,KAAK,YAAY,MAAM,oBAAoB,CAAC;AAEnD,eAAO,MAAM,WAAW,0BAAuH,CAAC;AAEhJ,qBAAa,WAAW,CACtB,MAAM,EACN,QAAQ,SAAS,MAAM,GAAG,IAAI,GAAG,IAAI,EACrC,SAAS,SAAS,OAAO,GAAG,QAAQ,SAAS,IAAI,GAAG,KAAK,GAAG,IAAI,EAChE,QAAQ,SAAS,YAAY,CAAC,uBAAuB,CAAC,MAAM,CAAC,GAAG,IAAI,GAAG,IAAI,CAC3E,YAAW,YAAY,CAAC,YAAY,CAAC,MAAM,EAAE,QAAQ,EAAE,SAAS,EAAE,QAAQ,CAAC;IAQ/D,SAAS,CAAC,KAAK,EAAE,MAAM;IAAE,SAAS,CAAC,OAAO,EAAE,QAAQ;IAA4B,cAAc,EAAE,QAAQ;IAN7G,WAAW,EAAE,YAAY,CAAC,WAAW,CAAC,MAAM,CAAC,EAAE,CAAM;IAE5D,IAAW,cAAc,IAAI,OAAO,CAEnC;gBAEqB,KAAK,EAAE,MAAM,EAAY,OAAO,GAAE,QAA2B,EAAS,cAAc,GAAE,QAA2B;IAEvI,OAAO,KAAK,wBAAwB,GAEnC;IAED,OAAO,CAAC,eAAe,CAAiC;IAExD,SAAS,CAAC,mBAAmB,CAAC,CAAC,EAAE,GAAG,EAAE,CAAC,GAAG,OAAO;IA0BjD,SAAS,CAAC,aAAa,CAAC,CAAC,EAAE,GAAG,EAAE,CAAC,GAAG,OAAO;IAmB3C,SAAS,CAAC,wBAAwB,EAAE,OAAO,CAAC,MAAM,CAAC,GAAG,IAAI,CAAQ;IAElE,SAAS,CAAC,mBAAmB,IAAI,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC;cAIvC,iBAAiB,IAAI,OAAO,CAAC,MAAM,CAAC;cAwBpC,mBAAmB,CAAC,YAAY,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;cAIxD,iBAAiB,IAAI,OAAO,CAAC,IAAI,CAAC;IAUlD,SAAS,CAAC,YAAY,QAAO,MAAM,CAAyC;IAErE,OAAO,oRA2BZ;IAEK,gBAAgB,iLAGV,QAAQ,SAAS,MAAM,GAAG,QAAQ,MAAM,CAAC,GAAG,MAAM,oDAO7D;IAEF,OAAO,CAAC,kBAAkB,CAAyG;IAEnI,SAAS,KAAK,iBAAiB,IAAI,YAAY,CAAC,WAAW,CAAC,MAAM,CAAC,GAAG,YAAY,CAAC,sBAAsB,CAAC,MAAM,EAAE,QAAQ,CAAC,CAY1H;IAED;;MAEE;IACF,SAAS,CAAC,MAAM,CAAC,cAAc,EAAE,CAAC,MAAM,IAAI,EAAE,MAAM,CAAC,EAAE,CAAM;IAE7D,SAAS,CAAC,YAAY,6BAA8B,MAAM,KAAK,MAAM,aAAa,MAAM,IAAI,UAqB1F;IAEF,SAAS,CAAC,iBAAiB,6BAAoC,MAAM,KAAK,MAAM,MAC9E,QAAQ,IAAI,CAAC,CAAyE;IAExF,SAAS,CAAC,+BAA+B,6BAAoC,MAAM,KAAK,MAAM,MAAI,QAAQ,IAAI,CAAC,CAG7G;IAEF,MAAM,CAAC,8BAA8B,EAAE,CAAC,MAAM,IAAI,CAAC,EAAE,CAAM;IAI3D,MAAM,CAAC,qBAAqB,6CAWtB;IAEN,SAAS,CAAC,UAAU,qHAyBlB;CAEH;AAED,eAAe,WAAW,CAAC"}
+{"version":3,"file":"GlobalStore.d.ts","sourceRoot":"","sources":["../src/GlobalStore.ts"],"names":[],"mappings":";AAKA,OAAO,KAAK,YAAY,MAAM,oBAAoB,CAAC;AAEnD,eAAO,MAAM,WAAW,0BAAuH,CAAC;AAEhJ,qBAAa,WAAW,CACtB,MAAM,EACN,QAAQ,SAAS,MAAM,GAAG,IAAI,GAAG,IAAI,EACrC,SAAS,SAAS,OAAO,GAAG,QAAQ,SAAS,IAAI,GAAG,KAAK,GAAG,IAAI,EAChE,QAAQ,SAAS,YAAY,CAAC,uBAAuB,CAAC,MAAM,CAAC,GAAG,IAAI,GAAG,IAAI,CAC3E,YAAW,YAAY,CAAC,YAAY,CAAC,MAAM,EAAE,QAAQ,EAAE,SAAS,EAAE,QAAQ,CAAC;IAQ/D,SAAS,CAAC,KAAK,EAAE,MAAM;IAAE,SAAS,CAAC,OAAO,EAAE,QAAQ;IAA4B,cAAc,EAAE,QAAQ;IAN7G,WAAW,EAAE,YAAY,CAAC,WAAW,CAAC,MAAM,CAAC,EAAE,CAAM;IAE5D,IAAW,cAAc,IAAI,OAAO,CAEnC;gBAEqB,KAAK,EAAE,MAAM,EAAY,OAAO,GAAE,QAA2B,EAAS,cAAc,GAAE,QAA2B;IAEvI,OAAO,KAAK,wBAAwB,GAEnC;IAED,OAAO,CAAC,eAAe,CAAiC;IAExD,SAAS,CAAC,mBAAmB,CAAC,CAAC,EAAE,GAAG,EAAE,CAAC,GAAG,OAAO;IA0BjD,SAAS,CAAC,aAAa,CAAC,CAAC,EAAE,GAAG,EAAE,CAAC,GAAG,OAAO;IAmB3C,SAAS,CAAC,wBAAwB,EAAE,OAAO,CAAC,MAAM,CAAC,GAAG,IAAI,CAAQ;IAElE,SAAS,CAAC,mBAAmB,IAAI,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC;cAIvC,iBAAiB,IAAI,OAAO,CAAC,MAAM,CAAC;cAwBpC,mBAAmB,CAAC,YAAY,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;cAIxD,iBAAiB,IAAI,OAAO,CAAC,IAAI,CAAC;IAUlD,SAAS,CAAC,YAAY,QAAO,MAAM,CAAyC;IAErE,OAAO,sRA2BZ;IAEK,gBAAgB,mLAGV,QAAQ,SAAS,MAAM,GAAG,QAAQ,MAAM,CAAC,GAAG,MAAM,oDAO7D;IAEF,OAAO,CAAC,kBAAkB,CAA0G;IAEpI,SAAS,KAAK,iBAAiB,IAAI,YAAY,CAAC,WAAW,CAAC,MAAM,CAAC,GAAG,YAAY,CAAC,uBAAuB,CAAC,MAAM,EAAE,QAAQ,CAAC,CAY3H;IAED;;MAEE;IACF,SAAS,CAAC,MAAM,CAAC,cAAc,EAAE,CAAC,MAAM,IAAI,EAAE,MAAM,CAAC,EAAE,CAAM;IAE7D,SAAS,CAAC,YAAY,6BAA8B,MAAM,KAAK,MAAM,aAAa,MAAM,IAAI,UAqB1F;IAEF,SAAS,CAAC,iBAAiB,6BAAoC,MAAM,KAAK,MAAM,MAC9E,QAAQ,MAAM,CAAC,CAAmF;IAEpG,SAAS,CAAC,+BAA+B,6BAAoC,MAAM,KAAK,MAAM,MAAI,QAAQ,MAAM,CAAC,CAK/G;IAEF,MAAM,CAAC,8BAA8B,EAAE,CAAC,MAAM,IAAI,CAAC,EAAE,CAAM;IAE3D;;MAEE;IACF,MAAM,CAAC,qBAAqB,6CAQtB;IAEN,SAAS,CAAC,UAAU,sHA0BlB;CAEH;AAED,eAAe,WAAW,CAAC"}

package/lib/GlobalStore.js

@@ -5,7 +5,6 @@ const tslib_1 = require("tslib");
 const react_1 = require("react");
 const lodash_1 = require("lodash");
 const async_storage_1 = (0, tslib_1.__importDefault)(require("@react-native-async-storage/async-storage"));
-const react_dom_1 = (0, tslib_1.__importDefault)(require("react-dom"));
 const isPrimitive = (value) => (0, lodash_1.isNil)(value) || (0, lodash_1.isNumber)(value) || (0, lodash_1.isBoolean)(value) || (0, lodash_1.isString)(value) || typeof value === 'symbol';
 exports.isPrimitive = isPrimitive;
 class GlobalStore {
@@ -59,10 +58,11 @@ class GlobalStore {
             GlobalStore.ExecutePendingBatchesCallbacks.push(callback);
             GlobalStore.ExecutePendingBatches();
         };
-        this.globalSetterAsync = (setter) => (0, tslib_1.__awaiter)(this, void 0, void 0, function* () { return new Promise((resolve) => this.globalSetter(setter, () => resolve())); });
+        this.globalSetterAsync = (setter) => (0, tslib_1.__awaiter)(this, void 0, void 0, function* () { return new Promise((resolve) => this.globalSetter(setter, () => resolve(this.state))); });
         this.globalSetterToPersistStoreAsync = (setter) => (0, tslib_1.__awaiter)(this, void 0, void 0, function* () {
             yield this.globalSetterAsync(setter);
             yield this.setAsyncStoreItem();
+            return this.state;
         });
         this.getActions = () => {
             const actions = this.actions;
@@ -173,17 +173,15 @@ exports.GlobalStore = GlobalStore;
 */
 GlobalStore.batchedUpdates = [];
 GlobalStore.ExecutePendingBatchesCallbacks = [];
-// avoid multiples calls to batchedUpdates
-// eslint-disable-next-line @typescript-eslint/no-empty-function
+/**
+ * React native cannot use unstable_batchedUpdates, it does not have any effect
+*/
 GlobalStore.ExecutePendingBatches = (0, lodash_1.debounce)(() => {
-    const reactBatchedUpdates = react_dom_1.default.unstable_batchedUpdates || ((mock) => mock());
-    reactBatchedUpdates(() => {
-        GlobalStore.batchedUpdates.forEach(([execute]) => {
-            execute();
-        });
-        GlobalStore.batchedUpdates = [];
-        GlobalStore.ExecutePendingBatchesCallbacks.forEach((callback) => callback());
-        GlobalStore.ExecutePendingBatchesCallbacks = [];
+    GlobalStore.batchedUpdates.forEach(([execute]) => {
+        execute();
     });
+    GlobalStore.batchedUpdates = [];
+    GlobalStore.ExecutePendingBatchesCallbacks.forEach((callback) => callback());
+    GlobalStore.ExecutePendingBatchesCallbacks = [];
 }, 0);
 exports.default = GlobalStore;

package/lib/GlobalStoreTypes.d.ts

@@ -2,7 +2,7 @@
 * @param {StateSetter<IState>} setter - add a new value to the state
 * @returns {void} result - void
 */
-export declare type StateSetter<IState> = (setter: IState | ((state: IState) => IState)) => void;
+export declare type StateSetter<IState> = (setter: IState | ((state: IState) => IState)) => Promise<IState>;
 /**
 * This is the structure required by the API actions in order to be able to capture action parameters and inject state setter into actions.
 */
@@ -14,21 +14,15 @@ export interface IActionCollectionConfig<IState> {
     [key: string]: IActionConfig<IState>;
 }
 /**
-* This should be the API format of the hook (if you passed an API as a parameter)
-*/
-export interface IActionCollectionResult {
-    [key: string]: (...params: any[]) => Promise<unknown>;
-}
-/**
 * This is the API result of the hook (if you passed an API as a parameter)
 */
-export declare type ActionCollectionResult<IState, IActions extends IActionCollectionConfig<IState> | null> = {
+export declare type IActionCollectionResult<IState, IActions extends IActionCollectionConfig<IState> | null> = {
     [key in keyof IActions]: (...params: any[]) => unknown;
 };
 /**
 * Hook result, if you passed an API as a parameter it will be returned in the second position of the hook invoke.
 */
-export declare type IHookResult<IState, IActions extends IActionCollectionConfig<IState> | null = null, IApi extends ActionCollectionResult<IState, IActions> | null = IActions extends null ? null : ActionCollectionResult<IState, IActions>> = IApi extends null ? StateSetter<IState> : IActions extends IActionCollectionConfig<IState> ? IApi extends ActionCollectionResult<IState, IActions> ? IApi : StateSetter<IState> : StateSetter<IState>;
+export declare type IHookResult<IState, IActions extends IActionCollectionConfig<IState> | null = null, IApi extends IActionCollectionResult<IState, IActions> | null = IActions extends null ? null : IActionCollectionResult<IState, IActions>> = IApi extends null ? StateSetter<IState> : IActions extends IActionCollectionConfig<IState> ? IApi extends IActionCollectionResult<IState, IActions> ? IApi : StateSetter<IState> : StateSetter<IState>;
 /**
 * This is a class to create global-store objects
 * @template IState
@@ -49,7 +43,7 @@ export interface IGlobalState<IState, IPersist extends string | null = null, IsP
     * Returns a global hook that will share information across components by subscribing them to a specific store.
     * @return [currentState, GlobalState.IHookResult<IState, IActions, IApi>, initialStatePersistStorage | null, isUpdatedPersistStorage | null]
     */
-    getHook: <IApi extends IActions extends ActionCollectionResult<IState, IActions> ? ActionCollectionResult<IState, IActions> : null>() => () => [
+    getHook: <IApi extends IActions extends IActionCollectionResult<IState, IActions> ? IActionCollectionResult<IState, IActions> : null>() => () => [
         IState,
         IHookResult<IState, IActions, IApi>,
         IsPersist extends true ? boolean : null
@@ -59,7 +53,7 @@ export interface IGlobalState<IState, IPersist extends string | null = null, IsP
     * THIS IS NOT A REACT-HOOK, so you could use it everywhere example other hooks, and services.
     * @return [currentState, GlobalState.IHookResult<IState, IActions, IApi>]
     */
-    getHookDecoupled: <IApi extends IActions extends ActionCollectionResult<IState, IActions> ? ActionCollectionResult<IState, IActions> : null>() => [
+    getHookDecoupled: <IApi extends IActions extends IActionCollectionResult<IState, IActions> ? IActionCollectionResult<IState, IActions> : null>() => [
         () => IPersist extends string ? Promise<IState> : IState,
         IHookResult<IState, IActions, IApi>
     ];

package/lib/GlobalStoreTypes.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"GlobalStoreTypes.d.ts","sourceRoot":"","sources":["../src/GlobalStoreTypes.ts"],"names":[],"mappings":"AAAA;;;EAGE;AACF,oBAAY,WAAW,CAAC,MAAM,IAAI,CAChC,MAAM,EAAE,MAAM,GAAG,CAAC,CAAC,KAAK,EAAE,MAAM,KAAK,MAAM,CAAC,KACzC,IAAI,CAAC;AAEV;;EAEE;AACF,oBAAY,aAAa,CAAC,MAAM,IAAI,CAElC,GAAG,MAAM,EAAE,GAAG,EAAE,KACb,CAAC,MAAM,EAAE,WAAW,CAAC,MAAM,CAAC,EAAE,YAAY,EAAE,MAAM,KAAK,OAAO,CAAC,OAAO,CAAC,CAAC;AAE7E;;EAEE;AACF,MAAM,WAAW,uBAAuB,CAAC,MAAM;IAC7C,CAAC,GAAG,EAAE,MAAM,GAAG,aAAa,CAAC,MAAM,CAAC,CAAC;CACtC;AAED;;EAEE;AACF,MAAM,WAAW,uBAAuB;IAEtC,CAAC,GAAG,EAAE,MAAM,GAAG,CAAC,GAAG,MAAM,EAAE,GAAG,EAAE,KAAK,OAAO,CAAC,OAAO,CAAC,CAAC;CACvD;AAED;;EAEE;AACF,oBAAY,sBAAsB,CAAC,MAAM,EAAE,QAAQ,SAAS,uBAAuB,CAAC,MAAM,CAAC,GAAG,IAAI,IAAI;KAEnG,GAAG,IAAI,MAAM,QAAQ,GAAG,CAAC,GAAG,MAAM,EAAE,GAAG,EAAE,KAAK,OAAO;CACvD,CAAC;AAEF;;EAEE;AACF,oBAAY,WAAW,CACrB,MAAM,EACN,QAAQ,SAAS,uBAAuB,CAAC,MAAM,CAAC,GAAG,IAAI,GAAG,IAAI,EAC9D,IAAI,SAAS,sBAAsB,CAAC,MAAM,EAAE,QAAQ,CAAC,GAAG,IAAI,GAAG,QAAQ,SAAS,IAAI,GAAG,IAAI,GAAG,sBAAsB,CAAC,MAAM,EAAE,QAAQ,CAAC,IACpI,IAAI,SAAS,IAAI,GACjB,WAAW,CAAC,MAAM,CAAC,GACnB,QAAQ,SAAS,uBAAuB,CAAC,MAAM,CAAC,GAChD,IAAI,SAAS,sBAAsB,CAAC,MAAM,EAAE,QAAQ,CAAC,GACnD,IAAI,GACJ,WAAW,CAAC,MAAM,CAAC,GACrB,WAAW,CAAC,MAAM,CAAC,CAAC;AAExB;;;;;;;;;;;;IAYI;AACJ,MAAM,WAAW,YAAY,CAC3B,MAAM,EACN,QAAQ,SAAS,MAAM,GAAG,IAAI,GAAG,IAAI,EACrC,SAAS,SAAS,OAAO,GAAG,QAAQ,SAAS,IAAI,GAAG,KAAK,GAAG,IAAI,EAChE,QAAQ,SAAS,uBAAuB,CAAC,MAAM,CAAC,GAAG,IAAI,GAAG,IAAI;IAG9D,cAAc,EAAE,QAAQ,CAAC;IAEzB,cAAc,EAAE,OAAO,CAAC;IAExB;;;MAGE;IACF,OAAO,EAAE,CAAC,IAAI,SAAS,QAAQ,SAAS,sBAAsB,CAAC,MAAM,EAAE,QAAQ,CAAC,GAAG,sBAAsB,CAAC,MAAM,EAAE,QAAQ,CAAC,GAAG,IAAI,OAAO,MAAM;QAC7I,MAAM;QACN,WAAW,CAAC,MAAM,EAAE,QAAQ,EAAE,IAAI,CAAC;QACnC,SAAS,SAAS,IAAI,GAAG,OAAO,GAAG,IAAI;KACxC,CAAC;IAEF;;;;MAIE;IACF,gBAAgB,EAAE,CAAC,IAAI,SAAS,QAAQ,SAAS,sBAAsB,CAAC,MAAM,EAAE,QAAQ,CAAC,GAAG,sBAAsB,CAAC,MAAM,EAAE,QAAQ,CAAC,GAAG,IAAI,OAAO;QAChJ,MAAM,QAAQ,SAAS,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,GAAG,MAAM;QACxD,WAAW,CAAC,MAAM,EAAE,QAAQ,EAAE,IAAI,CAAC;KACpC,CAAC;CACH;AAED;;GAEG;AACH,MAAM,WAAW,mBAAmB,CAClC,MAAM,EACN,QAAQ,SAAS,MAAM,GAAG,IAAI,GAAG,IAAI,EACrC,SAAS,SAAS,OAAO,GAAG,QAAQ,SAAS,IAAI,GAAG,KAAK,GAAG,IAAI,EAChE,QAAQ,SAAS,uBAAuB,CAAC,MAAM,CAAC,GAAG,IAAI,GAAG,IAAI,CAC9D,SAAQ,YAAY,CAAC,MAAM,EAAE,QAAQ,EAAE,SAAS,EAAE,QAAQ,CAAC;CAE5D"}
+{"version":3,"file":"GlobalStoreTypes.d.ts","sourceRoot":"","sources":["../src/GlobalStoreTypes.ts"],"names":[],"mappings":"AAAA;;;EAGE;AACF,oBAAY,WAAW,CAAC,MAAM,IAAI,CAChC,MAAM,EAAE,MAAM,GAAG,CAAC,CAAC,KAAK,EAAE,MAAM,KAAK,MAAM,CAAC,KACzC,OAAO,CAAC,MAAM,CAAC,CAAC;AAErB;;EAEE;AACF,oBAAY,aAAa,CAAC,MAAM,IAAI,CAElC,GAAG,MAAM,EAAE,GAAG,EAAE,KACb,CAAC,MAAM,EAAE,WAAW,CAAC,MAAM,CAAC,EAAE,YAAY,EAAE,MAAM,KAAK,OAAO,CAAC,OAAO,CAAC,CAAC;AAE7E;;EAEE;AACF,MAAM,WAAW,uBAAuB,CAAC,MAAM;IAC7C,CAAC,GAAG,EAAE,MAAM,GAAG,aAAa,CAAC,MAAM,CAAC,CAAC;CACtC;AAED;;EAEE;AACF,oBAAY,uBAAuB,CAAC,MAAM,EAAE,QAAQ,SAAS,uBAAuB,CAAC,MAAM,CAAC,GAAG,IAAI,IAAI;KAEpG,GAAG,IAAI,MAAM,QAAQ,GAAG,CAAC,GAAG,MAAM,EAAE,GAAG,EAAE,KAAK,OAAO;CACvD,CAAC;AAEF;;EAEE;AACF,oBAAY,WAAW,CACrB,MAAM,EACN,QAAQ,SAAS,uBAAuB,CAAC,MAAM,CAAC,GAAG,IAAI,GAAG,IAAI,EAC9D,IAAI,SAAS,uBAAuB,CAAC,MAAM,EAAE,QAAQ,CAAC,GAAG,IAAI,GAAG,QAAQ,SAAS,IAAI,GAAG,IAAI,GAAG,uBAAuB,CAAC,MAAM,EAAE,QAAQ,CAAC,IACtI,IAAI,SAAS,IAAI,GACjB,WAAW,CAAC,MAAM,CAAC,GACnB,QAAQ,SAAS,uBAAuB,CAAC,MAAM,CAAC,GAChD,IAAI,SAAS,uBAAuB,CAAC,MAAM,EAAE,QAAQ,CAAC,GACpD,IAAI,GACJ,WAAW,CAAC,MAAM,CAAC,GACrB,WAAW,CAAC,MAAM,CAAC,CAAC;AAExB;;;;;;;;;;;;IAYI;AACJ,MAAM,WAAW,YAAY,CAC3B,MAAM,EACN,QAAQ,SAAS,MAAM,GAAG,IAAI,GAAG,IAAI,EACrC,SAAS,SAAS,OAAO,GAAG,QAAQ,SAAS,IAAI,GAAG,KAAK,GAAG,IAAI,EAChE,QAAQ,SAAS,uBAAuB,CAAC,MAAM,CAAC,GAAG,IAAI,GAAG,IAAI;IAG9D,cAAc,EAAE,QAAQ,CAAC;IAEzB,cAAc,EAAE,OAAO,CAAC;IAExB;;;MAGE;IACF,OAAO,EAAE,CAAC,IAAI,SAAS,QAAQ,SAAS,uBAAuB,CAAC,MAAM,EAAE,QAAQ,CAAC,GAAG,uBAAuB,CAAC,MAAM,EAAE,QAAQ,CAAC,GAAG,IAAI,OAAO,MAAM;QAC/I,MAAM;QACN,WAAW,CAAC,MAAM,EAAE,QAAQ,EAAE,IAAI,CAAC;QACnC,SAAS,SAAS,IAAI,GAAG,OAAO,GAAG,IAAI;KACxC,CAAC;IAEF;;;;MAIE;IACF,gBAAgB,EAAE,CAAC,IAAI,SAAS,QAAQ,SAAS,uBAAuB,CAAC,MAAM,EAAE,QAAQ,CAAC,GAAG,uBAAuB,CAAC,MAAM,EAAE,QAAQ,CAAC,GAAG,IAAI,OAAO;QAClJ,MAAM,QAAQ,SAAS,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,GAAG,MAAM;QACxD,WAAW,CAAC,MAAM,EAAE,QAAQ,EAAE,IAAI,CAAC;KACpC,CAAC;CACH;AAED;;GAEG;AACH,MAAM,WAAW,mBAAmB,CAClC,MAAM,EACN,QAAQ,SAAS,MAAM,GAAG,IAAI,GAAG,IAAI,EACrC,SAAS,SAAS,OAAO,GAAG,QAAQ,SAAS,IAAI,GAAG,KAAK,GAAG,IAAI,EAChE,QAAQ,SAAS,uBAAuB,CAAC,MAAM,CAAC,GAAG,IAAI,GAAG,IAAI,CAC9D,SAAQ,YAAY,CAAC,MAAM,EAAE,QAAQ,EAAE,SAAS,EAAE,QAAQ,CAAC;CAE5D"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "react-native-global-state-hooks",
-  "version": "2.0.1",
+  "version": "2.0.3",
   "description": "This is a package to easily handling global-state across your react-native-components No-redux",
   "main": "lib/GlobalStore.js",
   "files": [
@@ -61,7 +61,6 @@
   "peerDependencies": {
     "@react-native-async-storage/async-storage": "workspace:*",
     "lodash": "workspace:*",
-    "react": "workspace:*",
-    "react-dom": "workspace:*"
+    "react": "workspace:*"
   }
 }