react-native-global-state-hooks 3.0.5 → 3.0.7

package/README.md

@@ -17,22 +17,26 @@ For seen a running example of the hooks, you can check the following link: [reac
 We are gonna create a global count example **useCountGlobal.ts**:
 
 ```ts
-import { GlobalStore } from 'react-native-global-state-hooks';
+import { createGlobalHook } from 'react-native-global-state-hooks';
 
 // initialize your store with the default value of the same.
-const countStore = new GlobalStore(0);
-
-// get the hook
-export const useCountGlobal = countStore.getHook();
+export const useCountGlobal = createGlobalHook(0);
 
 // inside your component just call...
-const [count, setCount] = useCountGlobal(); // no paremeters are needed since this is a global store
+const [count, setCount] = useCountGlobal(); // no parameters are needed since this is a global store
 
 // That's it, that's a global store... Strongly typed, with a global-hook that we could reuse cross all our react-components.
 
 // #### Optionally you are able to use a decoupled hook,
 // #### This function is linked to the store hooks but is not a hook himself.
 
+// we could create the store in this way to get extra capabilities
+const countStore = new GlobalStore(0);
+
+// the useCountGlobal works exactly the same
+export const useCountGlobal = countStore.getHook();
+
+// but now we are also able to get a decoupled hook
 export const [getCount, sendCount] = countStore.getHookDecoupled();
 
 // @example
@@ -109,14 +113,14 @@ Let's see a trivial example:
 ```JSX
 import { useCountGlobal, sendCount } from './useCountGlobal'
 
-const CountDisplayerComponent: React.FC = () => {
+const CountDisplayComponent: React.FC = () => {
   const [count] = useCountGlobal();
 
   return (<Text>{count}<Text/>);
 }
 
 // here we have a separate component that is gonna handle the state of the previous component we created,
-// this new component is not gonna be affected by the changes applied on <CountDisplayerComponent/>
+// this new component is not gonna be affected by the changes applied on <CountDisplayComponent/>
 // Stage2 does not need to be updated once the global count changes
 const CountManagerComponent: React.FC = () => {
   const increaseClick = useCallback(() => sendCount(count => count + 1), []);
@@ -137,13 +141,13 @@ const CountManagerComponent: React.FC = () => {
 
 Implementing extra functionality to extend the capabilities of the GlobalStorage couldn't be easier!!!
 
-Here is an example of how you could create your custom store that for example stores the state into a async-storage persistente...
+Here is an example of how you could create your custom store that for example stores the state into a async-storage persistent...
 
 You could just use this code right as it is by just adding also into your project **@react-native-async-storage** or whatever another async storage library.
 
 ```ts
 import asyncStorage from '@react-native-async-storage/async-storage';
-import { clone, formatFromStore, formatToStore } from 'json-storage-formatter';
+import { formatFromStore, formatToStore } from 'json-storage-formatter';
 
 import {
   GlobalStore as GlobalStoreBase,
@@ -153,120 +157,67 @@ import {
   StateSetter,
 } from 'react-native-global-state-hooks';
 
-/**
- * GlobalStore is an store that could also persist the state in the async storage
- * @template {TState} TState - The state of the store
- * @template {TMetadata} TMetadata - The metadata of the store, it must contain a readonly property called isAsyncStorageReady which cannot be set from outside the store
- * @template {TStateSetter} TStateSetter - The storeActionsConfig of the store
- */
 export class GlobalStore<
   TState,
-  // this restriction is needed to avoid the consumers to set the isAsyncStorageReady property from outside the store,
-  // ... even when the value will be ignored is better to avoid it to avoid confusion
-  TMetadata extends { readonly isAsyncStorageReady?: never } & Record<
-    string,
-    unknown
-  > = {},
-  TStateSetter extends StorageSetter<TState, TMetadata> = StateSetter<TState>
-> extends GlobalStoreBase<TState, StorageMetadata<TMetadata>, TStateSetter> {
-  /**
-   * Config for the async storage
-   * includes the asyncStorageKey and the metadata which will be used to determine if the async storage is ready or not
-   * @template {TState} TState - The state of the store
-   * @template {TMetadata} TMetadata - The metadata of the store
-   * @template {TStateSetter} TStateSetter - The storeActionsConfig of the store
-   **/
-  protected config: StorageConfig<TState, TMetadata, TStateSetter> = {};
-
-  /**
-   * Creates a new instance of the GlobalStore
-   * @param {TState} state - The initial state of the store
-   * @param {GlobalStoreConfig<TState, TMetadata, ActionCollectionConfig<TState, TMetadata> | StateSetter<TState>> & { asyncStorageKey: string; }} config - The config of the store
-   * @param  {GlobalStoreConfig<TState, TMetadata, ActionCollectionConfig<TState, TMetadata> | StateSetter<TState>> & { asyncStorageKey: string; }} config.metadata - The metadata of the store which will be used to determine if the async storage is ready or not, also it could store no reactive data
-   * @param  {GlobalStoreConfig<TState, TMetadata, ActionCollectionConfig<TState, TMetadata> | StateSetter<TState>> & { asyncStorageKey: string; }} config.asyncStorageKey - The key of the async storage
-   * @param  {GlobalStoreConfig<TState, TMetadata, ActionCollectionConfig<TState, TMetadata> | StateSetter<TState>> & { asyncStorageKey: string; }} config.onInit - The callback that will be called once the store is created
-   * @param  {GlobalStoreConfig<TState, TMetadata, ActionCollectionConfig<TState, TMetadata> | StateSetter<TState>> & { asyncStorageKey: string; }} config.onStateChange - The callback that will be called once the state is changed
-   * @param  {GlobalStoreConfig<TState, TMetadata, ActionCollectionConfig<TState, TMetadata> | StateSetter<TState>> & { asyncStorageKey: string; }} config.onSubscribed - The callback that will be called every time a new component is subscribed to the store
-   * @param  {GlobalStoreConfig<TState, TMetadata, ActionCollectionConfig<TState, TMetadata> | StateSetter<TState>> & { asyncStorageKey: string; }} config.computePreventStateChange - The callback that will be called before the state is changed, if it returns true the state will not be changed
-   * @param {TStateSetter} setterConfig - The actions configuration object (optional) (default: null) if not null the store manipulation will be done through the actions
-   */
+  TMetadata extends {
+    asyncStorageKey?: string;
+    isAsyncStorageReady?: boolean;
+  },
+  TStateSetter extends
+    | ActionCollectionConfig<TState, TMetadata>
+    | StateSetter<TState> = StateSetter<TState>
+> extends GlobalStoreAbstract<TState, TMetadata, TStateSetter> {
   constructor(
     state: TState,
-    config: StorageConfig<TState, TMetadata, TStateSetter> | null = null,
+    config: GlobalStoreConfig<TState, TMetadata, TStateSetter> = {},
     setterConfig: TStateSetter | null = null
   ) {
-    const { onInit, asyncStorageKey, ...configParameters } =
-      config ?? ({} as StorageConfig<TState, TMetadata, TStateSetter>);
-
-    super(state, configParameters, setterConfig as TStateSetter);
-
-    // if there is not async storage key this is not a persistent store
-    const isAsyncStorageReady: boolean | null = asyncStorageKey ? false : null;
-
-    this.config = {
-      ...config,
-      metadata: {
-        ...((configParameters.metadata ?? {}) as TMetadata),
-        isAsyncStorageReady,
-      },
-    };
-
-    const hasInitCallbacks = !!(asyncStorageKey || onInit);
-    if (!hasInitCallbacks) return;
+    super(state, config, setterConfig);
 
-    const parameters = this.getConfigCallbackParam({});
-
-    this.onInit(parameters);
-    onInit?.(parameters);
+    this.initialize();
   }
 
-  /**
-   * This method will be called once the store is created after the constructor,
-   * this method is different from the onInit of the config property and it won't be overridden
-   */
-  protected onInit = async ({
+  protected onInitialize = async ({
     setState,
     setMetadata,
     getMetadata,
-  }: StateConfigCallbackParam<
-    TState,
-    StorageMetadata<TMetadata>,
-    NonNullable<TStateSetter>
-  >) => {
-    const { asyncStorageKey } = this.config;
+    getState,
+  }: StateConfigCallbackParam<TState, TMetadata, TStateSetter>) => {
+    const metadata = getMetadata();
+    const { asyncStorageKey } = metadata;
+
     if (!asyncStorageKey) return;
 
     const storedItem = (await asyncStorage.getItem(asyncStorageKey)) as string;
-
     setMetadata({
-      ...getMetadata(),
+      ...metadata,
       isAsyncStorageReady: true,
     });
 
     if (storedItem === null) {
-      const state = clone(this.state);
+      const state = getState();
 
-      // this forces the react to re-render the component when the state is an object
-      return setState(state);
+      // force the re-render of the subscribed components even if the state is the same
+      return setState(state, { forceUpdate: true });
     }
 
-    const jsonParsed = JSON.parse(storedItem);
-    const items = formatFromStore<TState>(jsonParsed);
+    const items = formatFromStore<TState>(storedItem, {
+      jsonParse: true,
+    });
 
-    setState(items);
+    setState(items, { forceUpdate: true });
   };
 
-  protected onStateChanged = ({
+  protected onChange = ({
+    getMetadata,
     getState,
-  }: StateChangesParam<
-    TState,
-    StorageMetadata<TMetadata>,
-    NonNullable<TStateSetter>
-  >) => {
-    const { asyncStorageKey } = this.config;
+  }: StateChangesParam<TState, TMetadata, NonNullable<TStateSetter>>) => {
+    const { asyncStorageKey } = getMetadata();
+
     if (!asyncStorageKey) return;
 
     const state = getState();
+
     const formattedObject = formatToStore(state, {
       stringify: true,
     });
@@ -274,76 +225,6 @@ export class GlobalStore<
     asyncStorage.setItem(asyncStorageKey, formattedObject);
   };
 }
-
-/**
- * Metadata of the store
- * @template {TMetadata} TMetadata - The metadata type which also contains the isAsyncStorageReady property
- */
-type StorageMetadata<TMetadata> = Omit<TMetadata, 'isAsyncStorageReady'> & {
-  readonly isAsyncStorageReady?: boolean | null;
-};
-
-/**
- * The setter of the store
- * @template {TState} TState - The state of the store
- * @template {TMetadata} TMetadata - The metadata of the store, it must contain a readonly property called isAsyncStorageReady which cannot be set from outside the store
- * */
-type StorageSetter<TState, TMetadata> =
-  | ActionCollectionConfig<TState, StorageMetadata<TMetadata>>
-  | StateSetter<TState>
-  | null;
-
-/**
- * Config for the async storage
- * includes the asyncStorageKey
- * @template {TState} TState - The state of the store
- * @template {TMetadata} TMetadata - The metadata of the store, it must contain a readonly property called isAsyncStorageReady which cannot be set from outside the store
- * @template {TStateSetter} TStateSetter - The storeActionsConfig of the store
- */
-type StorageConfig<
-  TState,
-  TMetadata extends { readonly isAsyncStorageReady?: never },
-  TStateSetter extends
-    | ActionCollectionConfig<TState, StorageMetadata<TMetadata>>
-    | StateSetter<TState>
-    | null = StateSetter<TState>
-> = {
-  asyncStorageKey?: string;
-
-  metadata?: TMetadata;
-
-  onInit?: (
-    parameters: StateConfigCallbackParam<
-      TState,
-      StorageMetadata<TMetadata>,
-      NonNullable<TStateSetter>
-    >
-  ) => void;
-
-  onStateChanged?: (
-    parameters: StateChangesParam<
-      TState,
-      StorageMetadata<TMetadata>,
-      NonNullable<TStateSetter>
-    >
-  ) => void;
-
-  onSubscribed?: (
-    parameters: StateConfigCallbackParam<
-      TState,
-      StorageMetadata<TMetadata>,
-      NonNullable<TStateSetter>
-    >
-  ) => void;
-
-  computePreventStateChange?: (
-    parameters: StateChangesParam<
-      TState,
-      StorageMetadata<TMetadata>,
-      NonNullable<TStateSetter>
-    >
-  ) => boolean;
-};
 ```
 
 The methods **formatToStore** and **formatFromStore** are part of another library of my [json-storage-formatter](https://www.npmjs.com/package/json-storage-formatter)...
@@ -362,7 +243,7 @@ const [count, setCount, { isAsyncStorageReady }] = useCountGlobal();
 
 Originally the library was implementing persistent storage by using the package **@react-native-async-storage**, but not all people want to use it or need to use it... so it has been removed. Feel free to use the above example to get back that functionality if you were using the previous versions of the package.
 
-You could find this example on the [**GitHub** of the project](https://github.com/johnny-quesada-developer/json-storage-formatter), between the unit test sources when the case scenario was tested [GlobalStoreAsyc.ts](https://github.com/johnny-quesada-developer/react-native-global-state-hooks/blob/master/%40tests/__test__/GlobalStoreAsyc.ts)
+You could find this example on the [**GitHub** of the project](https://github.com/johnny-quesada-developer/json-storage-formatter), between the unit test sources when the case scenario was tested [GlobalStoreAsync.ts](https://github.com/johnny-quesada-developer/react-native-global-state-hooks/blob/master/%40tests/__test__/GlobalStoreAsyc.ts)
 
 ...
 
@@ -380,7 +261,7 @@ const initialValue = 0;
 
 const config = {
   // this is not reactive information that you could also store in the async storage
-  // upating the metadata will not trigger the onStateChanged method or any update on the components
+  // updating the metadata will not trigger the onStateChanged method or any update on the components
   metadata: null,
 
   // The lifecycle callbacks are: onInit, onStateChanged, onSubscribed and computePreventStateChange
@@ -756,7 +637,7 @@ const App = () => {
   return (
     <UserProvider>
       <CountProvider>
-        {/* lets create two componets instead of one */}
+        {/* lets create two components instead of one */}
         <ComponentSetter />
         <Component />
       </CountProvider>
@@ -895,14 +776,14 @@ There is also a third element in the tuple which is a function for getting the m
 ```tsx
 const [, , getMetadata] = new GlobalStore(0, {
   metadata: {
-    isStoredSyncronized: false,
+    isStoredSynchronized: false,
   },
 }).getHookDecoupled();
 
-console.log(getMetadata().isStoredSyncronized); // false
+console.log(getMetadata().isStoredSynchronized); // false
 ```
 
-The setMetadata is part of the store tools, so it can be used in the actions, but againg the metadata is not reactive!! so it will not trigger a re-render on the subscribers
+The setMetadata is part of the store tools, so it can be used in the actions, but again the metadata is not reactive!! so it will not trigger a re-render on the subscribers
 
 ...
 

package/lib/GlobalStore.d.ts

@@ -1,5 +1,5 @@
 import { Dispatch, SetStateAction } from 'react';
-import { ActionCollectionConfig, StateSetter, GlobalStoreConfig, ActionCollectionResult, StateConfigCallbackParam } from './GlobalStore.types';
+import { ActionCollectionConfig, StateSetter, GlobalStoreConfig, ActionCollectionResult, StateConfigCallbackParam, StateChangesParam } from './GlobalStore.types';
 /**
  * The GlobalStore class is the main class of the library and it is used to create a GlobalStore instances
  * @template {TState} TState - The type of the state object
@@ -7,13 +7,14 @@ import { ActionCollectionConfig, StateSetter, GlobalStoreConfig, ActionCollectio
  * @template {TStateSetter} TStateSetter - The type of the setterConfig object (optional) (default: null) if a configuration is passed, the hook will return an object with the actions then all the store manipulation will be done through the actions
  * */
 export declare class GlobalStore<TState, TMetadata = null, TStateSetter extends ActionCollectionConfig<TState, TMetadata> | StateSetter<TState> | null = StateSetter<TState>> {
-    protected state: TState;
     protected setterConfig: TStateSetter | null;
     /**
      * list of all the subscribers setState functions
      * @template {TState} TState - The type of the state object
      * */
-    subscribers: Set<StateSetter<TState>>;
+    subscribers: Set<StateSetter<{
+        state: TState;
+    }>>;
     /**
      * additional configuration for the store
      * @template {TState} TState - The type of the state object
@@ -75,6 +76,16 @@ export declare class GlobalStore<TState, TMetadata = null, TStateSetter extends
      * @returns {boolean} - true to prevent the state change, false to allow the state change
      * */
     protected computePreventStateChange?: GlobalStoreConfig<TState, TMetadata, TStateSetter>['computePreventStateChange'];
+    /**
+     * We use a wrapper in order to be able to force the state update when necessary even with primitive types
+     */
+    protected stateWrapper: {
+        state: TState;
+    };
+    /**
+     * @deprecated direct modifications of the state could end up in unexpected behaviors
+     */
+    protected get state(): TState;
     /**
      * Create a simple global store
      * @param {TState} state - The initial state
@@ -104,17 +115,7 @@ export declare class GlobalStore<TState, TMetadata = null, TStateSetter extends
      * @param {TStateSetter} setterConfig - The actions configuration object (optional) (default: null) if not null the store manipulation will be done through the actions
      * */
     constructor(state: TState, config: GlobalStoreConfig<TState, TMetadata, TStateSetter>, setterConfig: TStateSetter);
-    protected onInitializeStore: () => void;
-    /**
-     * gets a clone of the state
-     * @returns {TState} - The state clone
-     * */
-    protected getStateClone: () => TState;
-    /**
-     * gets a clone of the metadata
-     * @returns {TMetadata} - The metadata clone
-     * */
-    protected getMetadataClone: () => TMetadata;
+    protected initialize: () => void;
     /**
      * set the state and update all the subscribers
      * @param {StateSetter<TState>} setter - The setter function or the value to set
@@ -122,7 +123,9 @@ export declare class GlobalStore<TState, TMetadata = null, TStateSetter extends
      * */
     protected setState: ({ invokerSetState, state, }: {
         state: TState;
-        invokerSetState?: React.Dispatch<React.SetStateAction<TState>>;
+        invokerSetState?: Dispatch<SetStateAction<{
+            state: TState;
+        }>>;
     }) => void;
     /**
      * Set the value of the metadata property, this is no reactive and will not trigger a re-render
@@ -137,7 +140,9 @@ export declare class GlobalStore<TState, TMetadata = null, TStateSetter extends
      * @returns {StateConfigCallbackParam<TState, TMetadata>} - The parameters object
      * */
     protected getConfigCallbackParam: ({ invokerSetState, }: {
-        invokerSetState?: React.Dispatch<React.SetStateAction<TState>>;
+        invokerSetState?: React.Dispatch<React.SetStateAction<{
+            state: TState;
+        }>>;
     }) => StateConfigCallbackParam<TState, TMetadata, TStateSetter>;
     /**
      * Returns a custom hook that allows to handle a global state
@@ -155,14 +160,18 @@ export declare class GlobalStore<TState, TMetadata = null, TStateSetter extends
      * @returns {StateSetter<TState>} - The state setter
      * */
     protected getSetStateWrapper: ({ invokerSetState, }?: {
-        invokerSetState?: React.Dispatch<React.SetStateAction<TState>>;
+        invokerSetState?: React.Dispatch<React.SetStateAction<{
+            state: TState;
+        }>>;
     }) => StateSetter<TState>;
     /**
      * Returns the state setter or the actions map
      * @param {{ invokerSetState?: React.Dispatch<React.SetStateAction<TState>> }} parameters - The setState function of the component that invoked the state change (optional) (default: null) this is used to updated first the component that invoked the state change
      * @returns {TStateSetter} - The state setter or the actions map
      * */
-    protected getStateOrchestrator(invokerSetState?: React.Dispatch<React.SetStateAction<TState>>): StateSetter<TState> | ActionCollectionResult<TState, TMetadata, TStateSetter>;
+    protected getStateOrchestrator(invokerSetState?: React.Dispatch<React.SetStateAction<{
+        state: TState;
+    }>>): StateSetter<TState> | ActionCollectionResult<TState, TMetadata, TStateSetter>;
     /**
      * Calculate whenever or not we should compute the callback parameters on the state change
      * @returns {boolean} - True if we should compute the callback parameters on the state change
@@ -175,16 +184,35 @@ export declare class GlobalStore<TState, TMetadata = null, TStateSetter extends
      * - computePreventStateChange (if defined) - this function is executed before the state change and it should return a boolean value that will be used to determine if the state change should be prevented or not
      * @param {{ setter: StateSetter<TState>; invokerSetState?: React.Dispatch<React.SetStateAction<TState>> }} parameters - The state setter and the setState function of the component that invoked the state change (optional) (default: null) this is used to updated first the component that invoked the state change
      */
-    protected computeSetState: ({ setter, invokerSetState, }: {
+    protected computeSetState: ({ setter, invokerSetState, forceUpdate, }: {
         setter: StateSetter<TState>;
-        invokerSetState?: React.Dispatch<React.SetStateAction<TState>>;
+        invokerSetState?: React.Dispatch<React.SetStateAction<{
+            state: TState;
+        }>>;
+        forceUpdate: boolean;
     }) => void;
     /**
      * This creates a map of actions that can be used to modify or interact with the state
      * @param {{ invokerSetState?: React.Dispatch<React.SetStateAction<TState>> }} parameters - The setState function of the component that invoked the state change (optional) (default: null) this is used to updated first the component that invoked the state change
      * @returns {ActionCollectionResult<TState, TMetadata, TStateSetter>} - The actions map result of the configuration object passed to the constructor
      * */
-    protected getStoreActionsMap: ({ invokerSetState, }: {
-        invokerSetState?: React.Dispatch<React.SetStateAction<TState>>;
+    protected getStoreActionsMap: ({ invokerSetState, }?: {
+        invokerSetState?: React.Dispatch<React.SetStateAction<{
+            state: TState;
+        }>>;
     }) => ActionCollectionResult<TState, TMetadata, TStateSetter>;
 }
+/**
+ * Creates a global hook that can be used to access the state and actions across the application
+ * @param {TState} state - The initial state of the store
+ * @param {GlobalStoreConfig<TState, TMetadata, TStateSetter>} config - The configuration object of the store
+ * @param {TStateSetter | null} setterConfig - The configuration object of the state setter (optional) (default: null)
+ * @returns {GlobalStoreHook<TState, TMetadata, TStateSetter>} - The hook that can be used to access the state and actions across the application
+ */
+export declare const createGlobalHook: <TState, TMetadata = null, TStateSetter extends ActionCollectionConfig<TState, TMetadata> | StateSetter<TState> = StateSetter<TState>>(state: TState, config?: {
+    metadata?: TMetadata;
+    onInit?: (parameters: StateConfigCallbackParam<TState, TMetadata, TStateSetter>) => void;
+    onStateChanged?: (parameters: StateChangesParam<TState, TMetadata, TStateSetter>) => void;
+    onSubscribed?: (parameters: StateConfigCallbackParam<TState, TMetadata, TStateSetter>) => void;
+    computePreventStateChange?: (parameters: StateChangesParam<TState, TMetadata, TStateSetter>) => boolean;
+}, setterConfig?: TStateSetter) => () => [TState, TStateSetter extends StateSetter<TState> ? StateSetter<TState> : ActionCollectionResult<TState, TMetadata, TStateSetter>, TMetadata];

package/lib/GlobalStore.types.d.ts

@@ -2,7 +2,18 @@
  * @param {StateSetter<TState>} setter - add a new state to an existing state
  * @returns {void} result - void
  */
-export type StateSetter<TState> = (setter: TState | ((state: TState) => TState)) => void;
+export type StateSetter<TState> = (setter: TState | ((state: TState) => TState), 
+/**
+ * This parameter indicate whether we should force the re-render of the subscribers even if the state is the same,
+ * Do
+ */
+{ forceUpdate, }?: {
+    /**
+     * @deprecated forceUpdate normally should not be used inside components
+     * Use this flag just in custom implementations of the global store
+     */
+    forceUpdate?: boolean;
+}) => void;
 /**
  * Parameters of the onStateChanged callback function
  * @param {TState} state - the new state
@@ -13,19 +24,21 @@ export type StateChanges<TState> = {
     previousState?: TState;
 };
 /**
- * Callbacks to be passed to the configurating function of the store
+ * Callbacks to be passed to the configurations function of the store
  * @template {TState} TState - The state type
  * @template {TMetadata} TMetadata - The metadata type
  * @property {StateSetter<TState>} setMetadata - Set the metadata
  * @property {StateSetter<TState>} setState - Set the state
  * @property {() => TState} getState - Get the state
  * @property {() => TMetadata} getMetadata - Get the metadata
+ * @property {ActionCollectionResult<TState, TMetadata>} actions - The actions collection if any
  **/
 export type StoreTools<TState, TMetadata = null> = {
     setMetadata: StateSetter<TMetadata>;
     setState: StateSetter<TState>;
     getState: () => TState;
     getMetadata: () => TMetadata;
+    actions: ActionCollectionResult<TState, TMetadata>;
 };
 /**
  * Basic contract for the storeActionsConfig configuration

package/lib/GlobalStoreAbstract.d.ts

@@ -0,0 +1,15 @@
+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> | null = StateSetter<TState>> extends GlobalStore<TState, TMetadata, TStateSetter> {
+    constructor(state: TState, config?: GlobalStoreConfig<TState, TMetadata, TStateSetter>, setterConfig?: TStateSetter | null);
+    protected onInit: (parameters: StateConfigCallbackParam<TState, TMetadata, TStateSetter>) => void;
+    protected onStateChanged: (parameters: StateChangesParam<TState, TMetadata, NonNullable<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, NonNullable<TStateSetter>>) => void;
+}

package/lib/bundle.js

@@ -1 +1 @@
-!function(t,e){"object"==typeof exports&&"object"==typeof module?module.exports=e(require("react")):"function"==typeof define&&define.amd?define(["react"],e):"object"==typeof exports?exports["react-native-global-state-hooks"]=e(require("react")):t["react-native-global-state-hooks"]=e(t.react)}(this,(t=>{return e={774:(t,e,r)=>{"use strict";function n(t){return n="function"==typeof Symbol&&"symbol"==typeof Symbol.iterator?function(t){return typeof t}:function(t){return t&&"function"==typeof Symbol&&t.constructor===Symbol&&t!==Symbol.prototype?"symbol":typeof t},n(t)}function o(t,e){(null==e||e>t.length)&&(e=t.length);for(var r=0,n=new Array(e);r<e;r++)n[r]=t[r];return n}function a(t,e){for(var r=0;r<e.length;r++){var n=e[r];n.enumerable=n.enumerable||!1,n.configurable=!0,"value"in n&&(n.writable=!0),Object.defineProperty(t,i(n.key),n)}}function i(t){var e=function(t,e){if("object"!==n(t)||null===t)return t;var r=t[Symbol.toPrimitive];if(void 0!==r){var o=r.call(t,"string");if("object"!==n(o))return o;throw new TypeError("@@toPrimitive must return a primitive value.")}return String(t)}(t);return"symbol"===n(e)?e:String(e)}Object.defineProperty(e,"__esModule",{value:!0}),e.GlobalStore=void 0;var u=r(684),c=r(156),l=function(){function t(e){var r=this,n=arguments.length>1&&void 0!==arguments[1]?arguments[1]:{},a=arguments.length>2&&void 0!==arguments[2]?arguments[2]:null;!function(t,e){if(!(t instanceof e))throw new TypeError("Cannot call a class as a function")}(this,t),this.state=e,this.setterConfig=a,this.subscribers=new Set,this.config={metadata:null},this.onInit=null,this.onStateChanged=null,this.onSubscribed=null,this.computePreventStateChange=null,this.onInitializeStore=function(){var t=r.onInit,e=r.config.onInit;if(t||e){var n=r.getConfigCallbackParam({});null==t||t(n),null==e||e(n)}},this.getStateClone=function(){return(0,u.clone)(r.state)},this.getMetadataClone=function(){var t,e;return(0,u.clone)(null!==(e=null===(t=r.config)||void 0===t?void 0:t.metadata)&&void 0!==e?e:null)},this.setState=function(t){var e=t.invokerSetState,n=t.state;r.state=n,null==e||e(n),r.subscribers.forEach((function(t){t!==e&&t(n)}))},this.setMetadata=function(t){var e,n="function"==typeof t?t(r.getMetadataClone()):t;r.config=Object.assign(Object.assign({},null!==(e=r.config)&&void 0!==e?e:{}),{metadata:n})},this.getConfigCallbackParam=function(t){var e=t.invokerSetState;return{setMetadata:r.setMetadata,getMetadata:r.getMetadataClone,getState:r.getStateClone,setState:r.getSetStateWrapper({invokerSetState:e}),actions:r.getStoreActionsMap({})}},this.getHook=function(){return function(){var t,e,n=(t=(0,c.useState)((function(){return r.state})),e=2,function(t){if(Array.isArray(t))return t}(t)||function(t,e){var r=null==t?null:"undefined"!=typeof Symbol&&t[Symbol.iterator]||t["@@iterator"];if(null!=r){var n,o,a,i,u=[],c=!0,l=!1;try{if(a=(r=r.call(t)).next,0===e){if(Object(r)!==r)return;c=!1}else for(;!(c=(n=a.call(r)).done)&&(u.push(n.value),u.length!==e);c=!0);}catch(t){l=!0,o=t}finally{try{if(!c&&null!=r.return&&(i=r.return(),Object(i)!==i))return}finally{if(l)throw o}}return u}}(t,e)||function(t,e){if(t){if("string"==typeof t)return o(t,e);var r=Object.prototype.toString.call(t).slice(8,-1);return"Object"===r&&t.constructor&&(r=t.constructor.name),"Map"===r||"Set"===r?Array.from(t):"Arguments"===r||/^(?:Ui|I)nt(?:8|16|32)(?:Clamped)?Array$/.test(r)?o(t,e):void 0}}(t,e)||function(){throw new TypeError("Invalid attempt to destructure non-iterable instance.\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method.")}()),a=n[0],i=n[1];return(0,c.useEffect)((function(){r.subscribers.add(i);var t=r.onSubscribed,e=r.config.onSubscribed;if(t||e){var n=r.getConfigCallbackParam({invokerSetState:i});null==t||t(n),null==e||e(n)}return function(){r.subscribers.delete(i)}}),[]),[a,r.getStateOrchestrator(i),r.getMetadataClone()]}},this.getHookDecoupled=function(){var t=r.getStateClone,e=r.getMetadataClone;return[t,r.getStateOrchestrator(),e]},this.getSetStateWrapper=function(){var t=(arguments.length>0&&void 0!==arguments[0]?arguments[0]:{}).invokerSetState;return function(e){r.computeSetState({invokerSetState:t,setter:e})}},this.hasStateCallbacks=function(){var t=r.computePreventStateChange,e=r.onStateChanged,n=r.config,o=n.computePreventStateChange,a=n.onStateChanged;return!!(t||o||e||a)},this.computeSetState=function(t){var e=t.setter,n=t.invokerSetState,o="function"==typeof e,a=r.getStateClone(),i=o?e(a):e,u=r.hasStateCallbacks(),c=u&&r.getStoreActionsMap({}),l=u&&r.getSetStateWrapper({invokerSetState:n}),s={setMetadata:r.setMetadata,getMetadata:r.getMetadataClone,setState:l,getState:r.getStateClone,actions:c,previousState:a,state:i},f=r.computePreventStateChange,v=r.config.computePreventStateChange;if(!f&&!v||!(null==f?void 0:f(s))&&!(null==v?void 0:v(s))){r.setState({invokerSetState:n,state:i});var g=r.onStateChanged,S=r.config.onStateChanged;(g||S)&&(null==g||g(s),null==S||S(s))}},this.getStoreActionsMap=function(t){var e=t.invokerSetState;if(!r.setterConfig)return null;var n=r.setterConfig,o=r.setMetadata,a=n,u=Object.keys(a),c=r.getSetStateWrapper({invokerSetState:e}),l=r.getStateClone,s=r.getMetadataClone,f=u.reduce((function(t,e){return Object.assign(Object.assign({},t),(r={},u=function(){for(var t=a[e],r=arguments.length,n=new Array(r),i=0;i<r;i++)n[i]=arguments[i];var u=t.apply(f,n);return"function"!=typeof u&&function(t){throw new Error("[WRONG CONFIGURATION!]: Every key inside the storeActionsConfig must be a higher order function that returns a function \n[".concat(t,"]: key is not a valid function, try something like this: \n{\n\n    ").concat(t,": (param) => ({ setState, getState, setMetadata, getMetadata }) => {\n\n      setState((state) => ({ ...state, ...param }))\n\n    }\n\n}\n"))}(e),u.call(f,{setState:c,getState:l,setMetadata:o,getMetadata:s})},(n=i(n=e))in r?Object.defineProperty(r,n,{value:u,enumerable:!0,configurable:!0,writable:!0}):r[n]=u,r));var r,n,u}),{});return f},this.config=Object.assign({metadata:null},null!=n?n:{}),this.onInitializeStore()}var e,r;return e=t,(r=[{key:"getStateOrchestrator",value:function(t){return this.setterConfig?this.getStoreActionsMap({invokerSetState:t}):this.getSetStateWrapper({invokerSetState:t})}}])&&a(e.prototype,r),Object.defineProperty(e,"prototype",{writable:!1}),t}();e.GlobalStore=l},530:(t,e)=>{"use strict";Object.defineProperty(e,"__esModule",{value:!0})},991:(t,e,r)=>{"use strict";var n=Object.create?function(t,e,r,n){void 0===n&&(n=r);var o=Object.getOwnPropertyDescriptor(e,r);o&&!("get"in o?!e.__esModule:o.writable||o.configurable)||(o={enumerable:!0,get:function(){return e[r]}}),Object.defineProperty(t,n,o)}:function(t,e,r,n){void 0===n&&(n=r),t[n]=e[r]},o=function(t,e){for(var r in t)"default"===r||Object.prototype.hasOwnProperty.call(e,r)||n(e,t,r)};Object.defineProperty(e,"__esModule",{value:!0}),o(r(684),e),o(r(530),e),o(r(774),e)},684:function(t){t.exports=(()=>{"use strict";var t={991:(t,e,r)=>{var n=Object.create?function(t,e,r,n){void 0===n&&(n=r);var o=Object.getOwnPropertyDescriptor(e,r);o&&!("get"in o?!e.__esModule:o.writable||o.configurable)||(o={enumerable:!0,get:function(){return e[r]}}),Object.defineProperty(t,n,o)}:function(t,e,r,n){void 0===n&&(n=r),t[n]=e[r]};Object.defineProperty(e,"__esModule",{value:!0}),function(t,e){for(var r in t)"default"===r||Object.prototype.hasOwnProperty.call(e,r)||n(e,t,r)}(r(729),e)},729:(t,e)=>{function r(t,e){(null==e||e>t.length)&&(e=t.length);for(var r=0,n=new Array(e);r<e;r++)n[r]=t[r];return n}function n(t){return n="function"==typeof Symbol&&"symbol"==typeof Symbol.iterator?function(t){return typeof t}:function(t){return t&&"function"==typeof Symbol&&t.constructor===Symbol&&t!==Symbol.prototype?"symbol":typeof t},n(t)}function o(t,e,r){return(e=function(t){var e=function(t,e){if("object"!==n(t)||null===t)return t;var r=t[Symbol.toPrimitive];if(void 0!==r){var o=r.call(t,"string");if("object"!==n(o))return o;throw new TypeError("@@toPrimitive must return a primitive value.")}return String(t)}(t);return"symbol"===n(e)?e:String(e)}(e))in t?Object.defineProperty(t,e,{value:r,enumerable:!0,configurable:!0,writable:!0}):t[e]=r,t}Object.defineProperty(e,"__esModule",{value:!0}),e.formatToStore=e.formatFromStore=e.isPrimitive=e.isRegex=e.isDate=e.isString=e.isBoolean=e.isNumber=e.isNil=e.clone=void 0,e.clone=function(t){if((0,e.isPrimitive)(t)||(0,e.isDate)(t))return t;if(Array.isArray(t))return t.map((function(t){return(0,e.clone)(t)}));if(t instanceof Map){var r=Array.from(t.entries());return new Map(r.map((function(t){return(0,e.clone)(t)})))}if(t instanceof Set){var n=Array.from(t.values());return new Set(n.map((function(t){return(0,e.clone)(t)})))}return t instanceof RegExp?new RegExp(t.toString()):t instanceof Error?new Error(t.message):Object.keys(t).reduce((function(r,n){var a=t[n];return Object.assign(Object.assign({},r),o({},n,(0,e.clone)(a)))}),{})},e.isNil=function(t){return null==t},e.isNumber=function(t){return"number"==typeof t},e.isBoolean=function(t){return"boolean"==typeof t},e.isString=function(t){return"string"==typeof t},e.isDate=function(t){return t instanceof Date},e.isRegex=function(t){return t instanceof RegExp},e.isPrimitive=function(t){return(0,e.isNil)(t)||(0,e.isNumber)(t)||(0,e.isBoolean)(t)||(0,e.isString)(t)||"symbol"===n(t)},e.formatFromStore=function(t){return function(t){var n,a;if((0,e.isPrimitive)(t))return t;if("date"===(null==t?void 0:t.$t))return new Date(t.$v);if("map"===(null==t?void 0:t.$t)){var i=(null!==(n=t.$v)&&void 0!==n?n:[]).map((function(t){var n,o=(2,function(t){if(Array.isArray(t))return t}(n=t)||function(t,e){var r=null==t?null:"undefined"!=typeof Symbol&&t[Symbol.iterator]||t["@@iterator"];if(null!=r){var n,o,a,i,u=[],c=!0,l=!1;try{for(a=(r=r.call(t)).next,0;!(c=(n=a.call(r)).done)&&(u.push(n.value),2!==u.length);c=!0);}catch(t){l=!0,o=t}finally{try{if(!c&&null!=r.return&&(i=r.return(),Object(i)!==i))return}finally{if(l)throw o}}return u}}(n)||function(t,e){if(t){if("string"==typeof t)return r(t,2);var n=Object.prototype.toString.call(t).slice(8,-1);return"Object"===n&&t.constructor&&(n=t.constructor.name),"Map"===n||"Set"===n?Array.from(t):"Arguments"===n||/^(?:Ui|I)nt(?:8|16|32)(?:Clamped)?Array$/.test(n)?r(t,2):void 0}}(n)||function(){throw new TypeError("Invalid attempt to destructure non-iterable instance.\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method.")}()),a=o[0],i=o[1];return[a,(0,e.formatFromStore)(i)]}));return new Map(i)}if("set"===(null==t?void 0:t.$t)){var u=null!==(a=t.$v)&&void 0!==a?a:[].map((function(t){return(0,e.formatFromStore)(t)}));return new Set(u)}return"regex"===(null==t?void 0:t.$t)?new RegExp(t.$v):"error"===(null==t?void 0:t.$t)?new Error(t.$v):Array.isArray(t)?t.map((function(t){return(0,e.formatFromStore)(t)})):Object.keys(t).reduce((function(r,n){var a=t[n];return Object.assign(Object.assign({},r),o({},n,(0,e.formatFromStore)(a)))}),{})}((0,e.clone)(t))},e.formatToStore=function(t){var r,n=(arguments.length>1&&void 0!==arguments[1]?arguments[1]:{stringify:!1}).stringify,a=(r=(0,e.clone)(t),(0,e.isPrimitive)(r)?r:Array.isArray(r)?r.map((function(t){return(0,e.formatToStore)(t)})):r instanceof Map?{$t:"map",$v:Array.from(r.entries()).map((function(t){return(0,e.formatToStore)(t)}))}:r instanceof Set?{$t:"set",$v:Array.from(r.values()).map((function(t){return(0,e.formatToStore)(t)}))}:(0,e.isDate)(r)?{$t:"date",$v:r.toISOString()}:(0,e.isRegex)(r)?{$t:"regex",$v:r.toString()}:r instanceof Error?{$t:"error",$v:r.message}:Object.keys(r).reduce((function(t,n){var a=r[n];return Object.assign(Object.assign({},t),o({},n,(0,e.formatToStore)(a)))}),{}));return n?JSON.stringify(a):a}}},e={};return function r(n){var o=e[n];if(void 0!==o)return o.exports;var a=e[n]={exports:{}};return t[n](a,a.exports,r),a.exports}(991)})()},156:e=>{"use strict";e.exports=t}},r={},function t(n){var o=r[n];if(void 0!==o)return o.exports;var a=r[n]={exports:{}};return e[n].call(a.exports,a,a.exports,t),a.exports}(991);var e,r}));
+!function(t,e){"object"==typeof exports&&"object"==typeof module?module.exports=e(require("react")):"function"==typeof define&&define.amd?define(["react"],e):"object"==typeof exports?exports["react-native-global-state-hooks"]=e(require("react")):t["react-native-global-state-hooks"]=e(t.react)}(this,(t=>{return e={774:(t,e,r)=>{"use strict";function n(t){return n="function"==typeof Symbol&&"symbol"==typeof Symbol.iterator?function(t){return typeof t}:function(t){return t&&"function"==typeof Symbol&&t.constructor===Symbol&&t!==Symbol.prototype?"symbol":typeof t},n(t)}function o(t,e){(null==e||e>t.length)&&(e=t.length);for(var r=0,n=new Array(e);r<e;r++)n[r]=t[r];return n}function i(t,e){for(var r=0;r<e.length;r++){var n=e[r];n.enumerable=n.enumerable||!1,n.configurable=!0,"value"in n&&(n.writable=!0),Object.defineProperty(t,a(n.key),n)}}function a(t){var e=function(t,e){if("object"!==n(t)||null===t)return t;var r=t[Symbol.toPrimitive];if(void 0!==r){var o=r.call(t,"string");if("object"!==n(o))return o;throw new TypeError("@@toPrimitive must return a primitive value.")}return String(t)}(t);return"symbol"===n(e)?e:String(e)}Object.defineProperty(e,"__esModule",{value:!0}),e.createGlobalHook=e.GlobalStore=void 0;var u=r(156),c=function(){function t(e){var r=this,n=arguments.length>1&&void 0!==arguments[1]?arguments[1]:{},i=arguments.length>2&&void 0!==arguments[2]?arguments[2]:null;!function(t,e){if(!(t instanceof e))throw new TypeError("Cannot call a class as a function")}(this,t),this.setterConfig=i,this.subscribers=new Set,this.config={metadata:null},this.onInit=null,this.onStateChanged=null,this.onSubscribed=null,this.computePreventStateChange=null,this.initialize=function(){var t=r.onInit,e=r.config.onInit;if(t||e){var n=r.getConfigCallbackParam({});null==t||t(n),null==e||e(n)}},this.setState=function(t){var e=t.invokerSetState,n=t.state;r.stateWrapper={state:n},null==e||e({state:n}),r.subscribers.forEach((function(t){t!==e&&t({state:n})}))},this.setMetadata=function(t){var e,n,o="function"==typeof t?t(null!==(e=r.config.metadata)&&void 0!==e?e:null):t;r.config=Object.assign(Object.assign({},null!==(n=r.config)&&void 0!==n?n:{}),{metadata:o})},this.getConfigCallbackParam=function(t){var e=t.invokerSetState;return{setMetadata:r.setMetadata,getMetadata:function(){return r.config.metadata},getState:function(){return r.stateWrapper.state},setState:r.getSetStateWrapper({invokerSetState:e}),actions:r.getStoreActionsMap()}},this.getHook=function(){return function(){var t,e,n=(t=(0,u.useState)((function(){return r.stateWrapper})),e=2,function(t){if(Array.isArray(t))return t}(t)||function(t,e){var r=null==t?null:"undefined"!=typeof Symbol&&t[Symbol.iterator]||t["@@iterator"];if(null!=r){var n,o,i,a,u=[],c=!0,f=!1;try{if(i=(r=r.call(t)).next,0===e){if(Object(r)!==r)return;c=!1}else for(;!(c=(n=i.call(r)).done)&&(u.push(n.value),u.length!==e);c=!0);}catch(t){f=!0,o=t}finally{try{if(!c&&null!=r.return&&(a=r.return(),Object(a)!==a))return}finally{if(f)throw o}}return u}}(t,e)||function(t,e){if(t){if("string"==typeof t)return o(t,e);var r=Object.prototype.toString.call(t).slice(8,-1);return"Object"===r&&t.constructor&&(r=t.constructor.name),"Map"===r||"Set"===r?Array.from(t):"Arguments"===r||/^(?:Ui|I)nt(?:8|16|32)(?:Clamped)?Array$/.test(r)?o(t,e):void 0}}(t,e)||function(){throw new TypeError("Invalid attempt to destructure non-iterable instance.\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method.")}()),i=n[0],a=n[1];(0,u.useEffect)((function(){r.subscribers.add(a);var t=r.onSubscribed,e=r.config.onSubscribed;if(t||e){var n=r.getConfigCallbackParam({invokerSetState:a});null==t||t(n),null==e||e(n)}return function(){r.subscribers.delete(a)}}),[]);var c=r.getStateOrchestrator(a);return[i.state,c,r.config.metadata]}},this.getHookDecoupled=function(){return[function(){return r.stateWrapper.state},r.getStateOrchestrator(),function(){return r.config.metadata}]},this.getSetStateWrapper=function(){var t=(arguments.length>0&&void 0!==arguments[0]?arguments[0]:{}).invokerSetState;return function(e){var n=(arguments.length>1&&void 0!==arguments[1]?arguments[1]:{}).forceUpdate;r.computeSetState({invokerSetState:t,setter:e,forceUpdate:n})}},this.hasStateCallbacks=function(){var t=r.computePreventStateChange,e=r.onStateChanged,n=r.config,o=n.computePreventStateChange,i=n.onStateChanged;return!!(t||o||e||i)},this.computeSetState=function(t){var e=t.setter,n=t.invokerSetState,o=t.forceUpdate,i="function"==typeof e,a=r.stateWrapper.state,u=i?e(a):e;if(o||!Object.is(r.stateWrapper.state,u)){var c=r.hasStateCallbacks(),f=c&&r.getStoreActionsMap({}),s=c&&r.getSetStateWrapper({invokerSetState:n}),l={setMetadata:r.setMetadata,getMetadata:function(){return r.config.metadata},setState:s,getState:function(){return r.stateWrapper.state},actions:f,previousState:a,state:u},p=r.computePreventStateChange,v=r.config.computePreventStateChange;if((p||v)&&((null==p?void 0:p(l))||(null==v?void 0:v(l))))return;r.setState({invokerSetState:n,state:u});var y=r.onStateChanged,b=r.config.onStateChanged;(y||b)&&(null==y||y(l),null==b||b(l))}},this.getStoreActionsMap=function(){var t=(arguments.length>0&&void 0!==arguments[0]?arguments[0]:{}).invokerSetState;if(!r.setterConfig)return null;var e=r.setterConfig,n=r.setMetadata,o=e,i=Object.keys(o),u=r.getSetStateWrapper({invokerSetState:t}),c=function(){return r.stateWrapper.state},f=function(){return r.config.metadata},s=i.reduce((function(t,e){return Object.assign(Object.assign({},t),(r={},l=function(){for(var t=o[e],r=arguments.length,i=new Array(r),a=0;a<r;a++)i[a]=arguments[a];var l=t.apply(s,i);return"function"!=typeof l&&function(t){throw new Error("[WRONG CONFIGURATION!]: Every key inside the storeActionsConfig must be a higher order function that returns a function \n[".concat(t,"]: key is not a valid function, try something like this: \n{\n\n    ").concat(t,": (param) => ({ setState, getState, setMetadata, getMetadata }) => {\n\n      setState((state) => ({ ...state, ...param }))\n\n    }\n\n}\n"))}(e),l.call(s,{setState:u,getState:c,setMetadata:n,getMetadata:f,actions:s})},(i=a(i=e))in r?Object.defineProperty(r,i,{value:l,enumerable:!0,configurable:!0,writable:!0}):r[i]=l,r));var r,i,l}),{});return s},this.stateWrapper={state:e},this.config=Object.assign({metadata:null},null!=n?n:{}),this.constructor!==t||this.initialize()}var e,r;return e=t,(r=[{key:"state",get:function(){return this.stateWrapper.state}},{key:"getStateOrchestrator",value:function(t){return this.setterConfig?this.getStoreActionsMap({invokerSetState:t}):this.getSetStateWrapper({invokerSetState:t})}}])&&i(e.prototype,r),Object.defineProperty(e,"prototype",{writable:!1}),t}();e.GlobalStore=c,e.createGlobalHook=function(t){return new c(t,arguments.length>1&&void 0!==arguments[1]?arguments[1]:{},arguments.length>2&&void 0!==arguments[2]?arguments[2]:null).getHook()}},530:(t,e)=>{"use strict";Object.defineProperty(e,"__esModule",{value:!0})},195:(t,e,r)=>{"use strict";function n(t){return n="function"==typeof Symbol&&"symbol"==typeof Symbol.iterator?function(t){return typeof t}:function(t){return t&&"function"==typeof Symbol&&t.constructor===Symbol&&t!==Symbol.prototype?"symbol":typeof t},n(t)}function o(t,e){return o=Object.setPrototypeOf?Object.setPrototypeOf.bind():function(t,e){return t.__proto__=e,t},o(t,e)}function i(t){return i=Object.setPrototypeOf?Object.getPrototypeOf.bind():function(t){return t.__proto__||Object.getPrototypeOf(t)},i(t)}Object.defineProperty(e,"__esModule",{value:!0}),e.GlobalStoreAbstract=void 0;var a=function(t){!function(t,e){if("function"!=typeof e&&null!==e)throw new TypeError("Super expression must either be null or a function");t.prototype=Object.create(e&&e.prototype,{constructor:{value:t,writable:!0,configurable:!0}}),Object.defineProperty(t,"prototype",{writable:!1}),e&&o(t,e)}(c,t);var e,r,a,u=(r=c,a=function(){if("undefined"==typeof Reflect||!Reflect.construct)return!1;if(Reflect.construct.sham)return!1;if("function"==typeof Proxy)return!0;try{return Boolean.prototype.valueOf.call(Reflect.construct(Boolean,[],(function(){}))),!0}catch(t){return!1}}(),function(){var t,e=i(r);if(a){var o=i(this).constructor;t=Reflect.construct(e,arguments,o)}else t=e.apply(this,arguments);return function(t,e){if(e&&("object"===n(e)||"function"==typeof e))return e;if(void 0!==e)throw new TypeError("Derived constructors may only return object or undefined");return function(t){if(void 0===t)throw new ReferenceError("this hasn't been initialised - super() hasn't been called");return t}(t)}(this,t)});function c(t){var e,r=arguments.length>1&&void 0!==arguments[1]?arguments[1]:{},n=arguments.length>2&&void 0!==arguments[2]?arguments[2]:null;return function(t,e){if(!(t instanceof e))throw new TypeError("Cannot call a class as a function")}(this,c),(e=u.call(this,t,r,n)).onInit=function(t){e.onInitialize(t)},e.onStateChanged=function(t){e.onChange(t)},e}return e=c,Object.defineProperty(e,"prototype",{writable:!1}),e}(r(774).GlobalStore);e.GlobalStoreAbstract=a},991:(t,e,r)=>{"use strict";var n=Object.create?function(t,e,r,n){void 0===n&&(n=r);var o=Object.getOwnPropertyDescriptor(e,r);o&&!("get"in o?!e.__esModule:o.writable||o.configurable)||(o={enumerable:!0,get:function(){return e[r]}}),Object.defineProperty(t,n,o)}:function(t,e,r,n){void 0===n&&(n=r),t[n]=e[r]},o=function(t,e){for(var r in t)"default"===r||Object.prototype.hasOwnProperty.call(e,r)||n(e,t,r)};Object.defineProperty(e,"__esModule",{value:!0}),o(r(684),e),o(r(530),e),o(r(774),e),o(r(195),e)},684:function(t){t.exports=(()=>{"use strict";var t={991:(t,e,r)=>{var n=Object.create?function(t,e,r,n){void 0===n&&(n=r);var o=Object.getOwnPropertyDescriptor(e,r);o&&!("get"in o?!e.__esModule:o.writable||o.configurable)||(o={enumerable:!0,get:function(){return e[r]}}),Object.defineProperty(t,n,o)}:function(t,e,r,n){void 0===n&&(n=r),t[n]=e[r]};Object.defineProperty(e,"__esModule",{value:!0}),function(t,e){for(var r in t)"default"===r||Object.prototype.hasOwnProperty.call(e,r)||n(e,t,r)}(r(729),e)},729:(t,e)=>{function r(t){return r="function"==typeof Symbol&&"symbol"==typeof Symbol.iterator?function(t){return typeof t}:function(t){return t&&"function"==typeof Symbol&&t.constructor===Symbol&&t!==Symbol.prototype?"symbol":typeof t},r(t)}function n(t,e,n){return(e=function(t){var e=function(t,e){if("object"!==r(t)||null===t)return t;var n=t[Symbol.toPrimitive];if(void 0!==n){var o=n.call(t,"string");if("object"!==r(o))return o;throw new TypeError("@@toPrimitive must return a primitive value.")}return String(t)}(t);return"symbol"===r(e)?e:String(e)}(e))in t?Object.defineProperty(t,e,{value:n,enumerable:!0,configurable:!0,writable:!0}):t[e]=n,t}function o(t,e){if(t){if("string"==typeof t)return i(t,e);var r=Object.prototype.toString.call(t).slice(8,-1);return"Object"===r&&t.constructor&&(r=t.constructor.name),"Map"===r||"Set"===r?Array.from(t):"Arguments"===r||/^(?:Ui|I)nt(?:8|16|32)(?:Clamped)?Array$/.test(r)?i(t,e):void 0}}function i(t,e){(null==e||e>t.length)&&(e=t.length);for(var r=0,n=new Array(e);r<e;r++)n[r]=t[r];return n}Object.defineProperty(e,"__esModule",{value:!0}),e.formatToStore=e.formatFromStore=e.isPrimitive=e.isFunction=e.isRegex=e.isDate=e.isString=e.isBoolean=e.isNumber=e.isNil=e.clone=void 0,e.clone=function(t){var r,a=(arguments.length>1&&void 0!==arguments[1]?arguments[1]:{}).shallow;if((0,e.isPrimitive)(t)||(0,e.isDate)(t))return t;if(Array.isArray(t))return a?function(t){if(Array.isArray(t))return i(t)}(r=t)||function(t){if("undefined"!=typeof Symbol&&null!=t[Symbol.iterator]||null!=t["@@iterator"])return Array.from(t)}(r)||o(r)||function(){throw new TypeError("Invalid attempt to spread non-iterable instance.\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method.")}():t.map((function(t){return(0,e.clone)(t)}));if(t instanceof Map){var u=Array.from(t.entries());return a?new Map(u):new Map(u.map((function(t){return(0,e.clone)(t)})))}if(t instanceof Set){var c=Array.from(t.values());return a?new Set(c):new Set(c.map((function(t){return(0,e.clone)(t)})))}return t instanceof RegExp?new RegExp(t.toString()):(0,e.isFunction)(t)?a?t:Object.create(t):a?Object.assign({},t):t instanceof Error?new Error(t.message):Object.keys(t).reduce((function(r,o){var i=t[o];return Object.assign(Object.assign({},r),n({},o,(0,e.clone)(i)))}),{})},e.isNil=function(t){return null==t},e.isNumber=function(t){return"number"==typeof t},e.isBoolean=function(t){return"boolean"==typeof t},e.isString=function(t){return"string"==typeof t},e.isDate=function(t){return t instanceof Date},e.isRegex=function(t){return t instanceof RegExp},e.isFunction=function(t){return"function"==typeof t||t instanceof Function},e.isPrimitive=function(t){return(0,e.isNil)(t)||(0,e.isNumber)(t)||(0,e.isBoolean)(t)||(0,e.isString)(t)||"symbol"===r(t)},e.formatFromStore=function(t){return function(t){var r,i;if((0,e.isPrimitive)(t))return t;if("date"===(null==t?void 0:t.$t))return new Date(t.$v);if("map"===(null==t?void 0:t.$t)){var a=(null!==(r=t.$v)&&void 0!==r?r:[]).map((function(t){var r,n=(2,function(t){if(Array.isArray(t))return t}(r=t)||function(t,e){var r=null==t?null:"undefined"!=typeof Symbol&&t[Symbol.iterator]||t["@@iterator"];if(null!=r){var n,o,i,a,u=[],c=!0,f=!1;try{for(i=(r=r.call(t)).next,0;!(c=(n=i.call(r)).done)&&(u.push(n.value),2!==u.length);c=!0);}catch(t){f=!0,o=t}finally{try{if(!c&&null!=r.return&&(a=r.return(),Object(a)!==a))return}finally{if(f)throw o}}return u}}(r)||o(r,2)||function(){throw new TypeError("Invalid attempt to destructure non-iterable instance.\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method.")}()),i=n[0],a=n[1];return[i,(0,e.formatFromStore)(a)]}));return new Map(a)}if("set"===(null==t?void 0:t.$t)){var u=null!==(i=t.$v)&&void 0!==i?i:[].map((function(t){return(0,e.formatFromStore)(t)}));return new Set(u)}return"regex"===(null==t?void 0:t.$t)?new RegExp(t.$v):"error"===(null==t?void 0:t.$t)?new Error(t.$v):Array.isArray(t)?t.map((function(t){return(0,e.formatFromStore)(t)})):"function"===(null==t?void 0:t.$t)?Function("(".concat(t.$v,")(...arguments)")):Object.keys(t).reduce((function(r,o){var i=t[o];return Object.assign(Object.assign({},r),n({},o,(0,e.formatFromStore)(i)))}),{})}((arguments.length>1&&void 0!==arguments[1]?arguments[1]:{}).jsonParse?JSON.parse(t):(0,e.clone)(t))},e.formatToStore=function(t){var o=arguments.length>1&&void 0!==arguments[1]?arguments[1]:{stringify:!1},i=o.stringify,a=o.validator,u=o.excludeTypes,c=o.excludeKeys,f=new Set(null!=u?u:[]),s=new Set(null!=c?c:[]),l=f.size||s.size,p=null!=a?a:function(t){var e=t.key,n=t.value;if(!l)return!0;var o=s.has(e),i=f.has(r(n));return!o&&!i},v=function t(r){if((0,e.isPrimitive)(r))return r;if(Array.isArray(r))return r.map((function(e){return t(e)}));if(r instanceof Map)return{$t:"map",$v:Array.from(r.entries()).map((function(e){return t(e)}))};if(r instanceof Set)return{$t:"set",$v:Array.from(r.values()).map((function(e){return t(e)}))};if((0,e.isDate)(r))return{$t:"date",$v:r.toISOString()};if((0,e.isRegex)(r))return{$t:"regex",$v:r.toString()};if((0,e.isFunction)(r)){var o;try{o={$t:"function",$v:r.toString()}}catch(t){o={$t:"error",$v:"Error: Could not serialize function"}}return o}return r instanceof Error?{$t:"error",$v:r.message}:Object.keys(r).reduce((function(e,o){var i=r[o],a=t(i);return p({obj:r,key:o,value:a})?Object.assign(Object.assign({},e),n({},o,t(i))):e}),{})}((0,e.clone)(t));return i?JSON.stringify(v):v}}},e={};return function r(n){var o=e[n];if(void 0!==o)return o.exports;var i=e[n]={exports:{}};return t[n](i,i.exports,r),i.exports}(991)})()},156:e=>{"use strict";e.exports=t}},r={},function t(n){var o=r[n];if(void 0!==o)return o.exports;var i=r[n]={exports:{}};return e[n].call(i.exports,i,i.exports,t),i.exports}(991);var e,r}));

package/lib/index.d.ts

@@ -1,3 +1,4 @@
 export * from 'json-storage-formatter';
 export * from './GlobalStore.types';
 export * from './GlobalStore';
+export * from './GlobalStoreAbstract';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "react-native-global-state-hooks",
-  "version": "3.0.5",
+  "version": "3.0.7",
   "description": "This is a package to easily handling global-state across your react-native-components No-redux",
   "main": "lib/bundle.js",
   "types": "lib/index.d.ts",
@@ -80,6 +80,6 @@
     }
   },
   "dependencies": {
-    "json-storage-formatter": "^1.0.7"
+    "json-storage-formatter": "^1.0.8"
   }
 }

package/README.advance.md

@@ -1,123 +0,0 @@
-## 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**:
-
-```JSX
-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);
-    };
-  },
-
-  //* Lets add a new action to increase the value of the count */
-  increase(increase: number) {
-
-    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);
-```
-
-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) {
-    return (setter: StateSetter<number>, state: number) =>
-      setter(state + increase);
-  },
-} as IActionCollectionConfig<number>);
-```
-
-Now lets get our new global hook with specific API
-
-```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>();
-```
-
-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'
-
-const MyComponent: Reac.FC = () => {
-  const [count, countActions] = useCountGlobal();
-
-  // this functions are strongly typed 
-  const increaseClick = () => countActions.increase(1);
-  const decreaseClick = () => countActions.decrease(1);
-
-  return (<>
-      <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';
-import { IActionCollection } from 'react-native-global-state-hooks/lib/GlobalStoreTypes';
-
-export class SecureGlobalState<
-  IState,
-  IPersist extends string | null = null,
-  IsPersist extends boolean = IPersist extends null ? false : true,
-  IActions extends IActionCollection<IState> | null = null
-> extends GlobalState<IState, IPersist, IsPersist, IActions> {
-
-  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);
-  
-}
-
-export default SecureGlobalState;
-```