mas-server 3.0.42 → 4.0.0-beta.0

package/dist/utils/meaToken.js

@@ -1,57 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.validToken = void 0;
-exports.createToken = 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 Object.assign(Object.assign({}, token), { status: 1 });
-};
-exports.validToken = validToken;
-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 = {};
-    token.data = data;
-    permission.length != 0 && (token._permission = permission);
-    time !== 0 && (token._masTime = time * 1000 + getTimestamp());
-    return encode(token, key);
-}

package/dist/utils/printLog.js

@@ -1,12 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const moment_1 = __importDefault(require("moment"));
-exports.default = (req, res, next) => {
-    const date = (0, moment_1.default)().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/dist/utils/quickSend.js

@@ -1,37 +0,0 @@
-"use strict";
-var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
-    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.default = (req, res, next) => {
-    // req.fields && (req.body = req.fields);
-    res.return = (data_1, ...args_1) => __awaiter(void 0, [data_1, ...args_1], void 0, function* (data, status = 1, code = 200, msg = "") {
-        if (data === null || data === undefined) {
-            status = 0;
-        }
-        if (data instanceof Promise)
-            data = yield data;
-        // if (typeof data != "string") data = JSON.stringify(data);
-        res.status(code).send({
-            msg,
-            status: !!status ? 1 : 0,
-            data: data === null || data === undefined ? null : data,
-        });
-    });
-    res.reply = (data_1, ...args_1) => __awaiter(void 0, [data_1, ...args_1], void 0, function* (data, msg = "", code = 200) {
-        return yield res.return(data, data ? 1 : 0, code, msg);
-    });
-    res.success = (data_1, ...args_1) => __awaiter(void 0, [data_1, ...args_1], void 0, function* (data, msg = "成功") {
-        return yield res.return(data, 1, 200, msg);
-    });
-    res.fail = (data_1, ...args_1) => __awaiter(void 0, [data_1, ...args_1], void 0, function* (data, msg = "系统错误，请联系管理员") {
-        return yield res.return(data, 0, 200, msg);
-    });
-    next();
-};

package/dist/utils/readApi.js

@@ -1,60 +0,0 @@
-"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 () {
-    var ownKeys = function(o) {
-        ownKeys = Object.getOwnPropertyNames || function (o) {
-            var ar = [];
-            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
-            return ar;
-        };
-        return ownKeys(o);
-    };
-    return function (mod) {
-        if (mod && mod.__esModule) return mod;
-        var result = {};
-        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
-        __setModuleDefault(result, mod);
-        return result;
-    };
-})();
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.default = readFilesRecursively;
-const fs = __importStar(require("fs"));
-const path = __importStar(require("path"));
-function readFilesRecursively(folderPath, routerPrefix = "") {
-    const files = [];
-    fs.readdirSync(folderPath).forEach((fileName) => {
-        const filePath = path.join(folderPath, fileName);
-        const stat = fs.statSync(filePath);
-        if (stat.isDirectory()) {
-            const directoryPrefix = routerPrefix
-                ? `${routerPrefix}/${fileName}`
-                : fileName;
-            const directoryFiles = readFilesRecursively(filePath, directoryPrefix);
-            files.push(...directoryFiles);
-        }
-        else {
-            const filePrefix = routerPrefix
-                ? `${routerPrefix}/${fileName}`
-                : fileName;
-            const fileRoute = `/${filePrefix.replace(/\.[^/.]+$/, "")}`;
-            files.push(fileRoute);
-        }
-    });
-    return files;
-}

package/dist/utils/validRouteData.js

@@ -1,37 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const state_1 = require("../state");
-const validType_1 = __importDefault(require("./validType"));
-exports.default = (req, res, next) => {
-    const Router = state_1.state.Router;
-    const routerObj = Router[req.path];
-    if (routerObj) {
-        if (routerObj.methods != "all" &&
-            routerObj.methods != req.method.toLowerCase()) {
-            return res.return(null, 0, 400, "error method!");
-        }
-        if (routerObj.header && routerObj.header.length != 0) {
-            const headerObj = {};
-            routerObj.header.forEach((item) => {
-                !item.optional && (headerObj[item.name] = item.type);
-            });
-            if (!(0, validType_1.default)(req.headers, headerObj)) {
-                return res.return(null, 0, 400, "error headers format!");
-            }
-        }
-        if (req.method == "GET" &&
-            routerObj.validFormat &&
-            !(0, validType_1.default)(req.query, routerObj.validFormat, !!routerObj.validFormatStrict)) {
-            return res.return(null, 0, 400, "error data format!");
-        }
-        if (req.method == "POST" &&
-            routerObj.validFormat &&
-            !(0, validType_1.default)(req.body, routerObj.validFormat, !!routerObj.validFormatStrict)) {
-            return res.return(null, 0, 400, "error data format!");
-        }
-    }
-    next();
-};

