@ibiz-template/runtime 0.0.4-beta.2 → 0.0.4-beta.4

package/src/controller/interface/common/button-state/i-button-state.ts

@@ -0,0 +1,93 @@
+/* eslint-disable @typescript-eslint/no-explicit-any */
+
+/**
+ * 按钮UI状态
+ *
+ * @author lxm
+ * @date 2022-10-13 19:10:30
+ * @export
+ * @interface IButtonState
+ */
+export interface IButtonState {
+  /**
+   * 是否禁用
+   *
+   * @author lxm
+   * @date 2022-10-13 19:10:17
+   * @type {boolean}
+   */
+  disabled: boolean;
+
+  /**
+   * 显示与否
+   *
+   * @author lxm
+   * @date 2022-09-28 10:09:58
+   * @type {boolean}
+   */
+  visible: boolean;
+
+  /**
+   * 是否显示loading状态
+   *
+   * @author lxm
+   * @date 2022-09-28 10:09:43
+   * @type {boolean}
+   */
+  loading: boolean;
+
+  /**
+   * 是否有权限
+   *
+   * @author lxm
+   * @date 2022-10-13 21:10:06
+   * @type {boolean}
+   */
+  permitted: boolean;
+
+  /**
+   * 按钮的唯一标识
+   *
+   * @author lxm
+   * @date 2022-10-13 21:10:15
+   * @type {string}
+   */
+  name: string;
+
+  // todo
+  /**
+   * 界面行为模型
+   *
+   * @author lxm
+   * @date 2022-10-13 21:10:24
+   * @type {IPSAppDEUIAction}
+   */
+  uiAction: any;
+
+  /**
+   * 无权限显示模式
+   *
+   * @author lxm
+   * @date 2022-10-13 22:10:43
+   * @type {('HIDDEN' | 'DISABLED')}
+   */
+  noPermissionMode: 'HIDDEN' | 'DISABLED';
+
+  /**
+   * 实体模型
+   *
+   * @author lxm
+   * @date 2022-10-13 21:10:19
+   * @type {AppEntityModel}
+   */
+  entity?: any;
+
+  /**
+   * 更新自身状态
+   *
+   * @author lxm
+   * @date 2022-10-13 21:10:09
+   * @param {IData} data 后台数据，可能不存在
+   */
+  update(data?: IData): void;
+}

package/src/controller/interface/common/button-state/index.ts

@@ -0,0 +1,2 @@
+export * from './i-button-state';
+export * from './i-button-container-state';

package/src/controller/interface/common/i-neuron-controller.ts

@@ -0,0 +1,14 @@
+/* eslint-disable @typescript-eslint/no-empty-interface */
+
+import { EventBase } from '../event';
+
+/**
+ * 适配神经元的控制器接口
+ * @author lxm
+ * @date 2023-03-30 07:10:34
+ * @export
+ * @interface INeuronController
+ */
+export interface INeuronController {
+  get eventArgs(): Omit<EventBase, 'eventName'>;
+}

package/src/controller/interface/common/index.ts

@@ -0,0 +1,3 @@
+export * from './actions-state';
+export * from './button-state';
+export * from './i-neuron-controller';

package/src/controller/interface/controller/i-controller.ts

@@ -0,0 +1,18 @@
+import { ControllerEvent } from '../../utils';
+
+/**
+ * 视图，部件控制器基类
+ * @author lxm
+ * @date 2023-04-25 09:56:33
+ * @export
+ * @interface IController
+ */
+export interface IController {
+  /**
+   * 事件触发器
+   * @author lxm
+   * @date 2023-04-25 09:57:40
+   * @type {ControllerEvent}
+   */
+  evt: ControllerEvent;
+}

package/src/controller/interface/controller/index.ts

@@ -0,0 +1,2 @@
+export * from './layout';
+export * from './i-controller';

package/src/controller/interface/controller/layout/i-layout-controller.ts

