npm - sx-peerjs-http-util - Versions diffs - 1.0.1 - Mend

sx-peerjs-http-util 1.0.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (10) hide show

package/README.md ADDED Viewed

@@ -0,0 +1,172 @@
+# sx-peerjs-http-util
+一个浏览器端库，将 PeerJS 封装成简单易用的类似 HTTP 的 API。
+## 特性
+- 简单的请求-响应 API，类似 HTTP
+- 基于 PeerJS (WebRTC) 实现 P2P 通信
+- TypeScript 支持
+- 完整的 E2E 测试
+## 安装
+```bash
+npm install sx-peerjs-http-util peerjs
+```
+## API
+### Request
+```typescript
+interface Request {
+  method?: string;
+  data?: unknown;
+}
+```
+### Response
+```typescript
+interface Response {
+  status: number;
+  data: unknown;
+}
+```
+### request(options: RequestOptions): Promise<Response>
+发送请求到指定 Peer。
+```typescript
+import { request } from 'sx-peerjs-http-util';
+const response = await request({
+  peerId: 'remote-peer-id',
+  request: {
+    method: 'GET',
+    data: { message: 'Hello' },
+  },
+});
+console.log(response.status); // 200
+console.log(response.data); // { message: 'Response from server' }
+```
+### createServer(peer: Peer, handler: RequestHandler): () => void
+创建一个 PeerJS HTTP 服务器。
+```typescript
+import { createServer } from 'sx-peerjs-http-util';
+import { Peer } from 'peerjs';
+const peer = new Peer();
+const handler = async (request) => {
+  return {
+    status: 200,
+    data: {
+      message: 'Hello from server',
+      received: request.data,
+    },
+  };
+};
+const cleanup = createServer(peer, handler);
+// 清理时调用
+cleanup();
+```
+## 完整示例
+### 服务器端
+```html
+<!DOCTYPE html>
+<html>
+<head>
+  <script src="https://unpkg.com/peerjs@1.5.5/dist/peerjs.min.js"></script>
+  <script type="module">
+    import { createServer } from './dist/index.js';
+    const peer = new Peer();
+    peer.on('open', (id) => {
+      console.log('My Peer ID:', id);
+    });
+    const handler = async (request) => {
+      // 处理请求
+      if (request.method === 'ECHO') {
+        return {
+          status: 200,
+          data: request.data,
+        };
+      }
+      return {
+        status: 200,
+        data: { message: 'OK' },
+      };
+    };
+    createServer(peer, handler);
+  </script>
+</head>
+<body>
+  <h1>Server</h1>
+  <div id="peer-id"></div>
+</body>
+</html>
+```
+### 客户端
+```html
+<!DOCTYPE html>
+<html>
+<head>
+  <script src="https://unpkg.com/peerjs@1.5.5/dist/peerjs.min.js"></script>
+  <script type="module">
+    import { request } from './dist/index.js';
+    async function sendRequest() {
+      const response = await request({
+        peerId: 'server-peer-id',
+        request: {
+          method: 'ECHO',
+          data: { test: 'data' },
+        },
+      });
+      console.log('Response:', response);
+    }
+    // 调用
+    sendRequest();
+  </script>
+</head>
+<body>
+  <h1>Client</h1>
+  <button onclick="sendRequest()">Send Request</button>
+</body>
+</html>
+```
+## E2E 测试
+运行端到端测试：
+```bash
+npm run test:e2e
+```
+## 注意事项
+- 每次请求都会创建新的 Peer 连接，请求完成后会自动清理
+- 请求超时时间为 30 秒
+- 此库仅用于浏览器环境
+- 需要使用 PeerJS 信令服务器（默认使用公共服务器）

package/dist/index.d.ts ADDED Viewed

@@ -0,0 +1,17 @@
+import type { Request, Response, RequestOptions, ServerOptions, RequestHandler, ConnectionData } from './types';
+/**
+ * 发送 HTTP 请求到指定 Peer
+ * @param options 请求选项
+ * @returns Promise<Response>
+ */
+export declare function request(options: RequestOptions): Promise<Response>;
+/**
+ * 创建 PeerJS HTTP 服务器
+ * @param options 服务端选项
+ * @param handler 请求处理器
+ * @returns 清理函数
+ */
+export declare function createServer(peer: any, // Peer 实例
+handler: RequestHandler): () => void;
+export type { Request, Response, RequestOptions, ServerOptions, RequestHandler, ConnectionData };
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map ADDED Viewed

@@ -0,0 +1 @@

