@finos/legend-application-query 5.0.0

package/lib/stores/QueryBuilderFilterState.d.ts

@@ -0,0 +1,127 @@
+/**
+ * Copyright (c) 2020-present, Goldman Sachs
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+import type { TreeNodeData, TreeData } from '@finos/legend-art';
+import type { QueryBuilderExplorerTreeDragSource } from './QueryBuilderExplorerState.js';
+import { QueryBuilderPropertyExpressionState } from './QueryBuilderPropertyEditorState.js';
+import type { QueryBuilderState } from './QueryBuilderState.js';
+import { type AbstractPropertyExpression, type ValueSpecification, SimpleFunctionExpression } from '@finos/legend-graph';
+import { QUERY_BUILDER_GROUP_OPERATION } from './QueryBuilderOperatorsHelper.js';
+export declare abstract class QueryBuilderFilterOperator {
+    readonly uuid: string;
+    abstract getLabel(filterConditionState: FilterConditionState): string;
+    abstract isCompatibleWithFilterConditionProperty(filterConditionState: FilterConditionState): boolean;
+    abstract isCompatibleWithFilterConditionValue(filterConditionState: FilterConditionState): boolean;
+    abstract getDefaultFilterConditionValue(filterConditionState: FilterConditionState): ValueSpecification | undefined;
+    abstract buildFilterConditionExpression(filterConditionState: FilterConditionState): ValueSpecification;
+    abstract buildFilterConditionState(filterState: QueryBuilderFilterState, expression: SimpleFunctionExpression): FilterConditionState | undefined;
+}
+export declare enum QUERY_BUILDER_FILTER_DND_TYPE {
+    GROUP_CONDITION = "GROUP_CONDITION",
+    CONDITION = "CONDITION",
+    BLANK_CONDITION = "BLANK_CONDITION"
+}
+export interface QueryBuilderFilterConditionDragSource {
+    node: QueryBuilderFilterTreeNodeData;
+}
+export declare type QueryBuilderFilterDropTarget = QueryBuilderExplorerTreeDragSource | QueryBuilderFilterConditionDragSource;
+export declare type QueryBuilderFilterConditionRearrangeDropTarget = QueryBuilderFilterConditionDragSource;
+export declare class FilterConditionState {
+    filterState: QueryBuilderFilterState;
+    propertyExpressionState: QueryBuilderPropertyExpressionState;
+    operator: QueryBuilderFilterOperator;
+    value?: ValueSpecification | undefined;
+    existsLambdaParamNames: string[];
+    constructor(filterState: QueryBuilderFilterState, propertyExpression: AbstractPropertyExpression);
+    get operators(): QueryBuilderFilterOperator[];
+    changeProperty(propertyExpression: AbstractPropertyExpression): void;
+    changeOperator(val: QueryBuilderFilterOperator): void;
+    setOperator(val: QueryBuilderFilterOperator): void;
+    setValue(val: ValueSpecification | undefined): void;
+    addExistsLambdaParamNames(val: string): void;
+}
+export declare abstract class QueryBuilderFilterTreeNodeData implements TreeNodeData {
+    readonly id: string;
+    readonly label = "";
+    isOpen?: boolean | undefined;
+    parentId?: string | undefined;
+    constructor(parentId: string | undefined);
+    abstract get dragLayerLabel(): string;
+    setIsOpen(val: boolean): void;
+    setParentId(val: string | undefined): void;
+}
+export declare class QueryBuilderFilterTreeGroupNodeData extends QueryBuilderFilterTreeNodeData {
+    groupOperation: QUERY_BUILDER_GROUP_OPERATION;
+    childrenIds: string[];
+    constructor(parentId: string | undefined, groupOperation: QUERY_BUILDER_GROUP_OPERATION);
+    get dragLayerLabel(): string;
+    setGroupOperation(val: QUERY_BUILDER_GROUP_OPERATION): void;
+    addChildNode(node: QueryBuilderFilterTreeNodeData): void;
+    removeChildNode(node: QueryBuilderFilterTreeNodeData): void;
+    addChildNodeAt(node: QueryBuilderFilterTreeNodeData, idx: number): void;
+}
+export declare class QueryBuilderFilterTreeConditionNodeData extends QueryBuilderFilterTreeNodeData {
+    condition: FilterConditionState;
+    constructor(parentId: string | undefined, condition: FilterConditionState);
+    get dragLayerLabel(): string;
+}
+export declare class QueryBuilderFilterTreeBlankConditionNodeData extends QueryBuilderFilterTreeNodeData {
+    constructor(parentId: string | undefined);
+    get dragLayerLabel(): string;
+}
+export declare const buildFilterExpression: (filterState: QueryBuilderFilterState, getAllFunc: SimpleFunctionExpression) => SimpleFunctionExpression | undefined;
+export declare class QueryBuilderFilterState implements TreeData<QueryBuilderFilterTreeNodeData> {
+    queryBuilderState: QueryBuilderState;
+    lambdaParameterName: string;
+    rootIds: string[];
+    nodes: Map<string, QueryBuilderFilterTreeNodeData>;
+    selectedNode?: QueryBuilderFilterTreeNodeData | undefined;
+    isRearrangingConditions: boolean;
+    operators: QueryBuilderFilterOperator[];
+    private _suppressClickawayEventListener;
+    constructor(queryBuilderState: QueryBuilderState, operators: QueryBuilderFilterOperator[]);
+    get isEmpty(): boolean;
+    setLambdaParameterName(val: string): void;
+    setRearrangingConditions(val: boolean): void;
+    suppressClickawayEventListener(): void;
+    handleClickaway(): void;
+    setSelectedNode(val: QueryBuilderFilterTreeNodeData | undefined): void;
+    getNode(id: string): QueryBuilderFilterTreeNodeData;
+    getRootNode(): QueryBuilderFilterTreeNodeData | undefined;
+    private getParentNode;
+    private addRootNode;
+    addNodeFromNode(node: QueryBuilderFilterTreeNodeData, fromNode: QueryBuilderFilterTreeNodeData | undefined): void;
+    replaceBlankNodeWithNode(node: QueryBuilderFilterTreeNodeData, blankNode: QueryBuilderFilterTreeBlankConditionNodeData): void;
+    addGroupConditionNodeFromNode(fromNode: QueryBuilderFilterTreeNodeData | undefined): void;
+    newGroupWithConditionFromNode(node: QueryBuilderFilterTreeNodeData | undefined, fromNode: QueryBuilderFilterTreeNodeData | undefined): void;
+    private removeNode;
+    private pruneChildlessGroupNodes;
+    private pruneOrphanNodes;
+    /**
+     * If group node has fewer than 2 children, flatten it
+     */
+    private squashGroupNode;
+    removeNodeAndPruneBranch(node: QueryBuilderFilterTreeNodeData): void;
+    pruneTree(): void;
+    /**
+     * Cleanup unecessary group nodes (i.e. group node whose group operation is the same as its parent's)
+     */
+    simplifyTree(): void;
+    isValidMove(node: QueryBuilderFilterTreeNodeData, toNode: QueryBuilderFilterTreeNodeData): boolean;
+    moveNode(node: QueryBuilderFilterTreeNodeData, toNode: QueryBuilderFilterTreeNodeData): void;
+    collapseTree(): void;
+    expandTree(): void;
+}
+//# sourceMappingURL=QueryBuilderFilterState.d.ts.map

