@mingzey/typedrpc 1.1.1 → 1.1.3

package/README.md

@@ -1,20 +1,28 @@
+[English](./README.md) / [中文](./README.zh-CN.md)
 # TypedRPC
 
 TypeScript-based RPC framework with support for multiple connection types including HTTP, Socket, and SocketIO.
 
+## Repository
+
+[Github](https://github.com/MingZeY/TypedRPC)
+
 ## Features
 
-- **Type-Safe RPC calls** - Leverage TypeScript's type system for end-to-end type safety
-- **Multiple connection types** - Support for HTTP, Socket, and SocketIO connections, or custom connection providers
-- **Middleware support** - Extensible middleware system for request/response handling
-- **Context-aware** - Built-in context system for passing data between handlers
-- **Bidirectional communication** - Support for two-way RPC calls between client and server, capability depends on connection type
-- **Easy to use** - Simple API for defining services and methods
+- 🛡️ **Type-Safe RPC calls** - Leverage TypeScript's type system for end-to-end type safety
+- 🔌 **Multiple connection types** - Support for HTTP, Socket, and SocketIO connections, or custom connection providers
+- 🔄 **Middleware support** - Extensible middleware system for request/response handling
+- 📝 **Context-aware** - Built-in context system for passing data between handlers
+- 🔁 **Bidirectional communication** - Support for two-way RPC calls between client and server, capability depends on connection type
+- 📦 **Easy to use** - Simple API for defining services and methods
+- 🚀 **Zero dependencies** - No external library dependencies, only depends on TypeScript standard library
+- 🌐 **Frontend and backend compatible** - Can be used in Node.js backend and browser frontend
+- 📈 **High extensibility** - Can be easily integrated into frameworks like Electron, Express as an RPC solution
 
 ## Installation
 
 ```bash
-npm install typedrpc
+npm install @mingzey/typedrpc
 ```
 
 ## Basic Usage
@@ -22,13 +30,13 @@ npm install typedrpc
 ### Server Setup
 
 ```typescript
-import { TypedRPCServer, TypedRPCAPIDefine } from 'typedrpc';
+import { TypedRPCServer, TypedRPCAPIDefine } from '@mingzey/typedrpc';
 
 // Define your API interface
 const ServerAPIDefine = new TypedRPCAPIDefine<{
-  // Service layer - Define your services here or use interface inheritance
+    // Service layer - Define your services here or use interface inheritance
     math:{
-      // Method layer - Define your methods here
+        // Method layer - Define your methods here
         add(a:number,b:number):number,
     },
 }>({
@@ -47,7 +55,7 @@ const server = new TypedRPCServer({
 
 // Hook service methods
 server.hook('math','add',{
-    handler:(a,b)=>a+b,
+    handler: (a,b) => a+b,
 });
 
 // Start listening
@@ -59,7 +67,7 @@ server.listen({
 ### Client Setup
 
 ```typescript
-import { TypedRPCClient, TypedRPCAPIDefine } from 'typedrpc';
+import { TypedRPCClient, TypedRPCAPIDefine } from '@mingzey/typedrpc';
 // Reuse or import the same API definition
 const ServerAPIDefine = new TypedRPCAPIDefine<{
   math:{
@@ -97,9 +105,11 @@ new TypedRPCServer({
     local:ServerAPIDefine,
     connection:{
         provider:new TypedRPCConnectionProviderHTTP(),
+        // or use socket connection
         // provider:new TypedRPCConnectionProviderSocket(),
+        // or use socketio connection
         // provider:new TypedRPCConnectionProviderSocketIO(),
-        // provider:implaement your own connection provider
+        // or implaement your own connection provider
     }
 })
 ```
@@ -127,7 +137,7 @@ new TypedRPCServer({
 TypedRPC supports middleware for both servers and clients:
 
 ```typescript
-class MyMiddleware extends TypedRPCHandlerMiddleware{
+class MyMiddleware extends TypedRPCMiddleware{
 
     async inbound(context: TypedRPCContext): Promise<TypedRPCContext> {
       // Do something when inbound packet
@@ -150,7 +160,7 @@ TypedRPC provides a built-in context system that allows you to access request co
 
 ```typescript
 // Server-side code
-import { TypedRPCServer, TypedRPCAPIDefine, TypedRPCContextSymbol, type TypedRPCContext, type TypedRPCContextAware } from 'typedrpc';
+import { TypedRPCServer, TypedRPCAPIDefine, TypedRPCContextSymbol, type TypedRPCContext, type TypedRPCContextAware } from '@mingzey/typedrpc';
 
 // Define service interface
 interface MathServiceInterface {
@@ -172,7 +182,10 @@ class MathService implements MathServiceInterface, TypedRPCContextAware {
     // Inject context using TypedRPCContextSymbol
     [TypedRPCContextSymbol]: TypedRPCContext | null = null;
 
-    // For safety, must use @TypedRPCAPIDefine.method() to mark method as RPC method in service usage
+    /**
+     * For safety, must use @TypedRPCAPIDefine.method() to mark method as RPC method in service usage
+     * You need set experimentalDecorators:true in tsconfig.json
+     */
     @TypedRPCAPIDefine.method()
     add(a: number, b: number): number {
         // Access context
@@ -227,4 +240,4 @@ Contributions are welcome! Please feel free to submit a Pull Request.
 
 ## License
 
-MIT License - see the [LICENSE](https://github.com/TypedRPC/TypedRPC/blob/main/LICENSE) file for details.
+MIT License - see the [LICENSE](https://github.com/MingZeY/TypedRPC/blob/master/LICENSE) file for details.

package/README.zh-CN.md

@@ -1,20 +1,29 @@
+[English](./README.md) / [中文](./README.zh-CN.md)
+
 # TypedRPC
 
 基于 TypeScript 的 RPC 框架，支持多种连接类型，包括 HTTP、Socket 和 SocketIO。
 
+## 仓库
+
+[Github](https://github.com/MingZeY/TypedRPC)
+
 ## 特性
 
-- **类型安全的 RPC 调用** - 利用 TypeScript 的类型系统实现端到端的类型安全
-- **多种连接类型** - 支持 HTTP、Socket 和 SocketIO 连接，或自定义`TypedRPCConnectionProvider`
-- **中间件支持** - 可扩展的中间件系统，用于请求/响应处理
-- **上下文感知** - 内置上下文系统，用于在处理程序之间传递数据
-- **双向通信** - 支持客户端和服务器之间的双向 RPC 调用，能力取决于连接类型
-- **易于使用** - 用于定义服务和方法的简单 API
+- 🛡️ **类型安全的 RPC 调用** - 利用 TypeScript 的类型系统实现端到端的类型安全
+- 🔌 **多种连接类型** - 支持 HTTP、Socket 和 SocketIO 连接，或自定义`TypedRPCConnectionProvider`
+- 🔄 **中间件支持** - 可扩展的中间件系统，用于请求/响应处理
+- 📝 **上下文感知** - 内置上下文系统，用于在处理程序之间传递数据
+- 🔁 **双向通信** - 支持客户端和服务器之间的双向 RPC 调用，能力取决于连接类型
+- 📦 **易于使用** - 用于定义服务和方法的简单 API
+- 🚀 **零依赖** - 不依赖任何外部库，仅依赖 TypeScript 标准库
+- 🌐 **前后端通用** - 可在 Node.js 后端和浏览器前端使用
+- 📈 **高拓展性** - 可轻松集成入 Electron、Express 等框架作为 RPC 调用方案
 
 ## 安装
 
 ```bash
-npm install typedrpc
+npm install @mingzey/typedrpc
 ```
 
 ## 基本使用
@@ -22,22 +31,24 @@ npm install typedrpc
 ### 服务器设置
 
 ```typescript
-import { TypedRPCServer, TypedRPCAPIDefine } from 'typedrpc';
+import { TypedRPCServer, TypedRPCAPIDefine } from '@mingzey/typedrpc';
 
 // 定义 API 接口
 const ServerAPIDefine = new TypedRPCAPIDefine<{
-  // 服务层 - 在此处定义服务或使用接口继承
+    // 服务层 - 在此处定义服务或使用接口继承
     math:{
-      // 方法层 - 在此处定义方法
+        // 方法层 - 在此处定义方法
         add(a:number,b:number):number,
     },
-}>();
+}>({
+    timeout:10 * 1000
+});
 
 // 创建服务器实例
 const server = new TypedRPCServer({
     // 让 TypeScript 从 ServerAPIDefine 推断类型
     local:ServerAPIDefine,
-    // 连接层 - 在此处使用TypedRPCConnectionProvider的实现类
+    // 连接层 - 在此处使用连接提供者
     // connection:{
     //     provider:new TypedRPCConnectionProviderHTTP(),
     // }
@@ -45,7 +56,7 @@ const server = new TypedRPCServer({
 
 // 挂钩服务方法
 server.hook('math','add',{
-    handler:(a,b)=>a+b,
+    handler: (a,b) => a+b,
 });
 
 // 开始监听
@@ -57,7 +68,7 @@ server.listen({
 ### 客户端设置
 
 ```typescript
-import { TypedRPCClient, TypedRPCAPIDefine } from 'typedrpc';
+import { TypedRPCClient, TypedRPCAPIDefine } from '@mingzey/typedrpc';
 // 重用或导入相同的 API 定义
 const ServerAPIDefine = new TypedRPCAPIDefine<{
   math:{
@@ -95,9 +106,11 @@ new TypedRPCServer({
     local:ServerAPIDefine,
     connection:{
         provider:new TypedRPCConnectionProviderHTTP(),
+        // or use socket connection
         // provider:new TypedRPCConnectionProviderSocket(),
+        // or use socketio connection
         // provider:new TypedRPCConnectionProviderSocketIO(),
-        // provider:实现您自己的TypedRPCConnectionProvider的子类
+        // or implaement your own connection provider
     }
 })
 ```
@@ -125,15 +138,15 @@ new TypedRPCServer({
 TypedRPC 支持服务器和客户端的中间件：
 
 ```typescript
-class MyMiddleware extends TypedRPCHandlerMiddleware{
+class MyMiddleware extends TypedRPCMiddleware{
 
     async inbound(context: TypedRPCContext): Promise<TypedRPCContext> {
-      // 处理入站数据包时执行操作
+      // Do something when inbound packet
       return context;
     }
 
     async outbound(context: TypedRPCContext): Promise<TypedRPCContext> {
-      // 处理出站数据包时执行操作
+      // Do something when outbound packet
       return context;
     }
 
@@ -147,82 +160,85 @@ TypedRPC 提供内置的上下文系统，允许您在服务方法中访问请
 ### 示例：在服务中使用上下文
 
 ```typescript
-// 服务器端代码
-import { TypedRPCServer, TypedRPCAPIDefine, TypedRPCContextSymbol, type TypedRPCContext, type TypedRPCContextAware } from 'typedrpc';
+// Server-side code
+import { TypedRPCServer, TypedRPCAPIDefine, TypedRPCContextSymbol, type TypedRPCContext, type TypedRPCContextAware } from '@mingzey/typedrpc';
 
-// 定义服务接口
+// Define service interface
 interface MathServiceInterface {
     add(a: number, b: number):number;
 }
 
-// 创建 API 定义
+// Create API definition
 const serverAPIDefine = new TypedRPCAPIDefine<{
     math: MathServiceInterface,
 }>();
 
-// 创建服务器实例
+// Create server instance
 const server = new TypedRPCServer({
     local: serverAPIDefine,
 });
 
-// 实现具有上下文感知的服务
+// Implement service with context awareness
 class MathService implements MathServiceInterface, TypedRPCContextAware {
-    // 使用 TypedRPCContextSymbol 注入上下文
+    // Inject context using TypedRPCContextSymbol
     [TypedRPCContextSymbol]: TypedRPCContext | null = null;
 
-    // 为安全起见，必须使用 @TypedRPCAPIDefine.method() 将方法标记为服务使用中的 RPC 方法
+    /**
+     * For safety, must use @TypedRPCAPIDefine.method() to mark method as RPC method in service usage
+     * You need set experimentalDecorators:true in tsconfig.json
+     */
     @TypedRPCAPIDefine.method()
     add(a: number, b: number): number {
-        // 访问上下文
+        // Access context
         const context = this[TypedRPCContextSymbol];
         if (!context) {
-            throw new Error('上下文不可用');
+            throw new Error('Context is not available');
         }
         
-        // 使用上下文信息（例如，连接详情、认证）
-        console.log('请求来自:', context.connection);
+        // Use context information (e.g., connection details, authentication)
+        console.log('Request received from:', context.connection);
         
         return a + b;
     }
 }
 
-// 将服务挂钩到服务器，只有标记有 @TypedRPCAPIDefine.method() 的方法会被挂钩
+// Hook service to server, only methods marked with @TypedRPCAPIDefine.method() will be hooked
 server.hookService('math', new MathService());
 
-// 启动服务器
+// Start server
 server.listen({
     port: 3698,
 });
 ```
 
 ```typescript
-// 客户端代码
+// Client-side code
 import { TypedRPCClient, TypedRPCAPIDefine } from 'typedrpc';
 
-// 重用 API 定义
+// Reuse API definition
 const serverAPIDefine = new TypedRPCAPIDefine<{
     math: MathServiceInterface,
 }>();
 
-// 创建客户端
+// Create client
 const client = new TypedRPCClient({
     remote: serverAPIDefine,
 });
 
-// 连接并进行 RPC 调用
+// Connect and make RPC call
 const connection = await client.connect("localhost:3698");
 const api = client.getAPI(connection);
-const result = await api.math.add.call(1, 2); // 返回 3
+const result = await api.math.add.call(1, 2); // Returns 3
 ```
 
-## 更多使用
+## More Usage
 
-请参阅 `./test/*.ts` 获取更多使用示例。
+see `./test/*.ts` for more usage.
 
-## 贡献
+## Contributing
 
-欢迎贡献！请随时提交 Pull Request。
+Contributions are welcome! Please feel free to submit a Pull Request.
 
-## 许可证
+## License
 
-MIT 许可证 - 详情请参阅 [LICENSE](https://github.com/TypedRPC/TypedRPC/blob/main/LICENSE) 文件。
+MIT License - see the [LICENSE](https://github.com/MingZeY/TypedRPC/blob/master/LICENSE) file for details.

package/package.json

@@ -1,8 +1,12 @@
 {
   "name": "@mingzey/typedrpc",
-  "version": "1.1.1",
+  "version": "1.1.3",
   "description": "TypeScript-based RPC framework with support for multiple connection types including HTTP, Socket, and SocketIO or custom",
   "author": "MingZeY <1552904342@qq.com>",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/MingZeY/TypedRPC.git"
+  },
   "keywords": [
     "rpc",
     "typescript"
@@ -17,7 +21,7 @@
   "scripts": {
     "test": "tsx test/test.ts",
     "build": "tsc -p tsconfig.build.json",
-    "check": "tsc -p tsconfig.check.json --noEmit"
+    "check": "tsc --noEmit"
   },
   "devDependencies": {
     "@types/express": "^5.0.6",