@ibiz-template/core 0.7.41-alpha.101 → 0.7.41-alpha.113

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

@@ -0,0 +1,93 @@
+import {
+  AxiosRequestConfig,
+  AxiosResponse,
+  RawAxiosRequestHeaders,
+} from 'axios';
+import { IHttpResponse } from './i-http-response';
+import { IApiData, IApiParams } from '../../global-param';
+
+/**
+ * @description 网络请求工具
+ * @export
+ * @interface IApiNet
+ */
+export interface IApiNet {
+  /**
+   * @description Post 请求
+   * @param {string} url 请求地址
+   * @param {IApiData} data 请求数据
+   * @param {IApiParams} [params={}] 请求参数
+   * @param {RawAxiosRequestHeaders} [headers={}] 请求头
+   * @returns {*}  {Promise<IHttpResponse>}
+   * @memberof IApiNet
+   */
+  post(
+    url: string,
+    data: IApiData,
+    params?: IApiParams,
+    headers?: RawAxiosRequestHeaders,
+  ): Promise<IHttpResponse>;
+
+  /**
+   * @description Get 请求
+   * @param {string} url 请求地址
+   * @param {IApiParams} [params={}] 请求参数
+   * @param {RawAxiosRequestHeaders} [headers={}] 请求头
+   * @param {AxiosRequestConfig} [option={}] 请求配置
+   * @returns {*}  {Promise<IHttpResponse>}
+   * @memberof IApiNet
+   */
+  get(
+    url: string,
+    params?: IApiParams,
+    headers?: RawAxiosRequestHeaders,
+    option?: AxiosRequestConfig,
+  ): Promise<IHttpResponse>;
+
+  /**
+   * @description Delete 请求
+   * @param {string} url 请求地址
+   * @param {IApiParams} [params] 请求参数
+   * @param {RawAxiosRequestHeaders} [headers] 请求头
+   * @returns {*}  {Promise<IHttpResponse>}
+   * @memberof IApiNet
+   */
+  delete(
+    url: string,
+    params?: IApiParams,
+    headers?: RawAxiosRequestHeaders,
+  ): Promise<IHttpResponse>;
+
+  /**
+   * @description Put 请求
+   * @param {string} url 请求地址
+   * @param {IApiData} data 请求数据
+   * @param {IApiParams} [params={}] 请求参数
+   * @param {RawAxiosRequestHeaders} [headers={}] 请求头
+   * @returns {*}  {Promise<IHttpResponse>}
+   * @memberof IApiNet
+   */
+  put(
+    url: string,
+    data: IApiData,
+    params?: IApiParams,
+    headers?: RawAxiosRequestHeaders,
+  ): Promise<IHttpResponse>;
+
+  /**
+   * @description 基础请求方法，会合并预置配置
+   * @param {string} url 请求地址
+   * @param {AxiosRequestConfig} [config={}] 请求配置
+   * @returns {*}  {Promise<IHttpResponse>}
+   * @memberof IApiNet
+   */
+  request(url: string, config?: AxiosRequestConfig): Promise<IHttpResponse>;
+
+  /**
+   * @description 创建标准 axios 请求,此方法会跳过预置网络拦截器
+   * @param {AxiosRequestConfig<IApiData>} config 请求配置
+   * @returns {*}  {Promise<AxiosResponse>}
+   * @memberof IApiNet
+   */
+  axios(config: AxiosRequestConfig<IApiData>): Promise<AxiosResponse>;
+}

package/src/interface/api/utils/net/i-http-response.ts

