@ibiz-template/runtime 0.0.1-alpha.9 → 0.0.1-beta.1

package/src/interface/util/i-overlay-container/i-overlay-container.ts

@@ -0,0 +1,38 @@
+/**
+ * 全局呈现容器
+ *
+ * @author chitanda
+ * @date 2022-11-09 14:11:59
+ * @export
+ * @interface IOverlayContainer
+ */
+export interface IOverlayContainer {
+  /**
+   * 展示容器
+   *
+   * @author chitanda
+   * @date 2022-11-09 14:11:10
+   * @return {*}  {Promise<void>}
+   */
+  present(): Promise<void>;
+
+  /**
+   * 关闭容器
+   *
+   * @author chitanda
+   * @date 2022-11-09 14:11:17
+   * @param {unknown} [data]
+   * @return {*}  {Promise<void>}
+   */
+  dismiss(data?: unknown): Promise<void>;
+
+  /**
+   * 等待容器关闭并返回返回值
+   *
+   * @author chitanda
+   * @date 2022-11-09 14:11:21
+   * @template T
+   * @return {*}  {Promise<T>}
+   */
+  onWillDismiss<T = unknown>(): Promise<T>;
+}

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

@@ -0,0 +1,116 @@
+import { IDrawerOptions } from '../../i-drawer-options/i-drawer-options';
+import { IPopoverOptions } from '../../i-popover-options/i-popover-options';
+import { IModalOptions } from '../../i-modal-options/i-modal-options';
+import { IOverlayContainer } from '../i-overlay-container/i-overlay-container';
+import { IOverlayPopoverContainer } from '../i-overlay-popover-container/i-overlay-popover-container';
+
+/**
+ * 全局呈现容器控制器
+ *
+ * @author chitanda
+ * @date 2022-11-08 14:11:27
+ * @export
+ * @interface IOverlayController
+ */
+export interface IOverlayController {
+  /**
+   * 飘窗
+   *
+   * @author chitanda
+   * @date 2022-11-09 12:11:22
+   * @template T
+   * @param {HTMLElement} element
+   * @param {unknown} component 组件名称，组件对象，或者绘制函数
+   * @param {IParams} [props] 组件props
+   * @param {IPopoverOptions} [opts]
+   * @return {*}  {Promise<T>}
+   */
+  popover<T = void>(
+    element: HTMLElement,
+    component: unknown,
+    props?: IParams,
+    opts?: IPopoverOptions,
+  ): Promise<T>;
+
+  /**
+   * 创建飘窗全局容器
+   *
+   * @author chitanda
+   * @date 2022-11-09 15:11:13
+   * @param {unknown} component 组件名称，组件对象，或者绘制函数
+   * @param {IParams} [props] 组件props
+   * @param {IPopoverOptions} [opts]
+   * @return {*}  {IOverlayPopoverContainer}
+   */
+  createPopover(
+    component: unknown,
+    props?: IParams,
+    opts?: IPopoverOptions,
+  ): IOverlayPopoverContainer;
+
+  /**
+   * 抽屉
+   *
+   * @author chitanda
+   * @date 2022-11-08 15:11:45
+   * @template T
+   * @param {unknown} component 组件名称，组件对象，或者绘制函数
+   * @param {IParams} [props] 组件props
+   * @param {IDrawerOptions} [opts]
+   * @return {*}  {Promise<T>}
+   */
+  drawer<T = void>(
+    component: unknown,
+    props?: IParams,
+    opts?: IDrawerOptions,
+  ): Promise<T>;
+
+  /**
+   * 创建全局抽屉容器
+   *
+   * @author chitanda
+   * @date 2022-11-09 15:11:49
+   * @param {unknown} component 组件名称，组件对象，或者绘制函数
+   * @param {IParams} [props] 组件props
+   * @param {IDrawerOptions} [opts]
+   * @return {*}  {IOverlayContainer}
+   */
+  createDrawer(
+    component: unknown,
+    props?: IParams,
+    opts?: IDrawerOptions,
+  ): IOverlayContainer;
+
+  /**
+   * 模态
+   *
+   * @author chitanda
+   * @date 2022-11-08 15:11:40
+   * @template T
+   * @param {unknown} component 组件名称，组件对象，或者绘制函数
+   * @param {IParams} [props] 组件props
+   * @param {IModalOptions} [opts]
+   * @return {*}  {Promise<T>}
+   */
+  modal<T = void>(
+    component: unknown,
+    props?: IParams,
+    opts?: IModalOptions,
+  ): Promise<T>;
+
+  /**
+   * 创建全局模态容器
+   *
+   * @author chitanda
+   * @date 2022-11-09 15:11:58
+   * @param {unknown} component 组件名称，组件对象，或者绘制函数
+   * @param {IParams} [props] 组件props
+   * @param {IModalOptions} [opts]
+   * @return {*}  {IOverlayContainer}
+   */
+  createModal(
+    component: unknown,
+    props?: IParams,
+    opts?: IModalOptions,
+  ): IOverlayContainer;
+}

