@huangzongxin/elpis 0.0.0-stage → 1.0.0

package/.eslintignore

@@ -0,0 +1,3 @@
+node_modules/
+public/
+docs/

package/.eslintrc

@@ -0,0 +1,58 @@
+{
+  "ignorePatterns": ["docs/**/*.js"],
+  "extends": [
+    "plugin:vue/base",
+    "plugin:vue/recommended"
+  ],
+  "plugins": ["vue"],
+  "env": {
+    "browser": true,
+    "node": true
+  },
+  "parserOptions": {
+    "ecmaVersion": 2020,
+    "sourceType": "module"
+  },
+  "rules": {
+    "no-unused-vars": [2, {"args": "none"}],
+    "strict": "off",
+    "valid-jsdoc": "off",
+    "jsdoc/require-param-description": "off",
+    "jsdoc/require-param-type": "off",
+    "jsdoc/check-param-names": "off",
+    "jsdoc/require-param": "off",
+    "jsdoc/check-tag-names": "off",
+    "linebreak-style": "off",
+    "array-bracket-spacing": "off",
+    "prefer-promise-reject-errors": "off",
+    "comma-dangle": "off",
+    "newline-per-chained-call": "off",
+    "no-loop-func": "off",
+    "no-empty": "off",
+    "no-else-return": "off",
+    "no-unneeded-ternary": "off",
+    "no-eval": "off",
+    "prefer-destructuring": "off",
+    "no-param-reassign": "off",
+    "max-len": "off",
+    "no-restricted-syntax": "off",
+    "no-plusplus": "off",
+    "no-useless-escape": "off",
+    "no-nested-ternary": "off",
+    "radix": "off",
+    "arrow-body-style": "off",
+    "arrow-parens": "off",
+    "vue/multi-word-component-names": "off",
+    "vue/valid-v-for": "off",
+    "vue/no-multiple-template-root": "off",
+    "vue/max-attributes-per-line": ["warn", {
+      "singleline": 3,
+      "multiline": 1
+    }]
+  },
+  "globals": {
+    "$": true,
+    "axios": true,
+    "Vue": true
+  }
+}

package/.husky/pre-commit

@@ -0,0 +1,4 @@
+#!/usr/bin/env sh
+. "$(dirname -- "$0")/_/husky.sh"
+
+npm run lint

package/.vscode/settings.json

@@ -0,0 +1,5 @@
+{
+    "files.associations": {
+        "*.tpl": "html"
+    }
+}

package/README.md

