react-native-global-state-hooks 7.0.2 → 8.0.0

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

@@ -1,6 +0,0 @@
-import { TMetadataResult } from "GlobalStore.types";
-import React from "react";
-import { ActionCollectionConfig, createStateConfig, StateHook, StateSetter, ActionCollectionResult, StateGetter } from "react-hooks-global-states";
-export declare const createStatefulContext: <TState, TMetadata = null, TActions extends ActionCollectionConfig<TState, TMetadata> = null>(initialValue: TState, parameters?: createStateConfig<TState, TMetadata, TActions>) => readonly [() => [hook: StateHook<TState, keyof TActions extends never ? StateSetter<TState> : ActionCollectionResult<TState, TMetadataResult<TMetadata>, TActions>, TMetadataResult<TMetadata>>, stateRetriever: StateGetter<TState>, stateMutator: keyof TActions extends never ? StateSetter<TState> : ActionCollectionResult<TState, TMetadata, TActions>], React.FC<React.PropsWithChildren<{
-    initialValue?: Partial<TState>;
-}>>];

package/lib/src/GlobalStore.d.ts

@@ -1,28 +0,0 @@
-import * as GlobalStoreBase from "react-hooks-global-states";
-import { GlobalStoreConfig, StateChangesParam, TMetadataResult, ActionCollectionConfig, ActionCollectionResult } from "./GlobalStore.types";
-import { GlobalStoreAbstract, MetadataGetter, StateGetter, StateSetter } from "react-hooks-global-states";
-export declare class GlobalStore<TState, TMetadata = null, TStateSetter extends ActionCollectionConfig<TState, TMetadata> | StateSetter<TState> = StateSetter<TState>> extends GlobalStoreAbstract<TState, TMetadata, NonNullable<TStateSetter>> {
-    protected config: GlobalStoreConfig<TState, TMetadata, TStateSetter>;
-    constructor(state: TState, config?: GlobalStoreConfig<TState, TMetadata, TStateSetter>, actionsConfig?: TStateSetter | null);
-    protected getMetadata: () => TMetadata | TMetadataResult<TMetadata>;
-    /**
-     * 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: () => [
-        StateGetter<TState>,
-        keyof TStateSetter extends never ? StateSetter<TState> : ActionCollectionResult<TState, TMetadata, TStateSetter>,
-        MetadataGetter<TMetadataResult<TMetadata>>
-    ];
-    /**
-     * Returns a custom hook that allows to handle a global state
-     * @returns {[TState, TStateSetter, TMetadata]} - The state, the state setter or the actions map, the metadata
-     * */
-    getHook: () => () => [
-        state: TState,
-        stateMutator: keyof TStateSetter extends never ? StateSetter<TState> : ActionCollectionResult<TState, TMetadata, TStateSetter>,
-        metadata: MetadataGetter<TMetadataResult<TMetadata>>
-    ];
-    protected onInitialize: ({ setState, getState, setMetadata, }: GlobalStoreBase.StateConfigCallbackParam<TState, TMetadata>) => void;
-    protected onChange: ({ getState, }: StateChangesParam<TState, TMetadata, TStateSetter>) => void;
-}

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

