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

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

@@ -21,6 +21,7 @@ declare const CommonErrorsMap: {
         readonly EmptyParameter: "请求参数不能为空";
         readonly EmptyAPIRequest: "未指定API的请求";
         readonly ValidationError: "参数校验失败";
+        readonly RouteError: "路由错误";
     };
     readonly ResourceNotFound: {
         readonly APINotFound: "不存在的API";
@@ -77,6 +78,7 @@ declare function createErrorsClasses<T extends MessageMap = MessageMap>(messageM
         readonly EmptyParameter: "请求参数不能为空";
         readonly EmptyAPIRequest: "未指定API的请求";
         readonly ValidationError: "参数校验失败";
+        readonly RouteError: "路由错误";
     };
     readonly ResourceNotFound: {
         readonly APINotFound: "不存在的API";
@@ -102,6 +104,7 @@ export declare const CommonErrors: ErrorClasses<MergeMessageMap<{
         readonly EmptyParameter: "请求参数不能为空";
         readonly EmptyAPIRequest: "未指定API的请求";
         readonly ValidationError: "参数校验失败";
+        readonly RouteError: "路由错误";
     };
     readonly ResourceNotFound: {
         readonly APINotFound: "不存在的API";

package/dist/common/create-errors.js

@@ -23,6 +23,7 @@ const CommonErrorsMap = {
         EmptyParameter: "请求参数不能为空",
         EmptyAPIRequest: "未指定API的请求",
         ValidationError: "参数校验失败",
+        RouteError: "路由错误",
     },
     ResourceNotFound: {
         APINotFound: "不存在的API",

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

@@ -1,7 +1,7 @@
 import express from "express";
 import { AuthFunction } from "./api-middleware";
 import { APIs } from "./create-api";
-import { SSEHandlers } from "./sse-middleware";
+import { SseHandlers } from "./create-sse";
 export interface ICreateServerParams {
     /**
      * API列表
@@ -11,7 +11,17 @@ export interface ICreateServerParams {
      * SSE配置
      */
     sse?: {
-        handlers: SSEHandlers;
+        /**
+         * SSE API列表
+         */
+        handlers: SseHandlers;
+        /**
+         * SSE 监听的路由，例如：`/sse/generate`
+         *
+         * 注意：路由要以 `/` 开头
+         *
+         * 默认为：`/sse`
+         */
         route?: string;
     };
     /**

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

@@ -0,0 +1,27 @@
+import { Class } from "utility-types";
+import { ServerContext } from "./create-api";
+export type API<P, R> = (param: P) => Promise<R>;
+export type SseExecution<P, R, A> = (
+/** 请求入参 */
+params: P, 
+/** 请求上下文 */
+ctx: ServerContext<A>, 
+/**
+ * 操作函数
+ */
+operations: {
+    /**
+     * 向客户端推送消息
+     */
+    send: (event: string, message: string) => void;
+    /**
+     * 推送完毕回调
+     */
+    done: () => void;
+}) => Promise<R>;
+export type AnySseExecution = SseExecution<any, any, any>;
+export type SseHandlers = Record<string, AnySseExecution>;
+export declare function createSseAPI<P, R, A>(ParamsClass: Class<P>, execution: SseExecution<P, R, A>): API<P, R>;
+type StubParam<T> = T extends (params: infer P) => any ? P : never;
+export declare function implementSseAPI<F extends (params: any) => any, A = Record<string, any>>(_actionStub: F, ParamsClass: Class<StubParam<F>>, execution: SseExecution<StubParam<F>, ReturnType<F>, A>): API<StubParam<F>, ReturnType<F>>;
+export {};

package/dist/common/create-sse.js

@@ -0,0 +1,31 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.implementSseAPI = exports.createSseAPI = void 0;
+const class_transformer_1 = require("class-transformer");
+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, ctx, operations) => {
+        if (!params) {
+            throw new create_errors_1.CommonErrors.InvalidParameter.EmptyParameter();
+        }
+        // 校验参数
+        const paramsToCheck = params instanceof ParamsClass
+            ? params
+            : (0, class_transformer_1.plainToClass)(ParamsClass, params);
+        const errors = await (0, class_validator_1.validate)(paramsToCheck || {});
+        if (errors?.length) {
+            const errorMessages = errors.flatMap((error) => (0, create_api_1.getMessage)(error));
+            throw new create_errors_1.CommonErrors.InvalidParameter.ValidationError(errorMessages.join("\n"));
+        }
+        // 执行函数
+        return await execution(params, ctx, operations);
+    };
+    return runtime;
+}
+exports.createSseAPI = createSseAPI;
+function implementSseAPI(_actionStub, ParamsClass, execution) {
+    return createSseAPI(ParamsClass, execution);
+}
+exports.implementSseAPI = implementSseAPI;

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

@@ -1,25 +1,11 @@
 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>;
+import { SseHandlers } from "./create-sse";
 interface IPackSSEOptions {
     authFn?: AuthFunction;
     route?: string;
     log?: boolean;
 }
-export declare const packSSE: (sseHandlers: SSEHandlers, options?: IPackSSEOptions) => express.RequestHandler;
+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

@@ -12,8 +12,12 @@ const packSSE = (sseHandlers, options) => {
     ]));
     const { authFn, log = true, route = "/sse" } = options || {};
     return async (req, res, next) => {
+        const isValidRoute = route.startsWith("/");
+        if (!isValidRoute) {
+            throw new create_errors_1.CommonErrors.InvalidParameter.RouteError();
+        }
         const { path } = req;
-        // 路径不是SSE的路径
+        // SSE的路径直接往后走
         if (path !== route) {
             next();
             return;
@@ -66,18 +70,20 @@ const packSSE = (sseHandlers, options) => {
              * 统一管理请求头
              *
              */
-            // 处理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 });
+            await new Promise((resolve) => {
+                const send = (event, message) => {
+                    const response = (0, exports.createSSEMessage)(event, message);
+                    res.write(response);
+                    logger_1.logger.log("info", `发送消息：\n${response}`);
+                };
+                const done = () => resolve(true);
+                execution(params, ctx, { send, done });
+            });
             // 完成响应
             took = Date.now() - start;
             logger_1.logger.log("info", `耗时：${took} ms - RequestId: ${requestId}`);
@@ -106,7 +112,7 @@ const packSSE = (sseHandlers, options) => {
             }));
             // 完成响应
             took = Date.now() - start;
-            logger_1.logger.log("info", `响应：${response}`);
+            logger_1.logger.log("info", `发送消息：\n${response}`);
             logger_1.logger.log("info", `耗时：${took} ms - RequestId: ${requestId}`);
             res.write(response);
             return res.end();

package/package.json

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