@quark-fw/store 0.0.1 → 0.0.2

package/README.md

@@ -0,0 +1,37 @@
+# @quark-fw/store
+
+Isomorphic store and tRPC client hooks for React apps built on the Quark framework. Works during SSR and in the browser.
+
+## Install
+
+```sh
+npm i @quark-fw/store
+```
+
+`react` is a peer dependency.
+
+## Usage
+
+```tsx
+import Store, { useStore, useTrpc, StoreContext } from "@quark-fw/store";
+
+// on the server / app entry: create a Store around your tRPC client and provide it
+const store = new Store({ trpcClient });
+// <StoreContext.Provider value={store}>...</StoreContext.Provider>
+
+function TodoList() {
+	const trpc = useTrpc();   // typed tRPC client (AppRouter comes from your app)
+	const store = useStore(); // shared values/promises, survives SSR serialization
+	// ...
+}
+```
+
+Also exported:
+
+- `createTinyRPCClient` — minimal tRPC client factory used by `useTrpc`
+- `jsonSafeFetch` — fetch wrapper that reports JSON errors through the shared error channel
+- `@quark-fw/store/src/errors.js` — `reportError` / `errorMessage` helpers
+- `@quark-fw/store/src/serialize.js` — SSR-safe serialization (`Serialize` type)
+- `@quark-fw/store/src/usePromise.js` — suspense-style promise hook
+
+Part of the [Quark framework](https://www.npmjs.com/package/@quark-fw/core).

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@quark-fw/store",
-	"version": "0.0.1",
+	"version": "0.0.2",
 	"description": "Isomorphic store and tRPC client hooks for the Quark framework",
 	"type": "module",
 	"main": "dist/index.js",
@@ -14,11 +14,15 @@
 		"./src/*": "./dist/*",
 		"./*": "./dist/*"
 	},
-	"files": ["dist"],
+	"files": [
+		"dist"
+	],
 	"scripts": {
 		"build": "tsc -p tsconfig.build.json && node ../../scripts/postbuild.mjs"
 	},
-	"keywords": ["quark"],
+	"keywords": [
+		"quark"
+	],
 	"author": "",
 	"license": "ISC",
 	"publishConfig": {