@ibiz-template/core 0.1.14 → 0.1.20

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

@@ -0,0 +1,90 @@
+/**
+ * 异步作业信息
+ *
+ * @author chitanda
+ * @date 2023-09-05 15:09:59
+ * @export
+ * @interface IPortalAsyncAction
+ */
+export interface IPortalAsyncAction {
+  /**
+   * 会话标识
+   *
+   * @author chitanda
+   * @date 2023-09-05 15:09:57
+   * @type {string}
+   */
+  fulltopictag: string;
+
+  /**
+   * 异步作业类型
+   *
+   * @author chitanda
+   * @date 2023-09-05 15:09:09
+   * @type {string}
+   */
+  actiontype: string;
+
+  /**
+   * 异步作业执行结果
+   *
+   * @author chitanda
+   * @date 2023-09-05 15:09:33
+   * @type {unknown}
+   */
+  actionresult?: unknown;
+
+  /**
+   * 步骤信息
+   *
+   * @author chitanda
+   * @date 2023-09-05 15:09:55
+   * @type {string}
+   */
+  stepinfo?: string;
+
+  /**
+   * 异步结果下载路径，目前是留给导出数据使用
+   *
+   * @author chitanda
+   * @date 2023-09-05 15:09:03
+   * @type {string}
+   */
+  asyncresultdownloadurl?: string;
+
+  /**
+   * 预留参数
+   *
+   * @author chitanda
+   * @date 2023-09-05 15:09:32
+   * @type {unknown}
+   */
+  actionparam?: unknown;
+
+  /**
+   *预留参数2
+   *
+   * @author chitanda
+   * @date 2023-09-05 15:09:41
+   * @type {unknown}
+   */
+  actionparam2?: unknown;
+
+  /**
+   *预留参数3
+   *
+   * @author chitanda
+   * @date 2023-09-05 15:09:43
+   * @type {unknown}
+   */
+  actionparam3?: unknown;
+
+  /**
+   *预留参数4
+   *
+   * @author chitanda
+   * @date 2023-09-05 15:09:45
+   * @type {unknown}
+   */
+  actionparam4?: unknown;
+}

package/src/interface/i-portal-message/i-portal-message.ts

@@ -0,0 +1,79 @@
+import { IPortalAsyncAction } from '../i-portal-async-action/i-portal-async-action';
+
+/**
+ * 消息数据
+ *
+ * @author chitanda
+ * @date 2023-09-05 15:09:02
+ * @export
+ * @interface IPortalMessage
+ */
+export interface IPortalMessage {
+  /**
+   * 消息标识
+   *
+   * @author chitanda
+   * @date 2023-09-05 15:09:43
+   * @type {string}
+   */
+  messageid: string;
+
+  /**
+   * 消息名称
+   *
+   * @author chitanda
+   * @date 2023-09-05 15:09:49
+   * @type {string}
+   */
+  messagename: string;
+
+  /**
+   * 消息类型
+   *
+   * @author chitanda
+   * @date 2023-09-05 15:09:09
+   * @type {('CONSOLE' | 'COMMAND')} 日志消息 | 命令
+   */
+  type: 'CONSOLE' | 'COMMAND';
+
+  /**
+   * 消息子类型
+   *
+   * @author chitanda
+   * @date 2023-09-05 15:09:50
+   * @type {('MARKOPENDATA' | 'ASYNCACTION')} 标注打开数据 | 异步作业 | 数据更新 | 数据删除 | 数据创建
+   */
+  subtype?:
+    | 'MARKOPENDATA'
+    | 'ASYNCACTION'
+    | 'OBJECTUPDATED'
+    | 'OBJECTREMOVED'
+    | 'OBJECTCREATED';
+
+  /**
+   * 内容摘要
+   *
+   * @author chitanda
+   * @date 2023-09-05 15:09:23
+   * @type {string}
+   */
+  content?: string;
+
+  /**
+   * 消息数据
+   *
+   * @author chitanda
+   * @date 2023-09-05 15:09:55
+   * @type {(IPortalAsyncAction | IData | string | unknown)}
+   */
+  data?: IPortalAsyncAction | IData | string | unknown;
+
+  /**
+   * 消息路径
+   *
+   * @author chitanda
+   * @date 2023-09-05 15:09:25
+   * @type {string}
+   */
+  url?: string;
+}

package/src/interface/index.ts

@@ -1,4 +1,6 @@
 export * from './click-outside/click-outside';
 export type { I18n } from './i-18n/i-18n';
 export type { IEnvironment } from './i-environment/i-environment';
+export type { IPortalAsyncAction } from './i-portal-async-action/i-portal-async-action';
+export type { IPortalMessage } from './i-portal-message/i-portal-message';
 export type { OrgData } from './org-data/org-data';

