@byteluck-fe/model-driven-engine 2.10.0-alpha.20 → 2.11.0-alpha.0

package/README.md

@@ -1,30 +1,30 @@
-# Engine
-运行态引擎
-
-```
-│  index.ts // 入口文件
-│
-├─common // 引擎相关
-│      ActionManager.ts // utils操作管理
-│      checkerValue.ts // 表单值校验器
-│      DataManager.ts // 数据源容器
-│      Engine.ts // 引擎
-│      index.ts // 入口
-│      OkWorker.ts // 无用
-│      Plugin.ts // 插件
-│      proxyState.ts // 劫持引擎表单数据
-│      Runtime.ts // 控件注册和创建
-│      Store.ts // 数据管理
-│
-├─plugins
-│      CalcPlugin.ts // 计算公式插件
-│      ControlsEventPlugin.ts // 控件二开事件插件
-│      ES6ModulePlugin.ts //
-│      index.ts
-│      LifecycleEventPlugin.ts // 页面生命周期事件
-│      StylePlugin.ts // css二开
-│
-└─utils
-        index.ts
-        runtimeUtils.ts // 工具函数
-```
+# Engine
+运行态引擎
+
+```
+│  index.ts // 入口文件
+│
+├─common // 引擎相关
+│      ActionManager.ts // utils操作管理
+│      checkerValue.ts // 表单值校验器
+│      DataManager.ts // 数据源容器
+│      Engine.ts // 引擎
+│      index.ts // 入口
+│      OkWorker.ts // 无用
+│      Plugin.ts // 插件
+│      proxyState.ts // 劫持引擎表单数据
+│      Runtime.ts // 控件注册和创建
+│      Store.ts // 数据管理
+│
+├─plugins
+│      CalcPlugin.ts // 计算公式插件
+│      ControlsEventPlugin.ts // 控件二开事件插件
+│      ES6ModulePlugin.ts //
+│      index.ts
+│      LifecycleEventPlugin.ts // 页面生命周期事件
+│      StylePlugin.ts // css二开
+│
+└─utils
+        index.ts
+        runtimeUtils.ts // 工具函数
+```

package/dist/esm/common/ActionManager.js

