react-hooks-global-states 10.2.0 → 11.0.0-beta.2

package/createGlobalState.js

@@ -1 +1,47 @@
-var e;e=e=>(()=>{"use strict";var t={778:t=>{t.exports=e},840:(e,t,o)=>{Object.defineProperty(t,"__esModule",{value:!0}),t.createGlobalState=void 0;var r=o(778);t.createGlobalState=function(e,t){return new r.GlobalStore(e,t).getHook()},t.default=t.createGlobalState}},o={};return function e(r){var a=o[r];if(void 0!==a)return a.exports;var l=o[r]={exports:{}};return t[r](l,l.exports,e),l.exports}(840)})(),"object"==typeof exports&&"object"==typeof module?module.exports=e(require("./GlobalStore.js")):"function"==typeof define&&define.amd?define(["./GlobalStore.js"],e):"object"==typeof exports?exports["react-hooks-global-states"]=e(require("./GlobalStore.js")):this["react-hooks-global-states"]=e(this["./GlobalStore.js"]);
+var e;e=e=>/******/(()=>{
+/******/"use strict";
+/******/var t={
+/***/778:
+/***/t=>{t.exports=e;
+/***/},
+/***/840:
+/***/(e,t,o)=>{Object.defineProperty(t,"__esModule",{value:!0}),t.createGlobalState=void 0;var r=o(778);
+/**
+ * Creates a global state hook
+ */t.createGlobalState=function(){for(var e=arguments.length,t=new Array(e),o=0;o<e;o++)t[o]=arguments[o];var a=t[0],l=t[1];return new r.GlobalStore(a,l).use},t.default=t.createGlobalState}
+/***/
+/******/},o={};
+/************************************************************************/
+/******/
+/******/
+/******/
+/******/
+/******/
+/******/
+/******/return function e(r){
+/******/
+/******/var a=o[r];
+/******/if(void 0!==a)
+/******/return a.exports;
+/******/
+/******/
+/******/var l=o[r]={
+/******/
+/******/
+/******/exports:{}
+/******/};
+/******/
+/******/
+/******/
+/******/
+/******/
+/******/return t[r](l,l.exports,e),l.exports;
+/******/}
+/******/
+/************************************************************************/
+/******/
+/******/
+/******/
+/******/
+/******/(840);
+/******/})(),"object"==typeof exports&&"object"==typeof module?module.exports=e(require("./GlobalStore.js")):"function"==typeof define&&define.amd?define(["./GlobalStore.js"],e):"object"==typeof exports?exports["react-hooks-global-states"]=e(require("./GlobalStore.js")):this["react-hooks-global-states"]=e(this["./GlobalStore.js"]);

package/index.d.ts

@@ -1,12 +1,9 @@
-export { StateSetter, HookExtensions, ObservableFragment, MetadataSetter, StateChanges, StoreTools, ActionCollectionResult, GlobalStoreCallbacks, UseHookConfig, UnsubscribeCallback, SubscribeCallbackConfig, SubscribeCallback, StateGetter, BaseMetadata, MetadataGetter, CustomGlobalHookBuilderParams, SelectorCallback, SubscriberParameters, SubscriptionCallback, StateHook, ActionCollectionConfig, } from './types';
+export { StateApi, ObservableFragment, MetadataSetter, StateChanges, StoreTools, ActionCollectionResult, GlobalStoreCallbacks, UseHookConfig, UnsubscribeCallback, SubscribeCallbackConfig, SubscribeCallback, BaseMetadata, MetadataGetter, CustomGlobalHookBuilderParams, SelectorCallback, SubscriberParameters, SubscriptionCallback, StateHook, ActionCollectionConfig, } from './types';
 export { GlobalStore } from './GlobalStore';
 export { GlobalStoreAbstract } from './GlobalStoreAbstract';
 export { createGlobalState, type InferActionsType } from './createGlobalState';
-export { createCustomGlobalState } from './createCustomGlobalState';
 export { shallowCompare } from './shallowCompare';
 export { uniqueId } from './uniqueId';
 export { throwWrongKeyOnActionCollectionConfig } from './throwWrongKeyOnActionCollectionConfig';
 export { isRecord } from './isRecord';
-export { useStableState } from './useStableState';
-export { type Context, type ContextProvider, type ContextHook, type CreateContext, type InferContextType, createContext, } from './createContext';
-export { generateStackHash } from './generateStackHash';
+export { type ContextApi as Context, type ContextProvider, type ContextHook, type InferContextApi, createContext, } from './createContext';

package/isRecord.js

