kb-server 0.0.1-beta.1 → 0.0.1-beta.11

package/README.md

@@ -2,4 +2,13 @@
 
 快速创建一个 Node 服务
 
-快速创建API、标准错误码、Server
+快速创建 API、标准错误码、Server、支持统一鉴权函数（API 级别）
+
+```javascript
+import { createServer } from "kb-server";
+import * as apis from "./apis";
+
+(async () => {
+  return createServer({ apis });
+})().then((app) => app.listen(3000));
+```

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

@@ -1,5 +1,8 @@
 import express from "express";
-import { AnyAPIExecution } from "./create-api";
+import { APIs } from "./create-api";
+/**
+ * 正确响应
+ */
 export interface APIResponse {
     Response: {
         Data: {
@@ -8,6 +11,9 @@ export interface APIResponse {
         RequestId: string;
     };
 }
+/**
+ * 错误响应
+ */
 export interface APIErrorResponse {
     Response: {
         Error: {
@@ -17,9 +23,15 @@ export interface APIErrorResponse {
         RequestId: string;
     };
 }
+export type AuthFunction = (action: string, req: express.Request) => Promise<Record<string, any> | boolean> | boolean | Record<string, any>;
+interface IPackAPIOptions {
+    authFn?: AuthFunction;
+    log?: boolean;
+}
 /**
  * API包装函数
  * @param apis API列表
  * @returns
  */
-export declare const packAPI: (apis: Record<string, AnyAPIExecution>) => (req: express.Request, res: express.Response) => Promise<express.Response<any, Record<string, any>>>;
+export declare const packAPI: (apis: APIs, options?: IPackAPIOptions) => (req: express.Request, res: express.Response) => Promise<express.Response<any, Record<string, any>>>;
+export {};

package/dist/common/api-middleware.js

@@ -3,12 +3,14 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.packAPI = void 0;
 const create_errors_1 = require("./create-errors");
 const uuid_1 = require("uuid");
+const logger_1 = require("../helper/logger");
 /**
  * API包装函数
  * @param apis API列表
  * @returns
  */
-const packAPI = (apis) => {
+const packAPI = (apis, options) => {
+    const { authFn, log = true } = options || {};
     return async (req, res) => {
         // 生成API映射
         const apiMap = new Map(Object.entries(apis).map(([action, execution]) => [action, execution]));
@@ -22,13 +24,29 @@ const packAPI = (apis) => {
             RequestId: requestId,
         };
         try {
-            console.log(req.body);
             // 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 = apiMap.get(Action);
             if (typeof execution !== "function") {
@@ -45,11 +63,12 @@ const packAPI = (apis) => {
             };
             // 完成响应
             took = Date.now() - start;
-            console.log("响应：", took, JSON.stringify(response));
+            logger_1.logger.log("info", response);
+            logger_1.logger.log("info", `耗时：${took} ms - RequestId: ${requestId}`);
             return res.send(response);
         }
         catch (rawError) {
-            console.log("原始错误：", rawError);
+            logger_1.logger.log("error", rawError);
             // 未知错误
             let error = new create_errors_1.CommonErrors.InternalError.UnknownError();
             // 可控错误
@@ -71,7 +90,8 @@ const packAPI = (apis) => {
             };
             // 完成响应
             took = Date.now() - start;
-            console.log("响应：", took, JSON.stringify(response));
+            logger_1.logger.log("info", response);
+            logger_1.logger.log("info", `耗时：${took} ms - RequestId: ${requestId}`);
             return res.send(response);
         }
     };

package/dist/common/call-service.d.ts

@@ -0,0 +1 @@
+export declare const callService: <P = Record<string, any>, R = any>(endpoint: string, body: P) => Promise<R>;

package/dist/common/call-service.js

@@ -0,0 +1,27 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.callService = void 0;
+const node_fetch_1 = __importDefault(require("node-fetch"));
+const create_errors_1 = require("./create-errors");
+const callService = async (endpoint, body) => {
+    const response = await (0, node_fetch_1.default)(endpoint, {
+        headers: {
+            "Content-Type": "application/json",
+        },
+        method: "POST",
+        body: JSON.stringify(body),
+    });
+    const result = await response.json();
+    if (result?.Response?.Error) {
+        const errMsg = result.Response.Error?.Message;
+        if (errMsg) {
+            throw new create_errors_1.CommonErrors.InternalError.ServiceError(errMsg);
+        }
+        throw new create_errors_1.CommonErrors.InternalError.ServiceError();
+    }
+    return result?.Response?.Data;
+};
+exports.callService = callService;

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

@@ -2,12 +2,17 @@ import { Class } from "utility-types";
 export interface ServerContext {
     /** 被调用方的 RequestId */
     RequestId: string;
-    /** 用户ID */
-    UserId?: number;
+    /** 权限信息 */
+    AuthInfo?: Record<string, any>;
 }
 export type API<P, R> = (param: P) => Promise<R>;
-export type APIExecution<P, R> = (params: P, ctx: ServerContext) => Promise<R>;
+export type APIExecution<P, R> = (
+/** 请求入参 */
+params: P, 
+/** 请求上下文 */
+ctx: ServerContext) => Promise<R>;
 export type AnyAPIExecution = APIExecution<any, any>;
+export type APIs = Record<string, AnyAPIExecution>;
 export declare function createAPI<P, R>(ParamsClass: Class<P>, execution: APIExecution<P, R>): API<P, R>;
 type StubParam<T> = T extends (params: infer P) => any ? P : never;
 export declare function implementAPI<A extends (params: any) => any>(_actionStub: A, ParamsClass: Class<StubParam<A>>, execution: APIExecution<StubParam<A>, ReturnType<A>>): API<StubParam<A>, ReturnType<A>>;

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

@@ -24,6 +24,7 @@ declare const CommonErrorsMap: {
     };
     readonly ResourceNotFound: {
         readonly APINotFound: "不存在的API";
+        readonly AuthFunctionNotFound: "鉴权函数不存在";
     };
     readonly FailOperation: {
         readonly NoPermission: "无权操作";
@@ -79,6 +80,7 @@ declare function createErrorsClasses<T extends MessageMap = MessageMap>(messageM
     };
     readonly ResourceNotFound: {
         readonly APINotFound: "不存在的API";
+        readonly AuthFunctionNotFound: "鉴权函数不存在";
     };
     readonly FailOperation: {
         readonly NoPermission: "无权操作";
@@ -103,6 +105,7 @@ export declare const CommonErrors: ErrorClasses<MergeMessageMap<{
     };
     readonly ResourceNotFound: {
         readonly APINotFound: "不存在的API";
+        readonly AuthFunctionNotFound: "鉴权函数不存在";
     };
     readonly FailOperation: {
         readonly NoPermission: "无权操作";

package/dist/common/create-errors.js

@@ -26,6 +26,7 @@ const CommonErrorsMap = {
     },
     ResourceNotFound: {
         APINotFound: "不存在的API",
+        AuthFunctionNotFound: "鉴权函数不存在",
     },
     FailOperation: {
         NoPermission: "无权操作",

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

@@ -1,6 +1,20 @@
-import { AnyAPIExecution } from "./create-api";
+import { AuthFunction } from "./api-middleware";
+import { APIs } from "./create-api";
 export interface ICreateServerParams {
-    apis: Record<string, AnyAPIExecution>;
+    /**
+     * API列表
+     */
+    apis: APIs;
+    /**
+     * 鉴权函数
+     *
+     * 可以通过返回布尔值来定义权限，也可以直接返回数据对象，数据对象会被传递到上下文 ctx 中（AuthInfo）
+     */
+    authFn?: AuthFunction;
+    /**
+     * 默认请求日志，true开启，false关闭
+     */
+    log?: boolean;
 }
 export interface ICreateServerOptions {
     limit?: string | number | undefined;

package/dist/common/create-server.js

@@ -30,14 +30,14 @@ const api_middleware_1 = require("./api-middleware");
  * 创建 Server
  */
 function createServer(params, options) {
-    const { apis } = params || {};
+    const { apis, authFn, log } = params || {};
     const { limit = "10mb" } = options || {};
     const app = (0, express_1.default)();
     // POST 参数获取
     app.use((0, express_1.urlencoded)({ extended: true, limit }));
     app.use((0, express_1.json)({ limit }));
     // 注入API
-    app.use((0, api_middleware_1.packAPI)(apis));
+    app.use((0, api_middleware_1.packAPI)(apis, { authFn, log }));
     return app;
 }
 exports.createServer = createServer;

package/dist/helper/logger.d.ts

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

package/dist/helper/logger.js

@@ -0,0 +1,17 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": 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:ss:mm`);
+    if (typeof message === "object") {
+        console.log(`[${level}] - [${logTime}] - ${JSON.stringify(message)}`);
+    }
+    else {
+        console.log(`[${level}] - [${logTime}] - ${message}`);
+    }
+}

package/dist/index.d.ts

@@ -1,3 +1,4 @@
 export { createServer } from "./common/create-server";
-export { createErrors, CommonErrors } from "./common/create-errors";
+export { createErrors } from "./common/create-errors";
 export { implementAPI } from "./common/create-api";
+export { callService } from "./common/call-service";

package/dist/index.js

@@ -1,10 +1,11 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.implementAPI = exports.CommonErrors = exports.createErrors = exports.createServer = void 0;
+exports.callService = exports.implementAPI = exports.createErrors = exports.createServer = void 0;
 var create_server_1 = require("./common/create-server");
 Object.defineProperty(exports, "createServer", { enumerable: true, get: function () { return create_server_1.createServer; } });
 var create_errors_1 = require("./common/create-errors");
 Object.defineProperty(exports, "createErrors", { enumerable: true, get: function () { return create_errors_1.createErrors; } });
-Object.defineProperty(exports, "CommonErrors", { enumerable: true, get: function () { return create_errors_1.CommonErrors; } });
 var create_api_1 = require("./common/create-api");
 Object.defineProperty(exports, "implementAPI", { enumerable: true, get: function () { return create_api_1.implementAPI; } });
+var call_service_1 = require("./common/call-service");
+Object.defineProperty(exports, "callService", { enumerable: true, get: function () { return call_service_1.callService; } });

package/package.json

@@ -1,10 +1,10 @@
 {
   "name": "kb-server",
-  "version": "0.0.1-beta.1",
+  "version": "0.0.1-beta.11",
   "description": "A fast server for Node.JS,made by express.",
   "main": "dist/index.js",
   "scripts": {
-    "build": "tsc",
+    "build": "rm -rf ./dist && tsc",
     "test": "echo \"Error: no test specified\" && exit 1"
   },
   "keywords": [
@@ -23,10 +23,13 @@
     "class-validator": "^0.14.1",
     "express": "^4.21.1",
     "is-plain-object": "^5.0.0",
+    "moment": "^2.30.1",
+    "node-fetch": "^2.7.0",
     "utility-types": "^3.11.0",
     "uuid": "^11.0.3"
   },
   "devDependencies": {
-    "@types/express": "^4.17.21"
+    "@types/express": "^4.17.21",
+    "@types/node-fetch": "^2.6.12"
   }
 }