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

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

@@ -0,0 +1,157 @@
+/** 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/declarations/src/rpc/bi/admin/v1/bi_query.js

@@ -0,0 +1,6 @@
+// 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
+export {};

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

@@ -0,0 +1,83 @@
+import type { BiQueryResult } from "./bi_query";
+/** 智能问数状态枚举。 */
+export declare 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>;
+}

package/dist/package/declarations/src/rpc/bi/admin/v1/bi_query_record.js

@@ -0,0 +1,15 @@
+// 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
+/** 智能问数状态枚举。 */
+export var BiQueryStatus;
+(function (BiQueryStatus) {
+    /** BI_QUERY_STATUS_UNSPECIFIED - 未指定智能问数状态。 */
+    BiQueryStatus[BiQueryStatus["BI_QUERY_STATUS_UNSPECIFIED"] = 0] = "BI_QUERY_STATUS_UNSPECIFIED";
+    /** BI_QUERY_STATUS_SUCCESS - 成功。 */
+    BiQueryStatus[BiQueryStatus["BI_QUERY_STATUS_SUCCESS"] = 1] = "BI_QUERY_STATUS_SUCCESS";
+    /** BI_QUERY_STATUS_FAILED - 失败。 */
+    BiQueryStatus[BiQueryStatus["BI_QUERY_STATUS_FAILED"] = 2] = "BI_QUERY_STATUS_FAILED";
+})(BiQueryStatus || (BiQueryStatus = {}));

package/dist/package/declarations/src/rpc/bi/admin/v1/bi_source.d.ts