@@ -1 +1,44 @@
-var o;o=o=>(()=>{"use strict";var t={35:(o,t,e)=>{function r(o){return r="function"==typeof Symbol&&"symbol"==typeof Symbol.iterator?function(o){return typeof o}:function(o){return o&&"function"==typeof Symbol&&o.constructor===Symbol&&o!==Symbol.prototype?"symbol":typeof o},r(o)}Object.defineProperty(t,"__esModule",{value:!0}),t.isRecord=void 0;var s=e(773);t.isRecord=function(o){return!(0,s.isNil)(o)&&"object"===r(o)},t.default=t.isRecord},773:t=>{t.exports=o}},e={};return function o(r){var s=e[r];if(void 0!==s)return s.exports;var i=e[r]={exports:{}};return t[r](i,i.exports,o),i.exports}(35)})(),"object"==typeof exports&&"object"==typeof module?module.exports=o(require("json-storage-formatter/isNil")):"function"==typeof define&&define.amd?define(["json-storage-formatter/isNil"],o):"object"==typeof exports?exports["react-hooks-global-states"]=o(require("json-storage-formatter/isNil")):this["react-hooks-global-states"]=o(this["json-storage-formatter/isNil"]);
+var o;o=o=>/******/(()=>{
+/******/"use strict";
+/******/var t={
+/***/35:
+/***/(o,t,e)=>{function r(o){return r="function"==typeof Symbol&&"symbol"==typeof Symbol.iterator?function(o){return typeof o}:function(o){return o&&"function"==typeof Symbol&&o.constructor===Symbol&&o!==Symbol.prototype?"symbol":typeof o},r(o)}Object.defineProperty(t,"__esModule",{value:!0}),t.isRecord=void 0;var s=e(773);t.isRecord=function(o){return!(0,s.isNil)(o)&&"object"===r(o)},t.default=t.isRecord}
+/***/,
+/***/773:
+/***/t=>{t.exports=o;
+/***/
+/******/}},e={};
+/************************************************************************/
+/******/
+/******/
+/******/
+/******/
+/******/
+/******/
+/******/return function o(r){
+/******/
+/******/var s=e[r];
+/******/if(void 0!==s)
+/******/return s.exports;
+/******/
+/******/
+/******/var i=e[r]={
+/******/
+/******/
+/******/exports:{}
+/******/};
+/******/
+/******/
+/******/
+/******/
+/******/
+/******/return t[r](i,i.exports,o),i.exports;
+/******/}
+/******/
+/************************************************************************/
+/******/
+/******/
+/******/
+/******/
+/******/(35);
+/******/})(),"object"==typeof exports&&"object"==typeof module?module.exports=o(require("json-storage-formatter/isNil")):"function"==typeof define&&define.amd?define(["json-storage-formatter/isNil"],o):"object"==typeof exports?exports["react-hooks-global-states"]=o(require("json-storage-formatter/isNil")):this["react-hooks-global-states"]=o(this["json-storage-formatter/isNil"]);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "react-hooks-global-states",
-  "version": "10.2.0",
+  "version": "11.0.0-beta.2",
   "description": "This is a package to easily handling global-state across your react-components using hooks.",
   "main": "./bundle.js",
   "types": "./index.d.ts",
@@ -26,11 +26,6 @@
       "require": "./GlobalStoreAbstract.js",
       "types": "./GlobalStoreAbstract.d.ts"
     },