package/src/interface/util/i-overlay-popover-container/i-overlay-popover-container.ts

@@ -0,0 +1,23 @@
+import { IOverlayContainer } from '../i-overlay-container/i-overlay-container';
+
+/**
+ * 飘窗容器
+ *
+ * @author chitanda
+ * @date 2022-11-09 14:11:39
+ * @export
+ * @interface IOverlayPopoverContainer
+ * @extends {IOverlayContainer}
+ */
+export interface IOverlayPopoverContainer extends IOverlayContainer {
+  /**
+   * 展示飘窗容器
+   *
+   * @author chitanda
+   * @date 2022-11-09 14:11:47
+   * @param {HTMLElement} target
+   * @return {*}  {Promise<void>}
+   */
+  present(target: HTMLElement): Promise<void>;
+  present(): Promise<void>;
+}

package/src/interface/util/index.ts

@@ -6,3 +6,6 @@ export {
   NotificationParams,
 } from './i-notification-util/i-notification-util';
 export { IOpenViewUtil } from './i-open-view-util/i-open-view-util';
+export { IOverlayContainer } from './i-overlay-container/i-overlay-container';
+export { IOverlayController } from './i-overlay-controller/i-overlay-controller';
+export { IOverlayPopoverContainer } from './i-overlay-popover-container/i-overlay-popover-container';

package/src/plugin/index.ts

@@ -0,0 +1,5 @@
+export { PluginStaticResource } from './plugin-static-resource/plugin-static-resource';
+export {
+  RemotePluginConfig,
+  RemotePluginItem,
+} from './remote-plugin-item/remote-plugin-item';

package/src/plugin/plugin-static-resource/plugin-static-resource.ts

@@ -0,0 +1,42 @@
+/**
+ * 插件静态资源工具类
+ *
+ * @author chitanda
+ * @date 2022-11-03 10:11:08
+ * @export
+ * @class PluginStaticResource
+ */
+export class PluginStaticResource {
+  /**
+   * 计算出的静态资源跟路径
+   *
+   * @author chitanda
+   * @date 2022-11-03 10:11:08
+   * @protected
+   * @type {string}
+   */
+  protected baseDir: string;
+
+  /**
+   * 插件静态资源工具类.
+   *
+   * @author chitanda
+   * @date 2022-11-03 10:11:41
+   * @param {string} mateUrl import.mate.url
+   */
+  constructor(mateUrl: string) {
+    this.baseDir = mateUrl.substring(0, mateUrl.lastIndexOf('/'));
+  }
+
+  /**
+   * 合并输出静态资源目录
+   *
+   * @author chitanda
+   * @date 2022-11-03 10:11:39
+   * @param {string} path
+   * @return {*}  {string}
+   */
+  dir(path: string): string {
+    return this.baseDir + path;
+  }
+}

package/src/plugin/remote-plugin-item/remote-plugin-item.ts

