mas-server 2.0.64 → 3.0.0

package/src/typings/index.ts

@@ -1,124 +1,106 @@
-import type { Request, Response } from "express";
-
-type BasicTypeDescriptor =
-  | StringConstructor
-  | NumberConstructor
-  | BooleanConstructor
-  | ObjectConstructor;
-export type TypeDescriptor = BasicTypeDescriptor | Array<any>;
-
-export interface TypeMapping {
-  [key: string]:
-    | TypeDescriptor
-    | TypeMapping
-    | Array<TypeDescriptor | TypeMapping>;
-}
-
-export type apiConfigTypeItem = {
-  /** 接口名称 */
-  name?: string;
-  /** 接口描述 */
-  des?: string;
-  /** 接口请求方法 */
-  methods?: "get" | "post" | "all";
-  /** 请求头参数 */
-  header?: {
-    /** 参数名称 */
-    name: string;
-    /** 是否为空 */
-    optional?: boolean;
-    /** 请求头描述 */
-    des?: string;
-    /** 参数类型 */
-    type: TypeDescriptor;
-  }[];
-  /** 是否启用token，默认关闭 */
-  token?: boolean;
-  /** 允许放行的权限，在启用token的情况下才有效 */
-  permission?: string[];
-  /** 请求类型 */
-  "Content-Type"?:
-    | "multipart/form-data"
-    | "application/json"
-    | "application/x-www-form-urlencoded";
-  /** 请求示例 */
-  example?: any;
-  /** 响应示例 */
-  resExample?: any;
-  /** 效验数据格式 */
-  validFormat?: TypeMapping | TypeDescriptor;
-  /** 效验数据严格模式，默认不开启 */
-  validFormatStrict?: boolean;
-  /** 效验数据格式描述 */
-  validFormatDes?:
-    | string[]
-    | {
-        /** 字段名称 */
-        name: string;
-        /** 字段类型，不填会尝试从validFormat里取 */
-        type?: TypeMapping | TypeDescriptor;
-        /** 是否为空 */
-        optional?: boolean;
-        /** 字段描述 */
-        des?: string;
-      }[];
-};
-export type masRes = Response & {
-  /** 响应数据 */
-  return: (data: any, status?: any, code?: number, msg?: string) => void;
-  token?: { data: any; _permission: string[] };
-};
-export type masReq = Request & {
-  body: any;
-};
-export type configType = {
-  /** 项目名称 */
-  projectName: string;
-  /** 端口号 */
-  port: number;
-  /** 是否开启接口文档 */
-  apidoc: boolean;
-  /** 接口文档配置 */
-  apidocOptions?: {
-    /** 默认留空即可 */
-    baseUrl: "";
-  };
-  /** 是否允许跨域 */
-  cors: boolean;
-  logs: {
-    /** 是否保存日志 */
-    open: boolean;
-    /** 是否打印访问日志 */
-    debug: boolean;
-  };
-  /** ip请求限制 */
-  apiLimit: {
-    /** 是否开启 */
-    open?: boolean;
-    /** 同个 ip windowMs ms之内 */
-    windowMs?: number;
-    /** 最多max个请求 */
-    max?: number; //
-  };
-  token: {
-    /** 是否使用token */
-    open: boolean;
-    /** token秘钥 */
-    pwd: string;
-    /** 参数名 */
-    headerParams: string;
-  };
-  /** debug延时时间 */
-  debugTime?: number;
-  /** 是否使用数据库 */
-  useSql: boolean;
-  /** 数据库信息 */
-  sql: {
-    host: string;
-    user: string;
-    password: string;
-    database: string;
-  };
-};
-export type apiCallback = Promise<(req: masReq, res: masRes) => void>;
-export type apiConfigType = { [key: string]: apiConfigTypeItem };
+import type { Request, Response } from "express";
+
+type BasicTypeDescriptor =
+  | StringConstructor
+  | NumberConstructor
+  | BooleanConstructor
+  | ObjectConstructor;
+export type TypeDescriptor = BasicTypeDescriptor | Array<any>;
+
+export interface TypeMapping {
+  [key: string]:
+    | TypeDescriptor
+    | TypeMapping
+    | Array<TypeDescriptor | TypeMapping>;
+}
+
+export type ApiConfigTypeItem = {
+  /** 接口名称 */
+  name?: string;
+  /** 接口描述 */
+  des?: string;
+  /** 接口请求方法 */
+  methods?: "get" | "post" | "all";
+  /** 请求头参数 */
+  header?: {
+    /** 参数名称 */
+    name: string;
+    /** 是否为空 */
+    optional?: boolean;
+    /** 请求头描述 */
+    des?: string;
+    /** 参数类型 */
+    type: TypeDescriptor;
+  }[];
+  /** 是否启用token，默认关闭 */
+  token?: boolean;
+  /** 允许放行的权限，在启用token的情况下才有效 */
+  permission?: string[];
+  /** 请求类型 */
+  "Content-Type"?:
+    | "multipart/form-data"
+    | "application/json"
+    | "application/x-www-form-urlencoded";
+  /** 请求示例 */
+  example?: any;
+  /** 响应示例 */
+  resExample?: any;
+  /** 效验数据格式 */
+  validFormat?: TypeMapping | TypeDescriptor;
+  /** 效验数据严格模式，默认不开启 */
+  validFormatStrict?: boolean;
+  /** 效验数据格式描述 */
+  validFormatDes?:
+    | string[]
+    | {
+        /** 字段名称 */
+        name: string;
+        /** 字段类型，不填会尝试从validFormat里取 */
+        type?: TypeMapping | TypeDescriptor;
+        /** 是否为空 */
+        optional?: boolean;
+        /** 字段描述 */
+        des?: string;
+      }[];
+};
+export type MasRes = Response & {
+  /** 响应数据 */
+  return: (data: any, status?: any, code?: number, msg?: string) => void;
+  token?: { data: any; _permission: string[] };
+};
+export type MasReq = Request & {
+  body: any;
+};
+export type ConfigType = {
+  /** 项目名称 */
+  projectName: string;
+  /** 端口号 */
+  port: number;
+  logs: {
+    /** 是否保存日志 */
+    open: boolean;
+    /** 是否打印访问日志 */
+    debug: boolean;
+  };
+  /** ip请求限制 */
+  apiLimit: {
+    /** 是否开启 */
+    open?: boolean;
+    /** 同个 ip windowMs ms之内 */
+    windowMs?: number;
+    /** 最多max个请求 */
+    max?: number; //
+  };
+  token: {
+    /** 是否使用token */
+    open: boolean;
+    /** token秘钥 */
+    pwd: string;
+    /** 参数名 */
+    headerParams: string;
+  };
+  /** debug延时时间 */
+  debugTime?: number;
+};
+export type ApiCallback = Promise<(req: MasReq, res: MasRes) => void>;
+export type ApiConfigType = { [key: string]: ApiConfigTypeItem };

