@visactor/vbi 0.0.0

package/dist/builder/connector.d.ts

@@ -0,0 +1,7 @@
+import { VBIConnector, VBIConnectorId } from '../types/connector/connector';
+export declare const connectorMap: Map<VBIConnectorId, VBIConnector | (() => Promise<VBIConnector>)>;
+export declare const registerConnector: (id: VBIConnectorId, connector: VBIConnector | (() => Promise<VBIConnector>)) => void;
+export declare const getConnector: (id: VBIConnectorId) => Promise<{
+    discoverSchema: () => Promise<import("..").VBISchema>;
+    query: (queryProps: import("..").VBIQueryProps) => Promise<import("..").VBIQueryResult>;
+}>;

package/dist/builder/index.d.ts

@@ -0,0 +1,3 @@
+export { VBIBuilder } from './vbi-builder';
+export { VBI } from './vbi';
+export { MeasuresBuilder, DimensionsBuilder, ChartTypeBuilder, HavingFiltersBuilder } from './sub-builders';

package/dist/builder/sub-builders/chart-type/chart-type-builder.d.ts

@@ -0,0 +1,39 @@
+import { ObserveCallback } from '../../../types';
+import * as Y from 'yjs';
+/**
+ * @description 图表类型构建器，用于切换和获取图表类型。支持表格、柱状图、折线图、饼图、散点图等多种图表类型
+ */
+export declare class ChartTypeBuilder {
+    private dsl;
+    /**
+     * @description 构造函数
+     */
+    constructor(_doc: Y.Doc, dsl: Y.Map<any>);
+    /**
+     * @description 监听图表类型变化
+     * @param callback - 回调函数
+     */
+    /**
+     * @description 监听图表类型变化，返回取消监听的函数
+     * @param callback - 回调函数
+     * @returns 取消监听的函数
+     */
+    observe(callback: ObserveCallback): () => void;
+    /**
+     * @description 设置图表类型
+     * @param chartType - 图表类型
+     */
+    changeChartType(chartType: string): void;
+    /**
+     * @description 获取当前图表类型
+     */
+    getChartType(): string;
+    /**
+     * @description 导出为 JSON
+     */
+    toJson(): string;
+    /**
+     * @description 获取所有支持的图表类型
+     */
+    getAvailableChartTypes(): string[];
+}

package/dist/builder/sub-builders/chart-type/index.d.ts

@@ -0,0 +1 @@
+export { ChartTypeBuilder } from './chart-type-builder';

package/dist/builder/sub-builders/dimensions/dim-builder.d.ts

@@ -0,0 +1,48 @@
+import * as Y from 'yjs';
+import type { ObserveCallback, VBIDimension, VBIDimensionGroup, VBIDimensionTree } from '../../../types';
+import { DimensionNodeBuilder } from './dim-node-builder';
+/**
+ * @description 维度构建器，用于添加、修改、删除维度配置。维度是数据的分类字段，如：时间、地区、产品类别
+ */
+export declare class DimensionsBuilder {
+    private dsl;
+    constructor(_doc: Y.Doc, dsl: Y.Map<any>);
+    /**
+     * @description 添加一个维度
+     * @param field - 字段名
+     * @param callback - 回调函数
+     */
+    add(field: string, callback: (node: DimensionNodeBuilder) => void): DimensionsBuilder;
+    /**
+     * @description 删除指定字段的维度
+     * @param field - 字段名
+     */
+    remove(field: VBIDimension['field']): DimensionsBuilder;
+    /**
+     * @description 更新指定维度字段的配置
+     * @param field - 字段名
+     * @param callback - 回调函数
+     */
+    update(field: string, callback: (node: DimensionNodeBuilder) => void): DimensionsBuilder;
+    /**
+     * @description 根据字段名查找维度
+     * @param field - 字段名
+     */
+    find(field: VBIDimension['field']): DimensionNodeBuilder | undefined;
+    /**
+     * @description 获取所有维度
+     */
+    findAll(): DimensionNodeBuilder[];
+    /**
+     * @description 导出所有维度为 JSON 数组
+     */
+    toJson(): VBIDimension[];
+    /**
+     * @description 监听维度变化，返回取消监听的函数
+     * @param callback - 回调函数
+     * @returns 取消监听的函数
+     */
+    observe(callback: ObserveCallback): () => void;
+    static isDimensionNode(node: VBIDimensionTree[0]): node is VBIDimension;
+    static isDimensionGroup(node: VBIDimensionTree[0]): node is VBIDimensionGroup;
+}

package/dist/builder/sub-builders/dimensions/dim-node-builder.d.ts

