@ibiz-template/runtime 0.0.4-beta.3 → 0.0.4-beta.5

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

@@ -0,0 +1,77 @@
+import { IAppView } from '@ibiz/model-core';
+import { IViewEngine } from '../../../../engine';
+import { IControlProvider, IModal, IModalData } from '../../../../interface';
+import { IViewState } from '../../state';
+import { IController } from '../i-controller';
+
+/**
+ * 视图控制器接口
+ * @author lxm
+ * @date 2023-05-04 01:36:05
+ * @export
+ * @interface IViewController
+ * @extends {IController}
+ */
+export interface IViewController<
+  T extends IAppView = IAppView,
+  S extends IViewState = IViewState,
+> extends IController<T, S> {
+  /**
+   * 视图呈现模式
+   * @author lxm
+   * @date 2023-05-06 07:02:22
+   * @type {IModal}
+   */
+  modal: IModal;
+
+  /**
+   * 所有部件的适配器
+   *
+   * @author lxm
+   * @date 2022-08-24 20:08:07
+   * @type {{ [key: string]: IControlProvider }}
+   */
+  providers: { [key: string]: IControlProvider };
+
+  /**
+   * 视图引擎集合
+   * @author lxm
+   * @date 2023-05-06 07:48:47
+   * @type {IViewEngine[]}
+   */
+  engines: IViewEngine[];
+
+  /**
+   * 关闭视图
+   *
+   * @author lxm
+   * @date 2022-08-29 01:08:50
+   */
+  closeView(modalData?: IModalData): Promise<void>;
+
+  /**
+   * 执行视图预置界面行为能力
+   * @author lxm
+   * @date 2023-05-08 10:30:36
+   * @param {string} key 预置界面行为tag标识
+   * @param {...any[]} args 预置界面行为需要的参数
+   * @return {*}  {Promise<any>}
+   */
+  call<A extends IData>(key: string, args?: A): Promise<IData | null>;
+
+  /**
+   * 开启视图loading
+   *
+   * @author lxm
+   * @date 2022-09-19 14:09:00
+   */
+  startLoading(): void;
+
+  /**
+   *关闭视图loading
+   *
+   * @author lxm
+   * @date 2022-09-19 14:09:09
+   */
+  endLoading(): void;
+}

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

@@ -1,4 +1,5 @@
-import { CTX } from '../../../ctx';
+import { IUILogicParams } from '../../../../interface';
+import { IController } from '../../controller';
 
 /**
  * 事件参数
@@ -7,7 +8,7 @@ import { CTX } from '../../../ctx';
  * @export
  * @interface EventBase
  */
