react-global-state-hooks 1.1.2 → 2.0.1

package/lib/GlobalStore.d.ts

@@ -1,66 +0,0 @@
-import { GlobalStore as GlobalStoreBase } from 'react-native-global-state-hooks';
-import { ActionCollectionConfig, ActionCollectionResult, GlobalStoreConfig, StateConfigCallbackParam, StateSetter } from './GlobalStore.types';
-export declare class GlobalStore<TState, TMetadata = null, TStateSetter extends ActionCollectionConfig<TState, TMetadata> | StateSetter<TState> | null = StateSetter<TState>> extends GlobalStoreBase<TState, TMetadata, TStateSetter> {
-    /**
-     * 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: () => () => [
-        TState,
-        TStateSetter extends StateSetter<TState> ? StateSetter<TState> : ActionCollectionResult<TState, TMetadata, TStateSetter>,
-        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: () => [
-        () => TState,
-        TStateSetter extends StateSetter<TState> ? StateSetter<TState> : ActionCollectionResult<TState, TMetadata, TStateSetter>,
-        () => TMetadata
-    ];
-    /**
-     * 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)
-     * @property {GlobalStoreConfig<TState, TMetadata, TStateSetter>} config.localStorageKey - The key to use to store the state in the localStorage (optional) (default: null) if not null the state will be stored in the localStorage
-     */
-    protected config: GlobalStoreConfig<TState, TMetadata, TStateSetter>;
-    /**
-     * Create a new instance of the GlobalStore
-     * @param {TState} state - The initial state
-     * @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.metadata - The metadata to pass to the callbacks (optional) (default: 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 {StateConfigCallbackParam<TState, TMetadata>} config.localStorageKey - The key to use to store the state in the localStorage (optional) (default: null) if not null the state will be stored in the localStorage
-     * */
-    constructor(state: TState, config: GlobalStoreConfig<TState, TMetadata, TStateSetter>, setterConfig?: TStateSetter | null);
-    protected setLocalStorageValue: () => void;
-    protected getLocalStorageValue: () => string;
-    /**
-     * 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
-     */
-    protected onInit: ({ setState, }: StateConfigCallbackParam<TState, TMetadata, TStateSetter>) => Promise<void>;
-    protected onStateChanged: () => void;
-    /**
-     * set the state and update all the subscribers,
-     * In react web ReacDom allows to batch the state updates, this method will use the unstable_batchedUpdates method if it exists
-     * @param {StateSetter<TState>} setter - The setter function or the value to set
-     * @param {React.Dispatch<React.SetStateAction<TState>>} invokerSetState - 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 setState: ({ invokerSetState, state, }: {
-        state: TState;
-        invokerSetState?: React.Dispatch<React.SetStateAction<TState>>;
-    }) => void;
-}

package/lib/GlobalStore.types.d.ts

@@ -1,24 +0,0 @@
-import * as TGlobalStoreBase from 'react-native-global-state-hooks/lib/GlobalStore.types';
-export type StateSetter<TState> = TGlobalStoreBase.StateSetter<TState>;
-export type StateChanges<TState> = TGlobalStoreBase.StateChanges<TState>;
-export type StoreTools<TState, TMetadata = null> = TGlobalStoreBase.StoreTools<TState, TMetadata>;
-export interface ActionCollectionConfig<TState, TMetadata> extends TGlobalStoreBase.ActionCollectionConfig<TState, TMetadata> {
-}
-export type ActionCollectionResult<TState, TMetadata, TStateSetter extends ActionCollectionConfig<TState, TMetadata> | StateSetter<TState> = StateSetter<TState>> = TGlobalStoreBase.ActionCollectionResult<TState, TMetadata, TStateSetter>;
-export type StateConfigCallbackParam<TState, TMetadata, TStateSetter extends ActionCollectionConfig<TState, TMetadata> | StateSetter<TState> = StateSetter<TState>> = TGlobalStoreBase.StateConfigCallbackParam<TState, TMetadata, TStateSetter>;
-export type StateChangesParam<TState, TMetadata, TStateSetter extends ActionCollectionConfig<TState, TMetadata> | StateSetter<TState> = StateSetter<TState>> = TGlobalStoreBase.StateChangesParam<TState, TMetadata, TStateSetter>;
-/**
- * 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 TGlobalStoreBase.ActionCollectionConfig<TState, TMetadata> | TGlobalStoreBase.StateSetter<TState> = TGlobalStoreBase.StateSetter<TState>> = TGlobalStoreBase.GlobalStoreConfig<TState, TMetadata, TStateSetter> & {
-    localStorageKey?: string;
-    encrypt?: boolean | ((value: string) => string);
-    decrypt?: boolean | ((value: string) => string);
-};

package/lib/bundle.js.LICENSE.txt

@@ -1 +0,0 @@
-/*! regenerator-runtime -- Copyright (c) 2014-present, Facebook, Inc. -- license (MIT): https://github.com/facebook/regenerator/blob/main/LICENSE */

package/lib/index.d.ts

@@ -1,2 +0,0 @@
-export * from './GlobalStore';
-export * from './GlobalStore.types';