@liujitcn/kratos-admin-bi 0.0.0-stage → 0.1.11

package/dist/package/src/rpc/bi/admin/v1/bi_card.ts

@@ -0,0 +1,169 @@
+// Code generated by protoc-gen-ts_proto. DO NOT EDIT.
+// versions:
+//   protoc-gen-ts_proto  v2.12.1
+//   protoc               unknown
+// source: bi/admin/v1/bi_card.proto
+
+/* eslint-disable */
+import type { BiDashboard } from "./bi_dashboard";
+import type { BiQueryResult, BiQuerySpec } from "./bi_query";
+
+/** 数据卡片分页条件。 */
+export interface PageBiCardRequest {
+  /** 卡片名称 */
+  name: string;
+  /** 语义数据源编码 */
+  source_code: string;
+  /** 卡片分类 */
+  category: string;
+  /** 来源名称匹配编码 */
+  search_source_codes: string[];
+  /** 页码 */
+  page_num: number;
+  /** 每页数量 */
+  page_size: number;
+}
+
+/** 数据卡片分页结果。 */
+export interface PageBiCardResponse {
+  /** 数据卡片 */
+  cards: BiCard[];
+  /** 总数 */
+  total: number;
+  /** 分类数量 */
+  counts: BiCardCounts | undefined;
+}
+
+/** 数据卡片分类数量。 */
+export interface BiCardCounts {
+  /** 全部卡片数量 */
+  all: number;
+  /** 系统卡片数量 */
+  system: number;
+  /** 自建卡片数量 */
+  mine: number;
+  /** 收藏卡片数量 */
+  favorite: number;
+  /** 分享卡片数量 */
+  shared: number;
+}
+
+/** 数据卡片配置。 */
+export interface BiCardForm {
+  /** 卡片名称 */
+  name: string;
+  /** 语义查询配置 */
+  query:
+    | BiQuerySpec
+    | undefined;
+  /** 图表类型 */
+  chart_type: string;
+  /** 来源成功查询记录ID */
+  query_record_id: number;
+  /** 图表字段映射与样式配置JSON */
+  chart_json: string;
+  /** 自动刷新间隔秒数 */
+  refresh_seconds: number;
+  /** 是否共享 */
+  is_shared: boolean;
+}
+
+/** 保存数据卡片请求。 */
+export interface SaveBiCardRequest {
+  /** 卡片ID */
+  id: number;
+  /** 卡片配置 */
+  card: BiCardForm | undefined;
+}
+
+/** 删除数据卡片请求。 */
+export interface DeleteBiCardRequest {
+  /** 卡片ID */
+  id: number;
+}
+
+/** 删除数据卡片响应。 */
+export interface DeleteBiCardResponse {
+}
+
+/** 查询数据卡片结果请求。 */
+export interface GetBiCardDataRequest {
+  /** 卡片ID */
+  id: number;
+  /** 统计周期天数 */
+  range_days: number;
+}
+
+/** 数据卡片记录。 */
+export interface BiCard {
+  /** 卡片ID */
+  id: number;
+  /** 租户ID */
+  tenant_id: number;
+  /** 项目ID */
+  project_id: number;
+  /** 所有者用户ID */
+  owner_id: number;
+  /** 来源查询记录ID */
+  query_record_id: number;
+  /** 卡片名称 */
+  name: string;
+  /** 语义数据源编码 */
+  source_code: string;
+  /** 语义查询配置 */
+  query:
+    | BiQuerySpec
+    | undefined;
+  /** 图表类型 */
+  chart_type: string;
+  /** 图表字段映射与样式配置JSON */
+  chart_json: string;
+  /** 自动刷新间隔秒数 */
+  refresh_seconds: number;
+  /** 是否共享 */
+  is_shared: boolean;
+  /** 更新时间 */
+  updated_at: string;
+  /** 卡片分类 */
+  category: string;
+  /** 当前用户是否可编辑 */
+  can_edit: boolean;
+}
+
+/** 获取个人工作台请求。 */
+export interface GetBiWorkbenchRequest {
+}
+
+/** 个人工作台仪表盘入口与卡片收藏。 */
+export interface BiWorkbench {
+  /** 工作台仪表盘ID */
+  dashboard_ids: number[];
+  /** 收藏卡片ID */
+  favorite_ids: number[];
+  /** 可见仪表盘 */
+  dashboards: BiDashboard[];
+}
+
+/** 保存个人工作台请求。 */
+export interface SaveBiWorkbenchRequest {
+  /** 工作台仪表盘ID */
+  dashboard_ids: number[];
+  /** 收藏卡片ID */
+  favorite_ids: number[];
+}
+
+/** BI 数据卡片与个人工作台服务。 */
+export interface BiCardService {
+  /** 分页查询当前用户可见的数据卡片。 */
+  PageBiCard(request: PageBiCardRequest): Promise<PageBiCardResponse>;
+  /** 创建或修改自己的数据卡片。 */
+  SaveBiCard(request: SaveBiCardRequest): Promise<BiCard>;
+  /** 删除自己的数据卡片。 */
+  DeleteBiCard(request: DeleteBiCardRequest): Promise<DeleteBiCardResponse>;
+  /** 在当前用户权限范围内执行卡片查询。 */
+  GetBiCardData(request: GetBiCardDataRequest): Promise<BiQueryResult>;
+  /** 获取当前用户的工作台与收藏。 */
+  GetBiWorkbench(request: GetBiWorkbenchRequest): Promise<BiWorkbench>;
+  /** 保存当前用户的工作台顺序与收藏。 */
+  SaveBiWorkbench(request: SaveBiWorkbenchRequest): Promise<BiWorkbench>;
+}