@@ -0,0 +1,61 @@
+/**
+ * 布局子成员的控制器通用属性
+ *
+ * @author lxm
+ * @date 2022-10-20 16:10:20
+ * @export
+ * @interface ILayoutController
+ */
+export interface ILayoutController {
+  /**
+   * 表单布局子成员会有，控制动态显示的
+   *
+   * @author lxm
+   * @date 2022-10-20 16:10:34
+   * @type {boolean}
+   */
+  visible?: boolean;
+
+  /**
+   * 布局宽度
+   *
+   * @author lxm
+   * @date 2022-10-20 17:10:26
+   * @type {string}
+   */
+  width: string;
+  /**
+   * 布局高度
+   *
+   * @author lxm
+   * @date 2022-10-20 17:10:33
+   * @type {string}
+   */
+  height: string;
+  /**
+   * 额外样式，对象格式
+   *
+   * @author lxm
+   * @date 2022-10-20 17:10:41
+   * @type {IData}
+   */
+  extraStyle: IData;
+  /**
+   * 额外类名
+   *
+   * @author lxm
+   * @date 2022-10-20 17:10:06
+   * @type {string}
+   */
+  extraClass: string;
+
+  /**
+   * 压制自身内容的样式
+   *
+   * @author lxm
+   * @date 2023-02-15 02:07:35
+   * @type {IData}
+   * @memberof ILayoutController
+   */
+  contentStyle: IData;
+}

package/src/controller/interface/controller/layout/index.ts

@@ -0,0 +1 @@
+export * from './i-layout-controller';

package/src/controller/interface/event/argument/close-view-event.ts

@@ -0,0 +1,20 @@
+import { EventBase } from './event-base';
+
+/**
+ * 关闭视图事件
+ * @author lxm
+ * @date 2023-03-26 02:07:11
+ * @export
+ * @interface CloseViewEvent
+ * @extends {EventBase}
+ */
+export interface CloseViewEvent extends EventBase {
+  /**
+   * 关闭模态窗时是否操作成功
+   *
+   * @author chitanda
+   * @date 2022-08-17 18:08:40
+   * @type {boolean}
+   */
+  ok: boolean;
+}

package/src/controller/interface/event/argument/data-change-event.ts

@@ -0,0 +1,11 @@
+import { EventBase } from './event-base';
+
+export interface DataChangeEvent extends EventBase {
+  /**
+   * 变更行为类型
+   * @author lxm
+   * @date 2023-03-26 01:24:06
+   * @type {('LOAD' | 'LOADDRAFT' | 'REMOVE' | 'SAVE' | string)}
+   */
+  actionType: 'LOAD' | 'LOADDRAFT' | 'REMOVE' | 'SAVE' | string;
+}

package/src/controller/interface/event/argument/event-base.ts

