react-native-global-state-hooks 2.0.6 → 2.1.0

package/lib/GlobalStore.utils.js

@@ -0,0 +1,23 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.debounce = exports.clone = exports.formatFromStore = exports.formatToStore = void 0;
+const json_storage_formatter_1 = require("json-storage-formatter");
+Object.defineProperty(exports, "formatToStore", { enumerable: true, get: function () { return json_storage_formatter_1.formatToStore; } });
+Object.defineProperty(exports, "formatFromStore", { enumerable: true, get: function () { return json_storage_formatter_1.formatFromStore; } });
+Object.defineProperty(exports, "clone", { enumerable: true, get: function () { return json_storage_formatter_1.clone; } });
+/**
+ * Debounce function to prevent multiple calls to the same function in a short period of time
+ * @param callback Function to be called
+ * @param wait Time to wait before calling the function
+ * @returns Function to be called
+ */
+const debounce = (callback, wait = 300) => {
+    let timer;
+    return ((...args) => {
+        clearTimeout(timer);
+        timer = setTimeout(() => {
+            callback(...args);
+        }, wait);
+    });
+};
+exports.debounce = debounce;

package/lib/index.d.ts

@@ -0,0 +1,4 @@
+export * from './GlobalStore.types';
+export * from './GlobalStore.utils';
+export * from './GlobalStore';
+//# sourceMappingURL=index.d.ts.map

package/lib/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,qBAAqB,CAAC;AACpC,cAAc,qBAAqB,CAAC;AACpC,cAAc,eAAe,CAAC"}

package/lib/index.js

