kb-server 0.0.1-beta.19 → 0.0.1-beta.20

package/README.md

@@ -2,7 +2,7 @@
 
 快速创建一个 Node 服务
 
-快速创建 API、标准错误码、Server、支持统一鉴权函数（API 级别）、自定义中间件、日志
+快速创建 API、标准错误码、Server、支持统一鉴权函数（API 级别）、自定义中间件、日志、支持SSE
 
 ```javascript
 import { createServer } from "kb-server";

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

@@ -1,11 +1,19 @@
 import express from "express";
 import { AuthFunction } from "./api-middleware";
 import { APIs } from "./create-api";
+import { SSEHandlers } from "./sse-middleware";
 export interface ICreateServerParams {
     /**
      * API列表
      */
     apis: APIs;
+    /**
+     * SSE配置
+     */
+    sse?: {
+        handlers: SSEHandlers;
+        route?: string;
+    };
     /**
      * 鉴权函数
      *

package/dist/common/create-server.js

@@ -26,18 +26,22 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.createServer = void 0;
 const express_1 = __importStar(require("express"));
 const api_middleware_1 = require("./api-middleware");
+const sse_middleware_1 = require("./sse-middleware");
 /**
  * 创建 Server
  */
 function createServer(params, options) {
-    const { apis, authFn, log, middlewares = [] } = params || {};
+    const { apis, sse, authFn, log, middlewares = [] } = params || {};
     const { limit = "10mb" } = options || {};
+    const { handlers, route } = sse || {};
     const app = (0, express_1.default)();
     // POST 参数获取
     app.use((0, express_1.urlencoded)({ extended: true, limit }));
     app.use((0, express_1.json)({ limit }));
     // 使用自定义中间件
     middlewares.forEach((middleware) => app.use(middleware));
+    // 注入SSE
+    handlers && app.use((0, sse_middleware_1.packSSE)(handlers, { route }));
     // 注入API
     app.use((0, api_middleware_1.packAPI)(apis, { authFn, log }));
     return app;

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

@@ -0,0 +1,25 @@
+import express from "express";
+import { ServerContext } from "./create-api";
+import { AuthFunction } from "./api-middleware";
+export type SseExecution<P, R, A> = (
+/** 请求入参 */
+params: P, 
+/** 请求上下文 */
+ctx: ServerContext<A>, 
+/**
+ * 允许执行的操作
+ */
+operations: {
+    /** 发送消息 */
+    send: (event: string, message: string) => void;
+}) => Promise<R>;
+export type AnySseExecution = SseExecution<any, any, any>;
+export type SSEHandlers = Record<string, AnySseExecution>;
+interface IPackSSEOptions {
+    authFn?: AuthFunction;
+    route?: string;
+    log?: boolean;
+}
+export declare const packSSE: (sseHandlers: SSEHandlers, options?: IPackSSEOptions) => express.RequestHandler;
+export declare const createSSEMessage: (event: string, message: string) => string;
+export {};

package/dist/common/sse-middleware.js

@@ -0,0 +1,124 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createSSEMessage = exports.packSSE = void 0;
+const uuid_1 = require("uuid");
+const logger_1 = require("../helper/logger");
+const create_errors_1 = require("./create-errors");
+const short_id_1 = require("../helper/short-id");
+const packSSE = (sseHandlers, options) => {
+    const sseMap = new Map(Object.entries(sseHandlers).map(([action, execution]) => [
+        action,
+        execution,
+    ]));
+    const { authFn, log = true, route = "/sse" } = options || {};
+    return async (req, res, next) => {
+        const { path } = req;
+        // 路径不是SSE的路径
+        if (path !== route) {
+            next();
+            return;
+        }
+        // 请求开始时间
+        const start = Date.now();
+        let took = 0;
+        // 生成请求ID
+        const requestId = (0, uuid_1.v4)();
+        // 上下文
+        const ctx = {
+            RequestId: requestId,
+        };
+        try {
+            // API 解析
+            const { Action, ...params } = req.body || {};
+            if (log) {
+                logger_1.logger.log("info", `请求入参：${JSON.stringify(req.body)} - RequestId: ${requestId}`);
+            }
+            // 接口未定义
+            if (!Action) {
+                throw new create_errors_1.CommonErrors.InvalidParameter.EmptyAPIRequest();
+            }
+            // 处理鉴权函数
+            if (authFn !== null && authFn !== undefined) {
+                if (typeof authFn !== "function") {
+                    throw new create_errors_1.CommonErrors.ResourceNotFound.AuthFunctionNotFound();
+                }
+                const authResult = await authFn(Action, req);
+                if (!authResult) {
+                    throw new create_errors_1.CommonErrors.FailOperation.NoPermission();
+                }
+                if (typeof authResult !== "boolean") {
+                    // 把权限信息写入上下文
+                    ctx.AuthInfo = authResult || {};
+                }
+            }
+            // API 处理
+            const execution = sseMap.get(Action);
+            if (typeof execution !== "function") {
+                throw new create_errors_1.CommonErrors.ResourceNotFound.APINotFound();
+            }
+            /**
+             * 开始处理SSE请求就要统计
+             *
+             * 请求处理完毕的时间
+             *
+             * 不要让 API 随意改写 req res 里面的东西
+             *
+             * 统一管理请求头
+             *
+             */
+            // 处理SSE
+            res.writeHead(200, {
+                "Content-Type": "text/event-stream",
+                "Cache-Control": "no-cache",
+                Connection: "keep-alive",
+            });
+            const send = (event, message) => {
+                const response = (0, exports.createSSEMessage)(event, message);
+                res.write(response);
+                logger_1.logger.log("info", `发送消息：${response}`);
+            };
+            await execution(params, ctx, { send });
+            // 完成响应
+            took = Date.now() - start;
+            logger_1.logger.log("info", `耗时：${took} ms - RequestId: ${requestId}`);
+            return res.end();
+        }
+        catch (rawError) {
+            logger_1.logger.log("error", rawError);
+            // 未知错误
+            let error = new create_errors_1.CommonErrors.InternalError.UnknownError();
+            // 可控错误
+            if (rawError instanceof create_errors_1.BaseError) {
+                error = rawError;
+            }
+            // DB错误
+            if (rawError?.sql) {
+                error = new create_errors_1.CommonErrors.InternalError.DatabaseError();
+            }
+            const response = (0, exports.createSSEMessage)("error", JSON.stringify({
+                Response: {
+                    Error: {
+                        Code: error.code,
+                        Message: error.message,
+                    },
+                    RequestId: requestId,
+                },
+            }));
+            // 完成响应
+            took = Date.now() - start;
+            logger_1.logger.log("info", `响应：${response}`);
+            logger_1.logger.log("info", `耗时：${took} ms - RequestId: ${requestId}`);
+            res.write(response);
+            return res.end();
+        }
+    };
+};
+exports.packSSE = packSSE;
+const createSSEMessage = (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;
+};
+exports.createSSEMessage = createSSEMessage;

package/dist/helper/short-id.d.ts

@@ -0,0 +1 @@
+export declare const shortId: () => string;

package/dist/helper/short-id.js

@@ -0,0 +1,7 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.shortId = void 0;
+const nanoid_1 = require("nanoid");
+const nanoid = (0, nanoid_1.customAlphabet)("123456789abcdefghijkmnpqrstuvwxyzABCDEFGHJKLMNPQRSTUVWXYZ", 10);
+const shortId = () => nanoid();
+exports.shortId = shortId;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "kb-server",
-  "version": "0.0.1-beta.19",
+  "version": "0.0.1-beta.20",
   "description": "A fast server for Node.JS,made by express.",
   "main": "dist/index.js",
   "scripts": {
@@ -24,6 +24,7 @@
     "express": "^4.21.1",
     "is-plain-object": "^5.0.0",
     "moment": "^2.30.1",
+    "nanoid": "^5.1.3",
     "node-fetch": "^2.7.0",
     "utility-types": "^3.11.0",
     "uuid": "^11.0.3"