@@ -0,0 +1,301 @@
+import type { SecretCrypto } from "../../../common/v1/types";
+/** BI 数据源分页查询条件。 */
+export interface PageBiSourceRequest {
+    /** 数据源编码 */
+    code: string;
+    /** 数据源名称 */
+    name: string;
+    /** 服务端数据库客户端名称 */
+    source_name: string;
+    /** 状态：1启用，2禁用 */
+    status?: number | undefined;
+    /** 页码 */
+    page_num: number;
+    /** 每页数量 */
+    page_size: number;
+}
+/** BI 数据源分页响应。 */
+export interface PageBiSourceResponse {
+    /** 数据源配置列表 */
+    sources: BiSource[];
+    /** 总数 */
+    total: number;
+}
+/** 查询 BI 数据源请求。 */
+export interface GetBiSourceRequest {
+    /** 数据源ID */
+    id: number;
+}
+/** 创建 BI 数据源请求。 */
+export interface CreateBiSourceRequest {
+    /** 数据源配置 */
+    source: BiSourceForm | undefined;
+}
+/** 更新 BI 数据源请求。 */
+export interface UpdateBiSourceRequest {
+    /** 数据源配置 */
+    source: BiSourceForm | undefined;
+}
+/** 删除 BI 数据源请求。 */
+export interface DeleteBiSourceRequest {
+    /** 数据源ID */
+    id: number;
+}
+/** 删除 BI 数据源响应。 */
+export interface DeleteBiSourceResponse {
+}
+/** 修改 BI 数据源状态请求。 */
+export interface SetBiSourceStatusRequest {
+    /** 数据源ID */
+    id: number;
+    /** 状态：1启用，2禁用 */
+    status: number;
+}
+/** 查询服务端数据库客户端请求。 */
+export interface OptionBiSourceDatabaseRequest {
+}
+/** 查询服务端数据库客户端响应。 */
+export interface OptionBiSourceDatabaseResponse {
+    /** 服务端数据库客户端列表 */
+    databases: BiSourceDatabase[];
+}
+/** 服务端数据库客户端选项。 */
+export interface BiSourceDatabase {
+    /** 客户端名称 */
+    name: string;
+    /** 数据库驱动 */
+    driver: string;
+}
+/** 测试 BI 数据源请求。 */
+export interface TestBiSourceRequest {
+    /** 待测试数据源 */
+    source: BiSourceForm | undefined;
+}
+/** 测试 BI 数据源响应。 */
+export interface TestBiSourceResponse {
+    /** 是否可访问 */
+    success: boolean;
+    /** 测试结果说明 */
+    message: string;
+}
+/** 查询数据源数据库表结构的请求。 */
+export interface ListBiSourceTablesRequest {
+    /** 数据源ID */
+    id: number;
+}
+/** 数据库表字段的结构信息。 */
+export interface BiSourceSchemaColumn {
+    /** 字段名称 */
+    name: string;
+    /** 数据库字段类型 */
+    data_type: string;
+    /** 是否允许为空 */
+    nullable: boolean;
+    /** 是否为主键 */
+    primary_key: boolean;
+    /** 是否有单列唯一约束 */
+    unique: boolean;
+    /** 字段注释 */
+    comment: string;
+}
+/** 数据库中的表或视图结构。 */
+export interface BiSourceSchemaTable {
+    /** 表结构标识 */
+    key: string;
+    /** 数据库Schema */
+    schema_name: string;
+    /** 表或视图名称 */
+    name: string;
+    /** 表类型 */
+    table_type: string;
+    /** 字段列表 */
+    columns: BiSourceSchemaColumn[];
+    /** 表或视图注释 */
+    comment: string;
+}
+/** 查询数据源表结构的响应。 */
+export interface ListBiSourceTablesResponse {
+    /** 数据库表结构 */
+    tables: BiSourceSchemaTable[];
+}
+/** 保存数据源语义模型的请求。 */
+export interface SaveBiSourceModelRequest {
+    /** 数据源ID */
+    id: number;
+    /** 数据源语义模型 */
+    model: BiSourceModel | undefined;
+}
+/** 数据源可用的表、关联关系和业务语义。 */
+export interface BiSourceModel {
+    /** 事实表标识 */
+    base_table: string;
+    /** 选中的表结构 */
+    tables: BiSourceModelTable[];
+    /** 表关联关系 */
+    relations: BiSourceRelation[];
+    /** 语义维度 */
+    dimensions: BiSourceDimension[];
+    /** 语义指标 */
+    measures: BiSourceMeasure[];
+}
+/** 语义模型中的表节点。 */
+export interface BiSourceModelTable {
+    /** 表结构标识 */
+    key: string;
+    /** 租户隔离字段，为空表示连接级隔离或共享表 */
+    tenant_column: string;
+    /** 画布横坐标 */
+    x: number;
+    /** 画布纵坐标 */
+    y: number;
+}
+/** 两张表之间经过确认的多对一关系。 */
+export interface BiSourceRelation {
+    /** 已连接表标识 */
+    left_table: string;
+    /** 已连接表字段 */
+    left_column: string;
+    /** 维度表标识 */
+    right_table: string;
+    /** 维度表唯一字段 */
+    right_column: string;
+    /** 连接类型 */
+    join_type: string;
+}
+/** 数据源语义维度。 */
+export interface BiSourceDimension {
+    /** 语义编码 */
+    code: string;
+    /** 展示名称 */
+    name: string;
+    /** BI字段类型 */
+    type: string;
+    /** 所属表标识 */
+    table: string;
+    /** 数据库字段 */
+    column: string;
+    /** 是否允许过滤 */
+    filterable: boolean;
+}
+/** 数据源语义指标。 */
+export interface BiSourceMeasure {
+    /** 语义编码 */
+    code: string;
+    /** 展示名称 */
+    name: string;
+    /** BI字段类型 */
+    type: string;
+    /** 所属表标识 */
+    table: string;
+    /** 数据库字段 */
+    column: string;
+    /** 允许的聚合函数 */
+    aggregations: string[];
+}
+/** BI 数据源配置表单。 */
+export interface BiSourceForm {
+    /** 数据源ID */
+    id: number;
+    /** 数据源编码 */
+    code: string;
+    /** 数据源名称 */
+    name: string;
+    /** 数据源说明 */
+    description: string;
+    /** 服务端数据库客户端名称 */
+    source_name: string;
+    /** 数据库驱动 */
+    driver: string;
+    /** 数据库主机 */
+    host: string;
+    /** 数据库端口 */
+    port: number;
+    /** 数据库名称 */
+    database_name: string;
+    /** 数据库用户名 */
+    username: string;
+    /** 数据库密码密文 */
+    password: SecretCrypto | undefined;
+    /** PostgreSQL SSL模式 */
+    ssl_mode: string;
+    /** 数据库 Schema */
+    schema_name: string;
+    /** 最大结果行数 */
+    max_rows: number;
+    /** 状态：1启用，2禁用 */
+    status: number;
+}
+/** BI 数据源配置。 */
+export interface BiSource {
+    /** 数据源ID */
+    id: number;
+    /** 租户ID */
+    tenant_id: number;
+    /** 数据源编码 */
+    code: string;
+    /** 数据源名称 */
+    name: string;
+    /** 数据源说明 */
+    description: string;
+    /** 服务端数据库客户端名称 */
+    source_name: string;
+    /** 数据库驱动 */
+    driver: string;
+    /** 数据库主机 */
+    host: string;
+    /** 数据库端口 */
+    port: number;
+    /** 数据库名称 */
+    database_name: string;
+    /** 数据库用户名 */
+    username: string;
+    /** 是否已保存数据库密码 */
+    password_configured: boolean;
+    /** PostgreSQL SSL模式 */
+    ssl_mode: string;
+    /** 数据库 Schema */
+    schema_name: string;
+    /** 数据库表或视图名称 */
+    table_name: string;
+    /** 租户列 */
+    tenant_column: string;
+    /** 维度和指标语义配置 JSON */
+    schema_json: string;
+    /** 状态：1启用，2禁用 */
+    status: number;
+    /** 语义版本 */
+    version: number;
+    /** 最大结果行数 */
+    max_rows: number;
+    /** 创建时间 */
+    created_at: string;
+    /** 更新时间 */
+    updated_at: string;
+    /** 是否已配置语义模型 */
+    model_configured: boolean;
+    /** 模型选中的表数量 */
+    table_count: number;
+}
+/** BI 数据源配置管理服务。 */
+export interface BiSourceService {
+    /** 分页查询当前租户的数据源配置。 */
+    PageBiSource(request: PageBiSourceRequest): Promise<PageBiSourceResponse>;
+    /** 查询数据源配置详情。 */
+    GetBiSource(request: GetBiSourceRequest): Promise<BiSource>;
+    /** 创建数据源配置。 */
+    CreateBiSource(request: CreateBiSourceRequest): Promise<BiSource>;
+    /** 更新数据源配置。 */
+    UpdateBiSource(request: UpdateBiSourceRequest): Promise<BiSource>;
+    /** 删除数据源配置。 */
+    DeleteBiSource(request: DeleteBiSourceRequest): Promise<DeleteBiSourceResponse>;
+    /** 修改数据源启用状态。 */
+    SetBiSourceStatus(request: SetBiSourceStatusRequest): Promise<BiSource>;
+    /** 查询服务端已配置的数据库客户端选项。 */
+    OptionBiSourceDatabase(request: OptionBiSourceDatabaseRequest): Promise<OptionBiSourceDatabaseResponse>;
+    /** 测试数据源连接是否可访问。 */
+    TestBiSource(request: TestBiSourceRequest): Promise<TestBiSourceResponse>;
+    /** 发现已保存数据源中的表、字段和唯一键。 */
+    ListBiSourceTables(request: ListBiSourceTablesRequest): Promise<ListBiSourceTablesResponse>;
+    /** 保存经过校验的多表语义模型。 */
+    SaveBiSourceModel(request: SaveBiSourceModelRequest): Promise<BiSource>;
+}

