@dr.pogodin/react-global-state 0.23.0 → 0.24.0

package/build/types/GlobalStateProvider.d.ts

@@ -3,27 +3,25 @@ import GlobalState from './GlobalState';
 import type SsrContext from './SsrContext';
 import type { ValueOrInitializerT } from './utils';
 /**
- * Gets {@link GlobalState} instance from the context. In most cases
- * you should use {@link useGlobalState}, and other hooks to interact with
- * the global state, instead of accessing it directly.
- * @return
+ * Returns the GlobalState object from the context. In most cases you should use
+ * other hooks, like useGlobalState(), etc. to interact with the global state,
+ * instead of accessing the GlobalState object directly.
  */
-export declare function getGlobalState<StateT, SsrContextT extends SsrContext<StateT> = SsrContext<StateT>>(): GlobalState<StateT, SsrContextT>;
+export declare function useGlobalStateObject<StateT, SsrContextT extends SsrContext<StateT> = SsrContext<StateT>>(): GlobalState<StateT, SsrContextT>;
 /**
- * @category Hooks
- * @desc Gets SSR context.
- * @param throwWithoutSsrContext If `true` (default),
- * this hook will throw if no SSR context is attached to the global state;
- * set `false` to not throw in such case. In either case the hook will throw
- * if the {@link &lt;GlobalStateProvider&gt;} (hence the state) is missing.
+ * Returns SSR context.
+ * @param throwWithoutSsrContext - If _true_ (default), this hook will throw
+ *  if no SSR context is attached to the global state; set _false_ to not throw
+ *  in such case. In either case this hook will throw if the <GlobalStateProvider>
+ *  (hence the global state) is missing.
  * @returns SSR context.
  * @throws
- * - If current component has no parent {@link &lt;GlobalStateProvider&gt;}
- *   in the rendered React tree.
- * - If `throwWithoutSsrContext` is `true`, and there is no SSR context attached
- *   to the global state provided by {@link &lt;GlobalStateProvider&gt;}.
+ *  - If current component has no parent <GlobalStateProvider> in the rendered
+ *    React tree.
+ *  - If `throwWithoutSsrContext` is _true_ (default), and there is no SSR
+ *    context attached to the global state provided by <GlobalStateProvider>.
  */
-export declare function getSsrContext<SsrContextT extends SsrContext<unknown>>(throwWithoutSsrContext?: boolean): SsrContextT | undefined;
+export declare function useSsrContext<SsrContextT extends SsrContext<unknown>>(throwWithoutSsrContext?: boolean): SsrContextT | undefined;
 type NewStateProps<StateT, SsrContextT extends SsrContext<StateT>> = {
     initialState: ValueOrInitializerT<StateT>;
     ssrContext?: SsrContextT;

package/build/types/index.d.ts

@@ -1,5 +1,5 @@
 import GlobalState from './GlobalState';
-import GlobalStateProvider, { getGlobalState, getSsrContext } from './GlobalStateProvider';
+import GlobalStateProvider, { useGlobalStateObject, useSsrContext } from './GlobalStateProvider';
 import SsrContext from './SsrContext';
 import useAsyncCollection, { type UseAsyncCollectionI, type UseAsyncCollectionResT } from './useAsyncCollection';
 import { type AsyncDataEnvelopeT, type AsyncDataLoaderT, type AsyncDataReloaderT, type LoadAsyncDataI, type UseAsyncDataI, type UseAsyncDataOptionsT, type UseAsyncDataResT, loadAsyncData, newAsyncDataEnvelope, useAsyncData } from './useAsyncData';
@@ -7,17 +7,17 @@ import useGlobalState, { type UseGlobalStateI } from './useGlobalState';
 export type { AsyncCollectionLoaderT, AsyncCollectionReloaderT, AsyncCollectionT, } from './useAsyncCollection';
 export type { SetterT, UseGlobalStateResT } from './useGlobalState';
 export type { ForceT, ValueOrInitializerT } from './utils';
-export { type AsyncDataEnvelopeT, type AsyncDataLoaderT, type AsyncDataReloaderT, GlobalState, GlobalStateProvider, SsrContext, type UseAsyncCollectionI, type UseAsyncCollectionResT, type UseAsyncDataI, type UseAsyncDataOptionsT, type UseAsyncDataResT, type UseGlobalStateI, getGlobalState, getSsrContext, loadAsyncData, newAsyncDataEnvelope, useAsyncCollection, useAsyncData, useGlobalState, };
+export { type AsyncDataEnvelopeT, type AsyncDataLoaderT, type AsyncDataReloaderT, GlobalState, GlobalStateProvider, SsrContext, type UseAsyncCollectionI, type UseAsyncCollectionResT, type UseAsyncDataI, type UseAsyncDataOptionsT, type UseAsyncDataResT, type UseGlobalStateI, loadAsyncData, newAsyncDataEnvelope, useAsyncCollection, useAsyncData, useGlobalState, useGlobalStateObject, useSsrContext, };
 interface API<StateT, SsrContextT extends SsrContext<StateT> = SsrContext<StateT>> {
     GlobalState: typeof GlobalState<StateT, SsrContextT>;
     GlobalStateProvider: typeof GlobalStateProvider<StateT, SsrContextT>;
     SsrContext: typeof SsrContext<StateT>;
-    getGlobalState: typeof getGlobalState<StateT, SsrContextT>;
-    getSsrContext: typeof getSsrContext<SsrContextT>;
     loadAsyncData: LoadAsyncDataI<StateT>;
     newAsyncDataEnvelope: typeof newAsyncDataEnvelope;
     useAsyncCollection: UseAsyncCollectionI<StateT>;
     useAsyncData: UseAsyncDataI<StateT>;
     useGlobalState: UseGlobalStateI<StateT>;
+    useGlobalStateObject: typeof useGlobalStateObject<StateT, SsrContextT>;
+    useSsrContext: typeof useSsrContext<SsrContextT>;
 }
 export declare function withGlobalStateType<StateT, SsrContextT extends SsrContext<StateT> = SsrContext<StateT>>(): API<StateT, SsrContextT>;

package/build/types/utils.d.ts

@@ -1,4 +1,5 @@
 import type { GetFieldType } from 'lodash';
+import type { ObjectKey } from '@dr.pogodin/js-utils';
 export type CallbackT = () => void;
 export declare const force: unique symbol;
 export declare const lock: unique symbol;
@@ -40,17 +41,4 @@ export declare function isDebugMode(): boolean;
  * development versions of the app due to the logging overhead).
  */
 export declare function cloneDeepForLog<T>(value: T, key?: string): T;