+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,OAAO,EAAE,QAAQ,EAAE,cAAc,EAAE,aAAa,EAAE,cAAc,EAAE,cAAc,EAAE,MAAM,SAAS,CAAC;AAUhH;;;;GAIG;AACH,wBAAsB,OAAO,CAAC,OAAO,EAAE,cAAc,GAAG,OAAO,CAAC,QAAQ,CAAC,CAiExE;AAED;;;;;GAKG;AACH,wBAAgB,YAAY,CAC1B,IAAI,EAAE,GAAG,EAAE,UAAU;AACrB,OAAO,EAAE,cAAc,GACtB,MAAM,IAAI,CAuDZ;AAGD,YAAY,EAAE,OAAO,EAAE,QAAQ,EAAE,cAAc,EAAE,aAAa,EAAE,cAAc,EAAE,cAAc,EAAE,CAAC"}

package/dist/index.js ADDED Viewed

@@ -0,0 +1,116 @@
+import { Peer } from 'peerjs';
+/**
+ * 发送 HTTP 请求到指定 Peer
+ * @param options 请求选项
+ * @returns Promise<Response>
+ */
+export async function request(options) {
+    const { peerId, request } = options;
+    return new Promise((resolve, reject) => {
+        // 创建临时 Peer 用于发送请求
+        const tempPeer = new Peer();
+        // 超时处理
+        const timeout = setTimeout(() => {
+            conn.close();
+            tempPeer.destroy();
+            reject(new Error('Request timeout'));
+        }, 30000);
+        let conn;
+        let requestId;
+        tempPeer.on('open', (id) => {
+            // 连接到对端 Peer
+            conn = tempPeer.connect(peerId, {
+                reliable: true,
+            });
+            conn.on('open', () => {
+                // 生成请求 ID
+                requestId = `${tempPeer.id}-${Date.now()}`;
+                // 发送请求
+                const message = {
+                    type: 'request',
+                    id: requestId,
+                    request,
+                };
+                conn.send(message);
+            });
+            conn.on('data', (data) => {
+                const message = data;
+                if (message.type === 'response' && message.id === requestId) {
+                    clearTimeout(timeout);
+                    conn.close();
+                    tempPeer.destroy();
+                    resolve(message.response);
+                }
+            });
+            conn.on('error', (err) => {
+                clearTimeout(timeout);
+                tempPeer.destroy();
+                reject(err);
+            });
+            conn.on('close', () => {
+                clearTimeout(timeout);
+                tempPeer.destroy();
+            });
+        });
+        tempPeer.on('error', (err) => {
+            clearTimeout(timeout);
+            reject(err);
+        });
+    });
+}
+/**
+ * 创建 PeerJS HTTP 服务器
+ * @param options 服务端选项
+ * @param handler 请求处理器
+ * @returns 清理函数
+ */
+export function createServer(peer, // Peer 实例
+handler) {
+    const connections = new Set();
+    // 处理传入连接
+    peer.on('connection', (conn) => {
+        connections.add(conn);
+        conn.on('data', async (data) => {
+            const message = data;
+            if (message.type === 'request') {
+                try {
+                    // 调用处理器处理请求
+                    const response = await handler(message.request);
+                    // 发送响应
+                    const responseMessage = {
+                        type: 'response',
+                        id: message.id,
+                        response,
+                    };
+                    conn.send(responseMessage);
+                }
+                catch (error) {
+                    // 发送错误响应
+                    const errorResponse = {
+                        type: 'response',
+                        id: message.id,
+                        response: {
+                            status: 500,
+                            data: { error: error instanceof Error ? error.message : 'Unknown error' },
+                        },
+                    };
+                    conn.send(errorResponse);
+                }
+            }
+        });
+        conn.on('close', () => {
+            connections.delete(conn);
+        });
+        conn.on('error', () => {
+            connections.delete(conn);
+        });
+    });
+    // 返回清理函数
+    return () => {
+        for (const conn of connections) {
+            conn.close();
+        }
+        connections.clear();
+    };
+}
+//# sourceMappingURL=index.js.map

package/dist/index.js.map ADDED Viewed

@@ -0,0 +1 @@