@@ -1,3 +1,183 @@
-# Temporary Holding Version
-
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+model配置
+{
+mode: 'dashboard', // 模版类型，不同模版类型对应不一样的模版数据结构
+name: '', // 名称
+desc: '', // 描述
+icon: '', // icon
+homePage: '', // 首页(项目配置)
+// 头部菜单
+menu: [{
+key: '', // 菜单唯一描述，
+name: '', // 菜单名称
+menuType: '', // 枚举值：group / module
+
+    // 当 menuType == group 时，可填
+    subMenu: [{
+      // 可递归 menuItem
+    }, ...],
+
+    // 当 menuType == module 时，可填
+    moduleType: '', // 枚举值：sider/iframe/custom/schema
+
+    // 当 moduleType == sider 时
+    siderConfig: {
+      menu: [{
+        // 可递归 menuItem(除 moduleType === sider)
+      }, ...]
+    },
+
+    // 当 moduleType == iframe 时
+    iframeConfig: {
+      path: '', // iframe 路径
+    },
+
+    // 当 moduleType == custom 时
+    customConfig: {
+      path: '', // 自定义路由路径
+    },
+
+    // 当 moduleType == schema 时
+    schemaConfig: {
+      api: '', // 数据源API（遵循 RESTFUL 规范）
+      schema: { // 板块数据结构
+        type: 'object',
+        properties: {
+          key: {
+            ...schema, // 标准 schema 配置
+            type: '', // 字段类型
+            label: '', // 字段的中文名
+            // 字段在 table 中的相关配置
+            tableOption: {
+              ...elTableColumnConfig, // 标准 el-table-column 配置
+              toFixed: 0, // 保留小数点后几位
+              visible: true, // 默认为 true（false 时，表示不在表单中显示）
+            },
+            // 字段在 search-bar 中的相关配置
+            searchOption: {
+              ...eleComponentConfig, // 标准 el-component-column 配置
+              comType: '', // 配置组件类型 input/select/.....
+              default: '', // 默认值
+
+              // comType === 'select'
+              enumList: [], // 下拉框可选项
+
+              // comType === 'dynamicSelect'
+              api: ''
+            },
+            // 字段在不同动态 component 中的相关配置，前缀对应 componentComfig 中的键值
+            // 如：componentConfig.createForm，这里对应 createFormOption
+            // 字段在 createForm 中相关配置
+            createFormOption: {
+              ...eleComponentConfig, // 标准 el-component 配置
+              comType: '', // 控件类型 input/selct/input-number
+              visible: true, // 是否展示 (true/false)，默认为 true
+              disabled: false, // 是否禁用 (true/false)，默认为 false
+              default: '', // 默认值
+
+              // comType === 'select' 时生效
+              enumList: [] // 枚举列表
+            },
+            // 字段在 editForm 表单中的相关配置
+            editFormOption: {
+              ...eleComponentConfig, // 标准 el-component 配置
+              comType: '', // 控件类型 input/selct/input-number
+              visible: true, // 是否展示 (true/false)，默认为 true
+              disabled: false, // 是否禁用 (true/false)，默认为 false
+              default: '', // 默认值
+
+              // comType === 'select' 时生效
+              enumList: [] // 枚举列表
+            },
+            detailPanelOption: {
+              ...eleComponentConfig // 标准 el-component 配置
+            }
+          },
+          ...
+        },
+        required: [], // 标记哪些字段是必填项
+      },
+      // table 相关配置
+      tableConfig: {
+        headerButtons: [{
+          label: '', // 按钮中文名
+          eventKey: '', // 按钮事件名
+          // 按钮事件具体配置
+          eventOption: {
+            // 当 eventKey === 'showComponent'
+            comName: '' // 组件名称
+          },
+          ...elButtonConfig // 标准 el-button 配置
+        }, ...],
+        rowButtons: [{
+          label: '', // 按钮中文名
+          eventKey: '', // 按钮事件名
+          eventOption: {
+            // 当 eventKey === 'showComponent'
+            comName: '' // 组件名称
+
+            // 当 eventKey === 'remove'
+            params: {
+              // paramKey = 参数的键值
+              // rowValueKey = 参数值, 格式为 schema::tableKey，到 table 中找相应的字段
+              paramKey: rowValueKey
+            }
+          }, // 按钮事件具体配置
+          ...elButtonConfig // 标准 el-button 配置
+        }, ...]
+      },
+      // search-bar 相关配置
+      searchConfig: {},
+      // 动态组件 相关配置
+      componentConfig: {
+        // create-form 表单相关配置
+        createForm: {
+          title: '', // 表单标题
+          saveBtnText: '', // 保存按钮文案
+        },
+        // edit-form 表单相关配置
+        editForm: {
+          mainKey: '', // 表单主键，用于唯一标识要修改的数据对象
+          title: '', // 表单标题
+          saveBtnText: '', // 保存按钮文案
+        },
+        // detail-panel 相关配置
+        detailPanel: {
+          mainKey: '', // 表单主键，用于唯一标识要修改的数据对象
+          title: '', // 表单标题
+        }
+        // ...支持用户动态扩展
+      }
+    }
+
+}, ...]
+}
+服务端启动
+const {
+serverStart
+} = require('@fsiaonma/elpis');
+
+// 启动 elpis 服务
+const app = serverStart({});
+前端构建
+const { frontendBuild } = require('@fsiaonma/elpis');
+
+// 编译构建前端工程（签名不变）
+// local → Vite createServer :9002
+// production → Vite build → app/public/dist/prod
+frontendBuild(process.env.\_ENV);
+自定义页面扩展
+在 app/pages/ 目录下写入口 entry.xxx.js
+dashboard / custom-view 自定义页面扩展
+在 app/pages/dashboard/xxxx 下写页面
+dashboard / shcema-view / components 动态组件扩展
+在 app/pages/dashboard/complex-view/schema-view/components 下写组件
+配置到 app/pages/dashboard/complex-view/schema-view/components/component-config.js
+schema-form 控件扩展
+在 app/widgets/schema-form/complex-view 下写控件
+配置到 app/widgets/schema-form/form-item-config.js
+schema-search-bar 控件扩展
+在 app/widgets/schema-search-bar/complex-view 下写控件
+配置到 app/widgets/schema-search-bar/search-item-config.js
+
+
+