package/dist/utils/validToken.js

@@ -1,24 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const state_1 = require("../state");
-const __1 = require("..");
-const masUtils_1 = require("./masUtils");
-exports.default = (req, res, next) => {
-    const r = state_1.state.Router[req.path];
-    const tokenConfig = state_1.state.config.token;
-    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(null, 0, 400, "缺少重要参数");
-        }
-        let vt = (0, __1.validToken)({ token, permission: r.permission }, tokenConfig.pwd);
-        if (vt.status === 0) {
-            return res.return(vt.errorCode, 0, 200, vt.msg);
-        }
-        res.token = vt;
-        next();
-    }
-    else {
-        next();
-    }
-};

package/dist/utils/validType.js

@@ -1,84 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.default = validType;
-const masUtils_1 = require("../utils/masUtils");
-const vliadBase = (obj, typeMapping) => {
-    return (0, masUtils_1.getType)(obj) == typeMapping.name.toLowerCase();
-};
-const validTypeObj = (obj, typeMapping) => {
-    if (obj === null || obj === undefined)
-        return false;
-    let typeT = (0, masUtils_1.getType)(typeMapping);
-    if (typeT == "function") {
-        return vliadBase(obj, typeMapping);
-    }
-    else if (typeT == "object") {
-        if ((0, masUtils_1.getType)(obj) !== "object")
-            return false;
-        for (let k in typeMapping) {
-            if (obj[k] === null || obj[k] === undefined)
-                return false;
-            if (!validType(obj[k], typeMapping[k]))
-                return false;
-        }
-    }
-    else if (typeT == "array") {
-        if ((0, masUtils_1.getType)(obj) != "array")
-            return false;
-        if (obj.length === 0)
-            return false;
-        const typeMappingArrObj = typeMapping[0];
-        if (!typeMappingArrObj) {
-            throw new Error(`非法的效验格式 ${typeMapping} ${typeMappingArrObj}`);
-        }
-        if ((0, masUtils_1.getType)(obj) != "array")
-            return false;
-        for (let v of obj) {
-            if (!validTypeObj(v, typeMappingArrObj))
-                return false;
-        }
-    }
-    return true;
-};
-const validTypeObjStrict = (obj, typeMapping) => {
-    if (obj === null || obj === undefined)
-        return false;
-    let typeT = (0, masUtils_1.getType)(typeMapping);
-    if (typeT == "function") {
-        return vliadBase(obj, typeMapping);
-    }
-    else if (typeT == "object") {
-        if ((0, masUtils_1.getType)(obj) !== "object")
-            return false;
-        if (Object.keys(obj).length != Object.keys(typeT).length)
-            return false;
-        for (let k in typeMapping) {
-            if (obj[k] === null || obj[k] === undefined)
-                return false;
-            if (!validType(obj[k], typeMapping[k]))
-                return false;
-        }
-    }
-    else if (typeT == "array") {
-        if ((0, masUtils_1.getType)(obj) != "array")
-            return false;
-        if (obj.length === 0)
-            return false;
-        const typeMappingArrObj = typeMapping[0];
-        if (!typeMappingArrObj) {
-            throw new Error(`非法的效验格式 ${typeMapping} ${typeMappingArrObj}`);
-        }
-        if ((0, masUtils_1.getType)(obj) != "array")
-            return false;
-        for (let v of obj) {
-            if (!validTypeObj(v, typeMappingArrObj))
-                return false;
-        }
-    }
-    return true;
-};
-function validType(obj, typeMapping, strict = false) {
-    return strict
-        ? validTypeObjStrict(obj, typeMapping)
-        : validTypeObj(obj, typeMapping);
-}

package/src/index.ts

