mas-server 1.0.3 → 2.0.0

package/src/utils/validType.ts

@@ -0,0 +1,98 @@
+import { getType } from "@/utils/masUtils";
+
+type BasicTypeDescriptor =
+  | StringConstructor
+  | NumberConstructor
+  | BooleanConstructor
+  | ObjectConstructor;
+type TypeDescriptor = BasicTypeDescriptor | Array<any>;
+
+interface TypeMapping {
+  [key: string]:
+    | TypeDescriptor
+    | TypeMapping
+    | Array<TypeDescriptor | TypeMapping>;
+}
+const vliadBase = (obj, typeMapping) => {
+  return getType(obj) == (typeMapping as any).name.toLowerCase();
+};
+const validTypeObj = (obj: any, typeMapping: TypeMapping | TypeDescriptor) => {
+  if (obj === null || obj === undefined) return false;
+  let typeT = getType(typeMapping);
+  if (typeT == "function") {
+    return vliadBase(obj, typeMapping);
+  } else if (typeT == "object") {
+    if (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 (getType(obj) != "array") return false;
+    if (obj.length === 0) return false;
+    const typeMappingArrObj = typeMapping[0];
+    if (!typeMappingArrObj) {
+      throw new Error(`非法的效验格式 ${typeMapping} ${typeMappingArrObj}`);
+    }
+    if (getType(obj) != "array") return false;
+    for (let v of obj) {
+      if (!validTypeObj(v, typeMappingArrObj)) return false;
+    }
+  }
+  return true;
+};
+const validTypeObjStrict = (
+  obj: any,
+  typeMapping: TypeMapping | TypeDescriptor
+) => {
+  if (obj === null || obj === undefined) return false;
+  let typeT = getType(typeMapping);
+  if (typeT == "function") {
+    return vliadBase(obj, typeMapping);
+  } else if (typeT == "object") {
+    if (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 (getType(obj) != "array") return false;
+    if (obj.length === 0) return false;
+    const typeMappingArrObj = typeMapping[0];
+    if (!typeMappingArrObj) {
+      throw new Error(`非法的效验格式 ${typeMapping} ${typeMappingArrObj}`);
+    }
+    if (getType(obj) != "array") return false;
+    for (let v of obj) {
+      if (!validTypeObj(v, typeMappingArrObj)) return false;
+    }
+  }
+  return true;
+};
+export default function validType(
+  obj: any,
+  typeMapping: TypeMapping | TypeDescriptor,
+  strict: boolean = false
+): boolean {
+  return strict
+    ? 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

@@ -0,0 +1,6 @@
+import type { masReq, masRes } from "@/index";
+import masState from "../src/masState";
+const { sql } = masState;
+export default async (req: masReq, res: masRes) => {
+  res.return("hello mas-server!");
+};

package/test/apiTemplate/curd/del.ts

@@ -0,0 +1,9 @@
+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) => {
+  const { sql } = masState;
+  const sqlRes = await sql.use(sqlform.$form).delete(req.body).go();
+  res.return(sqlRes);
+};

package/test/apiTemplate/curd/get.ts

@@ -0,0 +1,9 @@
+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) => {
+  const { sql } = masState;
+  const sqlRes = await sql.use(sqlform.$form).select(req.body).paging().go();
+  res.return(sqlRes);
+};

package/test/apiTemplate/curd/set.ts

@@ -0,0 +1,9 @@
+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) => {
+  const { sql } = masState;
+  const sqlRes = await sql.use(sqlform.$form).set(req.body).go();
+  res.return(sqlRes, sqlRes);
+};

package/test/config/api.config.ts

@@ -0,0 +1,3 @@
+import { apiConfigType } from "@/index";
+     const apiConfig: apiConfigType = {"/api/curd/student/del":{"name":"删除数据","methods":"all","des":"","validFormat":{"id":Number}},"/api/curd/student/get":{"name":"得到数据","methods":"all","des":"","validFormat":null},"/api/curd/student/set":{"name":"修改或添加数据","methods":"all","des":"","validFormat":null},"/api/index":{"name":"默认接口","methods":"post","des":"一个默认接口","validFormat":{"arr":[{"name":String,"age":Number}]},"header":[{"name":"token","type":String,"des":"token密钥"}],"validFormatDes":[{"name":"arr","type":{"arr":[{"name":String,"age":Number}]},"des":"学生数组"},{"name":"arg1","type":Number,"des":"可选参数","optional":true}],"example":{"arr":[{"name":"小明","age":18}]},"resExample":{"status":1,"data":"hello mas!","msg":""}},"/api/per":{"name":"新建接口","methods":"all","des":"","validFormat":null},"/api/person/del":{"name":"新建接口","methods":"all","des":"","validFormat":{"arr":[String]}},"/api/person/get":{"name":"新建接口","methods":"all","des":""},"/api/person/set":{"name":"新建接口","methods":"all","des":""},"/api/test":{"name":"新建接口","methods":"all","des":"","validFormat":null},"/api/validtest/boolArr":{"name":"新建接口","methods":"all","des":"","validFormat":[{"name":String}]}};
+     export default apiConfig;

