@ibiz-template/core 0.7.41-alpha.1 → 0.7.41-alpha.106

package/src/interface/api/global-param/i-api-context.ts

@@ -0,0 +1,37 @@
+/* eslint-disable @typescript-eslint/no-explicit-any */
+/**
+ * @description 应用上下文
+ * @export
+ * @interface IApiContext
+ */
+export interface IApiContext {
+  [key: string | symbol]: any;
+
+  /**
+   * @description 界面域标识，每个独立路由导航的视图生成
+   * @type {string}
+   * @memberof IApiContext
+   */
+  srfsessionid: string;
+
+  /**
+   * @description 应用标识
+   * @type {string}
+   * @memberof IApiContext
+   */
+  srfappid: string;
+
+  /**
+   * @description 是否简单模式，简单模式下服务层会以界面数据为准，不会进行 DTO 处理
+   * @type {boolean}
+   * @memberof IApiContext
+   */
+  srfsimple?: boolean;
+
+  /**
+   * @description 编辑视图上一个，下一步等功能数据来源的多数据部件标识
+   * @type {string}
+   * @memberof IApiContext
+   */
+  srfnavctrlid?: string;
+}

package/src/interface/api/global-param/i-global-param.ts

@@ -0,0 +1,27 @@
+/* eslint-disable @typescript-eslint/no-explicit-any */
+/**
+ * @description 参数对象接口定义
+ * @export
+ * @interface IApiParams
+ */
+export interface IApiParams {
+  [key: string | symbol]: any;
+}
+
+/**
+ * @description 数据对象接口定义
+ * @export
+ * @interface IApiData
+ */
+export interface IApiData {
+  [key: string | symbol]: any;
+}
+
+/**
+ * @description 任意对象结构定义
+ * @export
+ * @interface IApiObject
+ */
+export interface IApiObject {
+  [key: string | symbol]: any;
+}

package/src/interface/api/global-param/index.ts

@@ -0,0 +1,2 @@
+export { IApiContext } from './i-api-context';
+export { IApiParams, IApiData, IApiObject } from './i-global-param';

package/src/interface/api/ibizsys/i-api-ibizsys.ts

@@ -0,0 +1,54 @@
+/* eslint-disable @typescript-eslint/no-explicit-any */
+import { IEnvironment } from '../environment';
+import { IApiData } from '../global-param';
+import { IApiI18n, IApiNet, IMessageCenter } from '../utils';
+import { IOrgData } from './i-org-data';
+
+/**
+ * @description 全局对象
+ * @export
+ * @interface IApiIBizsys
+ */
+export interface IApiIBizsys {
+  /**
+   * @description 环境变量
+   * @type {IEnvironment}
+   * @memberof IApiIBizsys
+   */
+  env: IEnvironment;
+
+  /**
+   * @description 网络请求工具
+   * @type {IApiNet}
+   * @memberof IApiIBizsys
+   */
+  net: IApiNet;
+
+  /**
+   * @description 界面消息中心
+   * @type {IMessageCenter}
+   * @memberof IApiIBizsys
+   */
+  mc: IMessageCenter;
+
+  /**
+   * @description 国际化工具
+   * @type {IApiI18n}
+   * @memberof IApiIBizsys
+   */
+  i18n: IApiI18n;
+
+  /**
+   * @description 组织数据
+   * @type {IOrgData}
+   * @memberof IApiIBizsys
+   */
+  orgData?: IOrgData;
+
+  /**
+   * @description 应用数据
+   * @type {IApiData}
+   * @memberof IApiIBizsys
+   */
+  appData?: IApiData;
+}

package/src/interface/api/ibizsys/i-app-data.ts

@@ -0,0 +1,64 @@
+import { IApiContext } from '../global-param';
+
+/**
+ * @description 当前用户应用数据
+ * @export
+ * @interface IOrgData
+ */
+export interface IAppData {
+  /**
+   * @description 当前用户可看到的菜单项集合，启用菜单权限控制才生效
+   * @type {string[]}
+   * @memberof IAppData
+   */
+  appmenu: string[];
+
+  /**
+   * @description 当前用户用户身份信息
+   * @type {IApiContext}
+   * @memberof IAppData
+   */
+  context: IApiContext;
+
+  /**
+   * @description 是否启用权限控制
+   * @type {boolean}
+   * @memberof IAppData
+   */
+  enablepermissionvalid: boolean;
+
+  /**
+   * @description 当前用户过期时间，字符串格式，如 "2026-03-24 15:43:25"（本地时间）
+   * @type {string}
+   * @memberof IAppData
+   */
+  expireddate: string;
+
+  /**
+   * @description 当前用户过期剩余时间，单位秒
+   * @type {number}
+   * @memberof IAppData
+   */
+  expirein: number;
+
+  /**
+   * @description 当前用户权限资源,配合前端权限控制使用
+   * @type {string[]}
+   * @memberof IAppData
+   */
+  unires: string[];
+
+  /**
+   * @description 当前后台服务版本
+   * @type {string}
+   * @memberof IAppData
+   */
+  version: string;
+
+  /**
+   * @description 模型动态标记
+   * @type {string}
+   * @memberof IAppData
+   */
+  dynamodeltag: string;
+}