package/src/utils/apiLimit.ts

@@ -5,7 +5,7 @@ const apiLimit = (app: any, config?: { windowMs: number; max: number }) => {
     windowMs: config?.windowMs || 60 * 1000, // 1分钟
     max: config?.max || 20, // 最多10个请求
     // 当达到限制时调用的处理函数
-    handler: function (req, res) {
+    handler: function (req, res: any) {
       res.status(502).end();
     },
   });

package/src/utils/createRouter.ts

@@ -1,18 +1,18 @@
 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;
+export default function createRouter(app, apiDir: string) {
+  const { Router } = state;
   // 遍历api路由
   for (const item in Router) {
-    let isExist = fs.existsSync(path.join(DIRNAME, "src", item) + ".ts");
+    const filePath = path.join(apiDir, "..", item) + ".ts";
+    let isExist = fs.existsSync(filePath);
     if (!isExist) {
       console.info(c.red(`${item} not found`));
       continue;
     }
-    const apiFunc = require(path.join(DIRNAME, "src", item)).default;
+    const apiFunc = require(filePath).default;
     if (!apiFunc) {
       console.info(c.yellow(`${item} 没有导出函数，已跳过..`));
     } else {

package/src/utils/getRouterInfo.ts

@@ -5,23 +5,19 @@ 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;
+  const defaullConfig = require(defaullConfigDir).config;
+
   // 遍历api路由
   for (const item of routerDir) {
-    let isExist = fs.existsSync(path.join(DIRNAME, "src", item) + ".ts");
+    const filePath = path.join(apiDir, "..", item) + ".ts";
+    let isExist = fs.existsSync(filePath);
     if (!isExist) {
       console.info(c.red(`${item} not found`));
       continue;
     }
-    const apiItemConfig = require(path.join(DIRNAME, "src", item)).config;
+    const apiItemConfig = require(filePath).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/masUtils.ts

@@ -1,5 +1,4 @@
 export function getType(obj): string {
-  // "".toLocaleLowerCase
   return Object.prototype.toString
     .call(obj)
     .slice(8)

package/src/utils/meaToken.ts

@@ -1,56 +1,56 @@
-const { decode, isJSON, encode } = require("./mas-encrypt.min.js");
-const getTimestamp = () => new Date().getTime();
-/**
- *
- * @param param0 token:解密的token,permission:效验的权限，只要有其中一个就可
- * @param key 解密密钥
- * @returns
- */
-const validToken = ({ token, permission = [] }, key = "8087") => {
-  if (!token)
-    return { msg: "没有传入token数据", errorCode: 0, status: 0, token };
-  token = decode(token, key);
-  if (!token) return { msg: "token数据错误", errorCode: 1, status: 0, token };
-  // 鉴权
-  if (permission.length != 0) {
-    const tPermission = token._permission;
-    if (!tPermission) {
-      return { msg: "权限错误", errorCode: 2, status: 0, token };
-    }
-    if (tPermission.filter((value) => permission.includes(value)).length == 0) {
-      return { msg: "权限错误", errorCode: 2, status: 0, token };
-    }
-  }
-  // 过期时间
-  if (token._masTime !== 0) {
-    if (getTimestamp() > token._masTime)
-      return { msg: "token过期", errorCode: 3, status: 0, token };
-  }
-
-  return { ...token, status: 1 };
-};
-const getErrorInfo = () => {
-  return [
-    { msg: "没有传入token数据", errorCode: 0, status: 0 },
-    { msg: "token数据错误", errorCode: 1, status: 0 },
-    { msg: "权限错误", errorCode: 2, status: 0 },
-    { msg: "token过期", errorCode: 3, status: 0 },
-  ];
-};
-/**
- *
- * @param param0 data:加密的数据,time:过期时间/s(为零则不会过期),permission:权限设置
- * @param key 加密密钥
- * @returns
- */
-function createToken(
-  { data = null, time = 0, permission = [] } = {},
-  key = "8087"
-) {
-  const token: any = {};
-  token.data = data;
-  permission.length != 0 && (token._permission = permission);
-  time !== 0 && (token._masTime = time * 1000 + getTimestamp());
-  return encode(token, key);
-}
-export { validToken, createToken };
+const { decode, isJSON, encode } = require("./mas-encrypt.min.js");
+const getTimestamp = () => new Date().getTime();
+/**
+ *
+ * @param param0 token:解密的token,permission:效验的权限，只要有其中一个就可
+ * @param key 解密密钥
+ * @returns
+ */
+const validToken = ({ token, permission = [] }, key = "8087") => {
+  if (!token)
+    return { msg: "没有传入token数据", errorCode: 0, status: 0, token };
+  token = decode(token, key);
+  if (!token) return { msg: "token数据错误", errorCode: 1, status: 0, token };
+  // 鉴权
+  if (permission.length != 0) {
+    const tPermission = token._permission;
+    if (!tPermission) {
+      return { msg: "权限错误", errorCode: 2, status: 0, token };
+    }
+    if (tPermission.filter((value) => permission.includes(value)).length == 0) {
+      return { msg: "权限错误", errorCode: 2, status: 0, token };
+    }
+  }
+  // 过期时间
+  if (token._masTime !== 0) {
+    if (getTimestamp() > token._masTime)
+      return { msg: "token过期", errorCode: 3, status: 0, token };
+  }
+
+  return { ...token, status: 1 };
+};
+const getErrorInfo = () => {
+  return [
+    { msg: "没有传入token数据", errorCode: 0, status: 0 },
+    { msg: "token数据错误", errorCode: 1, status: 0 },
+    { msg: "权限错误", errorCode: 2, status: 0 },
+    { msg: "token过期", errorCode: 3, status: 0 },
+  ];
+};
+/**
+ *
+ * @param param0 data:加密的数据,time:过期时间/s(为零则不会过期),permission:权限设置
+ * @param key 加密密钥
+ * @returns
+ */
+function createToken(
+  { data = null, time = 0, permission = [] } = {},
+  key = "8087"
+) {
+  const token: any = {};
+  token.data = data;
+  permission.length != 0 && (token._permission = permission);
+  time !== 0 && (token._masTime = time * 1000 + getTimestamp());
+  return encode(token, key);
+}
+export { validToken, createToken };

package/src/utils/validRouteData.ts

@@ -1,8 +1,8 @@
-import { apiConfigType, masReq, masRes } from "..";
+import { ApiConfigType, MasReq, MasRes } from "../typings/index";
 import { state } from "../state";
 import validType from "./validType";
-export default (req: masReq, res: masRes, next) => {
-  const Router: apiConfigType = state.Router;
+export default (req: any, res: MasRes, next) => {
+  const Router: ApiConfigType = state.Router;
   const routerObj = Router[req.path];
 
   if (routerObj) {

package/src/utils/validToken.ts

@@ -1,8 +1,8 @@
 import { state } from "../state";
-import { masReq, masRes, validToken } from "..";
+import { MasReq, MasRes, validToken } from "..";
 import { getType } from "./masUtils";
 
-export default (req: masReq, res: any, next) => {
+export default (req: any, res: any, next) => {
   const r = state.Router[req.path];
   const tokenConfig = state.config.token;
   if (getType(r?.permission) == "array") {

package/test/apiTemplate/curd/del.ts

@@ -1,8 +1,8 @@
-import type { masReq, masRes } from "@/index";
+import type { MasReq, MasRes } from "@/index";
 import masState from "@@/test/src/masState";
 import sqlform from "@@/test/src/sqlform.json";
 
-export default async (req: masReq, res: masRes) => {
+export default async (req: MasReq, res: MasRes) => {
   const { sql } = masState;
   const sqlRes = await sql.use(sqlform.$form).delete(req.body).go();
   res.return(sqlRes);

package/test/apiTemplate/curd/get.ts

@@ -1,8 +1,8 @@
-import type { masReq, masRes } from "@/index";
+import type { MasReq, MasRes } from "@/index";
 import masState from "@@/test/src/masState";
 import sqlform from "@@/test/src/sqlform.json";
 
-export default async (req: masReq, res: masRes) => {
+export default async (req: MasReq, res: MasRes) => {
   const { sql } = masState;
   const sqlRes = await sql.use(sqlform.$form).select(req.body).paging().go();
   res.return(sqlRes);

package/test/apiTemplate/curd/set.ts

@@ -1,8 +1,8 @@
-import type { masReq, masRes } from "@/index";
+import type { MasReq, MasRes } from "@/index";
 import masState from "@@/test/src/masState";
 import sqlform from "@@/test/src/sqlform.json";
 
-export default async (req: masReq, res: masRes) => {
+export default async (req: MasReq, res: MasRes) => {
   const { sql } = masState;
   const sqlRes = await sql.use(sqlform.$form).set(req.body).go();
   res.return(sqlRes, sqlRes);

package/test/apiTemplate/defaultApi.ts

@@ -0,0 +1,8 @@
+import type { ApiConfigTypeItem, MasReq, MasRes } from "@/index";
+export const config: ApiConfigTypeItem = {
+  name: "默认接口",
+  methods: "all",
+};
+export default async (req: MasReq, res: MasRes) => {
+  res.return("hello mas-server!");
+};

package/test/config/serverConfig/config.ts

@@ -0,0 +1,29 @@
+import { ConfigType } from "@/index";
+export default <ConfigType>{
+  projectName: "mas-server",
+  port: 8087,
+  logs: {
+    open: true,
+    debug: false,
+  },
+  apiLimit: {
+    open: true,
+    windowMs: 60 * 1000,
+    max: 1000,
+  },
+  token: {
+    open: true,
+    pwd: "8087",
+    headerParams: "token",
+  },
+  debugTime: 100,
+  // useSql: false,
+  // sql: {
+  //   host: "127.0.0.1",
+  //   user: "root",
+  //   password: "123456",
+  //   database: "school",
+  //   // database: "test",
+  //   // password: "tx123456",
+  // },
+};

package/test/config/{createSqlFormData.ts → sqlConfig/createSqlFormData.ts}

@@ -1,5 +1,4 @@
-import { createSqlFormType } from "@/index";
-const createSqlFormData: createSqlFormType = {
+const createSqlFormData = {
   testForm: [
     {
       key: "testA",

package/test/main.ts

@@ -1,23 +1,26 @@
 import "module-alias/register";
-import { getApp, masReq, masRes } from "@/index";
-import masState from "./src/masState";
-import config from "./config/config";
-
-const app = getApp(__dirname, (app) => {
-  // 数据库连接和express服务启动是异步进行的，如果数据库连接较慢，可能会出现调用接口访问不了数据库的情况
-  app.use((req, res: masRes, next) => {
-    if (config.useSql && !masState.sql) {
-      res.return("数据库正在连接！", 0, 500);
-    } else {
+import { getApp, MasReq, MasRes } from "@/index";
+import path from "path";
+import config from "./config/serverConfig/config";
+const app = getApp(
+  {
+    configPath: path.join(__dirname, "./config/serverConfig/config.ts"),
+    apisPath: path.join(__dirname, "./src/api/"),
+    defalutApiPath: path.join(__dirname, "./apiTemplate/defaultApi.ts"),
+    logPath: path.join(__dirname, "./logs"),
+    degbugPath: path.join(__dirname, "./src//debug.ts"),
+  },
+  (eapp) => {
+    eapp.use((req, res: MasRes, next) => {
       next();
-    }
-  });
-});
-app.all("/", (_req, res: masRes) => {
-  res.return("default index");
-});
+    });
+  }
+);
+// app.all("/", (_req, res: MasRes) => {
+//   res.return("default index");
+// });
 // 404兜底
-app.all("*", (_req: masReq, res: masRes) => {
+app.all("*", (_req: MasReq, res: MasRes) => {
   res.return(404, 0, 404);
 });
 app.listen(8087, () => {

package/test/scripts/beforeCreated.ts

@@ -1,28 +1,28 @@
-import "module-alias/register";
-import { checkSqlKey, sqlInit, getsqlFormData, massql, sqlEnd } from "@/index";
-import * as fs from "fs";
-import * as path from "path";
-import config from "../config/config";
-import masState from "../src/masState";
-import c from "ansi-colors";
+// import "module-alias/register";
+// import { checkSqlKey, sqlInit, getsqlFormData, massql, sqlEnd } from "@/index";
+// import * as fs from "fs";
+// import * as path from "path";
+// import config from "../config/config";
+// import masState from "../src/masState";
+// import c from "ansi-colors";
 
-// 数据库初始化
-(async () => {
-  // mysql初始化
-  if (config.useSql) {
-    await sqlInit(config.sql);
-    // 如果表没有update_time,create_time,is_delete三个字段，补上，放入masmysql的state中
-    await checkSqlKey();
-    // 比较入masmysql的state中的form，不一样重新生成生成sqlform,json
-    getsqlFormData(path.join(__dirname, "/../src/sqlform.json"));
-    if (process.argv[2] != "-end") {
-      masState.sql = new massql();
-      console.info(c.greenBright("mysql数据库连接成功！"));
-    }
-    if (process.argv[2] == "-end") {
-      await sqlEnd();
-      console.info(c.greenBright("初始化成功！"));
-    }
-  }
-})();
-export {};
+// // 数据库初始化
+// (async () => {
+//   // mysql初始化
+//   if (config.useSql) {
+//     await sqlInit(config.sql);
+//     // 如果表没有update_time,create_time,is_delete三个字段，补上，放入masmysql的state中
+//     await checkSqlKey();
+//     // 比较入masmysql的state中的form，不一样重新生成生成sqlform,json
+//     getsqlFormData(path.join(__dirname, "/../src/sqlform.json"));
+//     if (process.argv[2] != "-end") {
+//       masState.sql = new massql();
+//       console.info(c.greenBright("mysql数据库连接成功！"));
+//     }
+//     if (process.argv[2] == "-end") {
+//       await sqlEnd();
+//       console.info(c.greenBright("初始化成功！"));
+//     }
+//   }
+// })();
+// export {};

package/test/scripts/createApis.ts

@@ -7,7 +7,7 @@ import {
   sqlEnd,
   getsqlFormDataType,
 } from "@/index";
-import config from "../config/config";
+import config from "../config/serverConfig/config";
 import masState from "../src/masState";
 import * as fs from "fs";
 import * as path from "path";

package/test/scripts/createSqlForm.ts

@@ -1,5 +1,5 @@
 import "module-alias/register";
-import { createSqlForm } from "@/index";
-import createSqlFormData from "../config/createSqlFormData";
-import config from "../config/config";
-createSqlForm(config.sql, createSqlFormData);
+// import { createSqlForm } from "@/index";
+// import createSqlFormData from "../config/sqlConfig/createSqlFormData";
+// import config from "../config/config";
+// createSqlForm(config.sql, createSqlFormData);