package/test/config/api.key.ts

@@ -0,0 +1,14 @@
+export default {
+  api: "接口",
+  curd: "",
+  student: "",
+  del: "删除",
+  get: "",
+  set: "",
+  index: "",
+  per: "",
+  person: "人",
+  test: "",
+  validtest: "",
+  boolArr: "",
+};

package/test/config/config.ts

@@ -0,0 +1,30 @@
+import { configType } from "@/index";
+export default <configType>{
+  projectName: "mas-server",
+  port: 8087,
+  apidoc: true,
+  apidocOptions: {
+    // iframe嵌套
+    baseUrl: "",
+  },
+  cors: true,
+  logs: {
+    open: true,
+    debug: false,
+  },
+  token: {
+    open: true,
+    pwd: "8087",
+    headerParams: "token",
+  },
+  useSql: true,
+  debugTime: 1000,
+  sql: {
+    host: "127.0.0.1",
+    user: "root",
+    password: "123456",
+    database: "test666",
+    // database: "test",
+    // password: "tx123456",
+  },
+};

package/test/config/createSqlFormData.ts

@@ -0,0 +1,14 @@
+import { createSqlFormType } from "@/index";
+const createSqlFormData: createSqlFormType = {
+  testForm: [
+    {
+      key: "testA",
+      type: "str",
+    },
+    {
+      key: "numB",
+      type: "float",
+    },
+  ],
+};
+export default createSqlFormData;

package/test/main.ts

@@ -0,0 +1,25 @@
+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 {
+      next();
+    }
+  });
+});
+app.all("/", (_req, res: masRes) => {
+  res.return("default index");
+});
+// 404兜底
+app.all("*", (_req: masReq, res: masRes) => {
+  res.return(404, 0, 404);
+});
+app.listen(8087, () => {
+  console.log("http://localhost:8087");
+});

package/test/scripts/beforeCreated.ts

@@ -0,0 +1,67 @@
+import "module-alias/register";
+import {
+  checkSqlKey,
+  getRouteByApiSrc,
+  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初始化
+  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/createApiFile.ts

@@ -0,0 +1,27 @@
+import path from "path";
+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("/");
+    dirpath = dirpath.slice(0, dirpath.length - 1).join("/");
+    dir = path.join(DIRNAME, dir) + ".ts";
+    dirpath = path.join(DIRNAME, dirpath);
+    let isExist = fs.existsSync(dir);
+    if (isExist) {
+      console.info(c.yellow(`已存在！${dirname}`));
+      continue;
+    }
+    isExist = fs.existsSync(dirpath);
+    if (!isExist) fs.mkdirSync(dirpath, { recursive: true });
+    fs.copyFileSync(tempPath, dir);
+    console.info(c.green(`创建成功！${dirname}`));
+  }
+};
+createApiFile(
+  path.join(__dirname, "../src/api"),
+  path.join(__dirname, "../apiTemplate/api.temp.ts")
+);

package/test/scripts/createApis.ts

