mas-server 2.0.64 → 3.0.0

package/.temp/getRouteByApiSrc.ts

@@ -1,10 +1,10 @@
 import readApi from "./readApi";
 import c from "ansi-colors";
-import { apiConfigType } from "../typings";
+import { ApiConfigType } from "../typings";
 
 export default function getRouteByApiSrc(
   apiSrc,
-  apiConfig: apiConfigType,
+  apiConfig: ApiConfigType,
   apiKey: { [key: string]: string }
 ) {
   const routerArr = readApi(apiSrc, "api");

package/.temp/updateRouter.ts

@@ -23,8 +23,8 @@ const { newApiConfig, newApiConfigArr, isAdd, newApiKey } = getRouteByApiSrc(
 if (isAdd) {
   fs.writeFileSync(
     path.join(__dirname, "../config/api.config.ts"),
-    `import { apiConfigType } from "@/index";
-     const apiConfig: apiConfigType = ${
+    `import { ApiConfigType } from "@/index";
+     const apiConfig: ApiConfigType = ${
        // 构造器类型正则转译
        JSON.stringify(newApiConfig, (key, value) => {
          if (typeof value === "function") {
@@ -43,4 +43,4 @@ if (isAdd) {
     path.join(__dirname, "../config/api.key.ts"),
     "export default " + JSON.stringify(newApiKey)
   );
-}
+}

package/README.md

@@ -1 +1,7 @@
-一款基于express面向中小型项目的后端框架
+一款基于 express 面向中小型项目的后端框架
+功能如下：
+约定式路由
+权限管理
+日志管理
+IP 限流
+JWT 验证

package/beforebuild.js

@@ -6,5 +6,4 @@ if (fs.existsSync(path.join(__dirname, "./dist"))) {
 } else {
     fs.mkdirSync(path.join(__dirname, "dist"));
 }
-fs.cpSync(path.join(__dirname, "./src/utils/mas-encrypt.min.js"), path.join(__dirname, "./dist/utils/mas-encrypt.min.js"), { recursive: true });
-fs.cpSync(path.join(__dirname, "./src/apiDoc/"), path.join(__dirname, "./dist/apiDoc/"), { recursive: true });
+fs.cpSync(path.join(__dirname, "./src/utils/mas-encrypt.min.js"), path.join(__dirname, "./dist/utils/mas-encrypt.min.js"), { recursive: true });

package/dist/index.js

@@ -3,11 +3,10 @@ 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.massql = exports.getsqlFormDataType = exports.getsqlFormData = exports.createSqlForm = exports.checkSqlKey = exports.sqlQuery = exports.sqlInit = exports.sqlEnd = exports.sqlState = exports.moment = exports.readApi = exports.getApp = void 0;
+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"));
-const cors_1 = __importDefault(require("cors"));
-const path_1 = __importDefault(require("path"));
 const state_1 = require("./state");
 const printLog_1 = __importDefault(require("./utils/printLog"));
 const quickSend_1 = __importDefault(require("./utils/quickSend"));
@@ -20,18 +19,6 @@ const moment_1 = __importDefault(require("moment"));
 exports.moment = moment_1.default;
 require("moment/locale/zh-cn");
 moment_1.default.locale("zh-cn");
-// 数据库
-const masmysql_1 = require("masmysql");
-Object.defineProperty(exports, "sqlEnd", { enumerable: true, get: function () { return masmysql_1.sqlEnd; } });
-Object.defineProperty(exports, "sqlInit", { enumerable: true, get: function () { return masmysql_1.sqlInit; } });
-Object.defineProperty(exports, "sqlQuery", { enumerable: true, get: function () { return masmysql_1.sqlQuery; } });
-Object.defineProperty(exports, "checkSqlKey", { enumerable: true, get: function () { return masmysql_1.checkSqlKey; } });
-Object.defineProperty(exports, "createSqlForm", { enumerable: true, get: function () { return masmysql_1.createSqlForm; } });
-Object.defineProperty(exports, "massql", { enumerable: true, get: function () { return masmysql_1.massql; } });
-Object.defineProperty(exports, "sqlState", { enumerable: true, get: function () { return masmysql_1.state; } });
-Object.defineProperty(exports, "getsqlFormDataType", { enumerable: true, get: function () { return masmysql_1.getsqlFormDataType; } });
-Object.defineProperty(exports, "getsqlFormData", { enumerable: true, get: function () { return masmysql_1.getsqlFormData; } });
-const apiDoc_1 = __importDefault(require("./utils/apiDoc"));
 const meaToken_1 = require("./utils/meaToken");
 Object.defineProperty(exports, "createToken", { enumerable: true, get: function () { return meaToken_1.createToken; } });
 Object.defineProperty(exports, "validToken", { enumerable: true, get: function () { return meaToken_1.validToken; } });
@@ -42,27 +29,20 @@ const getRouterInfo_1 = __importDefault(require("./utils/getRouterInfo"));
 const logs_1 = __importDefault(require("./utils/logs"));
 const apiLimit_1 = __importDefault(require("./utils/apiLimit"));
 // =================================================================
-function getApp(DIRNAME, beforeMounted) {
-    var _a, _b;
-    // 路径和配置放入state
-    state_1.state.DIRNAME = DIRNAME;
-    const config = require(path_1.default.join(DIRNAME, "/config/config.ts")).default;
+function getApp(proConfig, 
+/** 接口生成之前 */
+beforeMounted) {
+    var _a;
+    const config = require(proConfig.configPath).default;
     // 获取路由信息
-    (0, getRouterInfo_1.default)(path_1.default.join(state_1.state.DIRNAME, "src/api"), path_1.default.join(state_1.state.DIRNAME, "config/defaultApiConfig.ts"));
+    (0, getRouterInfo_1.default)(proConfig.apisPath, proConfig.defalutApiPath);
     state_1.state.config = config;
-    state_1.state.apiCN =
-        ((_a = require(path_1.default.join(state_1.state.DIRNAME, "config/docNav.ts"))) === null || _a === void 0 ? void 0 : _a.default) || {};
     // new express
     const app = (0, express_1.default)();
     // ip限制
-    if ((_b = config.apiLimit) === null || _b === void 0 ? void 0 : _b.open) {
+    if ((_a = config.apiLimit) === null || _a === void 0 ? void 0 : _a.open) {
         (0, apiLimit_1.default)(app, config.apiLimit || {});
     }
-    // 是否允许跨域
-    config.cors && app.use((0, cors_1.default)());
-    if (beforeMounted) {
-        beforeMounted(app);
-    }
     // 初始化app
     app.use(express_1.default.urlencoded({ extended: true }));
     app.use(express_1.default.json());
@@ -82,8 +62,7 @@ function getApp(DIRNAME, beforeMounted) {
     }
     // 存储日志
     if (config.logs.open) {
-        // app.use(printLog);
-        (0, logs_1.default)(app, path_1.default.join(DIRNAME + `/logs/`));
+        (0, logs_1.default)(app, proConfig.logPath);
     }
     // 权限管理
     if (config.token.open) {
@@ -91,17 +70,12 @@ function getApp(DIRNAME, beforeMounted) {
     }
     // 数据效验
     app.use(validRouteData_1.default);
-    // 使用接口文档
-    if (config.apidoc) {
-        app.use("/apidoc", express_1.default.static(path_1.default.join(__dirname, "/apiDoc")));
-        (0, apiDoc_1.default)(app);
-    }
     // 创建路由
-    (0, createRouter_1.default)(app);
+    (0, createRouter_1.default)(app, proConfig.apisPath);
     // 运行debug
     setTimeout(() => {
         try {
-            require(path_1.default.join(DIRNAME + "/src/debug"));
+            require(proConfig.degbugPath);
         }
         catch (error) {
             console.info(ansi_colors_1.default.red("debug.js报错！！！"));
@@ -110,4 +84,3 @@ function getApp(DIRNAME, beforeMounted) {
     }, config.debugTime || 1000);
     return app;
 }
-exports.getApp = getApp;

package/dist/utils/createRouter.js

@@ -26,20 +26,22 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.default = createRouter;
 const state_1 = require("../state");
 const path_1 = __importDefault(require("path"));
 const fs = __importStar(require("fs"));
 const ansi_colors_1 = __importDefault(require("ansi-colors"));
-function createRouter(app) {
-    const { Router, DIRNAME } = state_1.state;
+function createRouter(app, apiDir) {
+    const { Router } = state_1.state;
     // 遍历api路由
     for (const item in Router) {
-        let isExist = fs.existsSync(path_1.default.join(DIRNAME, "src", item) + ".ts");
+        const filePath = path_1.default.join(apiDir, "..", item) + ".ts";
+        let isExist = fs.existsSync(filePath);
         if (!isExist) {
             console.info(ansi_colors_1.default.red(`${item} not found`));
             continue;
         }
-        const apiFunc = require(path_1.default.join(DIRNAME, "src", item)).default;
+        const apiFunc = require(filePath).default;
         if (!apiFunc) {
             console.info(ansi_colors_1.default.yellow(`${item} 没有导出函数，已跳过..`));
         }
@@ -48,4 +50,3 @@ function createRouter(app) {
         }
     }
 }
-exports.default = createRouter;

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.default = getRouterInfo;
 const state_1 = require("../state");
 const readApi_1 = __importDefault(require("./readApi"));
 const path_1 = __importDefault(require("path"));
@@ -10,25 +11,19 @@ const fs_1 = __importDefault(require("fs"));
 const ansi_colors_1 = __importDefault(require("ansi-colors"));
 function getRouterInfo(apiDir, defaullConfigDir) {
     const apiConfig = {};
-    const { DIRNAME } = state_1.state;
     const routerDir = (0, readApi_1.default)(apiDir, "api");
-    const defaullConfig = require(defaullConfigDir).default;
+    const defaullConfig = require(defaullConfigDir).config;
     // 遍历api路由
     for (const item of routerDir) {
-        let isExist = fs_1.default.existsSync(path_1.default.join(DIRNAME, "src", item) + ".ts");
+        const filePath = path_1.default.join(apiDir, "..", item) + ".ts";
+        let isExist = fs_1.default.existsSync(filePath);
         if (!isExist) {
             console.info(ansi_colors_1.default.red(`${item} not found`));
             continue;
         }
-        const apiItemConfig = require(path_1.default.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_1.state.Router = apiConfig;
     return apiConfig;
 }
-exports.default = getRouterInfo;

package/dist/utils/masUtils.js

@@ -1,12 +1,10 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getType = void 0;
+exports.getType = getType;
 function getType(obj) {
-    // "".toLocaleLowerCase
     return Object.prototype.toString
         .call(obj)
         .slice(8)
         .replace("]", "")
         .toLocaleLowerCase();
 }
-exports.getType = getType;

package/dist/utils/meaToken.js

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.createToken = exports.validToken = void 0;
+exports.validToken = void 0;
+exports.createToken = createToken;
 const { decode, isJSON, encode } = require("./mas-encrypt.min.js");
 const getTimestamp = () => new Date().getTime();
 /**
@@ -54,4 +55,3 @@ function createToken({ data = null, time = 0, permission = [] } = {}, key = "808
     time !== 0 && (token._masTime = time * 1000 + getTimestamp());
     return encode(token, key);
 }
-exports.createToken = createToken;

package/dist/utils/readApi.js

@@ -23,6 +23,7 @@ var __importStar = (this && this.__importStar) || function (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 = "") {
@@ -47,4 +48,3 @@ function readFilesRecursively(folderPath, routerPrefix = "") {
     });
     return files;
 }
-exports.default = readFilesRecursively;

package/dist/utils/validType.js

@@ -1,5 +1,6 @@
 "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();
@@ -81,4 +82,3 @@ function validType(obj, typeMapping, strict = false) {
         ? validTypeObjStrict(obj, typeMapping)
         : validTypeObj(obj, typeMapping);
 }
-exports.default = validType;

package/package.json

@@ -1,53 +1,53 @@
-{
-  "name": "mas-server",
-  "version": "2.0.64",
-  "description": "一款基于express面向中小型项目的后端框架",
-  "main": "dist/index.js",
-  "typings": "src/index.ts",
-  "scripts": {
-    "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": "node ./beforebuild.js && tsc --project ./tsconfig-build.json",
-    "sync": "npm run build && 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",
-    "express-rate-limit": "^7.1.4",
-    "fs-extra": "^11.1.1",
-    "glob": "^10.3.1",
-    "masmysql": "^2.0.56",
-    "module-alias": "^2.2.2",
-    "moment": "^2.29.4",
-    "moment-timezone": "^0.5.44",
-    "morgan": "^1.10.0",
-    "mysql": "^2.18.1",
-    "nodemon": "^2.0.22",
-    "rotating-file-stream": "^3.1.1",
-    "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": "3.0.0",
+  "description": "一款基于express面向中小型项目的后端框架",
+  "main": "dist/index.js",
+  "typings": "src/index.ts",
+  "scripts": {
+    "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": "node ./beforebuild.js && tsc --project ./tsconfig-build.json",
+    "sync": "npm run build && npm publish && cnpm sync mas-server && explorer \"https://npmmirror.com/package/mas-server\""
+  },
+  "keywords": [],
+  "author": "tingxi8087",
+  "license": "ISC",
+  "dependencies": {
+    "@types/express": "^4.17.21",
+    "ansi-colors": "^4.1.3",
+    "axios": "^1.3.6",
+    "cors": "^2.8.5",
+    "express": "^4.18.2",
+    "express-ip": "^1.0.4",
+    "express-rate-limit": "^7.1.4",
+    "fs-extra": "^11.1.1",
+    "glob": "^10.3.1",
+    "masmysql": "^2.0.56",
+    "module-alias": "^2.2.2",
+    "moment": "^2.29.4",
+    "moment-timezone": "^0.5.44",
+    "morgan": "^1.10.0",
+    "mysql": "^2.18.1",
+    "nodemon": "^2.0.22",
+    "rotating-file-stream": "^3.1.1",
+    "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

@@ -1,9 +1,6 @@
 import "module-alias/register";
 import express from "express";
 import type { Express } from "express";
-import cors from "cors";
-import path from "path";
-import * as fs from "fs";
 import { state } from "./state";
 import printLog from "./utils/printLog";
 import quickSend from "./utils/quickSend";
@@ -11,30 +8,16 @@ import readApi from "./utils/readApi";
 import validRouteData from "./utils/validRouteData";
 import validTokenUse from "./utils/validToken";
 import type {
-  masReq,
-  masRes,
-  apiConfigType,
-  configType,
-  apiConfigTypeItem,
+  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 {
-  sqlEnd,
-  sqlInit,
-  sqlQuery,
-  checkSqlKey,
-  createSqlForm,
-  massql,
-  state as sqlState,
-  getsqlFormDataType,
-  getsqlFormData,
-} from "masmysql";
-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";
@@ -44,31 +27,31 @@ import apiLimit from "./utils/apiLimit";
 
 // =================================================================
 export function getApp(
-  DIRNAME: string,
+  proConfig: {
+    /** 配置路径 */
+    configPath: string;
+    /** 接口路径 */
+    apisPath: string;
+    /** 兜底接口文件路径 */
+    defalutApiPath: string;
+    /** 日志路径 */
+    logPath: string;
+    /** 调试文件路径 */
+    degbugPath: string;
+  },
+  /** 接口生成之前 */
   beforeMounted?: (app: Express) => void
 ) {
-  // 路径和配置放入state
-  state.DIRNAME = DIRNAME;
-  const config = require(path.join(DIRNAME, "/config/config.ts")).default;
+  const config = require(proConfig.configPath).default;
   // 获取路由信息
-  getRouterInfo(
-    path.join(state.DIRNAME, "src/api"),
-    path.join(state.DIRNAME, "config/defaultApiConfig.ts")
-  );
+  getRouterInfo(proConfig.apisPath, proConfig.defalutApiPath);
   state.config = config;
-  state.apiCN =
-    require(path.join(state.DIRNAME, "config/docNav.ts"))?.default || {};
   // new express
   const app = express();
   // ip限制
   if (config.apiLimit?.open) {
     apiLimit(app, config.apiLimit || {});
   }
-  // 是否允许跨域
-  config.cors && app.use(cors());
-  if (beforeMounted) {
-    beforeMounted(app);
-  }
   // 初始化app
   app.use(express.urlencoded({ extended: true }));
   app.use(express.json());
@@ -88,27 +71,20 @@ export function getApp(
   }
   // 存储日志
   if (config.logs.open) {
-    // app.use(printLog);
-    getLogs(app, path.join(DIRNAME + `/logs/`));
+    getLogs(app, proConfig.logPath);
   }
-
   // 权限管理
   if (config.token.open) {
     app.use(validTokenUse);
   }
   // 数据效验
   app.use(validRouteData);
-  // 使用接口文档
-  if (config.apidoc) {
-    app.use("/apidoc", express.static(path.join(__dirname, "/apiDoc")));
-    apiDoc(app);
-  }
   // 创建路由
-  createRouter(app);
+  createRouter(app, proConfig.apisPath);
   // 运行debug
   setTimeout(() => {
     try {
-      require(path.join(DIRNAME + "/src/debug"));
+      require(proConfig.degbugPath);
     } catch (error) {
       console.info(c.red("debug.js报错！！！"));
       console.info(error);
@@ -116,28 +92,5 @@ export function getApp(
   }, config.debugTime || 1000);
   return app;
 }
-export {
-  readApi,
-  moment,
-  sqlState,
-  sqlEnd,
-  sqlInit,
-  sqlQuery,
-  checkSqlKey,
-  createSqlForm,
-  getsqlFormData,
-  getsqlFormDataType,
-  massql,
-  validToken,
-  createToken,
-  validType,
-};
-export type {
-  masReq,
-  masRes,
-  apiConfigType,
-  configType,
-  createSqlFormType,
-  sqlForm,
-  apiConfigTypeItem,
-};
+export { readApi, moment, validToken, createToken, validType };
+export type { MasReq, MasRes, ApiConfigType, ConfigType, ApiConfigTypeItem };