package/dist/package/src/rpc/bi/admin/v1/bi_dashboard.ts

@@ -0,0 +1,126 @@
+// Code generated by protoc-gen-ts_proto. DO NOT EDIT.
+// versions:
+//   protoc-gen-ts_proto  v2.12.1
+//   protoc               unknown
+// source: bi/admin/v1/bi_dashboard.proto
+
+/* eslint-disable */
+import type { BiQueryResult } from "./bi_query";
+
+/** BI 仪表盘分页查询条件。 */
+export interface PageBiDashboardRequest {
+  /** 仪表盘名称 */
+  name: string;
+  /** 页码 */
+  page_num: number;
+  /** 每页数量 */
+  page_size: number;
+}
+
+/** BI 仪表盘分页响应。 */
+export interface PageBiDashboardResponse {
+  /** 仪表盘列表 */
+  dashboards: BiDashboard[];
+  /** 总数 */
+  total: number;
+}
+
+/** 查询 BI 仪表盘请求。 */
+export interface GetBiDashboardRequest {
+  /** 仪表盘ID */
+  id: number;
+}
+
+/** 保存 BI 仪表盘请求。 */
+export interface SaveBiDashboardRequest {
+  /** 仪表盘草稿 */
+  dashboard: BiDashboard | undefined;
+}
+
+/** 发布 BI 仪表盘请求。 */
+export interface PublishBiDashboardRequest {
+  /** 仪表盘ID */
+  id: number;
+  /** 草稿版本 */
+  version: number;
+}
+
+/** 删除 BI 仪表盘请求。 */
+export interface DeleteBiDashboardRequest {
+  /** 仪表盘ID */
+  id: number;
+}
+
+/** 删除 BI 仪表盘响应。 */
+export interface DeleteBiDashboardResponse {
+}
+
+/** 查询已发布仪表盘数据请求。 */
+export interface GetBiDashboardDataRequest {
+  /** 仪表盘ID */
+  id: number;
+  /** 发布版本，0表示当前版本 */
+  version: number;
+}
+
+/** 仪表盘数据响应。 */
+export interface BiDashboardDataResponse {
+  /** 图表结果 */
+  cards: BiDashboardCardResult[];
+  /** 本次执行版本的仪表盘Schema JSON */
+  schema_json: string;
+}
+
+/** 单个图表查询结果。 */
+export interface BiDashboardCardResult {
+  /** 图表组件ID */
+  item_id: string;
+  /** 图表查询结果 */
+  result: BiQueryResult | undefined;
+}
+
+/** BI 仪表盘记录。 */
+export interface BiDashboard {
+  /** 仪表盘ID */
+  id: number;
+  /** 租户ID */
+  tenant_id: number;
+  /** 项目ID，0表示租户级 */
+  project_id: number;
+  /** 仪表盘编码 */
+  code: string;
+  /** 仪表盘名称 */
+  name: string;
+  /** 仪表盘说明 */
+  description: string;
+  /** 所有者用户ID */
+  owner_id: number;
+  /** 状态：1草稿，2已发布，3停用 */
+  status: number;
+  /** 草稿版本 */
+  draft_version: number;
+  /** 已发布版本 */
+  published_version: number;
+  /** 仪表盘Schema JSON */
+  schema_json: string;
+  /** 更新时间 */
+  updated_at: string;
+  /** 当前用户是否可编辑 */
+  can_edit: boolean;
+}
+
+/** BI 仪表盘管理服务。 */
+export interface BiDashboardService {
+  /** 分页查询当前用户可见的仪表盘。 */
+  PageBiDashboard(request: PageBiDashboardRequest): Promise<PageBiDashboardResponse>;
+  /** 查询仪表盘及当前草稿内容。 */
+  GetBiDashboard(request: GetBiDashboardRequest): Promise<BiDashboard>;
+  /** 创建或保存仪表盘草稿。 */
+  SaveBiDashboard(request: SaveBiDashboardRequest): Promise<BiDashboard>;
+  /** 发布仪表盘草稿。 */
+  PublishBiDashboard(request: PublishBiDashboardRequest): Promise<BiDashboard>;
+  /** 删除仪表盘。 */
+  DeleteBiDashboard(request: DeleteBiDashboardRequest): Promise<DeleteBiDashboardResponse>;
+  /** 执行已发布仪表盘中的全部图表查询。 */
+  GetBiDashboardData(request: GetBiDashboardDataRequest): Promise<BiDashboardDataResponse>;
+}

