@t8/react-store 1.2.3 → 1.2.4

package/README.md

@@ -4,7 +4,7 @@
 
 [![npm](https://img.shields.io/npm/v/@t8/react-store?labelColor=345&color=46e)](https://www.npmjs.com/package/@t8/react-store) ![Lightweight](https://img.shields.io/bundlephobia/minzip/@t8/react-store?label=minzip&labelColor=345&color=46e) ![CSR ✓](https://img.shields.io/badge/CSR-✓-345?labelColor=345) ![SSR ✓](https://img.shields.io/badge/SSR-✓-345?labelColor=345)
 
-**Why?** To have an easy-to-use state management lib for React apps requiring least effort to migrate from local state and to quickly set up shared state from scratch, whether with SSR or without. Other approaches, including Redux Toolkit, Zustand, Jotai, MobX, invariably depart from this picture to varying degrees.
+**Why?** To have an easy-to-use state management lib for React apps requiring least effort to migrate from local state and to quickly set up shared state from scratch, whether with SSR or without. Other approaches, like Redux Toolkit, Zustand, Jotai, MobX, depart from this picture to varying degrees.
 
 This picture is achieved here by (1) having a simple API introducing as few new entities as possible, (2) closely following the React's `useState()` pattern of initializing and manipulating the state to avoid boilerplate and sizable rewrites in the common task of migration from local state to shared state, (3) working smoothly with SSR with regular React Contexts without requiring a specifically designed setup and without internally making use of global stores or other global variables by default.
 

package/dist/index.d.ts

@@ -1,2 +1,39 @@
+import type { Store } from "@t8/store";
+
+export type SetStoreState<T> = Store<T>["setState"];
+export type ShouldUpdateCallback<T> = (nextState: T, prevState: T) => boolean;
+export type ShouldUpdate<T> = boolean | ShouldUpdateCallback<T>;
+/**
+ * Returns the state value of `store` passed as the parameter and
+ * a function to update the store state value.
+ *
+ * @example
+ * ```js
+ * let [value, setValue] = useStore(store);
+ * ```
+ *
+ * The optional second parameter `shouldUpdate` controls whether
+ * the component using this hook should be updated in response to
+ * the store updates, which is set to `true` by default.
+ *
+ * `shouldUpdate` can be set to `false` to prevent subscription
+ * to the store updates. Use case: if the component only requires
+ * the store state setter but not the store state value, the
+ * component may not need to respond to the store updates at all:
+ *
+ * @example
+ * ```js
+ * let [, setValue] = useStore(store, false);
+ * ```
+ *
+ * `shouldUpdate` can also be a function `(nextState, prevState) => boolean`
+ * to make the component respond only to specific store state changes,
+ * when this function returns `true`.
+ */
+export declare function useStore<T>(store: Store<T>, shouldUpdate?: ShouldUpdate<T>): [
+  T,
+  SetStoreState<T>
+];
 export * from "@t8/store";
-export * from "./src/useStore.ts";
+
+export {};

package/package.json

@@ -1,21 +1,18 @@
 {
   "name": "@t8/react-store",
-  "version": "1.2.3",
+  "version": "1.2.4",
   "description": "Small React app state management lib aligned with React's state pattern, condensed to the essentials",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "type": "module",
   "scripts": {
-    "build": "npx npm-run-all clean compile types",
     "clean": "node -e \"require('node:fs').rmSync('dist', { force: true, recursive: true });\"",
     "compile": "npx esbuild index.ts --bundle --outdir=dist --platform=neutral --external:react",
     "demo": "npx @t8/serve 3000 * tests/counter -b src/index.tsx",
-    "prepublishOnly": "npm run build",
-    "preversion": "npx npm-run-all shape build test",
-    "shape": "npx codeshape --typecheck",
+    "preversion": "npx npm-run-all clean shape compile test",
+    "shape": "npx codeshape --typecheck --emit-types",
     "test": "npx playwright test --project=chromium",
-    "tic-tac-toe": "npx @t8/serve 3000 * tests/tic-tac-toe -b src/index.tsx",
-    "types": "tsc -p tsconfig.build.json"
+    "tic-tac-toe": "npx @t8/serve 3000 * tests/tic-tac-toe -b src/index.tsx"
   },
   "repository": {
     "type": "git",
@@ -41,10 +38,9 @@
     "@types/react": "^19.2.7",
     "@types/react-dom": "^19.2.3",
     "immer": "^11.0.1",
-    "react-dom": "^19.2.1",
-    "typescript": "^5.9.3"
+    "react-dom": "^19.2.1"
   },
   "dependencies": {
-    "@t8/store": "^1.3.3"
+    "@t8/store": "^1.3.5"
   }
 }

package/dist/src/useStore.d.ts

@@ -1,32 +0,0 @@
-import { type Store } from "@t8/store";
-export type SetStoreState<T> = Store<T>["setState"];
-export type ShouldUpdateCallback<T> = (nextState: T, prevState: T) => boolean;
-export type ShouldUpdate<T> = boolean | ShouldUpdateCallback<T>;
-/**
- * Returns the state value of `store` passed as the parameter and
- * a function to update the store state value.
- *
- * @example
- * ```js
- * let [value, setValue] = useStore(store);
- * ```
- *
- * The optional second parameter `shouldUpdate` controls whether
- * the component using this hook should be updated in response to
- * the store updates, which is set to `true` by default.
- *
- * `shouldUpdate` can be set to `false` to prevent subscription
- * to the store updates. Use case: if the component only requires
- * the store state setter but not the store state value, the
- * component may not need to respond to the store updates at all:
- *
- * @example
- * ```js
- * let [, setValue] = useStore(store, false);
- * ```
- *
- * `shouldUpdate` can also be a function `(nextState, prevState) => boolean`
- * to make the component respond only to specific store state changes,
- * when this function returns `true`.
- */
-export declare function useStore<T>(store: Store<T>, shouldUpdate?: ShouldUpdate<T>): [T, SetStoreState<T>];