@@ -0,0 +1,106 @@
+import { CTX } from '../../../ctx';
+
+/**
+ * 事件参数
+ * @author lxm
+ * @date 2023-03-21 05:59:44
+ * @export
+ * @interface EventBase
+ */
+export interface EventBase {
+  /**
+   * 事件名称
+   * @author lxm
+   * @date 2023-03-23 03:12:27
+   * @type {string}
+   */
+  eventName: string;
+
+  /**
+   * 事件额外参数1
+   * @author lxm
+   * @date 2023-03-23 03:16:36
+   * @type {string}
+   */
+  eventArg?: string;
+
+  /**
+   * 事件额外参数2
+   * @author lxm
+   * @date 2023-03-23 03:16:36
+   * @type {string}
+   */
+  eventArg2?: string;
+
+  /**
+   * 触发事件的组件名称
+   * @author lxm
+   * @date 2023-03-23 03:15:24
+   * @type {string}
+   */
+  targetName: string;
+
+  /**
+   * 上下文
+   * @author lxm
+   * @date 2023-03-21 05:53:33
+   * @type {IContext}
+   */
+  context?: IContext;
+  /**
+   * 视图参数
+   * @author lxm
+   * @date 2023-03-21 05:54:23
+   * @type {IParams}
+   */
+  params?: IParams;
+
+  /**
+   * 事件涉及的数据集合
+   * @author lxm
+   * @date 2023-03-21 05:54:33
+   * @type {IDatum[]}
+   */
+  data?: IDatum[];
+
+  /**
+   * 原生JS事件对象
+   * @author lxm
+   * @date 2023-03-21 05:57:51
+   * @type {MouseEvent}
+   */
+  event?: MouseEvent;
+
+  // /**
+  //  * 当前上下文对应的神经元对象，可能是部件神经元也可能是视图神经元
+  //  * @author lxm
+  //  * @date 2023-03-21 05:58:31
+  //  * @type {Neuron}
+  //  */
+  // controller?: Neuron;
+
+  // /**
+  //  * 当前上下文对应的视图神经元对象
+  //  * @author lxm
+  //  * @date 2023-03-21 05:58:31
+  //  * @type {Neuron}
+  //  */
+  // view?: ViewNeuron;
+
+  /**
+   * 上下文环境对象
+   * @author lxm
+   * @date 2023-03-28 02:16:43
+   * @type {CTX}
+   */
+  ctx?: CTX;
+
+  /**
+   * 每个单独事件回调运行后需要事件触发位置处理的返回参数。
+   * 如果存在一定是个数组，存储复数的结果
+   * @author lxm
+   * @date 2023-03-26 11:25:48
+   * @type {IDatum[]}
+   */
+  result?: IDatum[];
+}

package/src/controller/interface/event/argument/index.ts

@@ -0,0 +1,5 @@
+export { EventBase } from './event-base';
+export { LoadEvent } from './load-event';
+export { DataChangeEvent } from './data-change-event';
+export { SetTitleEvent } from './set-title-event';
+export { CloseViewEvent } from './close-view-event';

package/src/controller/interface/event/argument/load-event.ts

@@ -0,0 +1,18 @@
+import { EventBase } from './event-base';
+
+/**
+ * 加载事件参数
+ * @author lxm
+ * @date 2023-03-21 05:59:44
+ * @export
+ * @interface EventBase
+ */
+export interface LoadEvent extends EventBase {
+  /**
+   * 是否是第一次加载
+   * @author lxm
+   * @date 2023-03-26 01:14:11
+   * @type {boolean}
+   */
+  isFirstLoad: boolean;
+}

package/src/controller/interface/event/argument/set-title-event.ts

@@ -0,0 +1,11 @@
+import { EventBase } from './event-base';
+
+export interface SetTitleEvent extends EventBase {
+  /**
+   * 设置的标题名称
+   * @author lxm
+   * @date 2023-03-26 02:02:16
+   * @type {string}
+   */
+  title: string;
+}

package/src/controller/interface/event/common/i-component-event.ts

@@ -0,0 +1,51 @@
+/* eslint-disable @typescript-eslint/no-explicit-any */
+import { EventBase } from '../argument';
+
+export type CompEventType<T> = {
+  [p in keyof T]: {
+    event: IParams;
+    emitArgs: undefined | IParams;
+  };
+};
+
+/**
+ * 组件通用生命周期事件
+ *
+ * @author lxm
+ * @date 2022-09-21 16:09:57
+ * @export
+ * @interface IComponentEvent
+ */
+export interface IComponentEvent {
+  /**
+   * 自身的准备工作完成(如模型加载，各种初始化，init结束)
+   *
+   * @author lxm
+   * @date 2022-09-21 16:09:28
+   */
+  onCreated: {
+    event: EventBase;
+    emitArgs: undefined;
+  };
+  /**
+   * 没有下级组件的created之后的那轮渲染结束就是
+   * 有下级的等所有下级mounted都抛出之后才算自己mounted
+   *
+   * @author lxm
+   * @date 2022-09-21 16:09:17
+   */
+  onMounted: {
+    event: EventBase;
+    emitArgs: undefined;
+  };
+  /**
+   * 自身组件被销毁时
+   *
+   * @author lxm
+   * @date 2022-09-21 16:09:26
+   */
+  onDestroyed: {
+    event: EventBase;
+    emitArgs: undefined;
+  };
+}