@@ -0,0 +1,22 @@
+import * as Y from 'yjs';
+import { VBIDimension } from '../../../types';
+/**
+ * @description 维度节点构建器，用于配置单个维度
+ */
+export declare class DimensionNodeBuilder {
+    private yMap;
+    constructor(yMap: Y.Map<any>);
+    /**
+     * @description 获取字段名
+     */
+    getField(): string;
+    /**
+     * @description 设置显示名称
+     * @param alias - 显示名称
+     */
+    setAlias(alias: string): this;
+    /**
+     * @description 导出为 JSON
+     */
+    toJson(): VBIDimension;
+}

package/dist/builder/sub-builders/dimensions/index.d.ts

@@ -0,0 +1,2 @@
+export * from './dim-builder';
+export * from './dim-node-builder';

package/dist/builder/sub-builders/havingFilters/having-builder.d.ts

@@ -0,0 +1,55 @@
+import * as Y from 'yjs';
+import type { VBIHavingFilter } from '../../../types';
+import { HavingFiltersNodeBuilder } from './having-node-builder';
+import type { YArrayEvent, Transaction } from 'yjs';
+/**
+ * @description Having 过滤构建器，用于添加、修改、删除分组后过滤条件。Having 过滤在数据聚合后生效，用于筛选分组结果
+ */
+export declare class HavingFiltersBuilder {
+    private dsl;
+    constructor(_doc: Y.Doc, dsl: Y.Map<any>);
+    /**
+     * @description 添加一个 Having 过滤条件
+     * @param field - 字段名
+     * @param callback - 回调函数
+     */
+    add(field: string, callback: (node: HavingFiltersNodeBuilder) => void): HavingFiltersBuilder;
+    /**
+     * @description 更新指定字段的过滤条件
+     * @param field - 字段名
+     * @param callback - 回调函数
+     */
+    update(field: string, callback: (node: HavingFiltersNodeBuilder) => void): HavingFiltersBuilder;
+    /**
+     * @description 根据字段名删除 Having 过滤条件
+     * @param field - 字段名
+     */
+    remove(field: string): HavingFiltersBuilder;
+    /**
+     * @description 根据字段名查找 Having 过滤条件
+     * @param field - 字段名
+     */
+    find(field: string): HavingFiltersNodeBuilder | undefined;
+    /**
+     * @description 获取所有 Having 过滤条件
+     */
+    findAll(): HavingFiltersNodeBuilder[];
+    /**
+     * @description 清空所有 Having 过滤条件
+     */
+    clear(): this;
+    /**
+     * @description 导出所有 Having 过滤条件为 JSON 数组
+     */
+    toJson(): VBIHavingFilter[];
+    /**
+     * @description 监听过滤条件变化
+     * @param callback - 回调函数
+     */
+    /**
+     * @description 监听过滤条件变化，返回取消监听的函数
+     * @param callback - 回调函数
+     * @returns 取消监听的函数
+     */
+    observe(callback: (e: YArrayEvent<any>, trans: Transaction | null) => void): () => void;
+}

package/dist/builder/sub-builders/havingFilters/having-node-builder.d.ts

@@ -0,0 +1,27 @@
+import * as Y from 'yjs';
+import { VBIHavingFilter } from '../../../types';
+/**
+ * @description Having 过滤节点构建器，用于配置单个 Having 过滤条件
+ */
+export declare class HavingFiltersNodeBuilder {
+    private yMap;
+    constructor(yMap: Y.Map<any>);
+    /**
+     * @description 获取字段名
+     */
+    getField(): string;
+    /**
+     * @description 设置过滤条件的值
+     * @param value - 过滤值
+     */
+    setValue(value: unknown): this;
+    /**
+     * @description 设置过滤操作符
+     * @param operator - 操作符
+     */
+    setOperator(operator: string): this;
+    /**
+     * @description 导出为 JSON
+     */
+    toJson(): VBIHavingFilter;
+}

package/dist/builder/sub-builders/havingFilters/index.d.ts

@@ -0,0 +1,2 @@
+export { HavingFiltersBuilder } from './having-builder';
+export { HavingFiltersNodeBuilder } from './having-node-builder';

package/dist/builder/sub-builders/index.d.ts

@@ -0,0 +1,5 @@
+export { MeasuresBuilder } from './measures';
+export { DimensionsBuilder } from './dimensions';
+export { ChartTypeBuilder } from './chart-type';
+export { WhereFiltersBuilder } from './whereFilters';
+export { HavingFiltersBuilder } from './havingFilters';

package/dist/builder/sub-builders/measures/index.d.ts