-export interface EventBase {
+export interface EventBase extends IUILogicParams {
   /**
    * 事件名称
    * @author lxm
@@ -41,59 +42,13 @@ export interface EventBase {
   targetName: string;
 
   /**
-   * 上下文
+   * todo 没用的话后期删掉
+   * 事件触发源对应的控制器
    * @author lxm
-   * @date 2023-03-21 05:53:33
-   * @type {IContext}
+   * @date 2023-05-06 05:48:42
+   * @type {IController}
    */
-  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;
+  controller: IController;
 
   /**
    * 每个单独事件回调运行后需要事件触发位置处理的返回参数。

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

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

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

@@ -0,0 +1,19 @@
+import { EventBase } from './event-base';
+
+/**
+ * 界面行为执行事件
+ * @author lxm
+ * @date 2023-05-08 08:25:30
+ * @export
+ * @interface UIActionEvent
+ * @extends {EventBase}
+ */
+export interface UIActionEvent extends EventBase {
+  /**
+   * 界面行为标识
+   * @author lxm
+   * @date 2023-03-26 02:02:16
+   * @type {string}
+   */
+  actionId: string;
+}

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

@@ -0,0 +1,19 @@
+import { EventBase } from './event-base';
+
+export interface ViewInfoEvent extends EventBase {
+  /**
+   * 视图标题名称
+   * @author lxm
+   * @date 2023-03-26 02:02:16
+   * @type {string}
+   */
+  caption?: string;
+
+  /**
+   * 视图信息栏文本
+   * @author lxm
+   * @date 2023-05-10 09:05:17
+   * @type {string}
+   */
+  dataInfo?: string;
+}

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

@@ -1,3 +1,4 @@
+import { EventBase } from '../argument';
 import { IControlEvent } from './i-control-event';
 
 /**
@@ -8,4 +9,16 @@ import { IControlEvent } from './i-control-event';
  * @export
  * @interface IAppMenuEvent
  */
-export type IAppMenuEvent = IControlEvent;
+export interface IAppMenuEvent extends IControlEvent {
+  /**
+   * 菜单点击事件
+   * @author lxm
+   * @date 2023-03-26 06:15:06
+   * @param {EventBase} event
+   * @return {*}  {Promise<void>}
+   */
+  onClick: {
+    event: EventBase;
+    emitArgs: { eventArg: string; event: MouseEvent };
+  };
+}

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

@@ -1,5 +1,7 @@
 /* eslint-disable @typescript-eslint/no-empty-interface */
 
+import { PartialWithObject } from '@ibiz-template/core';
+import { EventBase, UIActionEvent } from '../argument';
 import { IComponentEvent } from '../common/i-component-event';
 
 /**
@@ -10,4 +12,16 @@ import { IComponentEvent } from '../common/i-component-event';
  * @export
  * @interface IControlEvent
  */
-export interface IControlEvent extends IComponentEvent {}
+export interface IControlEvent extends IComponentEvent {
+  /**
+   * 界面行为执行事件
+   * @author lxm
+   * @date 2023-03-26 06:15:06
+   * @param {UIActionEvent} event
+   * @return {*}  {Promise<void>}
+   */
+  onUIAction: {
+    event: UIActionEvent;
+    emitArgs: PartialWithObject<UIActionEvent, EventBase>;
+  };
+}

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

@@ -1,4 +1,4 @@
-import { OmitObject } from '@ibiz-template/core';
+import { PartialWithObject } from '@ibiz-template/core';
 import { EventBase, LoadEvent } from '../argument';
 import { IControlEvent } from './i-control-event';
 
@@ -86,6 +86,6 @@ export interface IMDControlEvent extends IControlEvent {
    */
   onLoadSuccess: {
     event: LoadEvent;
-    emitArgs: OmitObject<LoadEvent, EventBase>;
+    emitArgs: PartialWithObject<LoadEvent, EventBase>;
   };
 }

package/src/controller/interface/event/view/i-edit-view-event.ts

@@ -1,4 +1,4 @@
-import { OmitObject } from '@ibiz-template/core';
+import { PartialWithObject } from '@ibiz-template/core';
 import { DataChangeEvent, EventBase } from '../argument';
 import { IViewEvent } from './i-view-event';
 
@@ -20,6 +20,8 @@ export interface IEditViewEvent extends IViewEvent {
    */
   onDataChange: {
     event: DataChangeEvent;
-    emitArgs: OmitObject<DataChangeEvent, EventBase> & { data?: IDatum[] };
+    emitArgs: PartialWithObject<DataChangeEvent, EventBase> & {
+      data?: IDatum[];
+    };
   };
 }

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

@@ -1,4 +1,4 @@
-import { OmitObject } from '@ibiz-template/core';
+import { PartialWithObject } from '@ibiz-template/core';
 import { DataChangeEvent, EventBase } from '../argument';
 import { IViewEvent } from './i-view-event';
 
@@ -20,6 +20,8 @@ export interface IMDViewEvent extends IViewEvent {
    */
   onDataChange: {
     event: DataChangeEvent;
-    emitArgs: OmitObject<DataChangeEvent, EventBase> & { data?: IDatum[] };
+    emitArgs: PartialWithObject<DataChangeEvent, EventBase> & {
+      data?: IDatum[];
+    };
   };
 }

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

@@ -1,5 +1,5 @@
-import { OmitObject } from '@ibiz-template/core';
-import { CloseViewEvent, EventBase, SetTitleEvent } from '../argument';
+import { PartialWithObject } from '@ibiz-template/core';
+import { CloseViewEvent, EventBase, ViewInfoEvent } from '../argument';
 import { IComponentEvent } from '../common/i-component-event';
 
 /**
@@ -19,18 +19,18 @@ export interface IViewEvent extends IComponentEvent {
    */
   onCloseView: {
     event: CloseViewEvent;
-    emitArgs: OmitObject<CloseViewEvent, EventBase> & { data?: IDatum[] };
+    emitArgs: PartialWithObject<CloseViewEvent, EventBase>;
   };
 
   /**
-   *设置标题
+   * 视图信息变更事件
    *
    * @author lxm
    * @date 2022-08-30 16:08:35
    */
-  onSetTitle: {
-    event: SetTitleEvent;
-    emitArgs: OmitObject<SetTitleEvent, EventBase>;
+  onViewInfoChange: {
+    event: ViewInfoEvent;
+    emitArgs: PartialWithObject<ViewInfoEvent, EventBase>;
   };
 
   /**

package/src/controller/interface/index.ts

@@ -1,5 +1,5 @@
-export * from './invoker';
 export * from './common';
 export * from './controller';
 export * from './event';
+export * from './state';
 export * from './work-flow';

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

@@ -0,0 +1,16 @@
+/**
+ * 基类UI状态
+ *
+ * @export
+ * @class ControlState
+ */
+export interface IBaseState {
+  /**
+   * 控制器是否已经准备完成
+   *
+   * @author lxm
+   * @date 2022-08-18 22:08:23
+   * @type {boolean}
+   */
+  complete: boolean;
+}

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

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

package/src/controller/interface/state/view/i-index-view-state.ts

@@ -0,0 +1,17 @@
+import { IViewState } from './i-view-state';
+
+/**
+ * 首页视图UI状态
+ *
+ * @export
+ * @class IIndexViewState
+ * @extends {IViewState}
+ */
+export interface IIndexViewState extends IViewState {
+  /**
+   * 菜单收缩变化
+   *
+   * @type {boolean}
+   */
+  isCollapse: boolean;
+}

package/src/controller/{state/view/view-state.ts → interface/state/view/i-view-state.ts}

@@ -1,4 +1,4 @@
-import { BaseState } from '../base-state';
+import { IBaseState } from '../i-base-state';
 
 /**
  * 视图UI状态对象
@@ -6,7 +6,7 @@ import { BaseState } from '../base-state';
  * @export
  * @class ViewState
  */
-export class ViewState extends BaseState {
+export interface IViewState extends IBaseState {
   /**
    * 视图标题
    *
@@ -14,7 +14,7 @@ export class ViewState extends BaseState {
    * @date 2022-08-25 11:08:45
    * @type {string}
    */
-  caption!: string;
+  caption: string;
 
   /**
    * 视图是否正在加载
@@ -22,5 +22,5 @@ export class ViewState extends BaseState {
    * @author lxm
    * @date 2022-09-19 14:09:12
    */
-  isLoading: boolean = false;
+  isLoading: boolean;
 }

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

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

package/src/controller/state/index.ts

@@ -1,2 +1 @@
-export * from './view';
 export * from './control';

package/src/controller/utils/button-state/button-container-state.ts

@@ -1,6 +1,14 @@
 /* eslint-disable @typescript-eslint/no-explicit-any */
 import { IButtonContainerState, IButtonState } from '../../interface';
 
+/**
+ * 按钮容器状态
+ * @author lxm
+ * @date 2023-05-10 02:19:07
+ * @export
+ * @class ButtonContainerState
+ * @implements {IButtonContainerState}
+ */
 export class ButtonContainerState implements IButtonContainerState {
   declare visible: boolean;
 
@@ -48,10 +56,12 @@ export class ButtonContainerState implements IButtonContainerState {
     });
   }
 
-  update(data?: IData): void {
-    this.children.forEach(child => {
-      child.update(data);
-    });
+  async update(data?: IData, appDeId?: string): Promise<void> {
+    await Promise.all(
+      this.children.map(child => {
+        return child.update(data, appDeId);
+      }),
+    );
   }
 
   [p: string]: any;

package/src/controller/utils/button-state/index.ts

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

package/src/controller/utils/button-state/ui-action-button-state.ts

@@ -0,0 +1,162 @@
+/* eslint-disable @typescript-eslint/no-explicit-any */
+// import { Application } from '../../../application';
+import { IButtonState } from '../../interface';
+
+/**
+ * 界面行为按钮状态
+ * @author lxm
+ * @date 2023-05-10 02:04:12
+ * @export
+ * @class UIActionButtonState
+ * @implements {IButtonState}
+ */
+export class UIActionButtonState implements IButtonState {
+  name: string;
+
+  disabled: boolean = false;
+
+  visible: boolean = true;
+
+  loading: boolean = false;
+
+  /**
+   * 是否有权限
+   */
+  protected permitted: boolean = true;
+
+  /**
+   * 没权限时是否隐藏
+   */
+  protected noPermissionHidden: boolean = true;
+
+  /**
+   * 有权限时且没数据时，是否禁用
+   */
+  protected noDataDisabled: boolean = false;
+
+  /**
+   * 操作标识
+   */
+  protected dataAccessAction?: string;
+
+  /**
+   * 应用标识
+   */
+  protected appId: string;
+
+  /**
+   * 界面行为标识
+   */
+  protected uiActionId?: string;
+
+  /**
+   * 实体界面行为的实体的codeName小写
+   */
+  protected appDeName?: string;
+
+  /**
+   *  是否初始化
+   */
+  protected isInit: boolean = false;
+
+  constructor(name: string, appId: string, uiActionId?: string) {
+    this.name = name;
+    this.uiActionId = uiActionId;
+    this.appId = appId;
+  }
+
+  /**
+   * 初始化，没有界面行为id就是普通的buttonState
+   * @author lxm
+   * @date 2023-05-10 02:16:22
+   * @protected
+   * @return {*}
+   */
+  protected async init() {
+    if (!this.uiActionId) {
+      this.isInit = true;
+      return;
+    }
+    const uiAction = await ibiz.hub.getUIAction(this.uiActionId);
+    [, this.appDeName] = this.uiActionId.split('@');
+    if (!uiAction) {
+      return;
+    }
+    const {
+      dataAccessAction,
+      noPrivDisplayMode,
+      actionTarget,
+      uiactionMode,
+      uiactionTag,
+    } = uiAction;
+    this.dataAccessAction = dataAccessAction;
+
+    // 设置无权限显示模式,1:禁用，2隐藏，6隐藏且默认隐藏
+    if (noPrivDisplayMode === 1) {
+      this.noPermissionHidden = false;
+    } else if (noPrivDisplayMode === 6) {
+      this.visible = false;
+    }
+
+    // 数据目标不为空，和一些要数据的预置界面行为，没数据的时候禁用
+    if (
+      (actionTarget && actionTarget !== 'NONE') ||
+      (uiactionMode === 'SYS' &&
+        [
+          'Save',
+          'SaveAndExit',
+          'SaveAndNew',
+          'Edit',
+          'Remove',
+          'RemoveAndExit',
+        ].includes(uiactionTag!))
+    ) {
+      this.noDataDisabled = true;
+    }
+    this.isInit = true;
+  }
+
+  /**
+   * 计算按钮权限
+   * @author lxm
+   * @date 2023-05-11 07:46:09
+   * @protected
+   * @param {IData} [data] 数据
+   * @param {string} [appDeId] 数据对应的实体id
+   * @return {*}
+   */
+  protected async calcPermission(data?: IData, appDeId?: string) {
+    if (!this.dataAccessAction) {
+      return;
+    }
+    const app = await ibiz.hub.getApp(this.appId);
+    // 界面行为实体和数据实体不一致时报警告
+    if (this.appDeName && appDeId && !appDeId.includes(this.appDeName)) {
+      ibiz.log.warn(
+        `${this.uiActionId}界面行为的实体${this.appDeName}和数据的实体${appDeId}不一致`,
+      );
+    }
+    this.permitted = await app.authority.calcByDataAcessAction(
+      this.dataAccessAction,
+      data,
+      appDeId,
+    );
+  }
+
+  async update(data?: IData, appDeId?: string): Promise<void> {
+    if (!this.isInit) {
+      await this.init();
+    }
+    await this.calcPermission(data, appDeId);
+    // 赋值,没权限时都禁用，没权限时隐藏的才会不显示
+    if (!this.permitted) {
+      this.disabled = true;
+      this.visible = !this.noPermissionHidden;
+    } else {
+      // 有权限时显示
+      this.visible = true;
+      // 有权限时没数据有些要禁用
+      this.disabled = this.noDataDisabled && !data;
+    }
+  }
+}

package/src/controller/utils/index.ts

@@ -2,4 +2,3 @@ export * from './counter';
 export * from './loading/loading-state';
 export * from './button-state';
 export * from './event';
-export * from './layout-helper/layout-helper';