package/src/controller/interface/event/common/index.ts

@@ -0,0 +1 @@
+export * from './i-component-event';

package/src/controller/interface/event/control/i-app-menu-event.ts

@@ -0,0 +1,11 @@
+import { IControlEvent } from './i-control-event';
+
+/**
+ * 应用菜单事件
+ *
+ * @author lxm
+ * @date 2022-08-30 16:08:43
+ * @export
+ * @interface IAppMenuEvent
+ */
+export type IAppMenuEvent = IControlEvent;

package/src/controller/interface/event/control/i-card-event.ts

@@ -0,0 +1,11 @@
+import { IMDControlEvent } from './i-md-control-event';
+
+/**
+ * 卡片部件事件
+ *
+ * @author lxm
+ * @date 2022-08-30 16:08:43
+ * @export
+ * @interface IMDControlEvent
+ */
+export type ICardEvent = IMDControlEvent;

package/src/controller/interface/event/control/i-control-event.ts

@@ -0,0 +1,13 @@
+/* eslint-disable @typescript-eslint/no-empty-interface */
+
+import { IComponentEvent } from '../common/i-component-event';
+
+/**
+ * 部件通用事件
+ *
+ * @author lxm
+ * @date 2022-09-13 10:09:28
+ * @export
+ * @interface IControlEvent
+ */
+export interface IControlEvent extends IComponentEvent {}

package/src/controller/interface/event/control/i-dashboard-event.ts

@@ -0,0 +1,12 @@
+import { IControlEvent } from './i-control-event';
+
+/**
+ * 数据看板部件事件
+ *
+ * @author lxm
+ * @date 2022-09-10 16:09:58
+ * @export
+ * @interface IDashboardEvent
+ * @extends {IControlEvent}
+ */
+export type IDashboardEvent = IControlEvent;

package/src/controller/interface/event/control/i-edit-form-event.ts

@@ -0,0 +1,39 @@
+import { EventBase } from '../argument';
+import { IFormEvent } from './i-form-event';
+
+/**
+ * 编辑表单事件
+ *
+ * @author lxm
+ * @date 2022-08-30 16:08:43
+ * @export
+ * @interface IEditFormEvent
+ */
+export interface IEditFormEvent extends IFormEvent {
+  /**
+   * 保存结束后
+   *
+   * @author lxm
+   * @date 2022-10-10 15:10:46
+   * @param {boolean} isNewData 是否是新建数据
+   * @param {IData} data 保存后的数据
+   * @returns {*}  {Promise<void>}
+   */
+  onSaveSuccess: {
+    event: EventBase;
+    emitArgs: undefined;
+  };
+
+  /**
+   * 删除之后事件
+   *
+   * @author lxm
+   * @date 2022-11-15 18:11:07
+   * @param {IData} data 删除的数据
+   * @returns {*}  {Promise<void>}
+   */
+  onRemoveSuccess: {
+    event: EventBase;
+    emitArgs: undefined;
+  };
+}

package/src/controller/interface/event/control/i-form-event.ts

@@ -0,0 +1,11 @@
+import { IControlEvent } from './i-control-event';
+
+/**
+ * 表单事件
+ *
+ * @author lxm
+ * @date 2022-08-30 16:08:43
+ * @export
+ * @interface IFormEvent
+ */
+export type IFormEvent = IControlEvent;

package/src/controller/interface/event/control/i-grid-event.ts

@@ -0,0 +1,11 @@
+import { IMDControlEvent } from './i-md-control-event';
+
+/**
+ * 表格部件事件
+ *
+ * @author lxm
+ * @date 2022-08-30 16:08:43
+ * @export
+ * @interface IMDControlEvent
+ */
+export type IGridEvent = IMDControlEvent;