package/src/utils/index.ts

@@ -1,4 +1,5 @@
 export * from './interceptor';
+export { MessageCenter } from './message-center';
 export { Namespace } from './namespace/namespace';
 export { IHttpResponse, HttpResponse } from './net/http-response';
 export { Net } from './net/net';

package/src/utils/message-center/base/message-all.ts

@@ -0,0 +1,12 @@
+import { MessageBase } from './message-base';
+
+/**
+ * 所有消息
+ *
+ * @author chitanda
+ * @date 2023-09-05 16:09:34
+ * @export
+ * @class MessageAll
+ * @extends {MessageBase}
+ */
+export class MessageAll extends MessageBase {}

package/src/utils/message-center/base/message-base.ts

@@ -0,0 +1,86 @@
+import { QXEvent } from 'qx-util';
+import { IPortalMessage } from '../../../interface';
+
+/**
+ * 消息事件
+ *
+ * @author chitanda
+ * @date 2023-09-05 16:09:17
+ * @interface MessageCenterEvent
+ */
+interface MessageCenterEvent {
+  all: (msg: IPortalMessage) => void;
+}
+
+/**
+ * 消息基类，各个类型消息继承此类
+ *
+ * @author chitanda
+ * @date 2023-09-05 16:09:41
+ * @export
+ * @class MessageBase
+ */
+export abstract class MessageBase {
+  /**
+   * 事件
+   *
+   * @author chitanda
+   * @date 2023-09-05 16:09:58
+   * @protected
+   * @type {QXEvent<MessageCenterEvent>}
+   */
+  protected evt: QXEvent<MessageCenterEvent> = new QXEvent(1000);
+
+  constructor(protected parent?: MessageBase) {}
+
+  /**
+   * 推送标准结构消息
+   *
+   * @author chitanda
+   * @date 2023-09-05 16:09:40
+   * @param {IPortalMessage} msg
+   */
+  next(msg: IPortalMessage): void {
+    this.evt.emit('all', msg);
+    if (this.parent) {
+      this.nextParent(msg);
+    }
+  }
+
+  /**
+   * 私有方法，专门向父级推送消息
+   *
+   * @author chitanda
+   * @date 2023-09-05 17:09:08
+   * @protected
+   * @param {IPortalMessage} msg
+   */
+  protected nextParent(msg: IPortalMessage): void {
+    if (this.parent) {
+      this.parent.evt.emit('all', msg);
+      this.parent.nextParent(msg);
+    }
+  }
+
+  /**
+   * 订阅消息
+   *
+   * @author chitanda
+   * @date 2023-09-05 15:09:21
+   * @param {(msg: IPortalMessage) => void} evt
+   */
+  on(cb: (msg: IPortalMessage) => void): void {
+    this.evt.on('all', cb);
+  }
+
+  /**
+   * 取消订阅
+   *
+   * @author chitanda
+   * @date 2023-09-05 15:09:50
+   * @param {(msg: IPortalMessage) => void} cb
+   */
+  off(cb: (msg: IPortalMessage) => void): void {
+    this.evt.off('all', cb);
+  }
+}

package/src/utils/message-center/command/change/command-change.ts

@@ -0,0 +1,12 @@
+import { CommandBase } from '../command-base/command-base';
+
+/**
+ * 数据变更指令消息
+ *
+ * @author chitanda
+ * @date 2023-09-05 17:09:49
+ * @export
+ * @class CommandChange
+ * @extends {CommandBase}
+ */
+export class CommandChange extends CommandBase {}

package/src/utils/message-center/command/command-base/command-base.ts

@@ -0,0 +1,30 @@
+import { createUUID } from 'qx-util';
+import { IPortalMessage } from '../../../../interface';
+import { MessageBase } from '../../base/message-base';
+
+/**
+ * 指令消息基类
+ *
+ * @author chitanda
+ * @date 2023-09-05 16:09:11
+ * @export
+ * @class CommandBase
+ * @extends {MessageBase}
+ */
+export class CommandBase extends MessageBase {
+  /**
+   * 发送指令消息
+   * @param data 更新的数据
+   * @param subtype 数据更新 | 数据删除 | 数据创建
+   */
+  protected sendCommand(data: IData, subtype: IPortalMessage['subtype']): void {
+    const msg: IPortalMessage = {
+      messageid: createUUID(),
+      messagename: 'command',
+      type: 'COMMAND',
+      subtype,
+      data,
+    };
+    this.next(msg);
+  }
+}

package/src/utils/message-center/command/create/command-create.ts

