react-native-global-state-hooks 2.1.5 → 2.1.7

package/README.md

@@ -140,34 +140,71 @@ You could just use this code right as it is by just adding also into your projec
 ```ts
 export class GlobalStoreAsync<
   TState,
-  TMetadata extends { readonly isAsyncStorageReady: boolean },
+  TMetadata extends { readonly isAsyncStorageReady: never },
+  // 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
   TStateSetter extends
-    | ActionCollectionConfig<TState, TMetadata>
+    | ActionCollectionConfig<
+        TState,
+        Omit<TMetadata, 'isAsyncStorageReady'> & {
+          readonly isAsyncStorageReady: boolean;
+        }
+      >
     | StateSetter<TState>
     | null = StateSetter<TState>
-> extends GlobalStore<TState, TMetadata, TStateSetter> {
-  protected isAsyncStorageReady: boolean = false;
-
-  protected config: GlobalStoreConfig<
-    TState,
-    TMetadata,
-    NonNullable<TStateSetter>
+> extends GlobalStore<
+  TState,
+  Omit<TMetadata, 'isAsyncStorageReady'> & {
+    readonly isAsyncStorageReady: boolean;
+  },
+  TStateSetter
+> {
+  protected config: NonNullable<
+    GlobalStoreConfig<
+      TState,
+      Omit<TMetadata, 'isAsyncStorageReady'> & {
+        readonly isAsyncStorageReady: boolean;
+      },
+      NonNullable<TStateSetter>
+    >
   > & {
-    asyncStorageKey: string; // key of the async storage
+    asyncStorageKey: string;
   };
 
   constructor(
     state: TState,
-    metadata: TMetadata = { isAsyncStorageReady: false } as TMetadata,
-    setterConfig: TStateSetter | null = null,
-    {
-      onInit: onInitConfig,
-      ...config
-    }: GlobalStoreConfig<TState, TMetadata, NonNullable<TStateSetter>> & {
-      asyncStorageKey: string; // key of the async storage
-    }
+    config: GlobalStoreConfig<
+      TState,
+      TMetadata,
+      ActionCollectionConfig<TState, TMetadata> | StateSetter<TState>
+    > & {
+      asyncStorageKey: string;
+    },
+    setterConfig: TStateSetter | null = null
   ) {
-    super(state, metadata, setterConfig, config);
+    type TConfig = NonNullable<
+      GlobalStoreConfig<
+        TState,
+        Omit<TMetadata, 'isAsyncStorageReady'> & {
+          readonly isAsyncStorageReady: boolean;
+        },
+        NonNullable<TStateSetter>
+      >
+    > & {
+      asyncStorageKey: string;
+    };
+
+    const { onInit: onInitConfig, ...configParameters } = config as TConfig;
+
+    super(state, configParameters, setterConfig as TStateSetter);
+
+    this.config = {
+      ...config,
+      metadata: {
+        ...configParameters.metadata,
+        isAsyncStorageReady: false,
+      },
+    } as TConfig;
 
     const parameters = this.getConfigCallbackParam({});
 
@@ -177,7 +214,7 @@ export class GlobalStoreAsync<
 
   /**
    * This method will be called once the store is created after the constructor,
-   * this method is different from the onInit of the confg property and it won't be overriden
+   * this method is different from the onInit of the config property and it won't be overriden
    */
   protected onInit = async ({
     setState,
@@ -185,20 +222,20 @@ export class GlobalStoreAsync<
     getMetadata,
   }: StateConfigCallbackParam<
     TState,
-    TMetadata,
+    Omit<TMetadata, 'isAsyncStorageReady'> & {
+      readonly isAsyncStorageReady: boolean;
+    },
     NonNullable<TStateSetter>
   >) => {
     const { asyncStorageKey } = this.config;
     const storedItem: string = await asyncStorage.getItem(asyncStorageKey);
 
-    this.isAsyncStorageReady = true;
-
     setMetadata({
       ...getMetadata(),
       isAsyncStorageReady: true,
     });
 
-    if (!storedItem) return;
+    if (storedItem === null) return;
 
     const jsonParsed = JSON.parse(storedItem);
     const items = formatFromStore<TState>(jsonParsed);
@@ -208,7 +245,13 @@ export class GlobalStoreAsync<
 
   protected onStateChanged = ({
     getState,
-  }: StateChangesParam<TState, TMetadata, NonNullable<TStateSetter>>) => {
+  }: StateChangesParam<
+    TState,
+    Omit<TMetadata, 'isAsyncStorageReady'> & {
+      readonly isAsyncStorageReady: boolean;
+    },
+    NonNullable<TStateSetter>
+  >) => {
     const { asyncStorageKey } = this.config;
 
     const state = getState();
@@ -253,13 +296,17 @@ It's super common to have the wish or the necessity of restricting the manipulat
 ```ts
 const initialValue = 0;
 