+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAkB,MAAM,QAAQ,CAAC;AAW9C;;;;GAIG;AACH,MAAM,CAAC,KAAK,UAAU,OAAO,CAAC,OAAuB;IACnD,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,GAAG,OAAO,CAAC;IAEpC,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;QACrC,mBAAmB;QACnB,MAAM,QAAQ,GAAG,IAAI,IAAI,EAAE,CAAC;QAE5B,OAAO;QACP,MAAM,OAAO,GAAG,UAAU,CAAC,GAAG,EAAE;YAC9B,IAAI,CAAC,KAAK,EAAE,CAAC;YACb,QAAQ,CAAC,OAAO,EAAE,CAAC;YACnB,MAAM,CAAC,IAAI,KAAK,CAAC,iBAAiB,CAAC,CAAC,CAAC;QACvC,CAAC,EAAE,KAAK,CAAC,CAAC;QAEV,IAAI,IAAoB,CAAC;QACzB,IAAI,SAAiB,CAAC;QAEtB,QAAQ,CAAC,EAAE,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,EAAE;YACzB,aAAa;YACb,IAAI,GAAG,QAAQ,CAAC,OAAO,CAAC,MAAM,EAAE;gBAC9B,QAAQ,EAAE,IAAI;aACf,CAAC,CAAC;YAEH,IAAI,CAAC,EAAE,CAAC,MAAM,EAAE,GAAG,EAAE;gBACnB,UAAU;gBACV,SAAS,GAAG,GAAG,QAAQ,CAAC,EAAE,IAAI,IAAI,CAAC,GAAG,EAAE,EAAE,CAAC;gBAE3C,OAAO;gBACP,MAAM,OAAO,GAAoB;oBAC/B,IAAI,EAAE,SAAS;oBACf,EAAE,EAAE,SAAS;oBACb,OAAO;iBACR,CAAC;gBAEF,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;YACrB,CAAC,CAAC,CAAC;YAEH,IAAI,CAAC,EAAE,CAAC,MAAM,EAAE,CAAC,IAAa,EAAE,EAAE;gBAChC,MAAM,OAAO,GAAG,IAAuB,CAAC;gBAExC,IAAI,OAAO,CAAC,IAAI,KAAK,UAAU,IAAI,OAAO,CAAC,EAAE,KAAK,SAAS,EAAE,CAAC;oBAC5D,YAAY,CAAC,OAAO,CAAC,CAAC;oBACtB,IAAI,CAAC,KAAK,EAAE,CAAC;oBACb,QAAQ,CAAC,OAAO,EAAE,CAAC;oBACnB,OAAO,CAAC,OAAO,CAAC,QAAS,CAAC,CAAC;gBAC7B,CAAC;YACH,CAAC,CAAC,CAAC;YAEH,IAAI,CAAC,EAAE,CAAC,OAAO,EAAE,CAAC,GAAG,EAAE,EAAE;gBACvB,YAAY,CAAC,OAAO,CAAC,CAAC;gBACtB,QAAQ,CAAC,OAAO,EAAE,CAAC;gBACnB,MAAM,CAAC,GAAG,CAAC,CAAC;YACd,CAAC,CAAC,CAAC;YAEH,IAAI,CAAC,EAAE,CAAC,OAAO,EAAE,GAAG,EAAE;gBACpB,YAAY,CAAC,OAAO,CAAC,CAAC;gBACtB,QAAQ,CAAC,OAAO,EAAE,CAAC;YACrB,CAAC,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;QAEH,QAAQ,CAAC,EAAE,CAAC,OAAO,EAAE,CAAC,GAAG,EAAE,EAAE;YAC3B,YAAY,CAAC,OAAO,CAAC,CAAC;YACtB,MAAM,CAAC,GAAG,CAAC,CAAC;QACd,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;AACL,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,YAAY,CAC1B,IAAS,EAAE,UAAU;AACrB,OAAuB;IAEvB,MAAM,WAAW,GAAG,IAAI,GAAG,EAAkB,CAAC;IAE9C,SAAS;IACT,IAAI,CAAC,EAAE,CAAC,YAAY,EAAE,CAAC,IAAoB,EAAE,EAAE;QAC7C,WAAW,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;QAEtB,IAAI,CAAC,EAAE,CAAC,MAAM,EAAE,KAAK,EAAE,IAAa,EAAE,EAAE;YACtC,MAAM,OAAO,GAAG,IAAuB,CAAC;YAExC,IAAI,OAAO,CAAC,IAAI,KAAK,SAAS,EAAE,CAAC;gBAC/B,IAAI,CAAC;oBACH,YAAY;oBACZ,MAAM,QAAQ,GAAG,MAAM,OAAO,CAAC,OAAO,CAAC,OAAQ,CAAC,CAAC;oBAEjD,OAAO;oBACP,MAAM,eAAe,GAAoB;wBACvC,IAAI,EAAE,UAAU;wBAChB,EAAE,EAAE,OAAO,CAAC,EAAE;wBACd,QAAQ;qBACT,CAAC;oBAEF,IAAI,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC;gBAC7B,CAAC;gBAAC,OAAO,KAAK,EAAE,CAAC;oBACf,SAAS;oBACT,MAAM,aAAa,GAAoB;wBACrC,IAAI,EAAE,UAAU;wBAChB,EAAE,EAAE,OAAO,CAAC,EAAE;wBACd,QAAQ,EAAE;4BACR,MAAM,EAAE,GAAG;4BACX,IAAI,EAAE,EAAE,KAAK,EAAE,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,eAAe,EAAE;yBAC1E;qBACF,CAAC;oBAEF,IAAI,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;gBAC3B,CAAC;YACH,CAAC;QACH,CAAC,CAAC,CAAC;QAEH,IAAI,CAAC,EAAE,CAAC,OAAO,EAAE,GAAG,EAAE;YACpB,WAAW,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;QAC3B,CAAC,CAAC,CAAC;QAEH,IAAI,CAAC,EAAE,CAAC,OAAO,EAAE,GAAG,EAAE;YACpB,WAAW,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;QAC3B,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,SAAS;IACT,OAAO,GAAG,EAAE;QACV,KAAK,MAAM,IAAI,IAAI,WAAW,EAAE,CAAC;YAC/B,IAAI,CAAC,KAAK,EAAE,CAAC;QACf,CAAC;QACD,WAAW,CAAC,KAAK,EAAE,CAAC;IACtB,CAAC,CAAC;AACJ,CAAC"}

