@ibiz-template/runtime 0.7.41-alpha.104 → 0.7.41-alpha.106

package/src/interface/provider/i-app-func-block.provider.ts

@@ -0,0 +1,70 @@
+import { IAppData, IOrgData } from '@ibiz-template/core';
+
+/**
+ * @description 登录上下文，传递给登录提供者的参数
+ * @author tony001
+ * @date 2026-05-13 14:05:28
+ * @export
+ * @interface ILoginContext
+ */
+export interface ILoginContext {
+  /** 用户名 */
+  loginname: string;
+  /** 密码 */
+  password: string;
+  /** 是否记住我 */
+  rememberme?: boolean;
+  /** 自定义请求头 */
+  headers?: IData;
+}
+
+/**
+ * @description 应用功能块提供者接口
+ * @author tony001
+ * @date 2026-05-13 14:05:12
+ * @export
+ * @interface IAppFuncBlockProvider
+ */
+export interface IAppFuncBlockProvider {
+  /**
+   * @description 登录
+   * @author tony001
+   * @date 2026-05-13 14:05:33
+   * @param {ILoginContext} ctx
+   * @param {Function} [requestedCallback] 数据响应成功的回调
+   * @returns {Promise<boolean>}
+   */
+  login(
+    ctx: ILoginContext,
+    requestedCallback?: (result: boolean) => void,
+  ): Promise<boolean>;
+
+  /**
+   * @description 登出
+   * @author tony001
+   * @date 2026-05-13 16:05:10
+   * @param {IData} [params]
+   * @returns {*}  {Promise<boolean>}
+   * @memberof IAppFuncBlockProvider
+   */
+  logout(params: IData): Promise<boolean>;
+
+  /**
+   * @description 加载应用数据
+   * @author tony001
+   * @date 2026-05-13 16:05:38
+   * @param {IParams} [context]
+   * @returns {*}  {Promise<{ ok: boolean; data: IAppData }>}
+   * @memberof IAppFuncBlockProvider
+   */
+  loadAppData(context?: IParams): Promise<{ ok: boolean; data: IAppData }>;
+
+  /**
+   * @description 获取组织数据
+   * @author tony001
+   * @date 2026-05-13 16:05:44
+   * @returns {*}  {Promise<{ ok: boolean; data: IOrgData[] }>}
+   * @memberof IAppFuncBlockProvider
+   */
+  loadOrgData(): Promise<{ ok: boolean; data: IOrgData[] }>;
+}

package/src/interface/provider/i-app-menu-item.provider.ts

@@ -0,0 +1,40 @@
+import { IAppMenuItem } from '@ibiz/model-core';
+import { IAppMenuController } from '../controller';
+
+/**
+ * 应用菜单项适配器的接口
+ *
+ * @author lxm
+ * @date 2022-10-25 13:10:45
+ * @export
+ * @interface IAppMenuItemProvider
+ */
+export interface IAppMenuItemProvider {
+  /**
+   * @description 执行菜单项点击
+   * @param {IAppMenuItem} menuItem
+   * @param {MouseEvent} event
+   * @param {IAppMenuController} [AppMenuController]
+   * @returns {*}  {Promise<void>}
+   * @memberof IAppMenuItemProvider
+   */
+  onClick?(
+    menuItem: IAppMenuItem,
+    event: MouseEvent,
+    AppMenuController?: IAppMenuController,
+  ): Promise<void>;
+
+  /**
+   * 绘制菜单项文本
+   * @author lxm
+   * @date 2023-12-29 03:05:22
+   * @param {IAppMenuItem} menuItem
+   * @param {IAppMenuController} AppMenuController
+   * @return {*}  {*}
+   */
+  renderText?(
+    menuItem: IAppMenuItem,
+    AppMenuController?: IAppMenuController,
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+  ): any;
+}

package/src/interface/provider/i-async-action.provider.ts