package/src/controller/interface/event/control/i-kanban-event.ts

@@ -0,0 +1,11 @@
+import { IMDControlEvent } from './i-md-control-event';
+
+/**
+ * 看板部件事件
+ *
+ * @author lxm
+ * @date 2022-08-30 16:08:43
+ * @export
+ * @interface IMDControlEvent
+ */
+export type IKanbanEvent = IMDControlEvent;

package/src/controller/interface/event/control/i-list-event.ts

@@ -0,0 +1,11 @@
+import { IMDControlEvent } from './i-md-control-event';
+
+/**
+ * 列表部件事件
+ *
+ * @author lxm
+ * @date 2022-08-30 16:08:43
+ * @export
+ * @interface IMDControlEvent
+ */
+export type IListEvent = IMDControlEvent;

package/src/controller/interface/event/control/i-md-control-event.ts

@@ -0,0 +1,91 @@
+import { OmitObject } from '@ibiz-template/core';
+import { EventBase, LoadEvent } from '../argument';
+import { IControlEvent } from './i-control-event';
+
+/**
+ * 多数据部件事件
+ *
+ * @author lxm
+ * @date 2022-08-30 16:08:43
+ * @export
+ * @interface IMDControlEvent
+ */
+export interface IMDControlEvent extends IControlEvent {
+  /**
+   * 加载前事件，返回值是视图参数
+   *
+   * @author lxm
+   * @date 2022-08-30 16:08:18
+   * @returns {*}  {IParams}
+   */
+  onBeforeLoad: {
+    event: EventBase;
+    emitArgs: undefined;
+  };
+
+  /**
+   * 数据激活事件
+   *
+   * @author lxm
+   * @date 2022-08-31 14:08:22
+   * @param {IData} data 激活的数据(单条)
+   */
+  onActive: {
+    event: EventBase;
+    emitArgs: { data: IDatum[] };
+  };
+
+  /**
+   * 选中数据变更事件
+   *
+   * @author lxm
+   * @date 2022-08-31 14:08:12
+   * @param {IDatum[]} selection 选中的数据集合
+   */
+  onSelectionChange: {
+    event: EventBase;
+    emitArgs: { data: IDatum[] };
+  };
+
+  /**
+   * 保存后处理事件
+   *
+   * @author lxm
+   * @date 2022-11-15 16:11:22
+   * @param {IDatum[]} data 保存的数据
+   * @param {boolean} isCreate 是否是新建
+   * @returns {*}  {Promise<void>}
+   */
+  onSaveSuccess: {
+    event: EventBase;
+    emitArgs: undefined;
+  };
+
+  /**
+   * 删除后处理事件
+   *
+   * @author lxm
+   * @date 2022-11-15 18:11:14
+   * @param {IDatum[]} data 删除的数据
+   * @returns {*}  {Promise<void>}
+   */
+  onRemoveSuccess: {
+    event: EventBase;
+    emitArgs: undefined;
+  };
+
+  /**
+   * 加载后处理事件
+   *
+   * @author lxm
+   * @date 2022-11-15 18:11:14
+   * @param {IDatum[]} data 加载回来的数据
+   * @param {boolean} isFirstLoad 是否是第一次加载
+   * @returns {*}  {Promise<void>}
+   * @memberof IMDControlEvent
+   */
+  onLoadSuccess: {
+    event: LoadEvent;
+    emitArgs: OmitObject<LoadEvent, EventBase>;
+  };
+}

package/src/controller/interface/event/control/i-panel-event.ts

@@ -0,0 +1,11 @@
+import { IControlEvent } from './i-control-event';
+
+/**
+ * 面板部件事件
+ *
+ * @author lxm
+ * @date 2022-08-30 16:08:43
+ * @export
+ * @interface IPanelEvent
+ */
+export type IPanelEvent = IControlEvent;