@visactor/vbi 0.4.17 → 0.4.20

package/dist/builder/adapters/index.d.ts

@@ -0,0 +1 @@
+export * from './vquery-vseed';

package/dist/builder/adapters/vquery-vseed/build-vquery.d.ts

@@ -0,0 +1,3 @@
+import type { VBIChartQueryBuilder } from '../../../types';
+import type { DefaultVBIQueryDSL } from './types';
+export declare const buildVQueryDSL: VBIChartQueryBuilder<DefaultVBIQueryDSL>;

package/dist/builder/adapters/vquery-vseed/build-vseed.d.ts

@@ -0,0 +1,3 @@
+import type { VBIChartSeedBuilder } from '../../../types';
+import type { DefaultVBIQueryDSL, DefaultVBISeedDSL } from './types';
+export declare const buildVSeedDSL: VBIChartSeedBuilder<DefaultVBIQueryDSL, DefaultVBISeedDSL>;

package/dist/builder/adapters/vquery-vseed/index.d.ts

@@ -0,0 +1,7 @@
+import type { VBIChartBuilderAdapters } from '../../../types';
+import type { DefaultVBIQueryDSL, DefaultVBISeedDSL } from './types';
+export type { DefaultVBIQueryDSL, DefaultVBISeedDSL } from './types';
+export { buildVQueryDSL } from './build-vquery';
+export { buildVSeedDSL } from './build-vseed';
+export declare const defaultVBIChartBuilderAdapters: VBIChartBuilderAdapters<DefaultVBIQueryDSL, DefaultVBISeedDSL>;
+export declare const resolveVBIChartBuilderAdapters: <TQueryDSL = DefaultVBIQueryDSL, TSeedDSL = DefaultVBISeedDSL>(adapters?: Partial<VBIChartBuilderAdapters<TQueryDSL, TSeedDSL>>) => VBIChartBuilderAdapters<TQueryDSL, TSeedDSL>;

package/dist/builder/adapters/vquery-vseed/types.d.ts

@@ -0,0 +1,4 @@
+import type { VSeedDSL } from '@visactor/vseed';
+import type { VQueryDSL } from '@visactor/vquery';
+export type DefaultVBIQueryDSL = VQueryDSL;
+export type DefaultVBISeedDSL = VSeedDSL;

package/dist/builder/{vbi-builder.d.ts → builder.d.ts}

@@ -1,11 +1,11 @@
 import * as Y from 'yjs';
-import type { VSeedDSL } from '@visactor/vseed';
-import type { VQueryDSL } from '@visactor/vquery';
+import type { DefaultVBIQueryDSL, DefaultVBISeedDSL } from './adapters/vquery-vseed';
 import { DimensionsBuilder, MeasuresBuilder, HavingFilterBuilder, WhereFilterBuilder, ChartTypeBuilder, ThemeBuilder, LocaleBuilder, LimitBuilder, UndoManager } from './features';