package/dist/package/src/rpc/bi/admin/v1/bi_query.ts

@@ -0,0 +1,187 @@
+// Code generated by protoc-gen-ts_proto. DO NOT EDIT.
+// versions:
+//   protoc-gen-ts_proto  v2.12.1
+//   protoc               unknown
+// source: bi/admin/v1/bi_query.proto
+
+/* eslint-disable */
+
+/** BI 数据源目录查询条件。 */
+export interface ListBiSourcesRequest {
+}
+
+/** BI 数据源目录响应。 */
+export interface ListBiSourcesResponse {
+  /** 当前用户可用的数据源 */
+  sources: BiSourceDescriptor[];
+}
+
+/** BI 数据源描述。 */
+export interface BiSourceDescriptor {
+  /** 数据源编码 */
+  code: string;
+  /** 数据源名称 */
+  name: string;
+  /** 数据源说明 */
+  description: string;
+  /** 数据源语义版本 */
+  version: number;
+  /** 可用维度 */
+  dimensions: BiFieldDescriptor[];
+  /** 可用指标 */
+  measures: BiMeasureDescriptor[];
+  /** 最大结果行数 */
+  max_rows: number;
+}
+
+/** BI 字段描述。 */
+export interface BiFieldDescriptor {
+  /** 字段编码 */
+  code: string;
+  /** 字段名称 */
+  name: string;
+  /** 字段类型 */
+  type: string;
+  /** 是否允许过滤 */
+  filterable: boolean;
+}
+
+/** BI 指标描述。 */
+export interface BiMeasureDescriptor {
+  /** 指标编码 */
+  code: string;
+  /** 指标名称 */
+  name: string;
+  /** 指标类型 */
+  type: string;
+  /** 允许的聚合函数 */
+  aggregations: string[];
+}
+
+/** BI 查询预览请求。 */
+export interface PreviewBiQueryRequest {
+  /** 语义查询计划 */
+  query: BiQuerySpec | undefined;
+}
+
+/** BI 语义查询计划。 */
+export interface BiQuerySpec {
+  /** 数据源编码 */
+  source_code: string;
+  /** 分组维度编码 */
+  dimensions: string[];
+  /** 查询指标 */
+  measures: BiMeasureSpec[];
+  /** 过滤条件 */
+  filters: BiFilterSpec[];
+  /** 结果行数上限，默认100 */
+  limit: number;
+  /** 时间范围 */
+  time_range:
+    | BiTimeRangeSpec
+    | undefined;
+  /** 结果排序规则 */
+  orders: BiOrderSpec[];
+}
+
+/** BI 时间范围。 */
+export interface BiTimeRangeSpec {
+  /** 时间维度编码 */
+  field: string;
+  /** 范围起点 */
+  start: string;
+  /** 范围终点 */
+  end: string;
+}
+
+/** BI 结果排序规则。 */
+export interface BiOrderSpec {
+  /** 已选择的维度或指标编码 */
+  field: string;
+  /** 排序方向 */
+  direction: string;
+}
+
+/** BI 指标查询项。 */
+export interface BiMeasureSpec {
+  /** 指标编码 */
+  code: string;
+  /** 聚合函数 */
+  aggregation: string;
+}
+
+/** BI 过滤条件。 */
+export interface BiFilterSpec {
+  /** 字段编码 */
+  field: string;
+  /** 操作符 */
+  operator: string;
+  /** 过滤值 */
+  values: string[];
+}
+
+/** BI 查询结果。 */
+export interface BiQueryResult {
+  /** 结果列 */
+  columns: BiResultColumn[];
+  /** 结果行 */
+  rows: BiResultRow[];
+  /** 是否因限制截断 */
+  truncated: boolean;
+  /** 查询耗时毫秒 */
+  elapsed_ms: number;
+  /** 本次成功查询记录ID */
+  query_record_id: number;
+}
+
+/** BI 结果列。 */
+export interface BiResultColumn {
+  /** 列编码 */
+  code: string;
+  /** 列名称 */
+  name: string;
+  /** 列类型 */
+  type: string;
+}
+
+/** BI 结果行。 */
+export interface BiResultRow {
+  /** 按列顺序排列的值 */
+  values: string[];
+}
+
+/** BI 自然语言问数请求。 */
+export interface AskBiQueryRequest {
+  /** 自然语言问题 */
+  question: string;
+  /** 所选供应商ID；留空时使用首个可用模型 */
+  provider_id: number;
+  /** 所选模型名称 */
+  model_name: string;
+}
+
+/** BI 自然语言问数响应。 */
+export interface AskBiQueryResponse {
+  /** 模型生成并校验后的查询计划 */
+  query:
+    | BiQuerySpec
+    | undefined;
+  /** 查询结果 */
+  result:
+    | BiQueryResult
+    | undefined;
+  /** 建议图表类型 */
+  chart_type: string;
+  /** 建议图表标题 */
+  title: string;
+}
+
+/** BI 语义查询服务。 */
+export interface BiQueryService {
+  /** 查询当前用户可用的数据源目录。 */
+  ListBiSources(request: ListBiSourcesRequest): Promise<ListBiSourcesResponse>;
+  /** 预览一个已经由前端配置的语义查询。 */
+  PreviewBiQuery(request: PreviewBiQueryRequest): Promise<BiQueryResult>;
+  /** 自然语言生成语义查询并返回预览结果。 */
+  AskBiQuery(request: AskBiQueryRequest): Promise<AskBiQueryResponse>;
+}