@@ -0,0 +1,41 @@
+import { IPortalAsyncAction } from '@ibiz-template/core';
+
+/**
+ * 异步操作适配器的接口
+ *
+ * @author lxm
+ * @date 2022-09-19 19:09:10
+ * @export
+ * @interface IAsyncActionProvider
+ */
+export interface IAsyncActionProvider {
+  /**
+   * 绘制组件（不能是字符串）
+   * @author lxm
+   * @date 2022-09-20 10:09:50
+   * @type {unknown}
+   */
+  // eslint-disable-next-line @typescript-eslint/no-explicit-any
+  component: any;
+
+  /**
+   * 绘制函数
+   * @author lxm
+   * @date 2024-01-26 05:38:09
+   */
+  // eslint-disable-next-line @typescript-eslint/no-explicit-any
+  render: (props: IData & { action: IPortalAsyncAction }) => any;
+
+  /**
+   * 点击事件
+   * @author lxm
+   * @date 2024-01-15 12:47:22
+   * @param {IPortalAsyncAction} asyncAction
+   * @param {MouseEvent} event
+   * @return {*}  {boolean} 返回是否需要隐藏外层组件消息
+   */
+  onClick?(
+    asyncAction: IPortalAsyncAction,
+    event: MouseEvent,
+  ): Promise<boolean>;
+}

package/src/interface/provider/i-control.provider.ts

@@ -0,0 +1,41 @@
+import { IControl } from '@ibiz/model-core';
+import { CTX } from '../../controller';
+import { IControlController } from '../controller';
+
+/**
+ * 部件适配器的接口
+ *
+ * @author lxm
+ * @date 2022-09-19 19:09:10
+ * @export
+ * @interface IControlProvider
+ */
+export interface IControlProvider {
+  /**
+   * 部件组件
+   *GridControlProvider
+   * @author lxm
+   * @date 2022-09-20 10:09:50
+   * @type {unknown}
+   */
+  // eslint-disable-next-line @typescript-eslint/no-explicit-any
+  component: any;
+
+  /**
+   * 创建部件控制器
+   *
+   * @author lxm
+   * @date 2023-09-15 11:52:22
+   * @param {IControl} model 部件模型
+   * @param {IContext} context 上下文
+   * @param {IParams} [params] 视图参数
+   * @param {CTX} [ctx]
+   * @return {*}  {IControlController}
+   */
+  createController?(
+    model: IControl,
+    context: IContext,
+    params: IParams,
+    ctx: CTX,
+  ): IControlController;
+}

package/src/interface/provider/i-de-method.provider.ts

@@ -0,0 +1,45 @@
+import { IAppDEMethod, IAppDataEntity } from '@ibiz/model-core';
+import { Method } from '../../service';
+import { IAppDEService } from '../service';
+
+/**
+ * 额外创建参数
+ * @author lxm
+ * @date 2023-11-28 03:31:58
+ * @export
+ * @interface CreateOptions
+ */
+export interface IDEMethodCreateOptions {
+  /**
+   * 是否是ac 模式
+   * @author lxm
+   * @date 2023-11-28 03:32:07
+   * @type {boolean}
+   */
+  acMode: boolean;
+  /**
+   * 是否为本地模式
+   *
+   * @author chitanda
+   * @date 2023-12-22 15:12:59
+   * @type {boolean}
+   */
+  localMode?: boolean;
+}
+
+/**
+ * 实体行为适配器的接口
+ *
+ * @author lxm
+ * @date 2022-10-25 13:10:45
+ * @export
+ * @interface IDEMethodProvider
+ */
+export interface IDEMethodProvider {
+  create(
+    service: IAppDEService,
+    entity: IAppDataEntity,
+    method: IAppDEMethod,
+    opts: IDEMethodCreateOptions,
+  ): Method;
+}

package/src/interface/provider/i-editor.provider.ts

