react-hooks-global-states 15.0.16 → 15.0.18

package/README.md

@@ -905,6 +905,9 @@ const DataContext = createContext([], {
         console.log('Provider unmounting!');
       };
     },
+    onRender: (store) => {
+      console.log('Provider rendered!');
+    },
   },
 });
 
@@ -917,6 +920,7 @@ function App() {
         console.log('Mounted!');
         return () => console.log('Cleanup!');
       }}
+      onRender={(store) => console.log('Executes on every provider render!')}
     >
       <Content />
     </DataContext.Provider>

package/createContext.js

@@ -1 +1 @@
-var e,t;e=this,t=(e,t,r,o,a)=>(()=>{"use strict";var s={12:t=>{t.exports=e},78:e=>{e.exports=t},506:e=>{e.exports=r},695:function(e,t,r){var o=this&&this.__rest||function(e,t){var r={};for(var o in e)Object.prototype.hasOwnProperty.call(e,o)&&t.indexOf(o)<0&&(r[o]=e[o]);if(null!=e&&"function"==typeof Object.getOwnPropertySymbols){var a=0;for(o=Object.getOwnPropertySymbols(e);a<o.length;a++)t.indexOf(o[a])<0&&Object.prototype.propertyIsEnumerable.call(e,o[a])&&(r[o[a]]=e[o[a]])}return r},a=this&&this.__importDefault||function(e){return e&&e.__esModule?e:{default:e}};Object.defineProperty(t,"__esModule",{value:!0}),t.createContext=void 0;const s=r(12),n=r(778),l=a(r(506)),u=a(r(773)),i=a(r(78));function c(e,t){var r;const o=null!==(r=null==t?void 0:t.name)&&void 0!==r?r:(0,i.default)("sh:"),a=(...r)=>{const a=this.api();return(0,s.useDebugValue)(`${this.displayName}:selector`),(0,s.useDebugValue)(`${o}:use`),(0,s.useMemo)((()=>a.createSelectorHook(e,t)),[a])(...r)},l={displayName:this.displayName,createSelectorHook:c.bind(a),api:()=>{(0,s.useDebugValue)(`${this.displayName}:selector`),(0,s.useDebugValue)(`${o}:api`);const r=this.api();return(0,s.useMemo)((()=>{const o=r.createObservable(e,t);return Object.assign(Object.assign({},r),{getState:()=>o.getState(),subscribe:o.subscribe.bind(o),createSelectorHook:n.createSelectorHook.bind(o),createObservable:n.createObservable.bind(o)})}),[r])}};return Object.assign(a,l),a}t.createContext=(e,t={})=>{var r;const a=(0,s.createContext)(null),d=null!==(r=t.name)&&void 0!==r?r:(0,i.default)("ctx:"),v=r=>{const i=(r=>{var{value:a}=r,i=o(r,["value"]);(0,s.useDebugValue)(`${d}:Provider`);const c=(0,s.useMemo)((()=>{var r,o,s,c;const d=()=>(0,l.default)(e)?e():e,v=(0,u.default)(a)?d():(0,l.default)(a)?a(d()):a,b=new n.GlobalStore(v,Object.assign(Object.assign({},t),{metadata:null!==(r=(0,l.default)(t.metadata)?t.metadata():t.metadata)&&void 0!==r?r:{}})),f={use:p};return Object.assign(b.storeTools,f),null===(s=null===(o=t.callbacks)||void 0===o?void 0:o.onCreated)||void 0===s||s.call(o,b.storeTools,b),null===(c=i.onCreated)||void 0===c||c.call(i,b.storeTools,b),b}),[]);return(0,s.useEffect)((()=>{var e,r,o;const a=[null===(r=null===(e=t.callbacks)||void 0===e?void 0:e.onMounted)||void 0===r?void 0:r.call(e,c.storeTools,c),null===(o=i.onMounted)||void 0===o?void 0:o.call(i,c.storeTools,c)].filter(Boolean);return()=>{var e,t,r,o;null===(t=null===(e=c.callbacks)||void 0===e?void 0:e.onUnMount)||void 0===t||t.call(e,c),a.forEach((e=>null==e?void 0:e())),null===(o=(r=c).__onUnMountContext)||void 0===o||o.call(r,c)}}),[c]),c})(r);return(0,s.createElement)(a.Provider,{value:i.use},r.children)};v.displayName=`${d}:Provider`,a.displayName=`${d}`;const b={makeProviderWrapper:e=>{const t={current:void 0,instance:void 0};return{wrapper:r=>{var{children:a}=r,n=o(r,["children"]);return(0,s.createElement)(v,Object.assign(Object.assign(Object.assign({},e),n),{onCreated:(r,o)=>{var a;t.current=r,t.instance=o,null===(a=null==e?void 0:e.onCreated)||void 0===a||a.call(e,r,o)}}),a)},context:t}}},p=(...e)=>{(0,s.useDebugValue)(`${d}:use`);const t=(0,s.useContext)(a);if(!t)throw new Error("use hook must be used within a ContextProvider");return t(...e)},f=()=>{(0,s.useDebugValue)(`${d}:api`);const e=(0,s.useContext)(a);if(!e)throw new Error("api hook must be used within a ContextProvider");return e},m={displayName:a.displayName,createSelectorHook:c.bind(p),api:f,select:(...e)=>p(...e)[0],observable:(...e)=>{(0,s.useDebugValue)(`${d}:observable`);const t=f(),r=(0,s.useRef)(e);return r.current=e,(0,s.useMemo)((()=>{var e,o,a;return t.createObservable((e=>(0,r.current[0])(e)),{isEqualRoot:(null===(e=r.current[1])||void 0===e?void 0:e.isEqualRoot)?(e,t)=>{const o=r.current[1].isEqualRoot;return Boolean(o(e,t))}:void 0,isEqual:(null===(o=r.current[1])||void 0===o?void 0:o.isEqual)?(e,t)=>{const o=r.current[1].isEqual;return Boolean(o(e,t))}:void 0,name:null===(a=r.current[1])||void 0===a?void 0:a.name})}),[t])},actions:()=>f().actions};return Object.assign(v,b),Object.assign(p,m),{use:p,Provider:v,Context:a}},t.default=t.createContext},773:e=>{e.exports=o},778:e=>{e.exports=a}},n={};return function e(t){var r=n[t];if(void 0!==r)return r.exports;var o=n[t]={exports:{}};return s[t].call(o.exports,o,o.exports,e),o.exports}(695)})(),"object"==typeof exports&&"object"==typeof module?module.exports=t(require("react"),require("./uniqueId.js"),require("json-storage-formatter/isFunction"),require("json-storage-formatter/isNil"),require("./GlobalStore.js")):"function"==typeof define&&define.amd?define(["react","./uniqueId.js","json-storage-formatter/isFunction","json-storage-formatter/isNil","./GlobalStore.js"],t):"object"==typeof exports?exports["react-hooks-global-states"]=t(require("react"),require("./uniqueId.js"),require("json-storage-formatter/isFunction"),require("json-storage-formatter/isNil"),require("./GlobalStore.js")):e["react-hooks-global-states"]=t(e.React,e["./uniqueId.js"],e["json-storage-formatter/isFunction"],e["json-storage-formatter/isNil"],e["./GlobalStore.js"]);
+var e,t;e=this,t=(e,t,o,r)=>(()=>{"use strict";var a={12:t=>{t.exports=e},78:e=>{e.exports=t},506:e=>{e.exports=o},695:function(e,t,o){var r=this&&this.__rest||function(e,t){var o={};for(var r in e)Object.prototype.hasOwnProperty.call(e,r)&&t.indexOf(r)<0&&(o[r]=e[r]);if(null!=e&&"function"==typeof Object.getOwnPropertySymbols){var a=0;for(r=Object.getOwnPropertySymbols(e);a<r.length;a++)t.indexOf(r[a])<0&&Object.prototype.propertyIsEnumerable.call(e,r[a])&&(o[r[a]]=e[r[a]])}return o},a=this&&this.__importDefault||function(e){return e&&e.__esModule?e:{default:e}};Object.defineProperty(t,"__esModule",{value:!0}),t.createContext=void 0;const n=o(12),s=o(778),l=a(o(506)),u=a(o(78));function i(e,t){var o;const r=null!==(o=null==t?void 0:t.name)&&void 0!==o?o:(0,u.default)("sh:"),a=(...o)=>{const a=this.api();return(0,n.useDebugValue)(`${this.displayName}:selector`),(0,n.useDebugValue)(`${r}:use`),(0,n.useMemo)((()=>a.createSelectorHook(e,t)),[a])(...o)},l={displayName:this.displayName,createSelectorHook:i.bind(a),api:()=>{(0,n.useDebugValue)(`${this.displayName}:selector`),(0,n.useDebugValue)(`${r}:api`);const o=this.api();return(0,n.useMemo)((()=>{const r=o.createObservable(e,t);return Object.assign(Object.assign({},o),{getState:()=>r.getState(),subscribe:r.subscribe.bind(r),createSelectorHook:s.createSelectorHook.bind(r),createObservable:s.createObservable.bind(r)})}),[o])}};return Object.assign(a,l),a}t.createContext=(e,t={})=>{var o;const a=(0,n.createContext)(null),c=null!==(o=t.name)&&void 0!==o?o:(0,u.default)("ctx:"),d=()=>(0,l.default)(e)?e():e,v=e=>Object.prototype.hasOwnProperty.call(e,"value"),b=e=>{const o=(e=>{var o;(0,n.useDebugValue)(`${c}:Provider`);const[r]=(0,n.useState)((()=>{var o,r,a,n;const u=v(e)?(0,l.default)(e.value)?e.value(d()):e.value:d(),i=new s.GlobalStore(u,Object.assign(Object.assign({},t),{metadata:null!==(o=(0,l.default)(t.metadata)?t.metadata():t.metadata)&&void 0!==o?o:{}})),c={use:f};return Object.assign(i.storeTools,c),null===(a=null===(r=t.callbacks)||void 0===r?void 0:r.onCreated)||void 0===a||a.call(r,i.storeTools,i),null===(n=e.onCreated)||void 0===n||n.call(e,i.storeTools,i),i}));return(0,n.useLayoutEffect)((()=>{v(e)&&!(0,l.default)(e.value)&&r.setState(e.value)}),[r,e.value]),(0,n.useEffect)((()=>{var o,a,n;const s=[null===(a=null===(o=t.callbacks)||void 0===o?void 0:o.onMounted)||void 0===a?void 0:a.call(o,r.storeTools,r),null===(n=e.onMounted)||void 0===n?void 0:n.call(e,r.storeTools,r)].filter(Boolean);return()=>{var e,t,o,a;null===(t=null===(e=r.callbacks)||void 0===e?void 0:e.onUnMount)||void 0===t||t.call(e,r),s.forEach((e=>null==e?void 0:e())),null===(a=(o=r).__onUnMountContext)||void 0===a||a.call(o,r)}}),[r]),null===(o=e.onRender)||void 0===o||o.call(e,r.storeTools,r),r})(e);return(0,n.createElement)(a.Provider,{value:o.use},e.children)};b.displayName=`${c}:Provider`,a.displayName=`${c}`;const p={makeProviderWrapper:e=>{const t={current:void 0,instance:void 0};return{wrapper:o=>{var{children:a}=o,s=r(o,["children"]);return(0,n.createElement)(b,Object.assign(Object.assign(Object.assign({},e),s),{onCreated:(o,r)=>{var a;t.current=o,t.instance=r,null===(a=null==e?void 0:e.onCreated)||void 0===a||a.call(e,o,r)}}),a)},context:t}}},f=(...e)=>{(0,n.useDebugValue)(`${c}:use`);const t=(0,n.useContext)(a);if(!t)throw new Error("use hook must be used within a ContextProvider");return t(...e)},m=()=>{(0,n.useDebugValue)(`${c}:api`);const e=(0,n.useContext)(a);if(!e)throw new Error("api hook must be used within a ContextProvider");return e},j={displayName:a.displayName,createSelectorHook:i.bind(f),api:m,select:(...e)=>f(...e)[0],observable:(...e)=>{(0,n.useDebugValue)(`${c}:observable`);const t=m(),o=(0,n.useRef)(e);return o.current=e,(0,n.useMemo)((()=>{var e,r,a;return t.createObservable((e=>(0,o.current[0])(e)),{isEqualRoot:(null===(e=o.current[1])||void 0===e?void 0:e.isEqualRoot)?(e,t)=>{const r=o.current[1].isEqualRoot;return Boolean(r(e,t))}:void 0,isEqual:(null===(r=o.current[1])||void 0===r?void 0:r.isEqual)?(e,t)=>{const r=o.current[1].isEqual;return Boolean(r(e,t))}:void 0,name:null===(a=o.current[1])||void 0===a?void 0:a.name})}),[t])},actions:()=>m().actions};return Object.assign(b,p),Object.assign(f,j),{use:f,Provider:b,Context:a}},t.default=t.createContext},778:e=>{e.exports=r}},n={};return function e(t){var o=n[t];if(void 0!==o)return o.exports;var r=n[t]={exports:{}};return a[t].call(r.exports,r,r.exports,e),r.exports}(695)})(),"object"==typeof exports&&"object"==typeof module?module.exports=t(require("react"),require("./uniqueId.js"),require("json-storage-formatter/isFunction"),require("./GlobalStore.js")):"function"==typeof define&&define.amd?define(["react","./uniqueId.js","json-storage-formatter/isFunction","./GlobalStore.js"],t):"object"==typeof exports?exports["react-hooks-global-states"]=t(require("react"),require("./uniqueId.js"),require("json-storage-formatter/isFunction"),require("./GlobalStore.js")):e["react-hooks-global-states"]=t(e.React,e["./uniqueId.js"],e["json-storage-formatter/isFunction"],e["./GlobalStore.js"]);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "react-hooks-global-states",
-  "version": "15.0.16",
+  "version": "15.0.18",
   "description": "A package to easily handle global state across your React components using hooks.",
   "main": "./bundle.js",
   "types": "./index.d.ts",
