react-native-global-state-hooks 5.0.4 → 5.0.6

package/lib/{GlobalStore.d.ts → src/GlobalStore.d.ts}

@@ -1,4 +1,4 @@
-import { ActionCollectionConfig, StateSetter, GlobalStoreConfig, ActionCollectionResult, StateConfigCallbackParam, MetadataSetter, UseHookConfig, StateGetter, SubscribeCallbackConfig, SubscribeCallback, SelectorCallback, SetStateCallback, SubscriberParameters, SubscriptionCallback } from "./GlobalStore.types";
+import { ActionCollectionConfig, StateSetter, GlobalStoreConfig, ActionCollectionResult, StateConfigCallbackParam, MetadataSetter, UseHookConfig, StateGetter, SubscribeCallbackConfig, SubscribeCallback, SelectorCallback, SetStateCallback, SubscriberParameters, SubscriptionCallback, MetadataGetter } from "./GlobalStore.types";
 export declare const throwNoSubscribersWereAdded: () => never;
 /**
  * The GlobalStore class is the main class of the library and it is used to create a GlobalStore instances
@@ -177,7 +177,7 @@ export declare class GlobalStore<TState, TMetadata = null, TStateSetter extends
      * Returns an array with the a function to get the state, the state setter or the actions map, and a function to get the metadata
      * @returns {[() => TState, TStateSetter, () => TMetadata]} - The state getter, the state setter or the actions map, the metadata getter
      * */
-    getHookDecoupled: () => [getter: StateGetter<TState>, setter: keyof TStateSetter extends never ? StateSetter<TState> : ActionCollectionResult<TState, TMetadata, TStateSetter>, metadata: () => TMetadata];
+    getHookDecoupled: () => [StateGetter<TState>, keyof TStateSetter extends never ? StateSetter<TState> : ActionCollectionResult<TState, TMetadata, TStateSetter>, MetadataGetter<TMetadata>];
     /**
      * returns a wrapper for the setState function that will update the state and all the subscribers
      * @param {{ invokerSetState?: SetStateCallback }} 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

package/lib/{GlobalStore.functionHooks.d.ts → src/GlobalStore.functionHooks.d.ts}

@@ -1,19 +1,11 @@
 import { ActionCollectionConfig, StateSetter, ActionCollectionResult, UseHookConfig, AvoidNever, UnsubscribeCallback, StateHook, StateGetter, createStateConfig, CustomGlobalHookBuilderParams, CustomGlobalHookParams, SelectorCallback, SubscribeToEmitter } from "./GlobalStore.types";
 /**
- * Creates a global hook that can be used to access the state and actions across the application
- * @param {TState} state - The initial state
- * @param {{ config?: GlobalStoreConfig<TState, TMetadata, TStateSetter>; actionsConfig?: TStateSetter | null }} parameters - The configuration object (optional) (default: null)
- * @param {GlobalStoreConfig<TState, TMetadata, TStateSetter>} parameters.config - The configuration object
- * @param {TStateSetter | null} parameters.actionsConfig - The setter configuration object (optional) (default: null)
+ * Creates a global state with the given state and config.
  * @returns {} [HOOK, DECOUPLED_GETTER, DECOUPLED_SETTER] this is an array with the hook, the decoupled getState function and the decoupled setter of the state
  */
-export declare const createGlobalStateWithDecoupledFuncs: <TState, TMetadata = null, TActions extends ActionCollectionConfig<TState, TMetadata> = null>(state: TState, { actions, ...config }?: createStateConfig<TState, TMetadata, TActions>) => [hook: StateHook<TState, keyof TActions extends never ? StateSetter<TState> : ActionCollectionResult<TState, TMetadata, TActions>, TMetadata>, getter: StateGetter<TState>, setter: keyof TActions extends never ? StateSetter<TState> : ActionCollectionResult<TState, TMetadata, TActions>];
+export declare const createGlobalStateWithDecoupledFuncs: <TState, TMetadata = null, TActions extends ActionCollectionConfig<TState, TMetadata> = null>(state: TState, { actions, ...config }?: createStateConfig<TState, TMetadata, TActions>) => [StateHook<TState, keyof TActions extends never ? StateSetter<TState> : ActionCollectionResult<TState, TMetadata, TActions>, TMetadata>, StateGetter<TState>, keyof TActions extends never ? StateSetter<TState> : ActionCollectionResult<TState, TMetadata, TActions>];
 /**
  * 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 {{ config?: GlobalStoreConfig<TState, TMetadata, TStateSetter>; actionsConfig?: TStateSetter | null }} parameters - The configuration object of the store and the configuration object of the state setter (optional) (default: null)
- * @param {GlobalStoreConfig<TState, TMetadata, TStateSetter>} parameters.config - The configuration object of the store
- * @param {TStateSetter | null} parameters.actionsConfig - The configuration object of the state setter (optional) (default: null)
  * @returns {} - () => [TState, Setter, TMetadata] the hook that can be used to access the state and the setter of the state
  */
 export declare const createGlobalState: <TState, TMetadata = null, TActions extends ActionCollectionConfig<TState, TMetadata> = null>(state: TState, config?: createStateConfig<TState, TMetadata, TActions>) => StateHook<TState, keyof TActions extends never ? StateSetter<TState> : ActionCollectionResult<TState, TMetadata, TActions>, TMetadata>;