@@ -0,0 +1,46 @@
+import { IEditor } from '@ibiz/model-core';
+import { IEditorContainerController, IEditorController } from '../controller';
+
+/**
+ * 编辑器适配器的接口
+ *
+ * @author lxm
+ * @date 2022-09-19 19:09:10
+ * @export
+ * @interface IEditorProvider
+ */
+export interface IEditorProvider {
+  /**
+   * 表单编辑器组件
+   *
+   * @author lxm
+   * @date 2022-09-20 10:09:50
+   * @type {unknown}
+   */
+  // eslint-disable-next-line @typescript-eslint/no-explicit-any
+  formEditor: any;
+
+  /**
+   * 表格编辑器组件
+   *
+   * @author lxm
+   * @date 2022-09-20 10:09:08
+   * @type {unknown}
+   */
+  // eslint-disable-next-line @typescript-eslint/no-explicit-any
+  gridEditor: any;
+
+  /**
+   * 创建编辑器控制器
+   *
+   * @author lxm
+   * @date 2022-09-20 10:09:57
+   * @param {EditorModel} editorModel 编辑器模型
+   * @param {unknown} parentController 父控制器
+   * @returns {*}  {Promise<T>}
+   */
+  createController(
+    editorModel: IEditor,
+    parentController: IEditorContainerController,
+  ): Promise<IEditorController>;
+}

package/src/interface/provider/i-error-view.provider.ts

@@ -0,0 +1,19 @@
+/**
+ * 错误视图适配器的接口
+ *
+ * @author lxm
+ * @date 2022-09-19 19:09:10
+ * @export
+ * @interface IErrorViewProvider
+ */
+export interface IErrorViewProvider {
+  /**
+   * 错误视图组件
+   *
+   * @author lxm
+   * @date 2022-09-20 10:09:50
+   * @type {unknown}
+   */
+  // eslint-disable-next-line @typescript-eslint/no-explicit-any
+  component: any;
+}

package/src/interface/provider/i-form-detail.provider.ts

@@ -0,0 +1,42 @@
+/* eslint-disable @typescript-eslint/no-explicit-any */
+import { IDEFormDetail } from '@ibiz/model-core';
+import {
+  IFormController,
+  IFormDetailContainerController,
+  IFormDetailController,
+} from '../controller';
+
+/**
+ * 表单成员适配器的接口
+ *
+ * @author lxm
+ * @date 2022-09-19 19:09:10
+ * @export
+ * @interface IFormDetailProvider
+ */
+export interface IFormDetailProvider {
+  /**
+   * 表单成员组件
+   *
+   * @author lxm
+   * @date 2022-09-20 10:09:50
+   * @type {unknown}
+   */
+  // eslint-disable-next-line @typescript-eslint/no-explicit-any
+  component: any;
+
+  /**
+   * 创建表单成员控制器
+   *
+   * @author lxm
+   * @date 2022-09-20 10:09:57
+   * @param {FormDetailModel} editorModel 表单成员模型
+   * @param {unknown} parentController 父控制器
+   * @returns {*}  {Promise<T>}
+   */
+  createController(
+    detailModel: IDEFormDetail,
+    form: IFormController,
+    parent: IFormDetailContainerController | undefined,
+  ): Promise<IFormDetailController>;
+}

package/src/interface/provider/i-grid-column.provider.ts

@@ -0,0 +1,37 @@
+import { IDEGridColumn } from '@ibiz/model-core';
+import { IGridColumnController, IGridController } from '../controller';
+
+/**
+ * 表格列适配器的接口
+ *
+ * @author lxm
+ * @date 2022-09-19 19:09:10
+ * @export
+ * @interface IGridColumnProvider
+ */
+export interface IGridColumnProvider {
+  /**
+   * 表格列组件
+   *
+   * @author lxm
+   * @date 2022-09-20 10:09:50
+   * @type {unknown}
+   */
+  // eslint-disable-next-line @typescript-eslint/no-explicit-any
+  component: any;
+
+  /**
+   * 创建表格列控制器
+   *
+   * @author lxm
+   * @date 2022-11-09 10:11:07
+   * @param {GridColumnModel} columnModel 列模型
+   * @param {GridController} grid 表格控制器
+   * @returns {*}  {Promise<GridColumnController>}
+   */
+  createController(
+    columnModel: IDEGridColumn,
+    grid: IGridController,
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+  ): Promise<IGridColumnController>;
+}

package/src/interface/provider/i-internal-message.provider.ts