@@ -0,0 +1,2 @@
+export * from './mea-builder';
+export * from './mea-node-builder';

package/dist/builder/sub-builders/measures/mea-builder.d.ts

@@ -0,0 +1,52 @@
+import * as Y from 'yjs';
+import type { ObserveCallback, VBIMeasure, VBIMeasureGroup, VBIMeasureTree } from '../../../types';
+import { MeasureNodeBuilder } from './mea-node-builder';
+/**
+ * @description 度量构建器，用于添加、修改、删除度量配置。度量是数据的数值字段，如：销售额、利润、数量
+ */
+export declare class MeasuresBuilder {
+    private dsl;
+    constructor(_doc: Y.Doc, dsl: Y.Map<any>);
+    /**
+     * @description 添加一个度量
+     * @param field - 字段名
+     * @param callback - 回调函数
+     */
+    add(field: string, callback: (node: MeasureNodeBuilder) => void): MeasuresBuilder;
+    /**
+     * @description 删除指定字段的度量
+     * @param field - 字段名
+     */
+    remove(field: VBIMeasure['field']): MeasuresBuilder;
+    /**
+     * @description 更新度量配置
+     * @param field - 字段名
+     * @param callback - 回调函数
+     */
+    update(field: string, callback: (node: MeasureNodeBuilder) => void): MeasuresBuilder;
+    /**
+     * @description 根据字段名查找度量
+     * @param field - 字段名
+     */
+    find(field: VBIMeasure['field']): MeasureNodeBuilder | undefined;
+    /**
+     * @description 获取所有度量
+     */
+    findAll(): MeasureNodeBuilder[];
+    /**
+     * @description 导出所有度量为 JSON 数组
+     */
+    toJson(): VBIMeasure[];
+    /**
+     * @description 监听度量变化
+     * @param callback - 回调函数
+     */
+    /**
+     * @description 监听度量变化，返回取消监听的函数
+     * @param callback - 回调函数
+     * @returns 取消监听的函数
+     */
+    observe(callback: ObserveCallback): () => void;
+    static isMeasureNode(node: VBIMeasureTree[0]): node is VBIMeasure;
+    static isMeasureGroup(node: VBIMeasureTree[0]): node is VBIMeasureGroup;
+}

package/dist/builder/sub-builders/measures/mea-node-builder.d.ts

@@ -0,0 +1,32 @@
+import * as Y from 'yjs';
+import { VBIMeasure } from '../../../types';
+/**
+ * @description 度量节点构建器，用于配置单个度量
+ */
+export declare class MeasureNodeBuilder {
+    private yMap;
+    constructor(yMap: Y.Map<any>);
+    /**
+     * @description 获取字段名
+     */
+    getField(): string;
+    /**
+     * @description 设置显示名称
+     * @param alias - 显示名称
+     */
+    setAlias(alias: string): this;
+    /**
+     * @description 设置图表编码位置
+     * @param encoding - 编码位置（yAxis/xAxis/color/size）
+     */
+    setEncoding(encoding: VBIMeasure['encoding']): this;
+    /**
+     * @description 设置聚合函数
+     * @param aggregate - 聚合配置
+     */
+    setAggregate(aggregate: VBIMeasure['aggregate']): this;
+    /**
+     * @description 导出为 JSON
+     */
+    toJson(): VBIMeasure;
+}

package/dist/builder/sub-builders/whereFilters/index.d.ts

@@ -0,0 +1 @@
+export { WhereFiltersBuilder } from './where-builder';

package/dist/builder/sub-builders/whereFilters/where-builder.d.ts

@@ -0,0 +1,55 @@
+import * as Y from 'yjs';
+import type { VBIFilter, ObserveCallback } from '../../../types';
+import { WhereFilterNodeBuilder } from './where-node-builder';
+/**
+ * @description Where 过滤构建器，用于添加、修改、删除行级过滤条件。Where 过滤在数据查询前生效，用于筛选原始数据
+ */
+export declare class WhereFiltersBuilder {
+    private dsl;
+    private doc;
+    constructor(doc: Y.Doc, dsl: Y.Map<any>);
+    /**
+     * @description 添加一个 Where 过滤条件
+     * @param field - 字段名
+     * @param callback - 回调函数
+     */
+    add(field: string, callback: (node: WhereFilterNodeBuilder) => void): WhereFiltersBuilder;
+    /**
+     * @description 更新指定字段的过滤条件
+     * @param field - 字段名
+     * @param callback - 回调函数
+     */
+    update(field: string, callback: (node: WhereFilterNodeBuilder) => void): WhereFiltersBuilder;
+    /**
+     * @description 删除指定字段的过滤条件
+     * @param field - 字段名
+     */
+    remove(field: string): WhereFiltersBuilder;
+    /**
+     * @description 根据字段名查找过滤条件
+     * @param field - 字段名
+     */
+    find(field: string): WhereFilterNodeBuilder | undefined;
+    /**
+     * @description 获取所有 Where 过滤条件
+     */
+    findAll(): WhereFilterNodeBuilder[];
+    /**
+     * @description 清空所有 Where 过滤条件
+     */
+    clear(): this;
+    /**
+     * @description 导出所有 Where 过滤条件为 JSON 数组
+     */
+    toJson(): VBIFilter[];
+    /**
+     * @description 监听过滤条件变化
+     * @param callback - 回调函数
+     */
+    /**
+     * @description 监听过滤条件变化，返回取消监听的函数
+     * @param callback - 回调函数
+     * @returns 取消监听的函数
+     */
+    observe(callback: ObserveCallback): () => void;
+}

