kb-server 0.0.1-beta.38 → 0.0.1-beta.39

package/README.md

@@ -1,10 +1,10 @@
 # KB Server
 
-快速创建一个 Node 服务
+快速创建一个 `Node` 服务 - 基于 `Express`
 
-快速创建 API、标准错误码、Server、支持统一鉴权函数（API 级别）、自定义中间件、日志、支持SSE
+快速创建 `API`、标准错误码、`Server`、支持统一鉴权函数（API 级别）、自定义中间件、日志、支持 `SSE`
 
-```javascript
+```typescript
 import { createServer } from "kb-server";
 import * as apis from "./apis";
 
@@ -18,3 +18,27 @@ server.listen(3000);
   return createServer({ apis });
 })().then((app) => app.listen(3000));
 ```
+
+## SSE 支持
+
+```typescript
+import { createServer } from "kb-server";
+import * as apis from "./apis";
+import * as sse from "./sse";
+
+
+(async () => {
+  // 其他的异步操作，例如：初始化数据库
+  return createServer({
+    apis,
+    sse: {
+      handlers: sse, // ...SSE处理函数
+    },
+    authFn: (action, req) => {
+      // ...统一鉴权函数
+    },
+    middlewares: [], // ...中间键列表
+    log: true, // ...框架日志
+  });
+})().then((app) => app.listen(3000));
+```

package/dist/common/api-middleware.js

@@ -27,7 +27,7 @@ const packAPI = (apis, options) => {
             // API 解析
             const { Action, ...params } = req.body || {};
             if (log) {
-                logger_1.logger.log("info", `请求入参：${JSON.stringify(req.body)} - RequestId: ${requestId}`);
+                logger_1.logger.info(`请求入参：${JSON.stringify(req.body)} - RequestId: ${requestId}`);
             }
             // 接口未定义
             if (!Action) {
@@ -63,12 +63,12 @@ const packAPI = (apis, options) => {
             };
             // 完成响应
             took = Date.now() - start;
-            logger_1.logger.log("info", `响应：${JSON.stringify(response)}`);
-            logger_1.logger.log("info", `耗时：${took} ms - RequestId: ${requestId}`);
+            logger_1.logger.info(`响应：${JSON.stringify(response)}`);
+            logger_1.logger.info(`耗时：${took} ms - RequestId: ${requestId}`);
             return res.send(response);
         }
         catch (rawError) {
-            logger_1.logger.log("error", rawError);
+            logger_1.logger.error(rawError);
             // 未知错误
             let error = new create_errors_1.CommonErrors.InternalError.UnknownError();
             // 可控错误
@@ -90,8 +90,8 @@ const packAPI = (apis, options) => {
             };
             // 完成响应
             took = Date.now() - start;
-            logger_1.logger.log("info", `响应：${JSON.stringify(response)}`);
-            logger_1.logger.log("info", `耗时：${took} ms - RequestId: ${requestId}`);
+            logger_1.logger.info(`响应：${JSON.stringify(response)}`);
+            logger_1.logger.info(`耗时：${took} ms - RequestId: ${requestId}`);
             return res.send(response);
         }
     };

package/dist/common/create-sse.d.ts

@@ -1,12 +1,20 @@
 import { Class } from "utility-types";
 import { ServerContext } from "./create-api";
-import { Session } from "better-sse";
+export type PushHandler = (data: Record<string, any>) => void;
+export type CloseHandler = () => void;
+export type SSEHandlers = {
+    /** 数据推送 */
+    push: PushHandler;
+    /** 关闭函数（调用结束要显式关闭） */
+    close: CloseHandler;
+    abortController: AbortController;
+};
 export type API<P, R> = (param: P) => Promise<R>;
 export type SseExecution<P, R, A> = (
 /** 请求入参 */
 params: P, 
-/** SSE 连接对象 */
-session: Session, 
+/** SSE相关操作函数 */
+sse: SSEHandlers, 
 /** 请求上下文 */
 ctx: ServerContext<A>) => Promise<R>;
 export type AnySseExecution = SseExecution<any, any, any>;

package/dist/common/create-sse.js

@@ -6,7 +6,7 @@ const class_validator_1 = require("class-validator");
 const create_errors_1 = require("./create-errors");
 const create_api_1 = require("./create-api");
 function createSseAPI(ParamsClass, execution) {
-    const runtime = async (params, session, ctx) => {
+    const runtime = async (params, sse, ctx) => {
         if (!params) {
             throw new create_errors_1.CommonErrors.InvalidParameter.EmptyParameter();
         }
@@ -20,7 +20,7 @@ function createSseAPI(ParamsClass, execution) {
             throw new create_errors_1.CommonErrors.InvalidParameter.ValidationError(errorMessages.join("\n"));
         }
         // 执行函数
-        return await execution(params, session, ctx);
+        return await execution(params, sse, ctx);
     };
     return runtime;
 }

package/dist/common/sse-middleware.d.ts

@@ -7,5 +7,5 @@ interface IPackSSEOptions {
     log?: boolean;
 }
 export declare const packSSE: (sseHandlers: SseHandlers, options?: IPackSSEOptions) => express.RequestHandler;
-export declare const createSSEMessage: (event: string, message: string) => string;
+export declare const createSSEMsg: (event: string, message: string) => string;
 export {};

package/dist/common/sse-middleware.js

@@ -1,7 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.createSSEMessage = exports.packSSE = void 0;
-const better_sse_1 = require("better-sse");
+exports.createSSEMsg = exports.packSSE = void 0;
 const uuid_1 = require("uuid");
 const logger_1 = require("../helper/logger");
 const create_errors_1 = require("./create-errors");
@@ -38,7 +37,7 @@ const packSSE = (sseHandlers, options) => {
             // API 解析
             const { Action, ...params } = req.body || {};
             if (log) {
-                logger_1.logger.log("info", `请求入参：${JSON.stringify(req.body)} - RequestId: ${requestId}`);
+                logger_1.logger.info(`请求入参：${JSON.stringify(req.body)} - RequestId: ${requestId}`);
             }
             // 接口未定义
             if (!Action) {
@@ -63,17 +62,55 @@ const packSSE = (sseHandlers, options) => {
             if (typeof execution !== "function") {
                 throw new create_errors_1.CommonErrors.ResourceNotFound.APINotFound();
             }
-            const session = await (0, better_sse_1.createSession)(req, res);
-            await execution(params, session, ctx);
-            // 完成响应
-            took = Date.now() - start;
-            logger_1.logger.log("info", `耗时：${took} ms - RequestId: ${requestId}`);
-            return res.end();
+            // 写头
+            res.writeHead(200, {
+                "Content-Type": "text/event-stream",
+                "Cache-Control": "no-cache",
+                Connection: "keep-alive",
+            });
+            const abortController = new AbortController();
+            // 连接断开
+            let isConnected = true;
+            res.on("close", () => {
+                isConnected = false;
+                abortController.abort();
+                // 完成响应
+                took = Date.now() - start;
+                logger_1.logger.info(`耗时：${took} ms - ${requestId}`);
+                return res.end();
+            });
+            // 推送消息
+            const push = (data) => {
+                if (!isConnected) {
+                    logger_1.logger.warning(`连接已关闭： ${requestId}`);
+                    return;
+                }
+                const msg = createResponseMsg(data);
+                try {
+                    res.write(msg);
+                    logger_1.logger.info(`推送数据： ${msg}`);
+                }
+                catch (error) {
+                    if (error.code === "EPIPE" || error.code === "ECONNRESET") {
+                        logger_1.logger.warning(`连接已关闭： ${requestId}`);
+                        isConnected = false;
+                    }
+                }
+            };
+            // 主动关闭
+            const close = () => {
+                logger_1.logger.info(`主动关闭连接： ${requestId}`);
+                // 完成响应
+                took = Date.now() - start;
+                logger_1.logger.info(`耗时：${took} ms - ${requestId}`);
+                res.end();
+            };
+            await execution(params, { push, close, abortController }, ctx);
         }
         catch (rawError) {
-            logger_1.logger.log("error", rawError);
+            logger_1.logger.error(rawError);
             if (!res.headersSent) {
-                // 写请求头
+                // 写头
                 res.writeHead(200, {
                     "Content-Type": "text/event-stream",
                     "Cache-Control": "no-cache",
@@ -90,27 +127,36 @@ const packSSE = (sseHandlers, options) => {
             if (rawError?.sql) {
                 error = new create_errors_1.CommonErrors.InternalError.DatabaseError();
             }
-            const response = (0, exports.createSSEMessage)("error", JSON.stringify({
+            const errResponse = {
                 Response: {
                     Error: { Code: error.code, Message: error.message },
                     RequestId: requestId,
                 },
-            }));
+            };
+            const response = (0, exports.createSSEMsg)("error", JSON.stringify(errResponse));
             // 完成响应
             took = Date.now() - start;
-            logger_1.logger.log("info", `发送消息：\n${response}`);
-            logger_1.logger.log("info", `耗时：${took} ms - RequestId: ${requestId}`);
-            res.write(response);
-            return res.end();
+            logger_1.logger.info(`发送消息：\n${response}`);
+            logger_1.logger.info(`耗时：${took} ms - ${requestId}`);
+            res.write(response, () => res.end());
         }
     };
 };
 exports.packSSE = packSSE;
-const createSSEMessage = (event, message) => {
+const createSSEMsg = (event, message) => {
     const id = (0, short_id_1.shortId)();
     const idStr = `id: ${id}\n`;
     const eventStr = `event: ${event}\n`;
     const dataStr = `data: ${message}\n\n`;
-    return idStr + eventStr + dataStr;
+    return `${idStr}${eventStr}${dataStr}`;
+};
+exports.createSSEMsg = createSSEMsg;
+const createResponseMsg = (data, requestId) => {
+    const msg = {
+        Response: {
+            RequestId: requestId || (0, uuid_1.v4)(),
+            Data: data,
+        },
+    };
+    return JSON.stringify(msg);
 };
-exports.createSSEMessage = createSSEMessage;

package/dist/helper/logger.d.ts

@@ -1,6 +1,5 @@
 export declare const logger: {
-    log: typeof log;
+    info: (message: unknown) => void;
+    error: (message: unknown) => void;
+    warning: (message: unknown) => void;
 };
-type LogLevel = "info" | "error" | "warning";
-declare function log(level: LogLevel, message: unknown): void;
-export {};

package/dist/helper/logger.js

@@ -4,14 +4,17 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.logger = void 0;
-const moment_1 = __importDefault(require("moment"));
-exports.logger = { log };
-function log(level, message) {
-    const logTime = (0, moment_1.default)().format(`YYYY-MM-DD HH:mm:ss`);
+const dayjs_1 = __importDefault(require("dayjs"));
+const log = (level, message) => {
+    const logTime = (0, dayjs_1.default)().format(`YYYY-MM-DD HH:mm:ss`);
     if (typeof message === "string") {
         console.log(`[${level}] - [${logTime}] - ${message}`);
     }
     else {
         console.log(`[${level}] - [${logTime}] - `, message);
     }
-}
+};
+const info = (message) => log("info", message);
+const error = (message) => log("error", message);
+const warning = (message) => log("warning", message);
+exports.logger = { info, error, warning };

package/package.json

@@ -1,11 +1,11 @@
 {
   "name": "kb-server",
-  "version": "0.0.1-beta.38",
+  "version": "0.0.1-beta.39",
   "description": "A fast server for Node.JS,made by express.",
   "main": "dist/index.js",
   "scripts": {
     "build": "rm -rf ./dist && tsc",
-    "test": "echo \"Error: no test specified\" && exit 1"
+    "release": "npm run build && npm publish"
   },
   "keywords": [
     "2kb",
@@ -25,9 +25,9 @@
     "better-sse": "^0.13.0",
     "class-transformer": "^0.5.1",
     "class-validator": "^0.14.1",
+    "dayjs": "^1.11.13",
     "express": "^4.21.1",
     "is-plain-object": "^5.0.0",
-    "moment": "^2.30.1",
     "nanoid": "^3.3.9",
     "utility-types": "^3.11.0",
     "uuid": "^11.0.3"