-/**
- * Converts given value to an escaped string. For now, we are good with the most
- * trivial escape logic:
- *  - '%' characters are replaced by '%0' code pair;
- *  - '/' characters are replaced by '%1' code pair.
- */
-export declare function escape(x: number | string): string;
-/**
- * Hashes given string array. For our current needs we are fine to go with
- * the most trivial implementation, which probably should not be called "hash"
- * in the strict sense: we just escape each given string to not include '/'
- * characters, and then we join all those strings using '/' as the separator.
- */
-export declare function hash(items: Array<number | string>): string;
+export declare function areEqual<K extends ObjectKey>(a: Record<K, boolean>, b: Record<K, boolean>): boolean;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dr.pogodin/react-global-state",
-  "version": "0.23.0",
+  "version": "0.24.0",
   "description": "Hook-based global state for React",
   "main": "./build/code/index.js",
   "types": "./build/types/index.d.ts",
@@ -15,7 +15,7 @@
     "jest": "npm run jest:types && npm run jest:logic",
     "jest:logic": "jest --config jest/config.json -w 1 --no-cache",
     "jest:types": "tstyche",
-    "lint": "eslint --cache",
+    "lint": "eslint --cache --cache-strategy content",
     "test": "npm run lint && npm run typecheck && npm run jest",
     "typecheck": "tsc --noEmit"
   },
@@ -36,43 +36,45 @@
   },
   "homepage": "https://dr.pogodin.studio/docs/react-global-state/index.html",
   "engines": {
-    "node": ">=20"
+    "node": ">=22"
   },
   "dependencies": {
-    "@babel/runtime": "^7.29.2",
-    "@dr.pogodin/js-utils": "^0.1.6",
+    "@babel/runtime": "^7.29.7",
+    "@dr.pogodin/js-utils": "^0.1.8",
     "@types/lodash": "^4.17.24",
     "lodash-es": "^4.18.1"
   },
   "devDependencies": {
-    "@babel/cli": "^7.28.6",
-    "@babel/core": "^7.29.0",
-    "@babel/node": "^7.29.0",
-    "@babel/plugin-transform-runtime": "^7.29.0",
-    "@babel/preset-env": "^7.29.2",
-    "@babel/preset-react": "^7.28.5",
-    "@babel/preset-typescript": "^7.28.5",
-    "@dr.pogodin/eslint-configs": "^0.2.10",
+    "@babel/cli": "^7.29.7",
+    "@babel/core": "^7.29.7",
+    "@babel/node": "^7.29.7",
+    "@babel/plugin-transform-runtime": "^7.29.7",
+    "@babel/preset-env": "^7.29.7",
+    "@babel/preset-react": "^7.29.7",
+    "@babel/preset-typescript": "^7.29.7",
+    "@dr.pogodin/eslint-configs": "^0.2.14",
+    "@jest/globals": "^30.4.1",
     "@testing-library/dom": "^10.4.1",
     "@testing-library/react": "^16.3.2",
     "@tsconfig/recommended": "^1.0.13",
     "@types/jest": "^30.0.0",
     "@types/lodash-es": "^4.17.12",
     "@types/pretty": "^2.0.3",
-    "@types/react": "^19.2.14",
+    "@types/react": "^19.2.17",
     "@types/react-dom": "^19.2.3",
-    "babel-jest": "^30.3.0",
+    "babel-jest": "^30.4.1",
     "babel-plugin-add-import-extension": "^1.6.0",
     "babel-plugin-module-resolver": "^5.0.3",
-    "jest": "^30.3.0",
-    "jest-environment-jsdom": "^30.3.0",
+    "babel-plugin-react-compiler": "^1.0.0",
+    "jest": "^30.4.2",
+    "jest-environment-jsdom": "^30.4.1",
     "mockdate": "^3.0.5",
     "rimraf": "^6.1.3",
-    "tstyche": "^7.0.0",
+    "tstyche": "^7.2.1",
     "typescript": "^5.9.3"
   },
   "peerDependencies": {
-    "react": "^19.2.5",
-    "react-dom": "^19.2.5"
+    "react": "^19.2.7",
+    "react-dom": "^19.2.7"
   }
 }

package/tsconfig.json

@@ -10,12 +10,13 @@
     "declaration": true,
     "jsx": "react-jsx",
     "module": "ESNext",
-    "moduleResolution": "Node",
+    "moduleResolution": "bundler",
     "noUncheckedIndexedAccess": true,
     "outDir": "build",
     "paths": {
       "*": ["./*"]
     },
+    "types": ["node"],
     "verbatimModuleSyntax": true
   }
-}
+}