package/app/controller/base.js

@@ -0,0 +1,44 @@
+module.exports = (app) => class BaseController {
+    /**
+     * 基础控制器
+     * conttroller 基类
+     * 统一收拢 controller 相关的公共方法
+     */
+    constructor() {
+        this.app = app;
+        this.config = app.config;
+    }
+
+    /**
+     * API 处理成功响应统一返回结构
+     * @param {*} ctx koa 上下文
+     * @param {*} data 响应数据
+     * @param {*} metadata 元数据
+     * @returns 
+     */
+    success(ctx,data={}, metadata = {}) {
+        ctx.status = 200;
+        ctx.body = {
+            success:true,
+            data,
+            metadata
+        }
+    }
+
+
+    /**
+     * API 处理失败响应统一返回结构
+     * @param {*} ctx koa 上下文
+     * @param {*} message 错误消息
+     * @param {*} code 错误码
+     * @returns 
+     */
+    fail(ctx,message, code) {
+        ctx.body = {
+            success:false,
+            message,
+            code,
+        }
+    }
+
+}

package/app/controller/project.js

@@ -0,0 +1,62 @@
+module.exports = (app) => {
+  const BaseController = require("./base")(app);
+
+  return class ProjectController extends BaseController {
+    /*
+      根据proj_key 获取项目配置
+        */
+    get(ctx) {
+      const { proj_key: projKey } = ctx.request.query;
+      const { project: projectService } = app.service;
+      const projConfig = projectService.get(projKey);
+      if (!projConfig) {
+        this.fail(ctx, "获取项目异常", 50000);
+        return;
+      }
+      this.success(ctx, projConfig);
+    }
+    /*
+        获取当前projectKey 对应模型下的项目列表，（如果无projectKey，全量获取）
+     */
+    getList(ctx) {
+      const { proj_key: projKey } = ctx.request.query;
+      const { project: projectService } = app.service;
+      const projectList = projectService.getList({ projKey });
+
+      const dtoProjectList = projectList.map((item) => {
+        const { modelKey, key, name, desc, homePage } = item;
+        return { modelKey, key, name, desc, homePage };
+      });
+
+      this.success(ctx, dtoProjectList);
+    }
+
+    /*
+        获取所有模型与项目的结构化数据
+     */
+    async getModelList(ctx) {
+      const { project: projectService } = app.service;
+      const modleList = await projectService.getModelList();
+      //构造返回结果，只返回关键数据
+      const dtoModelList = modleList.reduce((preList, item) => {
+        const { model, project } = item;
+        //构造model关键数据
+        const { key, name, desc } = model;
+        const dtoModel = { key, name, desc };
+        //构造project  关键数据
+        const dtoProject = Object.keys(project).reduce((preObj, projKey) => {
+          const { key, name, desc, homePage } = project[projKey];
+          preObj[projKey] = { key, name, desc, homePage };
+          return preObj;
+        }, {});
+
+        preList.push({
+          model: dtoModel,
+          project: dtoProject,
+        });
+        return preList;
+      }, []);
+      this.success(ctx, dtoModelList);
+    }
+  };
+};

package/app/controller/view.js