package/dist/package/src/rpc/bi/admin/v1/bi_query_record.ts

@@ -0,0 +1,98 @@
+// Code generated by protoc-gen-ts_proto. DO NOT EDIT.
+// versions:
+//   protoc-gen-ts_proto  v2.12.1
+//   protoc               unknown
+// source: bi/admin/v1/bi_query_record.proto
+
+/* eslint-disable */
+import type { BiQueryResult } from "./bi_query";
+
+/** 智能问数状态枚举。 */
+export enum BiQueryStatus {
+  /** BI_QUERY_STATUS_UNSPECIFIED - 未指定智能问数状态。 */
+  BI_QUERY_STATUS_UNSPECIFIED = 0,
+  /** BI_QUERY_STATUS_SUCCESS - 成功。 */
+  BI_QUERY_STATUS_SUCCESS = 1,
+  /** BI_QUERY_STATUS_FAILED - 失败。 */
+  BI_QUERY_STATUS_FAILED = 2,
+}
+
+/** 智能问数分页查询条件。 */
+export interface PageBiQueryRequest {
+  /** 问题内容 */
+  question: string;
+  /** 问数状态：枚举【BiQueryStatus】 */
+  status?:
+    | BiQueryStatus
+    | undefined;
+  /** 数据源编码 */
+  source_code: string;
+  /** 当前页码 */
+  page_num: number;
+  /** 每页行数 */
+  page_size: number;
+}
+
+/** 智能问数分页响应。 */
+export interface PageBiQueryResponse {
+  /** 智能问数记录列表 */
+  queries: BiQueryRecord[];
+  /** 总数 */
+  total: number;
+}
+
+/** 查询智能问数记录请求。 */
+export interface GetBiQueryRequest {
+  /** 记录ID */
+  id: number;
+}
+
+/** BI 查询记录。 */
+export interface BiQueryRecord {
+  /** 记录ID */
+  id: number;
+  /** 租户ID */
+  tenant_id: number;
+  /** 用户ID */
+  user_id: number;
+  /** 项目ID */
+  project_id: number;
+  /** 仪表盘ID */
+  dashboard_id: number;
+  /** 仪表盘版本 */
+  dashboard_version: number;
+  /** 图表组件ID */
+  widget_id: string;
+  /** 数据源编码 */
+  source_code: string;
+  /** 自然语言问题，非问数查询为空 */
+  question: string;
+  /** 语义查询计划JSON */
+  query_json: string;
+  /** 查询计划哈希 */
+  query_hash: string;
+  /** 问数状态：枚举【BiQueryStatus】 */
+  status: BiQueryStatus;
+  /** 结果行数 */
+  row_count: number;
+  /** 是否截断：0否，1是 */
+  truncated: number;
+  /** 查询耗时毫秒，问数包含模型生成耗时 */
+  elapsed_ms: number;
+  /** 失败原因 */
+  error_msg: string;
+  /** 创建时间 */
+  created_at: string;
+  /** 用户账号 */
+  user_name: string;
+  /** 完整类型化查询结果，仅详情返回 */
+  result: BiQueryResult | undefined;
+}
+
+/** BI 查询记录管理服务。 */
+export interface BiQueryRecordService {
+  /** 分页查询当前用户的自然语言问数历史。 */
+  PageBiQuery(request: PageBiQueryRequest): Promise<PageBiQueryResponse>;
+  /** 查询智能问数记录详情。 */
+  GetBiQuery(request: GetBiQueryRequest): Promise<BiQueryRecord>;
+}