package/dist/package/declarations/src/rpc/bi/admin/v1/bi_source.js

@@ -0,0 +1,6 @@
+// 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_source.proto
+export {};

package/dist/package/declarations/src/rpc/common/v1/types.d.ts

@@ -0,0 +1,60 @@
+/** double 类型数组包装消息。 */
+export interface DoubleValues {
+    /** 值列表。 */
+    value: number[];
+}
+/** float 类型数组包装消息。 */
+export interface FloatValues {
+    /** 值列表。 */
+    value: number[];
+}
+/** int64 类型数组包装消息。 */
+export interface Int64Values {
+    /** 值列表。 */
+    value: number[];
+}
+/** uint64 类型数组包装消息。 */
+export interface UInt64Values {
+    /** 值列表。 */
+    value: number[];
+}
+/** int32 类型数组包装消息。 */
+export interface Int32Values {
+    /** 值列表。 */
+    value: number[];
+}
+/** uint32 类型数组包装消息。 */
+export interface UInt32Values {
+    /** 值列表。 */
+    value: number[];
+}
+/** bool 类型数组包装消息。 */
+export interface BoolValues {
+    /** 值列表。 */
+    value: boolean[];
+}
+/** string 类型数组包装消息。 */
+export interface StringValues {
+    /** 值列表。 */
+    value: string[];
+}
+/** bytes 类型数组包装消息。 */
+export interface BytesValues {
+    /** 值列表。 */
+    value: Uint8Array[];
+}
+/** 敏感字段密文，密码与各类密钥字段统一使用。 */
+export interface SecretCrypto {
+    /** 临时密钥ID */
+    key_id: string;
+    /** 随机值 */
+    nonce: string;
+    /** 加密算法 */
+    algorithm: string;
+    /** 加密后的对称密钥 */
+    encrypted_key: string;
+    /** 初始化向量 */
+    iv: string;
+    /** 传输时为密文，服务端解密后回填明文 */
+    text: string;
+}