@@ -0,0 +1,67 @@
+import { AxiosResponse } from 'axios';
+import { IApiData } from '../../global-param';
+
+/**
+ * @description Http请求返回接口
+ * @export
+ * @interface IHttpResponse
+ * @extends {AxiosResponse}
+ * @template T
+ */
+export interface IHttpResponse<T = IApiData> extends AxiosResponse {
+  /**
+   * @description 是否请求成功,当状态码为 200-299 时认为成功
+   * @type {boolean}
+   * @memberof IHttpResponse
+   */
+  ok: boolean;
+
+  /**
+   * @description 是否为本地仿造响应,只有当值为 true 时, 才认为是本地仿造响应
+   * @type {boolean}
+   * @memberof IHttpResponse
+   */
+  local: boolean;
+
+  /**
+   * @description 响应数据
+   * @type {T}
+   * @memberof IHttpResponse
+   */
+  data: T;
+
+  /**
+   * @description 当前页
+   * @type {number}
+   * @memberof IHttpResponse
+   */
+  page?: number;
+
+  /**
+   * @description 分页条数
+   * @type {number}
+   * @memberof IHttpResponse
+   */
+  size?: number;
+
+  /**
+   * @description 总条数
+   * @type {number}
+   * @memberof IHttpResponse
+   */
+  total?: number;
+
+  /**
+   * @description 全部计数条数
+   * @type {number}
+   * @memberof IHttpResponse
+   */
+  totalx?: number;
+
+  /**
+   * @description 总页数
+   * @type {number}
+   * @memberof IHttpResponse
+   */
+  totalPages?: number;
+}

package/src/interface/click-outside/click-outside.ts

@@ -0,0 +1,51 @@
+/**
+ * @description 可选配置参数
+ * @export
+ * @interface OnClickOutsideOptions
+ */
+export interface OnClickOutsideOptions {
+  /**
+   * @description 指定使用的window,不给就用默认的window
+   * @type {Window}
+   * @memberof OnClickOutsideOptions
+   */
+  window?: Window;
+  /**
+   * @description 指定需要忽略的元素，用于排除某些外部的元素
+   * @type {HTMLElement[]}
+   * @memberof OnClickOutsideOptions
+   */
+  ignore?: HTMLElement[];
+  /**
+   * @description 是否捕获内部元素。默认为是，内部元素不会触发回调。
+   * @type {boolean}
+   * @memberof OnClickOutsideOptions
+   */
+  capture?: boolean;
+}
+
+// 回调处理函数类型
+export type OnClickOutsideHandler = (_evt: PointerEvent | MouseEvent) => void;
+
+/**
+ * @description OnClickOutside返回对象类型
+ * @export
+ * @interface OnClickOutsideResult
+ */
+export interface OnClickOutsideResult {
+  /**
+   * @description 停止监听，并移除相关监听事件
+   * @memberof OnClickOutsideResult
+   */
+  stop: () => void;
+  /**
+   * @description 暂停监听
+   * @memberof OnClickOutsideResult
+   */
+  pause: () => void;
+  /**
+   * @description 继续监听
+   * @memberof OnClickOutsideResult
+   */
+  proceed: () => void;
+}

package/src/interface/command/command/i-command-option.ts

@@ -0,0 +1,47 @@
+/* eslint-disable @typescript-eslint/no-explicit-any */
+/**
+ * @description 指令参数, 主要用于在指令呈现时的展示参数
+ * @export
+ * @interface ICommandOption
+ */
+export interface ICommandOption {
+  /**
+   * @description 唯一标识符（必需）
+   * @type {string}
+   * @memberof ICommandOption
+   */
+  readonly id: string;
+  /**
+   * @description 显示标题（必需）
+   * @type {string}
+   * @memberof ICommandOption
+   */
+  readonly title: string;
+  /**
+   * @description 悬停提示（可选）
+   * @type {string}
+   * @memberof ICommandOption
+   */
+  readonly tooltip?: string;
+  /**
+   * @description 描述（可选）
+   * @type {string}
+   * @memberof ICommandOption
+   */
+  readonly description?: string;
+  /**
+   * @description svg图标（可选）
+   * @type {string}
+   * @memberof ICommandOption
+   */
+  readonly icon?: string;
+}
+
+/**
+ * @description 指令处理回调
+ * @export
+ * @interface ICommandHandler
+ */
+export interface ICommandHandler {
+  (...args: any[]): unknown | Promise<unknown>;
+}

