react-hooks-global-states 1.0.3 → 1.0.5

package/README.md

@@ -1,16 +1,22 @@
-# react-hooks-global-states
+# react-hooks-global-states 🌟
 
-This is a package to easily handling **global state hooks** across your **react components**
+![Image John Avatar](https://raw.githubusercontent.com/johnny-quesada-developer/global-hooks-example/main/public/avatar2.jpeg)
 
-For seen a running example of the hooks, you can check the following link: [react-global-state-hooks-example](https://johnny-quesada-developer.github.io/react-global-state-hooks-example/)
+Hi There! Welcome to **react-hooks-global-states** your New State Management Solution for React Components 🚀
 
-To see **TODO-LIST** with the hooks and **async storage** take a look here: [todo-list-with-global-hooks](https://github.com/johnny-quesada-developer/todo-list-with-global-hooks.git).
+Are you looking for a solution to manage **global state** in your **React components**? Look no further!
 
-To see how to create a custom hook connected to your favorite async storage, please refer to the documentation section titled **Extending Global Hooks**
+**react-hooks-global-states** is your option for efficiently handling global state management in your React applications.
 
-You can also see an introduction video [here!](https://www.youtube.com/watch?v=1UBqXk2MH8I), you can see the code of the video here: [global-hooks-example](https://github.com/johnny-quesada-developer/global-hooks-example), and a live version of it here: [global-hooks-example-live](https://johnny-quesada-developer.github.io/global-hooks-example/)
+One line of code for a **global state**! try it out now on [CODEPEN-react-global-state-hooks](https://codepen.io/johnnynabetes/pen/WNmeGwb?editors=0010) and witness the magic ✨.
 
-**react-hooks-global-states** is compatible with both **React** and **React Native**. However, if you prefer, you can also explore [**react-global-state-hooks**](https://www.npmjs.com/package/react-global-state-hooks) for web applications, and [**react-native-global-state-hooks**](https://www.npmjs.com/package/react-native-global-state-hooks) for React Native projects. Each of these libraries extends the capabilities of **react-hooks-global-states** to suit the specific environments.
+For a deeper dive into how these hooks work, check out a comprehensive example at [react-global-state-hooks-example](https://johnny-quesada-developer.github.io/react-global-state-hooks-example/) 📘.
+
+Want to explore how it works with **React Native**? Head over to [react-native-global-state-hooks](https://www.npmjs.com/package/react-native-global-state-hooks) for a hands-on experience 📱. You can also explore a **TODO-LIST** example using global state and asynchronous storage by heading to [todo-list-with-global-hooks](https://github.com/johnny-quesada-developer/todo-list-with-global-hooks.git) 📝.
+
+For a more visual introduction, watch our informative video [here!](https://www.youtube.com/watch?v=1UBqXk2MH8I) 🎥 and dive into the code on [global-hooks-example](https://github.com/johnny-quesada-developer/global-hooks-example) 🧩.
+
+The best part? **react-hooks-global-states** is compatible with both **React** and **React Native**. If you're building web applications, explore [**react-global-state-hooks**](https://www.npmjs.com/package/react-global-state-hooks), and for your React Native projects, check out [**react-native-global-state-hooks**](https://www.npmjs.com/package/react-native-global-state-hooks). These specialized libraries extend the capabilities of **react-hooks-global-states** to perfectly fit your specific development environments. Discover the ease of global state management today! 🌐
 
 # Creating a global state
 

package/lib/src/GlobalStore.d.ts

@@ -1,4 +1,4 @@
-import { ActionCollectionConfig, StateSetter, GlobalStoreConfig, ActionCollectionResult, StateConfigCallbackParam, MetadataSetter, UseHookConfig, StateGetter, SubscribeCallbackConfig, SubscribeCallback, SelectorCallback, SubscriberParameters, SubscriptionCallback, MetadataGetter } from "./GlobalStore.types";
+import { ActionCollectionConfig, StateSetter, GlobalStoreConfig, ActionCollectionResult, StateConfigCallbackParam, MetadataSetter, UseHookConfig, StateGetter, SubscribeCallbackConfig, SubscribeCallback, SelectorCallback, 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
@@ -40,7 +40,7 @@ export declare class GlobalStore<TState, TMetadata = null, TStateSetter extends
      * @param {Dispatch<SetStateAction<TMetadata>>} parameters.setMetadata - The setMetadata function to update the metadata
      * @param {() => TMetadata} parameters.getMetadata - The getMetadata function to get the metadata
      * */
-    protected onInit?: GlobalStoreConfig<TState, TMetadata, TStateSetter>["onInit"];
+    protected onInit?: GlobalStoreConfig<TState, TMetadata, TStateSetter>['onInit'];
     /**
      * execute every time the state is changed
      * @template {TState} TState - The type of the state object
@@ -52,7 +52,7 @@ export declare class GlobalStore<TState, TMetadata = null, TStateSetter extends
      * @param {Dispatch<SetStateAction<TMetadata>>} parameters.setMetadata - The setMetadata function to update the metadata
      * @param {() => TMetadata} parameters.getMetadata - The getMetadata function to get the metadata
      * */
-    protected onStateChanged?: GlobalStoreConfig<TState, TMetadata, TStateSetter>["onStateChanged"];
+    protected onStateChanged?: GlobalStoreConfig<TState, TMetadata, TStateSetter>['onStateChanged'];
     /**
      * Execute each time a new component gets subscribed to the store
      * @template {TState} TState - The type of the state object
@@ -64,7 +64,7 @@ export declare class GlobalStore<TState, TMetadata = null, TStateSetter extends
      * @param {Dispatch<SetStateAction<TMetadata>>} parameters.setMetadata - The setMetadata function to update the metadata
      * @param {() => TMetadata} parameters.getMetadata - The getMetadata function to get the metadata
      * */
-    protected onSubscribed?: GlobalStoreConfig<TState, TMetadata, TStateSetter>["onSubscribed"];
+    protected onSubscribed?: GlobalStoreConfig<TState, TMetadata, TStateSetter>['onSubscribed'];
     /**
      * Execute every time a state change is triggered and before the state is updated, it allows to prevent the state change by returning true
      * @template {TState} TState - The type of the state object
@@ -77,7 +77,7 @@ export declare class GlobalStore<TState, TMetadata = null, TStateSetter extends
      * @param {() => TMetadata} parameters.getMetadata - The getMetadata function to get the metadata
      * @returns {boolean} - true to prevent the state change, false to allow the state change
      * */
-    protected computePreventStateChange?: GlobalStoreConfig<TState, TMetadata, TStateSetter>["computePreventStateChange"];
+    protected computePreventStateChange?: GlobalStoreConfig<TState, TMetadata, TStateSetter>['computePreventStateChange'];
     /**
      * We use a wrapper in order to be able to force the state update when necessary even with primitive types
      */

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

@@ -148,7 +148,7 @@ export type ActionCollectionResult<TState, TMetadata, TStateSetter extends Actio
  * @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, TMetadata, TStateSetter extends ActionCollectionConfig<TState, TMetadata> | StateSetter<TState> = StateSetter<TState>> = {
+export type StateConfigCallbackParam<TState = any, TMetadata = null, TStateSetter extends ActionCollectionConfig<TState, TMetadata> | StateSetter<TState> = StateSetter<TState>> = {
     actions: ActionCollectionResult<TState, TMetadata, TStateSetter>;
 } & StoreTools<TState, TMetadata>;
 /**
@@ -157,7 +157,7 @@ export type StateConfigCallbackParam<TState, TMetadata, TStateSetter extends Act
  * @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, TMetadata, TStateSetter extends ActionCollectionConfig<TState, TMetadata> | StateSetter<TState> = StateSetter<TState>> = StateConfigCallbackParam<TState, TMetadata, TStateSetter> & StateChanges<TState>;
+export type StateChangesParam<TState = any, TMetadata = null, TStateSetter extends ActionCollectionConfig<TState, TMetadata> | StateSetter<TState> = StateSetter<TState>> = StateConfigCallbackParam<TState, TMetadata, TStateSetter> & 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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "react-hooks-global-states",
-  "version": "1.0.3",
+  "version": "1.0.5",
   "description": "This is a package to easily handling global-state across your react-components No-redux",
   "main": "lib/bundle.js",
   "types": "lib/src/index.d.ts",
@@ -66,9 +66,9 @@
     "react": ">=17.0.0",
     "react-test-renderer": "^17.0.1",
     "ts-jest": "^26.4.4",
-    "ts-loader": "^9.4.2",
-    "tslib": "^2.5.0",
-    "typescript": "^4.9.5",
+    "ts-loader": "^9.5.1",
+    "tslib": "^2.6.2",
+    "typescript": "^5.3.3",
     "webpack": "^5.76.3",
     "webpack-cli": "^5.0.1"
   },