@@ -0,0 +1,107 @@
+/**
+ * 远程插件配置
+ *
+ * @author chitanda
+ * @date 2022-10-31 16:10:34
+ * @export
+ * @interface RemotePluginConfig
+ */
+export interface RemotePluginConfig {
+  /**
+   * 所有配置文件基础路径
+   *
+   * @author chitanda
+   * @date 2022-11-02 14:11:06
+   * @type {string}
+   */
+  baseUrl: string;
+  /**
+   * 包名称
+   *
+   * @author chitanda
+   * @date 2022-10-31 16:10:42
+   * @type {string}
+   */
+  name: string;
+  /**
+   * 版本
+   *
+   * @author chitanda
+   * @date 2022-11-02 15:11:03
+   * @type {string}
+   */
+  version: string;
+  /**
+   * system js 入口脚本
+   *
+   * @author chitanda
+   * @date 2022-11-02 15:11:28
+   * @type {string}
+   */
+  system: string;
+  /**
+   * 模块文件 入口脚本
+   *
+   * @author chitanda
+   * @date 2022-11-02 16:11:50
+   * @type {string}
+   */
+  module: string;
+  /**
+   * 样式地址
+   *
+   * @author chitanda
+   * @date 2022-10-31 16:10:46
+   * @type {(string | string[])}
+   */
+  styles: string | string[];
+  /**
+   * 是否为应用级
+   *
+   * @author chitanda
+   * @date 2022-10-31 16:10:51
+   * @type {boolean}
+   */
+  app?: boolean;
+}
+
+/**
+ * 远程插件项
+ *
+ * @author chitanda
+ * @date 2022-10-31 12:10:41
+ * @export
+ * @class RemotePluginItem
+ */
+export class RemotePluginItem {
+  /**
+   * 唯一标识
+   *
+   * @author chitanda
+   * @date 2022-10-31 12:10:48
+   * @type {string}
+   */
+  readonly tag: string;
+
+  /**
+   * 配置参数
+   *
+   * @author chitanda
+   * @date 2022-11-02 15:11:38
+   * @type {RemotePluginConfig}
+   */
+  readonly config: RemotePluginConfig;
+
+  /**
+   * Creates an instance of RemotePluginItem.
+   *
+   * @author chitanda
+   * @date 2022-10-31 12:10:28
+   * @param {string} tag 插件唯一标识
+   * @param {RemotePluginConfig} config
+   */
+  constructor(tag: string, config: RemotePluginConfig) {
+    this.tag = tag;
+    this.config = config;
+  }
+}

package/src/provider/index.ts

@@ -0,0 +1 @@
+export * from './ui-action';

package/src/provider/ui-action/backend-ui-action-provider.ts

@@ -0,0 +1,22 @@
+import { IUIActionHandler, IUIActionProvider } from '../../interface';
+import { BackendUIActionHandler } from '../../utils';
+
+/**
+ * 后台调用界面行为适配器
+ *
+ * @author lxm
+ * @date 2022-10-25 15:10:51
+ * @export
+ * @class BackendUIActionProvider
+ * @implements {IUIActionProvider}
+ */
+export class BackendUIActionProvider implements IUIActionProvider {
+  private handler?: IUIActionHandler;
+
+  async getHandler(): Promise<IUIActionHandler> {
+    if (!this.handler) {
+      this.handler = new BackendUIActionHandler();
+    }
+    return this.handler;
+  }
+}

package/src/provider/ui-action/common-sys-ui-action-provider.ts

@@ -0,0 +1,22 @@
+import { IUIActionHandler, IUIActionProvider } from '../../interface';
+import { CommonSysUIActionHandler } from '../../utils';
+
+/**
+ * 常用系统预置界面行为适配器
+ *
+ * @author lxm
+ * @date 2022-10-25 15:10:51
+ * @export
+ * @class CommonSysUIActionProvider
+ * @implements {IUIActionProvider}
+ */
+export class CommonSysUIActionProvider implements IUIActionProvider {
+  private handler?: IUIActionHandler;
+
+  async getHandler(): Promise<IUIActionHandler> {
+    if (!this.handler) {
+      this.handler = new CommonSysUIActionHandler();
+    }
+    return this.handler;
+  }
+}