package/src/interface/api/ibizsys/i-org-data.ts

@@ -0,0 +1,31 @@
+/**
+ * @description 组织数据
+ * @export
+ * @interface IOrgData
+ */
+export interface IOrgData {
+  /**
+   * @description 组织标识
+   * @type {string}
+   * @memberof IOrgData
+   */
+  orgid: string;
+  /**
+   * @description 组织名称
+   * @type {string}
+   * @memberof IOrgData
+   */
+  orgname: string;
+  /**
+   * @description 租户系统标识
+   * @type {string}
+   * @memberof IOrgData
+   */
+  dcsystemid: string;
+  /**
+   * @description 系统标识
+   * @type {string}
+   * @memberof IOrgData
+   */
+  systemid: string;
+}

package/src/interface/api/ibizsys/index.ts

@@ -0,0 +1,3 @@
+export type { IApiIBizsys } from './i-api-ibizsys';
+export type { IOrgData } from './i-org-data';
+export type { IAppData } from './i-app-data';

package/src/interface/api/index.ts

@@ -0,0 +1,6 @@
+export * from './constant';
+export * from './environment';
+export * from './global-param';
+export * from './ibizsys';
+export * from './utils';
+export * from './chat-message';

package/src/interface/api/utils/i-api-i18n.ts

@@ -0,0 +1,56 @@
+import { IApiParams } from '../global-param';
+
+/**
+ * @description 多语言工具接口
+ * @export
+ * @interface IApiI18n
+ */
+export interface IApiI18n {
+  /**
+   * @description 设置当前语言
+   * @param {string} lang 语言
+   * @memberof IApiI18n
+   */
+  setLang(lang: string): void;
+
+  /**
+   * @description 获取当前语言
+   * @returns {*}  {string}
+   * @memberof IApiI18n
+   */
+  getLang(): string;
+
+  /**
+   * @description 消息格式化
+   * @param {string} tag 消息key
+   * @param {IApiParams} [options] 翻译配置
+   * @returns {*}  {string}
+   * @memberof IApiI18n
+   */
+  t(tag: string, options?: IApiParams): string;
+
+  /**
+   * @description 消息格式化
+   * @param {string} tag 消息key
+   * @param {string} [defaultMsg] 未找到翻译时默认呈现的消息
+   * @param {IApiParams} [options] 翻译配置
+   * @returns {*}  {string}
+   * @memberof IApiI18n
+   */
+  t(tag: string, defaultMsg?: string, options?: IApiParams): string;
+
+  /**
+   * @description 合并指定语言语言资源
+   * @param {string} lang 语言
+   * @param {IApiParams} data 语言资源
+   * @memberof IApiI18n
+   */
+  mergeLocaleMessage(lang: string, data: IApiParams): void;
+
+  /**
+   * @description 合并语言资源
+   * @param {IApiParams} data 语言资源
+   * @memberof IApiI18n
+   */
+  mergeLocaleMessage(data: IApiParams): void;
+}

package/src/interface/api/utils/index.ts

@@ -0,0 +1,5 @@
+export * from './message-center';
+export type { IApiI18n } from './i-api-i18n';
+export type { IApiNet } from './net/i-api-net';
+export type { IHttpResponse } from './net/i-http-response';
+export type { IApiHttpError } from './net/i-api-http-error';

package/src/interface/api/utils/message-center/base/i-message-all.ts

@@ -0,0 +1,8 @@
+import { IMessageBase } from './i-message-base';
+/**
+ * @description 所有消息控制器
+ * @export
+ * @interface IMessageAll
+ * @extends {IMessageBase}
+ */
+export interface IMessageAll extends IMessageBase {}

package/src/interface/api/utils/message-center/base/i-message-base.ts

@@ -0,0 +1,29 @@
+import { IPortalMessage } from '../common';
+
+/**
+ * @description 消息基类控制器，各个类型消息继承此类
+ * @export
+ * @interface IMessageBase
+ */
+export interface IMessageBase {
+  /**
+   * @description 推送标准结构消息
+   * @param {IPortalMessage} msg 消息
+   * @memberof IMessageBase
+   */
+  next(msg: IPortalMessage): void;
+
+  /**
+   * @description 订阅消息
+   * @param {(msg: IPortalMessage) => void} cb 回调函数
+   * @memberof IMessageBase
+   */
+  on(cb: (msg: IPortalMessage) => void): void;
+
+  /**
+   * @description 取消订阅消息
+   * @param {(msg: IPortalMessage) => void} cb 回调函数
+   * @memberof IMessageBase
+   */
+  off(cb: (msg: IPortalMessage) => void): void;
+}