package/lib/stores/QueryBuilderFilterState.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"QueryBuilderFilterState.d.ts","sourceRoot":"","sources":["../../src/stores/QueryBuilderFilterState.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;GAcG;AASH,OAAO,KAAK,EAAE,YAAY,EAAE,QAAQ,EAAE,MAAM,mBAAmB,CAAC;AAchE,OAAO,KAAK,EAAE,kCAAkC,EAAE,MAAM,gCAAgC,CAAC;AACzF,OAAO,EAAE,mCAAmC,EAAE,MAAM,sCAAsC,CAAC;AAC3F,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,wBAAwB,CAAC;AAChE,OAAO,EACL,KAAK,0BAA0B,EAC/B,KAAK,kBAAkB,EAEvB,wBAAwB,EAGzB,MAAM,qBAAqB,CAAC;AAM7B,OAAO,EAEL,6BAA6B,EAC9B,MAAM,kCAAkC,CAAC;AAE1C,8BAAsB,0BAA0B;IAC9C,QAAQ,CAAC,IAAI,SAAU;IAEvB,QAAQ,CAAC,QAAQ,CAAC,oBAAoB,EAAE,oBAAoB,GAAG,MAAM;IAErE,QAAQ,CAAC,uCAAuC,CAC9C,oBAAoB,EAAE,oBAAoB,GACzC,OAAO;IAEV,QAAQ,CAAC,oCAAoC,CAC3C,oBAAoB,EAAE,oBAAoB,GACzC,OAAO;IAEV,QAAQ,CAAC,8BAA8B,CACrC,oBAAoB,EAAE,oBAAoB,GACzC,kBAAkB,GAAG,SAAS;IAEjC,QAAQ,CAAC,8BAA8B,CACrC,oBAAoB,EAAE,oBAAoB,GACzC,kBAAkB;IAErB,QAAQ,CAAC,yBAAyB,CAChC,WAAW,EAAE,uBAAuB,EACpC,UAAU,EAAE,wBAAwB,GACnC,oBAAoB,GAAG,SAAS;CACpC;AAED,oBAAY,6BAA6B;IACvC,eAAe,oBAAoB;IACnC,SAAS,cAAc;IACvB,eAAe,oBAAoB;CACpC;AAED,MAAM,WAAW,qCAAqC;IACpD,IAAI,EAAE,8BAA8B,CAAC;CACtC;AAED,oBAAY,4BAA4B,GACpC,kCAAkC,GAClC,qCAAqC,CAAC;AAC1C,oBAAY,8CAA8C,GACxD,qCAAqC,CAAC;AAExC,qBAAa,oBAAoB;IAC/B,WAAW,EAAE,uBAAuB,CAAC;IACrC,uBAAuB,EAAE,mCAAmC,CAAC;IAC7D,QAAQ,EAAG,0BAA0B,CAAC;IACtC,KAAK,CAAC,EAAE,kBAAkB,GAAG,SAAS,CAAC;IACvC,sBAAsB,EAAE,MAAM,EAAE,CAAM;gBAGpC,WAAW,EAAE,uBAAuB,EACpC,kBAAkB,EAAE,0BAA0B;IA2BhD,IAAI,SAAS,IAAI,0BAA0B,EAAE,CAI5C;IAED,cAAc,CAAC,kBAAkB,EAAE,0BAA0B,GAAG,IAAI;IAmCpE,cAAc,CAAC,GAAG,EAAE,0BAA0B,GAAG,IAAI;IAOrD,WAAW,CAAC,GAAG,EAAE,0BAA0B,GAAG,IAAI;IAIlD,QAAQ,CAAC,GAAG,EAAE,kBAAkB,GAAG,SAAS,GAAG,IAAI;IASnD,yBAAyB,CAAC,GAAG,EAAE,MAAM,GAAG,IAAI;CAG7C;AAED,8BAAsB,8BAA+B,YAAW,YAAY;IAC1E,QAAQ,CAAC,EAAE,SAAU;IACrB,QAAQ,CAAC,KAAK,MAAM;IAEpB,MAAM,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;IAC7B,QAAQ,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;gBAElB,QAAQ,EAAE,MAAM,GAAG,SAAS;IAWxC,QAAQ,KAAK,cAAc,IAAI,MAAM,CAAC;IACtC,SAAS,CAAC,GAAG,EAAE,OAAO,GAAG,IAAI;IAG7B,WAAW,CAAC,GAAG,EAAE,MAAM,GAAG,SAAS,GAAG,IAAI;CAG3C;AAED,qBAAa,mCAAoC,SAAQ,8BAA8B;IACrF,cAAc,EAAE,6BAA6B,CAAC;IAC9C,WAAW,EAAE,MAAM,EAAE,CAAM;gBAGzB,QAAQ,EAAE,MAAM,GAAG,SAAS,EAC5B,cAAc,EAAE,6BAA6B;IAiB/C,IAAI,cAAc,IAAI,MAAM,CAE3B;IAED,iBAAiB,CAAC,GAAG,EAAE,6BAA6B,GAAG,IAAI;IAG3D,YAAY,CAAC,IAAI,EAAE,8BAA8B,GAAG,IAAI;IAIxD,eAAe,CAAC,IAAI,EAAE,8BAA8B,GAAG,IAAI;IAI3D,cAAc,CAAC,IAAI,EAAE,8BAA8B,EAAE,GAAG,EAAE,MAAM,GAAG,IAAI;CAOxE;AAED,qBAAa,uCAAwC,SAAQ,8BAA8B;IACzF,SAAS,EAAE,oBAAoB,CAAC;gBAEpB,QAAQ,EAAE,MAAM,GAAG,SAAS,EAAE,SAAS,EAAE,oBAAoB;IAWzE,IAAI,cAAc,IAAI,MAAM,CAE3B;CACF;AAED,qBAAa,4CAA6C,SAAQ,8BAA8B;gBAClF,QAAQ,EAAE,MAAM,GAAG,SAAS;IAQxC,IAAI,cAAc,IAAI,MAAM,CAE3B;CACF;AAwDD,eAAO,MAAM,qBAAqB,gBACnB,uBAAuB,cACxB,wBAAwB,KACnC,wBAAwB,GAAG,SA6B7B,CAAC;AAEF,qBAAa,uBACX,YAAW,QAAQ,CAAC,8BAA8B,CAAC;IAEnD,iBAAiB,EAAE,iBAAiB,CAAC;IACrC,mBAAmB,SAAgC;IACnD,OAAO,EAAE,MAAM,EAAE,CAAM;IACvB,KAAK,8CAAqD;IAC1D,YAAY,CAAC,EAAE,8BAA8B,GAAG,SAAS,CAAC;IAC1D,uBAAuB,UAAS;IAChC,SAAS,EAAE,0BAA0B,EAAE,CAAM;IAC7C,OAAO,CAAC,+BAA+B,CAAS;gBAG9C,iBAAiB,EAAE,iBAAiB,EACpC,SAAS,EAAE,0BAA0B,EAAE;IAyBzC,IAAI,OAAO,IAAI,OAAO,CAErB;IAED,sBAAsB,CAAC,GAAG,EAAE,MAAM,GAAG,IAAI;IAIzC,wBAAwB,CAAC,GAAG,EAAE,OAAO,GAAG,IAAI;IAG5C,8BAA8B,IAAI,IAAI;IAGtC,eAAe,IAAI,IAAI;IAOvB,eAAe,CAAC,GAAG,EAAE,8BAA8B,GAAG,SAAS,GAAG,IAAI;IAItE,OAAO,CAAC,EAAE,EAAE,MAAM,GAAG,8BAA8B;IAMnD,WAAW,IAAI,8BAA8B,GAAG,SAAS;IASzD,OAAO,CAAC,aAAa;IAWrB,OAAO,CAAC,WAAW;IAwBnB,eAAe,CACb,IAAI,EAAE,8BAA8B,EACpC,QAAQ,EAAE,8BAA8B,GAAG,SAAS,GACnD,IAAI;IAqBP,wBAAwB,CACtB,IAAI,EAAE,8BAA8B,EACpC,SAAS,EAAE,4CAA4C,GACtD,IAAI;IAeP,6BAA6B,CAC3B,QAAQ,EAAE,8BAA8B,GAAG,SAAS,GACnD,IAAI;IAgBP,6BAA6B,CAC3B,IAAI,EAAE,8BAA8B,GAAG,SAAS,EAChD,QAAQ,EAAE,8BAA8B,GAAG,SAAS,GACnD,IAAI;IAyBP,OAAO,CAAC,UAAU;IAkBlB,OAAO,CAAC,wBAAwB;IAYhC,OAAO,CAAC,gBAAgB;IAYxB;;OAEG;IACH,OAAO,CAAC,eAAe;IAuBvB,wBAAwB,CAAC,IAAI,EAAE,8BAA8B,GAAG,IAAI;IAyBpE,SAAS,IAAI,IAAI;IAiDjB;;OAEG;IACH,YAAY,IAAI,IAAI;IAqCpB,WAAW,CACT,IAAI,EAAE,8BAA8B,EACpC,MAAM,EAAE,8BAA8B,GACrC,OAAO;IAeV,QAAQ,CACN,IAAI,EAAE,8BAA8B,EACpC,MAAM,EAAE,8BAA8B,GACrC,IAAI;IAIP,YAAY,IAAI,IAAI;IAIpB,UAAU,IAAI,IAAI;CAGnB"}