@@ -0,0 +1,46 @@
+import { IInternalMessage } from '@ibiz-template/core';
+
+/**
+ * 站内信适配器的接口
+ *
+ * @author lxm
+ * @date 2022-09-19 19:09:10
+ * @export
+ * @interface IInternalMessageProvider
+ */
+export interface IInternalMessageProvider {
+  /**
+   * 绘制组件
+   * @author lxm
+   * @date 2022-09-20 10:09:50
+   * @type {unknown}
+   */
+  component: unknown;
+
+  /**
+   * 绘制函数
+   * @author lxm
+   * @date 2024-01-26 05:38:09
+   */
+  // eslint-disable-next-line @typescript-eslint/no-explicit-any
+  render: (props: IData & { message: IInternalMessage }) => any;
+
+  /**
+   * 点击事件
+   * @author lxm
+   * @date 2024-01-15 12:47:22
+   * @param {IInternalMessage} message
+   * @param {MouseEvent} event
+   * @return {*}  {boolean} 返回是否隐藏消息popover
+   */
+  onClick?(message: IInternalMessage, event: MouseEvent): Promise<boolean>;
+
+  /**
+   * 解析url并打开对应视图
+   * @param {string} redirectUrl
+   * @return {*}
+   * @author: zhujiamin
+   * @Date: 2024-03-04 11:16:40
+   */
+  openViewByUrl(redirectUrl: string | undefined): boolean;
+}

package/src/interface/provider/i-mob-platform-provider.ts

@@ -0,0 +1,18 @@
+/**
+ * 移动端搭载平台适配器接口
+ */
+export interface IMobPlatformProvider {
+  /**
+   * @description 获取是否显示视图头部
+   * @return {boolean}
+   * @memberof IMobPlatformProvider
+   */
+  getShowViewHeader(): boolean;
+
+  /**
+   * @description 获取是否显示预置返回按钮
+   * @return {boolean}
+   * @memberof IMobPlatformProvider
+   */
+  getShowPresetBack(): boolean;
+}

package/src/interface/provider/i-panel-item.provider.ts

@@ -0,0 +1,45 @@
+/* eslint-disable @typescript-eslint/no-explicit-any */
+import { IPanelItem } from '@ibiz/model-core';
+import {
+  IPanelController,
+  IPanelItemContainerController,
+  IPanelItemController,
+} from '../controller';
+
+/**
+ * 面板成员适配器的接口
+ *
+ * @author lxm
+ * @date 2022-09-19 19:09:10
+ * @export
+ * @interface IPanelItemProvider
+ */
+export interface IPanelItemProvider {
+  /**
+   * 面板成员组件
+   *
+   * @author lxm
+   * @date 2022-09-20 10:09:50
+   * @type {unknown}
+   */
+  // eslint-disable-next-line @typescript-eslint/no-explicit-any
+  component: any;
+
+  /**
+   * 创建面板成员控制器
+   *
+   * @author lxm
+   * @date 2023-04-27 06:06:03
+   * @param {IPanelItem} panelItem 面板成员模型
+   * @param {PanelController} panel 面板控制器
+   * @param {(PanelItemController | undefined)} parent 父容器控制器
+   * @return {*}  {Promise<PanelItemController>}
+   */
+  createController(
+    panelItem: IPanelItem,
+    panel: IPanelController,
+    parent: IPanelItemContainerController | undefined,
+  ): Promise<IPanelItemController>;
+
+  // todo 类型接口
+}

package/src/interface/provider/i-platform-provider.ts