package/src/interface/command/command/i-command.ts

@@ -0,0 +1,68 @@
+/* eslint-disable @typescript-eslint/no-explicit-any */
+import { IDisposable } from '../disposable/i-disposable';
+import { ICommandHandler, ICommandOption } from './i-command-option';
+
+/**
+ * @description 指令声明
+ * @export
+ * @interface ICommand
+ */
+export interface ICommand {
+  id: string;
+  handler: ICommandHandler;
+  opts?: ICommandOption;
+}
+
+/**
+ * 指令控制器集
+ */
+export type ICommandsMap = Map<string, ICommand>;
+
+/**
+ * @description 指令注册器
+ * @export
+ * @interface ICommandRegistry
+ */
+export interface ICommandRegistry {
+  /**
+   * @description 注册指令
+   * @param {string} id 指令id
+   * @param {ICommandHandler} command 指令处理回调
+   * @param {ICommandOption} opts 指令参数
+   * @returns {*}  {IDisposable} 指令释放对象
+   * @memberof ICommandRegistry
+   */
+  registerCommand(
+    id: string,
+    command: ICommandHandler,
+    opts: ICommandOption,
+  ): IDisposable;
+  /**
+   * @description 注册指令
+   * @param {string} id 指令id
+   * @param {ICommandHandler} command 指令处理回调
+   * @returns {*}  {IDisposable} 指令释放对象
+   * @memberof ICommandRegistry
+   */
+  registerCommand(id: string, command: ICommandHandler): IDisposable;
+  /**
+   * @description 注册指令
+   * @param {ICommand} command 指令
+   * @returns {*}  {IDisposable} 指令释放对象
+   * @memberof ICommandRegistry
+   */
+  registerCommand(command: ICommand): IDisposable;
+  /**
+   * @description 获取指令
+   * @param {string} id 指令id
+   * @returns {*}  {(ICommand | undefined)}
+   * @memberof ICommandRegistry
+   */
+  getCommand(id: string): ICommand | undefined;
+  /**
+   * @description 获取所有指令
+   * @returns {*}  {ICommandsMap}
+   * @memberof ICommandRegistry
+   */
+  getCommands(): ICommandsMap;
+}

package/src/interface/command/disposable/i-disposable.ts

@@ -0,0 +1,12 @@
+/**
+ * @description 可释放的对象
+ * @export
+ * @interface IDisposable
+ */
+export interface IDisposable {
+  /**
+   * @description 释放对象持有的所有资源
+   * @memberof IDisposable
+   */
+  dispose(): void;
+}

package/src/interface/command/i-command-controller.ts

@@ -0,0 +1,50 @@
+import { ICommandHandler, ICommandOption } from '../../command';
+import { IDisposable } from './disposable/i-disposable';
+
+/**
+ * @description 指令控制器接口
+ * @export
+ * @interface ICommandController
+ */
+export interface ICommandController {
+  /**
+   * @description 注册指令
+   * @param {string} id 指令id
+   * @param {ICommandHandler} handler 指令处理回调
+   * @param {ICommandOption} [opts] 指令参数
+   * @returns {*}  {IDisposable} 指令释放对象
+   * @memberof ICommandController
+   */
+  register(
+    id: string,
+    handler: ICommandHandler,
+    opts?: ICommandOption,
+  ): IDisposable;
+
+  /**
+   * @description 执行指令
+   * @template T
+   * @param {string} id 指令id
+   * @param {...unknown[]} args 指令参数
+   * @returns {*}  {Promise<T>} 指令返回值
+   * @memberof ICommandController
+   */
+  execute<T = undefined>(id: string, ...args: unknown[]): Promise<T>;
+
+  /**
+   * @description 判断指令是否存在，没有则直接抛出异常
+   * @param {string} id 指令id
+   * @param {boolean} [err] 是否抛出异常
+   * @returns {*}  {boolean} 是否存在
+   * @memberof ICommandController
+   */
+  hasCommand(id: string, err?: boolean): boolean;
+
+  /**
+   * @description 获取指令参数
+   * @param {string} id 指令id
+   * @returns {*}  {(ICommandOption | undefined)} 指令参数
+   * @memberof ICommandController
+   */
+  getCommandOpts(id: string): ICommandOption | undefined;
+}

