@visactor/vbi 0.0.0 → 0.4.13

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 VisActor
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

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

@@ -1,13 +1,14 @@
 import * as Y from 'yjs';
-import type { VBIHavingFilter } from '../../../types';
+import type { VBIHavingClause, ObserveCallback } from '../../../types';
 import { HavingFiltersNodeBuilder } from './having-node-builder';
-import type { YArrayEvent, Transaction } from 'yjs';
+import { HavingGroupBuilder } from './having-group-builder';
 /**
  * @description Having 过滤构建器，用于添加、修改、删除分组后过滤条件。Having 过滤在数据聚合后生效，用于筛选分组结果
  */
 export declare class HavingFiltersBuilder {
     private dsl;
-    constructor(_doc: Y.Doc, dsl: Y.Map<any>);
+    private doc;
+    constructor(doc: Y.Doc, dsl: Y.Map<any>);
     /**
      * @description 添加一个 Having 过滤条件
      * @param field - 字段名
@@ -15,25 +16,33 @@ export declare class HavingFiltersBuilder {
      */
     add(field: string, callback: (node: HavingFiltersNodeBuilder) => void): HavingFiltersBuilder;
     /**
-     * @description 更新指定字段的过滤条件
-     * @param field - 字段名
+     * @description 添加一个 Having 分组
+     * @param op - 逻辑操作符
      * @param callback - 回调函数
      */
-    update(field: string, callback: (node: HavingFiltersNodeBuilder) => void): HavingFiltersBuilder;
+    addGroup(op: 'and' | 'or', callback: (group: HavingGroupBuilder) => void): HavingFiltersBuilder;
     /**
-     * @description 根据字段名删除 Having 过滤条件
-     * @param field - 字段名
+     * @description 更新指定 ID 的过滤条件
+     * @param id - 过滤条件 ID
+     * @param callback - 回调函数
      */
-    remove(field: string): HavingFiltersBuilder;
+    update(id: string, callback: (node: HavingFiltersNodeBuilder) => void): HavingFiltersBuilder;
     /**
-     * @description 根据字段名查找 Having 过滤条件
-     * @param field - 字段名
+     * @description 更新指定 ID 的分组
+     * @param id - 分组 ID
+     * @param callback - 回调函数
+     */
+    updateGroup(id: string, callback: (group: HavingGroupBuilder) => void): HavingFiltersBuilder;
+    /**
+     * @description 删除指定 ID 的条件或指定索引的项
+     * @param idOrIndex - ID 或索引
      */
-    find(field: string): HavingFiltersNodeBuilder | undefined;
+    remove(idOrIndex: string | number): HavingFiltersBuilder;
     /**
-     * @description 获取所有 Having 过滤条件
+     * @description 根据 ID 查找条件（过滤或分组）
+     * @param id - ID
      */
-    findAll(): HavingFiltersNodeBuilder[];
+    find(id: string): HavingFiltersNodeBuilder | HavingGroupBuilder | undefined;
     /**
      * @description 清空所有 Having 过滤条件
      */
@@ -41,15 +50,19 @@ export declare class HavingFiltersBuilder {
     /**
      * @description 导出所有 Having 过滤条件为 JSON 数组
      */
-    toJson(): VBIHavingFilter[];
-    /**
-     * @description 监听过滤条件变化
-     * @param callback - 回调函数
-     */
+    toJson(): VBIHavingClause[];
     /**
      * @description 监听过滤条件变化，返回取消监听的函数
      * @param callback - 回调函数
      * @returns 取消监听的函数
      */
-    observe(callback: (e: YArrayEvent<any>, trans: Transaction | null) => void): () => void;
+    observe(callback: ObserveCallback): () => void;
+    /**
+     * @description 判断是否为分组节点
+     */
+    static isGroup(yMap: Y.Map<any>): boolean;
+    /**
+     * @description 判断是否为叶子节点
+     */
+    static isNode(yMap: Y.Map<any>): boolean;
 }

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

@@ -0,0 +1,48 @@
+import * as Y from 'yjs';
+import type { VBIHavingGroup } from '../../../types';
+import { HavingFiltersNodeBuilder } from './having-node-builder';
+/**
+ * @description Having 分组构建器，用于配置一组条件的逻辑关系（AND/OR）
+ */
+export declare class HavingGroupBuilder {
+    private yMap;
+    constructor(yMap: Y.Map<any>);
+    /**
+     * @description 获取分组 ID
+     */
+    getId(): string;
+    /**
+     * @description 获取逻辑操作符
+     */
+    getOperator(): 'and' | 'or';
+    /**
+     * @description 设置逻辑操作符
+     * @param op - 逻辑操作符
+     */
+    setOperator(op: 'and' | 'or'): this;
+    /**
+     * @description 添加一个 Having 过滤条件到分组
+     * @param field - 字段名
+     * @param callback - 回调函数
+     */
+    add(field: string, callback: (node: HavingFiltersNodeBuilder) => void): this;
+    /**
+     * @description 添加一个嵌套分组到当前分组
+     * @param op - 逻辑操作符
+     * @param callback - 回调函数
+     */
+    addGroup(op: 'and' | 'or', callback: (group: HavingGroupBuilder) => void): this;
+    /**
+     * @description 删除指定 ID 的条件或指定索引的项
+     * @param idOrIndex - ID 或索引
+     */
+    remove(idOrIndex: string | number): this;
+    /**
+     * @description 清空分组内所有条件
+     */
+    clear(): this;
+    /**
+     * @description 导出为 JSON
+     */
+    toJson(): VBIHavingGroup;
+}

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

@@ -6,10 +6,18 @@ import { VBIHavingFilter } from '../../../types';
 export declare class HavingFiltersNodeBuilder {
     private yMap;
     constructor(yMap: Y.Map<any>);
+    /**
+     * @description 获取节点 ID
+     */
+    getId(): string;
     /**
      * @description 获取字段名
      */
     getField(): string;
+    /**
+     * @description 获取过滤操作符
+     */
+    getOperator(): string | undefined;
     /**
      * @description 设置过滤条件的值
      * @param value - 过滤值

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

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

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

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

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

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

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

@@ -1,6 +1,7 @@
 import * as Y from 'yjs';
-import type { VBIFilter, ObserveCallback } from '../../../types';
+import type { VBIWhereClause, ObserveCallback } from '../../../types';
 import { WhereFilterNodeBuilder } from './where-node-builder';
+import { WhereGroupBuilder } from './where-group-builder';
 /**
  * @description Where 过滤构建器，用于添加、修改、删除行级过滤条件。Where 过滤在数据查询前生效，用于筛选原始数据
  */
@@ -15,25 +16,33 @@ export declare class WhereFiltersBuilder {
      */
     add(field: string, callback: (node: WhereFilterNodeBuilder) => void): WhereFiltersBuilder;
     /**
-     * @description 更新指定字段的过滤条件
-     * @param field - 字段名
+     * @description 添加一个 Where 分组
+     * @param op - 逻辑操作符
      * @param callback - 回调函数
      */
-    update(field: string, callback: (node: WhereFilterNodeBuilder) => void): WhereFiltersBuilder;
+    addGroup(op: 'and' | 'or', callback: (group: WhereGroupBuilder) => void): WhereFiltersBuilder;
     /**
-     * @description 删除指定字段的过滤条件
-     * @param field - 字段名
+     * @description 更新指定 ID 的过滤条件
+     * @param id - 过滤条件 ID
+     * @param callback - 回调函数
      */
-    remove(field: string): WhereFiltersBuilder;
+    update(id: string, callback: (node: WhereFilterNodeBuilder) => void): WhereFiltersBuilder;
     /**
-     * @description 根据字段名查找过滤条件
-     * @param field - 字段名
+     * @description 更新指定 ID 的分组
+     * @param id - 分组 ID
+     * @param callback - 回调函数
+     */
+    updateGroup(id: string, callback: (group: WhereGroupBuilder) => void): WhereFiltersBuilder;
+    /**
+     * @description 删除指定 ID 的条件或指定索引的项
+     * @param idOrIndex - ID 或索引
      */
-    find(field: string): WhereFilterNodeBuilder | undefined;
+    remove(idOrIndex: string | number): WhereFiltersBuilder;
     /**
-     * @description 获取所有 Where 过滤条件
+     * @description 根据 ID 查找条件（过滤或分组）
+     * @param id - ID
      */
-    findAll(): WhereFilterNodeBuilder[];
+    find(id: string): WhereFilterNodeBuilder | WhereGroupBuilder | undefined;
     /**
      * @description 清空所有 Where 过滤条件
      */
@@ -41,15 +50,19 @@ export declare class WhereFiltersBuilder {
     /**
      * @description 导出所有 Where 过滤条件为 JSON 数组
      */
-    toJson(): VBIFilter[];
-    /**
-     * @description 监听过滤条件变化
-     * @param callback - 回调函数
-     */
+    toJson(): VBIWhereClause[];
     /**
      * @description 监听过滤条件变化，返回取消监听的函数
      * @param callback - 回调函数
      * @returns 取消监听的函数
      */
     observe(callback: ObserveCallback): () => void;
+    /**
+     * @description 判断是否为分组节点
+     */
+    static isGroup(yMap: Y.Map<any>): boolean;
+    /**
+     * @description 判断是否为叶子节点
+     */
+    static isNode(yMap: Y.Map<any>): boolean;
 }

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

@@ -0,0 +1,48 @@
+import * as Y from 'yjs';
+import type { VBIWhereGroup } from '../../../types';
+import { WhereFilterNodeBuilder } from './where-node-builder';
+/**
+ * @description Where 分组构建器，用于配置一组条件的逻辑关系（AND/OR）
+ */
+export declare class WhereGroupBuilder {
+    private yMap;
+    constructor(yMap: Y.Map<any>);
+    /**
+     * @description 获取分组 ID
+     */
+    getId(): string;
+    /**
+     * @description 获取逻辑操作符
+     */
+    getOperator(): 'and' | 'or';
+    /**
+     * @description 设置逻辑操作符
+     * @param op - 逻辑操作符
+     */
+    setOperator(op: 'and' | 'or'): this;
+    /**
+     * @description 添加一个 Where 过滤条件到分组
+     * @param field - 字段名
+     * @param callback - 回调函数
+     */
+    add(field: string, callback: (node: WhereFilterNodeBuilder) => void): this;
+    /**
+     * @description 添加一个嵌套分组到当前分组
+     * @param op - 逻辑操作符
+     * @param callback - 回调函数
+     */
+    addGroup(op: 'and' | 'or', callback: (group: WhereGroupBuilder) => void): this;
+    /**
+     * @description 删除指定 ID 的条件或指定索引的项
+     * @param idOrIndex - ID 或索引
+     */
+    remove(idOrIndex: string | number): this;
+    /**
+     * @description 清空分组内所有条件
+     */
+    clear(): this;
+    /**
+     * @description 导出为 JSON
+     */
+    toJson(): VBIWhereGroup;
+}

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

@@ -6,10 +6,18 @@ import { VBIFilter } from '../../../types';
 export declare class WhereFilterNodeBuilder {
     private yMap;
     constructor(yMap: Y.Map<any>);
+    /**
+     * @description 获取节点 ID
+     */
+    getId(): string;
     /**
      * @description 获取字段名
      */
     getField(): string;
+    /**
+     * @description 获取过滤操作符
+     */
+    getOperator(): string | undefined;
     /**
      * @description 设置过滤操作符
      * @param operator - 操作符