@@ -186,11 +186,11 @@ export var ActionManager = /*#__PURE__*/ function() {
         _class_call_check(this, ActionManager);
         _define_property(this, "actionMap", new Map());
         _define_property(this, "buildinActions", {});
-        /**
-   * 执行action的时候，作为第二个参数传递给方法，可以通过外部挂载
+        /**
+   * 执行action的时候，作为第二个参数传递给方法，可以通过外部挂载
    */ _define_property(this, "actionUtils", {});
-        /**
-   * 用于存储es module解析出来的源码，CustomVueControlPlugin
+        /**
+   * 用于存储es module解析出来的源码，CustomVueControlPlugin
    */ _define_property(this, "sources", {});
     }
     _create_class(ActionManager, [

package/dist/esm/common/Engine.js

@@ -978,9 +978,9 @@ var Engine = /*#__PURE__*/ function(Watcher) {
             }
         },
         {
-            /**
-   * 设置payload的options，提供在不是使用标准api修改state的时候可以传递options，会在本次任务执行完成之后清空
-   * @param options 需要携带的options
+            /**
+   * 设置payload的options，提供在不是使用标准api修改state的时候可以传递options，会在本次任务执行完成之后清空
+   * @param options 需要携带的options
    * */ key: "setPayloadOptions",
             value: function setPayloadOptions(options) {
                 eventOptionsTemp = options;
@@ -997,9 +997,9 @@ var Engine = /*#__PURE__*/ function(Watcher) {
             }
         },
         {
-            /**
-   * 向Store设置一组值，明细表必须全量赋值，并触发事件（触发事件是根据组件在页面中的顺序逐个触发）
-   * @param states
+            /**
+   * 向Store设置一组值，明细表必须全量赋值，并触发事件（触发事件是根据组件在页面中的顺序逐个触发）
+   * @param states
    */ key: "setStates",
             value: function setStates(states, rowIndex, options) {
                 var _this = this;
@@ -1026,11 +1026,11 @@ var Engine = /*#__PURE__*/ function(Watcher) {
             }
         },
         {
-            /**
-   * 通过dataCode和fieldCode来获取控件的值
-   * @param dataCode 模型编码 - 如果是主表的话就是主表的模型编码，明细子表的话就是子表的模型编码
-   * @param fieldCode 字段编码 - 控件绑定的数据项的编码
-   * @param rowIndex 行下标 - 如果是明细子表中的控件需要提供
+            /**
+   * 通过dataCode和fieldCode来获取控件的值
+   * @param dataCode 模型编码 - 如果是主表的话就是主表的模型编码，明细子表的话就是子表的模型编码
+   * @param fieldCode 字段编码 - 控件绑定的数据项的编码
+   * @param rowIndex 行下标 - 如果是明细子表中的控件需要提供
    * */ key: "getField",
             value: function getField(dataCode, fieldCode, rowIndex) {
                 if (!fieldCode) {
@@ -1141,13 +1141,13 @@ var Engine = /*#__PURE__*/ function(Watcher) {
             }
         },
         {
-            /**
-   * 通过dataCode和fieldCode来设置控件的值
-   * @param dataCode 模型编码 - 如果是主表的话就是主表的模型编码，明细子表的话就是子表的模型编码
-   * @param fieldCode 字段编码 - 控件绑定的数据项的编码
-   * @param value 修改的值
-   * @param rowIndex 行下标 - 如果是明细子表中的控件需要提供
-   * @param options 触发事件携带的参数
+            /**
+   * 通过dataCode和fieldCode来设置控件的值
+   * @param dataCode 模型编码 - 如果是主表的话就是主表的模型编码，明细子表的话就是子表的模型编码
+   * @param fieldCode 字段编码 - 控件绑定的数据项的编码
+   * @param value 修改的值
+   * @param rowIndex 行下标 - 如果是明细子表中的控件需要提供
+   * @param options 触发事件携带的参数
    * */ key: "setField",
             value: function setField(dataCode, fieldCode, value, rowIndex, options) {
                 var dataBindMapping = this.getDataBindMapping(dataCode, fieldCode);
@@ -1175,12 +1175,12 @@ var Engine = /*#__PURE__*/ function(Watcher) {
             }
         },
         {
-            /**
-   * 通过dataCode和 state来给一组控件赋值，并触发事件携带options
-   * @param dataCode 需要赋值的目标模型
-   * @param state 赋值对象，以fieldCode为key组成的对象
-   * @param rowIndex 行下标，给明细子表赋值时指定赋值某行
-   * @param options 触发事件携带的参数
+            /**
+   * 通过dataCode和 state来给一组控件赋值，并触发事件携带options
+   * @param dataCode 需要赋值的目标模型
+   * @param state 赋值对象，以fieldCode为key组成的对象
+   * @param rowIndex 行下标，给明细子表赋值时指定赋值某行
+   * @param options 触发事件携带的参数
    * */ key: "setFields",
             value: function setFields(dataCode, state, rowIndex, options) {
                 var _this = this;
@@ -1221,10 +1221,10 @@ var Engine = /*#__PURE__*/ function(Watcher) {
             }
         },
         {
-            /**
-   * 通过dataCode来将state转化为标准的state结构
-   * @param dataCode 需要转换的目标模型code
-   * @param state 值对象，以fieldCode为key组成的对象
+            /**
+   * 通过dataCode来将state转化为标准的state结构
+   * @param dataCode 需要转换的目标模型code
+   * @param state 值对象，以fieldCode为key组成的对象
    * */ key: "buildFields",
             value: function buildFields(dataCode, state) {
                 var _this = this;
@@ -1265,10 +1265,10 @@ var Engine = /*#__PURE__*/ function(Watcher) {
             }
         },
         {
-            /**
-   * 向Store设置一组值，并触发事件携带options
-   * @param dataSet
-   * @options 传递给关联事件中 EventPayload中的options，一般在plugin中监听使用
+            /**
+   * 向Store设置一组值，并触发事件携带options
+   * @param dataSet
+   * @options 传递给关联事件中 EventPayload中的options，一般在plugin中监听使用
    */ key: "setData",
             value: function setData(dataSet, options) {
                 var _this = this;
@@ -1405,19 +1405,19 @@ var Engine = /*#__PURE__*/ function(Watcher) {
             }
         },
         {
-            /**
-   * 获取控件的dataBind
-   * @param controlId
+            /**
+   * 获取控件的dataBind
+   * @param controlId
    * */ key: "getDataBind",
             value: function getDataBind(controlId) {
                 return this.store.getDataBind(controlId);
             }
         },
         {
-            /**
-   * 获取组件实例，传入rowIndex代表获取明细表内的控件实例，rowIndex传入-1代表获取表头内的实例
-   * @param controlId
-   * @param rowIndex
+            /**
+   * 获取组件实例，传入rowIndex代表获取明细表内的控件实例，rowIndex传入-1代表获取表头内的实例
+   * @param controlId
+   * @param rowIndex
    */ key: "getInstance",
             value: function getInstance(controlId, rowIndex) {
                 var instances = this.getInstances(controlId, rowIndex === -1);
@@ -1436,10 +1436,10 @@ var Engine = /*#__PURE__*/ function(Watcher) {
             }
         },
         {
-            /**
-   * 获取组件实例，明细表中的组件将会得到数组, 第二个参数为(false/不传入)则获取到的是明细表内不包含表头内实例的所有控件实例，传入true则获取到包含表头内实例的所有控件实例,表头内实例永远在下标0的位置
-   * @param controlId
-   * @param header 明细表内是否获取表头的控件
+            /**
+   * 获取组件实例，明细表中的组件将会得到数组, 第二个参数为(false/不传入)则获取到的是明细表内不包含表头内实例的所有控件实例，传入true则获取到包含表头内实例的所有控件实例,表头内实例永远在下标0的位置
+   * @param controlId
+   * @param header 明细表内是否获取表头的控件
    */ // getInstances(
             //   controlId?: string,
             //   header: boolean = false
@@ -1611,27 +1611,27 @@ var Engine = /*#__PURE__*/ function(Watcher) {
         },
         {
             key: "assertInstance",
-            value: /**
-   * 判断控件的类型，返回当前控件的正确类型
+            value: /**
+   * 判断控件的类型，返回当前控件的正确类型
    * */ function assertInstance(instance, types) {
                 return isString(types) ? instance.type === types : types.includes(instance.type);
             }
         },
         {
             key: "assertInstanceIsCustomControl",
-            value: /**
-   * 判断控件或控件类型是一个自定义控件
+            value: /**
+   * 判断控件或控件类型是一个自定义控件
    * */ function assertInstanceIsCustomControl(instance) {
                 return !isBuiltInControls(isString(instance) ? instance : instance.type);
             }
         },
         {
             key: "getInstanceRowIndex",
-            value: /**
-   * 获取控件在明细子表中的行下标，
-   * 如果控件在表头内，则返回-1
-   * 如果控件在表内，则返回行下标
-   * 如果控件不在明细表内，则返回undefined
+            value: /**
+   * 获取控件在明细子表中的行下标，
+   * 如果控件在表头内，则返回-1
+   * 如果控件在表内，则返回行下标
+   * 如果控件不在明细表内，则返回undefined
    * */ // public getInstanceRowIndex(
             //   instance: ControlRuntimeInstance<ControlsKeys> | RuntimeControl
             // ) {

package/dist/esm/common/Runtime.js

@@ -301,8 +301,8 @@ function loop(control, parentId, callback) {
 function hasHeaderOrFooterControl(control, checkType) {
     return checkType in control.props && isArray(control.props[checkType]);
 }
-/**
- * 控件是否在视图中隐藏，遍历查找所有parent
+/**
+ * 控件是否在视图中隐藏，遍历查找所有parent
  * */ function getControlIsHide(control) {
     if (control.props.isHide) {
         return true;

package/dist/esm/common/Store.js

@@ -69,10 +69,10 @@ var Store = /*#__PURE__*/ function() {
     }
     _create_class(Store, [
         {
-            /**
-   * 使用该方法仅改变数据，不会表单触发事件。明细表可全量赋值也可根据rowIndex进行单独设置
-   * @param controlId 组件ID
-   * @param value
+            /**
+   * 使用该方法仅改变数据，不会表单触发事件。明细表可全量赋值也可根据rowIndex进行单独设置
+   * @param controlId 组件ID
+   * @param value
    */ key: "setState",
             value: function setState(controlId, value, rowIndex) {
                 var _this = this;

package/dist/esm/common/proxyState.js

@@ -101,11 +101,11 @@ function ArrayHandler(target, propertyKey, value, thisKey, callback) {
         }
     }
 }
-/**
- * 返回proxy操作对象
- * @param thisKey 当前对象在上级中的key
- * @param callback 需要在修改的时候，触发的回调函数
- * @param beforeSetCallback 需要在修改之前触发的回调函数，可以进行校验和对值的修改等等，最终的返回值不为undefined就会使用
+/**
+ * 返回proxy操作对象
+ * @param thisKey 当前对象在上级中的key
+ * @param callback 需要在修改的时候，触发的回调函数
+ * @param beforeSetCallback 需要在修改之前触发的回调函数，可以进行校验和对值的修改等等，最终的返回值不为undefined就会使用
  * */ function handler(thisKey, callback, beforeSetCallback) {
     return {
         __engineProxy__: true,
@@ -179,12 +179,12 @@ function ArrayHandler(target, propertyKey, value, thisKey, callback) {
         }
     };
 }
-/**
- * 代理state数据
- * @param state 数据对象
- * @param callback 触发set时候的回调函数
- * @param beforeSetCallback
- * @param prevKey 递归对象的key
+/**
+ * 代理state数据
+ * @param state 数据对象
+ * @param callback 触发set时候的回调函数
+ * @param beforeSetCallback
+ * @param prevKey 递归对象的key
  * */ export function proxyState(state, callback, beforeSetCallback) {
     var prevKey = arguments.length > 3 && arguments[3] !== void 0 ? arguments[3] : "";
     // 冻结的对象不需要再执行proxy，否则会报错
@@ -212,10 +212,10 @@ function flatInstanceForChildren(controls) {
     });
     return result;
 }
-/**
- * 在flatInstance中通过key查找出对应的instance
- * @param flatInstance 拍平的instance数组
- * @param key 操作的数据在state的key - 可以是深层次的 subtable.0.input等
+/**
+ * 在flatInstance中通过key查找出对应的instance
+ * @param flatInstance 拍平的instance数组
+ * @param key 操作的数据在state的key - 可以是深层次的 subtable.0.input等
  * */ export function findItem(flatInstance, key, instanceMap) {
     if (key === "") return undefined;
     var keys = key.split(".");
@@ -272,9 +272,9 @@ function getArrayNewArgs(type, args, value) {
         return args.slice(0, 2).concat(value);
     }
 }
-/**
- * TODO 数组劫持操作需要模仿vue3进行重构，不再直接劫持原生property
- * 劫持数组api，达到操作数组api的时候，可以同步操作instance
+/**
+ * TODO 数组劫持操作需要模仿vue3进行重构，不再直接劫持原生property
+ * 劫持数组api，达到操作数组api的时候，可以同步操作instance
  * */ function hijackArrayProperty() {
     proxyArrayApi.forEach(function(key) {
         var oldApiHandler = Array.prototype[key];

package/dist/esm/plugins/CalcPlugin.js

@@ -59,11 +59,11 @@ import { CONTROL_TYPE, CALC_TOKEN_TYPE, CALC_AGGREGATE_TYPE } from "@byteluck-fe
 import { format } from "mathjs";
 var DisplayType;
 (function(DisplayType) {
-    /**
-   * 完全等于
+    /**
+   * 完全等于
    */ DisplayType["EQ"] = "EQ";
-    /**
-   * 包含
+    /**
+   * 包含
    * */ DisplayType["IN"] = "IN";
 })(DisplayType || (DisplayType = {}));
 export var CalcPlugin = /*#__PURE__*/ function() {
@@ -72,16 +72,16 @@ export var CalcPlugin = /*#__PURE__*/ function() {
         _class_call_check(this, CalcPlugin);
         _define_property(this, "engine", void 0);
         _define_property(this, "options", void 0);
-        /**
-   * 所有的计算公式控件
+        /**
+   * 所有的计算公式控件
    * */ // @ts-ignore
         _define_property(this, "calcControls", []);
-        /**
-   * key=控件id  value=控件修改后需要触发重新计算的计算公式控件组成的数组
-   * 存储为一个Map，用于在控件change的时候，重新计算依赖的calc
+        /**
+   * key=控件id  value=控件修改后需要触发重新计算的计算公式控件组成的数组
+   * 存储为一个Map，用于在控件change的时候，重新计算依赖的calc
    * */ _define_property(this, "dependenciesTriggerMap", new Map());
-        /**
-   * 隐藏以后需要被计算的控件
+        /**
+   * 隐藏以后需要被计算的控件
    * */ _define_property(this, "hideNotRememberControlIds", []);
         _define_property(this, "dontHasPermissionControlIds", []);
         _define_property(this, "cacheComputedResult", {});
@@ -92,8 +92,8 @@ export var CalcPlugin = /*#__PURE__*/ function() {
     _create_class(CalcPlugin, [
         {
             key: "getNeedHideRememberControlIds",
-            value: /**
-   * @description 获取显隐控制的需要被记住值的控件id
+            value: /**
+   * @description 获取显隐控制的需要被记住值的控件id
    * */ function getNeedHideRememberControlIds() {
                 var _this_options;
                 if (!((_this_options = this.options) === null || _this_options === void 0 ? void 0 : _this_options.displayBoList)) {
@@ -110,8 +110,8 @@ export var CalcPlugin = /*#__PURE__*/ function() {
         },
         {
             key: "getDontHasPermissionControlIds",
-            value: /**
-   * @description 获取权限控制的隐藏的字段，不需要参与计算
+            value: /**
+   * @description 获取权限控制的隐藏的字段，不需要参与计算
    * */ function getDontHasPermissionControlIds() {
                 var _this_options;
                 if (!((_this_options = this.options) === null || _this_options === void 0 ? void 0 : _this_options.behavior)) {
@@ -127,9 +127,9 @@ export var CalcPlugin = /*#__PURE__*/ function() {
         },
         {
             key: "controlNeedComputedValue",
-            value: /**
-   * @description 判断控件是否需要被计算
-   * @param control 控件
+            value: /**
+   * @description 判断控件是否需要被计算
+   * @param control 控件
    * */ function controlNeedComputedValue(control) {
                 if (!control) {
                     return false;
@@ -149,9 +149,9 @@ export var CalcPlugin = /*#__PURE__*/ function() {
         },
         {
             key: "getControlIsHide",
-            value: /**
-   * @description 获取控件是否被隐藏
-   * @param control 控件
+            value: /**
+   * @description 获取控件是否被隐藏
+   * @param control 控件
    * */ function getControlIsHide(control) {
                 if (control.props.isHide) {
                     return true;
@@ -180,8 +180,8 @@ export var CalcPlugin = /*#__PURE__*/ function() {
         },
         {
             key: "resetDependencies",
-            value: /**
-   * @description 重置依赖，获取所有的计算公式控件，并根据计算公式获取控件依赖关系
+            value: /**
+   * @description 重置依赖，获取所有的计算公式控件，并根据计算公式获取控件依赖关系
    * */ function resetDependencies() {
                 this.calcControls = [];
                 this.dependenciesTriggerMap.clear();
@@ -191,8 +191,8 @@ export var CalcPlugin = /*#__PURE__*/ function() {
         },
         {
             key: "allCalcControlComputed",
-            value: /**
-   * @description 执行所有计算公式控件的计算
+            value: /**
+   * @description 执行所有计算公式控件的计算
    * */ function allCalcControlComputed() {
                 var _this = this;
                 this.calcControls.forEach(function(item) {
@@ -206,8 +206,8 @@ export var CalcPlugin = /*#__PURE__*/ function() {
         },
         {
             key: "getAllCalcControl",
-            value: /**
-   * @description 获取所有的计算公式控件
+            value: /**
+   * @description 获取所有的计算公式控件
    * */ function getAllCalcControl() {
                 this.calcControls = this.engine.runtime.flatInstances.filter(// @ts-ignore
                 function(item) {
@@ -217,8 +217,8 @@ export var CalcPlugin = /*#__PURE__*/ function() {
         },
         {
             key: "getCalcDependencies",
-            value: /**
-   * @description 获取计算公式控件依赖，组成 依赖=>[计算公式] 的Map结构
+            value: /**
+   * @description 获取计算公式控件依赖，组成 依赖=>[计算公式] 的Map结构
    * */ function getCalcDependencies() {
                 var _this = this;
                 this.calcControls.forEach(function(item) {
@@ -270,8 +270,8 @@ export var CalcPlugin = /*#__PURE__*/ function() {
         },
         {
             key: "watchSchemaHideChange",
-            value: /**
-   * @description 监听控件的显隐事件，把显隐会影响的控件触发一遍计算
+            value: /**
+   * @description 监听控件的显隐事件，把显隐会影响的控件触发一遍计算
    * */ function watchSchemaHideChange() {
                 var _this = this;
                 this.engine.on("schema-change", function(payload) {
@@ -287,8 +287,8 @@ export var CalcPlugin = /*#__PURE__*/ function() {
         },
         {
             key: "watchSubtableChange",
-            value: /**
-   * @description 监听明细子表的change事件，把明细表会影响的控件触发一遍计算
+            value: /**
+   * @description 监听明细子表的change事件，把明细表会影响的控件触发一遍计算
    * */ function watchSubtableChange() {
                 var _this = this;
                 this.engine.on("list-change", function(payload) {
@@ -315,8 +315,8 @@ export var CalcPlugin = /*#__PURE__*/ function() {
         },
         {
             key: "watchControlChange",
-            value: /**
-   * @description 监听控件的change事件，当控件change的时候，取到控件会影响的计算公式，然后执行对应的计算
+            value: /**
+   * @description 监听控件的change事件，当控件change的时候，取到控件会影响的计算公式，然后执行对应的计算
    * */ function watchControlChange() {
                 var _this = this;
                 this.engine.on("change", function(payload) {
@@ -351,8 +351,8 @@ export var CalcPlugin = /*#__PURE__*/ function() {
         },
         {
             key: "controlInSubtable",
-            value: /**
-   * @description 控件在明细子表内
+            value: /**
+   * @description 控件在明细子表内
    * */ function controlInSubtable(control) {
                 var _control_parent;
                 return ((_control_parent = control.parent) === null || _control_parent === void 0 ? void 0 : _control_parent.type) === CONTROL_TYPE.SUBTABLE_COLUMN;
@@ -360,8 +360,8 @@ export var CalcPlugin = /*#__PURE__*/ function() {
         },
         {
             key: "computedCalcValue",
-            value: /**
-   * @description 执行计算公式的计算
+            value: /**
+   * @description 执行计算公式的计算
    * */ // @ts-ignore
             function computedCalcValue(control) {
                 var _this = this;
@@ -451,8 +451,8 @@ export var CalcPlugin = /*#__PURE__*/ function() {
         },
         {
             key: "getNumberValue",
-            value: /**
-   * @description 获取数字值，因为计算公式可以依赖计算公式和金额，所以需要从value中取到对应的值
+            value: /**
+   * @description 获取数字值，因为计算公式可以依赖计算公式和金额，所以需要从value中取到对应的值
    * */ function getNumberValue(value) {
                 if (typeof value === "object" && value) {
                     if ("result" in value) {
@@ -469,8 +469,8 @@ export var CalcPlugin = /*#__PURE__*/ function() {
         },
         {
             key: "getAggregateTypeValue",
-            value: /**
-   * 计算明细子表最大值最小值平均值总和
+            value: /**
+   * 计算明细子表最大值最小值平均值总和
    * */ function getAggregateTypeValue(values, type) {
                 if (!type || !values || !values.length) return 0;
                 switch(type){