@visactor/vbi 0.4.16 → 0.4.19

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 { VBIQueryBuilder } from '../../../types';
+import type { DefaultVBIQueryDSL } from './types';
+export declare const buildVQueryDSL: VBIQueryBuilder<DefaultVBIQueryDSL>;

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

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

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

@@ -0,0 +1,7 @@
+import type { VBIBuilderAdapters } 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 defaultVBIBuilderAdapters: VBIBuilderAdapters<DefaultVBIQueryDSL, DefaultVBISeedDSL>;
+export declare const resolveVBIBuilderAdapters: <TQueryDSL = DefaultVBIQueryDSL, TSeedDSL = DefaultVBISeedDSL>(adapters?: Partial<VBIBuilderAdapters<TQueryDSL, TSeedDSL>>) => VBIBuilderAdapters<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/builder.d.ts

@@ -0,0 +1,29 @@
+import * as Y from 'yjs';
+import type { DefaultVBIQueryDSL, DefaultVBISeedDSL } from './adapters/vquery-vseed';
+import { DimensionsBuilder, MeasuresBuilder, HavingFilterBuilder, WhereFilterBuilder, ChartTypeBuilder, ThemeBuilder, LocaleBuilder, LimitBuilder, UndoManager } from './features';
+import type { VBIDSL, VBIBuilderAdapters, VBIBuilderInterface, VBIBuilderOptions } from '../types';
+export declare class VBIBuilder<TQueryDSL = DefaultVBIQueryDSL, TSeedDSL = DefaultVBISeedDSL> implements VBIBuilderInterface<TQueryDSL, TSeedDSL> {
+    doc: Y.Doc;
+    dsl: Y.Map<any>;
+    adapters: VBIBuilderAdapters<TQueryDSL, TSeedDSL>;
+    chartType: ChartTypeBuilder;
+    measures: MeasuresBuilder;
+    dimensions: DimensionsBuilder;
+    havingFilter: HavingFilterBuilder;
+    whereFilter: WhereFilterBuilder;
+    theme: ThemeBuilder;
+    locale: LocaleBuilder;
+    limit: LimitBuilder;
+    undoManager: UndoManager;
+    constructor(doc: Y.Doc, options?: VBIBuilderOptions<TQueryDSL, TSeedDSL>);
+    applyUpdate: (update: Uint8Array, transactionOrigin?: any) => void;
+    encodeStateAsUpdate: (targetStateVector?: Uint8Array) => Uint8Array<ArrayBufferLike>;
+    buildVSeed: () => Promise<TSeedDSL>;
+    buildVQuery: () => TQueryDSL;
+    build: () => VBIDSL;
+    isEmpty: () => boolean;
+    getSchema: () => Promise<{
+        name: string;
+        type: string;
+    }[]>;
+}

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