-// 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
-const metadata = null;
+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
+  metadata: null,
+
+  // The lifecycle callbacks are: onInit, onStateChanged, onSubscribed and computePreventStateChange
+};
 
 const countStore = new GlobalStore(
   initialValue,
-  metadata,
+  config,
   {
     log: (message: string) => (): void => {
       console.log(message);
@@ -311,7 +358,7 @@ import { GlobalStore } from 'react-native-global-state-hooks';
 
 const initialValue = 0;
 
-const store = new GlobalStore(0, null, null, {
+const store = new GlobalStore(0, {
   onInit: async ({ setMetadata, setState }) => {
     const data = await someApiCall();
 
@@ -332,7 +379,7 @@ This method will be called every time the state is changed
 ```ts
 import { GlobalStore } from 'react-native-global-state-hooks';
 
-const store = new GlobalStore(0, null, null, {
+const store = new GlobalStore(0, {
   onStateChanged: ({ getState }) => {
     const state = getState();
 
@@ -352,7 +399,7 @@ This method will be called every time a component is subscribed to the store
 ```ts
 import { GlobalStore } from 'react-native-global-state-hooks';
 
-const store = new GlobalStore(0, null, null, {
+const store = new GlobalStore(0, {
   onSubscribed: ({ getState }) => {
     console.log('A component was subscribed to the store');
   },
@@ -370,7 +417,7 @@ This method will be called every time the state is going to be changed, if it re
 ```ts
 import { GlobalStore } from 'react-native-global-state-hooks';
 
-const store = new GlobalStore(0, null, null, {
+const store = new GlobalStore(0, {
   computePreventStateChange: ({ getState }) => {
     const state = getState();
     const shouldPrevent = state < 0;

package/lib/GlobalStore.d.ts

@@ -1,10 +1,6 @@
+export * from 'json-storage-formatter';
 import { Dispatch, SetStateAction } from 'react';
 import { ActionCollectionConfig, StateSetter, GlobalStoreConfig, ActionCollectionResult, StateConfigCallbackParam } from './GlobalStore.types';
-export declare const clone: <T>(obj: T) => T;
-export declare const formatFromStore: <T = unknown>(value: unknown) => T;
-export declare const formatToStore: <TValue, TStringify extends boolean = false>(value: TValue, { stringify }?: {
-    stringify: TStringify;
-}) => TStringify extends true ? string : unknown;
 /**
  * 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
@@ -13,14 +9,24 @@ export declare const formatToStore: <TValue, TStringify extends boolean = false>
  * */
 export declare class GlobalStore<TState, TMetadata = null, TStateSetter extends ActionCollectionConfig<TState, TMetadata> | StateSetter<TState> | null = StateSetter<TState>> {
     protected state: TState;
-    protected metadata: TMetadata;
     protected setterConfig: TStateSetter | null;
-    protected config: GlobalStoreConfig<TState, TMetadata, TStateSetter>;
     /**
      * list of all the subscribers setState functions
      * @template {TState} TState - The type of the state object
      * */
     subscribers: Set<StateSetter<TState>>;
+    /**
+     * additional configuration for the store
+     * @template {TState} TState - The type of the state object
+     * @template {TMetadata} TMetadata - The type of the metadata object (optional) (default: null) no reactive information set to share with the subscribers
+     * @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
+     * @property {GlobalStoreConfig<TState, TMetadata, TStateSetter>} config.metadata - The metadata to pass to the callbacks (optional) (default: null)
+     * @property {GlobalStoreConfig<TState, TMetadata, TStateSetter>} config.onInit - The callback to execute when the store is initialized (optional) (default: null)
+     * @property {GlobalStoreConfig<TState, TMetadata, TStateSetter>} config.onStateChanged - The callback to execute when the state is changed (optional) (default: null)
+     * @property {GlobalStoreConfig<TState, TMetadata, TStateSetter>} config.onSubscribed - The callback to execute when a component is subscribed to the store (optional) (default: null)
+     * @property {GlobalStoreConfig<TState, TMetadata, TStateSetter>} config.computePreventStateChange - The callback to execute when the state is changed to compute if the state change should be prevented (optional) (default: null)
+     */
+    protected config: GlobalStoreConfig<TState, TMetadata, TStateSetter>;
     /**
      * execute once the store is created
      * @template {TState} TState - The type of the state object
@@ -75,22 +81,14 @@ export declare class GlobalStore<TState, TMetadata = null, TStateSetter extends
      * @param {TState} state - The initial state
      * */
     constructor(state: TState);
-    /**
-     * Create a simple global store with also contains a metadata object
-     * The metadata object is not reactive, but it can be used to share information with the subscribers
-     * @param {TState} state - The initial state
-     * @param {TMetadata} metadata - The metadata object (optional) (default: null) no reactive information set to share with the subscribers
-     * */
-    constructor(state: TState, metadata: TMetadata);
     /**
      * Create a new global store with custom action
      * The metadata object could be null if not needed
      * The setter Object is used to define the actions that will be used to manipulate the state
      * @param {TState} state - The initial state
-     * @param {TMetadata} metadata - The metadata object (optional) (default: null) no reactive information set to share with the subscribers
      * @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, metadata: TMetadata, setterConfig: TStateSetter);
+    constructor(state: TState, config: GlobalStoreConfig<TState, TMetadata, TStateSetter>);
     /**
      * Create a new global store with custom action
      * The metadata object could be null if not needed
@@ -98,15 +96,15 @@ export declare class GlobalStore<TState, TMetadata = null, TStateSetter extends
      * The config object is used to define the callbacks that will be executed during the store lifecycle
      * The lifecycle callbacks are: onInit, onStateChanged, onSubscribed and computePreventStateChange
      * @param {TState} state - The initial state
-     * @param {TMetadata} metadata - The metadata object (optional) (default: null) no reactive information set to share with the subscribers
-     * @param {TStateSetter} setterConfig - The actions configuration object (optional) (default: null) if not null the store manipulation will be done through the actions
      * @param {GlobalStoreConfig<TState, TMetadata>} config - The configuration object (optional) (default: { metadata: null })
-     * @param {StateConfigCallbackParam<TState, TMetadata>} config.onInit - The callback to execute when the store is initialized (optional) (default: null)
-     * @param {StateConfigCallbackParam<TState, TMetadata>} config.onStateChanged - The callback to execute when the state is changed (optional) (default: null)
-     * @param {StateConfigCallbackParam<TState, TMetadata>} config.onSubscribed - The callback to execute when a subscriber is added (optional) (default: null)
-     * @param {StateConfigCallbackParam<TState, TMetadata>} config.computePreventStateChange - The callback to execute when the state is changed to compute if the state change should be prevented (optional) (default: null)
+     * @param {GlobalStoreConfig<TState, TMetadata>} config.metadata - The metadata object (optional) (default: null) if not null the metadata object will be reactive
+     * @param {GlobalStoreConfig<TState, TMetadata>} config.onInit - The callback to execute when the store is initialized (optional) (default: null)
+     * @param {GlobalStoreConfig<TState, TMetadata>} config.onStateChanged - The callback to execute when the state is changed (optional) (default: null)
+     * @param {GlobalStoreConfig<TState, TMetadata>} config.onSubscribed - The callback to execute when a new component gets subscribed to the store (optional) (default: null)
+     * @param {GlobalStoreConfig<TState, TMetadata>} config.computePreventStateChange - The callback to execute everytime a state change is triggered and before the state is updated, it allows to prevent the state change by returning true (optional) (default: null)
+     * @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, metadata: TMetadata, setterConfig: TStateSetter, config: GlobalStoreConfig<TState, TMetadata, TStateSetter>);
+    constructor(state: TState, config: GlobalStoreConfig<TState, TMetadata, TStateSetter>, setterConfig: TStateSetter);
     protected onInitializeStore: () => void;
     /**
      * gets a clone of the state

package/lib/GlobalStore.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"GlobalStore.d.ts","sourceRoot":"","sources":["../src/GlobalStore.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,QAAQ,EAAE,cAAc,EAAuB,MAAM,OAAO,CAAC;AAEtE,OAAO,EACL,sBAAsB,EACtB,WAAW,EACX,iBAAiB,EACjB,sBAAsB,EACtB,wBAAwB,EAEzB,MAAM,qBAAqB,CAAC;AAU7B,eAAO,MAAM,KAAK,kBAA6B,CAAC;AAChD,eAAO,MAAM,eAAe,oCAAuC,CAAC;AACpE,eAAO,MAAM,aAAa;;gDAAqC,CAAC;AAEhE;;;;;KAKK;AACL,qBAAa,WAAW,CACtB,MAAM,EACN,SAAS,GAAG,IAAI,EAChB,YAAY,SACR,sBAAsB,CAAC,MAAM,EAAE,SAAS,CAAC,GACzC,WAAW,CAAC,MAAM,CAAC,GACnB,IAAI,GAAG,WAAW,CAAC,MAAM,CAAC;IAuI5B,SAAS,CAAC,KAAK,EAAE,MAAM;IACvB,SAAS,CAAC,QAAQ,EAAE,SAAS;IAC7B,SAAS,CAAC,YAAY,EAAE,YAAY,GAAG,IAAI;IAC3C,SAAS,CAAC,MAAM,EAAE,iBAAiB,CAAC,MAAM,EAAE,SAAS,EAAE,YAAY,CAAC;IAxItE;;;SAGK;IACE,WAAW,EAAE,GAAG,CAAC,WAAW,CAAC,MAAM,CAAC,CAAC,CAAa;IAEzD;;;;;;;;;;SAUK;IACL,SAAS,CAAC,MAAM,CAAC,EAAE,iBAAiB,CAClC,MAAM,EACN,SAAS,EACT,YAAY,CACb,CAAC,QAAQ,CAAC,CAAQ;IAEnB;;;;;;;;;;SAUK;IACL,SAAS,CAAC,cAAc,CAAC,EAAE,iBAAiB,CAC1C,MAAM,EACN,SAAS,EACT,YAAY,CACb,CAAC,gBAAgB,CAAC,CAAQ;IAE3B;;;;;;;;;;SAUK;IACL,SAAS,CAAC,YAAY,CAAC,EAAE,iBAAiB,CACxC,MAAM,EACN,SAAS,EACT,YAAY,CACb,CAAC,cAAc,CAAC,CAAQ;IAEzB;;;;;;;;;;;SAWK;IACL,SAAS,CAAC,yBAAyB,CAAC,EAAE,iBAAiB,CACrD,MAAM,EACN,SAAS,EACT,YAAY,CACb,CAAC,2BAA2B,CAAC,CAAQ;IAEtC;;;SAGK;gBACO,KAAK,EAAE,MAAM;IAEzB;;;;;SAKK;gBACO,KAAK,EAAE,MAAM,EAAE,QAAQ,EAAE,SAAS;IAE9C;;;;;;;SAOK;gBACO,KAAK,EAAE,MAAM,EAAE,QAAQ,EAAE,SAAS,EAAE,YAAY,EAAE,YAAY;IAE1E;;;;;;;;;;;;;;SAcK;gBAEH,KAAK,EAAE,MAAM,EACb,QAAQ,EAAE,SAAS,EACnB,YAAY,EAAE,YAAY,EAC1B,MAAM,EAAE,iBAAiB,CAAC,MAAM,EAAE,SAAS,EAAE,YAAY,CAAC;IAuB5D,SAAS,CAAC,iBAAiB,aAUzB;IAEF;;;SAGK;IACL,SAAS,CAAC,aAAa,QAAO,MAAM,CACK;IAEzC;;;SAGK;IACL,SAAS,CAAC,gBAAgB,QAAO,SAAS,CACe;IAEzD;;;;SAIK;IACL,SAAS,CAAC,QAAQ;eAIT,MAAM;0BACK,cAAc,CAAC,oBAAoB,CAAC,MAAM,CAAC,CAAC;eAc9D;IAEF;;;SAGK;IACL,SAAS,CAAC,WAAW,EAAE,WAAW,CAAC,SAAS,CAAC,CAQ3C;IAEF;;;;;;SAMK;IACL,SAAS,CAAC,sBAAsB;0BAGZ,cAAc,CAAC,oBAAoB,CAAC,MAAM,CAAC,CAAC;UAC5D,yBAAyB,MAAM,EAAE,SAAS,EAAE,YAAY,CAAC,CAsB3D;IAEF;;;SAGK;IACE,OAAO,4JA8BZ;IAEF;;;SAGK;IACE,gBAAgB,eAMb,MAAM,kIAIN,SAAS,EAEjB;IAEF;;;;SAIK;IACL,SAAS,CAAC,kBAAkB;0BAGR,cAAc,CAAC,oBAAoB,CAAC,MAAM,CAAC,CAAC;UACvD,YAAY,MAAM,CAAC,CAM1B;IAEF;;;;SAIK;IACL,SAAS,CAAC,oBAAoB,CAC5B,eAAe,CAAC,EAAE,KAAK,CAAC,QAAQ,CAAC,KAAK,CAAC,cAAc,CAAC,MAAM,CAAC,CAAC;IAWhE;;;SAGK;IACL,SAAS,CAAC,iBAAiB,QAAO,OAAO,CAgBvC;IAEF;;;;;;OAMG;IACH,SAAS,CAAC,eAAe;gBAIf,YAAY,MAAM,CAAC;0BACT,cAAc,CAAC,oBAAoB,CAAC,MAAM,CAAC,CAAC;eAwD9D;IAEF;;;;SAIK;IACL,SAAS,CAAC,kBAAkB;0BAGR,cAAc,CAAC,oBAAoB,CAAC,MAAM,CAAC,CAAC;UAC5D,uBAAuB,MAAM,EAAE,SAAS,EAAE,YAAY,CAAC,CAgDzD;CACH;AAED,eAAe,WAAW,CAAC"}
+{"version":3,"file":"GlobalStore.d.ts","sourceRoot":"","sources":["../src/GlobalStore.ts"],"names":[],"mappings":"AAAA,cAAc,wBAAwB,CAAC;AAEvC,OAAO,EAAE,QAAQ,EAAE,cAAc,EAAuB,MAAM,OAAO,CAAC;AAEtE,OAAO,EACL,sBAAsB,EACtB,WAAW,EACX,iBAAiB,EACjB,sBAAsB,EACtB,wBAAwB,EAEzB,MAAM,qBAAqB,CAAC;AAU7B;;;;;KAKK;AACL,qBAAa,WAAW,CACtB,MAAM,EACN,SAAS,GAAG,IAAI,EAChB,YAAY,SACR,sBAAsB,CAAC,MAAM,EAAE,SAAS,CAAC,GACzC,WAAW,CAAC,MAAM,CAAC,GACnB,IAAI,GAAG,WAAW,CAAC,MAAM,CAAC;IA8I5B,SAAS,CAAC,KAAK,EAAE,MAAM;IAEvB,SAAS,CAAC,YAAY,EAAE,YAAY,GAAG,IAAI;IA9I7C;;;SAGK;IACE,WAAW,EAAE,GAAG,CAAC,WAAW,CAAC,MAAM,CAAC,CAAC,CAAa;IAEzD;;;;;;;;;;OAUG;IACH,SAAS,CAAC,MAAM,EAAE,iBAAiB,CAAC,MAAM,EAAE,SAAS,EAAE,YAAY,CAAC,CAElE;IAEF;;;;;;;;;;SAUK;IACL,SAAS,CAAC,MAAM,CAAC,EAAE,iBAAiB,CAClC,MAAM,EACN,SAAS,EACT,YAAY,CACb,CAAC,QAAQ,CAAC,CAAQ;IAEnB;;;;;;;;;;SAUK;IACL,SAAS,CAAC,cAAc,CAAC,EAAE,iBAAiB,CAC1C,MAAM,EACN,SAAS,EACT,YAAY,CACb,CAAC,gBAAgB,CAAC,CAAQ;IAE3B;;;;;;;;;;SAUK;IACL,SAAS,CAAC,YAAY,CAAC,EAAE,iBAAiB,CACxC,MAAM,EACN,SAAS,EACT,YAAY,CACb,CAAC,cAAc,CAAC,CAAQ;IAEzB;;;;;;;;;;;SAWK;IACL,SAAS,CAAC,yBAAyB,CAAC,EAAE,iBAAiB,CACrD,MAAM,EACN,SAAS,EACT,YAAY,CACb,CAAC,2BAA2B,CAAC,CAAQ;IAEtC;;;SAGK;gBACO,KAAK,EAAE,MAAM;IAEzB;;;;;;SAMK;gBAEH,KAAK,EAAE,MAAM,EACb,MAAM,EAAE,iBAAiB,CAAC,MAAM,EAAE,SAAS,EAAE,YAAY,CAAC;IAG5D;;;;;;;;;;;;;;SAcK;gBAEH,KAAK,EAAE,MAAM,EACb,MAAM,EAAE,iBAAiB,CAAC,MAAM,EAAE,SAAS,EAAE,YAAY,CAAC,EAC1D,YAAY,EAAE,YAAY;IA0B5B,SAAS,CAAC,iBAAiB,aAUzB;IAEF;;;SAGK;IACL,SAAS,CAAC,aAAa,QAAO,MAAM,CAAsB;IAE1D;;;SAGK;IACL,SAAS,CAAC,gBAAgB,QAAO,SAAS,CACU;IAEpD;;;;SAIK;IACL,SAAS,CAAC,QAAQ;eAIT,MAAM;0BACK,cAAc,CAAC,oBAAoB,CAAC,MAAM,CAAC,CAAC;eAc9D;IAEF;;;SAGK;IACL,SAAS,CAAC,WAAW,EAAE,WAAW,CAAC,SAAS,CAAC,CAW3C;IAEF;;;;;;SAMK;IACL,SAAS,CAAC,sBAAsB;0BAGZ,cAAc,CAAC,oBAAoB,CAAC,MAAM,CAAC,CAAC;UAC5D,yBAAyB,MAAM,EAAE,SAAS,EAAE,YAAY,CAAC,CAsB3D;IAEF;;;SAGK;IACE,OAAO,4JA8BZ;IAEF;;;SAGK;IACE,gBAAgB,eAMb,MAAM,kIAIN,SAAS,EAEjB;IAEF;;;;SAIK;IACL,SAAS,CAAC,kBAAkB;0BAGR,cAAc,CAAC,oBAAoB,CAAC,MAAM,CAAC,CAAC;UACvD,YAAY,MAAM,CAAC,CAM1B;IAEF;;;;SAIK;IACL,SAAS,CAAC,oBAAoB,CAC5B,eAAe,CAAC,EAAE,KAAK,CAAC,QAAQ,CAAC,KAAK,CAAC,cAAc,CAAC,MAAM,CAAC,CAAC;IAWhE;;;SAGK;IACL,SAAS,CAAC,iBAAiB,QAAO,OAAO,CAgBvC;IAEF;;;;;;OAMG;IACH,SAAS,CAAC,eAAe;gBAIf,YAAY,MAAM,CAAC;0BACT,cAAc,CAAC,oBAAoB,CAAC,MAAM,CAAC,CAAC;eAwD9D;IAEF;;;;SAIK;IACL,SAAS,CAAC,kBAAkB;0BAGR,cAAc,CAAC,oBAAoB,CAAC,MAAM,CAAC,CAAC;UAC5D,uBAAuB,MAAM,EAAE,SAAS,EAAE,YAAY,CAAC,CAgDzD;CACH;AAED,eAAe,WAAW,CAAC"}

package/lib/GlobalStore.js

@@ -1,9 +1,9 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.GlobalStore = exports.formatToStore = exports.formatFromStore = exports.clone = void 0;
+exports.GlobalStore = void 0;
 const tslib_1 = require("tslib");
-// jsonStorageFormatter
-const jsonStorageFormatter = tslib_1.__importStar(require("json-storage-formatter"));
+tslib_1.__exportStar(require("json-storage-formatter"), exports);
+const json_storage_formatter_1 = require("json-storage-formatter");
 const react_1 = require("react");
 const throwWrongKeyOnActionCollectionConfig = (action_key) => {
     throw new Error(`[WRONG CONFIGURATION!]: Every key inside the storeActionsConfig must be a higher order function that returns a function \n[${action_key}]: key is not a valid function, try something like this: \n{\n
@@ -12,9 +12,6 @@ const throwWrongKeyOnActionCollectionConfig = (action_key) => {
     }\n
 }\n`);
 };
-exports.clone = jsonStorageFormatter.clone;
-exports.formatFromStore = jsonStorageFormatter.formatFromStore;
-exports.formatToStore = jsonStorageFormatter.formatToStore;
 /**
  * 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
@@ -25,24 +22,35 @@ class GlobalStore {
     /**
      * Create a new instance of the GlobalStore
      * @param {TState} state - The initial state
-     * @param {TMetadata} metadata - The metadata object (optional) (default: null) no reactive information set to share with the subscribers
-     * @param {TStateSetter} setterConfig - The actions configuration object (optional) (default: null) if not null the store manipulation will be done through the actions
      * @param {GlobalStoreConfig<TState, TMetadata>} config - The configuration object (optional) (default: { metadata: null })
-     * @param {StateConfigCallbackParam<TState, TMetadata>} config.onInit - The callback to execute when the store is initialized (optional) (default: null)
-     * @param {StateConfigCallbackParam<TState, TMetadata>} config.onStateChanged - The callback to execute when the state is changed (optional) (default: null)
-     * @param {StateConfigCallbackParam<TState, TMetadata>} config.onSubscribed - The callback to execute when a subscriber is added (optional) (default: null)
-     * @param {StateConfigCallbackParam<TState, TMetadata>} config.computePreventStateChange - The callback to execute when the state is changed to compute if the state change should be prevented (optional) (default: null)
+     * @param {GlobalStoreConfig<TState, TMetadata>} config.metadata - The metadata object (optional) (default: null) if not null the metadata object will be reactive
+     * @param {GlobalStoreConfig<TState, TMetadata>} config.onInit - The callback to execute when the store is initialized (optional) (default: null)
+     * @param {GlobalStoreConfig<TState, TMetadata>} config.onStateChanged - The callback to execute when the state is changed (optional) (default: null)
+     * @param {GlobalStoreConfig<TState, TMetadata>} config.onSubscribed - The callback to execute when a new component gets subscribed to the store (optional) (default: null)
+     * @param {GlobalStoreConfig<TState, TMetadata>} config.computePreventStateChange - The callback to execute everytime a state change is triggered and before the state is updated, it allows to prevent the state change by returning true (optional) (default: null)   * @param {TStateSetter} setterConfig - The actions configuration object (optional) (default: null) if not null the store manipulation will be done through the actions
      * */
-    constructor(state, metadata = null, setterConfig = null, config = {}) {
+    constructor(state, config = {}, setterConfig = null) {
         this.state = state;
-        this.metadata = metadata;
         this.setterConfig = setterConfig;
-        this.config = config;
         /**
          * list of all the subscribers setState functions
          * @template {TState} TState - The type of the state object
          * */
         this.subscribers = new Set();
+        /**
+         * additional configuration for the store
+         * @template {TState} TState - The type of the state object
+         * @template {TMetadata} TMetadata - The type of the metadata object (optional) (default: null) no reactive information set to share with the subscribers
+         * @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
+         * @property {GlobalStoreConfig<TState, TMetadata, TStateSetter>} config.metadata - The metadata to pass to the callbacks (optional) (default: null)
+         * @property {GlobalStoreConfig<TState, TMetadata, TStateSetter>} config.onInit - The callback to execute when the store is initialized (optional) (default: null)
+         * @property {GlobalStoreConfig<TState, TMetadata, TStateSetter>} config.onStateChanged - The callback to execute when the state is changed (optional) (default: null)
+         * @property {GlobalStoreConfig<TState, TMetadata, TStateSetter>} config.onSubscribed - The callback to execute when a component is subscribed to the store (optional) (default: null)
+         * @property {GlobalStoreConfig<TState, TMetadata, TStateSetter>} config.computePreventStateChange - The callback to execute when the state is changed to compute if the state change should be prevented (optional) (default: null)
+         */
+        this.config = {
+            metadata: null,
+        };
         /**
          * execute once the store is created
          * @template {TState} TState - The type of the state object
@@ -105,12 +113,12 @@ class GlobalStore {
          * gets a clone of the state
          * @returns {TState} - The state clone
          * */
-        this.getStateClone = () => jsonStorageFormatter.clone(this.state);
+        this.getStateClone = () => (0, json_storage_formatter_1.clone)(this.state);
         /**
          * gets a clone of the metadata
          * @returns {TMetadata} - The metadata clone
          * */
-        this.getMetadataClone = () => jsonStorageFormatter.clone(this.metadata);
+        this.getMetadataClone = () => { var _a, _b; return (0, json_storage_formatter_1.clone)((_b = (_a = this.config) === null || _a === void 0 ? void 0 : _a.metadata) !== null && _b !== void 0 ? _b : null); };
         /**
          * set the state and update all the subscribers
          * @param {StateSetter<TState>} setter - The setter function or the value to set
@@ -133,11 +141,12 @@ class GlobalStore {
          * @param {StateSetter<TMetadata>} setter - The setter function or the value to set
          * */
         this.setMetadata = (setter) => {
+            var _a;
             const isSetterFunction = typeof setter === 'function';
             const metadata = isSetterFunction
                 ? setter(this.getMetadataClone())
                 : setter;
-            this.metadata = metadata;
+            this.config = Object.assign(Object.assign({}, ((_a = this.config) !== null && _a !== void 0 ? _a : {})), { metadata });
         };
         /**
          * get the parameters object to pass to the callback functions (onInit, onStateChanged, onSubscribed, computePreventStateChange)
@@ -295,6 +304,7 @@ class GlobalStore {
                 } })), {});
             return actions;
         };
+        this.config = Object.assign({ metadata: null }, (config !== null && config !== void 0 ? config : {}));
         this.onInitializeStore();
     }
     /**

package/lib/GlobalStore.types.d.ts

@@ -100,9 +100,10 @@ export type StateChangesParam<TState, TMetadata, TStateSetter extends ActionColl
  * @template {ActionCollectionConfig<TState,TMetadata> | null} TStateSetter - the configuration of the API (optional) - if you don't pass an API as a parameter, you can pass null
  * */
 export type GlobalStoreConfig<TState, TMetadata, TStateSetter extends ActionCollectionConfig<TState, TMetadata> | StateSetter<TState> = StateSetter<TState>> = {
+    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;
-};
+} | null;
 //# sourceMappingURL=GlobalStore.types.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"GlobalStore.types.d.ts","sourceRoot":"","sources":["../src/GlobalStore.types.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,MAAM,MAAM,WAAW,CAAC,MAAM,IAAI,CAChC,MAAM,EAAE,MAAM,GAAG,CAAC,CAAC,KAAK,EAAE,MAAM,KAAK,MAAM,CAAC,KACzC,IAAI,CAAC;AAEV;;;;IAII;AACJ,MAAM,MAAM,YAAY,CAAC,MAAM,IAAI;IACjC,KAAK,EAAE,MAAM,CAAC;IACd,aAAa,CAAC,EAAE,MAAM,CAAC;CACxB,CAAC;AAEF;;;;;;;;IAQI;AACJ,MAAM,MAAM,UAAU,CAAC,MAAM,EAAE,SAAS,GAAG,IAAI,IAAI;IACjD,WAAW,EAAE,WAAW,CAAC,SAAS,CAAC,CAAC;IACpC,QAAQ,EAAE,WAAW,CAAC,MAAM,CAAC,CAAC;IAC9B,QAAQ,EAAE,MAAM,MAAM,CAAC;IACvB,WAAW,EAAE,MAAM,SAAS,CAAC;CAC9B,CAAC;AAEF;;;;;;;GAOG;AACH,MAAM,WAAW,sBAAsB,CAAC,MAAM,EAAE,SAAS;IACvD,CAAC,GAAG,EAAE,MAAM,GAAG,CACb,GAAG,UAAU,EAAE,GAAG,EAAE,KACjB,CAAC,UAAU,EAAE,UAAU,CAAC,MAAM,EAAE,SAAS,CAAC,KAAK,OAAO,GAAG,IAAI,CAAC;CACpE;AAED;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,MAAM,MAAM,sBAAsB,CAChC,MAAM,EACN,SAAS,EACT,YAAY,SACR,sBAAsB,CAAC,MAAM,EAAE,SAAS,CAAC,GACzC,WAAW,CAAC,MAAM,CAAC,GAAG,WAAW,CAAC,MAAM,CAAC,IAC3C,YAAY,SAAS,sBAAsB,CAAC,MAAM,EAAE,SAAS,CAAC,GAC9D;KACG,GAAG,IAAI,MAAM,YAAY,GAAG,CAC3B,GAAG,MAAM,EAAE,UAAU,CAAC,YAAY,CAAC,GAAG,CAAC,CAAC,KACrC,UAAU,CAAC,UAAU,CAAC,YAAY,CAAC,GAAG,CAAC,CAAC,CAAC;CAC/C,GACD,IAAI,CAAC;AAET;;;;;;;;;;;KAWK;AACL,MAAM,MAAM,wBAAwB,CAClC,MAAM,EACN,SAAS,EACT,YAAY,SACR,sBAAsB,CAAC,MAAM,EAAE,SAAS,CAAC,GACzC,WAAW,CAAC,MAAM,CAAC,GAAG,WAAW,CAAC,MAAM,CAAC,IAC3C;IACF,OAAO,EAAE,YAAY,SAAS,sBAAsB,CAAC,MAAM,EAAE,SAAS,CAAC,GACnE,sBAAsB,CAAC,MAAM,EAAE,SAAS,EAAE,YAAY,CAAC,GACvD,IAAI,CAAC;CACV,GAAG,UAAU,CAAC,MAAM,EAAE,SAAS,CAAC,CAAC;AAElC;;;;;GAKG;AACH,MAAM,MAAM,iBAAiB,CAC3B,MAAM,EACN,SAAS,EACT,YAAY,SACR,sBAAsB,CAAC,MAAM,EAAE,SAAS,CAAC,GACzC,WAAW,CAAC,MAAM,CAAC,GAAG,WAAW,CAAC,MAAM,CAAC,IAC3C,wBAAwB,CAAC,MAAM,EAAE,SAAS,EAAE,YAAY,CAAC,GAC3D,YAAY,CAAC,MAAM,CAAC,CAAC;AAEvB;;;;;;;;;KASK;AACL,MAAM,MAAM,iBAAiB,CAC3B,MAAM,EACN,SAAS,EACT,YAAY,SACR,sBAAsB,CAAC,MAAM,EAAE,SAAS,CAAC,GACzC,WAAW,CAAC,MAAM,CAAC,GAAG,WAAW,CAAC,MAAM,CAAC,IAC3C;IACF,MAAM,CAAC,EAAE,CACP,UAAU,EAAE,wBAAwB,CAAC,MAAM,EAAE,SAAS,EAAE,YAAY,CAAC,KAClE,IAAI,CAAC;IAEV,cAAc,CAAC,EAAE,CACf,UAAU,EAAE,iBAAiB,CAAC,MAAM,EAAE,SAAS,EAAE,YAAY,CAAC,KAC3D,IAAI,CAAC;IAEV,YAAY,CAAC,EAAE,CACb,UAAU,EAAE,wBAAwB,CAAC,MAAM,EAAE,SAAS,EAAE,YAAY,CAAC,KAClE,IAAI,CAAC;IAEV,yBAAyB,CAAC,EAAE,CAC1B,UAAU,EAAE,iBAAiB,CAAC,MAAM,EAAE,SAAS,EAAE,YAAY,CAAC,KAC3D,OAAO,CAAC;CACd,CAAC"}
+{"version":3,"file":"GlobalStore.types.d.ts","sourceRoot":"","sources":["../src/GlobalStore.types.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,MAAM,MAAM,WAAW,CAAC,MAAM,IAAI,CAChC,MAAM,EAAE,MAAM,GAAG,CAAC,CAAC,KAAK,EAAE,MAAM,KAAK,MAAM,CAAC,KACzC,IAAI,CAAC;AAEV;;;;IAII;AACJ,MAAM,MAAM,YAAY,CAAC,MAAM,IAAI;IACjC,KAAK,EAAE,MAAM,CAAC;IACd,aAAa,CAAC,EAAE,MAAM,CAAC;CACxB,CAAC;AAEF;;;;;;;;IAQI;AACJ,MAAM,MAAM,UAAU,CAAC,MAAM,EAAE,SAAS,GAAG,IAAI,IAAI;IACjD,WAAW,EAAE,WAAW,CAAC,SAAS,CAAC,CAAC;IACpC,QAAQ,EAAE,WAAW,CAAC,MAAM,CAAC,CAAC;IAC9B,QAAQ,EAAE,MAAM,MAAM,CAAC;IACvB,WAAW,EAAE,MAAM,SAAS,CAAC;CAC9B,CAAC;AAEF;;;;;;;GAOG;AACH,MAAM,WAAW,sBAAsB,CAAC,MAAM,EAAE,SAAS;IACvD,CAAC,GAAG,EAAE,MAAM,GAAG,CACb,GAAG,UAAU,EAAE,GAAG,EAAE,KACjB,CAAC,UAAU,EAAE,UAAU,CAAC,MAAM,EAAE,SAAS,CAAC,KAAK,OAAO,GAAG,IAAI,CAAC;CACpE;AAED;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,MAAM,MAAM,sBAAsB,CAChC,MAAM,EACN,SAAS,EACT,YAAY,SACR,sBAAsB,CAAC,MAAM,EAAE,SAAS,CAAC,GACzC,WAAW,CAAC,MAAM,CAAC,GAAG,WAAW,CAAC,MAAM,CAAC,IAC3C,YAAY,SAAS,sBAAsB,CAAC,MAAM,EAAE,SAAS,CAAC,GAC9D;KACG,GAAG,IAAI,MAAM,YAAY,GAAG,CAC3B,GAAG,MAAM,EAAE,UAAU,CAAC,YAAY,CAAC,GAAG,CAAC,CAAC,KACrC,UAAU,CAAC,UAAU,CAAC,YAAY,CAAC,GAAG,CAAC,CAAC,CAAC;CAC/C,GACD,IAAI,CAAC;AAET;;;;;;;;;;;KAWK;AACL,MAAM,MAAM,wBAAwB,CAClC,MAAM,EACN,SAAS,EACT,YAAY,SACR,sBAAsB,CAAC,MAAM,EAAE,SAAS,CAAC,GACzC,WAAW,CAAC,MAAM,CAAC,GAAG,WAAW,CAAC,MAAM,CAAC,IAC3C;IACF,OAAO,EAAE,YAAY,SAAS,sBAAsB,CAAC,MAAM,EAAE,SAAS,CAAC,GACnE,sBAAsB,CAAC,MAAM,EAAE,SAAS,EAAE,YAAY,CAAC,GACvD,IAAI,CAAC;CACV,GAAG,UAAU,CAAC,MAAM,EAAE,SAAS,CAAC,CAAC;AAElC;;;;;GAKG;AACH,MAAM,MAAM,iBAAiB,CAC3B,MAAM,EACN,SAAS,EACT,YAAY,SACR,sBAAsB,CAAC,MAAM,EAAE,SAAS,CAAC,GACzC,WAAW,CAAC,MAAM,CAAC,GAAG,WAAW,CAAC,MAAM,CAAC,IAC3C,wBAAwB,CAAC,MAAM,EAAE,SAAS,EAAE,YAAY,CAAC,GAC3D,YAAY,CAAC,MAAM,CAAC,CAAC;AAEvB;;;;;;;;;KASK;AACL,MAAM,MAAM,iBAAiB,CAC3B,MAAM,EACN,SAAS,EACT,YAAY,SACR,sBAAsB,CAAC,MAAM,EAAE,SAAS,CAAC,GACzC,WAAW,CAAC,MAAM,CAAC,GAAG,WAAW,CAAC,MAAM,CAAC,IAC3C;IACF,QAAQ,CAAC,EAAE,SAAS,CAAC;IAErB,MAAM,CAAC,EAAE,CACP,UAAU,EAAE,wBAAwB,CAAC,MAAM,EAAE,SAAS,EAAE,YAAY,CAAC,KAClE,IAAI,CAAC;IAEV,cAAc,CAAC,EAAE,CACf,UAAU,EAAE,iBAAiB,CAAC,MAAM,EAAE,SAAS,EAAE,YAAY,CAAC,KAC3D,IAAI,CAAC;IAEV,YAAY,CAAC,EAAE,CACb,UAAU,EAAE,wBAAwB,CAAC,MAAM,EAAE,SAAS,EAAE,YAAY,CAAC,KAClE,IAAI,CAAC;IAEV,yBAAyB,CAAC,EAAE,CAC1B,UAAU,EAAE,iBAAiB,CAAC,MAAM,EAAE,SAAS,EAAE,YAAY,CAAC,KAC3D,OAAO,CAAC;CACd,GAAG,IAAI,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "react-native-global-state-hooks",
-  "version": "2.1.5",
+  "version": "2.1.7",
   "description": "This is a package to easily handling global-state across your react-native-components No-redux",
   "main": "lib/GlobalStore.js",
   "files": [