@@ -0,0 +1,6 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+tslib_1.__exportStar(require("./GlobalStore.types"), exports);
+tslib_1.__exportStar(require("./GlobalStore.utils"), exports);
+tslib_1.__exportStar(require("./GlobalStore"), exports);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "react-native-global-state-hooks",
-  "version": "2.0.6",
+  "version": "2.1.0",
   "description": "This is a package to easily handling global-state across your react-native-components No-redux",
   "main": "lib/GlobalStore.js",
   "files": [
@@ -40,7 +40,6 @@
   },
   "homepage": "https://github.com/johnny-quesada-developer/react-native-global-state-hooks#readme",
   "devDependencies": {
-    "@react-native-async-storage/async-storage": "workspace:*",
     "@types/jest": "^26.0.17",
     "@types/lodash": "^4.14.165",
     "@types/react": "^17.0.0",
@@ -48,6 +47,7 @@
     "@types/react-test-renderer": "^17.0.0",
     "@typescript-eslint/eslint-plugin": "^4.9.1",
     "@typescript-eslint/parser": "^4.9.1",
+    "cancelable-promise-jq": "^1.0.4",
     "eslint": "^7.15.0",
     "eslint-config-airbnb": "^18.2.1",
     "eslint-plugin-import": "^2.22.1",
@@ -58,10 +58,10 @@
     "react": "workspace:*",
     "react-test-renderer": "^17.0.1",
     "ts-jest": "^26.4.4",
-    "typescript": "^4.1.2"
+    "tslib": "^2.5.0",
+    "typescript": "^4.9.5"
   },
   "peerDependencies": {
-    "@react-native-async-storage/async-storage": "workspace:*",
     "react": "workspace:*"
   },
   "dependencies": {

package/lib/GlobalStoreTypes.d.ts

@@ -1,66 +0,0 @@
-/**
-* @param {StateSetter<IState>} setter - add a new value to the state
-* @returns {void} result - void
-*/
-export declare type StateSetter<IState> = (setter: IState | ((state: IState) => IState)) => void;
-/**
-* This is the structure required by the API actions in order to be able to capture action parameters and inject state setter into actions.
-*/
-export declare type IActionConfig<IState> = (...params: any[]) => (setter: StateSetter<IState>, currentState: IState) => Promise<unknown>;
-/**
-* Configuration of you API
-*/
-export interface IActionCollectionConfig<IState> {
-    [key: string]: IActionConfig<IState>;
-}
-/**
-* This is the API result of the hook (if you passed an API as a parameter)
-*/
-export declare type IActionCollectionResult<IState, IActions extends IActionCollectionConfig<IState> | null> = {
-    [key in keyof IActions]: (...params: any[]) => unknown;
-};
-/**
-* Hook result, if you passed an API as a parameter it will be returned in the second position of the hook invoke.
-*/
-export declare type IHookResult<IState, IActions extends IActionCollectionConfig<IState> | null = null, IApi extends IActionCollectionResult<IState, IActions> | null = IActions extends null ? null : IActionCollectionResult<IState, IActions>> = IApi extends null ? StateSetter<IState> : IActions extends IActionCollectionConfig<IState> ? IApi extends IActionCollectionResult<IState, IActions> ? IApi : StateSetter<IState> : StateSetter<IState>;
-/**
-* This is a class to create global-store objects
-* @template IState
-* @param {IState} state - Initial state,
-* @template IPersist
-* @param {IPersist} persistStoreAs -  A name that indicates if the store should be persisted at the asyncStorage
-* @template IsPersist
-* @param {IsPersist} isPersist - Calculated flag that indicates if the store is persisted
-* @template IActions
-* @param {IActions} actions - An specific api to restrict the use of the state,
-* this will disable the default return of the state-setter of the hook, and instead will return the API
-* @param {string} persistStoreAs - A name if you want to persist the state of the store in localstorage
-* */
-export interface IGlobalState<IState, IPersist extends string | null = null, IActions extends IActionCollectionConfig<IState> | null = null> {
-    persistStoreAs: IPersist;
-    isPersistStore: boolean;
-    /**
-    * This function can be used to format the data after it is loaded from the asyncStorage
-    */
-    onPersistStorageLoad: (obj: unknown) => (IState | null);
-    /**
-    * Returns a global hook that will share information across components by subscribing them to a specific store.
-    * @return [currentState, GlobalState.IHookResult<IState, IActions, IApi>, initialStatePersistStorage | null, isUpdatedPersistStorage | null]
-    */
-    getHook: <IApi extends IActions extends IActionCollectionResult<IState, IActions> ? IActionCollectionResult<IState, IActions> : null>() => () => [
-        IState,
-        IHookResult<IState, IActions, IApi>,
-        IPersist extends null ? false : true extends true ? boolean : null
-    ];
-    /**
-    * This is an access to the subscribers queue and to the current state of a specific store...
-    * THIS IS NOT A REACT-HOOK, so you could use it everywhere example other hooks, and services.
-    * @return [currentState, GlobalState.IHookResult<IState, IActions, IApi>]
-    */
-    getHookDecoupled: <IApi extends IActions extends IActionCollectionResult<IState, IActions> ? IActionCollectionResult<IState, IActions> : null>() => [
-        () => IPersist extends string ? Promise<IState> : IState,
-        IHookResult<IState, IActions, IApi>
-    ];
-    deleteAsyncStoreItem: () => Promise<void>;
-}
-//# sourceMappingURL=GlobalStoreTypes.d.ts.map

package/lib/GlobalStoreTypes.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"GlobalStoreTypes.d.ts","sourceRoot":"","sources":["../src/GlobalStoreTypes.ts"],"names":[],"mappings":"AAAA;;;EAGE;AACF,oBAAY,WAAW,CAAC,MAAM,IAAI,CAChC,MAAM,EAAE,MAAM,GAAG,CAAC,CAAC,KAAK,EAAE,MAAM,KAAK,MAAM,CAAC,KACzC,IAAI,CAAC;AAEV;;EAEE;AACF,oBAAY,aAAa,CAAC,MAAM,IAAI,CAElC,GAAG,MAAM,EAAE,GAAG,EAAE,KACb,CAAC,MAAM,EAAE,WAAW,CAAC,MAAM,CAAC,EAAE,YAAY,EAAE,MAAM,KAAK,OAAO,CAAC,OAAO,CAAC,CAAC;AAE7E;;EAEE;AACF,MAAM,WAAW,uBAAuB,CAAC,MAAM;IAC7C,CAAC,GAAG,EAAE,MAAM,GAAG,aAAa,CAAC,MAAM,CAAC,CAAC;CACtC;AAED;;EAEE;AACF,oBAAY,uBAAuB,CAAC,MAAM,EAAE,QAAQ,SAAS,uBAAuB,CAAC,MAAM,CAAC,GAAG,IAAI,IAAI;KAEpG,GAAG,IAAI,MAAM,QAAQ,GAAG,CAAC,GAAG,MAAM,EAAE,GAAG,EAAE,KAAK,OAAO;CACvD,CAAC;AAEF;;EAEE;AACF,oBAAY,WAAW,CACrB,MAAM,EACN,QAAQ,SAAS,uBAAuB,CAAC,MAAM,CAAC,GAAG,IAAI,GAAG,IAAI,EAC9D,IAAI,SAAS,uBAAuB,CAAC,MAAM,EAAE,QAAQ,CAAC,GAAG,IAAI,GAAG,QAAQ,SAAS,IAAI,GAAG,IAAI,GAAG,uBAAuB,CAAC,MAAM,EAAE,QAAQ,CAAC,IACtI,IAAI,SAAS,IAAI,GACjB,WAAW,CAAC,MAAM,CAAC,GACnB,QAAQ,SAAS,uBAAuB,CAAC,MAAM,CAAC,GAChD,IAAI,SAAS,uBAAuB,CAAC,MAAM,EAAE,QAAQ,CAAC,GACpD,IAAI,GACJ,WAAW,CAAC,MAAM,CAAC,GACrB,WAAW,CAAC,MAAM,CAAC,CAAC;AAExB;;;;;;;;;;;;IAYI;AACJ,MAAM,WAAW,YAAY,CAC3B,MAAM,EACN,QAAQ,SAAS,MAAM,GAAG,IAAI,GAAG,IAAI,EACrC,QAAQ,SAAS,uBAAuB,CAAC,MAAM,CAAC,GAAG,IAAI,GAAG,IAAI;IAG9D,cAAc,EAAE,QAAQ,CAAC;IAEzB,cAAc,EAAE,OAAO,CAAC;IAExB;;MAEE;IACF,oBAAoB,EAAE,CAAC,GAAG,EAAE,OAAO,KAAK,CAAC,MAAM,GAAG,IAAI,CAAC,CAAC;IAExD;;;MAGE;IACF,OAAO,EAAE,CAAC,IAAI,SAAS,QAAQ,SAAS,uBAAuB,CAAC,MAAM,EAAE,QAAQ,CAAC,GAAG,uBAAuB,CAAC,MAAM,EAAE,QAAQ,CAAC,GAAG,IAAI,OAAO,MAAM;QAC/I,MAAM;QACN,WAAW,CAAC,MAAM,EAAE,QAAQ,EAAE,IAAI,CAAC;QACnC,QAAQ,SAAS,IAAI,GAAG,KAAK,GAAG,IAAI,SAAS,IAAI,GAAG,OAAO,GAAG,IAAI;KACnE,CAAC;IAEF;;;;MAIE;IACF,gBAAgB,EAAE,CAAC,IAAI,SAAS,QAAQ,SAAS,uBAAuB,CAAC,MAAM,EAAE,QAAQ,CAAC,GAAG,uBAAuB,CAAC,MAAM,EAAE,QAAQ,CAAC,GAAG,IAAI,OAAO;QAClJ,MAAM,QAAQ,SAAS,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,GAAG,MAAM;QACxD,WAAW,CAAC,MAAM,EAAE,QAAQ,EAAE,IAAI,CAAC;KACpC,CAAC;IAEF,oBAAoB,EAAE,MAAM,OAAO,CAAC,IAAI,CAAC,CAAC;CAC3C"}