@@ -1,19 +0,0 @@
-import * as GlobalStoreBase from "react-hooks-global-states";
-import { createStateConfig, CustomGlobalHookParams, TMetadataResult, ActionCollectionConfig, ActionCollectionResult } from "./GlobalStore.types";
-import { AvoidNever, CustomGlobalHookBuilderParams } from "react-hooks-global-states";
-/**
- * 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: GlobalStoreBase.StateHook<TState, keyof TActions extends never ? GlobalStoreBase.StateSetter<TState> : ActionCollectionResult<TState, TMetadata, TActions>, TMetadataResult<TMetadata>>, stateRetriever: GlobalStoreBase.StateGetter<TState>, stateMutator: keyof TActions extends never ? GlobalStoreBase.StateSetter<TState> : ActionCollectionResult<TState, TMetadata, TActions>];
-/**
- * Creates a global hook that can be used to access the state and actions across the application
- * @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>) => GlobalStoreBase.StateHook<TState, keyof TActions extends never ? GlobalStoreBase.StateSetter<TState> : ActionCollectionResult<TState, TMetadata, TActions>, TMetadataResult<TMetadata>>;
-/**
- * @description
- * 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 extends Record<string, unknown>, TCustomConfig extends Record<string, unknown>>({ onInitialize, onChange, }: GlobalStoreBase.CustomGlobalHookBuilderParams<GlobalStoreBase.AvoidNever<TInheritMetadata>, GlobalStoreBase.AvoidNever<TCustomConfig>>) => <TState, TMetadata = null, TActions extends ActionCollectionConfig<TState, TMetadata> = null>(state: TState, { config: customConfig, onInit, onStateChanged, ...parameters }?: GlobalStoreBase.CustomGlobalHookParams<TCustomConfig, TState, TMetadata, TActions>) => [hook: GlobalStoreBase.StateHook<TState, keyof TActions extends never ? GlobalStoreBase.StateSetter<TState> : ActionCollectionResult<TState, TMetadata, TActions>, TMetadataResult<TMetadata>>, stateRetriever: GlobalStoreBase.StateGetter<TState>, stateMutator: keyof TActions extends never ? GlobalStoreBase.StateSetter<TState> : ActionCollectionResult<TState, TMetadata, TActions>];

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

@@ -1,124 +0,0 @@
-import * as GlobalStoreBase from "react-hooks-global-states";
-import { MetadataSetter, StateSetter } from "react-hooks-global-states";
-/**
- * Configuration of the async storage (optional)
- */
-export type AsyncStorageConfig = {
-    /**
-     * async storage configuration
-     */
-    asyncStorage?: {
-        /**
-         * The key of the async storage
-         */
-        key?: string;
-        /**
-         * The function used to encrypt the async storage, it can be a custom function or a boolean value (true = atob)
-         */
-        encrypt?: boolean | ((value: string) => string);
-        /**
-         * The function used to decrypt the async storage, it can be a custom function or a boolean value (true = atob)
-         */
-        decrypt?: boolean | ((value: string) => string);
-    };
-};
-export type TMetadataResult<TMetadata = null> = {
-    isAsyncStorageReady?: boolean;
-    asyncStorageKey?: string;
-} & Omit<NonNullable<TMetadata>, "isAsyncStorageReady" | "asyncStorageKey">;
-/**
- * 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 = any, TMetadata = any, TActions = any> = Omit<GlobalStoreBase.StoreTools<TState, TMetadata, TActions>, "getMetadata" | "setMetadata"> & {
-    getMetadata: () => TMetadataResult<TMetadata>;
-    setMetadata: MetadataSetter<TMetadataResult<TMetadata>> | MetadataSetter<TMetadata>;
-};
-/**
- * Basic contract for the storeActionsConfig configuration
- * @template {TState} TState - The state type
- * @template {TMetadata} TMetadata - The metadata type
- * @property {string} key - The action name
- * @property {(...parameters: unknown[]) => (storeTools: { setMetadata: MetadataSetter<TMetadata>; setState: StateSetter<TState>; getState: () => TState; getMetadata: () => TMetadata; }) => unknown | void} value - The action function
- * @returns {ActionCollectionConfig<TState, TMetadata>} result - The action collection configuration
- */
-export interface ActionCollectionConfig<TState, TMetadata = null> {
-    [key: string]: (...parameters: any[]) => (storeTools: any) => unknown | void;
-}
-/**
- * This is the actions object returned by the hook when you pass an storeActionsConfig configuration
- * if you pass an storeActionsConfig configuration, the hook will return an object with the actions
- * whatever data manipulation of the state should be executed through the custom actions with as access to the state and metadata
- * @template {TState} TState - The state type
- * @template {TMetadata} TMetadata - The metadata type
- * @template {TStateSetter} TStateSetter - The storeActionsConfig type (optional) - if you pass an storeActionsConfig the hook will return an object with the actions
- *
- * @example
- *
- * const store = new GlobalStore(0, {
- *  increment: () => ({ setState }) => {
- *    setState((state) => state + 1);
- *  },
- *  decrement: () => ({ setState }) => {
- *    setState((state) => state - 1);
- *  },
- * });
- *
- * const [state, actions] = store.getHook();
- *
- * actions.increment();
- * actions.decrement();
- *
- * console.log(state); // 0
- */
-export type ActionCollectionResult<TState, TMetadata, TStateSetter extends ActionCollectionConfig<TState, TMetadata> | StateSetter<TState> = StateSetter<TState>> = TStateSetter extends ActionCollectionConfig<TState, TMetadata> ? {
-    [key in keyof TStateSetter]: (...params: Parameters<TStateSetter[key]>) => ReturnType<ReturnType<TStateSetter[key]>>;
-} : null;
-/**
- * Common parameters of the store configuration callback functions
- * @param {StateSetter<TState>} setState - add a new value to the state
- * @param {() => TState} getState - get the current state
- * @param {MetadataSetter<TMetadata>} setMetadata - add a new value to the metadata
- * @param {() => TMetadata} getMetadata - get the current metadata
- * @param {ActionCollectionResult<TState, ActionCollectionConfig<TState, TMetadata>> | null} actions - the actions object returned by the hook when you pass an storeActionsConfig configuration otherwise null
- * @template {TState} TState - The state type
- * @template {TMetadata} TMetadata - The metadata type
- * @template {TStateSetter} TStateSetter - The storeActionsConfig type (optional) - if you pass an storeActionsConfig the hook will return an object with the actions
- * @template {ActionCollectionResult<TState, TStateSetter>} TStateSetter - the result of the API (optional) - if you don't pass an API as a parameter, you can pass null
- * */
-export type StateConfigCallbackParam<TState = any, TMetadata = null, TStateSetter extends ActionCollectionConfig<TState, TMetadata> | GlobalStoreBase.StateSetter<TState> = GlobalStoreBase.StateSetter<TState>> = {
-    actions: ActionCollectionResult<TState, TMetadata, TStateSetter>;
-} & StoreTools<TState, TMetadata>;
-/**
- * Parameters of the onStateChanged callback function
- * @template {TState} TState - The state type
- * @template {TMetadata} TMetadata - The metadata type
- * @template {TStateSetter} TStateSetter - The storeActionsConfig type (optional) - if you pass an storeActionsConfig the hook will return an object with the actions
- */
-export type StateChangesParam<TState = any, TMetadata = null, TStateSetter extends ActionCollectionConfig<TState, TMetadata> | GlobalStoreBase.StateSetter<TState> = GlobalStoreBase.StateSetter<TState>> = StateConfigCallbackParam<TState, TMetadata, TStateSetter> & GlobalStoreBase.StateChanges<TState>;
-/**
- * Configuration of the store (optional) - if you don't need to use the store configuration you don't need to pass this parameter
- * @param {StateConfigCallbackParam<TState, TMetadata> => void} onInit - callback function called when the store is initialized
- * @param {StateConfigCallbackParam<TState, TMetadata> => void} onSubscribed - callback function called every time a component is subscribed to the store
- * @param {StateChangesParam<TState, TMetadata> => boolean} computePreventStateChange - callback function called every time the state is changed and it allows you to prevent the state change
- * @param {StateChangesParam<TState, TMetadata> => void} onStateChanged - callback function called every time the state is changed
- * @template TState - the type of the state
- * @template TMetadata - the type of the metadata (optional) - if you don't pass an metadata as a parameter, you can pass null
- * @template {ActionCollectionConfig<TState,TMetadata> | null} TStateSetter - the configuration of the API (optional) - if you don't pass an API as a parameter, you can pass null
- * */
-export type GlobalStoreConfig<TState, TMetadata, TStateSetter extends ActionCollectionConfig<TState, TMetadata> | GlobalStoreBase.StateSetter<TState> = GlobalStoreBase.StateSetter<TState>> = GlobalStoreBase.GlobalStoreConfig<TState, TMetadata, TStateSetter> & AsyncStorageConfig;
-/**
- * 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> = GlobalStoreBase.createStateConfig<TState, TMetadata, TActions> & AsyncStorageConfig;
-/**
- * @description
- * Configuration of the custom global hook
- */
-export type CustomGlobalHookParams<TCustomConfig, TState, TMetadata, TActions extends ActionCollectionConfig<TState, TMetadata> | null> = GlobalStoreBase.CustomGlobalHookParams<TCustomConfig, TState, TMetadata, TActions> & AsyncStorageConfig;

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