package/src/interface/api/utils/message-center/base/index.ts

@@ -0,0 +1,2 @@
+export type { IMessageAll } from './i-message-all';
+export type { IMessageBase } from './i-message-base';

package/src/interface/api/utils/message-center/command/add-in-changed/i-add-in-changed.ts

@@ -0,0 +1,25 @@
+/**
+ * @description 添加变更
+ * @export
+ * @interface IAddInChanged
+ */
+export interface IAddInChanged {
+  /**
+   * @description 标题
+   * @type {string}
+   * @memberof IAddInChanged
+   */
+  title: string;
+  /**
+   * @description 内容
+   * @type {string}
+   * @memberof IAddInChanged
+   */
+  content: string;
+  /**
+   * @description 消息类型
+   * @type {string}
+   * @memberof IAddInChanged
+   */
+  message_type: string;
+}

package/src/interface/api/utils/message-center/command/add-in-changed/i-command-add-in-changed.ts

@@ -0,0 +1,16 @@
+import { ICommandBase } from '../i-command-base';
+import { IAddInChanged } from './i-add-in-changed';
+/**
+ * @description 添加变更指令消息控制器
+ * @export
+ * @interface ICommandAddInChanged
+ * @extends {ICommandBase}
+ */
+export interface ICommandAddInChanged extends ICommandBase {
+  /**
+   * @description 发送消息
+   * @param {IAddInChanged} data 添加的变更数据
+   * @memberof ICommandAddInChanged
+   */
+  send(data: IAddInChanged): void;
+}

package/src/interface/api/utils/message-center/command/async-action/i-command-async-action.ts

@@ -0,0 +1,17 @@
+import { IPortalAsyncAction } from '../../common';
+import { ICommandBase } from '../i-command-base';
+
+/**
+ * @description 异步作业指令消息控制器
+ * @export
+ * @interface ICommandAsyncAction
+ * @extends {ICommandBase}
+ */
+export interface ICommandAsyncAction extends ICommandBase {
+  /**
+   * @description 发送消息
+   * @param {IPortalAsyncAction} data 异步作业数据
+   * @memberof ICommandAsyncAction
+   */
+  send(data: IPortalAsyncAction): void;
+}

package/src/interface/api/utils/message-center/command/change/i-command-change.ts

@@ -0,0 +1,8 @@
+import { ICommandBase } from '../i-command-base';
+/**
+ * @description 数据变更指令消息控制器
+ * @export
+ * @interface ICommandChange
+ * @extends {ICommandBase}
+ */
+export interface ICommandChange extends ICommandBase {}

package/src/interface/api/utils/message-center/command/create/i-command-create.ts

@@ -0,0 +1,18 @@
+import { IAppDataEntity, IMsgMetaData } from '../../common';
+import { ICommandBase } from '../i-command-base';
+
+/**
+ * @description 创建指令消息控制器
+ * @export
+ * @interface ICommandCreate
+ * @extends {ICommandBase}
+ */
+export interface ICommandCreate extends ICommandBase {
+  /**
+   * @description 发送数据
+   * @param {IAppDataEntity} data 实体数据
+   * @param {IMsgMetaData} [meta] 元数据
+   * @memberof ICommandCreate
+   */
+  send(data: IAppDataEntity, meta?: IMsgMetaData): void;
+}

package/src/interface/api/utils/message-center/command/i-command-base.ts

@@ -0,0 +1,23 @@
+import { IApiData } from '../../../global-param';
+import { IMessageBase } from '../base';
+import { IPortalMessage } from '../common';
+/**
+ * @description 指令消息基类控制器接口
+ * @export
+ * @interface ICommandBase
+ * @extends {IMessageBase}
+ */
+export interface ICommandBase extends IMessageBase {
+  /**
+   * @description 发送指令消息
+   * @param {IApiData} data 数据
+   * @param {IPortalMessage['subtype']} subtype 子类型
+   * @param {string} [triggerKey] 触发源
+   * @memberof ICommandBase
+   */
+  sendCommand(
+    data: IApiData,
+    subtype: IPortalMessage['subtype'],
+    triggerKey?: string,
+  ): void;
+}

package/src/interface/api/utils/message-center/command/i-message-command.ts