@@ -6,7 +6,7 @@ import { DimensionNodeBuilder } from './dim-node-builder';
  */
 export declare class DimensionsBuilder {
     private dsl;
-    constructor(_doc: Y.Doc, dsl: Y.Map<any>);
+    constructor(doc: Y.Doc, dsl: Y.Map<any>);
     /**
      * @description 添加一个维度
      * @param field - 字段名
@@ -14,21 +14,21 @@ export declare class DimensionsBuilder {
      */
     add(field: string, callback: (node: DimensionNodeBuilder) => void): DimensionsBuilder;
     /**
-     * @description 删除指定字段的维度
-     * @param field - 字段名
+     * @description 删除指定 ID 的维度
+     * @param id - 维度 ID
      */
-    remove(field: VBIDimension['field']): DimensionsBuilder;
+    remove(id: string): DimensionsBuilder;
     /**
-     * @description 更新指定维度字段的配置
-     * @param field - 字段名
+     * @description 更新指定维度 ID 的配置
+     * @param id - 维度 ID
      * @param callback - 回调函数
      */
-    update(field: string, callback: (node: DimensionNodeBuilder) => void): DimensionsBuilder;
+    update(id: string, callback: (node: DimensionNodeBuilder) => void): DimensionsBuilder;
     /**
-     * @description 根据字段名查找维度
-     * @param field - 字段名
+     * @description 按回调条件查找第一个维度，行为与 Array.find 一致
+     * @param predicate - 查找条件
      */
-    find(field: VBIDimension['field']): DimensionNodeBuilder | undefined;
+    find(predicate: (node: DimensionNodeBuilder, index: number) => boolean): DimensionNodeBuilder | undefined;
     /**
      * @description 获取所有维度
      */

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

@@ -6,6 +6,10 @@ import { VBIDimension } from '../../../types';
 export declare class DimensionNodeBuilder {
     private yMap;
     constructor(yMap: Y.Map<any>);
+    /**
+     * @description 获取节点 ID
+     */
+    getId(): string;
     /**
      * @description 获取字段名
      */

package/dist/builder/features/dimensions/dimension-utils.d.ts

@@ -0,0 +1,4 @@
+import * as Y from 'yjs';
+export declare const getOrCreateDimensions: (dsl: Y.Map<any>) => Y.Array<any>;
+export declare const normalizeDimensionNodeIds: (dimensions: Y.Array<any>) => void;
+export declare const locateDimensionIndexById: (dimensions: Y.Array<any>, dimensionId: string) => number;

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

@@ -39,10 +39,10 @@ export declare class HavingFilterBuilder {
      */
     remove(idOrIndex: string | number): HavingFilterBuilder;
     /**
-     * @description 根据 ID 查找条件（过滤或分组）
-     * @param id - ID
+     * @description 按回调条件查找第一个条件（过滤或分组），行为与 Array.find 一致
+     * @param predicate - 查找条件
      */
-    find(id: string): HavingFilterNodeBuilder | HavingGroupBuilder | undefined;
+    find(predicate: (entry: HavingFilterNodeBuilder | HavingGroupBuilder, index: number) => boolean): HavingFilterNodeBuilder | HavingGroupBuilder | undefined;
     /**
      * @description 清空所有 Having 过滤条件
      */

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

@@ -6,7 +6,7 @@ import { MeasureNodeBuilder } from './mea-node-builder';
  */
 export declare class MeasuresBuilder {
     private dsl;
-    constructor(_doc: Y.Doc, dsl: Y.Map<any>);
+    constructor(doc: Y.Doc, dsl: Y.Map<any>);
     /**
      * @description 添加一个度量
      * @param field - 字段名
@@ -14,21 +14,21 @@ export declare class MeasuresBuilder {
      */
     add(field: string, callback: (node: MeasureNodeBuilder) => void): MeasuresBuilder;
     /**
-     * @description 删除指定字段的度量
-     * @param field - 字段名
+     * @description 删除指定 ID 的度量
+     * @param id - 度量 ID
      */
-    remove(field: VBIMeasure['field']): MeasuresBuilder;
+    remove(id: string): MeasuresBuilder;
     /**
      * @description 更新度量配置
-     * @param field - 字段名
+     * @param id - 度量 ID
      * @param callback - 回调函数
      */
-    update(field: string, callback: (node: MeasureNodeBuilder) => void): MeasuresBuilder;
+    update(id: string, callback: (node: MeasureNodeBuilder) => void): MeasuresBuilder;
     /**
-     * @description 根据字段名查找度量
-     * @param field - 字段名
+     * @description 按回调条件查找第一个度量，行为与 Array.find 一致
+     * @param predicate - 查找条件
      */
-    find(field: VBIMeasure['field']): MeasureNodeBuilder | undefined;
+    find(predicate: (node: MeasureNodeBuilder, index: number) => boolean): MeasureNodeBuilder | undefined;
     /**
      * @description 获取所有度量
      */

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

@@ -6,6 +6,10 @@ import { VBIMeasure } from '../../../types';
 export declare class MeasureNodeBuilder {
     private yMap;
     constructor(yMap: Y.Map<any>);
+    /**
+     * @description 获取节点 ID
+     */
+    getId(): string;
     /**
      * @description 获取字段名
      */

package/dist/builder/features/measures/measure-utils.d.ts

@@ -0,0 +1,4 @@
+import * as Y from 'yjs';
+export declare const getOrCreateMeasures: (dsl: Y.Map<any>) => Y.Array<any>;
+export declare const normalizeMeasureNodeIds: (measures: Y.Array<any>) => void;
+export declare const locateMeasureIndexById: (measures: Y.Array<any>, measureId: string) => number;

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

@@ -39,10 +39,10 @@ export declare class WhereFilterBuilder {
      */
     remove(idOrIndex: string | number): WhereFilterBuilder;
     /**
-     * @description 根据 ID 查找条件（过滤或分组）
-     * @param id - ID
+     * @description 按回调条件查找第一个条件（过滤或分组），行为与 Array.find 一致
+     * @param predicate - 查找条件
      */
-    find(id: string): WhereFilterNodeBuilder | WhereGroupBuilder | undefined;
+    find(predicate: (entry: WhereFilterNodeBuilder | WhereGroupBuilder, index: number) => boolean): WhereFilterNodeBuilder | WhereGroupBuilder | undefined;
     /**
      * @description 清空所有 Where 过滤条件
      */

package/dist/builder/index.d.ts

@@ -1,3 +1,4 @@
-export { VBIBuilder } from './vbi-builder';
-export { VBI } from './vbi';
+export { VBIBuilder } 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/apply-update.d.ts

@@ -0,0 +1,2 @@
+import * as Y from 'yjs';
+export declare const applyUpdateToDoc: (doc: Y.Doc, update: Uint8Array, transactionOrigin?: any) => void;

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

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

package/dist/builder/modules/encode-state-as-update.d.ts

@@ -0,0 +1,2 @@
+import * as Y from 'yjs';
+export declare const encodeDocStateAsUpdate: (doc: Y.Doc, targetStateVector?: Uint8Array) => Uint8Array<ArrayBufferLike>;

package/dist/builder/modules/get-schema.d.ts

@@ -0,0 +1,5 @@
+import * as Y from 'yjs';
+export declare const getBuilderSchema: (dsl: Y.Map<any>) => Promise<{
+    name: string;
+    type: string;
+}[]>;

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

@@ -0,0 +1,5 @@
+export { applyUpdateToDoc } from './apply-update';
+export { encodeDocStateAsUpdate } from './encode-state-as-update';
+export { buildVBIDSL } from './build';
+export { isEmptyVBIDSL } from './is-empty';
+export { getBuilderSchema } from './get-schema';

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

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