@@ -0,0 +1,24 @@
+import { IAppDataEntity } from '../../interface';
+import { CommandBase } from '../command-base/command-base';
+
+/**
+ * 创建指令消息
+ *
+ * @author chitanda
+ * @date 2023-09-05 17:09:57
+ * @export
+ * @class CommandCreate
+ * @extends {CommandBase}
+ */
+export class CommandCreate extends CommandBase {
+  /**
+   * 发送新建的数据
+   *
+   * @author chitanda
+   * @date 2023-09-05 17:09:13
+   * @param {IAppDataEntity} data
+   */
+  send(data: IAppDataEntity): void {
+    this.sendCommand(data, 'OBJECTCREATED');
+  }
+}

package/src/utils/message-center/command/message-command.ts

@@ -0,0 +1,118 @@
+import { createUUID } from 'qx-util';
+import { IPortalMessage } from '../../../interface';
+import { MessageBase } from '../base/message-base';
+import { CommandCreate } from './create/command-create';
+import { CommandUpdate } from './update/command-update';
+import { CommandRemove } from './remove/command-remove';
+import { CommandChange } from './change/command-change';
+
+/**
+ * 指令消息
+ *
+ * @author chitanda
+ * @date 2023-09-05 16:09:41
+ * @export
+ * @class MessageCommand
+ * @extends {MessageBase}
+ */
+export class MessageCommand extends MessageBase {
+  /**
+   * 数据变更指令消息
+   *
+   * @author chitanda
+   * @date 2023-09-05 17:09:15
+   * @type {CommandChange}
+   */
+  readonly change: CommandChange = new CommandChange();
+
+  /**
+   * 新建消息
+   *
+   * @author chitanda
+   * @date 2023-09-05 17:09:55
+   * @type {CommandCreate}
+   */
+  readonly create: CommandCreate = new CommandCreate(this);
+
+  /**
+   * 更新消息
+   *
+   * @author chitanda
+   * @date 2023-09-05 17:09:01
+   * @type {CommandUpdate}
+   */
+  readonly update: CommandUpdate = new CommandUpdate(this);
+
+  /**
+   * 删除消息
+   *
+   * @author chitanda
+   * @date 2023-09-05 17:09:05
+   * @type {CommandRemove}
+   */
+  readonly remove: CommandRemove = new CommandRemove(this);
+
+  /**
+   * 推送指令消息
+   *
+   * @author chitanda
+   * @date 2023-09-05 17:09:50
+   * @param {IPortalMessage} msg
+   */
+  next(msg: IPortalMessage): void {
+    // 消息分子类型，子类型发完消息后，会让父发消息
+    // 所以子类型有父时，会一级一级的往上发消息。不需要在此处发全局消息
+    // change 特殊处理，不给父发消息
+    switch (msg.subtype) {
+      case 'OBJECTCREATED':
+        this.create.next(msg);
+        this.change.next(msg);
+        break;
+      case 'OBJECTUPDATED':
+        this.update.next(msg);
+        this.change.next(msg);
+        break;
+      case 'OBJECTREMOVED':
+        this.remove.next(msg);
+        this.change.next(msg);
+        break;
+      default:
+        super.next(msg);
+    }
+  }
+
+  protected nextParent(msg: IPortalMessage): void {
+    switch (msg.subtype) {
+      case 'OBJECTCREATED':
+        this.change.next(msg);
+        break;
+      case 'OBJECTUPDATED':
+        this.change.next(msg);
+        break;
+      case 'OBJECTREMOVED':
+        this.change.next(msg);
+        break;
+      default:
+    }
+    super.nextParent(msg);
+  }
+
+  /**
+   * 发送指令消息
+   *
+   * @author chitanda
+   * @date 2023-09-05 17:09:35
+   * @param {IData} data
+   * @param {IPortalMessage['subtype']} subtype
+   */
+  send(data: IData, subtype: IPortalMessage['subtype']): void {
+    const msg: IPortalMessage = {
+      messageid: createUUID(),
+      messagename: 'command',
+      type: 'COMMAND',
+      subtype,
+      data,
+    };
+    this.next(msg);
+  }
+}

package/src/utils/message-center/command/remove/command-remove.ts

@@ -0,0 +1,24 @@
+import { IAppDataEntity } from '../../interface';
+import { CommandBase } from '../command-base/command-base';
+
+/**
+ * 删除指令消息
+ *
+ * @author chitanda
+ * @date 2023-09-05 17:09:03
+ * @export
+ * @class CommandRemove
+ * @extends {CommandBase}
+ */
+export class CommandRemove extends CommandBase {
+  /**
+   * 发送删除的数据
+   *
+   * @author chitanda
+   * @date 2023-09-05 17:09:29
+   * @param {IAppDataEntity} data
+   */
+  send(data: IAppDataEntity): void {
+    this.sendCommand(data, 'OBJECTREMOVED');
+  }
+}

package/src/utils/message-center/command/update/command-update.ts