package/src/interface/command/index.ts

@@ -0,0 +1,11 @@
+export type {
+  ICommand,
+  ICommandsMap,
+  ICommandRegistry,
+} from './command/i-command';
+export type {
+  ICommandOption,
+  ICommandHandler,
+} from './command/i-command-option';
+export type { IDisposable } from './disposable/i-disposable';
+export type { ICommandController } from './i-command-controller';

package/src/interface/context/index.ts

@@ -0,0 +1,42 @@
+/**
+ * @description 应用上下文处理接口
+ * @export
+ * @interface IIBizContext
+ * @extends {IContext}
+ */
+export interface IIBizContext extends IContext {
+  /**
+   * @description 返回自身的上下文，独有的和与父有差异的
+   * @returns {*}  {IData}
+   * @memberof IIBizContext
+   */
+  getOwnContext(): IData;
+
+  /**
+   * @description 销毁当前上下文
+   * @memberof IIBizContext
+   */
+  destroy(): void;
+
+  /**
+   * @description 克隆当前上下文
+   * @returns {*}  {IContext}
+   * @memberof IIBizContext
+   */
+  clone(): IContext;
+
+  /**
+   * @description 深度克隆
+   * @return {*}  {IData}
+   * @memberof IIBizContext
+   */
+  deepClone(): IData;
+
+  /**
+   * @description 在不改变对象引用的情况下，重置上下文，等效于重新实例化，但是引用不变
+   * @param {IData} [context] 默认值
+   * @param {IContext} [parent] 父上下文
+   * @memberof IIBizContext
+   */
+  reset(context?: IData, parent?: IContext): void;
+}

package/src/interface/error/index.ts

@@ -0,0 +1,13 @@
+import { AxiosResponse } from 'axios';
+
+export type InputError = {
+  message: string;
+  response?: AxiosResponse;
+};
+
+export type detailMessage = {
+  name: string;
+  logicName: string;
+  errorType: number;
+  errorInfo: string;
+};

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

@@ -0,0 +1,16 @@
+import { IPortalAsyncAction } from '../api';
+import { IApiChatMessage } from '../api/chat-message';
+
+/**
+ * @description AI聊天消息
+ * @export
+ * @interface IChatMessage
+ */
+export interface IChatMessage extends IApiChatMessage {
+  /**
+   * @description 消息数据
+   * @type {(IPortalAsyncAction | IData | string | unknown)}
+   * @memberof IChatMessage
+   */
+  data?: IPortalAsyncAction | IData | string | unknown;
+}

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

@@ -0,0 +1,33 @@
+/* eslint-disable @typescript-eslint/no-explicit-any */
+import { Logger } from 'loglevel';
+import { IApiIBizsys } from '../api';
+import { ICommandController } from '../command';
+
+/**
+ * @description 全局对象
+ * @export
+ * @interface IIBizsys
+ */
+export interface IIBizsys extends IApiIBizsys {
+  /**
+   * @description 日志输出工具
+   * @type {Logger}
+   * @memberof IIBizsys
+   */
+  log: Logger;
+
+  /**
+   * @description 指令控制器
+   * @type {ICommandController}
+   * @memberof IIBizsys
+   */
+  commands: ICommandController;
+
+  /**
+   * @description 注册全局扩展，用于替换预置能力
+   * @param {keyof IBizSys} key
+   * @param {*} value
+   * @memberof IIBizsys
+   */
+  registerExtension(key: keyof IApiIBizsys, value: any): void;
+}

package/src/interface/ibizsys/index.ts

@@ -0,0 +1 @@
+export type { IIBizsys } from './i-ibizsys';