@@ -68,13 +68,13 @@
   ],
   "scripts": {
     "format": "prettier --write .  --log-level silent && yarn lint:fix",
-    "test": "yarn build && yarn jest",
+    "test": "yarn build && yarn ts-check:tests && yarn jest",
     "test:logs": "sh -c 'yarn build && yarn jest \"$@\" 2>&1 | grep -i \"console\" -A 2' --",
     "test:debug:no-watch": "node --inspect-brk node_modules/.bin/jest --no-watchman --runInBand",
     "test:debug": "node --inspect-brk node_modules/.bin/jest --watch --runInBand",
-    "test:quick": "yarn test --no-coverage --maxWorkers=4 -c --no-watchman -u",
+    "test:quick": "yarn ts-check:tests && yarn test --no-coverage --maxWorkers=4 -c --no-watchman -u",
     "test:coverage": "yarn test --maxWorkers=4 -c --colors --no-watchman --verbose --coverage",
-    "build": "yarn ts-check && yarn clean && webpack --config webpack.config.js && yarn ts-check:tests",
+    "build": "yarn ts-check && yarn clean && webpack --config webpack.config.js",
     "prepare": "yarn format && npm run build && yarn test:quick",
     "version": "npm run format && yarn build && yarn jest && git add -A",
     "postversion": "git push && git push --tags",

package/types.d.ts

@@ -410,6 +410,18 @@ export type GlobalStoreContextCallbacks<State, StateMutator, Metadata extends Ba
      * @description Underlying store instance
      */
     store: GlobalStore<State, Metadata, unknown, Any>) => void | UnsubscribeCallback;