-import type { VBIDSL, VBIBuilderInterface } from '../types';
-export declare class VBIBuilder implements VBIBuilderInterface {
+import type { BuildVSeedOptions, VBIChartDSL, VBIChartBuilderAdapters, VBIChartBuilderInterface, VBIChartBuilderOptions } from '../types';
+export declare class VBIChartBuilder<TQueryDSL = DefaultVBIQueryDSL, TSeedDSL = DefaultVBISeedDSL> implements VBIChartBuilderInterface<TQueryDSL, TSeedDSL> {
     doc: Y.Doc;
     dsl: Y.Map<any>;
+    adapters: VBIChartBuilderAdapters<TQueryDSL, TSeedDSL>;
     chartType: ChartTypeBuilder;
     measures: MeasuresBuilder;
     dimensions: DimensionsBuilder;
@@ -15,12 +15,12 @@ export declare class VBIBuilder implements VBIBuilderInterface {
     locale: LocaleBuilder;
     limit: LimitBuilder;
     undoManager: UndoManager;
-    constructor(doc: Y.Doc);
+    constructor(doc: Y.Doc, options?: VBIChartBuilderOptions<TQueryDSL, TSeedDSL>);
     applyUpdate: (update: Uint8Array, transactionOrigin?: any) => void;
     encodeStateAsUpdate: (targetStateVector?: Uint8Array) => Uint8Array<ArrayBufferLike>;
-    buildVSeed: () => Promise<VSeedDSL>;
-    buildVQuery: () => VQueryDSL;
-    build: () => VBIDSL;
+    buildVSeed: (options?: BuildVSeedOptions) => Promise<TSeedDSL>;
+    buildVQuery: () => TQueryDSL;
+    build: () => VBIChartDSL;
     isEmpty: () => boolean;
     getSchema: () => Promise<{
         name: string;

package/dist/builder/features/chart-type/chart-type-builder.d.ts

@@ -4,11 +4,12 @@ import * as Y from 'yjs';
  * @description 图表类型构建器，用于切换和获取图表类型。支持表格、柱状图、折线图、饼图、散点图等多种图表类型
  */
 export declare class ChartTypeBuilder {
+    private doc;
     private dsl;
     /**
      * @description 构造函数
      */
-    constructor(_doc: Y.Doc, dsl: Y.Map<any>);
+    constructor(doc: Y.Doc, dsl: Y.Map<any>);
     /**
      * @description 监听图表类型变化
      * @param callback - 回调函数
@@ -28,6 +29,24 @@ export declare class ChartTypeBuilder {
      * @description 获取当前图表类型
      */
     getChartType(): string;
+    /**
+     * @description 获取当前图表类型支持的维度编码
+     */
+    getSupportedDimensionEncodings(): import("./dimension-encoding").SupportedDimensionEncoding[];
+    /**
+     * @description 根据当前图表类型，按维度顺序返回推荐的维度编码
+     * @param dimensionCount - 维度数量，默认使用当前 DSL 中的维度数量
+     */
+    getRecommendedDimensionEncodings(dimensionCount?: number): import("./dimension-encoding").SupportedDimensionEncoding[];
+    /**
+     * @description 获取当前图表类型支持的指标编码
+     */
+    getSupportedMeasureEncodings(): import("./measure-encoding").SupportedMeasureEncoding[];
+    /**
+     * @description 根据当前图表类型，按指标顺序返回推荐的指标编码
+     * @param measureCount - 指标数量，默认使用当前 DSL 中的指标数量
+     */
+    getRecommendedMeasureEncodings(measureCount?: number): import("./measure-encoding").SupportedMeasureEncoding[];
     /**
      * @description 导出为 JSON
      */

package/dist/builder/features/chart-type/dimension-encoding.d.ts

@@ -0,0 +1,4 @@
+import type { VBIDimension } from '../../../types';
+export type SupportedDimensionEncoding = NonNullable<VBIDimension['encoding']>;
+export declare const getSupportedDimensionEncodingsForChartType: (chartType: string) => SupportedDimensionEncoding[];
+export declare const getRecommendedDimensionEncodingsForChartType: (chartType: string, dimensionCount: number) => SupportedDimensionEncoding[];

package/dist/builder/features/chart-type/measure-encoding.d.ts

@@ -0,0 +1,4 @@
+import type { VBIMeasure } from '../../../types';
+export type SupportedMeasureEncoding = NonNullable<VBIMeasure['encoding']>;
+export declare const getSupportedMeasureEncodingsForChartType: (chartType: string) => SupportedMeasureEncoding[];
+export declare const getRecommendedMeasureEncodingsForChartType: (chartType: string, measureCount: number) => SupportedMeasureEncoding[];

package/dist/builder/features/chart-type/reapply-dimension-encodings.d.ts

@@ -0,0 +1,2 @@
+import * as Y from 'yjs';
+export declare const reapplyDimensionEncodings: (dsl: Y.Map<any>, chartType: string) => void;

package/dist/builder/features/chart-type/reapply-measure-encodings.d.ts

@@ -0,0 +1,2 @@
+import * as Y from 'yjs';
+export declare const reapplyMeasureEncodings: (dsl: Y.Map<any>, chartType: string) => void;

package/dist/builder/features/dimensions/dim-builder.d.ts

@@ -1,10 +1,11 @@
 import * as Y from 'yjs';
-import type { ObserveCallback, VBIDimension, VBIDimensionGroup, VBIDimensionTree } from '../../../types';
+import type { ObserveDeepCallback, VBIDimension, VBIDimensionGroup, VBIDimensionTree } from '../../../types';
 import { DimensionNodeBuilder } from './dim-node-builder';
 /**
  * @description 维度构建器，用于添加、修改、删除维度配置。维度是数据的分类字段，如：时间、地区、产品类别
  */
 export declare class DimensionsBuilder {
+    private doc;
     private dsl;
     constructor(doc: Y.Doc, dsl: Y.Map<any>);
     /**
@@ -42,7 +43,7 @@ export declare class DimensionsBuilder {
      * @param callback - 回调函数
      * @returns 取消监听的函数
      */
-    observe(callback: ObserveCallback): () => void;
+    observe(callback: ObserveDeepCallback): () => void;
     static isDimensionNode(node: VBIDimensionTree[0]): node is VBIDimension;
     static isDimensionGroup(node: VBIDimensionTree[0]): node is VBIDimensionGroup;
 }

package/dist/builder/features/dimensions/dim-node-builder.d.ts

@@ -1,5 +1,5 @@
 import * as Y from 'yjs';
-import { VBIDimension } from '../../../types';
+import type { VBIDimension, VBISort } from '../../../types';
 /**
  * @description 维度节点构建器，用于配置单个维度
  */
@@ -14,11 +14,42 @@ export declare class DimensionNodeBuilder {
      * @description 获取字段名
      */
     getField(): string;
+    /**
+     * @description 获取图表编码位置
+     */
+    getEncoding(): VBIDimension['encoding'] | undefined;
+    /**
+     * @description 获取排序配置
+     */
+    getSort(): VBISort | undefined;
     /**
      * @description 设置显示名称
      * @param alias - 显示名称
      */
     setAlias(alias: string): this;
+    /**
+     * @description 设置图表编码位置
+     * @param encoding - 维度编码位置
+     */
+    setEncoding(encoding: NonNullable<VBIDimension['encoding']>): this;
+    /**
+     * @description 设置排序配置
+     * @param sort - 排序配置
+     */
+    setSort(sort: VBISort): this;
+    /**
+     * @description 设置日期聚合函数
+     * @param aggregate - 日期聚合配置
+     */
+    setAggregate(aggregate: NonNullable<VBIDimension['aggregate']>): this;
+    /**
+     * @description 清除日期聚合函数
+     */
+    clearAggregate(): this;
+    /**
+     * @description 清除排序配置
+     */
+    clearSort(): this;
     /**
      * @description 导出为 JSON
      */

package/dist/builder/features/havingFilter/having-builder.d.ts

@@ -1,5 +1,5 @@
 import * as Y from 'yjs';
-import type { VBIHavingGroup, ObserveCallback } from '../../../types';
+import type { VBIHavingGroup, ObserveDeepCallback } from '../../../types';
 import { HavingFilterNodeBuilder } from './having-node-builder';
 import { HavingGroupBuilder } from './having-group-builder';
 /**
@@ -56,7 +56,7 @@ export declare class HavingFilterBuilder {
      * @param callback - 回调函数
      * @returns 取消监听的函数
      */
-    observe(callback: ObserveCallback): () => void;
+    observe(callback: ObserveDeepCallback): () => void;
     /**
      * @description 判断是否为分组节点
      */

package/dist/builder/features/havingFilter/having-node-builder.d.ts

@@ -1,5 +1,5 @@
 import * as Y from 'yjs';
-import { VBIHavingFilter } from '../../../types';
+import { VBIHavingFilter, VBIHavingAggregate } from '../../../types';
 /**
  * @description Having 过滤节点构建器，用于配置单个 Having 过滤条件
  */
@@ -18,6 +18,10 @@ export declare class HavingFilterNodeBuilder {
      * @description 获取过滤操作符
      */
     getOperator(): string | undefined;
+    /**
+     * @description 获取聚合配置
+     */
+    getAggregate(): VBIHavingAggregate | undefined;
     /**
      * @description 设置过滤条件的值
      * @param value - 过滤值
@@ -28,6 +32,11 @@ export declare class HavingFilterNodeBuilder {
      * @param operator - 操作符
      */
     setOperator(operator: string): this;
+    /**
+     * @description 设置聚合配置
+     * @param aggregate - 聚合配置
+     */
+    setAggregate(aggregate: VBIHavingAggregate): this;
     /**
      * @description 导出为 JSON
      */

package/dist/builder/features/measures/mea-builder.d.ts

@@ -1,10 +1,11 @@
 import * as Y from 'yjs';
-import type { ObserveCallback, VBIMeasure, VBIMeasureGroup, VBIMeasureTree } from '../../../types';
+import type { ObserveDeepCallback, VBIMeasure, VBIMeasureGroup, VBIMeasureTree } from '../../../types';
 import { MeasureNodeBuilder } from './mea-node-builder';
 /**
  * @description 度量构建器，用于添加、修改、删除度量配置。度量是数据的数值字段，如：销售额、利润、数量
  */
 export declare class MeasuresBuilder {
+    private doc;
     private dsl;
     constructor(doc: Y.Doc, dsl: Y.Map<any>);
     /**
@@ -46,7 +47,7 @@ export declare class MeasuresBuilder {
      * @param callback - 回调函数
      * @returns 取消监听的函数
      */
-    observe(callback: ObserveCallback): () => void;
+    observe(callback: ObserveDeepCallback): () => void;
     static isMeasureNode(node: VBIMeasureTree[0]): node is VBIMeasure;
     static isMeasureGroup(node: VBIMeasureTree[0]): node is VBIMeasureGroup;
 }

package/dist/builder/features/measures/mea-node-builder.d.ts

@@ -1,5 +1,5 @@
 import * as Y from 'yjs';
-import { VBIMeasure } from '../../../types';
+import type { VBIMeasure, VBIMeasureFormat, VBISort } from '../../../types';
 /**
  * @description 度量节点构建器，用于配置单个度量
  */
@@ -14,6 +14,14 @@ export declare class MeasureNodeBuilder {
      * @description 获取字段名
      */
     getField(): string;
+    /**
+     * @description 获取图表编码位置
+     */
+    getEncoding(): VBIMeasure['encoding'] | undefined;
+    /**
+     * @description 获取排序配置
+     */
+    getSort(): VBISort | undefined;
     /**
      * @description 设置显示名称
      * @param alias - 显示名称
@@ -21,14 +29,36 @@ export declare class MeasureNodeBuilder {
     setAlias(alias: string): this;
     /**
      * @description 设置图表编码位置
-     * @param encoding - 编码位置（yAxis/xAxis/color/size）
+     * @param encoding - 指标编码位置
      */
-    setEncoding(encoding: VBIMeasure['encoding']): this;
+    setEncoding(encoding: NonNullable<VBIMeasure['encoding']>): this;
+    /**
+     * @description 设置排序配置
+     * @param sort - 排序配置
+     */
+    setSort(sort: VBISort): this;
     /**
      * @description 设置聚合函数
      * @param aggregate - 聚合配置
      */
     setAggregate(aggregate: VBIMeasure['aggregate']): this;
+    /**
+     * @description 设置数值格式
+     * @param format - 格式配置
+     */
+    setFormat(format: VBIMeasureFormat): this;
+    /**
+     * @description 获取数值格式
+     */
+    getFormat(): VBIMeasureFormat | undefined;
+    /**
+     * @description 清除数值格式配置
+     */
+    clearFormat(): this;
+    /**
+     * @description 清除排序配置
+     */
+    clearSort(): this;
     /**
      * @description 导出为 JSON
      */

package/dist/builder/features/whereFilter/where-builder.d.ts

@@ -1,5 +1,5 @@
 import * as Y from 'yjs';
-import type { VBIWhereGroup, ObserveCallback } from '../../../types';
+import type { VBIWhereGroup, ObserveDeepCallback } from '../../../types';
 import { WhereFilterNodeBuilder } from './where-node-builder';
 import { WhereGroupBuilder } from './where-group-builder';
 /**
@@ -56,7 +56,7 @@ export declare class WhereFilterBuilder {
      * @param callback - 回调函数
      * @returns 取消监听的函数
      */
-    observe(callback: ObserveCallback): () => void;
+    observe(callback: ObserveDeepCallback): () => void;
     /**
      * @description 判断是否为分组节点
      */

package/dist/builder/features/whereFilter/where-node-builder.d.ts

@@ -1,5 +1,5 @@
 import * as Y from 'yjs';
-import { VBIFilter } from '../../../types';
+import type { VBIWhereDatePredicate, VBIWhereFilter } from '../../../types';
 /**
  * @description Where 过滤节点构建器，用于配置单个 Where 过滤条件
  */
@@ -33,8 +33,17 @@ export declare class WhereFilterNodeBuilder {
      * @param value - 过滤值
      */
     setValue(value: unknown): this;
+    /**
+     * @description 设置日期过滤条件
+     * @param predicate - 日期谓词
+     */
+    setDate(predicate: VBIWhereDatePredicate): this;
+    /**
+     * @description 获取日期过滤条件，非日期过滤返回 undefined
+     */
+    getDate(): VBIWhereDatePredicate | undefined;
     /**
      * @description 导出为 JSON
      */
-    toJSON(): VBIFilter;
+    toJSON(): VBIWhereFilter;
 }

package/dist/builder/index.d.ts

@@ -1,3 +1,4 @@
-export { VBIBuilder } from './vbi-builder';
+export { VBIChartBuilder } from './builder';
 export { VBI } from '../vbi';
+export * from './adapters';
 export { MeasuresBuilder, DimensionsBuilder, ChartTypeBuilder, HavingFilterBuilder, WhereFilterBuilder, ThemeBuilder, LocaleBuilder, LimitBuilder, UndoManager, } from './features';

package/dist/builder/modules/build.d.ts

@@ -1,3 +1,3 @@
 import * as Y from 'yjs';
-import type { VBIDSL } from '../../types';
-export declare const buildVBIDSL: (dsl: Y.Map<any>) => VBIDSL;
+import type { VBIChartDSL } from '../../types';
+export declare const buildVBIChartDSL: (dsl: Y.Map<any>) => VBIChartDSL;

package/dist/builder/modules/index.d.ts

@@ -1,8 +1,5 @@
 export { applyUpdateToDoc } from './apply-update';
 export { encodeDocStateAsUpdate } from './encode-state-as-update';
-export { buildVBIDSL } from './build';
-export { buildVQueryDSL } from './build-vquery';
-export { buildVSeedDSL } from './build-vseed';
-export { isEmptyVBIDSL } from './is-empty';
+export { buildVBIChartDSL } from './build';
+export { isEmptyVBIChartDSL } from './is-empty';
 export { getBuilderSchema } from './get-schema';
-export { createBuilderFeatures } from './create-builder-features';

package/dist/builder/modules/is-empty.d.ts

@@ -1,2 +1,2 @@
 import * as Y from 'yjs';
-export declare const isEmptyVBIDSL: (dsl: Y.Map<any>) => boolean;
+export declare const isEmptyVBIChartDSL: (dsl: Y.Map<any>) => boolean;