@pyrpc/client 0.1.0-alpha.1 → 0.1.0-alpha.2

package/README.md

@@ -1,39 +1,71 @@
-# @pyrpc/client
-
-The universal TypeScript client for pyRPC.
-
-## Installation
-
-```bash
-npm install @pyrpc/client
-# or
-pnpm add @pyrpc/client
-# or
-yarn add @pyrpc/client
-```
-
-## Usage
-
-```typescript
-import { createClient } from '@pyrpc/client';
-import type { AppRouter } from './server-types'; // Generated by pyrpc-codegen
-
-const client = createClient<AppRouter>({
-  baseUrl: 'http://localhost:8000',
-});
-
-// Call remote procedures as local methods
-const user = await client.get_user({ id: 1 });
-console.log(user.name);
-```
-
-### Dynamic Headers (Auth)
-
-```typescript
-const client = createClient({
-  baseUrl: 'http://localhost:8000',
-  headers: () => ({
-    Authorization: `Bearer ${localStorage.getItem('token')}`,
-  }),
-});
-```
+# @pyrpc/client
+
+Universal TypeScript client for [pyRPC](https://pyrpc.dev). Type-safe RPC calls to your Python backend — install, import, call.
+
+## Installation
+
+```bash
+npm install @pyrpc/client
+```
+
+The postinstall script in `@pyrpc/types` will prompt for your server URL and generate typed contracts automatically.
+
+For CI, set the `PYRPC_URL` environment variable:
+
+```bash
+PYRPC_URL=https://api.example.com npm install @pyrpc/client
+```
+
+## Usage
+
+```typescript
+import { createClient } from "@pyrpc/client";
+import type { Types } from "@pyrpc/types";
+
+const client = createClient<Types>({
+  baseUrl: "https://api.example.com",
+});
+
+const user = await client.get_user(1);
+console.log(user.name);
+```
+
+The proxy-based API lets you call any remote procedure as a local method. Parameters are passed positionally or as a single object for named arguments.
+
+### Dynamic headers (auth)
+
+```typescript
+const client = createClient({
+  baseUrl: "https://api.example.com",
+  headers: () => ({
+    Authorization: `Bearer ${localStorage.getItem("token")}`,
+  }),
+});
+```
+
+### Error handling
+
+```typescript
+import { createClient, PyRPCError } from "@pyrpc/client";
+
+try {
+  await client.delete_user(1);
+} catch (error) {
+  if (error instanceof PyRPCError) {
+    console.error(error.code, error.message);
+  }
+}
+```
+
+## API
+
+### `createClient<TTypes>(options?)`
+
+Creates a proxy client that forwards method calls to the server.
+
+- `baseUrl` — Server root URL (defaults to `window.location.origin` in browsers)
+- `headers` — Static, dynamic, or async `HeadersInit`
+
+## License
+
+MIT

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pyrpc/client",
-  "version": "0.1.0-alpha.1",
+  "version": "0.1.0-alpha.2",
   "description": "Universal TypeScript client for pyRPC",
   "main": "./dist/index.js",
   "module": "./dist/index.mjs",
@@ -23,6 +23,9 @@
   ],
   "author": "",
   "license": "MIT",
+  "dependencies": {
+    "@pyrpc/types": "^0.1.0-alpha.1"
+  },
   "devDependencies": {
     "@types/node": "^20.19.39",
     "tsup": "^8.5.1",