@@ -1,16 +0,0 @@
-import { GlobalStoreConfig } from "./GlobalStore.types";
-/**
- * @description
- * Get an item from local storage using the config provided.
- */
-export declare const getAsyncStorageItem: <TState, TMetadata = null>({ config, }: {
-    config: GlobalStoreConfig<TState, TMetadata>;
-}) => Promise<TState>;
-/**
- * @description
- * Set an item to local storage using the config provided.
- */
-export declare const setAsyncStorageItem: <TState, TMetadata = null>({ item, config, }: {
-    config: GlobalStoreConfig<TState, TMetadata>;
-    item: TState;
-}) => Promise<void>;

package/lib/src/GlobalStoreAbstract.d.ts

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

package/lib/src/index.d.ts

@@ -1,12 +0,0 @@
-/**
- * The commented exports are the ones that are overridden by this library.
- * The intention is to extend the capabilities to specially web development.
- * The original library is intended to be used just with react,
- */
-export { clone, isNil, isNumber, isBoolean, isString, isDate, isRegex, isFunction, isPrimitive, formatFromStore, formatToStore, throwNoSubscribersWereAdded, createDerivate, createDerivateEmitter, shallowCompare, debounce, combineAsyncGettersEmitter, combineRetrieverEmitterAsynchronously, combineAsyncGetters, combineRetrieverAsynchronously, StateSetter, StateHook, AvoidNever, MetadataSetter, StateChanges, UseHookConfig, UnsubscribeCallback, SubscribeCallbackConfig, SubscribeCallback, SubscriberCallback, StateGetter, Subscribe, CustomGlobalHookBuilderParams, SelectorCallback, SubscribeToEmitter, SubscriberParameters, SubscriptionCallback, SetStateCallback, } from "react-hooks-global-states";
-export { AsyncStorageConfig, TMetadataResult, StoreTools, ActionCollectionConfig, ActionCollectionResult, StateConfigCallbackParam, StateChangesParam, GlobalStoreConfig, createStateConfig, CustomGlobalHookParams, } from "./GlobalStore.types";
-export { GlobalStore } from "./GlobalStore";
-export { GlobalStoreAbstract } from "./GlobalStoreAbstract";
-export { createGlobalStateWithDecoupledFuncs, createGlobalState, createCustomGlobalStateWithDecoupledFuncs, } from "./GlobalStore.functionHooks";
-export { getAsyncStorageItem, setAsyncStorageItem } from "./GlobalStore.utils";
-export * from "./GlobalStore.context";