@@ -0,0 +1,17 @@
+module.exports = (app) => {
+  // 渲染模板
+  return class ViewController {
+    async renderPage(ctx) {
+      const { query, body } = ctx.request;
+      app.logger.info(`[ViewController] query: ${JSON.stringify(query)}`);
+      app.logger.info(`[ViewController] body: ${JSON.stringify(body)}`);
+
+      await ctx.render(`dist/entry.${ctx.params.page}`, {
+        projKey: ctx.query?.proj_key,
+        name: app.options.name,
+        env: app.env.get(),
+        options: JSON.stringify(app.options),
+      });
+    }
+  };
+};

package/app/extend/logger.js

@@ -0,0 +1,38 @@
+const log4js = require('log4js');
+/**
+ * 日志记录器
+ * 外部调用 app.logger.info     app.logger.error
+ * @returns 日志记录器实例
+ */ 
+ module.exports = (app) => {
+    let logger ;
+    if(app.env.isLocal()){
+        // 打印在控制台即可
+        logger = console;
+    }else{
+        // 生产环境，八日至输出并落地到磁盘（日志落盘）
+        log4js.configure({
+            appenders: {
+                console: {
+                    type: 'console'
+                },
+                // 日志文件切分
+                dateFile: {
+                    type: 'dateFile',
+                    filename: './logs/application.log',
+                    pattern: '.yyyy-MM-dd'
+                }
+            },
+            categories: {
+                default: {
+                    appenders: ['dateFile','console'],
+                    level: 'trace'
+                }
+            }
+        });
+
+        logger = log4js.getLogger();
+    }
+
+    return logger;
+ }

package/app/middleware/api-params-verify.js

@@ -0,0 +1,71 @@
+const Ajv = require("ajv");
+const ajv = new Ajv();
+
+/**
+ * API参数验证中间件,合法性校验
+ */
+module.exports = (app) => {
+  //定义 json-schema 校验规则
+  const $schema = "http://json-schema.org/draft-07/schema#";
+  return async (ctx, next) => {
+    // 只对api请求进行参数校验
+    if (ctx.path.indexOf("/api/") < 0) {
+      return await next();
+    }
+
+    // 验证请求参数
+    const { query, body, headers } = ctx.request;
+    const { params, path, method } = ctx;
+
+    app.logger.info(`[${method}${path}] query: ${JSON.stringify(query)}`);
+    app.logger.info(`[${method}${path}] body: ${JSON.stringify(body)}`);
+    app.logger.info(`[${method}${path}] headers: ${JSON.stringify(headers)}`);
+    app.logger.info(`[${method}${path}] params: ${JSON.stringify(params)}`);
+
+    const schema = app.routerSchema[path]?.[method.toLowerCase()];
+    if (!schema) {
+      return await next();
+    }
+
+    let valid = true;
+
+    // ajv 校验请求参数 校验器
+    let validate;
+
+    // 校验 headers
+    if (valid && headers && schema.headers) {
+      schema.headers.$schema = $schema;
+      validate = ajv.compile(schema.headers);
+      valid = validate(headers);
+    }
+    // 校验 body
+    if (valid && body && schema.body) {
+      schema.body.$schema = $schema;
+      validate = ajv.compile(schema.body);
+      valid = validate(body);
+    }
+    // 校验 query
+    if (valid && query && schema.query) {
+      schema.query.$schema = $schema;
+      validate = ajv.compile(schema.query);
+      valid = validate(query);
+    }
+    // 校验 params
+    if (valid && params && schema.params) {
+      schema.params.$schema = $schema;
+      validate = ajv.compile(schema.params);
+      valid = validate(params);
+    }
+    if (!valid) {
+      ctx.status = 200;
+      ctx.body = {
+        success: false,
+        message: `request validate fail: ${ajv.errorsText(validate.errors)}`,
+        code: 442,
+      };
+      return;
+    }
+
+    await next();
+  };
+};

package/app/middleware/api-sign-verify.js