package/dist/types.d.ts ADDED Viewed

@@ -0,0 +1,48 @@
+/**
+ * 请求数据结构
+ */
+export interface Request {
+    /** 请求方法 */
+    method?: string;
+    /** 请求数据 */
+    data?: unknown;
+}
+/**
+ * 响应数据结构
+ */
+export interface Response {
+    /** 响应状态码 */
+    status: number;
+    /** 响应数据 */
+    data: unknown;
+}
+/**
+ * PeerJS HTTP 请求选项
+ */
+export interface RequestOptions {
+    /** 对端设备的 Peer ID */
+    peerId: string;
+    /** 请求数据 */
+    request: Request;
+}
+/**
+ * PeerJS HTTP 服务端选项
+ */
+export interface ServerOptions {
+    /** PeerJS 实例 */
+    peer: any;
+}
+/**
+ * 请求处理器函数类型
+ */
+export type RequestHandler = (request: Request) => Promise<Response> | Response;
+/**
+ * 连接事件数据
+ */
+export interface ConnectionData {
+    /** 发送请求 */
+    send: (request: Request) => Promise<Response>;
+    /** 关闭连接 */
+    close: () => void;
+}
+//# sourceMappingURL=types.d.ts.map

package/dist/types.d.ts.map ADDED Viewed

@@ -0,0 +1 @@

+ {"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,MAAM,WAAW,OAAO;IACtB,WAAW;IACX,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,WAAW;IACX,IAAI,CAAC,EAAE,OAAO,CAAC;CAChB;AAED;;GAEG;AACH,MAAM,WAAW,QAAQ;IACvB,YAAY;IACZ,MAAM,EAAE,MAAM,CAAC;IACf,WAAW;IACX,IAAI,EAAE,OAAO,CAAC;CACf;AAED;;GAEG;AACH,MAAM,WAAW,cAAc;IAC7B,oBAAoB;IACpB,MAAM,EAAE,MAAM,CAAC;IACf,WAAW;IACX,OAAO,EAAE,OAAO,CAAC;CAClB;AAED;;GAEG;AACH,MAAM,WAAW,aAAa;IAC5B,gBAAgB;IAChB,IAAI,EAAE,GAAG,CAAC;CACX;AAED;;GAEG;AACH,MAAM,MAAM,cAAc,GAAG,CAAC,OAAO,EAAE,OAAO,KAAK,OAAO,CAAC,QAAQ,CAAC,GAAG,QAAQ,CAAC;AAEhF;;GAEG;AACH,MAAM,WAAW,cAAc;IAC7B,WAAW;IACX,IAAI,EAAE,CAAC,OAAO,EAAE,OAAO,KAAK,OAAO,CAAC,QAAQ,CAAC,CAAC;IAC9C,WAAW;IACX,KAAK,EAAE,MAAM,IAAI,CAAC;CACnB"}

package/dist/types.js ADDED Viewed

	@@ -0,0 +1,2 @@
1	+ export {};
2	+ //# sourceMappingURL=types.js.map

package/dist/types.js.map ADDED Viewed

	@@ -0,0 +1 @@
1	+ {"version":3,"file":"types.js","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":""}

package/package.json ADDED Viewed

@@ -0,0 +1,34 @@
+{
+  "name": "sx-peerjs-http-util",
+  "version": "1.0.1",
+  "description": "A browser library that wraps PeerJS with a simple HTTP-like API",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "type": "module",
+  "scripts": {
+    "build": "tsc",
+    "test:e2e": "playwright test",
+    "prepare": "npm run build"
+  },
+  "keywords": [
+    "peerjs",
+    "webrtc",
+    "p2p",
+    "http",
+    "browser",
+    "e2e"
+  ],
+  "author": "",
+  "license": "ISC",
+  "files": [
+    "dist"
+  ],
+  "dependencies": {
+    "peerjs": "^1.5.5"
+  },
+  "devDependencies": {
+    "@playwright/test": "^1.50.0",
+    "@types/node": "^22.14.0",
+    "typescript": "^5.8.3"
+  }
+}