mas-server 2.0.46 → 2.0.51

package/dist/utils/validRouteData.js

@@ -16,7 +16,7 @@ exports.default = (req, res, next) => {
         if (routerObj.header && routerObj.header.length != 0) {
             const headerObj = {};
             routerObj.header.forEach((item) => {
-                headerObj[item.name] = item.type;
+                !item.optional && (headerObj[item.name] = item.type);
             });
             if (!(0, validType_1.default)(req.headers, headerObj)) {
                 return res.return("error headers format!", 0, 400);

package/dist/utils/validToken.js

@@ -9,7 +9,7 @@ exports.default = (req, res, next) => {
     if ((0, masUtils_1.getType)(r === null || r === void 0 ? void 0 : r.permission) == "array") {
         const token = req.headers[tokenConfig.headerParams];
         if (!token) {
-            return res.return("缺少重要参数", 0);
+            return res.return("缺少重要参数", 0, 400);
         }
         let vt = (0, __1.validToken)({ token, permission: r.permission }, tokenConfig.pwd);
         if (vt.status === 0) {

package/dist/utils/validType.js

@@ -82,20 +82,3 @@ function validType(obj, typeMapping, strict = false) {
         : validTypeObj(obj, typeMapping);
 }
 exports.default = validType;
-// let res = validType(
-//   { name: "2", arr: [1] },
-//   { name: String, arr: [Number] },
-//   true
-// [
-//   { name: "s", age: "" },
-//   { names: "s", age: "" },
-// ],
-// { name: "11", age: 1, obj: { a: "1", b: 1 } },
-// String,
-// Boolean,
-// { name: String, age: Number, obj: { a: String, b: Number } }
-// [{ name: String }]
-// );
-// console.log(res);
-// console.log(getType(null)); //"null"
-// console.log(getType(undefined)); //"undefined"

package/package.json

@@ -1,51 +1,50 @@
-{
-  "name": "mas-server",
-  "version": "2.0.46",
-  "description": "一款基于express面向中小型项目的后端框架",
-  "main": "dist/index.js",
-  "typings": "src/index.ts",
-  "scripts": {
-    "testdev": "npx ts-node-dev --transpile-only ./test/scripts/run.ts --respawn",
-    "test": "npx ts-node ./test/scripts/beforeCreated.ts -end && npx ts-node ./test/scripts/run.ts",
-    "testmon": "npx nodemon ./test/scripts/run.ts",
-    "testTS": "npx nodemon ./test/test.ts",
-    "createSql": "npx ts-node ./test/scripts/createSqlForm.ts",
-    "createApi": "npx ts-node ./test/scripts/createApiFile.ts",
-    "createApis": "npx ts-node ./test/scripts/createApis.ts",
-    "init": "npx nodemon ./test/scripts/beforeCreated.ts -end",
-    "gsft": "npx nodemon ./test/scripts/getSqlFormType.ts",
-    "build": "tsc",
-    "sync": "tsc && npm publish && cnpm sync mas-server && explorer \"https://npmmirror.com/package/mas-server\""
-  },
-  "keywords": [],
-  "author": "tingxi8087",
-  "license": "ISC",
-  "dependencies": {
-    "@types/express": "^4.17.17",
-    "ansi-colors": "^4.1.3",
-    "axios": "^1.3.6",
-    "cors": "^2.8.5",
-    "express": "^4.18.2",
-    "express-ip": "^1.0.4",
-    "fs-extra": "^11.1.1",
-    "glob": "^10.3.1",
-    "mas-encrypt": "^1.0.0",
-    "masmysql": "^2.0.53",
-    "module-alias": "^2.2.2",
-    "moment": "^2.29.4",
-    "mysql": "^2.18.1",
-    "nodemon": "^2.0.22",
-    "ts-node": "^10.9.1",
-    "ts-node-dev": "^2.0.0",
-    "typescript": "^5.0.4"
-  },
-  "_moduleAliases": {
-    "@": "src/",
-    "@@": "."
-  },
-  "devDependencies": {
-    "@types/cors": "^2.8.13",
-    "@types/express": "^4.17.17",
-    "@types/moment": "^2.13.0"
-  }
-}
+{
+  "name": "mas-server",
+  "version": "2.0.51",
+  "description": "一款基于express面向中小型项目的后端框架",
+  "main": "dist/index.js",
+  "typings": "src/index.ts",
+  "scripts": {
+    "testdev": "npx ts-node-dev --transpile-only ./test/scripts/run.ts --respawn",
+    "test": "npx ts-node ./test/scripts/beforeCreated.ts -end && npx ts-node ./test/scripts/run.ts",
+    "testmon": "npx nodemon ./test/scripts/run.ts",
+    "testTS": "npx nodemon ./test/test.ts",
+    "createSql": "npx ts-node ./test/scripts/createSqlForm.ts",
+    "createApi": "npx ts-node ./test/scripts/createApiFile.ts",
+    "createApis": "npx ts-node ./test/scripts/createApis.ts",
+    "init": "npx nodemon ./test/scripts/beforeCreated.ts -end",
+    "gsft": "npx nodemon ./test/scripts/getSqlFormType.ts",
+    "build": "tsc --project ./tsconfig-build.json",
+    "sync": "npm run build && node ./beforebuild.js && npm publish && cnpm sync mas-server && explorer \"https://npmmirror.com/package/mas-server\""
+  },
+  "keywords": [],
+  "author": "tingxi8087",
+  "license": "ISC",
+  "dependencies": {
+    "@types/express": "^4.17.17",
+    "ansi-colors": "^4.1.3",
+    "axios": "^1.3.6",
+    "cors": "^2.8.5",
+    "express": "^4.18.2",
+    "express-ip": "^1.0.4",
+    "fs-extra": "^11.1.1",
+    "glob": "^10.3.1",
+    "masmysql": "^2.0.53",
+    "module-alias": "^2.2.2",
+    "moment": "^2.29.4",
+    "mysql": "^2.18.1",
+    "nodemon": "^2.0.22",
+    "ts-node": "^10.9.1",
+    "ts-node-dev": "^2.0.0",
+    "typescript": "^5.0.4"
+  },
+  "_moduleAliases": {
+    "@": "src/",
+    "@@": "."
+  },
+  "devDependencies": {
+    "@types/cors": "^2.8.13",
+    "@types/express": "^4.17.17",
+    "@types/moment": "^2.13.0"
+  }
+}

package/src/index.ts

@@ -9,9 +9,15 @@ import getLog from "./utils/getLog";
 import quickSend from "./utils/quickSend";
 import readApi from "./utils/readApi";
 import validRouteData from "./utils/validRouteData";
-import getRouteByApiSrc from "./utils/getRouteByApiSrc";
+
 import validTokenUse from "./utils/validToken";
-import type { masReq, masRes, apiConfigType, configType } from "./typings";
+import type {
+  masReq,
+  masRes,
+  apiConfigType,
+  configType,
+  apiConfigTypeItem,
+} from "./typings";
 import c from "ansi-colors";
 import moment from "moment";
 import "moment/locale/zh-cn";
@@ -32,6 +38,8 @@ import type { createSqlFormType, sqlForm } from "masmysql";
 import apiDoc from "./utils/apiDoc";
 import { createToken, validToken } from "./utils/meaToken";
 import validType from "./utils/validType";
+import createRouter from "./utils/createRouter";
+import getRouterInfo from "./utils/getRouterInfo";
 
 // =================================================================
 export function getApp(
@@ -41,14 +49,15 @@ export function getApp(
   // 路径和配置放入state
   state.DIRNAME = DIRNAME;
   const config = require(path.join(DIRNAME, "/config/config.ts")).default;
-  const Router = require(path.join(DIRNAME, "/config/api.config.ts")).default;
-  const apiCN = require(path.join(DIRNAME, "/config/api.key.ts")).default;
+  // 获取路由信息
+  getRouterInfo(
+    path.join(state.DIRNAME, "src/api"),
+    path.join(state.DIRNAME, "config/defaultApiConfig.ts")
+  );
   state.config = config;
-  state.Router = Router;
-  state.apiCN = apiCN;
+  state.apiCN = [];
   // new express
   const app = express();
-
   // 是否允许跨域
   config.cors && app.use(cors());
   if (beforeMounted) {
@@ -57,7 +66,6 @@ export function getApp(
   // 初始化app
   app.use(express.urlencoded({ extended: true }));
   app.use(express.json());
-  // 自定义中间件来处理纯文本和JSON数据
   // 错误处理中间件
   app.use((err, req, res, next) => {
     if (err.type == "entity.parse.failed") {
@@ -83,20 +91,8 @@ export function getApp(
     app.use("/apidoc", express.static(path.join(__dirname, "/apiDoc")));
     apiDoc(app);
   }
-  // 遍历api路由
-  for (const item in Router) {
-    let isExist = fs.existsSync(path.join(DIRNAME, "src", item) + ".ts");
-    if (!isExist) {
-      console.info(c.red(`${item} not found`));
-      continue;
-    }
-    const apiFunc = require(path.join(DIRNAME, "src", item)).default;
-    if (!apiFunc) {
-      console.info(c.yellow(`${item} 没有导出函数，已跳过..`));
-    } else {
-      apiFunc && app[Router[item].methods](item, apiFunc);
-    }
-  }
+  // 创建路由
+  createRouter(app);
   // 运行debug
   setTimeout(() => {
     try {
@@ -110,7 +106,6 @@ export function getApp(
 }
 export {
   readApi,
-  getRouteByApiSrc,
   moment,
   sqlState,
   sqlEnd,
@@ -123,7 +118,7 @@ export {
   massql,
   validToken,
   createToken,
-  validType
+  validType,
 };
 export type {
   masReq,
@@ -132,4 +127,5 @@ export type {
   configType,
   createSqlFormType,
   sqlForm,
+  apiConfigTypeItem,
 };

package/src/typings/index.ts

@@ -14,13 +14,13 @@ export interface TypeMapping {
     | Array<TypeDescriptor | TypeMapping>;
 }
 
-type apiConfigTypeItem = {
+export type apiConfigTypeItem = {
   /** 接口名称 */
-  name: string;
+  name?: string;
   /** 接口描述 */
   des?: string;
   /** 接口请求方法 */
-  methods: "get" | "post" | "all";
+  methods?: "get" | "post" | "all";
   /** 请求头参数 */
   header?: {
     /** 参数名称 */
@@ -55,8 +55,8 @@ type apiConfigTypeItem = {
     | {
         /** 字段名称 */
         name: string;
-        /** 字段类型 */
-        type: TypeMapping | TypeDescriptor;
+        /** 字段类型，不填会尝试从validFormat里取 */
+        type?: TypeMapping | TypeDescriptor;
         /** 是否为空 */
         optional?: boolean;
         /** 字段描述 */

package/src/utils/apiDoc.ts

@@ -8,9 +8,25 @@ export default (app: Express) => {
     }
     return value;
   });
-  // console.log(state);
+  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(JSON.parse(router));
+    res.return(newRouter);
   });
   app.post("/apidoc/cn", (req: masReq, res: masRes) => {
     res.return(state.apiCN);

package/src/utils/createRouter.ts

@@ -0,0 +1,22 @@
+import { state } from "@/state";
+import getRouterInfo from "./getRouterInfo";
+import path from "path";
+import * as fs from "fs";
+import c from "ansi-colors";
+export default function createRouter(app) {
+  const { Router, DIRNAME } = state;
+  // 遍历api路由
+  for (const item in Router) {
+    let isExist = fs.existsSync(path.join(DIRNAME, "src", item) + ".ts");
+    if (!isExist) {
+      console.info(c.red(`${item} not found`));
+      continue;
+    }
+    const apiFunc = require(path.join(DIRNAME, "src", item)).default;
+    if (!apiFunc) {
+      console.info(c.yellow(`${item} 没有导出函数，已跳过..`));
+    } else {
+      apiFunc && app[Router[item].methods](item, apiFunc);
+    }
+  }
+}

package/src/utils/getRouterInfo.ts

@@ -0,0 +1,28 @@
+import { state } from "@/state";
+import readFilesRecursively from "./readApi";
+import path from "path";
+import fs from "fs";
+import c from "ansi-colors";
+export default function getRouterInfo(apiDir: string, defaullConfigDir) {
+  const apiConfig = {};
+  const { DIRNAME } = state;
+  const routerDir = readFilesRecursively(apiDir, "api");
+  const defaullConfig = require(defaullConfigDir).default;
+  // 遍历api路由
+  for (const item of routerDir) {
+    let isExist = fs.existsSync(path.join(DIRNAME, "src", item) + ".ts");
+    if (!isExist) {
+      console.info(c.red(`${item} not found`));
+      continue;
+    }
+    const apiItemConfig = require(path.join(DIRNAME, "src", item)).config;
+    apiConfig[item] = apiItemConfig || defaullConfig;
+    // if (!apiFunc) {
+    //   console.info(c.yellow(`${item} 没有导出函数，已跳过..`));
+    // } else {
+    //   apiFunc && app[Router[item].methods](item, apiFunc);
+    // }
+  }
+  state.Router = apiConfig;
+  return apiConfig;
+}

package/src/utils/readApi.ts

@@ -6,11 +6,9 @@ export default function readFilesRecursively(
   routerPrefix: string = ""
 ): string[] {
   const files: string[] = [];
-
   fs.readdirSync(folderPath).forEach((fileName) => {
     const filePath = path.join(folderPath, fileName);
     const stat = fs.statSync(filePath);
-
     if (stat.isDirectory()) {
       const directoryPrefix = routerPrefix
         ? `${routerPrefix}/${fileName}`

package/src/utils/validRouteData.ts

@@ -15,9 +15,8 @@ export default (req: masReq, res: masRes, next) => {
     if (routerObj.header && routerObj.header.length != 0) {
       const headerObj = {};
       routerObj.header.forEach((item) => {
-        headerObj[item.name] = item.type;
+        !item.optional && (headerObj[item.name] = item.type);
       });
-
       if (!validType(req.headers, headerObj)) {
         return res.return("error headers format!", 0, 400);
       }

package/src/utils/validToken.ts

@@ -8,7 +8,7 @@ export default (req: masReq, res: any, next) => {
   if (getType(r?.permission) == "array") {
     const token = req.headers[tokenConfig.headerParams];
     if (!token) {
-      return res.return("缺少重要参数", 0);
+      return res.return("缺少重要参数", 0, 400);
     }
     let vt = validToken({ token, permission: r.permission }, tokenConfig.pwd);
     if (vt.status === 0) {

package/src/utils/validType.ts

@@ -79,20 +79,3 @@ export default function validType(
     ? validTypeObjStrict(obj, typeMapping)
     : validTypeObj(obj, typeMapping);
 }
-// let res = validType(
-//   { name: "2", arr: [1] },
-//   { name: String, arr: [Number] },
-//   true
-// [
-//   { name: "s", age: "" },
-//   { names: "s", age: "" },
-// ],
-// { name: "11", age: 1, obj: { a: "1", b: 1 } },
-// String,
-// Boolean,
-// { name: String, age: Number, obj: { a: String, b: Number } }
-// [{ name: String }]
-// );
-// console.log(res);
-// console.log(getType(null)); //"null"
-// console.log(getType(undefined)); //"undefined"

package/test/apiTemplate/api.temp.ts

@@ -1,6 +1,11 @@
-import type { masReq, masRes } from "@/index";
-import masState from "../src/masState";
-const { sql } = masState;
+import type { apiConfigTypeItem, masReq, masRes } from "@/index";
+import masState from "@/masState";
+
+export const config: apiConfigTypeItem = {
+  name: "默认接口",
+  methods: "all",
+};
 export default async (req: masReq, res: masRes) => {
+  const { sql } = masState;
   res.return("hello mas-server!");
 };

package/test/config/config.ts

@@ -18,7 +18,7 @@ export default <configType>{
     headerParams: "token",
   },
   useSql: true,
-  debugTime: 1000,
+  debugTime: 100,
   sql: {
     host: "127.0.0.1",
     user: "root",

package/test/config/defaultApiConfig.ts

@@ -0,0 +1,7 @@
+import { apiConfigTypeItem } from "@/typings";
+
+const defaultApiConfig: apiConfigTypeItem = {
+  name: "新建接口",
+  methods: "all",
+};
+export default defaultApiConfig;

package/test/main.ts

@@ -22,4 +22,5 @@ app.all("*", (_req: masReq, res: masRes) => {
 });
 app.listen(8087, () => {
   console.log("http://localhost:8087");
+  console.log("http://localhost:8087/apidoc");
 });

package/test/scripts/beforeCreated.ts

@@ -1,49 +1,11 @@
 import "module-alias/register";
-import {
-  checkSqlKey,
-  getRouteByApiSrc,
-  sqlInit,
-  getsqlFormData,
-  massql,
-  sqlEnd,
-} from "@/index";
+import { checkSqlKey, sqlInit, getsqlFormData, massql, sqlEnd } from "@/index";
 import * as fs from "fs";
 import * as path from "path";
-import apiConfig from "../config/api.config";
-import apiKey from "../config/api.key";
 import config from "../config/config";
 import masState from "../src/masState";
 import c from "ansi-colors";
-const { newApiConfig, newApiConfigArr, isAdd, newApiKey } = getRouteByApiSrc(
-  path.join(__dirname, "../src/api"),
-  apiConfig,
-  apiKey
-);
-// 写入api.config.js和api.key.js
-if (isAdd) {
-  fs.writeFileSync(
-    path.join(__dirname, "../config/api.config.ts"),
-    `import { apiConfigType } from "@/index";
-     const apiConfig: apiConfigType = ${
-       // 构造器类型正则转译
-       JSON.stringify(newApiConfig, (key, value) => {
-         if (typeof value === "function") {
-           return value
-             .toString()
-             .replace(/function\s+(\w+)\(\)\s+\{.*\}/, "$1");
-         }
-         return value;
-       }).replace(/"String"|"Number"|"Boolean"/g, (match) =>
-         match.replace(/"/g, "")
-       )
-     };
-     export default apiConfig;`
-  );
-  fs.writeFileSync(
-    path.join(__dirname, "../config/api.key.ts"),
-    "export default " + JSON.stringify(newApiKey)
-  );
-}
+
 // 数据库初始化
 (async () => {
   // mysql初始化
@@ -57,7 +19,6 @@ if (isAdd) {
       masState.sql = new massql();
       console.info(c.greenBright("mysql数据库连接成功！"));
     }
-
     if (process.argv[2] == "-end") {
       await sqlEnd();
       console.info(c.greenBright("初始化成功！"));

package/test/scripts/createApiFile.ts

@@ -3,7 +3,6 @@ import c from "ansi-colors";
 import * as fs from "fs";
 const createApiFile = (DIRNAME, tempPath) => {
   let argv = process.argv.slice(2);
-  // console.log(argv);
   for (let dir of argv) {
     let dirname = dir;
     let dirpath: any = dir.split("/");

package/test/scripts/createApis.ts

@@ -16,7 +16,6 @@ import c from "ansi-colors";
 // 根据数据库生成对应type，自动注入数据效验
 (async () => {
   let argv = process.argv.slice(2);
-  console.log(argv);
   const formName = argv[0];
   const wPath = argv[1];
   // mysql初始化
@@ -57,53 +56,6 @@ import c from "ansi-colors";
       path.join(__dirname, "../src/api", wPath, `/${formName}/set.ts`),
       setStr
     );
-    const dir = `/api${argv[1]}/${formName}`;
-    const apiConfig = (await import("../config/api.config")).default;
-    // console.log(apiConfig);
-
-    // console.log(apiConfig[`${dir}/del`].name);
-    // return
-    apiConfig[`${dir}/get`] = {
-      name: "新建接口",
-      methods: "all",
-      des: "",
-      validFormat: null,
-    };
-    apiConfig[`${dir}/set`] = {
-      name: "新建接口",
-      methods: "all",
-      des: "",
-      validFormat: null,
-    };
-    apiConfig[`${dir}/del`] = {
-      name: "新建接口",
-      methods: "all",
-      des: "",
-      validFormat: null,
-    };
-    apiConfig[`${dir}/get`].name = "得到数据";
-    apiConfig[`${dir}/set`].name = "修改或添加数据";
-    apiConfig[`${dir}/del`].name = "删除数据";
-    apiConfig[`${dir}/del`].validFormat = { id: Number };
-    fs.writeFileSync(
-      path.join(__dirname, "../config/api.config.ts"),
-      `import { apiConfigType } from "@/index";
-       const apiConfig: apiConfigType = ${
-         // 构造器类型正则转译
-         JSON.stringify(apiConfig, (key, value) => {
-           if (typeof value === "function") {
-             return value
-               .toString()
-               .replace(/function\s+(\w+)\(\)\s+\{.*\}/, "$1");
-           }
-           return value;
-         }).replace(/"String"|"Number"|"Boolean"/g, (match) =>
-           match.replace(/"/g, "")
-         )
-       };
-       export default apiConfig;`
-    );
     await sqlEnd();
-    // console.info(c.greenBright("获取类型成功！"));
   }
 })();

package/test/scripts/getSqlFormType.ts

@@ -1,21 +1,10 @@
 import "module-alias/register";
-import {
-  checkSqlKey,
-  getRouteByApiSrc,
-  sqlInit,
-  getsqlFormData,
-  massql,
-  sqlEnd,
-  getsqlFormDataType,
-} from "@/index";
+import { checkSqlKey, sqlInit, sqlEnd, getsqlFormDataType } from "@/index";
 import * as fs from "fs";
 import * as path from "path";
-import apiConfig from "../config/api.config";
-import apiKey from "../config/api.key";
+
 import config from "../config/config";
-import masState from "../src/masState";
 import c from "ansi-colors";
-
 (async () => {
   // mysql初始化
   if (config.useSql) {

package/test/src/api/example/ArrValid.ts

@@ -0,0 +1,11 @@
+import type { apiConfigTypeItem, masReq, masRes } from "@/index";
+import masState from "@@/test/src/masState";
+export const config: apiConfigTypeItem = {
+  name: "效验数组",
+  methods: "post",
+  validFormat: [Number],
+};
+export default async (req: masReq, res: masRes) => {
+  console.log(req.body);
+  res.return(req.body);
+};

package/test/src/api/example/per.ts

@@ -0,0 +1,34 @@
+import {
+  createToken,
+  type apiConfigTypeItem,
+  type masReq,
+  type masRes,
+} from "@/index";
+export const config: apiConfigTypeItem = {
+  name: "权限测试接口",
+  methods: "post",
+  permission: ["admin"],
+};
+const token = createToken(
+  { data: "这是一条token里的信息", permission: ["admin"] },
+  "8087"
+);
+// 开启这行拿到token，然后请求头里加上token即可正常访问
+// console.log(token);
+export default async (req: masReq, res: masRes) => {
+  console.log(res.token);
+  res.return("你是超级管理员!");
+};
+
+// 也可以选择自己效验
+// import { createToken, validToken } from "@/index";
+// const token = createToken({
+//   time: 10,
+//   permission: ["admin", "www"],
+//   data: { a: 1, b: 2 },
+// });
+// setTimeout(() => {
+//   const tokenInfo = validToken({ token, permission: ["user", "admin"] });
+//   console.log(token);
+//   console.log(tokenInfo);
+// }, 1000);