@@ -22,7 +14,7 @@ export declare const createGlobalState: <TState, TMetadata = null, TActions exte
  * Use this function to create a custom global store.
  * You can use this function to create a store with async storage.
  */
-export declare const createCustomGlobalStateWithDecoupledFuncs: <TInheritMetadata = null, TCustomConfig = null>({ onInitialize, onChange, }: CustomGlobalHookBuilderParams<TInheritMetadata, TCustomConfig>) => <TState, TMetadata = null, TActions extends ActionCollectionConfig<TState, AvoidNever<TInheritMetadata> & AvoidNever<TMetadata>> = null>(state: TState, { config: customConfig, onInit, onStateChanged, ...parameters }?: CustomGlobalHookParams<TCustomConfig, TState, AvoidNever<TInheritMetadata> & AvoidNever<TMetadata>, TActions>) => [hook: StateHook<TState, keyof TActions extends never ? StateSetter<TState> : ActionCollectionResult<TState, AvoidNever<TInheritMetadata> & AvoidNever<TMetadata>, TActions>, AvoidNever<TInheritMetadata> & AvoidNever<TMetadata>>, getter: StateGetter<TState>, setter: keyof TActions extends never ? StateSetter<TState> : ActionCollectionResult<TState, AvoidNever<TInheritMetadata> & AvoidNever<TMetadata>, TActions>];
+export declare const createCustomGlobalStateWithDecoupledFuncs: <TInheritMetadata = null, TCustomConfig = null>({ onInitialize, onChange, }: CustomGlobalHookBuilderParams<TInheritMetadata, TCustomConfig>) => <TState, TMetadata = null, TActions extends ActionCollectionConfig<TState, AvoidNever<TInheritMetadata> & AvoidNever<TMetadata>> = null>(state: TState, { config: customConfig, onInit, onStateChanged, ...parameters }?: CustomGlobalHookParams<TCustomConfig, TState, AvoidNever<TInheritMetadata> & AvoidNever<TMetadata>, TActions>) => [StateHook<TState, keyof TActions extends never ? StateSetter<TState> : ActionCollectionResult<TState, AvoidNever<TInheritMetadata> & AvoidNever<TMetadata>, TActions>, AvoidNever<TInheritMetadata> & AvoidNever<TMetadata>>, StateGetter<TState>, keyof TActions extends never ? StateSetter<TState> : ActionCollectionResult<TState, AvoidNever<TInheritMetadata> & AvoidNever<TMetadata>, TActions>];
 /**
  * @description
  * Use this function to create a custom global hook which contains a fragment of the state of another hook or a fragment

package/lib/{GlobalStore.types.d.ts → src/GlobalStore.types.d.ts}

@@ -236,10 +236,14 @@ export type StateGetter<TState> = <Subscription extends Subscribe | false = fals
  * use the methods subscribe and subscribeSelect to subscribe to the store changes
  */
 callback?: Subscription extends Subscribe ? SubscriberCallback<TState> : null) => Subscription extends Subscribe ? UnsubscribeCallback : TState;
+export type MetadataGetter<TMetadata> = () => TMetadata;
 /**
  * Constant value type to indicate that the getter is a subscription
  */
 export type Subscribe = true;
+/**
+ * Configuration of the state (optional) - if you don't need to use the state configuration you don't need to pass this parameter
+ */
 export type createStateConfig<TState, TMetadata, TActions extends ActionCollectionConfig<TState, TMetadata> | null = null> = {
     /**
      * @description
@@ -259,6 +263,10 @@ export type CustomGlobalHookBuilderParams<TInheritMetadata = null, TCustomConfig
      */
     onChange: ({ setState, setMetadata, getMetadata, getState, actions, }: StateChangesParam<any, TInheritMetadata>, config: TCustomConfig) => void;
 };
+/**
+ * @description
+ * Configuration of the custom global hook
+ */
 export type CustomGlobalHookParams<TCustomConfig, TState, TMetadata, TActions extends ActionCollectionConfig<TState, TMetadata> | null> = {
     /**
      * @description

package/package.json

@@ -1,9 +1,9 @@
 {
   "name": "react-native-global-state-hooks",
-  "version": "5.0.4",
+  "version": "5.0.6",
   "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",
+  "types": "lib/src/index.d.ts",
   "files": [
     "lib"
   ],