@@ -0,0 +1,94 @@
+import { IApiData } from '../../../global-param';
+import { IMessageBase } from '../base';
+import { IPortalMessage } from '../common';
+import { ICommandAddInChanged } from './add-in-changed/i-command-add-in-changed';
+import { ICommandAsyncAction } from './async-action/i-command-async-action';
+import { ICommandChange } from './change/i-command-change';
+import { ICommandCreate } from './create/i-command-create';
+import { ICommandInternalMessage } from './internal-message/i-command-internal-message';
+import { ICommandMarkOpenData } from './mark-open-data/i-command-mark-open-data';
+import { ICommandRemove } from './remove/i-command-remove';
+import { ICommandUpdate } from './update/i-command-update';
+
+/**
+ * @description 指令消息控制器
+ * @export
+ * @interface IMessageCommand
+ * @extends {IMessageBase}
+ */
+export interface IMessageCommand extends IMessageBase {
+  /**
+   * @description 数据变更指令消息控制器
+   * @type {ICommandChange}
+   * @memberof IMessageCommand
+   */
+  readonly change: ICommandChange;
+
+  /**
+   * @description 数据新建指令消息控制器
+   * @type {ICommandCreate}
+   * @memberof IMessageCommand
+   */
+  readonly create: ICommandCreate;
+
+  /**
+   * @description 数据更新指令消息控制器
+   * @type {ICommandUpdate}
+   * @memberof IMessageCommand
+   */
+  readonly update: ICommandUpdate;
+
+  /**
+   * @description 数据删除指令消息控制器
+   * @type {ICommandRemove}
+   * @memberof IMessageCommand
+   */
+  readonly remove: ICommandRemove;
+  /**
+   * @description 异步作业指令消息控制器
+   * @type {ICommandAsyncAction}
+   * @memberof IMessageCommand
+   */
+  readonly asyncAction: ICommandAsyncAction;
+
+  /**
+   * @description 内部消息指令消息控制器
+   * @type {ICommandInternalMessage}
+   * @memberof IMessageCommand
+   */
+  readonly internalMessage: ICommandInternalMessage;
+
+  /**
+   * @description 协同指令消息控制器
+   * @type {ICommandMarkOpenData}
+   * @memberof IMessageCommand
+   */
+  readonly markOpenData: ICommandMarkOpenData;
+
+  /**
+   * @description 添加变更指令消息控制器
+   * @type {ICommandAddInChanged}
+   * @memberof IMessageCommand
+   */
+  readonly addInChanged: ICommandAddInChanged;
+
+  /**
+   * @description 推送指令消息
+   * @param {IPortalMessage} msg 消息
+   * @memberof IMessageCommand
+   */
+  next(msg: IPortalMessage): void;
+
+  /**
+   * @description 发送指令消息
+   * @param {IApiData} data 数据
+   * @param {IPortalMessage['subtype']} subtype 子类型
+   * @param {string} [triggerKey] 触发源
+   * @memberof IMessageCommand
+   */
+  send(
+    data: IApiData,
+    subtype: IPortalMessage['subtype'],
+    triggerKey?: string,
+  ): void;
+}

package/src/interface/api/utils/message-center/command/index.ts

@@ -0,0 +1,20 @@
+export type { ICommandBase } from './i-command-base';
+export type { IAddInChanged } from './add-in-changed/i-add-in-changed';
+export type { ICommandAddInChanged } from './add-in-changed/i-command-add-in-changed';
+export type { ICommandAsyncAction } from './async-action/i-command-async-action';
+export type { ICommandChange } from './change/i-command-change';
+export type { ICommandCreate } from './create/i-command-create';
+export type {
+  IInternalMessage,
+  InternalMessageContentType,
+  InternalMessageStatus,
+} from './internal-message/i-internal-message';
+export type { ICommandInternalMessage } from './internal-message/i-command-internal-message';
+export type {
+  MarkOpenDataAction,
+  IMarkOpenData,
+} from './mark-open-data/i-mark-open-data';
+export type { ICommandMarkOpenData } from './mark-open-data/i-command-mark-open-data';
+export type { ICommandRemove } from './remove/i-command-remove';
+export type { ICommandUpdate } from './update/i-command-update';
+export type { IMessageCommand } from './i-message-command';

package/src/interface/api/utils/message-center/command/internal-message/i-command-internal-message.ts

@@ -0,0 +1,17 @@
+import { ICommandBase } from '../i-command-base';
+import { IInternalMessage } from './i-internal-message';
+
+/**
+ * @description 站内信指令消息控制器
+ * @export
+ * @interface ICommandInternalMessage
+ * @extends {ICommandBase}
+ */
+export interface ICommandInternalMessage extends ICommandBase {
+  /**
+   * @description 发送消息
+   * @param {IInternalMessage} data 站内信数据
+   * @memberof ICommandInternalMessage
+   */
+  send(data: IInternalMessage): void;
+}