+    /**
+     * @description Called every time the context provider is rendered
+     */
+    onRender?: (
+    /**
+     * @description Full context instance
+     */
+    storeTools: ContextStoreTools<State, StateMutator extends AnyFunction ? null : StateMutator, Metadata>, 
+    /**
+     * @description Underlying store instance
+     */
+    store: GlobalStore<State, Metadata, unknown, Any>) => void;
 };
 export type ContextStoreCallbacks<State, StateMutator, Metadata extends BaseMetadata> = GlobalStoreCallbacks<State, StateMutator, Metadata> & GlobalStoreContextCallbacks<State, StateMutator, Metadata>;
 /**
@@ -1139,12 +1151,11 @@ export type InferActionsType<Hook extends StateHook<Any, Any, Any>> = ReturnType
  * ```
  */
 export type InferStateApi<Hook extends StateHook<Any, Any, Any>> = Hook extends StateHook<infer State, infer PublicStateMutator, infer Metadata> ? StoreTools<State, PublicStateMutator, Metadata> : never;
-export declare const __uniqueIdBrand: unique symbol;
 /**
  * Branded unique identifier
  */
 export type BrandedId<T extends string | undefined> = `${T extends string ? T : ''}${string}` & {
-    [__uniqueIdBrand]: T;
+    __brand: T;
 };
 export interface UniqueId {
     /**
@@ -1152,10 +1163,10 @@ export interface UniqueId {
      *
      * @example
      * uniqueId();           // "k9j3n5x8q2"
-     * type Id1 = `${string}` & { [__uniqueIdBrand]: undefined };
+     * type Id1 = `${string}` & { __brand: undefined };
      *
      * uniqueId('user:');    // "user:k9j3n5x8q2"
-     * type Id2 = `user:${string}` & { [__uniqueIdBrand]: 'user:' };
+     * type Id2 = `user:${string}` & { __brand: 'user:' };
      */
     <T extends string | undefined>(prefix?: T): BrandedId<T>;
     /**
@@ -1164,36 +1175,36 @@ export interface UniqueId {
      * @example
      * const makeOrderId = uniqueId.for('order:');
      * const id = makeOrderId(); // "order:k9j3n5x8q2"
-     * type OrderId = `order:${string}` & { [__brand]: 'order:' };
+     * type OrderId = `order:${string}` & { __brand: 'order:' };
      */
     for<T extends string>(prefix: T): {
         (): `${T}${string}` & {
-            [__uniqueIdBrand]: T;
+            __brand: T;
         };
         /**
          * Checks if the given value matches the branded ID for this prefix.
          */
         is(value: unknown): value is `${T}${string}` & {
-            [__uniqueIdBrand]: T;
+            __brand: T;
         };
         /**
          * Asserts that the value matches this branded ID, throws otherwise.
          */
         assert(value: unknown): asserts value is `${T}${string}` & {
-            [__uniqueIdBrand]: T;
+            __brand: T;
         };
         /**
          * Returns a strictly branded generator using a custom symbol brand.
          */
         strict<Brand extends symbol>(): {
             (): `${T}${string}` & {
-                [__uniqueIdBrand]: Brand;
+                __brand: Brand;
             };
             is(value: unknown): value is `${T}${string}` & {
-                [__uniqueIdBrand]: Brand;
+                __brand: Brand;
             };
             assert(value: unknown): asserts value is `${T}${string}` & {
-                [__uniqueIdBrand]: Brand;
+                __brand: Brand;
             };
         };
     };
@@ -1201,13 +1212,13 @@ export interface UniqueId {
      * Creates a reusable unique ID generator without a prefix.
      */
     of<T extends string>(): () => string & {
-        [__uniqueIdBrand]: T;
+        __brand: T;
     };
     /**
      * Creates a strictly branded unique ID generator without a prefix.
      */
     strict<Brand extends symbol>(): () => string & {
-        [__uniqueIdBrand]: Brand;
+        __brand: Brand;
     };
 }
 /**

package/uniqueId.d.ts

@@ -1,7 +1,7 @@
-import type { UniqueId, BrandedId, __uniqueIdBrand } from './types';
+import type { UniqueId, BrandedId } from './types';
 /**
  * Generates a unique identifier string, optionally prefixed.
  */
 export declare const uniqueId: UniqueId;
 export default uniqueId;
-export type { UniqueId, BrandedId, __uniqueIdBrand };
+export type { UniqueId, BrandedId };