package/dist/package/declarations/src/rpc/common/v1/types.js

@@ -0,0 +1,6 @@
+// Code generated by protoc-gen-ts_proto. DO NOT EDIT.
+// versions:
+//   protoc-gen-ts_proto  v2.12.1
+//   protoc               unknown
+// source: common/v1/types.proto
+export {};

package/dist/package/declarations/src/schema/layout.d.ts

@@ -0,0 +1,7 @@
+/** 流式放置只修改栅格坐标，浅拷贝卡片以支持响应式查询快照。 */
+export declare function flowPlace<T extends {
+    x?: number;
+    y?: number;
+    w: number;
+    h: number;
+}>(charts: T[], columns: number): T[];

package/dist/package/declarations/src/schema/layout.js

@@ -0,0 +1,52 @@
+/** 流式放置只修改栅格坐标，浅拷贝卡片以支持响应式查询快照。 */
+export function flowPlace(charts, columns) {
+    if (!Number.isInteger(columns) ||
+        columns < 1 ||
+        charts.some(item => !Number.isInteger(item.w) ||
+            !Number.isInteger(item.h) ||
+            (item.w ?? 6) < 1 ||
+            (item.w ?? 6) > columns ||
+            (item.h ?? 4) < 1))
+        throw new Error("卡片栅格尺寸无效");
+    const placed = charts.map(item => ({ ...item }));
+    const occupied = new Set();
+    const mark = (c) => {
+        const w = c.w ?? 6;
+        const h = c.h ?? 4;
+        for (let dx = 0; dx < w; dx++) {
+            for (let dy = 0; dy < h; dy++)
+                occupied.add(`${(c.x ?? 0) + dx},${(c.y ?? 0) + dy}`);
+        }
+    };
+    placed.forEach(c => {
+        if (c.x !== undefined && c.y !== undefined) {
+            mark(c);
+        }
+    });
+    for (const c of placed) {
+        if (c.x !== undefined && c.y !== undefined)
+            continue;
+        const w = c.w ?? 6;
+        const h = c.h ?? 4;
+        let found = false;
+        for (let y = 0; !found; y++) {
+            for (let x = 0; x + w <= columns; x++) {
+                let free = true;
+                for (let dx = 0; dx < w && free; dx++) {
+                    for (let dy = 0; dy < h && free; dy++) {
+                        if (occupied.has(`${x + dx},${y + dy}`))
+                            free = false;
+                    }
+                }
+                if (free) {
+                    c.x = x;
+                    c.y = y;
+                    mark(c);
+                    found = true;
+                    break;
+                }
+            }
+        }
+    }
+    return placed;
+}