kb-server 0.0.1-beta.6 → 0.0.1-beta.8

package/README.md

@@ -2,4 +2,13 @@
 
 快速创建一个 Node 服务
 
-快速创建API、标准错误码、Server、支持统一鉴权函数（API级别）
+快速创建 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

@@ -26,6 +26,7 @@ export interface APIErrorResponse {
 export type AuthFunction = (action: string, req: express.Request) => Promise<Record<string, any> | boolean> | boolean | Record<string, any>;
 interface IPackAPIOptions {
     authFn?: AuthFunction;
+    log?: boolean;
 }
 /**
  * API包装函数

package/dist/common/api-middleware.js

@@ -3,13 +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, options) => {
-    const { authFn } = options || {};
+    const { authFn, log = true } = options || {};
     return async (req, res) => {
         // 生成API映射
         const apiMap = new Map(Object.entries(apis).map(([action, execution]) => [action, execution]));
@@ -25,8 +26,9 @@ const packAPI = (apis, options) => {
         try {
             // API 解析
             const { Action, ...params } = req.body || {};
-            // temp
-            console.log(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();
@@ -61,11 +63,12 @@ const packAPI = (apis, options) => {
             };
             // 完成响应
             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();
             // 可控错误
@@ -87,7 +90,8 @@ const packAPI = (apis, options) => {
             };
             // 完成响应
             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/create-server.d.ts

@@ -1,6 +1,9 @@
 import { AuthFunction } from "./api-middleware";
 import { APIs } from "./create-api";
 export interface ICreateServerParams {
+    /**
+     * API列表
+     */
     apis: APIs;
     /**
      * 鉴权函数
@@ -8,6 +11,10 @@ export interface ICreateServerParams {
      * 可以通过返回布尔值来定义权限，也可以直接返回数据对象，数据对象会被传递到上下文 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, authFn } = 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, { authFn }));
+    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/package.json

@@ -1,6 +1,6 @@
 {
   "name": "kb-server",
-  "version": "0.0.1-beta.6",
+  "version": "0.0.1-beta.8",
   "description": "A fast server for Node.JS,made by express.",
   "main": "dist/index.js",
   "scripts": {
@@ -23,6 +23,7 @@
     "class-validator": "^0.14.1",
     "express": "^4.21.1",
     "is-plain-object": "^5.0.0",
+    "moment": "^2.30.1",
     "utility-types": "^3.11.0",
     "uuid": "^11.0.3"
   },