@@ -0,0 +1,35 @@
+const md5 = require("md5");
+/**
+ * API签名验证中间件,合法性校验
+ */
+
+module.exports = (app) => {
+  return async (ctx, next) => {
+    // 只对api请求进行校验
+    if (ctx.path.indexOf("/api") < 0) {
+      return await next();
+    }
+    const { path, method } = ctx;
+    const { headers } = ctx.request;
+    const { s_sign: sSgin, s_t: st } = headers;
+
+    const signKey = "ahjflkjcklvmlakdujsfwiujz123s"; //随便写的
+    const signature = md5(`${signKey}_${st}`);
+    app.logger.info(`[${method}${path}] signature: ${signature}`);
+    if (
+      !sSgin ||
+      !st ||
+      signature !== sSgin.toLowerCase() ||
+      Date.now() - st > 1000 * 600
+    ) {
+      ctx.status = 200;
+      ctx.body = {
+        success: false,
+        message: "signature not correct or api request timeout  !!",
+        code: 445,
+      };
+      return;
+    }
+    await next();
+  };
+};

package/app/middleware/error-handler.js

@@ -0,0 +1,33 @@
+/**
+ * 运行时 错误处理中间件 ，兜底所有异常
+ * @param {*} app 
+ * @returns 
+ */
+module.exports = (app) => {
+    return async (ctx,next) => {
+        try {
+            await next();
+        } catch (err) {
+            // 异常处理
+            const {status,message,detail} =err
+            app.logger.info(JSON.stringify(err))
+            app.logger.error('[-- exception --]:',err)
+            app.logger.error('[-- exception --]:',status , message , detail)
+
+            if(message && message.indexOf('template not found') > -1){
+                // 进行页面重定向  301:永久重定向  302:临时重定向
+                ctx.status = 302;
+                ctx.redirect(`${app.options?.homePage}`);
+                return;
+            }
+            const resBody = {
+                success:false,
+                code:50000,
+                message:"网络异常，请稍后重试",
+            }
+
+            ctx.status = 200;
+            ctx.body = resBody ;
+        }
+    }
+}

package/app/middleware/project-handler.js

@@ -0,0 +1,26 @@
+/**
+ * projectHandler  项目处理中间件
+ */
+module.exports = (app) => {
+  return async (ctx, next) => {
+    // 只对业务API 进行proj_key校验
+    if (ctx.path.indexOf("/api/proj/") < 0) {
+      return await next();
+    }
+    // 项目处理中间件
+    const { proj_key: projKey } = ctx.request.headers;
+
+    if (!projKey) {
+      ctx.status = 200;
+      ctx.body = {
+        success: false,
+        code: 446,
+        msg: "proj_key not found",
+      };
+      return;
+    }
+    ctx.projKey = projKey;
+
+    await next();
+  };
+};

package/app/middleware.js

@@ -0,0 +1,41 @@
+const path = require("path");
+const koaNunjucks = require("koa-nunjucks-2");
+
+module.exports = (app) => {
+  // 配置静态根目录
+  const koaStatic = require("koa-static");
+  app.use(koaStatic(path.resolve(process.cwd(), "./app/public")));
+
+  // 加载模板引擎
+  app.use(
+    koaNunjucks({
+      ext: "tpl",
+      path: path.resolve(process.cwd(), "./app/public"),
+      nunjucksConfig: {
+        noCache: true,
+        trimBlocks: true,
+      },
+    }),
+  );
+
+  // 引入ctx.body 解析中间件
+  const BodyParser = require("koa-bodyparser");
+  app.use(
+    BodyParser({
+      formList: "1000mb",
+      enableTypes: ["json", "form-data", "text"],
+    }),
+  );
+
+  // 引入错误处理中间件
+  app.use(app.middlewares.errorHandler);
+
+  // 引入API签名验证中间件
+  app.use(app.middlewares.apiSignVerify);
+
+  // 引入API参数验证中间件
+  app.use(app.middlewares.apiParamsVerify);
+
+  // 引入项目处理中间件
+  app.use(app.middlewares.projectHandler);
+};

package/app/pages/asserts/custom.css

@@ -0,0 +1,13 @@
+html,body {
+    margin: 0;
+    padding: 0;
+    height: 100%;
+}
+
+#root {
+    height: 100%;
+}
+
+input:-webkit-autofill {
+    -webkit-box-shadow: 0 0 0 1000px #121212 inset !important;
+}