@@ -1,98 +0,0 @@
-import "module-alias/register";
-import express from "express";
-import type { Express } from "express";
-import { state } from "./state";
-import printLog from "./utils/printLog";
-import quickSend from "./utils/quickSend";
-import readApi from "./utils/readApi";
-import validRouteData from "./utils/validRouteData";
-import validTokenUse from "./utils/validToken";
-import type {
-  MasReq,
-  MasRes,
-  ApiConfigType,
-  ConfigType,
-  ApiConfigTypeItem,
-} from "./typings";
-import c from "ansi-colors";
-import moment from "moment";
-import "moment/locale/zh-cn";
-moment.locale("zh-cn");
-import { createToken, validToken } from "./utils/meaToken";
-import validType from "./utils/validType";
-import createRouter from "./utils/createRouter";
-import getRouterInfo, { getApiRouter } from "./utils/getRouterInfo";
-import getLogs from "./utils/logs";
-import apiLimit from "./utils/apiLimit";
-
-// =================================================================
-export function getApp(
-  proConfig: {
-    /** 配置路径 */
-    configPath: string;
-    /** 接口路径 */
-    apisPath: string;
-    /** 兜底接口文件路径 */
-    defalutApiPath: string;
-    /** 日志路径 */
-    logPath: string;
-    /** 调试文件路径 */
-    degbugPath: string;
-  },
-  /** 接口生成之前 */
-  beforeMounted?: (app: Express) => void
-) {
-  const config = require(proConfig.configPath).default;
-  // 获取路由信息
-  getRouterInfo(proConfig.apisPath, proConfig.defalutApiPath);
-  state.config = config;
-  // new express
-  const app = express();
-  beforeMounted && beforeMounted(app);
-  // ip限制
-  if (config.apiLimit?.open) {
-    apiLimit(app, config.apiLimit || {});
-  }
-  // 初始化app
-  app.use(express.urlencoded({ extended: true }));
-  app.use(express.json());
-  // 错误处理中间件
-  app.use((err, req, res, next) => {
-    if (err.type == "entity.parse.failed") {
-      req.body._str = err.body;
-    }
-    next();
-  });
-  //快速return
-  app.use(quickSend);
-  // 打印日志
-  if (config.logs.debug) {
-    app.use(require("express-ip")().getIpInfoMiddleware);
-    app.use(printLog);
-  }
-  // 存储日志
-  if (config.logs.open) {
-    getLogs(app, proConfig.logPath);
-  }
-  // 权限管理
-  if (config.token.open) {
-    app.use(validTokenUse);
-  }
-  // 数据效验
-  app.use(validRouteData);
-  // 创建路由
-  createRouter(app, proConfig.apisPath);
-  // 运行debug
-  setTimeout(() => {
-    try {
-      require(proConfig.degbugPath);
-    } catch (error) {
-      console.info(c.red("debug.js报错！！！"));
-      console.info(error);
-    }
-  }, config.debugTime || 1000);
-  return app;
-}
-
-export { readApi, moment, validToken, createToken, validType, getApiRouter };
-export type { MasReq, MasRes, ApiConfigType, ConfigType, ApiConfigTypeItem };

package/src/state.ts

@@ -1 +0,0 @@
-export const state: any = {};

package/src/typings/index.ts

@@ -1,113 +0,0 @@
-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信息 */
-  token?: { data: any; _permission: string[] };
-  /** 通用响应方法 */
-  reply: (data: any, msg?: string, code?: number) => Promise<void>;
-  /** 成功响应方法 */
-  success: (data: any, msg?: string) => Promise<void>;
-  /** 失败响应方法 */
-  fail: (data: any, msg?: string) => Promise<void>;
-};
-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

@@ -1,15 +0,0 @@
-import rateLimit from "express-rate-limit";
-const apiLimit = (app: any, config?: { windowMs: number; max: number }) => {
-  // 创建一个速率限制器，限制每个IP地址在一分钟内最多可以发送10个请求
-  const limiter = rateLimit({
-    windowMs: config?.windowMs || 60 * 1000, // 1分钟
-    max: config?.max || 20, // 最多10个请求
-    // 当达到限制时调用的处理函数
-    handler: function (req, res: any) {
-      res.status(502).end();
-    },
-  });
-  // 将速率限制器应用于所有请求
-  app.use(limiter);
-};
-export default apiLimit;

package/src/utils/createRouter.ts

@@ -1,34 +0,0 @@
-import { state } from "../state";
-import path from "path";
-import * as fs from "fs";
-import c from "ansi-colors";
-export default function createRouter(app, apiDir: string) {
-  const { Router } = state;
-  // 遍历api路由
-  for (const item in Router) {
-    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(filePath).default;
-    if (!apiFunc) {
-      console.info(c.yellow(`${item} 没有导出函数，已跳过..`));
-    } else {
-      apiFunc &&
-        app[Router[item].methods](item, async (req, res) => {
-          try {
-            await apiFunc(req, res);
-          } catch (error) {
-            console.log(error, error.toString);
-            res.return(
-              { msg: "服务器错误", error: error?.toString?.() || null },
-              0,
-              500
-            );
-          }
-        });
-    }
-  }
-}

package/src/utils/getRouterInfo.ts

@@ -1,49 +0,0 @@
-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 routerDir = readFilesRecursively(apiDir, "api");
-  const defaullConfig = require(defaullConfigDir).config;
-  // 遍历api路由
-  for (const item of routerDir) {
-    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(filePath).config;
-    apiConfig[item] = apiItemConfig || defaullConfig;
-  }
-  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 +0,0 @@
-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;