@@ -0,0 +1,152 @@
+/**
+ * @description 后台导出参数
+ * @export
+ * @interface IBackendExportParams
+ */
+export interface IBackendExportParams {
+  /**
+   * @description 后台导出路径
+   * @type {string}
+   * @memberof IExportParams
+   */
+  url: string;
+  /**
+   * @description 请求方式
+   * @type {('post' | 'get')}
+   * @memberof IExportParams
+   */
+  method: 'post' | 'get';
+  /**
+   * @description 请求参数
+   * @type {IParams}
+   * @memberof IExportParams
+   */
+  params: IParams;
+  /**
+   * @description 请求数据
+   * @type {IData}
+   * @memberof IExportParams
+   */
+  data?: IData;
+  /**
+   * @description 基础路径
+   * @type {string}
+   * @memberof IExportParams
+   */
+  baseURL?: string;
+  /**
+   * @description 是否新窗口预览
+   * @type {boolean}
+   * @memberof IExportParams
+   */
+  newWindow?: boolean;
+}
+
+/**
+ * @description 前台导出参数
+ * @export
+ * @interface IFrontExportParams
+ */
+export interface IFrontExportParams {
+  /**
+   * @description 文件名称
+   * @type {string}
+   * @memberof IFrontExportParams
+   */
+  fileName: string;
+  /**
+   * @description 表头数据
+   * @type {string[]}
+   * @memberof IFrontExportParams
+   */
+  header: string[];
+  /**
+   * @description 表格数据
+   * @type {IData[][]}
+   * @memberof IFrontExportParams
+   */
+  data: IData[][];
+}
+
+/**
+ * 搭载平台适配器接口
+ *
+ * @author zk
+ * @date 2023-11-20 02:11:24
+ * @export
+ * @interface IPlatformProvider
+ */
+export interface IPlatformProvider {
+  /**
+   * 登录
+   *
+   * @author zk
+   * @date 2023-11-20 03:11:10
+   * @param {string} loginName 账号!
+   * @param {string} passWord 密码!
+   * @param {string} [verificationCode] 验证码?
+   * @return {*}  {Promise<boolean>}
+   * @memberof IPlatformProvider
+   */
+  login(
+    loginName: string,
+    passWord: string,
+    verificationCode?: string,
+  ): Promise<boolean>;
+
+  /**
+   * @description 下载
+   * @param {string} url 下载地址
+   * @param {string} fileName 文件名称
+   * @returns {*}  {Promise<boolean>}
+   * @memberof IPlatformProvider
+   */
+  download(url: string, fileName: string): Promise<boolean>;
+
+  /**
+   * @description 后台导出
+   * @param {IBackendExportParams} args 导出参数
+   * @returns {*}  {Promise<boolean>}
+   * @memberof IPlatformProvider
+   */
+  backendExport(args: IBackendExportParams): Promise<boolean>;
+
+  /**
+   * @description 前台导出
+   * @param {IFrontExportParams} args
+   * @returns {*}  {Promise<boolean>}
+   * @memberof IPlatformProvider
+   */
+  frontExport(args: IFrontExportParams): Promise<boolean>;
+
+  /**
+   * 初始化
+   *
+   * @author zk
+   * @date 2023-11-21 11:11:57
+   * @memberof IPlatformProvider
+   */
+  init(): Promise<void>;
+
+  /**
+   * @description 销毁
+   * @memberof IPlatformProvider
+   */
+  destroyed(): Promise<void>;
+
+  /**
+   * 返回
+   *
+   * @author zk
+   * @date 2023-11-21 08:11:36
+   * @memberof IPlatformProvider
+   */
+  back(): void;
+
+  /**
+   * @description 设置浏览器标题
+   * @param {string} title
+   * @memberof IPlatformProvider
+   */
+  setBrowserTitle(title: string): void;
+}

package/src/interface/provider/i-portlet.provider.ts

@@ -0,0 +1,41 @@
+import { IDBPortletPart } from '@ibiz/model-core';
+import {
+  IDashboardController,
+  IPortletContainerController,
+  IPortletController,
+} from '../controller';
+
+/**
+ * 门户部件适配器的接口
+ *
+ * @author lxm
+ * @date 2022-09-19 19:09:10
+ * @export
+ * @interface IPortletProvider
+ */
+export interface IPortletProvider {
+  /**
+   * 门户部件组件
+   *
+   * @author lxm
+   * @date 2022-09-20 10:09:50
+   * @type {unknown}
+   */
+  // eslint-disable-next-line @typescript-eslint/no-explicit-any
+  component: any;
+
+  /**
+   * 创建门户部件控制器
+   *
+   * @author lxm
+   * @date 2022-10-20 22:10:17
+   * @param {PortletPartModel} portletModel 门户部件模型
+   * @param {DashboardController} dashboard 数据看板控制器
+   * @returns {*}  {Promise<T>}
+   */
+  createController(
+    portletModel: IDBPortletPart,
+    dashboard: IDashboardController,
+    parent?: IPortletContainerController,
+  ): Promise<IPortletController>;
+}