@ibiz-template/core 0.7.41-alpha.12 → 0.7.41-alpha.138

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

@@ -0,0 +1,532 @@
+import { LogLevelDesc } from 'loglevel';
+import { IDevToolConfig } from './i-devtool-config';
+import { LoginMode } from '../constant/login-mode/login-mode';
+import { MenuPermissionMode } from '../constant/menu-permission-mode/menu-permission-mode';
+import { IApiParams } from '../global-param/i-global-param';
+
+/**
+ * 环境变量
+ * @description 定义应用系统的全局环境变量，用于配置应用运行时的各项参数和行为，支持灵活定制以适配不同运行环境。
+ * @export
+ * @interface IEnvironment
+ */
+export interface IEnvironment {
+  /**
+   * @description 样式bem的命名空间
+   * @default ibiz
+   * @type {string}
+   * @platform web
+   * @platform mob
+   * @memberof IEnvironment
+   */
+  namespace?: string;
+
+  /**
+   * @description 是否为开发模式
+   * @type {boolean}
+   * @default false
+   * @platform web
+   * @platform mob
+   * @memberof IEnvironment
+   */
+  dev: boolean;
+
+  /**
+   * @description 是否为多应用 hub 基座模式
+   * @type {boolean}
+   * @default true
+   * @platform web
+   * @platform mob
+   * @memberof IEnvironment
+   */
+  hub: boolean;
+
+  /**
+   * @description 是否启用 mqtt (ws模式消息)
+   * @type {boolean}
+   * @default false
+   * @platform web
+   * @platform mob
+   * @memberof IEnvironment
+   */
+  enableMqtt: boolean;
+
+  /**
+   * @description mqtt 默认连接地址,emq 服务地址 /portal/mqtt/mqtt, rebbitmq 服务地址 /portal/mqtt/ws
+   * @type {string}
+   * @default /portal/mqtt/mqtt
+   * @platform web
+   * @platform mob
+   * @memberof IEnvironment
+   */
+  mqttUrl: string;
+
+  /**
+   * @description 默认应用的应用标识
+   * @type {string}
+   * @platform web
+   * @platform mob
+   * @memberof IEnvironment
+   */
+  appId: string;
+
+  /**
+   * @description 日志级别,使用`loglevel`插件包生成
+   * @type {LogLevelDesc}
+   * @default ERROR
+   * @platform web
+   * @platform mob
+   * @memberof IEnvironment
+   */
+  logLevel: LogLevelDesc;
+
+  /**
+   * @description 请求根路径
+   * @type {string}
+   * @default /api
+   * @platform web
+   * @platform mob
+   * @memberof IEnvironment
+   */
+  baseUrl: string;
+
+  /**
+   * @description 插件默认所在目录，获取插件时根据该值拼接出完整的url
+   * @type {string}
+   * @default http://172.16.240.221
+   * @platform web
+   * @platform mob
+   * @memberof IEnvironment
+   */
+  pluginBaseUrl: string;
+
+  /**
+   * @description 登录模式;DEFAULT: 默认标准登录,CUSTOM: 自定义登录,CAS: 中央认证登录,OAUTH: oauth登录
+   * @type {LoginMode}
+   * @default DEFAULT
+   * @platform web
+   * @platform mob
+   * @memberof IEnvironment
+   */
+  loginMode: LoginMode;
+
+  /**
+   * @description oauth 开放接入标识
+   * @type {string}
+   * @platform web
+   * @platform mob
+   * @memberof IEnvironment
+   */
+  oauthOpenAccessId: string;
+
+  /**
+   * @description 中央认证登录地址
+   * @type {string}
+   * @platform web
+   * @platform mob
+   * @memberof IEnvironment
+   */
+  casLoginUrl: string;
+
+  /**
+   * @description 模型是否为本地模型(走静态资源模式)（已弃用）
+   * @type {boolean}
+   * @default false
+   * @memberof IEnvironment
+   */
+  isLocalModel: boolean;
+
+  /**
+   * @description 远程模型路径
+   * @type {string}
+   * @default /remotemodel
+   * @platform web
+   * @platform mob
+   * @memberof IEnvironment
+   */
+  remoteModelUrl: string;
+
+  /**
+   * @description 资源文件根路径
+   * @type {string}
+   * @default ./assets
+   * @platform web
+   * @platform mob
+   * @memberof IEnvironment
+   */
+  assetsUrl: string;
+
+  /**
+   * @description 中心系统标识
+   * @type {string}
+   * @platform web
+   * @platform mob
+   * @memberof IEnvironment
+   */
+  dcSystem: string;
+
+  /**
+   * @description 文件下载url
+   * @type {string}
+   * @default /ibizutil/download/{cat}
+   * @platform web
+   * @platform mob
+   * @memberof IEnvironment
+   */
+  downloadFileUrl: string;
+
+  /**
+   * @description 文件上传url
+   * @type {string}
+   * @default /ibizutil/upload/{cat}
+   * @platform web
+   * @platform mob
+   * @memberof IEnvironment
+   */
+  uploadFileUrl: string;
+
+  /**
+   * @description 上传文件存储目录
+   * @type {string}
+   * @default '''
+   * @platform web
+   * @platform mob
+   * @memberof IEnvironment
+   */
+  defaultOSSCat: string;
+
+  /**
+   * @description 是否启用权限校验（默认true）
+   * @type {boolean}
+   * @default true
+   * @platform web
+   * @platform mob
+   * @memberof IEnvironment
+   */
+  enablePermission: boolean;
+
+  /**
+   * @description 菜单权限校验模式（默认MIXIN）
+   * @type {MenuPermissionMode}
+   * @default MIXIN
+   * @memberof IEnvironment
+   */
+  menuPermissionMode: MenuPermissionMode;
+
+  /**
+   * @description 路由占位符
+   * @type {string}
+   * @default `-`
+   * @platform web
+   * @platform mob
+   * @memberof IEnvironment
+   */
+  routePlaceholder: string;
+
+  /**
+   * @description 是否让所有工作流history接口走all（已弃用）
+   * @type {boolean}
+   * @default false
+   * @memberof IEnvironment
+   */
+  enableWfAllHistory: boolean;
+
+  /**
+   * @description 是否启用加密,加密模式为RSA加密
+   * @type {boolean}
+   * @default false
+   * @platform web
+   * @platform mob
+   * @memberof IEnvironment
+   */
+  enableEncryption: boolean;
+
+  /**
+   * @description 应用loadding主题
+   * @type {('DEFAULT' | 'DARK' | 'LIGHT')}
+   * @default DEFAULT
+   * @platform web
+   * @memberof IEnvironment
+   */
+  appLoadingTheme: 'DEFAULT' | 'DARK' | 'LIGHT';
+
+  /**
+   * @description 应用标题
+   * @type {string}
+   * @platform web
+   * @platform mob
+   * @memberof IEnvironment
+   */
+  AppTitle?: string;
+
+  /**
+   * @description 应用标记
+   * @type {string}
+   * @platform web
+   * @platform mob
+   * @memberof IEnvironment
+   */
+  AppLabel?: string;
+
+  /**
+   * @description 是否为 SaaS 模式
+   * @type {boolean}
+   * @default true
+   * @platform web
+   * @platform mob
+   * @memberof IEnvironment
+   */
+  isSaaSMode?: boolean;
+
+  /**
+   * @description 是否为移动端应用
+   * @type {boolean}
+   * @default false
+   * @platform mob
+   * @memberof IEnvironment
+   */
+  isMob?: boolean;
+
+  /**
+   * @description 应用图标地址
+   * @type {string}
+   * @default ./favicon.ico
+   * @platform web
+   * @memberof IEnvironment
+   */
+  favicon?: string;
+
+  /**
+   * @description 是否启用多语言,此值是默认加载后，根据应用模型中的配置来决定是否启用多语言。请勿手动修改此值
+   * @type {boolean}
+   * @default false
+   * @platform web
+   * @platform mob
+   * @memberof IEnvironment
+   */
+  isEnableMultiLan?: boolean;
+
+  /**
+   * @description 匿名用户名
+   * @type {string}
+   * @platform web
+   * @platform mob
+   * @memberof IEnvironment
+   */
+  anonymousUser?: string;
+
+  /**
+   * @description 匿名用户密码
+   * @type {string}
+   * @platform web
+   * @platform mob
+   * @memberof IEnvironment
+   */
+  anonymousPwd?: string;
+
+  /**
+   * @description 启用匿名模式
+   * @type {boolean}
+   * @default false
+   * @platform web
+   * @platform mob
+   * @memberof IEnvironment
+   */
+  enableAnonymous?: boolean;
+
+  /**
+   * @description 访问数据存储区域
+   * @type {('COOKIE' | 'LOCALSTORAGE' | 'SESSIONSTORAGE')}
+   * @default COOKIE
+   * @platform web
+   * @platform mob
+   * @memberof IEnvironment
+   */
+  accessStoreArea: 'COOKIE' | 'LOCALSTORAGE' | 'SESSIONSTORAGE';
+
+  /**
+   * @description 市场地址，与实体子应用引用视图配合使用
+   * @type {string}
+   * @platform web
+   * @memberof IEnvironment
+   */
+  marketAddress?: string;
+
+  /**
+   * @description devtool的配置对象
+   * @type {IDevToolConfig}
+   * @platform web
+   * @platform mob
+   * @memberof IEnvironment
+   */
+  devtoolConfig?: IDevToolConfig;
+
+  /**
+   * @description 是否启用title，是否hover时线上title提示
+   * @type {boolean}
+   * @default true
+   * @platform web
+   * @memberof IEnvironment
+   */
+  enableTitle?: boolean;
+
+  /**
+   * @description token头
+   * @type {string}
+   * @platform web
+   * @platform mob
+   * @memberof IEnvironment
+   */
+  tokenHeader?: string;
+
+  /**
+   * @description token前缀
+   * @type {string}
+   * @platform web
+   * @platform mob
+   * @memberof IEnvironment
+   */
+  tokenPrefix?: string;
+
+  /**
+   * @description 自定义动态参数，格式如：{\"XXX\":\"YYY\",\"AAA\":\"BBB\"}
+   * @type {IApiParams}
+   * @platform web
+   * @platform mob
+   * @memberof IEnvironment
+   */
+  customParams?: IApiParams;
+
+  /**
+   * @description 定义cookie作用域
+   * @type {string}
+   * @platform web
+   * @platform mob
+   * @memberof IEnvironment
+   */
+  cookieDomain?: string;
+
+  /**
+   * @description 环境类型
+   * @type {('development' | 'test' | 'production')}
+   * @default development
+   * @platform web
+   * @platform mob
+   * @memberof IEnvironment
+   */
+  environmentTag?: 'development' | 'test' | 'production';
+
+  /**
+   * @description 移动端菜单呈现模式，DEFAULT：菜单映射的页面菜单显示，非菜单映射的页面菜单不显示；ALWAYS：所有页面菜单都显示,默认：DEFAULT
+   * @type {('DEFAULT' | 'ALWAYS')}
+   * @default DEFAULT
+   * @platform mob
+   * @memberof IEnvironment
+   */
+  mobMenuShowMode?: 'DEFAULT' | 'ALWAYS';
+
+  /**
+   * @description 是否启用AI支持
+   * @type {boolean}
+   * @default true
+   * @platform web
+   * @memberof IEnvironment
+   */
+  enableAI: boolean;
+
+  /**
+   * @description 应用版本号
+   * @type {string}
+   * @platform web
+   * @platform mob
+   * @memberof IEnvironment
+   */
+  appVersion?: string;
+
+  /**
+   * @description 高德地图安全密钥
+   * @type {string}
+   * @platform web
+   * @platform mob
+   * @memberof IEnvironment
+   */
+  aMapSecurityJsCode?: string;
+
+  /**
+   * @description 高德地图key
+   * @type {string}
+   * @platform web
+   * @platform mob
+   * @memberof IEnvironment
+   */
+  aMapKey?: string;
+
+  /**
+   * @description 运行容器
+   * @type {('DYNAENGINE' | 'FULLCODE')} 动态引擎 | 全代码
+   * @platform web
+   * @platform mob
+   * @memberof IEnvironment
+   */
+  runContainer?: 'DYNAENGINE' | 'FULLCODE';
+
+  /**
+   * @description 移动端微信appid
+   * @type {string}
+   * @platform mob
+   * @memberof IEnvironment
+   */
+  mobWeChatAppId?: string;
+
+  /**
+   * @description 是否为门户应用
+   * @type {boolean}
+   * @platform web
+   * @platform mob
+   * @default false
+   * @memberof IEnvironment
+   */
+  isPortalApp?: boolean;
+
+  /**
+   * @description 是否启用移动端loading
+   * @type {boolean}
+   * @platform mob
+   * @default false
+   * @memberof IEnvironment
+   */
+  isEnableMobLoading?: boolean;
+
+  /**
+   * @description 移动端loading标题
+   * @type {string}
+   * @platform mob
+   * @memberof IEnvironment
+   */
+  mobLoadingCaption?: string;
+
+  /**
+   * @description 移动端loading描述
+   * @type {string}
+   * @platform mob
+   * @memberof IEnvironment
+   */
+  mobLoadingDescription?: string;
+
+  /**
+   * @description 移动端loading背景色
+   * @type {string}
+   * @platform mob
+   * @memberof IEnvironment
+   */
+  mobLoadingBackground?: string;
+
+  /**
+   * @description 是否启用屏幕宽度自适应
+   * @type {boolean}
+   * @platform web
+   * @default false
+   * @memberof IEnvironment
+   */
+  isAdaptiveScreenWidth?: boolean;
+}

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

@@ -0,0 +1,2 @@
+export type { IDevToolConfig } from './i-devtool-config';
+export type { IEnvironment } from './i-environment';

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;
+}