@@ -0,0 +1,24 @@
+import { IAppDataEntity } from '../../interface';
+import { CommandBase } from '../command-base/command-base';
+
+/**
+ * 更新指令消息
+ *
+ * @author chitanda
+ * @date 2023-09-05 17:09:54
+ * @export
+ * @class CommandUpdate
+ * @extends {CommandBase}
+ */
+export class CommandUpdate extends CommandBase {
+  /**
+   * 发送更新的数据
+   *
+   * @author chitanda
+   * @date 2023-09-05 17:09:37
+   * @param {IAppDataEntity} data
+   */
+  send(data: IAppDataEntity): void {
+    this.sendCommand(data, 'OBJECTUPDATED');
+  }
+}

package/src/utils/message-center/console/message-console.ts

@@ -0,0 +1,31 @@
+import { createUUID } from 'qx-util';
+import { IPortalMessage } from '../../../interface';
+import { MessageBase } from '../base/message-base';
+
+/**
+ * 日志消息
+ *
+ * @author chitanda
+ * @date 2023-09-05 16:09:33
+ * @export
+ * @class MessageConsole
+ * @extends {MessageBase}
+ */
+export class MessageConsole extends MessageBase {
+  /**
+   * 发送日志消息
+   *
+   * @author chitanda
+   * @date 2023-09-05 16:09:25
+   * @param {(IData | string)} data
+   */
+  send(data: IData | string): void {
+    const msg: IPortalMessage = {
+      messageid: createUUID(),
+      messagename: 'console',
+      type: 'CONSOLE',
+      data,
+    };
+    this.next(msg);
+  }
+}

package/src/utils/message-center/index.ts

@@ -0,0 +1 @@
+export { MessageCenter } from './message-center';

package/src/utils/message-center/interface/i-app-data-entity.ts

@@ -0,0 +1,19 @@
+/**
+ * 应用实体数据对象
+ *
+ * @author chitanda
+ * @date 2023-09-05 17:09:39
+ * @export
+ * @interface IAppDataEntity
+ * @extends {IData}
+ */
+export interface IAppDataEntity extends IData {
+  /**
+   * 应用实体数据对象标识
+   *
+   * @author chitanda
+   * @date 2023-09-05 17:09:57
+   * @type {string}
+   */
+  srfdecodename: string;
+}

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

@@ -0,0 +1 @@
+export type { IAppDataEntity } from './i-app-data-entity';

package/src/utils/message-center/message-center.ts

@@ -0,0 +1,82 @@
+import { IPortalMessage } from '../../interface';
+import { MessageAll } from './base/message-all';
+import { MessageCommand } from './command/message-command';
+import { MessageConsole } from './console/message-console';
+
+/**
+ * 界面消息中心
+ *
+ * @author chitanda
+ * @date 2023-09-05 15:09:14
+ * @export
+ * @class MessageCenter
+ */
+export class MessageCenter {
+  /**
+   * 所有消息
+   *
+   * @author chitanda
+   * @date 2023-09-05 16:09:12
+   * @type {MessageAll}
+   */
+  protected all: MessageAll = new MessageAll();
+
+  /**
+   * 指令消息
+   *
+   * @author chitanda
+   * @date 2023-09-05 16:09:28
+   * @type {MessageCommand}
+   */
+  readonly command: MessageCommand = new MessageCommand(this.all);
+
+  /**
+   * 日志消息
+   *
+   * @author chitanda
+   * @date 2023-09-05 16:09:48
+   * @type {MessageConsole}
+   */
+  readonly console: MessageConsole = new MessageConsole(this.all);
+
+  /**
+   * 发送消息
+   *
+   * @author chitanda
+   * @date 2023-09-05 15:09:49
+   * @param {IPortalMessage} msg
+   */
+  next(msg: IPortalMessage): void {
+    // 消息分子类型，子类型发完消息后，会让父发消息
+    // 所以子类型有父时，会一级一级的往上发消息。不需要在此处发全局消息
+    if (msg.type === 'COMMAND') {
+      this.command.next(msg);
+    } else if (msg.type === 'CONSOLE') {
+      this.console.next(msg);
+    } else {
+      this.all.next(msg);
+    }
+  }
+
+  /**
+   * 订阅消息
+   *
+   * @author chitanda
+   * @date 2023-09-05 17:09:32
+   * @param {(msg: IPortalMessage) => void} callback
+   */
+  on(callback: (msg: IPortalMessage) => void): void {
+    this.all.on(callback);
+  }
+
+  /**
+   * 取消订阅
+   *
+   * @author chitanda
+   * @date 2023-09-05 17:09:38
+   * @param {(msg: IPortalMessage) => void} callback
+   */
+  off(callback: (msg: IPortalMessage) => void): void {
+    this.all.off(callback);
+  }
+}