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

package/src/app-hub.ts

@@ -1,7 +1,7 @@
 import { IAppDataEntity, IAppView, IApplication } from '@ibiz/model-core';
 import { RuntimeError } from '@ibiz-template/core';
 import { Application } from './application';
-import { ModelLoaderProvider } from './interface';
+import { IAppHubService, ModelLoaderProvider } from './interface';
 import { Convert } from './hub';
 
 /**
@@ -12,14 +12,15 @@ import { Convert } from './hub';
  * @export
  * @class AppHub
  */
-export class AppHub {
+export class AppHub implements IAppHubService {
   /**
    * 多应用模式下，应用模型转换器
    *
    * @author chitanda
-   * @date 2023-04-19 11:04:04
+   * @date 2023-04-23 15:04:06
+   * @type {Convert}
    */
-  readonly convert = new Convert();
+  readonly convert: Convert = new Convert();
 
   /**
    * 应用总集
@@ -47,7 +48,7 @@ export class AppHub {
    * @author chitanda
    * @date 2023-04-17 11:04:20
    * @protected
-   * @type {Map<string, string>} Map<视图名称, 视图所属应用>
+   * @type {Map<string, string>} Map<视图 id, 视图所属应用>
    */
   protected view2appMap: Map<string, string> = new Map();
 
@@ -89,6 +90,26 @@ export class AppHub {
    */
   defaultAppIndexViewName: string = 'Index';
 
+  /**
+   * 计算应用视图 标识
+   *
+   * @author chitanda
+   * @date 2023-04-20 18:04:48
+   * @protected
+   * @param {string} tag
+   * @return {*}  {string}
+   */
+  protected calcAppViewId(tag: string): string {
+    let id = '';
+    if (tag.indexOf('.') !== -1) {
+      const ids = tag.split('.');
+      id = ids[ids.length - 1];
+    } else {
+      id = tag.toLowerCase();
+    }
+    return id;
+  }
+
   /**
    * 注册模型加载适配器
    *
@@ -138,7 +159,7 @@ export class AppHub {
       this.dataEntities.set(appId, new Map());
     }
     const map = this.dataEntities.get(appId)!;
-    map.set(model.codeName!, model);
+    map.set(model.id!, model);
   }
 
   /**
@@ -146,11 +167,25 @@ export class AppHub {
    *
    * @author chitanda
    * @date 2023-04-17 23:04:37
-   * @param {string} name
+   * @param {string} tag 视图 codeName 或者视图 id
    * @param {string} [appId=ibiz.env.appId]
    */
-  setAppView(name: string, appId: string = ibiz.env.appId): void {
-    this.view2appMap.set(name, appId);
+  setAppView(tag: string, appId: string = ibiz.env.appId): void {
+    const id = this.calcAppViewId(tag);
+    this.view2appMap.set(id, appId);
+  }
+
+  /**
+   * 判断应用视图是否存在
+   *
+   * @author chitanda
+   * @date 2023-04-20 18:04:00
+   * @param {string} tag 视图 codeName 或者视图 id
+   * @return {*}  {boolean}
+   */
+  hasAppView(tag: string): boolean {
+    const id = this.calcAppViewId(tag);
+    return this.view2appMap.has(id);
   }
 
   /**
@@ -158,23 +193,24 @@ export class AppHub {
    *
    * @author chitanda
    * @date 2023-04-17 21:04:14
-   * @param {string} name
+   * @param {string} tag 视图 codeName 或者视图 id
    * @return {*}  {Promise<IAppView>}
    */
-  async getAppView(name: string): Promise<IAppView> {
-    const appId = this.view2appMap.get(name) || ibiz.env.appId;
+  async getAppView(tag: string): Promise<IAppView> {
+    const id = this.calcAppViewId(tag);
+    const appId = this.view2appMap.get(id) || ibiz.env.appId;
     if (!this.appMap.has(appId)) {
       await this.createApp(appId);
     }
-    if (this.views.has(name)) {
-      return this.views.get(name)!;
+    if (this.views.has(id)) {
+      return this.views.get(id)!;
     }
     if (this.modelLoaderProvider) {
-      const appView = await this.modelLoaderProvider.getAppView(appId, name);
+      const appView = await this.modelLoaderProvider.getAppView(appId, id);
       this.registerAppView(appView);
       return appView;
     }
-    throw new RuntimeError(`视图[${name}]不存在`);
+    throw new RuntimeError(`视图[${id}]不存在`);
   }
 
   /**
@@ -187,24 +223,21 @@ export class AppHub {
    * @return {*}  {Promise<IAppDataEntity>}
    */
   async getAppDataEntity(
-    name: string,
+    id: string,
     appId: string = ibiz.env.appId,
   ): Promise<IAppDataEntity> {
     if (this.dataEntities.has(appId)) {
       const map = this.dataEntities.get(appId)!;
-      if (map.has(name)) {
-        return map.get(name)!;
+      if (map.has(id)) {
+        return map.get(id)!;
       }
     }
     if (this.modelLoaderProvider) {
-      const entity = await this.modelLoaderProvider.getAppDataEntity(
-        appId,
-        name,
-      );
+      const entity = await this.modelLoaderProvider.getAppDataEntity(appId, id);
       this.registerAppDataEntity(entity, appId);
       return entity;
     }
-    throw new RuntimeError(`未找到应用实体[${name}]`);
+    throw new RuntimeError(`未找到应用实体[${id}]`);
   }
 
   /**

package/src/application.ts

@@ -1,21 +1,18 @@
 import { Net } from '@ibiz-template/core';
-import { IAppDERS, IApplication } from '@ibiz/model-core';
-import {
-  AuthorityService,
-  CodeListService,
-  ServicePathUtil,
-  ServiceUtil,
-} from './service';
+import { IAppFunc, IApplication } from '@ibiz/model-core';
+import { AuthorityService, CodeListService, DEServiceUtil } from './service';
+import { IAppService } from './interface';
 
 /**
- * 单一应用对象
+ * 应用对象
  *
  * @author chitanda
- * @date 2022-12-21 10:12:05
+ * @date 2023-04-23 15:04:59
  * @export
  * @class Application
+ * @implements {IAppService}
  */
-export class Application {
+export class Application implements IAppService {
   /**
    * 当前应用标识
    *
@@ -37,22 +34,13 @@ export class Application {
    */
   readonly net: Net;
 
-  /**
-   * 资源路径计算，资源路径上下文计算工具类
-   *
-   * @author chitanda
-   * @date 2023-01-10 16:01:38
-   * @type {ServicePathUtil}
-   */
-  readonly resourcePathUtil: ServicePathUtil;
-
   /**
    * 应用实体服务工具对象
    *
    * @author chitanda
    * @date 2022-12-23 10:12:46
    */
-  readonly es: ServiceUtil;
+  readonly deService: DEServiceUtil;
 
   /**
    * 代码表服务
@@ -72,24 +60,6 @@ export class Application {
    */
   readonly authority: AuthorityService;
 
-  /**
-   * 应用实体清单, 存储应用实体的代码标识
-   *
-   * @author chitanda
-   * @date 2023-04-18 14:04:32
-   * @type {string[]}
-   */
-  readonly appDataEntityList: string[] = [];
-
-  /**
-   * 当前应用实体关系
-   *
-   * @author chitanda
-   * @date 2023-04-18 14:04:56
-   * @type {IAppDERS[]}
-   */
-  readonly appDERSs: IAppDERS[] = [];
-
   /**
    * Creates an instance of Application.
    *
@@ -99,10 +69,9 @@ export class Application {
    */
   constructor(public readonly model: IApplication) {
     this.net = new Net({
-      baseURL: `${ibiz.env.baseUrl}/${model.id}`,
+      baseURL: `${ibiz.env.baseUrl}/${model.appId}`,
     });
-    this.resourcePathUtil = new ServicePathUtil(this);
-    this.es = new ServiceUtil(model);
+    this.deService = new DEServiceUtil(model);
     this.codeList = new CodeListService(model);
     this.authority = new AuthorityService(model);
   }
@@ -115,7 +84,34 @@ export class Application {
    * @return {*}  {Promise<void>}
    */
   async init(): Promise<void> {
-    await this.resourcePathUtil.init();
     await this.authority.init();
   }
+
+  /**
+   * 根据 id 查找应用功能
+   *
+   * @author chitanda
+   * @date 2023-04-20 17:04:24
+   * @param {string} id
+   * @return {*}  {(IAppFunc | null)}
+   */
+  getAppFunc(id: string): IAppFunc | null {
+    const items: IAppFunc[] = this.model.appFuncs || [];
+    const item = items.find(func => func.id === id);
+    return item || null;
+  }
+
+  /**
+   * 获取界面行为模型
+   * @author lxm
+   * @date 2023-04-28 05:44:14
+   * @param {string} actionId
+   * @param {string} [_appDataEntityId]
+   * @return {*}
+   */
+  getUIAction(actionId: string, _appDataEntityId?: string) {
+    return this.model.appDEUIActions!.find(action => {
+      return action.id === actionId;
+    });
+  }
 }

package/src/command/app/app-func/app-func.ts

@@ -1,5 +1,7 @@
 /* eslint-disable @typescript-eslint/no-unused-vars */
+import { RuntimeError } from '@ibiz-template/core';
 import { IAppFunc } from '@ibiz/model-core';
+import { OpenAppViewCommand } from '../open-app-view/open-app-view';
 
 /**
  * 执行应用功能
@@ -36,11 +38,16 @@ export class AppFuncCommand {
    * @return {*}  {Promise<void>}
    */
   async exec(
-    appFunc: IAppFunc,
+    appFuncId: string,
     context: IContext,
     params: IParams = {},
     opts: IData = {},
   ): Promise<void> {
+    const appFunc = ibiz.hub.getApp(context.srfappid).getAppFunc(appFuncId);
+    if (!appFunc) {
+      throw new RuntimeError(`找不到叫${appFuncId}的应用功能`);
+    }
+
     const navContext = appFunc.navigateContexts;
     if (navContext) {
       Object.assign(context, navContext);
@@ -82,18 +89,16 @@ export class AppFuncCommand {
     params?: IParams,
     opts?: IData,
   ): Promise<void> {
-    // todo
-    // const view = appFunc.getPSAppView();
-    // if (!view) {
-    //   throw new Error('应用视图不存在');
-    // }
-    // return ibiz.commands.execute(
-    //   OpenAppViewCommand.TAG,
-    //   view,
-    //   context,
-    //   params,
-    //   opts,
-    // );
+    if (!appFunc.appViewId) {
+      throw new Error('应用视图不存在');
+    }
+    return ibiz.commands.execute(
+      OpenAppViewCommand.TAG,
+      appFunc.appViewId,
+      context,
+      params,
+      opts,
+    );
   }
 
   /**

package/src/command/app/open-app-view/open-app-view.ts

@@ -22,18 +22,22 @@ export class OpenAppViewCommand {
    *
    * @author chitanda
    * @date 2022-08-25 23:08:08
-   * @param {IAppView} appView
+   * @param {string} appViewId
    * @param {IContext} [context]
    * @param {IParams} [params={}]
    * @param {IData} [_opts={}]
    * @return {*}  {(Promise<IModalData | void>)}
    */
   async exec(
-    appView: IAppView,
+    appViewId: string,
     context: IContext,
     params: IParams = {},
     opts: IData = {},
   ): Promise<IModalData | void> {
+    const appView = await ibiz.hub.getAppView(appViewId!);
+    if (!appView) {
+      throw new Error('应用视图不存在');
+    }
     if (appView.redirectView) {
       return openRedirectView(
         appView as IAppRedirectView,

package/src/controller/common/base.controller.ts

@@ -0,0 +1,203 @@
+import { Logger } from '@ibiz-template/core';
+import { CTX } from '../ctx';
+import { EventBase } from '../interface';
+import { BaseState } from '../state/base-state';
+import { ActivityCounter, ControllerEvent } from '../utils';
+
+const SELF_KEY = '__self';
+
+/**
+ * 控制器基类
+ * @author lxm
+ * @date 2023-04-25 11:00:31
+ * @export
+ * @class BaseController
+ */
+export class BaseController {
+  /**
+   * 控制器名称，作为检索控制器的唯一标识
+   * @author lxm
+   * @date 2023-04-26 08:22:30
+   * @type {string}
+   */
+  name: string = '';
+
+  /**
+   * UI状态
+   * @author lxm
+   * @date 2023-04-27 02:03:45
+   */
+  state = new BaseState();
+
+  /**
+   * Creates an instance of BaseController.
+   * @author lxm
+   * @date 2023-04-26 06:46:21
+   * @param {CTX} ctx 跨组件上下文环境，内部机制不暴露
+   */
+  constructor(protected ctx: CTX) {}
+
+  /**
+   * 获取事件的基础参数
+   * @author lxm
+   * @date 2023-04-25 11:03:44
+   * @return {*}  {Omit<EventBase, 'eventName'>}
+   */
+  getEventArgs(): Omit<EventBase, 'eventName'> {
+    return { targetName: '' };
+  }
+
+  /**
+   * 事件触发器
+   * @author lxm
+   * @date 2023-04-25 09:36:31
+   * @type {ControllerEvent}
+   */
+  evt: ControllerEvent = new ControllerEvent(this.getEventArgs.bind(this));
+
+  /**
+   * 计算父子加载顺序的计数器
+   * @author lxm
+   * @date 2023-04-26 06:14:22
+   * @type {ActivityCounter}
+   */
+  mountCounter: ActivityCounter = new ActivityCounter(this.mounted.bind(this));
+
+  /**
+   * 子组件的名称，会监听指定子组件的生命周期，影响自身的声明周期。
+   * @author lxm
+   * @date 2023-04-26 08:10:57
+   * @type {string[]}
+   */
+  childNames: string[] = [];
+
+  /**
+   * 生命周期-创建完成，不推荐子类实现
+   * @author lxm
+   * @date 2023-04-25 11:08:54
+   */
+  async created(): Promise<void> {
+    // 登记自身
+    this.mountCounter.enroll(SELF_KEY);
+    await this.doCreated();
+    this.state.complete = true;
+    this.force(() => {
+      this.mountSelf();
+    });
+    Logger.debug(`${this.name} onCreated`);
+    this.evt.emit('onCreated', undefined);
+  }
+
+  /**
+   * 生命周期-创建完成，实际执行逻辑，子类重写用这个
+   * @author lxm
+   * @date 2023-04-25 11:12:02
+   */
+  protected async doCreated(): Promise<void> {
+    // 监听预告，提前让计数器等待将要绘制的子组件
+    this.ctx.evt.on('forecast', name => {
+      if (this.childNames.includes(name)) {
+        this.mountCounter.enroll(name);
+      }
+    });
+    // 监听指定子组件的注册和加载声明周期，操作计数器，使父组件mounted在子组件都mounted之后
+    this.ctx.evt.on('register', (name, c) => {
+      if (this.childNames.includes(name)) {
+        c.evt.on('onMounted', () => {
+          this.mountCounter.attend(name);
+        });
+      }
+    });
+  }
+
+  /**
+   * 自身挂载方法，默认是设置自身已经挂载的状态，用于计数器计算。
+   * 异步方法，可以把异步初始化放这里，执行完后调基类的mountSelf，mounted声明周期就可以在异步之后触发
+   * @author lxm
+   * @date 2023-04-27 03:34:35
+   */
+  async mountSelf(): Promise<void> {
+    const isSelfMounted = this.mountCounter.registration.get(SELF_KEY);
+    if (!isSelfMounted) {
+      this.mountCounter.attend(SELF_KEY);
+    }
+  }
+
+  /**
+   * 生命周期-加载完成，不推荐子类实现
+   * 外部不允许调用，只能被mountCounter触发，保证mounted时机正确，外部调用mountSelf
+   *
+   * @author lxm
+   * @date 2023-04-25 11:08:54
+   */
+  protected mounted(): void {
+    this.doMounted();
+    Logger.debug(`${this.name} onMounted`);
+    this.evt.emit('onMounted', undefined);
+  }
+
+  /**
+   * 生命周期-加载完成，实际执行逻辑，子类重写用这个
+   * 放置等自身后需要等待的子组件都加载完成后才会执行的逻辑。
+   * @author lxm
+   * @date 2023-04-25 11:12:02
+   */
+  protected doMounted(): void {
+    // 子类重写
+  }
+
+  /**
+   * 生命周期-销毁完成，不推荐子类实现
+   * @author lxm
+   * @date 2023-04-25 11:08:54
+   */
+  destroyed(): void {
+    this.doDestroyed();
+    Logger.debug(`${this.name} onDestroyed`);
+    this.evt.emit('onDestroyed', undefined);
+    this.evt.destroy();
+  }
+
+  /**
+   * 生命周期-销毁完成，实际执行逻辑，子类重写用这个
+   * @author lxm
+   * @date 2023-04-25 11:12:02
+   */
+  protected doDestroyed(): void {
+    // 子类重写
+  }
+
+  /**
+   * 强制更新视图（框架级）
+   *
+   * @author chitanda
+   * @param {() => void} [callback] 更新之后，组件渲染完成后的回调
+   * @date 2022-07-24 14:07:38
+   */
+  force(_callback?: () => void): void {
+    // 在界面数据发生变更时，会调用此方法。
+    // 可外部覆盖实例的此方法，实现自定义的数据更新逻辑。
+  }
+
+  /**
+   * 获取指定名称的控制器
+   * @author lxm
+   * @date 2023-04-25 10:14:42
+   * @param {string} name
+   * @param {boolean} [traceRoot=false] 是否跨越视图作用域，一路向根上找。
+   * @return {*}  {(BaseController | undefined)}
+   */
+  getController(name: string, traceRoot = false) {
+    return this.ctx.getController(name, traceRoot);
+  }
+
+  /**
+   * 当前视图上下文内有新的控制产生时触发回调。
+   * @author lxm
+   * @date 2023-04-26 07:59:41
+   * @param {(name: string, c: BaseController) => void} cb
+   */
+  listenNewController(cb: (name: string, c: BaseController) => void) {
+    this.ctx.evt.on('register', cb);
+  }
+}

package/src/controller/common/editor.controller.ts

@@ -0,0 +1,133 @@
+/* eslint-disable @typescript-eslint/no-explicit-any */
+import { IEditor, INavigateParamContainer } from '@ibiz/model-core';
+import { convertNavData } from '../../utils';
+
+/**
+ * 编辑器控制器基类
+ *
+ * @author lxm
+ * @date 2022-08-24 20:08:15
+ * @export
+ * @class EditorController
+ */
+export class EditorController<T extends IEditor = IEditor> {
+  /**
+   * 编辑器模型
+   *
+   * @author lxm
+   * @date 2022-08-24 20:08:12
+   * @type {T}
+   */
+  readonly model: T;
+
+  /**
+   * 上下文
+   *
+   * @author lxm
+   * @date 2022-08-24 20:08:55
+   * @type {IContext}
+   */
+  readonly context!: IContext;
+
+  /**
+   * 视图参数
+   *
+   * @author lxm
+   * @date 2022-08-24 20:08:52
+   * @type {IParams}
+   */
+  readonly params!: IParams;
+
+  /**
+   * 父控制器，可以使表单项控制器，也可以是表格编辑项控制器
+   *
+   * @author lxm
+   * @date 2022-08-24 20:08:52
+   * @type {FormItemController}
+   */
+  readonly parent: any;
+
+  /**
+   * 占位
+   * @return {*}
+   * @author: zhujiamin
+   * @Date: 2022-08-25 14:33:14
+   */
+  public placeHolder = '';
+
+  /**
+   * 占位
+   * @return {*}
+   * @author: zhujiamin
+   * @Date: 2022-08-25 14:33:14
+   */
+  public editorParams: IModel = {};
+
+  /**
+   * 是否只读
+   *
+   * @author lxm
+   * @date 2022-12-12 21:12:51
+   * @readonly
+   */
+  get readonly() {
+    return this.model.readOnly;
+  }
+
+  /**
+   * Creates an instance of EditorController.
+   * @author lxm
+   * @date 2022-08-24 20:08:19
+   * @param {T} model
+   */
+  constructor(model: T, parent: any) {
+    this.model = model;
+    this.parent = parent;
+    this.context = parent.context;
+    this.params = parent.params;
+  }
+
+  /**
+   * 子类不可覆盖或重写此方法，在 init 时需要重写的使用 onInit 方法。
+   *
+   * @author lxm
+   * @date 2022-08-18 22:08:30
+   * @returns {*}  {Promise<void>}
+   */
+  async init(): Promise<void> {
+    await this.onInit();
+  }
+
+  protected async onInit(): Promise<void> {
+    // 异步初始化
+    if (this.model.placeHolder) {
+      this.placeHolder = this.model.placeHolder;
+    }
+    if (this.model.editorParams) {
+      this.editorParams = this.model.editorParams;
+    }
+  }
+
+  /**
+   * 公共参数处理，计算上下文和视图参数
+   * @return {*}
+   * @author: zhujiamin
+   * @Date: 2022-08-25 15:44:14
+   */
+  public handlePublicParams(data: IData, context: IContext, params: IParams) {
+    const { navigateContexts, navigateParams } = this
+      .model as INavigateParamContainer;
+    let selfContext = {};
+    if (navigateContexts && data) {
+      selfContext = convertNavData(navigateContexts!, context, params, data);
+    }
+    const _context = Object.assign(context.clone(), selfContext);
+
+    let selfParams = {};
+    if (navigateParams && data) {
+      selfParams = convertNavData(navigateParams!, context, params, data);
+    }
+    const _params: IParams = { ...params, ...selfParams };
+    return { context: _context, params: _params };
+  }
+}

package/src/controller/common/index.ts

@@ -0,0 +1,3 @@
+export * from './view.controller';
+export * from './base.controller';
+export * from './editor.controller';