@jokio/rpc 0.1.0 → 0.1.1

package/README.md

@@ -1,4 +1,4 @@
-# jokRPC
+# @jokio/rpc
 
 A type-safe RPC framework for TypeScript with Zod validation, designed for Express servers and HTTP clients.
 
@@ -15,7 +15,7 @@ A type-safe RPC framework for TypeScript with Zod validation, designed for Expre
 ## Installation
 
 ```bash
-npm install jokrpc zod express
+npm install @jokio/rpc zod express
 ```
 
 ## Usage
@@ -23,14 +23,14 @@ npm install jokrpc zod express
 ### 1. Define Your Router Configuration
 
 ```typescript
-import { defineRouterConfig } from 'jokrpc'
-import { z } from 'zod'
+import { defineRouterConfig } from "@jokio/rpc";
+import { z } from "zod";
 
 const routerConfig = defineRouterConfig({
   GET: {
-    '/users/:id': {
+    "/users/:id": {
       query: z.object({
-        include: z.enum(['posts', 'comments']).optional(),
+        include: z.enum(["posts", "comments"]).optional(),
       }),
       result: z.object({
         id: z.string(),
@@ -40,7 +40,7 @@ const routerConfig = defineRouterConfig({
     },
   },
   POST: {
-    '/users': {
+    "/users": {
       body: z.object({
         name: z.string(),
         email: z.string().email(),
@@ -55,66 +55,66 @@ const routerConfig = defineRouterConfig({
       }),
     },
   },
-})
+});
 ```
 
 ### 2. Set Up the Server
 
 ```typescript
-import express from 'express'
-import { applyConfigToExpressRouter } from 'jokrpc'
+import express from "express";
+import { applyConfigToExpressRouter } from "@jokio/rpc";
 
-const app = express()
-app.use(express.json())
+const app = express();
+app.use(express.json());
 
-const router = express.Router()
+const router = express.Router();
 
 applyConfigToExpressRouter(router, routerConfig, {
   GET: {
-    '/users/:id': async ({ query }) => {
+    "/users/:id": async ({ query }) => {
       // Handler implementation
       return {
-        id: '1',
-        name: 'John Doe',
-        email: 'john@example.com',
-      }
+        id: "1",
+        name: "John Doe",
+        email: "john@example.com",
+      };
     },
   },
   POST: {
-    '/users': async ({ body, query }) => {
+    "/users": async ({ body, query }) => {
       // Handler implementation
       return {
-        id: '2',
+        id: "2",
         name: body.name,
         email: body.email,
-      }
+      };
     },
   },
-})
+});
 
-app.use('/api', router)
-app.listen(3000)
+app.use("/api", router);
+app.listen(3000);
 ```
 
 ### 3. Create a Type-Safe Client
 
 ```typescript
-import { createClient } from 'jokrpc'
+import { createClient } from "@jokio/rpc";
 
 const client = createClient(routerConfig, {
-  baseUrl: 'http://localhost:3000/api',
+  baseUrl: "http://localhost:3000/api",
   validateRequest: true, // Optional: validate requests on client-side
-})
+});
 
 // Fully typed API calls
-const user = await client.GET['/users/:id']({
-  query: { include: 'posts' },
-})
+const user = await client.GET["/users/:id"]({
+  query: { include: "posts" },
+});
 
-const newUser = await client.POST['/users']({
-  body: { name: 'Jane Doe', email: 'jane@example.com' },
+const newUser = await client.POST["/users"]({
+  body: { name: "Jane Doe", email: "jane@example.com" },
   query: { sendEmail: true },
-})
+});
 ```
 
 ## API Reference
@@ -128,6 +128,7 @@ Helper function to define a router configuration with type inference.
 Applies route handlers to an Express router with automatic validation.
 
 **Parameters:**
+
 - `router`: Express Router instance
 - `config`: Router configuration object
 - `handlers`: Handler functions for each route
@@ -137,6 +138,7 @@ Applies route handlers to an Express router with automatic validation.
 Creates a type-safe HTTP client.
 
 **Options:**
+
 - `baseUrl`: Base URL for API requests
 - `headers`: Optional default headers
 - `fetch`: Optional custom fetch function (useful for Node.js or testing)
@@ -148,26 +150,27 @@ The library provides end-to-end type safety:
 
 ```typescript
 // TypeScript knows the exact shape of requests and responses
-const result = await client.POST['/users']({
+const result = await client.POST["/users"]({
   body: {
-    name: 'John',
-    email: 'invalid-email', // Zod will catch this at runtime
+    name: "John",
+    email: "invalid-email", // Zod will catch this at runtime
   },
-})
+});
 
 // result is typed as { id: string; name: string; email: string }
-console.log(result.id)
+console.log(result.id);
 ```
 
 ## Error Handling
 
 The library throws errors for:
+
 - HTTP errors (non-2xx responses)
 - Validation errors (invalid request/response data)
 
 ```typescript
 try {
-  await client.POST['/users']({ body: invalidData })
+  await client.POST["/users"]({ body: invalidData });
 } catch (error) {
   // Handle validation or HTTP errors
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@jokio/rpc",
-  "version": "0.1.0",
+  "version": "0.1.1",
   "description": "Type-safe RPC framework with Zod validation for Express and TypeScript",
   "main": "./dist/index.js",
   "module": "./dist/index.mjs",
@@ -33,17 +33,13 @@
   ],
   "author": "",
   "license": "MIT",
-  "peerDependencies": {
-    "express": "^4.0.0",
-    "zod": "^4.0.0"
-  },
   "devDependencies": {
     "@types/express": "^4.17.21",
     "@types/node": "^20.10.0",
-    "express": "^4.18.2",
+    "express": "^5.2.1",
     "tsup": "^8.0.1",
-    "typescript": "^5.3.3",
-    "zod": "^3.22.4"
+    "typescript": "^5.9.3",
+    "zod": "^4.3.4"
   },
   "repository": {
     "type": "git",