package/src/provider/ui-action/front-ui-action-provider.ts

@@ -0,0 +1,22 @@
+import { IUIActionHandler, IUIActionProvider } from '../../interface';
+import { FrontUIActionHandler } from '../../utils';
+
+/**
+ * 前台调用界面行为适配器
+ *
+ * @author lxm
+ * @date 2022-10-25 15:10:51
+ * @export
+ * @class FrontUIActionProvider
+ * @implements {IUIActionProvider}
+ */
+export class FrontUIActionProvider implements IUIActionProvider {
+  private handler?: IUIActionHandler;
+
+  async getHandler(): Promise<IUIActionHandler> {
+    if (!this.handler) {
+      this.handler = new FrontUIActionHandler();
+    }
+    return this.handler;
+  }
+}

package/src/provider/ui-action/index.ts

@@ -0,0 +1,50 @@
+import { BackendUIActionProvider } from './backend-ui-action-provider';
+import { CommonSysUIActionProvider } from './common-sys-ui-action-provider';
+import { FrontUIActionProvider } from './front-ui-action-provider';
+
+/**
+ * 预置默认的界面行为适配器
+ *
+ * @author lxm
+ * @date 2022-09-19 22:09:50
+ * @export
+ */
+export function presetUIActionProvider(): void {
+  const { uiAction } = ibiz.register;
+  if (!uiAction) {
+    return;
+  }
+  // *前台调用
+  uiAction.register('FRONT', new FrontUIActionProvider());
+  // *后台调用
+  uiAction.register('BACKEND', new BackendUIActionProvider());
+  // *系统预置界面行为
+  // 打开新建数据视图
+  uiAction.register('SYS_New', new CommonSysUIActionProvider());
+  // 打开编辑数据视图
+  uiAction.register('SYS_Edit', new CommonSysUIActionProvider());
+  // 保存
+  uiAction.register('SYS_Save', new CommonSysUIActionProvider());
+  uiAction.register('SYS_SaveAndExit', new CommonSysUIActionProvider());
+  uiAction.register('SYS_SaveRow', new CommonSysUIActionProvider());
+  uiAction.register('SYS_SaveAndNew', new CommonSysUIActionProvider());
+  // 删除
+  uiAction.register('SYS_Remove', new CommonSysUIActionProvider());
+  uiAction.register('SYS_RemoveAndExit', new CommonSysUIActionProvider());
+  uiAction.register('SYS_NewRow', new CommonSysUIActionProvider());
+  // 工作流
+  uiAction.register('SYS_SaveAndStart', new CommonSysUIActionProvider());
+  uiAction.register('SYS_ViewWFStep', new CommonSysUIActionProvider());
+  // 其他
+  uiAction.register('SYS_ToggleFilter', new CommonSysUIActionProvider());
+  uiAction.register('SYS_Exit', new CommonSysUIActionProvider());
+  uiAction.register('SYS_Refresh', new CommonSysUIActionProvider());
+  uiAction.register('SYS_Import', new CommonSysUIActionProvider());
+  uiAction.register('SYS_ExportExcel', new CommonSysUIActionProvider());
+}
+
+export {
+  FrontUIActionProvider,
+  CommonSysUIActionProvider,
+  BackendUIActionProvider,
+};

package/src/register/index.ts

@@ -0,0 +1,3 @@
+export * from './register-center';
+export * from './register-base';
+export * from './ui-action-register';

package/src/register/register-base.ts

@@ -0,0 +1,27 @@
+import { IRegister } from '../interface';
+
+/**
+ * 注册器基类
+ *
+ * @author lxm
+ * @date 2022-10-17 16:10:54
+ * @export
+ * @class RegisterBase
+ * @implements {IRegister<T>}
+ * @template T
+ */
+export class RegisterBase<T> implements IRegister<T> {
+  providers: Map<string, T> = new Map();
+
+  register(key: string, provider: T): void {
+    this.providers.set(key, provider);
+  }
+
+  unRegister(key: string): void {
+    this.providers.delete(key);
+  }
+
+  getByKey(key: string): T | undefined {
+    return this.providers.get(key);
+  }
+}

