mas-server 3.0.0 → 3.0.2

package/dist/index.js

@@ -1,9 +1,32 @@
 "use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
 var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.validType = exports.createToken = exports.validToken = exports.moment = exports.readApi = void 0;
+exports.getApiRouter = exports.validType = exports.createToken = exports.validToken = exports.moment = exports.readApi = void 0;
 exports.getApp = getApp;
 require("module-alias/register");
 const express_1 = __importDefault(require("express"));
@@ -25,7 +48,8 @@ Object.defineProperty(exports, "validToken", { enumerable: true, get: function (
 const validType_1 = __importDefault(require("./utils/validType"));
 exports.validType = validType_1.default;
 const createRouter_1 = __importDefault(require("./utils/createRouter"));
-const getRouterInfo_1 = __importDefault(require("./utils/getRouterInfo"));
+const getRouterInfo_1 = __importStar(require("./utils/getRouterInfo"));
+Object.defineProperty(exports, "getApiRouter", { enumerable: true, get: function () { return getRouterInfo_1.getApiRouter; } });
 const logs_1 = __importDefault(require("./utils/logs"));
 const apiLimit_1 = __importDefault(require("./utils/apiLimit"));
 // =================================================================
@@ -39,6 +63,7 @@ beforeMounted) {
     state_1.state.config = config;
     // new express
     const app = (0, express_1.default)();
+    beforeMounted && beforeMounted(app);
     // ip限制
     if ((_a = config.apiLimit) === null || _a === void 0 ? void 0 : _a.open) {
         (0, apiLimit_1.default)(app, config.apiLimit || {});

package/dist/utils/getRouterInfo.js

@@ -3,6 +3,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.getApiRouter = void 0;
 exports.default = getRouterInfo;
 const state_1 = require("../state");
 const readApi_1 = __importDefault(require("./readApi"));
@@ -27,3 +28,29 @@ function getRouterInfo(apiDir, defaullConfigDir) {
     state_1.state.Router = apiConfig;
     return apiConfig;
 }
+const getApiRouter = () => {
+    const router = JSON.stringify(state_1.state.Router, (key, value) => {
+        if (typeof value === "function") {
+            return value.toString().replace(/function\s+(\w+)\(\)\s+\{.*\}/, "$1");
+        }
+        return value;
+    });
+    const newRouter = JSON.parse(router);
+    // 有的描述没有类型，尝试从validFormat里取
+    for (const key in newRouter) {
+        const item = newRouter[key];
+        if (item.validFormat && item.validFormatDes) {
+            for (const validFormatDesItem of item.validFormatDes) {
+                if (!validFormatDesItem.type &&
+                    item.validFormat[validFormatDesItem.name]) {
+                    validFormatDesItem.type = item.validFormat[validFormatDesItem.name];
+                }
+                else if (!validFormatDesItem.type) {
+                    validFormatDesItem.type = "String";
+                }
+            }
+        }
+    }
+    return newRouter;
+};
+exports.getApiRouter = getApiRouter;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "mas-server",
-  "version": "3.0.0",
+  "version": "3.0.02",
   "description": "一款基于express面向中小型项目的后端框架",
   "main": "dist/index.js",
   "typings": "src/index.ts",

package/src/index.ts

@@ -21,7 +21,7 @@ moment.locale("zh-cn");
 import { createToken, validToken } from "./utils/meaToken";
 import validType from "./utils/validType";
 import createRouter from "./utils/createRouter";
-import getRouterInfo from "./utils/getRouterInfo";
+import getRouterInfo, { getApiRouter } from "./utils/getRouterInfo";
 import getLogs from "./utils/logs";
 import apiLimit from "./utils/apiLimit";
 
@@ -48,6 +48,7 @@ export function getApp(
   state.config = config;
   // new express
   const app = express();
+  beforeMounted && beforeMounted(app);
   // ip限制
   if (config.apiLimit?.open) {
     apiLimit(app, config.apiLimit || {});
@@ -92,5 +93,6 @@ export function getApp(
   }, config.debugTime || 1000);
   return app;
 }
-export { readApi, moment, validToken, createToken, validType };
+
+export { readApi, moment, validToken, createToken, validType, getApiRouter };
 export type { MasReq, MasRes, ApiConfigType, ConfigType, ApiConfigTypeItem };

package/src/utils/getRouterInfo.ts

@@ -7,7 +7,6 @@ export default function getRouterInfo(apiDir: string, defaullConfigDir) {
   const apiConfig = {};
   const routerDir = readFilesRecursively(apiDir, "api");
   const defaullConfig = require(defaullConfigDir).config;
-
   // 遍历api路由
   for (const item of routerDir) {
     const filePath = path.join(apiDir, "..", item) + ".ts";
@@ -22,3 +21,29 @@ export default function getRouterInfo(apiDir: string, defaullConfigDir) {
   state.Router = apiConfig;
   return apiConfig;
 }
+export const getApiRouter = () => {
+  const router = JSON.stringify(state.Router, (key, value) => {
+    if (typeof value === "function") {
+      return value.toString().replace(/function\s+(\w+)\(\)\s+\{.*\}/, "$1");
+    }
+    return value;
+  });
+  const newRouter = JSON.parse(router);
+  // 有的描述没有类型，尝试从validFormat里取
+  for (const key in newRouter) {
+    const item = newRouter[key];
+    if (item.validFormat && item.validFormatDes) {
+      for (const validFormatDesItem of item.validFormatDes) {
+        if (
+          !validFormatDesItem.type &&
+          item.validFormat[validFormatDesItem.name]
+        ) {
+          validFormatDesItem.type = item.validFormat[validFormatDesItem.name];
+        } else if (!validFormatDesItem.type) {
+          validFormatDesItem.type = "String";
+        }
+      }
+    }
+  }
+  return newRouter;
+};

package/src/utils/logs.ts

@@ -1,21 +1,21 @@
-import rateLimit from "express-rate-limit";
-import morgan from "morgan";
-import fs from "fs";
-import * as rfs from "rotating-file-stream";
-import moment from "moment-timezone";
-const getLogs = (app: any, dir: string) => {
-  // 创建一个日志目录（如果它不存在的话）
-  const logDirectory = dir;
-  fs.existsSync(logDirectory) || fs.mkdirSync(logDirectory);
-  // 创建一个循环日志流
-  const accessLogStream = rfs.createStream("access.log", {
-    size: "50M", // 单个文件的最大大小
-    interval: "1d", // 每天滚动日志
-    path: logDirectory,
-  });
-  morgan.token("date", (req, res, tz) => {
-    return moment().tz("Asia/Shanghai").format("YYYY-MM-DD HH:mm:ss");
-  });
-  app.use(morgan("combined", { stream: accessLogStream }));
-};
-export default getLogs;
+import rateLimit from "express-rate-limit";
+import morgan from "morgan";
+import fs from "fs";
+import * as rfs from "rotating-file-stream";
+import moment from "moment-timezone";
+const getLogs = (app: any, dir: string) => {
+  // 创建一个日志目录（如果它不存在的话）
+  const logDirectory = dir;
+  fs.existsSync(logDirectory) || fs.mkdirSync(logDirectory);
+  // 创建一个循环日志流
+  const accessLogStream = rfs.createStream("access.log", {
+    size: "50M", // 单个文件的最大大小
+    interval: "1d", // 每天滚动日志
+    path: logDirectory,
+  });
+  morgan.token("date", (req, res, tz) => {
+    return moment().tz("Asia/Shanghai").format("YYYY-MM-DD HH:mm:ss");
+  });
+  app.use(morgan("combined", { stream: accessLogStream }));
+};
+export default getLogs;

package/src/utils/printLog.ts

@@ -1,12 +1,12 @@
-import fs from "fs";
-import { state } from "../state";
-import moment from "moment";
-
-export default (req, res, next) => {
-  const date = moment().format("YYYY-MM-DD HH:mm:ss");
-  const data = `${date} ${req.method} ${req.ipInfo.ip} ${req.url} ${
-    req.body ? JSON.stringify(req.body) : ""
-  }\n`;
-  console.info(data);
-  next();
-};
+import fs from "fs";
+import { state } from "../state";
+import moment from "moment";
+
+export default (req, res, next) => {
+  const date = moment().format("YYYY-MM-DD HH:mm:ss");
+  const data = `${date} ${req.method} ${req.ipInfo.ip} ${req.url} ${
+    req.body ? JSON.stringify(req.body) : ""
+  }\n`;
+  console.info(data);
+  next();
+};

package/test/main.ts

@@ -12,6 +12,7 @@ const app = getApp(
   },
   (eapp) => {
     eapp.use((req, res: MasRes, next) => {
+      console.log(req.path, "加工之前的111");
       next();
     });
   }
@@ -25,5 +26,4 @@ app.all("*", (_req: MasReq, res: MasRes) => {
 });
 app.listen(8087, () => {
   console.log("http://localhost:8087");
-  console.log("http://localhost:8087/apidoc");
 });

package/test/src/apiDoc.ts

@@ -0,0 +1,33 @@
+// import type { Express } from "express";
+// import { MasReq, MasRes } from "@/index";
+// export default (app: Express) => {
+//   const router = JSON.stringify(state.Router, (key, value) => {
+//     if (typeof value === "function") {
+//       return value.toString().replace(/function\s+(\w+)\(\)\s+\{.*\}/, "$1");
+//     }
+//     return value;
+//   });
+//   const newRouter = JSON.parse(router);
+//   // 有的描述没有类型，尝试从validFormat里取
+//   for (const key in newRouter) {
+//     const item = newRouter[key];
+//     if (item.validFormat && item.validFormatDes) {
+//       for (const validFormatDesItem of item.validFormatDes) {
+//         if (
+//           !validFormatDesItem.type &&
+//           item.validFormat[validFormatDesItem.name]
+//         ) {
+//           validFormatDesItem.type = item.validFormat[validFormatDesItem.name];
+//         } else if (!validFormatDesItem.type) {
+//           validFormatDesItem.type = "String";
+//         }
+//       }
+//     }
+//   }
+//   app.post("/apidoc/router", (req: masReq, res: masRes) => {
+//     res.return(newRouter);
+//   });
+//   app.post("/apidoc/cn", (req: masReq, res: masRes) => {
+//     res.return(state.apiCN);
+//   });
+// };

package/test/src/debug.ts

@@ -1,4 +1,5 @@
 import validType from "@/utils/validType";
 import axios from "axios";
 import * as sqlform from "./sqlform.json";
-import { createToken } from "@/index";
+import { createToken, getApiRouter } from "@/index";
+// console.log(getApiRouter(), "路由信息");

package/tsconfig-build.json

@@ -1,20 +1,20 @@
-{
-  "$schema": "./tsconfigschema.json",
-  "compilerOptions": {
-    "strict": false,
-    "module": "commonjs",
-    "moduleResolution": "node",
-    "esModuleInterop": true,
-    "baseUrl": "./",
-    "rootDir": "src",
-    "outDir": "dist",
-    "paths": {
-      "@/*": ["src/*"],
-      "@@/*": ["./*"]
-    },
-    "target": "es6",
-    "lib": ["ES2021", "dom"],
-    "resolveJsonModule": true
-  },
-  "exclude": ["node_modules", "dist", "test", ".temp","beforebuild.js"]
-}
+{
+  "$schema": "./tsconfigschema.json",
+  "compilerOptions": {
+    "strict": false,
+    "module": "commonjs",
+    "moduleResolution": "node",
+    "esModuleInterop": true,
+    "baseUrl": "./",
+    "rootDir": "src",
+    "outDir": "dist",
+    "paths": {
+      "@/*": ["src/*"],
+      "@@/*": ["./*"]
+    },
+    "target": "es6",
+    "lib": ["ES2021", "dom"],
+    "resolveJsonModule": true
+  },
+  "exclude": ["node_modules", "dist", "test", ".temp","beforebuild.js"]
+}