@quickbi/bi-types
v3.3.7
Published
Quick BI 基础共享库层的**纯类型定义包**,提供跨应用、跨领域模块共享的 TypeScript 类型与枚举。
Keywords
Readme
@quickbi/bi-types
Quick BI 基础共享库层的纯类型定义包,提供跨应用、跨领域模块共享的 TypeScript 类型与枚举。
核心特征
- 零运行时依赖:仅
@rjsf/utils一项 type-only 类型依赖,不引入任何运行时依赖 - 零运行时副作用:
sideEffects: false,Tree-shaking 友好 - 可对外发布:通过 npm 公网 registry 发布,供项目内外消费
目录结构
src/
├── index.ts # 统一出口
├── chart-config.ts # 图表数值/百分比/单位格式化配置
├── component-type.ts # 图表与大屏组件类型枚举
├── cross-table.ts # 交叉表 OLAP 模型
├── etl.ts # 数据准备(ETL)状态枚举
├── permission-type.ts # 资源权限类型
├── standard-model.ts # 图表统一输入 FieldModel
├── cube/ # 数据集(Cube)领域类型
│ ├── cube-model.ts # 数据集接口模型
│ ├── cube-schema.ts # 字段模型(DataType/Field 等)
│ ├── cube-field-expression.ts # 字段表达式(计算字段/分组)
│ ├── cube-links.ts # 关联关系 JoinCondition
│ ├── cube-blend.ts # 数据混合 BlendSchema
│ ├── data-source.ts # 数据源类型
│ ├── logical-schema.ts # 逻辑表模型
│ └── physical-schema.ts # 物理表模型
├── data-panel/ # 数据面板(图表字段配置)模型
│ ├── base.ts # 区域/字段类型枚举
│ ├── data-config.ts # 存储侧 DataConfig
│ ├── data-schema-item.ts # 字段配置枚举与运行时类型
│ └── data-schema.ts # 渲染侧 DataPanelDataSchema
├── open/ # 开放平台(自定义组件/事件/菜单/嵌入)
│ ├── common/ # 通用枚举与工具类型
│ ├── components/ # 组件契约(Props/Meta/Lifecycle/面板)
│ ├── events/ # 自定义事件
│ ├── menus/ # 自定义菜单
│ ├── custom-page/ # 自定义页面
│ └── embed/ # 嵌入分析通信类型
├── ui/ # UI 层基础枚举
│ ├── page-header.ts # 资源页头部按钮分组
│ └── theme.ts # 主题模式(亮色/暗色/跟随系统)
└── router/ # 全局路由
├── route-key.ts # RouteKey 枚举(400+ 项)
└── route-tree.ts # 路由树与路径索引 Map使用方式
import { ComponentType, FieldType, RouteKey, ROUTE_PATH_MAP } from '@quickbi/bi-types';重要约束
- 禁止引入运行时依赖:除
@rjsf/utils(type-only)外,不新增任何依赖 - RouteKey 枚举值不可修改:已被客户自定义组件、事件、嵌入功能使用并落库存储,修改会导致线上兼容性问题
- 遵循架构分层:本包属于 Basic 层,不可引用 Domain / App 层模块
- 新增类型需通过
src/index.ts统一导出:外部消费方统一从包入口导入