package/dist/builder/sub-builders/whereFilters/where-node-builder.d.ts

@@ -0,0 +1,27 @@
+import * as Y from 'yjs';
+import { VBIFilter } from '../../../types';
+/**
+ * @description Where 过滤节点构建器，用于配置单个 Where 过滤条件
+ */
+export declare class WhereFilterNodeBuilder {
+    private yMap;
+    constructor(yMap: Y.Map<any>);
+    /**
+     * @description 获取字段名
+     */
+    getField(): string;
+    /**
+     * @description 设置过滤操作符
+     * @param operator - 操作符
+     */
+    setOperator(operator: string): this;
+    /**
+     * @description 设置过滤值
+     * @param value - 过滤值
+     */
+    setValue(value: unknown): this;
+    /**
+     * @description 导出为 JSON
+     */
+    toJson(): VBIFilter;
+}

package/dist/builder/vbi-builder.d.ts

@@ -0,0 +1,32 @@
+import * as Y from 'yjs';
+import { VSeedDSL } from '@visactor/vseed';
+import { VQueryDSL } from '@visactor/vquery';
+import { DimensionsBuilder } from './sub-builders/dimensions';
+import { MeasuresBuilder } from './sub-builders/measures';
+import { HavingFiltersBuilder } from './sub-builders/havingFilters';
+import { WhereFiltersBuilder } from './sub-builders';
+import { ChartTypeBuilder } from './sub-builders';
+import { VBIDSL, VBIBuilderInterface } from '../types';
+export declare class VBIBuilder implements VBIBuilderInterface {
+    doc: Y.Doc;
+    dsl: Y.Map<any>;
+    undoManager: Y.UndoManager;
+    chartType: ChartTypeBuilder;
+    measures: MeasuresBuilder;
+    dimensions: DimensionsBuilder;
+    havingFilters: HavingFiltersBuilder;
+    whereFilters: WhereFiltersBuilder;
+    constructor(doc: Y.Doc);
+    applyUpdate(update: Uint8Array): void;
+    encodeStateAsUpdate(targetStateVector?: Uint8Array): Uint8Array<ArrayBufferLike>;
+    buildVSeed: () => Promise<VSeedDSL>;
+    buildVQuery: () => VQueryDSL;
+    build: () => VBIDSL;
+    getSchema: () => Promise<{
+        name: string;
+        type: string;
+    }[]>;
+    setLimit(limit: number): this;
+    setLocale(locale: string): this;
+    setTheme(theme: string): this;
+}

package/dist/builder/vbi.d.ts

@@ -0,0 +1,16 @@
+import { VBIConnectorId } from '../types/connector/connector';
+import { VBIDSL } from '../types';
+import { VBIBuilder } from './vbi-builder';
+export declare const VBI: {
+    connectorMap: Map<string, {
+        discoverSchema: () => Promise<import("../types").VBISchema>;
+        query: (queryProps: import("../types").VBIQueryProps) => Promise<import("../types").VBIQueryResult>;
+    } | (() => Promise<import("../types").VBIConnector>)>;
+    registerConnector: (id: VBIConnectorId, connector: import("../types").VBIConnector | (() => Promise<import("../types").VBIConnector>)) => void;
+    getConnector: (id: VBIConnectorId) => Promise<{
+        discoverSchema: () => Promise<import("../types").VBISchema>;
+        query: (queryProps: import("../types").VBIQueryProps) => Promise<import("../types").VBIQueryResult>;
+    }>;
+    generateEmptyDSL: (connectorId: VBIConnectorId) => VBIDSL;
+    from: (vbi: VBIDSL) => VBIBuilder;
+};