package/src/register/register-center.ts

@@ -0,0 +1,20 @@
+import { UIActionRegister } from './ui-action-register';
+
+/**
+ * 注册中心
+ *
+ * @author lxm
+ * @date 2022-09-19 19:09:10
+ * @export
+ * @class Register
+ */
+export class RegisterCenter {
+  /**
+   * 界面行为注册器
+   *
+   * @author lxm
+   * @date 2022-10-25 15:10:39
+   * @type {UIActionRegister}
+   */
+  uiAction: UIActionRegister = new UIActionRegister();
+}

package/src/register/ui-action-register.ts

@@ -0,0 +1,48 @@
+import { RuntimeError } from '@ibiz-template/core';
+import { IPSAppUIAction } from '@ibiz-template/model';
+import { IUIActionRegister, IUIActionProvider } from '../interface';
+import { RegisterBase } from './register-base';
+
+/**
+ * 界面行为注册器
+ *
+ * @author lxm
+ * @date 2022-10-25 15:10:38
+ * @export
+ * @class UIActionRegister
+ * @extends {RegisterBase<IUIActionProvider>}
+ * @implements {IUIActionRegister}
+ */
+export class UIActionRegister
+  extends RegisterBase<IUIActionProvider>
+  implements IUIActionRegister
+{
+  async get(model: IPSAppUIAction): Promise<IUIActionProvider> {
+    // 先找插件标识和类型
+    if (model.getPSSysPFPlugin()) {
+      await ibiz.plugin.loadPlugin(model.getPSSysPFPlugin()!);
+      const { pluginType, pluginCode } = model.getPSSysPFPlugin()!;
+      const key = `${pluginType}_${pluginCode}`;
+      if (this.providers.has(key)) {
+        return this.providers.get(key)!;
+      }
+      throw new RuntimeError(`找不到插件标识${key}对应的适配器`);
+    }
+    // 找界面行为模式和界面行为标记
+    const { uIActionMode, uIActionTag } = model;
+    if (uIActionMode === 'SYS') {
+      const key = `${uIActionMode}_${uIActionTag}`;
+      if (this.providers.has(key)) {
+        return this.providers.get(key)!;
+      }
+      throw new RuntimeError(
+        `找不到系统预置界面行为${uIActionTag}对应的适配器`,
+      );
+    } else {
+      if (this.providers.has(uIActionMode)) {
+        return this.providers.get(uIActionMode)!;
+      }
+      throw new RuntimeError(`找不界面行为模式${uIActionMode}对应的适配器`);
+    }
+  }
+}

package/src/types.ts

@@ -6,8 +6,10 @@ import {
   IOpenViewUtil,
   IModalUtil,
   ILoadingUtil,
+  IPluginFactory,
+  IOverlayController,
 } from './interface';
-import { Register } from './register/register';
+import { RegisterCenter } from './register/register-center';
 
 declare module '@ibiz-template/core' {
   interface IBizSys {
@@ -63,7 +65,22 @@ declare module '@ibiz-template/core' {
      * @type {IOpenViewUtil}
      */
     openView: IOpenViewUtil;
-
+    /**
+     * 全局多种组件呈现工具类
+     *
+     * @author chitanda
+     * @date 2022-11-08 15:11:08
+     * @type {IOverlayController}
+     */
+    overlay: IOverlayController;
+    /**
+     * 插件工具工厂
+     *
+     * @author chitanda
+     * @date 2022-10-20 16:10:36
+     * @type {IPluginFactory}
+     */
+    plugin: IPluginFactory;
     /**
      * 注册中心
      *
@@ -71,6 +88,6 @@ declare module '@ibiz-template/core' {
      * @date 2022-09-19 19:09:23
      * @type {Register}
      */
-    register: Register;
+    register: RegisterCenter;
   }
 }