@honestjs/rpc-plugin 1.1.0 → 1.1.1

package/README.md

@@ -1,14 +1,7 @@
-# @honestjs/rpc-plugin
+# RPC Plugin
 
-A comprehensive RPC plugin for HonestJS that combines route analysis, schema generation, and client generation into a
-single solution.
-
-## Features
-
-- **Route Analysis**: Automatically analyzes controller methods and extracts type information using ts-morph
-- **Schema Generation**: Generates JSON schemas and TypeScript interfaces from types used in controllers
-- **Client Generation**: Creates a fully-typed TypeScript RPC client with proper parameter typing
-- **Type Safety**: Full TypeScript support with generated types and interfaces
+The RPC Plugin automatically analyzes your HonestJS controllers and generates a fully-typed TypeScript RPC client with
+proper parameter typing.
 
 ## Installation
 
@@ -20,24 +13,18 @@ yarn add @honestjs/rpc-plugin
 pnpm add @honestjs/rpc-plugin
 ```
 
-## Usage
-
-### Basic Setup
+## Basic Setup
 
 ```typescript
 import { RPCPlugin } from '@honestjs/rpc-plugin'
 import { Application } from 'honestjs'
 
 const app = new Application({
-	plugins: [
-		new RPCPlugin({
-			outputDir: './generated/rpc'
-		})
-	]
+	plugins: [RPCPlugin]
 })
 ```
 
-### Configuration Options
+## Configuration Options
 
 ```typescript
 interface RPCPluginOptions {
@@ -87,17 +74,6 @@ apiClient.setDefaultHeaders({
 	'X-API-Key': 'your-api-key',
 	Authorization: 'Bearer your-jwt-token'
 })
-
-// Use with custom fetch function (e.g., for testing or custom logic)
-const customFetch = (input: RequestInfo | URL, init?: RequestInit) => {
-	console.log('Making request to:', input)
-	return fetch(input, init)
-}
-
-const apiClientWithCustomFetch = new ApiClient('http://localhost:3000', {
-	fetchFn: customFetch,
-	defaultHeaders: { 'X-Custom-Header': 'value' }
-})
 ```
 
 The generated `client.ts` file contains everything you need:
@@ -220,14 +196,6 @@ expect(mockFetch).toHaveBeenCalledWith('http://test.com/api/v1/users/123', expec
 - Creates parameter validation and typing
 - Builds the complete RPC client with proper error handling
 
-## Benefits of the Unified Approach
-
-- **No Duplication**: Single source of truth for all type information
-- **Tight Coupling**: Components share data directly without file I/O
-- **Better Performance**: Eliminates redundant analysis and file generation
-- **Consistent Types**: All generated code uses the same type definitions
-- **Easier Maintenance**: Single plugin to configure and maintain
-
 ## Example Generated Output
 
 ### Generated Client
@@ -272,12 +240,100 @@ const rpcPlugin = new RPCPlugin()
 await rpcPlugin.analyze() // Manually trigger analysis and generation
 ```
 
-## Dependencies
+## Advanced Usage
+
+### Custom Controller Pattern
+
+If your controllers follow a different file structure:
+
+```typescript
+new RPCPlugin({
+	controllerPattern: 'src/controllers/**/*.controller.ts',
+	outputDir: './src/generated/api'
+})
+```
+
+### Manual Generation Control
+
+Disable automatic generation and control when files are generated:
+
+```typescript
+const rpcPlugin = new RPCPlugin({
+	generateOnInit: false
+})
+
+// Later in your code
+await rpcPlugin.analyze()
+```
+
+## Integration with HonestJS
+
+### Controller Example
+
+Here's how your controllers should be structured for optimal RPC generation:
+
+```typescript
+import { Controller, Post, Get, Body, Param, Query } from 'honestjs'
+
+interface CreateUserDto {
+	name: string
+	email: string
+}
+
+interface ListUsersQuery {
+	page?: number
+	limit?: number
+}
+
+@Controller('/users')
+export class UsersController {
+	@Post('/')
+	async create(@Body() createUserDto: CreateUserDto): Promise<User> {
+		// Implementation
+	}
+
+	@Get('/')
+	async list(@Query() query: ListUsersQuery): Promise<User[]> {
+		// Implementation
+	}
+
+	@Get('/:id')
+	async getById(@Param('id') id: string): Promise<User> {
+		// Implementation
+	}
+}
+```
+
+### Module Registration
 
-- **ts-morph**: TypeScript source code analysis
-- **ts-json-schema-generator**: JSON schema generation from TypeScript types
-- **honestjs**: Core framework integration
+Ensure your controllers are properly registered in modules:
+
+```typescript
+import { Module } from 'honestjs'
+import { UsersController } from './users.controller'
+import { UsersService } from './users.service'
+
+@Module({
+	controllers: [UsersController],
+	providers: [UsersService]
+})
+export class UsersModule {}
+```
 
-## License
+## Error Handling
 
-MIT
+The generated client includes comprehensive error handling:
+
+```typescript
+try {
+	const user = await apiClient.users.create({
+		body: { name: 'John', email: 'john@example.com' }
+	})
+} catch (error) {
+	if (error instanceof ApiError) {
+		console.error(`API Error ${error.statusCode}: ${error.message}`)
+	} else {
+		console.error('Unexpected error:', error)
+	}
+}
+```

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@honestjs/rpc-plugin",
-  "version": "1.1.0",
+  "version": "1.1.1",
   "description": "RPC plugin for HonestJS framework",
   "main": "./dist/index.js",
   "module": "./dist/index.mjs",
@@ -29,12 +29,12 @@
     "directory": "packages/rpc-plugin"
   },
   "dependencies": {
-    "ts-json-schema-generator": "^2.4.0",
+    "ts-json-schema-generator": "^2.5.0",
     "ts-morph": "^26.0.0"
   },
   "devDependencies": {
-    "honestjs": "^0.1.5",
-    "hono": "^4.9.4"
+    "honestjs": "^0.1.6",
+    "hono": "^4.12.3"
   },
   "peerDependencies": {
     "honestjs": "^0.1.0",