package/src/interface/index.ts

@@ -0,0 +1,11 @@
+import { IOrgData } from './api/ibizsys/i-org-data';
+
+export * from './api';
+export * from './click-outside/click-outside';
+export * from './command';
+export * from './context';
+export * from './error';
+export type { IChatMessage } from './i-chat-message/i-chat-message';
+export type OrgData = IOrgData;
+export * from './ibizsys';
+export * from './utils';

package/src/interface/utils/i-18n.ts

@@ -0,0 +1,22 @@
+import { IApiI18n } from '../api';
+
+/**
+ * @description 多语言工具接口
+ * @export
+ * @interface I18n
+ */
+export interface I18n extends IApiI18n {
+  /**
+   * @description 异步初始化，加载多语言文件
+   * @returns {*}  {Promise<void>}
+   * @memberof I18n
+   */
+  init(): Promise<void>;
+
+  /**
+   * @description 设置异步加载的多语言模块
+   * @param {Record<string, () => Promise<IData>>} languages
+   * @memberof I18n
+   */
+  setLangConfigs(languages: Record<string, () => Promise<IData>>): void;
+}

package/src/interface/utils/index.ts

@@ -0,0 +1 @@
+export type { I18n } from './i-18n';

package/src/locale/en/index.ts

@@ -0,0 +1,30 @@
+export const en = {
+  core: {
+    command: {
+      unregisteredCommand:
+        'Unregistered command: {id}, please register the command first',
+    },
+    error: {
+      networkAbnormality: 'Network abnormality, please try again later',
+      modelMsg: '「{id}」 model {msg}',
+      unsupportedModels: 'Unsupported models',
+      modelConfigurationMissing: 'Model Configuration Missing',
+      serviceException: 'Exception in service handling',
+      serviceResNotExist: 'Request resource path does not exist',
+      serviceResNotPermission: 'Requesting resources without permission',
+    },
+    utils: {
+      powerOfTwo: '{permission} is not a power of two.',
+      targetElement: 'The target element does not exist',
+      cannotFindWindow: 'Cannot find window',
+      unrealized: 'unrealized',
+      remoteStylesheet: 'Failed to load remote stylesheet',
+      notMatchLockUnlock: 'The lock and unlock counts do not match!',
+      multiApplicationMode:
+        'Multi-application mode waiting for reimplementation requests',
+      uploadFailed: '{file}Upload failed',
+      invalidInputValue: 'Invalid input value, must be >= 0',
+    },
+    noReInstall: 'ibiz already exists, no need to re-install it',
+  },
+};

package/src/locale/index.ts

@@ -0,0 +1,2 @@
+export { en } from './en';
+export { zhCn } from './zh-CN';

package/src/locale/zh-CN/index.ts

@@ -0,0 +1,28 @@
+export const zhCn = {
+  core: {
+    command: {
+      unregisteredCommand: '未注册指令: {id}，请先注册指令',
+    },
+    error: {
+      networkAbnormality: '网络异常，请稍后重试',
+      modelMsg: '「{id}」模型 {msg}',
+      unsupportedModels: '未支持的模型',
+      modelConfigurationMissing: '模型配置缺失',
+      serviceException: '服务处理异常',
+      serviceResNotExist: '请求资源路径不存在',
+      serviceResNotPermission: '请求资源无权限',
+    },
+    utils: {
+      powerOfTwo: '{permission}不是2的幂',
+      targetElement: 'target元素不存在',
+      cannotFindWindow: '找不到window',
+      unrealized: '未实现',
+      remoteStylesheet: '未实现加载远程样式表失败',
+      notMatchLockUnlock: 'lock和unlock次数不匹配！',
+      multiApplicationMode: '多应用模式等待重新实现请求',
+      uploadFailed: '{file}Upload failed',
+      invalidInputValue: '无效输入值，必须>=0',
+    },
+    noReInstall: 'ibiz 已经存在, 无需重复安装',
+  },
+};