-    "./createCustomGlobalState": {
-      "import": "./createCustomGlobalState.js",
-      "require": "./createCustomGlobalState.js",
-      "types": "./createCustomGlobalState.d.ts"
-    },
     "./createGlobalState": {
       "import": "./createGlobalState.js",
       "require": "./createGlobalState.js",
@@ -60,16 +55,6 @@
       "import": "./uniqueId.js",
       "require": "./uniqueId.js",
       "types": "./uniqueId.d.ts"
-    },
-    "./useStableState": {
-      "import": "./useStableState.js",
-      "require": "./useStableState.js",
-      "types": "./useStableState.d.ts"
-    },
-    "./generateStackHash": {
-      "import": "./generateStackHash.js",
-      "require": "./generateStackHash.js",
-      "types": "./generateStackHash.d.ts"
     }
   },
   "files": [
@@ -77,7 +62,8 @@
     "*.d.ts"
   ],
   "scripts": {
-    "test:debug": "node --inspect-brk node_modules/.bin/jest --watch --runInBand",
+    "format": "prettier --write .",
+    "test-debug": "node --inspect-brk node_modules/.bin/jest --runInBand --detectOpenHandles",
     "test:quick": "jest --maxWorkers=4 -c --no-watchman -u",
     "test:coverage": "jest --maxWorkers=4 -c --colors --no-watchman --verbose --coverage",
     "build": "yarn clean && webpack --config webpack.config.js",
@@ -137,6 +123,7 @@
     "jest": "^29.7.0",
     "jest-environment-jsdom": "^30.0.4",
     "json-storage-formatter": "^2.0.9",
+    "prettier": "^3.6.2",
     "react": "^18.2.0",
     "react-dom": "^18.2.0",
     "ts-jest": "^29.1.1",

package/shallowCompare.d.ts

@@ -1,13 +1,52 @@
 /**
- * Returns true if the two values are equal.
+ * @description It performs a shallow comparison of the values.
+ * @param value1 - The first value to compare.
+ * @param value2 - The second value to compare.
+ * @returns True if the values are equal, false otherwise.
  */
 export declare const shallowCompare: <T>(value1: T, value2: T) => boolean;
 export declare const isArray: (value: unknown) => value is unknown[];
 export declare const isMap: (value: unknown) => value is Map<unknown, unknown>;
 export declare const isSet: (value: unknown) => value is Set<unknown>;
+/**
+ * @description Determines whether a simple equality check (using `===`) is sufficient
+ * to compare the provided values. This helps decide when a deep equality check
+ * is unnecessary or inefficient.
+ *
+ * Simple equality checks are considered valid when:
+ * - The values have different types (comparison will trivially return false)
+ * - Either value is null or undefined
+ * - Both values are primitive types (string, number, boolean, symbol, bigint)
+ * - Both values are Date objects
+ * - Both values are functions
+ *
+ * @param value1 - The first value to compare.
+ * @param value2 - The second value to compare.
+ * @returns `true` if a simple `===` check is sufficient, `false` if a deep comparison may be required.
+ *
+ * @example
+ * ```ts
+ * canCheckSimpleEquality(42, 42); // true (primitive numbers)
+ * canCheckSimpleEquality({ a: 1 }, { a: 1 }); // false (objects)
+ * canCheckSimpleEquality([1, 2], [1, 2]); // false (arrays)
+ * canCheckSimpleEquality('a', 1); // true (different types, shallow check enough)
+ * ```
+ */
 export declare const canCheckSimpleEquality: (value1: unknown, value2: unknown) => boolean;
-export declare const isEqualArray: <T>(array1: T[], array2: T[]) => boolean;
-export declare const isEqualMap: <K, V>(map1: Map<K, V>, map2: Map<K, V>) => boolean;
-export declare const isEqualSet: <T>(set1: Set<T>, set2: Set<T>) => boolean;
+/**
+ * @description Performs a shallow comparison between two arrays.
+ */
+export declare const isEqualArray: <T>(array1: T[], array2: T[]) => array1 is T[];
+/**
+ * @description Performs a shallow comparison between two maps.
+ */
+export declare const isEqualMap: <K, V>(map1: Map<K, V>, map2: Map<K, V>) => map1 is Map<K, V>;
+/**
+ * @description Performs a shallow comparison between two sets.
+ */
+export declare const isEqualSet: <T>(set1: Set<T>, set2: Set<T>) => set1 is Set<T>;
+/**
+ * @description Performs a shallow comparison between two objects.
+ */
 export declare const isEqualObject: <T extends Record<string, unknown>>(value1: T, value2: T) => boolean;
 export default shallowCompare;

package/shallowCompare.js

@@ -1 +1,53 @@
-var r,t;r=this,t=(r,t,e,n)=>(()=>{"use strict";var o={38:t=>{t.exports=r},487:r=>{r.exports=t},773:r=>{r.exports=e},955:r=>{r.exports=n},973:(r,t,e)=>{function n(r,t){var e="undefined"!=typeof Symbol&&r[Symbol.iterator]||r["@@iterator"];if(!e){if(Array.isArray(r)||(e=o(r))||t&&r&&"number"==typeof r.length){e&&(r=e);var n=0,i=function(){};return{s:i,n:function(){return n>=r.length?{done:!0}:{done:!1,value:r[n++]}},e:function(r){throw r},f:i}}throw new TypeError("Invalid attempt to iterate non-iterable instance.\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method.")}var a,s=!0,u=!1;return{s:function(){e=e.call(r)},n:function(){var r=e.next();return s=r.done,r},e:function(r){u=!0,a=r},f:function(){try{s||null==e.return||e.return()}finally{if(u)throw a}}}}function o(r,t){if(r){if("string"==typeof r)return i(r,t);var e={}.toString.call(r).slice(8,-1);return"Object"===e&&r.constructor&&(e=r.constructor.name),"Map"===e||"Set"===e?Array.from(r):"Arguments"===e||/^(?:Ui|I)nt(?:8|16|32)(?:Clamped)?Array$/.test(e)?i(r,t):void 0}}function i(r,t){(null==t||t>r.length)&&(t=r.length);for(var e=0,n=Array(t);e<t;e++)n[e]=r[e];return n}function a(r){return a="function"==typeof Symbol&&"symbol"==typeof Symbol.iterator?function(r){return typeof r}:function(r){return r&&"function"==typeof Symbol&&r.constructor===Symbol&&r!==Symbol.prototype?"symbol":typeof r},a(r)}Object.defineProperty(t,"__esModule",{value:!0}),t.isEqualObject=t.isEqualSet=t.isEqualMap=t.isEqualArray=t.canCheckSimpleEquality=t.isSet=t.isMap=t.isArray=t.shallowCompare=void 0;var s=e(955),u=e(38),l=e(773),f=e(487);t.shallowCompare=function(r,e){return!(r!==e)||((0,t.canCheckSimpleEquality)(r,e)?r===e:(0,t.isArray)(r)&&(0,t.isArray)(e)?(0,t.isEqualArray)(r,e):(0,t.isMap)(r)&&(0,t.isMap)(e)?(0,t.isEqualMap)(r,e):(0,t.isSet)(r)&&(0,t.isSet)(e)?(0,t.isEqualSet)(r,e):(0,f.isRecord)(r)&&(0,f.isRecord)(e)?(0,t.isEqualObject)(r,e):r===e)},t.isArray=function(r){return Array.isArray(r)},t.isMap=function(r){return r instanceof Map},t.isSet=function(r){return r instanceof Set},t.canCheckSimpleEquality=function(r,t){var e=a(r),n=a(t);return e!==n||(0,l.isNil)(r)||(0,l.isNil)(t)||(0,s.isPrimitive)(r)&&(0,s.isPrimitive)(t)||(0,u.isDate)(r)&&(0,u.isDate)(t)||"function"===e&&"function"===n},t.isEqualArray=function(r,t){if(r.length!==t.length)return!1;for(var e=0;e<r.length;e+=1)if(r[e]!==t[e])return!1;return!0},t.isEqualMap=function(r,t){if(r.size!==t.size)return!1;var e,i,a=n(r);try{for(a.s();!(e=a.n()).done;){var s=function(r){if(Array.isArray(r))return r}(i=e.value)||function(r){var t=null==r?null:"undefined"!=typeof Symbol&&r[Symbol.iterator]||r["@@iterator"];if(null!=t){var e,n,o,i,a=[],s=!0,u=!1;try{for(o=(t=t.call(r)).next;!(s=(e=o.call(t)).done)&&(a.push(e.value),2!==a.length);s=!0);}catch(r){u=!0,n=r}finally{try{if(!s&&null!=t.return&&(i=t.return(),Object(i)!==i))return}finally{if(u)throw n}}return a}}(i)||o(i,2)||function(){throw new TypeError("Invalid attempt to destructure non-iterable instance.\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method.")}(),u=s[0];if(s[1]!==t.get(u))return!1}}catch(r){a.e(r)}finally{a.f()}return!0},t.isEqualSet=function(r,t){if(r.size!==t.size)return!1;var e,o=n(r);try{for(o.s();!(e=o.n()).done;){var i=e.value;if(!t.has(i))return!1}}catch(r){o.e(r)}finally{o.f()}return!0},t.isEqualObject=function(r,t){var e=Object.keys(r),n=Object.keys(t);if(e.length!==n.length)return!1;for(var o=0,i=e;o<i.length;o++){var a=i[o];if(r[a]!==t[a])return!1}return!0},t.default=t.shallowCompare}},i={};return function r(t){var e=i[t];if(void 0!==e)return e.exports;var n=i[t]={exports:{}};return o[t](n,n.exports,r),n.exports}(973)})(),"object"==typeof exports&&"object"==typeof module?module.exports=t(require("json-storage-formatter/isDate"),require("./isRecord.js"),require("json-storage-formatter/isNil"),require("json-storage-formatter/isPrimitive")):"function"==typeof define&&define.amd?define(["json-storage-formatter/isDate","./isRecord.js","json-storage-formatter/isNil","json-storage-formatter/isPrimitive"],t):"object"==typeof exports?exports["react-hooks-global-states"]=t(require("json-storage-formatter/isDate"),require("./isRecord.js"),require("json-storage-formatter/isNil"),require("json-storage-formatter/isPrimitive")):r["react-hooks-global-states"]=t(r["json-storage-formatter/isDate"],r["./isRecord.js"],r["json-storage-formatter/isNil"],r["json-storage-formatter/isPrimitive"]);
+var r,t;r=this,t=(r,t,e,n)=>/******/(()=>{
+/******/"use strict";
+/******/var o={
+/***/38:
+/***/t=>{t.exports=r;
+/***/},
+/***/487:
+/***/r=>{r.exports=t;
+/***/},
+/***/773:
+/***/r=>{r.exports=e;
+/***/},
+/***/955:
+/***/r=>{r.exports=n;
+/***/},
+/***/973:
+/***/(r,t,e)=>{function n(r,t){var e="undefined"!=typeof Symbol&&r[Symbol.iterator]||r["@@iterator"];if(!e){if(Array.isArray(r)||(e=o(r))||t&&r&&"number"==typeof r.length){e&&(r=e);var n=0,i=function(){};return{s:i,n:function(){return n>=r.length?{done:!0}:{done:!1,value:r[n++]}},e:function(r){throw r},f:i}}throw new TypeError("Invalid attempt to iterate non-iterable instance.\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method.")}var a,s=!0,u=!1;return{s:function(){e=e.call(r)},n:function(){var r=e.next();return s=r.done,r},e:function(r){u=!0,a=r},f:function(){try{s||null==e.return||e.return()}finally{if(u)throw a}}}}function o(r,t){if(r){if("string"==typeof r)return i(r,t);var e={}.toString.call(r).slice(8,-1);return"Object"===e&&r.constructor&&(e=r.constructor.name),"Map"===e||"Set"===e?Array.from(r):"Arguments"===e||/^(?:Ui|I)nt(?:8|16|32)(?:Clamped)?Array$/.test(e)?i(r,t):void 0}}function i(r,t){(null==t||t>r.length)&&(t=r.length);for(var e=0,n=Array(t);e<t;e++)n[e]=r[e];return n}function a(r){return a="function"==typeof Symbol&&"symbol"==typeof Symbol.iterator?function(r){return typeof r}:function(r){return r&&"function"==typeof Symbol&&r.constructor===Symbol&&r!==Symbol.prototype?"symbol":typeof r},a(r)}Object.defineProperty(t,"__esModule",{value:!0}),t.isEqualObject=t.isEqualSet=t.isEqualMap=t.isEqualArray=t.canCheckSimpleEquality=t.isSet=t.isMap=t.isArray=t.shallowCompare=void 0;var s=e(955),u=e(38),l=e(773),f=e(487);t.shallowCompare=function(r,e){return!(r!==e)||((0,t.canCheckSimpleEquality)(r,e)?r===e:(0,t.isArray)(r)&&(0,t.isArray)(e)?(0,t.isEqualArray)(r,e):(0,t.isMap)(r)&&(0,t.isMap)(e)?(0,t.isEqualMap)(r,e):(0,t.isSet)(r)&&(0,t.isSet)(e)?(0,t.isEqualSet)(r,e):(0,f.isRecord)(r)&&(0,f.isRecord)(e)?(0,t.isEqualObject)(r,e):r===e)},t.isArray=function(r){return Array.isArray(r)},t.isMap=function(r){return r instanceof Map},t.isSet=function(r){return r instanceof Set},t.canCheckSimpleEquality=function(r,t){var e=a(r),n=a(t);return e!==n||(0,l.isNil)(r)||(0,l.isNil)(t)||(0,s.isPrimitive)(r)&&(0,s.isPrimitive)(t)||(0,u.isDate)(r)&&(0,u.isDate)(t)||"function"===e&&"function"===n},t.isEqualArray=function(r,t){if(r.length!==t.length)return!1;for(var e=0;e<r.length;e+=1)if(r[e]!==t[e])return!1;return!0},t.isEqualMap=function(r,t){if(r.size!==t.size)return!1;var e,i,a=n(r);try{for(a.s();!(e=a.n()).done;){var s=function(r){if(Array.isArray(r))return r}(i=e.value)||function(r){var t=null==r?null:"undefined"!=typeof Symbol&&r[Symbol.iterator]||r["@@iterator"];if(null!=t){var e,n,o,i,a=[],s=!0,u=!1;try{for(o=(t=t.call(r)).next;!(s=(e=o.call(t)).done)&&(a.push(e.value),2!==a.length);s=!0);}catch(r){u=!0,n=r}finally{try{if(!s&&null!=t.return&&(i=t.return(),Object(i)!==i))return}finally{if(u)throw n}}return a}}(i)||o(i,2)||function(){throw new TypeError("Invalid attempt to destructure non-iterable instance.\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method.")}(),u=s[0];if(s[1]!==t.get(u))return!1}}catch(r){a.e(r)}finally{a.f()}return!0},t.isEqualSet=function(r,t){if(r.size!==t.size)return!1;var e,o=n(r);try{for(o.s();!(e=o.n()).done;){var i=e.value;if(!t.has(i))return!1}}catch(r){o.e(r)}finally{o.f()}return!0},t.isEqualObject=function(r,t){var e=Object.keys(r),n=Object.keys(t);if(e.length!==n.length)return!1;for(var o=0,i=e;o<i.length;o++){var a=i[o];if(r[a]!==t[a])return!1}return!0},t.default=t.shallowCompare}
+/***/
+/******/},i={};
+/************************************************************************/
+/******/
+/******/
+/******/
+/******/
+/******/
+/******/
+/******/return function r(t){
+/******/
+/******/var e=i[t];
+/******/if(void 0!==e)
+/******/return e.exports;
+/******/
+/******/
+/******/var n=i[t]={
+/******/
+/******/
+/******/exports:{}
+/******/};
+/******/
+/******/
+/******/
+/******/
+/******/
+/******/return o[t](n,n.exports,r),n.exports;
+/******/}
+/******/
+/************************************************************************/
+/******/
+/******/
+/******/
+/******/
+/******/(973);
+/******/})(),"object"==typeof exports&&"object"==typeof module?module.exports=t(require("json-storage-formatter/isDate"),require("./isRecord.js"),require("json-storage-formatter/isNil"),require("json-storage-formatter/isPrimitive")):"function"==typeof define&&define.amd?define(["json-storage-formatter/isDate","./isRecord.js","json-storage-formatter/isNil","json-storage-formatter/isPrimitive"],t):"object"==typeof exports?exports["react-hooks-global-states"]=t(require("json-storage-formatter/isDate"),require("./isRecord.js"),require("json-storage-formatter/isNil"),require("json-storage-formatter/isPrimitive")):r["react-hooks-global-states"]=t(r["json-storage-formatter/isDate"],r["./isRecord.js"],r["json-storage-formatter/isNil"],r["json-storage-formatter/isPrimitive"]);

package/throwWrongKeyOnActionCollectionConfig.js

@@ -1 +1,16 @@
-var t;t=()=>(()=>{"use strict";var t={};return((t,e)=>{Object.defineProperty(e,"__esModule",{value:!0}),e.throwWrongKeyOnActionCollectionConfig=void 0,e.throwWrongKeyOnActionCollectionConfig=function(t){throw new Error("[WRONG CONFIGURATION!]: Every key inside the storeActionsConfig must be a higher order function that returns a function \n[".concat(t,"]: key is not a valid function, try something like this: \n{\n\n    ").concat(t,": (param) => ({ setState, getState, setMetadata, getMetadata, actions }) => {\n\n      setState((state) => ({ ...state, ...param }))\n\n    }\n\n}\n"))},e.default=e.throwWrongKeyOnActionCollectionConfig})(0,t),t})(),"object"==typeof exports&&"object"==typeof module?module.exports=t():"function"==typeof define&&define.amd?define([],t):"object"==typeof exports?exports["react-hooks-global-states"]=t():this["react-hooks-global-states"]=t();
+var t;t=()=>/******/(()=>{
+/******/"use strict";
+/******/var t={};
+/************************************************************************/
+/******/
+/******/
+/******/
+/******/
+/******/
+/******/
+/******/
+/******/
+/***/return((t,e)=>{Object.defineProperty(e,"__esModule",{value:!0}),e.throwWrongKeyOnActionCollectionConfig=void 0,e.throwWrongKeyOnActionCollectionConfig=function(t){throw new Error("[WRONG CONFIGURATION!]: Every key inside the storeActionsConfig must be a higher order function that returns a function \n[".concat(t,"]: key is not a valid function, try something like this: \n{\n\n    ").concat(t,": (param) => ({ setState, getState, setMetadata, getMetadata, actions }) => {\n\n      setState((state) => ({ ...state, ...param }))\n\n    }\n\n}\n"))},e.default=e.throwWrongKeyOnActionCollectionConfig})
+/***/
+/******/(0,t),t;
+/******/})(),"object"==typeof exports&&"object"==typeof module?module.exports=t():"function"==typeof define&&define.amd?define([],t):"object"==typeof exports?exports["react-hooks-global-states"]=t():this["react-hooks-global-states"]=t();

package/types.d.ts

@@ -1,68 +1,75 @@
-export type StateSetter<State> = (setter: State | ((state: State) => State), meta?: {
+export type AnyFunction = (...args: any[]) => any;
+/**
+ * @description Represents the complete non-reactive API of a global state instance.
+ * This API provides full control over the state, including reading, writing, subscribing,
+ * and creating derived hooks or observable fragments.
+ */
+export type StateApi<State, StateDispatch, StateMutator, Metadata extends BaseMetadata> = {
     /**
-     * @description you can add an identifier to the state call
-     * this will show up in the devtools to help you identify from where the state change was called
+     * Returns the metadata
+     * Metadata is additional non reactive information associated with the global state
      */
-    identifier?: string | undefined;
+    getMetadata: MetadataGetter<Metadata>;
     /**
-     * @deprecated forceUpdate normally should not be used inside components
-     * Use this flag just in custom implementations of the global store
+     * Sets the metadata value
+     * The metadata value is not reactive and wont trigger re-renders
      */
-    forceUpdate?: boolean | undefined;
-}) => void;
-export type HookExtensions<State, StateMutator, Metadata extends BaseMetadata | unknown> = {
+    setMetadata: MetadataSetter<Metadata>;
+    /**
+     * @description Contains the generated action functions if custom actions are defined.
+     * When actions exist, direct state mutation via `setState` is disabled and setState will be `null`.
+     * If no actions are provided, this property is `null`.
+     */
+    actions: StateMutator extends AnyFunction ? null : StateMutator;
+    /**
+     * @description Provides direct access to the state updater when no custom actions are defined.
+     * When actions exist, direct state mutation via `setState` is disabled and this property will be `null`.
+     * If no actions are provided, this property exposes the `setState` function.
+     */
+    setState: StateMutator extends AnyFunction ? StateDispatch : null;
     /**
-     * @description Return the state controls of the hook
-     * This selectors includes:
-     * - stateRetriever: a function to get the current state or subscribe a callback to the state changes
-     * - stateMutator: a function to set the state or a collection of actions if you pass an storeActionsConfig configuration
-     * - metadataRetriever: a function to get the metadata of the global state
+     * @description Get the current state value
      */
-    stateControls: () => Readonly<[
-        retriever: StateGetter<State>,
-        mutator: StateMutator,
-        metadata: MetadataGetter<Metadata>
-    ]>;
+    getState: () => State;
+    /**
+     * @description Subscribe to the state changes
+     * You can subscribe to the whole state or to a fragment of the state by passing a selector as first parameter,
+     * this can be used in non react environments to listen to the state changes
+     */
+    subscribe: SubscribeToState<State>;
     /***
      * @description Creates a new hooks that returns the result of the selector passed as a parameter
      * Your can create selector hooks of other selectors hooks and extract as many derived states as or fragments of the state as you want
      * The selector hook will be evaluated only if the result of the selector changes and the equality function returns false
      * you can customize the equality function by passing the isEqualRoot and isEqual parameters
      */
-    createSelectorHook: <Derivate>(this: StateHook<State, StateMutator, Metadata>, selector: (state: State) => Derivate, args?: Omit<UseHookConfig<Derivate, State>, 'dependencies'> & {
-        name?: string;
-    }) => StateHook<Derivate, StateMutator, Metadata>;
-    createObservable: <Fragment>(this: StateHook<State, StateMutator, Metadata>, mainSelector: (state: State) => Fragment, args?: {
-        isEqual?: (current: Fragment, next: Fragment) => boolean;
-        isEqualRoot?: (current: State, next: State) => boolean;
+    createSelectorHook: <Selection>(selector: (state: State) => Selection, args?: Omit<UseHookConfig<Selection, State>, 'dependencies'> & {
         name?: string;
-    }) => ObservableFragment<Fragment>;
-    removeSubscriptions: () => void;
-    dispose: () => void;
-};
-export type ObservableFragment<State> = StateGetter<State> & {
-    createObservable: <Fragment>(this: ObservableFragment<State>, mainSelector: (state: State) => Fragment, args?: {
-        isEqual?: (current: Fragment, next: Fragment) => boolean;
+    }) => StateHook<Selection, StateDispatch, StateMutator, Metadata>;
+    /**
+     * @description Creates a function that allows you to subscribe to a fragment of the state
+     * The observable selection will notify the subscribers only if the fragment changes and the equality function returns false
+     * you can customize the equality function by passing the isEqualRoot and isEqual parameters
+     */
+    createObservable: <Selection>(this: StateApi<State, StateDispatch, StateMutator, Metadata>, selector: (state: State) => Selection, args?: {
+        isEqual?: (current: Selection, next: Selection) => boolean;
         isEqualRoot?: (current: State, next: State) => boolean;
+        /**
+         * @description Name of the observable fragment for debugging purposes
+         */
         name?: string;
-    }) => ObservableFragment<Fragment>;
-    removeSubscriptions: () => void;
-    _name: string | undefined;
+    }) => ObservableFragment<Selection, StateDispatch, StateMutator, Metadata>;
 };
-export interface StateHook<State, StateMutator, Metadata extends BaseMetadata | unknown> extends HookExtensions<State, StateMutator, Metadata> {
+/**
+ * @description Function that allows you to subscribe to a fragment of the state
+ */
+export type ObservableFragment<State, StateDispatch, StateMutator, Metadata extends BaseMetadata> = SubscribeToState<State> & StateApi<State, StateDispatch, StateMutator, Metadata>;
+export interface StateHook<State, StateDispatch, StateMutator, Metadata extends BaseMetadata> extends StateApi<State, StateDispatch, StateMutator, Metadata> {
     (): Readonly<[state: State, stateMutator: StateMutator, metadata: Metadata]>;
-    <Derivate>(selector: (state: State) => Derivate, dependencies?: unknown[]): Readonly<[
-        state: Derivate,
-        stateMutator: StateMutator,
-        metadata: Metadata
-    ]>;
-    <Derivate>(selector: (state: State) => Derivate, config?: UseHookConfig<Derivate, State>): Readonly<[
-        state: Derivate,
-        stateMutator: StateMutator,
-        metadata: Metadata
-    ]>;
+    <Derivate>(selector: (state: State) => Derivate, dependencies?: unknown[]): Readonly<[state: Derivate, stateMutator: StateMutator, metadata: Metadata]>;
+    <Derivate>(selector: (state: State) => Derivate, config?: UseHookConfig<Derivate, State>): Readonly<[state: Derivate, stateMutator: StateMutator, metadata: Metadata]>;
 }
-export type MetadataSetter<Metadata extends BaseMetadata | unknown> = (setter: Metadata | ((metadata: Metadata) => Metadata)) => void;
+export type MetadataSetter<Metadata extends BaseMetadata> = (setter: Metadata | ((metadata: Metadata) => Metadata)) => void;
 export type StateChanges<State> = {
     state: State;
     previousState: State | undefined;
@@ -71,31 +78,51 @@ export type StateChanges<State> = {
 /**
  * API for the actions of the global states
  **/
-export type StoreTools<State, Metadata extends BaseMetadata | unknown = BaseMetadata, Actions extends undefined | unknown | Record<string, (...args: any[]) => any> = unknown> = {
+export type StoreTools<State, Metadata extends BaseMetadata = BaseMetadata, Actions extends undefined | unknown | Record<string, AnyFunction> = unknown> = {
     setMetadata: MetadataSetter<Metadata>;
-    setState: StateSetter<State>;
-    getState: StateGetter<State>;
+    setState: React.Dispatch<React.SetStateAction<State>>;
+    getState: () => State;
+    subscribe: SubscribeToState<State>;
     getMetadata: () => Metadata;
     actions: Actions;
 };
 /**
  * contract for the storeActionsConfig configuration
  */
-export interface ActionCollectionConfig<State, Metadata extends BaseMetadata | unknown, ThisAPI = Record<string, (...parameters: any[]) => unknown>> {
+export interface ActionCollectionConfig<State, Metadata extends BaseMetadata, ThisAPI = Record<string, (...parameters: any[]) => unknown>> {
     readonly [key: string]: {
         (this: ThisAPI, ...parameters: any[]): (this: ThisAPI, storeTools: StoreTools<State, Metadata, Record<string, (...parameters: any[]) => unknown | void>>) => unknown | void;
     };
 }
-export type ActionCollectionResult<State, Metadata extends BaseMetadata | unknown, ActionsConfig extends ActionCollectionConfig<State, Metadata>> = {
+export type ActionCollectionResult<State, Metadata extends BaseMetadata, ActionsConfig extends ActionCollectionConfig<State, Metadata>> = {
     [key in keyof ActionsConfig]: {
         (...params: Parameters<ActionsConfig[key]>): ReturnType<ReturnType<ActionsConfig[key]>>;
     };
 };
-export type GlobalStoreCallbacks<State, Metadata extends BaseMetadata | unknown> = {
+/**
+ * Callbacks for the global store lifecycle events
+ */
+export type GlobalStoreCallbacks<State, Metadata extends BaseMetadata> = {
+    /**
+     * @description Called when the store is initialized
+     */
     onInit?: (args: StoreTools<State, Metadata>) => void;
+    /**
+     * @description Called when the state has changed
+     */
     onStateChanged?: (args: StoreTools<State, Metadata> & StateChanges<State>) => void;
+    /**
+     * @description Called when a new subscription is created
+     */
     onSubscribed?: (args: StoreTools<State, Metadata>, subscription: SubscriberParameters) => void;
+    /**
+     * @description Called to determine whether to prevent a state change
+     */
     computePreventStateChange?: (args: StoreTools<State, Metadata> & StateChanges<State>) => boolean;
+    /**
+     * @description Called when the store is unmounted, only applicable in context stores
+     */
+    onUnMount?: (store: StateApi<State, any, any, Metadata>) => void;
 };
 export type UseHookConfig<State, TRoot = any> = {
     isEqual?: (current: State, next: State) => boolean;
@@ -114,24 +141,24 @@ export type SubscribeCallbackConfig<State> = UseHookConfig<State> & {
  */
 export type SubscribeCallback<State> = (state: State) => void;
 /**
- * get the current state or subscribe to the state changes
+ * @description Subscribe to the state changes
+ * You can subscribe to the whole state or to a fragment of the state by passing a selector as first parameter
+ * This can be used in non react environments to listen to the state changes
  */
-export type StateGetter<State> = {
-    (): State;
+export type SubscribeToState<State> = {
     (subscription: SubscribeCallback<State>, config?: SubscribeCallbackConfig<State>): UnsubscribeCallback;
     <TDerivate>(selector: SelectorCallback<State, TDerivate>, subscription: SubscribeCallback<TDerivate>, config?: SubscribeCallbackConfig<TDerivate>): UnsubscribeCallback;
 };
 export type BaseMetadata = Record<string, unknown>;
-export type MetadataGetter<Metadata extends BaseMetadata | unknown> = () => Metadata;
-export type CustomGlobalHookBuilderParams<TCustomConfig extends BaseMetadata | unknown, Metadata extends BaseMetadata | unknown> = {
+export type MetadataGetter<Metadata extends BaseMetadata> = () => Metadata;
+export type CustomGlobalHookBuilderParams<TCustomConfig extends BaseMetadata | unknown, Metadata extends BaseMetadata> = {
     onInitialize?: (args: StoreTools<unknown, Metadata, unknown>, config: TCustomConfig | undefined) => void;
     onChange?: (args: StoreTools<unknown, Metadata, unknown> & StateChanges<unknown>, config: TCustomConfig | undefined) => void;
 };
 export type SelectorCallback<State, TDerivate> = (state: State) => TDerivate;
 export type SubscriberParameters = {
-    subscriptionId: string;
-    selector: SelectorCallback<unknown, unknown> | undefined;
-    getConfig: () => UseHookConfig<unknown> | SubscribeCallbackConfig<unknown> | undefined;
+    selector: SelectorCallback<any, any> | undefined;
+    getConfig: () => UseHookConfig<any> | SubscribeCallbackConfig<any> | undefined;
     currentState: unknown;
     callback: SubscriptionCallback | (() => void);
 };

package/types.js

@@ -1 +1,4 @@
-var e;e=()=>(()=>{"use strict";var e={};return(()=>{var t=e;Object.defineProperty(t,"__esModule",{value:!0})})(),e})(),"object"==typeof exports&&"object"==typeof module?module.exports=e():"function"==typeof define&&define.amd?define([],e):"object"==typeof exports?exports["react-hooks-global-states"]=e():this["react-hooks-global-states"]=e();
+var e;e=()=>/******/(()=>{
+/******/"use strict";var e={};
+/******/return(()=>{var t=e;Object.defineProperty(t,"__esModule",{value:!0})})(),e;
+/******/})(),"object"==typeof exports&&"object"==typeof module?module.exports=e():"function"==typeof define&&define.amd?define([],e):"object"==typeof exports?exports["react-hooks-global-states"]=e():this["react-hooks-global-states"]=e();

package/uniqueId.js

@@ -1 +1,16 @@
-var e;e=()=>(()=>{"use strict";var e={};return((e,t)=>{var o;Object.defineProperty(t,"__esModule",{value:!0}),t.uniqueId=void 0,t.uniqueId=(o=0,function(){var e=arguments.length>0&&void 0!==arguments[0]?arguments[0]:"";return o===Number.MAX_SAFE_INTEGER&&(o=0),e+Date.now().toString(36)+(o++).toString(36)}),t.default=t.uniqueId})(0,e),e})(),"object"==typeof exports&&"object"==typeof module?module.exports=e():"function"==typeof define&&define.amd?define([],e):"object"==typeof exports?exports["react-hooks-global-states"]=e():this["react-hooks-global-states"]=e();
+var e;e=()=>/******/(()=>{
+/******/"use strict";
+/******/var e={};
+/************************************************************************/
+/******/
+/******/
+/******/
+/******/
+/******/
+/******/
+/******/
+/******/
+/***/return((e,t)=>{var o;Object.defineProperty(t,"__esModule",{value:!0}),t.uniqueId=void 0,t.uniqueId=(o=0,function(){var e=arguments.length>0&&void 0!==arguments[0]?arguments[0]:"";return o===Number.MAX_SAFE_INTEGER&&(o=0),e+Date.now().toString(36)+(o++).toString(36)}),t.default=t.uniqueId})
+/***/
+/******/(0,e),e;
+/******/})(),"object"==typeof exports&&"object"==typeof module?module.exports=e():"function"==typeof define&&define.amd?define([],e):"object"==typeof exports?exports["react-hooks-global-states"]=e():this["react-hooks-global-states"]=e();

package/webpack.config.js

@@ -5,15 +5,12 @@ const individualEntries = {
   createContext: './src/createContext.ts',
   GlobalStore: './src/GlobalStore.ts',
   GlobalStoreAbstract: './src/GlobalStoreAbstract.ts',
-  createCustomGlobalState: './src/createCustomGlobalState.ts',
   createGlobalState: './src/createGlobalState.ts',
   types: './src/types.ts',
   isRecord: './src/isRecord.ts',
   shallowCompare: './src/shallowCompare.ts',
   throwWrongKeyOnActionCollectionConfig: './src/throwWrongKeyOnActionCollectionConfig.ts',
   uniqueId: './src/uniqueId.ts',
-  useStableState: './src/useStableState.ts',
-  generateStackHash: './src/generateStackHash.ts',
 };
 
 const getExternalsForEntries = () => {
@@ -106,8 +103,11 @@ module.exports = {
             toplevel: true,
             properties: false,
           },
-          format: {
-            comments: false,
+          output: {
+            // Keep only JSDoc-style comments (/** ... */)
+            comments: (_node, comment) => {
+              return comment.type === 'comment2' && comment.value.startsWith('*');
+            },
           },
         },
       }),

package/createCustomGlobalState.d.ts

@@ -1,23 +0,0 @@
-import type { ActionCollectionConfig, StateSetter, ActionCollectionResult, StateHook, CustomGlobalHookBuilderParams, BaseMetadata, GlobalStoreCallbacks } from './types';
-export interface CustomCreateGlobalState<TCustomConfig extends BaseMetadata | unknown, InheritMetadata extends BaseMetadata | unknown = BaseMetadata> {
-    <State>(state: State): StateHook<State, StateSetter<State>, BaseMetadata>;
-    <State, Metadata extends BaseMetadata | unknown, ActionsConfig extends ActionCollectionConfig<State, InheritMetadata & Metadata> | null | {}, PublicStateMutator = keyof ActionsConfig extends never | undefined ? StateSetter<State> : ActionCollectionResult<State, InheritMetadata & Metadata, NonNullable<ActionsConfig>>>(state: State, args: {
-        name?: string;
-        metadata?: Metadata;
-        callbacks?: GlobalStoreCallbacks<State, InheritMetadata & Metadata>;
-        actions?: ActionsConfig;
-        config?: TCustomConfig;
-    }): StateHook<State, PublicStateMutator, InheritMetadata & Metadata>;
-    <State, Metadata extends BaseMetadata | unknown, ActionsConfig extends Readonly<ActionCollectionConfig<State, InheritMetadata & Metadata>>>(state: State, args: {
-        name?: string;
-        metadata?: Metadata;
-        callbacks?: GlobalStoreCallbacks<State, InheritMetadata & Metadata>;
-        actions: ActionsConfig;
-        config?: TCustomConfig;
-    }): StateHook<State, ActionCollectionResult<State, InheritMetadata & Metadata, ActionsConfig>, InheritMetadata & Metadata>;
-}
-/**
- * @description Simple custom global state hook builder
- */
-export declare const createCustomGlobalState: <TCustomConfig extends BaseMetadata | unknown, InheritMetadata extends BaseMetadata | unknown = BaseMetadata>({ onInitialize, onChange, }: CustomGlobalHookBuilderParams<TCustomConfig, InheritMetadata>) => CustomCreateGlobalState<TCustomConfig, InheritMetadata>;
-export default createCustomGlobalState;

package/createCustomGlobalState.js

@@ -1 +0,0 @@
-var e;e=e=>(()=>{"use strict";var t={154:(e,t,o)=>{Object.defineProperty(t,"__esModule",{value:!0}),t.createCustomGlobalState=void 0;var a=o(670);t.createCustomGlobalState=function(e){var t=e.onInitialize,o=e.onChange;return function(e){var l=arguments.length>1&&void 0!==arguments[1]?arguments[1]:{},n=l.callbacks,r=function(e,t){var o={};for(var a in e)Object.prototype.hasOwnProperty.call(e,a)&&t.indexOf(a)<0&&(o[a]=e[a]);if(null!=e&&"function"==typeof Object.getOwnPropertySymbols){var l=0;for(a=Object.getOwnPropertySymbols(e);l<a.length;l++)t.indexOf(a[l])<0&&Object.prototype.propertyIsEnumerable.call(e,a[l])&&(o[a[l]]=e[a[l]])}return o}(l,["callbacks"]);return(0,a.createGlobalState)(e,Object.assign(Object.assign({},r),{callbacks:Object.assign(Object.assign({},null!=n?n:{}),{onInit:function(e){var o;null==t||t(e,null==r?void 0:r.config),null===(o=null==n?void 0:n.onInit)||void 0===o||o.call(n,e)},onStateChanged:function(e){var t;null==o||o(e,null==r?void 0:r.config),null===(t=null==n?void 0:n.onStateChanged)||void 0===t||t.call(n,e)}})}))}},t.default=t.createCustomGlobalState},670:t=>{t.exports=e}},o={};return function e(a){var l=o[a];if(void 0!==l)return l.exports;var n=o[a]={exports:{}};return t[a](n,n.exports,e),n.exports}(154)})(),"object"==typeof exports&&"object"==typeof module?module.exports=e(require("./createGlobalState.js")):"function"==typeof define&&define.amd?define(["./createGlobalState.js"],e):"object"==typeof exports?exports["react-hooks-global-states"]=e(require("./createGlobalState.js")):this["react-hooks-global-states"]=e(this["./createGlobalState.js"]);

package/generateStackHash.d.ts

@@ -1,2 +0,0 @@
-export declare const generateStackHash: (stack: string) => string;
-export default generateStackHash;

package/generateStackHash.js

@@ -1 +0,0 @@
-var e;e=()=>(()=>{"use strict";var e={};return((e,t)=>{Object.defineProperty(t,"__esModule",{value:!0}),t.generateStackHash=void 0,t.generateStackHash=function(e){if(!e.trim())return"unknown";e=e.replace(/\s/g,"");for(var t=2166136261,o=0;o<e.length;o++)t^=e.charCodeAt(o),t*=16777619,t&=4294967295;return function(e){for(var t="";e>0;)t="0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ"[e%62]+t,e=Math.floor(e/62);return t||"0"}(t>>>0)},t.default=t.generateStackHash})(0,e),e})(),"object"==typeof exports&&"object"==typeof module?module.exports=e():"function"==typeof define&&define.amd?define([],e):"object"==typeof exports?exports["react-hooks-global-states"]=e():this["react-hooks-global-states"]=e();