@@ -0,0 +1,109 @@
+import "module-alias/register";
+import {
+  sqlInit,
+  checkSqlKey,
+  getsqlFormData,
+  massql,
+  sqlEnd,
+  getsqlFormDataType,
+} from "@/index";
+import config from "../config/config";
+import masState from "../src/masState";
+import * as fs from "fs";
+import * as path from "path";
+import c from "ansi-colors";
+// import apiConfig from "../config/api.config";
+// 根据数据库生成对应type，自动注入数据效验
+(async () => {
+  let argv = process.argv.slice(2);
+  console.log(argv);
+  const formName = argv[0];
+  const wPath = argv[1];
+  // mysql初始化
+  if (config.useSql) {
+    await sqlInit(config.sql);
+    await checkSqlKey();
+    const formDataType = getsqlFormDataType();
+    if (!formDataType[formName]) {
+      console.info(c.redBright("该表不存在！"));
+      return;
+    }
+    const vlidType = formDataType[formName].typeData;
+    const getStr = fs
+      .readFileSync(path.join(__dirname, "../apiTemplate/curd/get.ts"))
+      .toString()
+      .replace("$form", formName);
+    const delStr = fs
+      .readFileSync(path.join(__dirname, "../apiTemplate/curd/del.ts"))
+      .toString()
+      .replace("$form", formName);
+    const setStr = fs
+      .readFileSync(path.join(__dirname, "../apiTemplate/curd/set.ts"))
+      .toString()
+      .replace("$form", formName);
+    // console.log(getStr);
+    fs.mkdirSync(path.join(__dirname, "../src/api", wPath, `/${formName}`), {
+      recursive: true,
+    });
+    fs.writeFileSync(
+      path.join(__dirname, "../src/api", wPath, `/${formName}/get.ts`),
+      getStr
+    );
+    fs.writeFileSync(
+      path.join(__dirname, "../src/api", wPath, `/${formName}/del.ts`),
+      delStr
+    );
+    fs.writeFileSync(
+      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/createSqlForm.ts

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

package/test/scripts/getSqlFormType.ts

@@ -0,0 +1,34 @@
+import "module-alias/register";
+import {
+  checkSqlKey,
+  getRouteByApiSrc,
+  sqlInit,
+  getsqlFormData,
+  massql,
+  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) {
+    await sqlInit(config.sql);
+    await checkSqlKey();
+    const formDataType = getsqlFormDataType();
+    for (let formName in formDataType) {
+      fs.writeFileSync(
+        path.join(__dirname, `../typings/${formName}SF.ts`),
+        `export type ${formName}SF = ${formDataType[formName].typeObj}`
+      );
+    }
+    await sqlEnd();
+    console.info(c.greenBright("获取类型成功！"));
+  }
+})();

package/test/scripts/run.ts

@@ -0,0 +1,4 @@
+// 先写入api.config.js和api.key.js
+import "./beforeCreated";
+// 运行express
+import "../main";

package/test/scripts/updateRouter.ts

@@ -0,0 +1,46 @@
+import "module-alias/register";
+import {
+  checkSqlKey,
+  getRouteByApiSrc,
+  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)
+  );
+}

package/test/src/api/curd/student/del.ts

@@ -0,0 +1,9 @@
+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) => {
+  const { sql } = masState;
+  const sqlRes = await sql.use(sqlform.student).delete(req.body).go();
+  res.return(sqlRes);
+};

package/test/src/api/curd/student/get.ts

@@ -0,0 +1,9 @@
+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) => {
+  const { sql } = masState;
+  const sqlRes = await sql.use(sqlform.student).select(req.body).paging().go();
+  res.return(sqlRes);
+};

package/test/src/api/curd/student/set.ts

@@ -0,0 +1,9 @@
+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) => {
+  const { sql } = masState;
+  const sqlRes = await sql.use(sqlform.student).set(req.body).go();
+  res.return(sqlRes, sqlRes);
+};

package/test/src/api/index.ts

@@ -0,0 +1,4 @@
+import type { masReq, masRes } from "@/index";
+export default async (req: masReq, res: masRes) => {
+  res.return("hello mas-server!");
+};

package/test/src/api/per.ts

@@ -0,0 +1,6 @@
+import type { masReq, masRes } from "@/index";
+export default async (req: masReq, res: masRes) => {
+  console.log(res.token);
+
+  res.return("hello mas-server!");
+};

package/test/src/api/person/del.ts

@@ -0,0 +1,4 @@
+import type { masReq, masRes } from "@/index";
+export default async (req: masReq, res: masRes) => {
+  res.return([1, 2]);
+};

package/test/src/api/person/get.ts

@@ -0,0 +1,4 @@
+import type { masReq, masRes } from "@/index";
+export default async (req: masReq, res: masRes) => {
+  res.return([1, 2]);
+};

package/test/src/api/person/set.ts

@@ -0,0 +1,4 @@
+import type { masReq, masRes } from "@/index";
+export default async (req: masReq, res: masRes) => {
+  res.return("hello set!");
+};

package/test/src/api/test.ts

@@ -0,0 +1,7 @@
+import type { masReq, masRes } from "@/index";
+export default async (req: masReq, res: masRes) => {
+  console.log(req.body, "@body");
+  console.log(req.query, "@query");
+
+  res.return("hello test!");
+};

package/test/src/api/validtest/boolArr.ts

@@ -0,0 +1,4 @@
+import type { masReq, masRes } from "@/index";
+export default async (req: masReq, res: masRes) => {
+  res.return("hello bool");
+};