@itwin/components-react 4.0.0-dev.2 → 4.0.0-dev.21

package/lib/esm/components-react/filter-builder/FilterBuilderRuleValue.js

@@ -2,19 +2,25 @@
 * Copyright (c) Bentley Systems, Incorporated. All rights reserved.
 * See LICENSE.md in the project root for license terms and full copyright notice.
 *--------------------------------------------------------------------------------------------*/
+/** @packageDocumentation
+ * @module PropertyFilterBuilder
+ */
 import * as React from "react";
 import { PropertyRecord, PropertyValueFormat } from "@itwin/appui-abstract";
 import { EditorContainer } from "../editors/EditorContainer";
-/** @alpha */
+/**
+ * Component that renders [[PropertyFilterBuilderRuleRenderer]] value input.
+ * @internal
+ */
 export function PropertyFilterBuilderRuleValue(props) {
     const { value, property, onChange } = props;
     const propertyRecord = React.useMemo(() => {
-        return new PropertyRecord(value !== null && value !== void 0 ? value : { valueFormat: PropertyValueFormat.Primitive }, property);
+        return new PropertyRecord(value ?? { valueFormat: PropertyValueFormat.Primitive }, property);
     }, [value, property]);
     const onValueChange = React.useCallback(({ newValue }) => {
         onChange(newValue);
     }, [onChange]);
     return React.createElement("div", { className: "rule-value" },
-        React.createElement(EditorContainer, { propertyRecord: propertyRecord, onCancel: /* istanbul ignore next */ () => { }, onCommit: onValueChange, setFocus: false }));
+        React.createElement(EditorContainer, { propertyRecord: propertyRecord, onCancel: /* istanbul ignore next */ () => { }, onCommit: onValueChange, setFocus: false, shouldCommitOnChange: true }));
 }
 //# sourceMappingURL=FilterBuilderRuleValue.js.map

package/lib/esm/components-react/filter-builder/FilterBuilderRuleValue.js.map

@@ -1 +1 @@
-{"version":3,"file":"FilterBuilderRuleValue.js","sourceRoot":"","sources":["../../../../src/components-react/filter-builder/FilterBuilderRuleValue.tsx"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F,OAAO,KAAK,KAAK,MAAM,OAAO,CAAC;AAC/B,OAAO,EAAuB,cAAc,EAAiB,mBAAmB,EAAE,MAAM,uBAAuB,CAAC;AAChH,OAAO,EAAE,eAAe,EAAuB,MAAM,4BAA4B,CAAC;AASlF,aAAa;AACb,MAAM,UAAU,8BAA8B,CAAC,KAA0C;IACvF,MAAM,EAAE,KAAK,EAAE,QAAQ,EAAE,QAAQ,EAAE,GAAG,KAAK,CAAC;IAE5C,MAAM,cAAc,GAAG,KAAK,CAAC,OAAO,CAAC,GAAG,EAAE;QACxC,OAAO,IAAI,cAAc,CAAC,KAAK,aAAL,KAAK,cAAL,KAAK,GAAI,EAAE,WAAW,EAAE,mBAAmB,CAAC,SAAS,EAAE,EAAE,QAAQ,CAAC,CAAC;IAC/F,CAAC,EAAE,CAAC,KAAK,EAAE,QAAQ,CAAC,CAAC,CAAC;IAEtB,MAAM,aAAa,GAAG,KAAK,CAAC,WAAW,CAAC,CAAC,EAAE,QAAQ,EAAuB,EAAE,EAAE;QAC5E,QAAQ,CAAC,QAAQ,CAAC,CAAC;IACrB,CAAC,EAAE,CAAC,QAAQ,CAAC,CAAC,CAAC;IAEf,OAAO,6BAAK,SAAS,EAAC,YAAY;QAChC,oBAAC,eAAe,IACd,cAAc,EAAE,cAAc,EAC9B,QAAQ,EAAE,0BAA0B,CAAC,GAAG,EAAE,GAAG,CAAC,EAC9C,QAAQ,EAAE,aAAa,EACvB,QAAQ,EAAE,KAAK,GACf,CACE,CAAC;AACT,CAAC","sourcesContent":["/*---------------------------------------------------------------------------------------------\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n* See LICENSE.md in the project root for license terms and full copyright notice.\n*--------------------------------------------------------------------------------------------*/\nimport * as React from \"react\";\nimport { PropertyDescription, PropertyRecord, PropertyValue, PropertyValueFormat } from \"@itwin/appui-abstract\";\nimport { EditorContainer, PropertyUpdatedArgs } from \"../editors/EditorContainer\";\n\n/** @alpha */\nexport interface PropertyFilterBuilderRuleValueProps {\n  value?: PropertyValue;\n  property: PropertyDescription;\n  onChange: (value: PropertyValue) => void;\n}\n\n/** @alpha */\nexport function PropertyFilterBuilderRuleValue(props: PropertyFilterBuilderRuleValueProps) {\n  const { value, property, onChange } = props;\n\n  const propertyRecord = React.useMemo(() => {\n    return new PropertyRecord(value ?? { valueFormat: PropertyValueFormat.Primitive }, property);\n  }, [value, property]);\n\n  const onValueChange = React.useCallback(({ newValue }: PropertyUpdatedArgs) => {\n    onChange(newValue);\n  }, [onChange]);\n\n  return <div className=\"rule-value\">\n    <EditorContainer\n      propertyRecord={propertyRecord}\n      onCancel={/* istanbul ignore next */ () => { }}\n      onCommit={onValueChange}\n      setFocus={false}\n    />\n  </div>;\n}\n"]}
+{"version":3,"file":"FilterBuilderRuleValue.js","sourceRoot":"","sources":["../../../../src/components-react/filter-builder/FilterBuilderRuleValue.tsx"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAEH,OAAO,KAAK,KAAK,MAAM,OAAO,CAAC;AAC/B,OAAO,EAAuB,cAAc,EAAiB,mBAAmB,EAAE,MAAM,uBAAuB,CAAC;AAChH,OAAO,EAAE,eAAe,EAAuB,MAAM,4BAA4B,CAAC;AAelF;;;GAGG;AACH,MAAM,UAAU,8BAA8B,CAAC,KAA0C;IACvF,MAAM,EAAE,KAAK,EAAE,QAAQ,EAAE,QAAQ,EAAE,GAAG,KAAK,CAAC;IAE5C,MAAM,cAAc,GAAG,KAAK,CAAC,OAAO,CAAC,GAAG,EAAE;QACxC,OAAO,IAAI,cAAc,CAAC,KAAK,IAAI,EAAE,WAAW,EAAE,mBAAmB,CAAC,SAAS,EAAE,EAAE,QAAQ,CAAC,CAAC;IAC/F,CAAC,EAAE,CAAC,KAAK,EAAE,QAAQ,CAAC,CAAC,CAAC;IAEtB,MAAM,aAAa,GAAG,KAAK,CAAC,WAAW,CAAC,CAAC,EAAE,QAAQ,EAAuB,EAAE,EAAE;QAC5E,QAAQ,CAAC,QAAQ,CAAC,CAAC;IACrB,CAAC,EAAE,CAAC,QAAQ,CAAC,CAAC,CAAC;IAEf,OAAO,6BAAK,SAAS,EAAC,YAAY;QAChC,oBAAC,eAAe,IACd,cAAc,EAAE,cAAc,EAC9B,QAAQ,EAAE,0BAA0B,CAAC,GAAG,EAAE,GAAG,CAAC,EAC9C,QAAQ,EAAE,aAAa,EACvB,QAAQ,EAAE,KAAK,EACf,oBAAoB,EAAE,IAAI,GAC1B,CACE,CAAC;AACT,CAAC","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\n/** @packageDocumentation\r\n * @module PropertyFilterBuilder\r\n */\r\n\r\nimport * as React from \"react\";\r\nimport { PropertyDescription, PropertyRecord, PropertyValue, PropertyValueFormat } from \"@itwin/appui-abstract\";\r\nimport { EditorContainer, PropertyUpdatedArgs } from \"../editors/EditorContainer\";\r\n\r\n/**\r\n * Props for [[PropertyFilterBuilderRuleValue]] component.\r\n * @internal\r\n */\r\nexport interface PropertyFilterBuilderRuleValueProps {\r\n  /** Currently entered value. */\r\n  value?: PropertyValue;\r\n  /** Property used in rule to which this value will be compared to. */\r\n  property: PropertyDescription;\r\n  /** Callback that is invoked when value changes. */\r\n  onChange: (value: PropertyValue) => void;\r\n}\r\n\r\n/**\r\n * Component that renders [[PropertyFilterBuilderRuleRenderer]] value input.\r\n * @internal\r\n */\r\nexport function PropertyFilterBuilderRuleValue(props: PropertyFilterBuilderRuleValueProps) {\r\n  const { value, property, onChange } = props;\r\n\r\n  const propertyRecord = React.useMemo(() => {\r\n    return new PropertyRecord(value ?? { valueFormat: PropertyValueFormat.Primitive }, property);\r\n  }, [value, property]);\r\n\r\n  const onValueChange = React.useCallback(({ newValue }: PropertyUpdatedArgs) => {\r\n    onChange(newValue);\r\n  }, [onChange]);\r\n\r\n  return <div className=\"rule-value\">\r\n    <EditorContainer\r\n      propertyRecord={propertyRecord}\r\n      onCancel={/* istanbul ignore next */ () => { }}\r\n      onCommit={onValueChange}\r\n      setFocus={false}\r\n      shouldCommitOnChange={true}\r\n    />\r\n  </div>;\r\n}\r\n"]}

package/lib/esm/components-react/filter-builder/FilterBuilderState.d.ts

@@ -1,44 +1,87 @@
+/** @packageDocumentation
+ * @module PropertyFilterBuilder
+ */
 import { PropertyDescription, PropertyValue } from "@itwin/appui-abstract";
 import { PropertyFilterRuleGroupOperator, PropertyFilterRuleOperator } from "./Operators";
 import { PropertyFilter } from "./Types";
-/** @alpha */
+/**
+ * Data structure that describes [[PropertyFilterBuilder]] component state.
+ * @internal
+ */
 export interface PropertyFilterBuilderState {
+    /** Root group of rules in [[PropertyFilterBuilder]] component. */
     rootGroup: PropertyFilterBuilderRuleGroup;
 }
-/** @alpha */
-export declare type PropertyFilterBuilderRuleGroupItem = PropertyFilterBuilderRuleGroup | PropertyFilterBuilderRule;
-/** @alpha */
+/**
+ * Type that describes [[PropertyFilterBuilder]] component group item.
+ * @internal
+ */
+export type PropertyFilterBuilderRuleGroupItem = PropertyFilterBuilderRuleGroup | PropertyFilterBuilderRule;
+/**
+ * Data structure that describes [[PropertyFilterBuilder]] component rule group.
+ * @internal
+ */
 export interface PropertyFilterBuilderRuleGroup {
+    /** Id of this rule group. */
     id: string;
+    /** Id of rule group that this group is nested in. */
     groupId?: string;
+    /** Operator that should join items in this group. */
     operator: PropertyFilterRuleGroupOperator;
+    /** Items in this group. */
     items: PropertyFilterBuilderRuleGroupItem[];
 }
-/** @alpha */
+/**
+ * Data structure that describes [[PropertyFilterBuilder]] component single rule.
+ * @internal
+ */
 export interface PropertyFilterBuilderRule {
+    /** Id of this rule. */
     id: string;
+    /** Id of rule group that this rule is nested in. */
     groupId: string;
+    /** Property used in this rule. */
     property?: PropertyDescription;
+    /** Operator that should be used to compare property value. */
     operator?: PropertyFilterRuleOperator;
+    /** Value that property should be compared to. */
     value?: PropertyValue;
 }
-/** @alpha */
+/**
+ * Actions for controlling [[PropertyFilterBuilder]] component state.
+ * @internal
+ */
 export declare class PropertyFilterBuilderActions {
     private setState;
     constructor(setState: (setter: (prevState: PropertyFilterBuilderState) => PropertyFilterBuilderState) => void);
     private updateState;
+    /** Adds new rule or group of rules to the group specified by path. */
     addItem(path: string[], itemType: "RULE_GROUP" | "RULE"): void;
+    /** Removes item specified by path. */
     removeItem(path: string[]): void;
+    /** Sets operator of rule group specified by the path. */
     setRuleGroupOperator(path: string[], operator: PropertyFilterRuleGroupOperator): void;
+    /** Sets property of rule specified by the path. */
     setRuleProperty(path: string[], property?: PropertyDescription): void;
+    /** Sets operator of rule specified by the path. */
     setRuleOperator(path: string[], operator: PropertyFilterRuleOperator): void;
+    /** Sets value of rule specified by the path. */
     setRuleValue(path: string[], value: PropertyValue): void;
 }
-/** @alpha */
+/**
+ * Function to check if supplied [[PropertyFilterBuilderRuleGroupItem]] is [[PropertyFilterBuilderRuleGroup]].
+ * @internal
+ */
 export declare function isPropertyFilterBuilderRuleGroup(item: PropertyFilterBuilderRuleGroupItem): item is PropertyFilterBuilderRuleGroup;
-/** @alpha */
+/**
+ * Custom hook that creates state for [[PropertyFilterBuilder]] component. It creates empty state or initializes
+ * state from supplied initial filter.
+ * @internal
+ */
 export declare function usePropertyFilterBuilderState(initialFilter?: PropertyFilter): {
     state: PropertyFilterBuilderState;
     actions: PropertyFilterBuilderActions;
 };
+/** @internal */
+export declare function buildPropertyFilter(groupItem: PropertyFilterBuilderRuleGroupItem): PropertyFilter | undefined;
 //# sourceMappingURL=FilterBuilderState.d.ts.map

package/lib/esm/components-react/filter-builder/FilterBuilderState.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"FilterBuilderState.d.ts","sourceRoot":"","sources":["../../../../src/components-react/filter-builder/FilterBuilderState.ts"],"names":[],"mappings":"AAMA,OAAO,EAAE,mBAAmB,EAAE,aAAa,EAAE,MAAM,uBAAuB,CAAC;AAE3E,OAAO,EAAiC,+BAA+B,EAAE,0BAA0B,EAAE,MAAM,aAAa,CAAC;AACzH,OAAO,EAA6B,cAAc,EAAsB,MAAM,SAAS,CAAC;AAExF,aAAa;AACb,MAAM,WAAW,0BAA0B;IACzC,SAAS,EAAE,8BAA8B,CAAC;CAC3C;AAED,aAAa;AACb,oBAAY,kCAAkC,GAAG,8BAA8B,GAAG,yBAAyB,CAAC;AAE5G,aAAa;AACb,MAAM,WAAW,8BAA8B;IAC7C,EAAE,EAAE,MAAM,CAAC;IACX,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,QAAQ,EAAE,+BAA+B,CAAC;IAC1C,KAAK,EAAE,kCAAkC,EAAE,CAAC;CAC7C;AAED,aAAa;AACb,MAAM,WAAW,yBAAyB;IACxC,EAAE,EAAE,MAAM,CAAC;IACX,OAAO,EAAE,MAAM,CAAC;IAChB,QAAQ,CAAC,EAAE,mBAAmB,CAAC;IAC/B,QAAQ,CAAC,EAAE,0BAA0B,CAAC;IACtC,KAAK,CAAC,EAAE,aAAa,CAAC;CACvB;AAED,aAAa;AACb,qBAAa,4BAA4B;IAC3B,OAAO,CAAC,QAAQ;gBAAR,QAAQ,EAAE,CAAC,MAAM,EAAE,CAAC,SAAS,EAAE,0BAA0B,KAAK,0BAA0B,KAAK,IAAI;IAErH,OAAO,CAAC,WAAW;IAIZ,OAAO,CAAC,IAAI,EAAE,MAAM,EAAE,EAAE,QAAQ,EAAE,YAAY,GAAG,MAAM;IAUvD,UAAU,CAAC,IAAI,EAAE,MAAM,EAAE;IAoBzB,oBAAoB,CAAC,IAAI,EAAE,MAAM,EAAE,EAAE,QAAQ,EAAE,+BAA+B;IAS9E,eAAe,CAAC,IAAI,EAAE,MAAM,EAAE,EAAE,QAAQ,CAAC,EAAE,mBAAmB;IAU9D,eAAe,CAAC,IAAI,EAAE,MAAM,EAAE,EAAE,QAAQ,EAAE,0BAA0B;IAWpE,YAAY,CAAC,IAAI,EAAE,MAAM,EAAE,EAAE,KAAK,EAAE,aAAa;CAQzD;AAED,aAAa;AACb,wBAAgB,gCAAgC,CAAC,IAAI,EAAE,kCAAkC,GAAG,IAAI,IAAI,8BAA8B,CAEjI;AAED,aAAa;AACb,wBAAgB,6BAA6B,CAAC,aAAa,CAAC,EAAE,cAAc;;;EAO3E"}
+{"version":3,"file":"FilterBuilderState.d.ts","sourceRoot":"","sources":["../../../../src/components-react/filter-builder/FilterBuilderState.ts"],"names":[],"mappings":"AAIA;;GAEG;AAIH,OAAO,EAAE,mBAAmB,EAAE,aAAa,EAAuB,MAAM,uBAAuB,CAAC;AAEhG,OAAO,EAAiC,+BAA+B,EAAE,0BAA0B,EAAE,MAAM,aAAa,CAAC;AACzH,OAAO,EAA6B,cAAc,EAAsB,MAAM,SAAS,CAAC;AAExF;;;GAGG;AACH,MAAM,WAAW,0BAA0B;IACzC,kEAAkE;IAClE,SAAS,EAAE,8BAA8B,CAAC;CAC3C;AAED;;;GAGG;AACH,MAAM,MAAM,kCAAkC,GAAG,8BAA8B,GAAG,yBAAyB,CAAC;AAE5G;;;GAGG;AACH,MAAM,WAAW,8BAA8B;IAC7C,6BAA6B;IAC7B,EAAE,EAAE,MAAM,CAAC;IACX,qDAAqD;IACrD,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,qDAAqD;IACrD,QAAQ,EAAE,+BAA+B,CAAC;IAC1C,2BAA2B;IAC3B,KAAK,EAAE,kCAAkC,EAAE,CAAC;CAC7C;AAED;;;GAGG;AACH,MAAM,WAAW,yBAAyB;IACxC,uBAAuB;IACvB,EAAE,EAAE,MAAM,CAAC;IACX,oDAAoD;IACpD,OAAO,EAAE,MAAM,CAAC;IAChB,kCAAkC;IAClC,QAAQ,CAAC,EAAE,mBAAmB,CAAC;IAC/B,8DAA8D;IAC9D,QAAQ,CAAC,EAAE,0BAA0B,CAAC;IACtC,iDAAiD;IACjD,KAAK,CAAC,EAAE,aAAa,CAAC;CACvB;AAED;;;GAGG;AACH,qBAAa,4BAA4B;IAC3B,OAAO,CAAC,QAAQ;gBAAR,QAAQ,EAAE,CAAC,MAAM,EAAE,CAAC,SAAS,EAAE,0BAA0B,KAAK,0BAA0B,KAAK,IAAI;IAErH,OAAO,CAAC,WAAW;IAInB,sEAAsE;IAC/D,OAAO,CAAC,IAAI,EAAE,MAAM,EAAE,EAAE,QAAQ,EAAE,YAAY,GAAG,MAAM;IAU9D,sCAAsC;IAC/B,UAAU,CAAC,IAAI,EAAE,MAAM,EAAE;IAoBhC,yDAAyD;IAClD,oBAAoB,CAAC,IAAI,EAAE,MAAM,EAAE,EAAE,QAAQ,EAAE,+BAA+B;IASrF,mDAAmD;IAC5C,eAAe,CAAC,IAAI,EAAE,MAAM,EAAE,EAAE,QAAQ,CAAC,EAAE,mBAAmB;IAUrE,mDAAmD;IAC5C,eAAe,CAAC,IAAI,EAAE,MAAM,EAAE,EAAE,QAAQ,EAAE,0BAA0B;IAW3E,gDAAgD;IACzC,YAAY,CAAC,IAAI,EAAE,MAAM,EAAE,EAAE,KAAK,EAAE,aAAa;CAQzD;AAED;;;GAGG;AACH,wBAAgB,gCAAgC,CAAC,IAAI,EAAE,kCAAkC,GAAG,IAAI,IAAI,8BAA8B,CAEjI;AAED;;;;GAIG;AACH,wBAAgB,6BAA6B,CAAC,aAAa,CAAC,EAAE,cAAc;;;EAO3E;AAED,gBAAgB;AAChB,wBAAgB,mBAAmB,CAAC,SAAS,EAAE,kCAAkC,GAAG,cAAc,GAAG,SAAS,CAI7G"}

package/lib/esm/components-react/filter-builder/FilterBuilderState.js

@@ -2,12 +2,19 @@
 * Copyright (c) Bentley Systems, Incorporated. All rights reserved.
 * See LICENSE.md in the project root for license terms and full copyright notice.
 *--------------------------------------------------------------------------------------------*/
+/** @packageDocumentation
+ * @module PropertyFilterBuilder
+ */
 import { produce } from "immer";
 import * as React from "react";
+import { PropertyValueFormat } from "@itwin/appui-abstract";
 import { Guid } from "@itwin/core-bentley";
 import { isUnaryPropertyFilterOperator, PropertyFilterRuleGroupOperator } from "./Operators";
 import { isPropertyFilterRuleGroup } from "./Types";
-/** @alpha */
+/**
+ * Actions for controlling [[PropertyFilterBuilder]] component state.
+ * @internal
+ */
 export class PropertyFilterBuilderActions {
     constructor(setState) {
         this.setState = setState;
@@ -15,6 +22,7 @@ export class PropertyFilterBuilderActions {
     updateState(updater) {
         this.setState(produce(updater));
     }
+    /** Adds new rule or group of rules to the group specified by path. */
     addItem(path, itemType) {
         this.updateState((state) => {
             const parentGroup = findRuleGroup(state.rootGroup, path);
@@ -24,6 +32,7 @@ export class PropertyFilterBuilderActions {
             parentGroup.items.push(item);
         });
     }
+    /** Removes item specified by path. */
     removeItem(path) {
         function removeItemFromGroup(state, pathToItem) {
             const pathToParent = pathToItem.slice(0, -1);
@@ -42,6 +51,7 @@ export class PropertyFilterBuilderActions {
             removeItemFromGroup(state, path);
         });
     }
+    /** Sets operator of rule group specified by the path. */
     setRuleGroupOperator(path, operator) {
         this.updateState((state) => {
             const group = findRuleGroup(state.rootGroup, path);
@@ -50,6 +60,7 @@ export class PropertyFilterBuilderActions {
             group.operator = operator;
         });
     }
+    /** Sets property of rule specified by the path. */
     setRuleProperty(path, property) {
         this.updateState((state) => {
             const rule = findRule(state.rootGroup, path);
@@ -59,6 +70,7 @@ export class PropertyFilterBuilderActions {
             rule.value = undefined;
         });
     }
+    /** Sets operator of rule specified by the path. */
     setRuleOperator(path, operator) {
         this.updateState((state) => {
             const rule = findRule(state.rootGroup, path);
@@ -69,6 +81,7 @@ export class PropertyFilterBuilderActions {
             rule.operator = operator;
         });
     }
+    /** Sets value of rule specified by the path. */
     setRuleValue(path, value) {
         this.updateState((state) => {
             const rule = findRule(state.rootGroup, path);
@@ -78,16 +91,54 @@ export class PropertyFilterBuilderActions {
         });
     }
 }
-/** @alpha */
+/**
+ * Function to check if supplied [[PropertyFilterBuilderRuleGroupItem]] is [[PropertyFilterBuilderRuleGroup]].
+ * @internal
+ */
 export function isPropertyFilterBuilderRuleGroup(item) {
     return item.items !== undefined;
 }
-/** @alpha */
+/**
+ * Custom hook that creates state for [[PropertyFilterBuilder]] component. It creates empty state or initializes
+ * state from supplied initial filter.
+ * @internal
+ */
 export function usePropertyFilterBuilderState(initialFilter) {
     const [state, setState] = React.useState(() => initialFilter ? convertFilterToState(initialFilter) : { rootGroup: createEmptyRuleGroup() });
     const [actions] = React.useState(() => new PropertyFilterBuilderActions(setState));
     return { state, actions };
 }
+/** @internal */
+export function buildPropertyFilter(groupItem) {
+    if (isPropertyFilterBuilderRuleGroup(groupItem))
+        return buildPropertyFilterFromRuleGroup(groupItem);
+    return buildPropertyFilterFromRule(groupItem);
+}
+function buildPropertyFilterFromRuleGroup(rootGroup) {
+    if (rootGroup.items.length === 0)
+        return undefined;
+    const rules = new Array();
+    for (const item of rootGroup.items) {
+        const rule = buildPropertyFilter(item);
+        if (!rule)
+            return undefined;
+        rules.push(rule);
+    }
+    if (rules.length === 1)
+        return rules[0];
+    return {
+        operator: rootGroup.operator,
+        rules,
+    };
+}
+function buildPropertyFilterFromRule(rule) {
+    const { property, operator, value } = rule;
+    if (!property || operator === undefined)
+        return undefined;
+    if (!isUnaryPropertyFilterOperator(operator) && (value === undefined || value.valueFormat !== PropertyValueFormat.Primitive || value.value === undefined))
+        return undefined;
+    return { property, operator, value };
+}
 function createEmptyRule(groupId) {
     return {
         id: Guid.createValue(),

package/lib/esm/components-react/filter-builder/FilterBuilderState.js.map

@@ -1 +1 @@
-{"version":3,"file":"FilterBuilderState.js","sourceRoot":"","sources":["../../../../src/components-react/filter-builder/FilterBuilderState.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F,OAAO,EAAS,OAAO,EAAE,MAAM,OAAO,CAAC;AACvC,OAAO,KAAK,KAAK,MAAM,OAAO,CAAC;AAE/B,OAAO,EAAE,IAAI,EAAE,MAAM,qBAAqB,CAAC;AAC3C,OAAO,EAAE,6BAA6B,EAAE,+BAA+B,EAA8B,MAAM,aAAa,CAAC;AACzH,OAAO,EAAE,yBAAyB,EAAsC,MAAM,SAAS,CAAC;AA2BxF,aAAa;AACb,MAAM,OAAO,4BAA4B;IACvC,YAAoB,QAAiG;QAAjG,aAAQ,GAAR,QAAQ,CAAyF;IAAI,CAAC;IAElH,WAAW,CAAC,OAA2D;QAC7E,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC;IAClC,CAAC;IAEM,OAAO,CAAC,IAAc,EAAE,QAA+B;QAC5D,IAAI,CAAC,WAAW,CAAC,CAAC,KAAK,EAAE,EAAE;YACzB,MAAM,WAAW,GAAG,aAAa,CAAC,KAAK,CAAC,SAAS,EAAE,IAAI,CAAC,CAAC;YACzD,IAAI,CAAC,WAAW;gBACd,OAAO;YACT,MAAM,IAAI,GAAG,QAAQ,KAAK,YAAY,CAAC,CAAC,CAAC,oBAAoB,CAAC,WAAW,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,eAAe,CAAC,WAAW,CAAC,EAAE,CAAC,CAAC;YAChH,WAAW,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAC/B,CAAC,CAAC,CAAC;IACL,CAAC;IAEM,UAAU,CAAC,IAAc;QAC9B,SAAS,mBAAmB,CAAC,KAAwC,EAAE,UAAoB;YACzF,MAAM,YAAY,GAAG,UAAU,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;YAC7C,MAAM,WAAW,GAAG,aAAa,CAAC,KAAK,CAAC,SAAS,EAAE,YAAY,CAAC,CAAC;YACjE,IAAI,CAAC,WAAW;gBACd,OAAO;YACT,MAAM,MAAM,GAAG,UAAU,CAAC,UAAU,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;YACjD,MAAM,SAAS,GAAG,WAAW,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,EAAE,KAAK,MAAM,CAAC,CAAC;YAC5E,IAAI,SAAS,KAAK,CAAC,CAAC;gBAClB,OAAO;YACT,WAAW,CAAC,KAAK,CAAC,MAAM,CAAC,SAAS,EAAE,CAAC,CAAC,CAAC;YACvC,IAAI,WAAW,CAAC,KAAK,CAAC,MAAM,KAAK,CAAC;gBAChC,mBAAmB,CAAC,KAAK,EAAE,YAAY,CAAC,CAAC;QAC7C,CAAC;QAED,IAAI,CAAC,WAAW,CAAC,CAAC,KAAK,EAAE,EAAE;YACzB,mBAAmB,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC;QACnC,CAAC,CAAC,CAAC;IACL,CAAC;IAEM,oBAAoB,CAAC,IAAc,EAAE,QAAyC;QACnF,IAAI,CAAC,WAAW,CAAC,CAAC,KAAK,EAAE,EAAE;YACzB,MAAM,KAAK,GAAG,aAAa,CAAC,KAAK,CAAC,SAAS,EAAE,IAAI,CAAC,CAAC;YACnD,IAAI,CAAC,KAAK;gBACR,OAAO;YACT,KAAK,CAAC,QAAQ,GAAG,QAAQ,CAAC;QAC5B,CAAC,CAAC,CAAC;IACL,CAAC;IAEM,eAAe,CAAC,IAAc,EAAE,QAA8B;QACnE,IAAI,CAAC,WAAW,CAAC,CAAC,KAAK,EAAE,EAAE;YACzB,MAAM,IAAI,GAAG,QAAQ,CAAC,KAAK,CAAC,SAAS,EAAE,IAAI,CAAC,CAAC;YAC7C,IAAI,CAAC,IAAI;gBACP,OAAO;YACT,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;YACzB,IAAI,CAAC,KAAK,GAAG,SAAS,CAAC;QACzB,CAAC,CAAC,CAAC;IACL,CAAC;IAEM,eAAe,CAAC,IAAc,EAAE,QAAoC;QACzE,IAAI,CAAC,WAAW,CAAC,CAAC,KAAK,EAAE,EAAE;YACzB,MAAM,IAAI,GAAG,QAAQ,CAAC,KAAK,CAAC,SAAS,EAAE,IAAI,CAAC,CAAC;YAC7C,IAAI,CAAC,IAAI;gBACP,OAAO;YACT,IAAI,6BAA6B,CAAC,QAAQ,CAAC;gBACzC,IAAI,CAAC,KAAK,GAAG,SAAS,CAAC;YACzB,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;QAC3B,CAAC,CAAC,CAAC;IACL,CAAC;IAEM,YAAY,CAAC,IAAc,EAAE,KAAoB;QACtD,IAAI,CAAC,WAAW,CAAC,CAAC,KAAK,EAAE,EAAE;YACzB,MAAM,IAAI,GAAG,QAAQ,CAAC,KAAK,CAAC,SAAS,EAAE,IAAI,CAAC,CAAC;YAC7C,IAAI,CAAC,IAAI;gBACP,OAAO;YACT,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC;QACrB,CAAC,CAAC,CAAC;IACL,CAAC;CACF;AAED,aAAa;AACb,MAAM,UAAU,gCAAgC,CAAC,IAAwC;IACvF,OAAQ,IAAY,CAAC,KAAK,KAAK,SAAS,CAAC;AAC3C,CAAC;AAED,aAAa;AACb,MAAM,UAAU,6BAA6B,CAAC,aAA8B;IAC1E,MAAM,CAAC,KAAK,EAAE,QAAQ,CAAC,GAAG,KAAK,CAAC,QAAQ,CACtC,GAAG,EAAE,CAAC,aAAa,CAAC,CAAC,CAAC,oBAAoB,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC,EAAE,SAAS,EAAE,oBAAoB,EAAE,EAAE,CAClG,CAAC;IACF,MAAM,CAAC,OAAO,CAAC,GAAG,KAAK,CAAC,QAAQ,CAAC,GAAG,EAAE,CAAC,IAAI,4BAA4B,CAAC,QAAQ,CAAC,CAAC,CAAC;IAEnF,OAAO,EAAE,KAAK,EAAE,OAAO,EAAE,CAAC;AAC5B,CAAC;AAED,SAAS,eAAe,CAAC,OAAe;IACtC,OAAO;QACL,EAAE,EAAE,IAAI,CAAC,WAAW,EAAE;QACtB,OAAO;KACR,CAAC;AACJ,CAAC;AAED,SAAS,oBAAoB,CAAC,OAAgB;IAC5C,MAAM,EAAE,GAAG,IAAI,CAAC,WAAW,EAAE,CAAC;IAC9B,OAAO;QACL,EAAE;QACF,OAAO;QACP,QAAQ,EAAE,+BAA+B,CAAC,GAAG;QAC7C,KAAK,EAAE,CAAC,eAAe,CAAC,EAAE,CAAC,CAAC;KAC7B,CAAC;AACJ,CAAC;AAED,SAAS,aAAa,CAAC,SAAyC,EAAE,IAAc;IAC9E,IAAI,IAAI,CAAC,MAAM,KAAK,CAAC;QACnB,OAAO,SAAS,CAAC;IAEnB,MAAM,CAAC,aAAa,EAAE,GAAG,IAAI,CAAC,GAAG,IAAI,CAAC;IACtC,MAAM,WAAW,GAAG,SAAS,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,EAAE,KAAK,aAAa,CAAC,CAAC;IAC9E,IAAI,CAAC,WAAW,IAAI,CAAC,gCAAgC,CAAC,WAAW,CAAC;QAChE,OAAO,SAAS,CAAC;IAEnB,OAAO,aAAa,CAAC,WAAW,EAAE,IAAI,CAAC,CAAC;AAC1C,CAAC;AAED,SAAS,QAAQ,CAAC,SAAyC,EAAE,IAAc;IACzE,IAAI,IAAI,CAAC,MAAM,KAAK,CAAC;QACnB,OAAO,SAAS,CAAC;IAEnB,MAAM,CAAC,aAAa,EAAE,GAAG,IAAI,CAAC,GAAG,IAAI,CAAC;IACtC,MAAM,WAAW,GAAG,SAAS,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,EAAE,KAAK,aAAa,CAAC,CAAC;IAC9E,IAAI,CAAC,WAAW;QACd,OAAO,SAAS,CAAC;IAEnB,IAAI,gCAAgC,CAAC,WAAW,CAAC;QAC/C,OAAO,QAAQ,CAAC,WAAW,EAAE,IAAI,CAAC,CAAC;IAErC,OAAO,WAAW,CAAC;AACrB,CAAC;AAED,SAAS,gBAAgB,CAAC,MAAsB,EAAE,QAAgB;IAChE,MAAM,EAAE,GAAG,IAAI,CAAC,WAAW,EAAE,CAAC;IAC9B,IAAI,yBAAyB,CAAC,MAAM,CAAC;QACnC,OAAO;YACL,EAAE;YACF,OAAO,EAAE,QAAQ;YACjB,QAAQ,EAAE,MAAM,CAAC,QAAQ;YACzB,KAAK,EAAE,MAAM,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,gBAAgB,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC;SAC9D,CAAC;IACJ,OAAO,WAAW,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC;AACjC,CAAC;AAED,SAAS,WAAW,CAAC,MAA0B,EAAE,QAAgB;IAC/D,OAAO;QACL,EAAE,EAAE,IAAI,CAAC,WAAW,EAAE;QACtB,OAAO,EAAE,QAAQ;QACjB,QAAQ,EAAE,MAAM,CAAC,QAAQ;QACzB,QAAQ,EAAE,MAAM,CAAC,QAAQ;QACzB,KAAK,EAAE,MAAM,CAAC,KAAK;KACpB,CAAC;AACJ,CAAC;AAED,SAAS,oBAAoB,CAAC,MAAsB;IAClD,MAAM,EAAE,GAAG,IAAI,CAAC,WAAW,EAAE,CAAC;IAC9B,IAAI,yBAAyB,CAAC,MAAM,CAAC,EAAE;QACrC,OAAO;YACL,SAAS,EAAE;gBACT,EAAE;gBACF,QAAQ,EAAE,MAAM,CAAC,QAAQ;gBACzB,KAAK,EAAE,MAAM,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,gBAAgB,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC;aAC9D;SACF,CAAC;KACH;IACD,OAAO;QACL,SAAS,EAAE;YACT,EAAE;YACF,QAAQ,EAAE,+BAA+B,CAAC,GAAG;YAC7C,KAAK,EAAE,CAAC,WAAW,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC;SACjC;KACF,CAAC;AACJ,CAAC","sourcesContent":["/*---------------------------------------------------------------------------------------------\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n* See LICENSE.md in the project root for license terms and full copyright notice.\n*--------------------------------------------------------------------------------------------*/\nimport { Draft, produce } from \"immer\";\nimport * as React from \"react\";\nimport { PropertyDescription, PropertyValue } from \"@itwin/appui-abstract\";\nimport { Guid } from \"@itwin/core-bentley\";\nimport { isUnaryPropertyFilterOperator, PropertyFilterRuleGroupOperator, PropertyFilterRuleOperator } from \"./Operators\";\nimport { isPropertyFilterRuleGroup, PropertyFilter, PropertyFilterRule } from \"./Types\";\n\n/** @alpha */\nexport interface PropertyFilterBuilderState {\n  rootGroup: PropertyFilterBuilderRuleGroup;\n}\n\n/** @alpha */\nexport type PropertyFilterBuilderRuleGroupItem = PropertyFilterBuilderRuleGroup | PropertyFilterBuilderRule;\n\n/** @alpha */\nexport interface PropertyFilterBuilderRuleGroup {\n  id: string;\n  groupId?: string;\n  operator: PropertyFilterRuleGroupOperator;\n  items: PropertyFilterBuilderRuleGroupItem[];\n}\n\n/** @alpha */\nexport interface PropertyFilterBuilderRule {\n  id: string;\n  groupId: string;\n  property?: PropertyDescription;\n  operator?: PropertyFilterRuleOperator;\n  value?: PropertyValue;\n}\n\n/** @alpha */\nexport class PropertyFilterBuilderActions {\n  constructor(private setState: (setter: (prevState: PropertyFilterBuilderState) => PropertyFilterBuilderState) => void) { }\n\n  private updateState(updater: (state: Draft<PropertyFilterBuilderState>) => void) {\n    this.setState(produce(updater));\n  }\n\n  public addItem(path: string[], itemType: \"RULE_GROUP\" | \"RULE\") {\n    this.updateState((state) => {\n      const parentGroup = findRuleGroup(state.rootGroup, path);\n      if (!parentGroup)\n        return;\n      const item = itemType === \"RULE_GROUP\" ? createEmptyRuleGroup(parentGroup.id) : createEmptyRule(parentGroup.id);\n      parentGroup.items.push(item);\n    });\n  }\n\n  public removeItem(path: string[]) {\n    function removeItemFromGroup(state: Draft<PropertyFilterBuilderState>, pathToItem: string[]) {\n      const pathToParent = pathToItem.slice(0, -1);\n      const parentGroup = findRuleGroup(state.rootGroup, pathToParent);\n      if (!parentGroup)\n        return;\n      const itemId = pathToItem[pathToItem.length - 1];\n      const itemIndex = parentGroup.items.findIndex((item) => item.id === itemId);\n      if (itemIndex === -1)\n        return;\n      parentGroup.items.splice(itemIndex, 1);\n      if (parentGroup.items.length === 0)\n        removeItemFromGroup(state, pathToParent);\n    }\n\n    this.updateState((state) => {\n      removeItemFromGroup(state, path);\n    });\n  }\n\n  public setRuleGroupOperator(path: string[], operator: PropertyFilterRuleGroupOperator) {\n    this.updateState((state) => {\n      const group = findRuleGroup(state.rootGroup, path);\n      if (!group)\n        return;\n      group.operator = operator;\n    });\n  }\n\n  public setRuleProperty(path: string[], property?: PropertyDescription) {\n    this.updateState((state) => {\n      const rule = findRule(state.rootGroup, path);\n      if (!rule)\n        return;\n      rule.property = property;\n      rule.value = undefined;\n    });\n  }\n\n  public setRuleOperator(path: string[], operator: PropertyFilterRuleOperator) {\n    this.updateState((state) => {\n      const rule = findRule(state.rootGroup, path);\n      if (!rule)\n        return;\n      if (isUnaryPropertyFilterOperator(operator))\n        rule.value = undefined;\n      rule.operator = operator;\n    });\n  }\n\n  public setRuleValue(path: string[], value: PropertyValue) {\n    this.updateState((state) => {\n      const rule = findRule(state.rootGroup, path);\n      if (!rule)\n        return;\n      rule.value = value;\n    });\n  }\n}\n\n/** @alpha */\nexport function isPropertyFilterBuilderRuleGroup(item: PropertyFilterBuilderRuleGroupItem): item is PropertyFilterBuilderRuleGroup {\n  return (item as any).items !== undefined;\n}\n\n/** @alpha */\nexport function usePropertyFilterBuilderState(initialFilter?: PropertyFilter) {\n  const [state, setState] = React.useState<PropertyFilterBuilderState>(\n    () => initialFilter ? convertFilterToState(initialFilter) : { rootGroup: createEmptyRuleGroup() }\n  );\n  const [actions] = React.useState(() => new PropertyFilterBuilderActions(setState));\n\n  return { state, actions };\n}\n\nfunction createEmptyRule(groupId: string): PropertyFilterBuilderRule {\n  return {\n    id: Guid.createValue(),\n    groupId,\n  };\n}\n\nfunction createEmptyRuleGroup(groupId?: string): PropertyFilterBuilderRuleGroup {\n  const id = Guid.createValue();\n  return {\n    id,\n    groupId,\n    operator: PropertyFilterRuleGroupOperator.And,\n    items: [createEmptyRule(id)],\n  };\n}\n\nfunction findRuleGroup(rootGroup: PropertyFilterBuilderRuleGroup, path: string[]): PropertyFilterBuilderRuleGroup | undefined {\n  if (path.length === 0)\n    return rootGroup;\n\n  const [currentItemId, ...rest] = path;\n  const currentItem = rootGroup.items.find((item) => item.id === currentItemId);\n  if (!currentItem || !isPropertyFilterBuilderRuleGroup(currentItem))\n    return undefined;\n\n  return findRuleGroup(currentItem, rest);\n}\n\nfunction findRule(rootGroup: PropertyFilterBuilderRuleGroup, path: string[]): PropertyFilterBuilderRule | undefined {\n  if (path.length === 0)\n    return undefined;\n\n  const [currentItemId, ...rest] = path;\n  const currentItem = rootGroup.items.find((item) => item.id === currentItemId);\n  if (!currentItem)\n    return undefined;\n\n  if (isPropertyFilterBuilderRuleGroup(currentItem))\n    return findRule(currentItem, rest);\n\n  return currentItem;\n}\n\nfunction getRuleGroupItem(filter: PropertyFilter, parentId: string): PropertyFilterBuilderRuleGroupItem {\n  const id = Guid.createValue();\n  if (isPropertyFilterRuleGroup(filter))\n    return {\n      id,\n      groupId: parentId,\n      operator: filter.operator,\n      items: filter.rules.map((rule) => getRuleGroupItem(rule, id)),\n    };\n  return getRuleItem(filter, id);\n}\n\nfunction getRuleItem(filter: PropertyFilterRule, parentId: string) {\n  return {\n    id: Guid.createValue(),\n    groupId: parentId,\n    property: filter.property,\n    operator: filter.operator,\n    value: filter.value,\n  };\n}\n\nfunction convertFilterToState(filter: PropertyFilter): PropertyFilterBuilderState {\n  const id = Guid.createValue();\n  if (isPropertyFilterRuleGroup(filter)) {\n    return {\n      rootGroup: {\n        id,\n        operator: filter.operator,\n        items: filter.rules.map((rule) => getRuleGroupItem(rule, id)),\n      },\n    };\n  }\n  return {\n    rootGroup: {\n      id,\n      operator: PropertyFilterRuleGroupOperator.And,\n      items: [getRuleItem(filter, id)],\n    },\n  };\n}\n"]}
+{"version":3,"file":"FilterBuilderState.js","sourceRoot":"","sources":["../../../../src/components-react/filter-builder/FilterBuilderState.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAEH,OAAO,EAAS,OAAO,EAAE,MAAM,OAAO,CAAC;AACvC,OAAO,KAAK,KAAK,MAAM,OAAO,CAAC;AAC/B,OAAO,EAAsC,mBAAmB,EAAE,MAAM,uBAAuB,CAAC;AAChG,OAAO,EAAE,IAAI,EAAE,MAAM,qBAAqB,CAAC;AAC3C,OAAO,EAAE,6BAA6B,EAAE,+BAA+B,EAA8B,MAAM,aAAa,CAAC;AACzH,OAAO,EAAE,yBAAyB,EAAsC,MAAM,SAAS,CAAC;AAiDxF;;;GAGG;AACH,MAAM,OAAO,4BAA4B;IACvC,YAAoB,QAAiG;QAAjG,aAAQ,GAAR,QAAQ,CAAyF;IAAI,CAAC;IAElH,WAAW,CAAC,OAA2D;QAC7E,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC;IAClC,CAAC;IAED,sEAAsE;IAC/D,OAAO,CAAC,IAAc,EAAE,QAA+B;QAC5D,IAAI,CAAC,WAAW,CAAC,CAAC,KAAK,EAAE,EAAE;YACzB,MAAM,WAAW,GAAG,aAAa,CAAC,KAAK,CAAC,SAAS,EAAE,IAAI,CAAC,CAAC;YACzD,IAAI,CAAC,WAAW;gBACd,OAAO;YACT,MAAM,IAAI,GAAG,QAAQ,KAAK,YAAY,CAAC,CAAC,CAAC,oBAAoB,CAAC,WAAW,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,eAAe,CAAC,WAAW,CAAC,EAAE,CAAC,CAAC;YAChH,WAAW,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAC/B,CAAC,CAAC,CAAC;IACL,CAAC;IAED,sCAAsC;IAC/B,UAAU,CAAC,IAAc;QAC9B,SAAS,mBAAmB,CAAC,KAAwC,EAAE,UAAoB;YACzF,MAAM,YAAY,GAAG,UAAU,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;YAC7C,MAAM,WAAW,GAAG,aAAa,CAAC,KAAK,CAAC,SAAS,EAAE,YAAY,CAAC,CAAC;YACjE,IAAI,CAAC,WAAW;gBACd,OAAO;YACT,MAAM,MAAM,GAAG,UAAU,CAAC,UAAU,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;YACjD,MAAM,SAAS,GAAG,WAAW,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,EAAE,KAAK,MAAM,CAAC,CAAC;YAC5E,IAAI,SAAS,KAAK,CAAC,CAAC;gBAClB,OAAO;YACT,WAAW,CAAC,KAAK,CAAC,MAAM,CAAC,SAAS,EAAE,CAAC,CAAC,CAAC;YACvC,IAAI,WAAW,CAAC,KAAK,CAAC,MAAM,KAAK,CAAC;gBAChC,mBAAmB,CAAC,KAAK,EAAE,YAAY,CAAC,CAAC;QAC7C,CAAC;QAED,IAAI,CAAC,WAAW,CAAC,CAAC,KAAK,EAAE,EAAE;YACzB,mBAAmB,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC;QACnC,CAAC,CAAC,CAAC;IACL,CAAC;IAED,yDAAyD;IAClD,oBAAoB,CAAC,IAAc,EAAE,QAAyC;QACnF,IAAI,CAAC,WAAW,CAAC,CAAC,KAAK,EAAE,EAAE;YACzB,MAAM,KAAK,GAAG,aAAa,CAAC,KAAK,CAAC,SAAS,EAAE,IAAI,CAAC,CAAC;YACnD,IAAI,CAAC,KAAK;gBACR,OAAO;YACT,KAAK,CAAC,QAAQ,GAAG,QAAQ,CAAC;QAC5B,CAAC,CAAC,CAAC;IACL,CAAC;IAED,mDAAmD;IAC5C,eAAe,CAAC,IAAc,EAAE,QAA8B;QACnE,IAAI,CAAC,WAAW,CAAC,CAAC,KAAK,EAAE,EAAE;YACzB,MAAM,IAAI,GAAG,QAAQ,CAAC,KAAK,CAAC,SAAS,EAAE,IAAI,CAAC,CAAC;YAC7C,IAAI,CAAC,IAAI;gBACP,OAAO;YACT,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;YACzB,IAAI,CAAC,KAAK,GAAG,SAAS,CAAC;QACzB,CAAC,CAAC,CAAC;IACL,CAAC;IAED,mDAAmD;IAC5C,eAAe,CAAC,IAAc,EAAE,QAAoC;QACzE,IAAI,CAAC,WAAW,CAAC,CAAC,KAAK,EAAE,EAAE;YACzB,MAAM,IAAI,GAAG,QAAQ,CAAC,KAAK,CAAC,SAAS,EAAE,IAAI,CAAC,CAAC;YAC7C,IAAI,CAAC,IAAI;gBACP,OAAO;YACT,IAAI,6BAA6B,CAAC,QAAQ,CAAC;gBACzC,IAAI,CAAC,KAAK,GAAG,SAAS,CAAC;YACzB,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;QAC3B,CAAC,CAAC,CAAC;IACL,CAAC;IAED,gDAAgD;IACzC,YAAY,CAAC,IAAc,EAAE,KAAoB;QACtD,IAAI,CAAC,WAAW,CAAC,CAAC,KAAK,EAAE,EAAE;YACzB,MAAM,IAAI,GAAG,QAAQ,CAAC,KAAK,CAAC,SAAS,EAAE,IAAI,CAAC,CAAC;YAC7C,IAAI,CAAC,IAAI;gBACP,OAAO;YACT,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC;QACrB,CAAC,CAAC,CAAC;IACL,CAAC;CACF;AAED;;;GAGG;AACH,MAAM,UAAU,gCAAgC,CAAC,IAAwC;IACvF,OAAQ,IAAY,CAAC,KAAK,KAAK,SAAS,CAAC;AAC3C,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,6BAA6B,CAAC,aAA8B;IAC1E,MAAM,CAAC,KAAK,EAAE,QAAQ,CAAC,GAAG,KAAK,CAAC,QAAQ,CACtC,GAAG,EAAE,CAAC,aAAa,CAAC,CAAC,CAAC,oBAAoB,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC,EAAE,SAAS,EAAE,oBAAoB,EAAE,EAAE,CAClG,CAAC;IACF,MAAM,CAAC,OAAO,CAAC,GAAG,KAAK,CAAC,QAAQ,CAAC,GAAG,EAAE,CAAC,IAAI,4BAA4B,CAAC,QAAQ,CAAC,CAAC,CAAC;IAEnF,OAAO,EAAE,KAAK,EAAE,OAAO,EAAE,CAAC;AAC5B,CAAC;AAED,gBAAgB;AAChB,MAAM,UAAU,mBAAmB,CAAC,SAA6C;IAC/E,IAAI,gCAAgC,CAAC,SAAS,CAAC;QAC7C,OAAO,gCAAgC,CAAC,SAAS,CAAC,CAAC;IACrD,OAAO,2BAA2B,CAAC,SAAS,CAAC,CAAC;AAChD,CAAC;AAED,SAAS,gCAAgC,CAAC,SAAyC;IACjF,IAAI,SAAS,CAAC,KAAK,CAAC,MAAM,KAAK,CAAC;QAC9B,OAAO,SAAS,CAAC;IAEnB,MAAM,KAAK,GAAG,IAAI,KAAK,EAAkB,CAAC;IAC1C,KAAK,MAAM,IAAI,IAAI,SAAS,CAAC,KAAK,EAAE;QAClC,MAAM,IAAI,GAAG,mBAAmB,CAAC,IAAI,CAAC,CAAC;QACvC,IAAI,CAAC,IAAI;YACP,OAAO,SAAS,CAAC;QACnB,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;KAClB;IAED,IAAI,KAAK,CAAC,MAAM,KAAK,CAAC;QACpB,OAAO,KAAK,CAAC,CAAC,CAAC,CAAC;IAElB,OAAO;QACL,QAAQ,EAAE,SAAS,CAAC,QAAQ;QAC5B,KAAK;KACN,CAAC;AACJ,CAAC;AAED,SAAS,2BAA2B,CAAC,IAA+B;IAClE,MAAM,EAAE,QAAQ,EAAE,QAAQ,EAAE,KAAK,EAAE,GAAG,IAAI,CAAC;IAC3C,IAAI,CAAC,QAAQ,IAAI,QAAQ,KAAK,SAAS;QACrC,OAAO,SAAS,CAAC;IAEnB,IAAI,CAAC,6BAA6B,CAAC,QAAQ,CAAC,IAAI,CAAC,KAAK,KAAK,SAAS,IAAI,KAAK,CAAC,WAAW,KAAK,mBAAmB,CAAC,SAAS,IAAI,KAAK,CAAC,KAAK,KAAK,SAAS,CAAC;QACvJ,OAAO,SAAS,CAAC;IAEnB,OAAO,EAAE,QAAQ,EAAE,QAAQ,EAAE,KAAK,EAAE,CAAC;AACvC,CAAC;AAED,SAAS,eAAe,CAAC,OAAe;IACtC,OAAO;QACL,EAAE,EAAE,IAAI,CAAC,WAAW,EAAE;QACtB,OAAO;KACR,CAAC;AACJ,CAAC;AAED,SAAS,oBAAoB,CAAC,OAAgB;IAC5C,MAAM,EAAE,GAAG,IAAI,CAAC,WAAW,EAAE,CAAC;IAC9B,OAAO;QACL,EAAE;QACF,OAAO;QACP,QAAQ,EAAE,+BAA+B,CAAC,GAAG;QAC7C,KAAK,EAAE,CAAC,eAAe,CAAC,EAAE,CAAC,CAAC;KAC7B,CAAC;AACJ,CAAC;AAED,SAAS,aAAa,CAAC,SAAyC,EAAE,IAAc;IAC9E,IAAI,IAAI,CAAC,MAAM,KAAK,CAAC;QACnB,OAAO,SAAS,CAAC;IAEnB,MAAM,CAAC,aAAa,EAAE,GAAG,IAAI,CAAC,GAAG,IAAI,CAAC;IACtC,MAAM,WAAW,GAAG,SAAS,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,EAAE,KAAK,aAAa,CAAC,CAAC;IAC9E,IAAI,CAAC,WAAW,IAAI,CAAC,gCAAgC,CAAC,WAAW,CAAC;QAChE,OAAO,SAAS,CAAC;IAEnB,OAAO,aAAa,CAAC,WAAW,EAAE,IAAI,CAAC,CAAC;AAC1C,CAAC;AAED,SAAS,QAAQ,CAAC,SAAyC,EAAE,IAAc;IACzE,IAAI,IAAI,CAAC,MAAM,KAAK,CAAC;QACnB,OAAO,SAAS,CAAC;IAEnB,MAAM,CAAC,aAAa,EAAE,GAAG,IAAI,CAAC,GAAG,IAAI,CAAC;IACtC,MAAM,WAAW,GAAG,SAAS,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,EAAE,KAAK,aAAa,CAAC,CAAC;IAC9E,IAAI,CAAC,WAAW;QACd,OAAO,SAAS,CAAC;IAEnB,IAAI,gCAAgC,CAAC,WAAW,CAAC;QAC/C,OAAO,QAAQ,CAAC,WAAW,EAAE,IAAI,CAAC,CAAC;IAErC,OAAO,WAAW,CAAC;AACrB,CAAC;AAED,SAAS,gBAAgB,CAAC,MAAsB,EAAE,QAAgB;IAChE,MAAM,EAAE,GAAG,IAAI,CAAC,WAAW,EAAE,CAAC;IAC9B,IAAI,yBAAyB,CAAC,MAAM,CAAC;QACnC,OAAO;YACL,EAAE;YACF,OAAO,EAAE,QAAQ;YACjB,QAAQ,EAAE,MAAM,CAAC,QAAQ;YACzB,KAAK,EAAE,MAAM,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,gBAAgB,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC;SAC9D,CAAC;IACJ,OAAO,WAAW,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC;AACjC,CAAC;AAED,SAAS,WAAW,CAAC,MAA0B,EAAE,QAAgB;IAC/D,OAAO;QACL,EAAE,EAAE,IAAI,CAAC,WAAW,EAAE;QACtB,OAAO,EAAE,QAAQ;QACjB,QAAQ,EAAE,MAAM,CAAC,QAAQ;QACzB,QAAQ,EAAE,MAAM,CAAC,QAAQ;QACzB,KAAK,EAAE,MAAM,CAAC,KAAK;KACpB,CAAC;AACJ,CAAC;AAED,SAAS,oBAAoB,CAAC,MAAsB;IAClD,MAAM,EAAE,GAAG,IAAI,CAAC,WAAW,EAAE,CAAC;IAC9B,IAAI,yBAAyB,CAAC,MAAM,CAAC,EAAE;QACrC,OAAO;YACL,SAAS,EAAE;gBACT,EAAE;gBACF,QAAQ,EAAE,MAAM,CAAC,QAAQ;gBACzB,KAAK,EAAE,MAAM,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,gBAAgB,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC;aAC9D;SACF,CAAC;KACH;IACD,OAAO;QACL,SAAS,EAAE;YACT,EAAE;YACF,QAAQ,EAAE,+BAA+B,CAAC,GAAG;YAC7C,KAAK,EAAE,CAAC,WAAW,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC;SACjC;KACF,CAAC;AACJ,CAAC","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\n/** @packageDocumentation\r\n * @module PropertyFilterBuilder\r\n */\r\n\r\nimport { Draft, produce } from \"immer\";\r\nimport * as React from \"react\";\r\nimport { PropertyDescription, PropertyValue, PropertyValueFormat } from \"@itwin/appui-abstract\";\r\nimport { Guid } from \"@itwin/core-bentley\";\r\nimport { isUnaryPropertyFilterOperator, PropertyFilterRuleGroupOperator, PropertyFilterRuleOperator } from \"./Operators\";\r\nimport { isPropertyFilterRuleGroup, PropertyFilter, PropertyFilterRule } from \"./Types\";\r\n\r\n/**\r\n * Data structure that describes [[PropertyFilterBuilder]] component state.\r\n * @internal\r\n */\r\nexport interface PropertyFilterBuilderState {\r\n  /** Root group of rules in [[PropertyFilterBuilder]] component. */\r\n  rootGroup: PropertyFilterBuilderRuleGroup;\r\n}\r\n\r\n/**\r\n * Type that describes [[PropertyFilterBuilder]] component group item.\r\n * @internal\r\n */\r\nexport type PropertyFilterBuilderRuleGroupItem = PropertyFilterBuilderRuleGroup | PropertyFilterBuilderRule;\r\n\r\n/**\r\n * Data structure that describes [[PropertyFilterBuilder]] component rule group.\r\n * @internal\r\n */\r\nexport interface PropertyFilterBuilderRuleGroup {\r\n  /** Id of this rule group. */\r\n  id: string;\r\n  /** Id of rule group that this group is nested in. */\r\n  groupId?: string;\r\n  /** Operator that should join items in this group. */\r\n  operator: PropertyFilterRuleGroupOperator;\r\n  /** Items in this group. */\r\n  items: PropertyFilterBuilderRuleGroupItem[];\r\n}\r\n\r\n/**\r\n * Data structure that describes [[PropertyFilterBuilder]] component single rule.\r\n * @internal\r\n */\r\nexport interface PropertyFilterBuilderRule {\r\n  /** Id of this rule. */\r\n  id: string;\r\n  /** Id of rule group that this rule is nested in. */\r\n  groupId: string;\r\n  /** Property used in this rule. */\r\n  property?: PropertyDescription;\r\n  /** Operator that should be used to compare property value. */\r\n  operator?: PropertyFilterRuleOperator;\r\n  /** Value that property should be compared to. */\r\n  value?: PropertyValue;\r\n}\r\n\r\n/**\r\n * Actions for controlling [[PropertyFilterBuilder]] component state.\r\n * @internal\r\n */\r\nexport class PropertyFilterBuilderActions {\r\n  constructor(private setState: (setter: (prevState: PropertyFilterBuilderState) => PropertyFilterBuilderState) => void) { }\r\n\r\n  private updateState(updater: (state: Draft<PropertyFilterBuilderState>) => void) {\r\n    this.setState(produce(updater));\r\n  }\r\n\r\n  /** Adds new rule or group of rules to the group specified by path. */\r\n  public addItem(path: string[], itemType: \"RULE_GROUP\" | \"RULE\") {\r\n    this.updateState((state) => {\r\n      const parentGroup = findRuleGroup(state.rootGroup, path);\r\n      if (!parentGroup)\r\n        return;\r\n      const item = itemType === \"RULE_GROUP\" ? createEmptyRuleGroup(parentGroup.id) : createEmptyRule(parentGroup.id);\r\n      parentGroup.items.push(item);\r\n    });\r\n  }\r\n\r\n  /** Removes item specified by path. */\r\n  public removeItem(path: string[]) {\r\n    function removeItemFromGroup(state: Draft<PropertyFilterBuilderState>, pathToItem: string[]) {\r\n      const pathToParent = pathToItem.slice(0, -1);\r\n      const parentGroup = findRuleGroup(state.rootGroup, pathToParent);\r\n      if (!parentGroup)\r\n        return;\r\n      const itemId = pathToItem[pathToItem.length - 1];\r\n      const itemIndex = parentGroup.items.findIndex((item) => item.id === itemId);\r\n      if (itemIndex === -1)\r\n        return;\r\n      parentGroup.items.splice(itemIndex, 1);\r\n      if (parentGroup.items.length === 0)\r\n        removeItemFromGroup(state, pathToParent);\r\n    }\r\n\r\n    this.updateState((state) => {\r\n      removeItemFromGroup(state, path);\r\n    });\r\n  }\r\n\r\n  /** Sets operator of rule group specified by the path. */\r\n  public setRuleGroupOperator(path: string[], operator: PropertyFilterRuleGroupOperator) {\r\n    this.updateState((state) => {\r\n      const group = findRuleGroup(state.rootGroup, path);\r\n      if (!group)\r\n        return;\r\n      group.operator = operator;\r\n    });\r\n  }\r\n\r\n  /** Sets property of rule specified by the path. */\r\n  public setRuleProperty(path: string[], property?: PropertyDescription) {\r\n    this.updateState((state) => {\r\n      const rule = findRule(state.rootGroup, path);\r\n      if (!rule)\r\n        return;\r\n      rule.property = property;\r\n      rule.value = undefined;\r\n    });\r\n  }\r\n\r\n  /** Sets operator of rule specified by the path. */\r\n  public setRuleOperator(path: string[], operator: PropertyFilterRuleOperator) {\r\n    this.updateState((state) => {\r\n      const rule = findRule(state.rootGroup, path);\r\n      if (!rule)\r\n        return;\r\n      if (isUnaryPropertyFilterOperator(operator))\r\n        rule.value = undefined;\r\n      rule.operator = operator;\r\n    });\r\n  }\r\n\r\n  /** Sets value of rule specified by the path. */\r\n  public setRuleValue(path: string[], value: PropertyValue) {\r\n    this.updateState((state) => {\r\n      const rule = findRule(state.rootGroup, path);\r\n      if (!rule)\r\n        return;\r\n      rule.value = value;\r\n    });\r\n  }\r\n}\r\n\r\n/**\r\n * Function to check if supplied [[PropertyFilterBuilderRuleGroupItem]] is [[PropertyFilterBuilderRuleGroup]].\r\n * @internal\r\n */\r\nexport function isPropertyFilterBuilderRuleGroup(item: PropertyFilterBuilderRuleGroupItem): item is PropertyFilterBuilderRuleGroup {\r\n  return (item as any).items !== undefined;\r\n}\r\n\r\n/**\r\n * Custom hook that creates state for [[PropertyFilterBuilder]] component. It creates empty state or initializes\r\n * state from supplied initial filter.\r\n * @internal\r\n */\r\nexport function usePropertyFilterBuilderState(initialFilter?: PropertyFilter) {\r\n  const [state, setState] = React.useState<PropertyFilterBuilderState>(\r\n    () => initialFilter ? convertFilterToState(initialFilter) : { rootGroup: createEmptyRuleGroup() }\r\n  );\r\n  const [actions] = React.useState(() => new PropertyFilterBuilderActions(setState));\r\n\r\n  return { state, actions };\r\n}\r\n\r\n/** @internal */\r\nexport function buildPropertyFilter(groupItem: PropertyFilterBuilderRuleGroupItem): PropertyFilter | undefined {\r\n  if (isPropertyFilterBuilderRuleGroup(groupItem))\r\n    return buildPropertyFilterFromRuleGroup(groupItem);\r\n  return buildPropertyFilterFromRule(groupItem);\r\n}\r\n\r\nfunction buildPropertyFilterFromRuleGroup(rootGroup: PropertyFilterBuilderRuleGroup): PropertyFilter | undefined {\r\n  if (rootGroup.items.length === 0)\r\n    return undefined;\r\n\r\n  const rules = new Array<PropertyFilter>();\r\n  for (const item of rootGroup.items) {\r\n    const rule = buildPropertyFilter(item);\r\n    if (!rule)\r\n      return undefined;\r\n    rules.push(rule);\r\n  }\r\n\r\n  if (rules.length === 1)\r\n    return rules[0];\r\n\r\n  return {\r\n    operator: rootGroup.operator,\r\n    rules,\r\n  };\r\n}\r\n\r\nfunction buildPropertyFilterFromRule(rule: PropertyFilterBuilderRule): PropertyFilter | undefined {\r\n  const { property, operator, value } = rule;\r\n  if (!property || operator === undefined)\r\n    return undefined;\r\n\r\n  if (!isUnaryPropertyFilterOperator(operator) && (value === undefined || value.valueFormat !== PropertyValueFormat.Primitive || value.value === undefined))\r\n    return undefined;\r\n\r\n  return { property, operator, value };\r\n}\r\n\r\nfunction createEmptyRule(groupId: string): PropertyFilterBuilderRule {\r\n  return {\r\n    id: Guid.createValue(),\r\n    groupId,\r\n  };\r\n}\r\n\r\nfunction createEmptyRuleGroup(groupId?: string): PropertyFilterBuilderRuleGroup {\r\n  const id = Guid.createValue();\r\n  return {\r\n    id,\r\n    groupId,\r\n    operator: PropertyFilterRuleGroupOperator.And,\r\n    items: [createEmptyRule(id)],\r\n  };\r\n}\r\n\r\nfunction findRuleGroup(rootGroup: PropertyFilterBuilderRuleGroup, path: string[]): PropertyFilterBuilderRuleGroup | undefined {\r\n  if (path.length === 0)\r\n    return rootGroup;\r\n\r\n  const [currentItemId, ...rest] = path;\r\n  const currentItem = rootGroup.items.find((item) => item.id === currentItemId);\r\n  if (!currentItem || !isPropertyFilterBuilderRuleGroup(currentItem))\r\n    return undefined;\r\n\r\n  return findRuleGroup(currentItem, rest);\r\n}\r\n\r\nfunction findRule(rootGroup: PropertyFilterBuilderRuleGroup, path: string[]): PropertyFilterBuilderRule | undefined {\r\n  if (path.length === 0)\r\n    return undefined;\r\n\r\n  const [currentItemId, ...rest] = path;\r\n  const currentItem = rootGroup.items.find((item) => item.id === currentItemId);\r\n  if (!currentItem)\r\n    return undefined;\r\n\r\n  if (isPropertyFilterBuilderRuleGroup(currentItem))\r\n    return findRule(currentItem, rest);\r\n\r\n  return currentItem;\r\n}\r\n\r\nfunction getRuleGroupItem(filter: PropertyFilter, parentId: string): PropertyFilterBuilderRuleGroupItem {\r\n  const id = Guid.createValue();\r\n  if (isPropertyFilterRuleGroup(filter))\r\n    return {\r\n      id,\r\n      groupId: parentId,\r\n      operator: filter.operator,\r\n      items: filter.rules.map((rule) => getRuleGroupItem(rule, id)),\r\n    };\r\n  return getRuleItem(filter, id);\r\n}\r\n\r\nfunction getRuleItem(filter: PropertyFilterRule, parentId: string) {\r\n  return {\r\n    id: Guid.createValue(),\r\n    groupId: parentId,\r\n    property: filter.property,\r\n    operator: filter.operator,\r\n    value: filter.value,\r\n  };\r\n}\r\n\r\nfunction convertFilterToState(filter: PropertyFilter): PropertyFilterBuilderState {\r\n  const id = Guid.createValue();\r\n  if (isPropertyFilterRuleGroup(filter)) {\r\n    return {\r\n      rootGroup: {\r\n        id,\r\n        operator: filter.operator,\r\n        items: filter.rules.map((rule) => getRuleGroupItem(rule, id)),\r\n      },\r\n    };\r\n  }\r\n  return {\r\n    rootGroup: {\r\n      id,\r\n      operator: PropertyFilterRuleGroupOperator.And,\r\n      items: [getRuleItem(filter, id)],\r\n    },\r\n  };\r\n}\r\n"]}

package/lib/esm/components-react/filter-builder/Operators.d.ts

@@ -1,10 +1,19 @@
+/** @packageDocumentation
+ * @module PropertyFilterBuilder
+ */
 import { PropertyDescription } from "@itwin/appui-abstract";
-/** @alpha */
+/**
+ * Logical operator for joining rules.
+ * @beta
+ */
 export declare enum PropertyFilterRuleGroupOperator {
     And = 0,
     Or = 1
 }
-/** @alpha */
+/**
+ * Operators for comparing property value in rule.
+ * @beta
+ */
 export declare enum PropertyFilterRuleOperator {
     IsTrue = 0,
     IsFalse = 1,
@@ -18,10 +27,19 @@ export declare enum PropertyFilterRuleOperator {
     IsNull = 9,
     IsNotNull = 10
 }
-/** @alpha */
+/**
+ * Function that returns set of available operator based on property type.
+ * @beta
+ */
 export declare function getPropertyFilterOperators(property: PropertyDescription): PropertyFilterRuleOperator[];
-/** @alpha */
+/**
+ * Function that returns display label for rule operator.
+ * @beta
+ */
 export declare function getPropertyFilterOperatorLabel(operator: PropertyFilterRuleOperator): string;
-/** @alpha */
+/**
+ * Function that checks if supplied operator is unary.
+ * @beta
+ */
 export declare function isUnaryPropertyFilterOperator(operator: PropertyFilterRuleOperator): boolean;
 //# sourceMappingURL=Operators.d.ts.map

package/lib/esm/components-react/filter-builder/Operators.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"Operators.d.ts","sourceRoot":"","sources":["../../../../src/components-react/filter-builder/Operators.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,mBAAmB,EAAqB,MAAM,uBAAuB,CAAC;AAG/E,aAAa;AACb,oBAAY,+BAA+B;IACzC,GAAG,IAAA;IACH,EAAE,IAAA;CACH;AAED,aAAa;AACb,oBAAY,0BAA0B;IACpC,MAAM,IAAA;IACN,OAAO,IAAA;IAEP,OAAO,IAAA;IACP,UAAU,IAAA;IAEV,OAAO,IAAA;IACP,cAAc,IAAA;IACd,IAAI,IAAA;IACJ,WAAW,IAAA;IAEX,IAAI,IAAA;IAEJ,MAAM,IAAA;IACN,SAAS,KAAA;CACV;AAED,aAAa;AACb,wBAAgB,0BAA0B,CAAC,QAAQ,EAAE,mBAAmB,gCA2CvE;AAGD,aAAa;AACb,wBAAgB,8BAA8B,CAAC,QAAQ,EAAE,0BAA0B,UAyBlF;AAED,aAAa;AACb,wBAAgB,6BAA6B,CAAC,QAAQ,EAAE,0BAA0B,WASjF"}
+{"version":3,"file":"Operators.d.ts","sourceRoot":"","sources":["../../../../src/components-react/filter-builder/Operators.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,mBAAmB,EAAqB,MAAM,uBAAuB,CAAC;AAG/E;;;GAGG;AACH,oBAAY,+BAA+B;IACzC,GAAG,IAAA;IACH,EAAE,IAAA;CACH;AAED;;;GAGG;AACH,oBAAY,0BAA0B;IACpC,MAAM,IAAA;IACN,OAAO,IAAA;IAEP,OAAO,IAAA;IACP,UAAU,IAAA;IAEV,OAAO,IAAA;IACP,cAAc,IAAA;IACd,IAAI,IAAA;IACJ,WAAW,IAAA;IAEX,IAAI,IAAA;IAEJ,MAAM,IAAA;IACN,SAAS,KAAA;CACV;AAED;;;GAGG;AACH,wBAAgB,0BAA0B,CAAC,QAAQ,EAAE,mBAAmB,gCA2CvE;AAGD;;;GAGG;AACH,wBAAgB,8BAA8B,CAAC,QAAQ,EAAE,0BAA0B,UAyBlF;AAED;;;GAGG;AACH,wBAAgB,6BAA6B,CAAC,QAAQ,EAAE,0BAA0B,WASjF"}

package/lib/esm/components-react/filter-builder/Operators.js

@@ -2,15 +2,24 @@
 * Copyright (c) Bentley Systems, Incorporated. All rights reserved.
 * See LICENSE.md in the project root for license terms and full copyright notice.
 *--------------------------------------------------------------------------------------------*/
+/** @packageDocumentation
+ * @module PropertyFilterBuilder
+ */
 import { StandardTypeNames } from "@itwin/appui-abstract";
 import { UiComponents } from "../UiComponents";
-/** @alpha */
+/**
+ * Logical operator for joining rules.
+ * @beta
+ */
 export var PropertyFilterRuleGroupOperator;
 (function (PropertyFilterRuleGroupOperator) {
     PropertyFilterRuleGroupOperator[PropertyFilterRuleGroupOperator["And"] = 0] = "And";
     PropertyFilterRuleGroupOperator[PropertyFilterRuleGroupOperator["Or"] = 1] = "Or";
 })(PropertyFilterRuleGroupOperator || (PropertyFilterRuleGroupOperator = {}));
-/** @alpha */
+/**
+ * Operators for comparing property value in rule.
+ * @beta
+ */
 export var PropertyFilterRuleOperator;
 (function (PropertyFilterRuleOperator) {
     PropertyFilterRuleOperator[PropertyFilterRuleOperator["IsTrue"] = 0] = "IsTrue";
@@ -25,7 +34,10 @@ export var PropertyFilterRuleOperator;
     PropertyFilterRuleOperator[PropertyFilterRuleOperator["IsNull"] = 9] = "IsNull";
     PropertyFilterRuleOperator[PropertyFilterRuleOperator["IsNotNull"] = 10] = "IsNotNull";
 })(PropertyFilterRuleOperator || (PropertyFilterRuleOperator = {}));
-/** @alpha */
+/**
+ * Function that returns set of available operator based on property type.
+ * @beta
+ */
 export function getPropertyFilterOperators(property) {
     const typename = property.typename;
     if (typename === StandardTypeNames.Bool || typename === StandardTypeNames.Boolean) {
@@ -66,7 +78,10 @@ export function getPropertyFilterOperators(property) {
     return operators;
 }
 /* istanbul ignore next */
-/** @alpha */
+/**
+ * Function that returns display label for rule operator.
+ * @beta
+ */
 export function getPropertyFilterOperatorLabel(operator) {
     switch (operator) {
         case PropertyFilterRuleOperator.IsTrue:
@@ -93,7 +108,10 @@ export function getPropertyFilterOperatorLabel(operator) {
             return UiComponents.translate("filterBuilder.operators.isNotNull");
     }
 }
-/** @alpha */
+/**
+ * Function that checks if supplied operator is unary.
+ * @beta
+ */
 export function isUnaryPropertyFilterOperator(operator) {
     switch (operator) {
         case PropertyFilterRuleOperator.IsTrue:

package/lib/esm/components-react/filter-builder/Operators.js.map

@@ -1 +1 @@
-{"version":3,"file":"Operators.js","sourceRoot":"","sources":["../../../../src/components-react/filter-builder/Operators.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F,OAAO,EAAuB,iBAAiB,EAAE,MAAM,uBAAuB,CAAC;AAC/E,OAAO,EAAE,YAAY,EAAE,MAAM,iBAAiB,CAAC;AAE/C,aAAa;AACb,MAAM,CAAN,IAAY,+BAGX;AAHD,WAAY,+BAA+B;IACzC,mFAAG,CAAA;IACH,iFAAE,CAAA;AACJ,CAAC,EAHW,+BAA+B,KAA/B,+BAA+B,QAG1C;AAED,aAAa;AACb,MAAM,CAAN,IAAY,0BAgBX;AAhBD,WAAY,0BAA0B;IACpC,+EAAM,CAAA;IACN,iFAAO,CAAA;IAEP,iFAAO,CAAA;IACP,uFAAU,CAAA;IAEV,iFAAO,CAAA;IACP,+FAAc,CAAA;IACd,2EAAI,CAAA;IACJ,yFAAW,CAAA;IAEX,2EAAI,CAAA;IAEJ,+EAAM,CAAA;IACN,sFAAS,CAAA;AACX,CAAC,EAhBW,0BAA0B,KAA1B,0BAA0B,QAgBrC;AAED,aAAa;AACb,MAAM,UAAU,0BAA0B,CAAC,QAA6B;IACtE,MAAM,QAAQ,GAAG,QAAQ,CAAC,QAAQ,CAAC;IAEnC,IAAI,QAAQ,KAAK,iBAAiB,CAAC,IAAI,IAAI,QAAQ,KAAK,iBAAiB,CAAC,OAAO,EAAE;QACjF,OAAO;YACL,0BAA0B,CAAC,MAAM;YACjC,0BAA0B,CAAC,OAAO;SACnC,CAAC;KACH;IAED,MAAM,SAAS,GAAG;QAChB,0BAA0B,CAAC,OAAO;QAClC,0BAA0B,CAAC,UAAU;QACrC,0BAA0B,CAAC,MAAM;QACjC,0BAA0B,CAAC,SAAS;KACrC,CAAC;IAEF,IAAI,QAAQ,KAAK,iBAAiB,CAAC,MAAM;WACpC,QAAQ,KAAK,iBAAiB,CAAC,GAAG;WAClC,QAAQ,KAAK,iBAAiB,CAAC,OAAO;WACtC,QAAQ,KAAK,iBAAiB,CAAC,MAAM;WACrC,QAAQ,KAAK,iBAAiB,CAAC,KAAK;WACpC,QAAQ,KAAK,iBAAiB,CAAC,GAAG;WAClC,QAAQ,KAAK,iBAAiB,CAAC,WAAW;WAC1C,QAAQ,KAAK,iBAAiB,CAAC,SAAS;WACxC,QAAQ,KAAK,iBAAiB,CAAC,QAAQ,EAAE;QAC5C,OAAO;YACL,GAAG,SAAS;YACZ,0BAA0B,CAAC,OAAO;YAClC,0BAA0B,CAAC,cAAc;YACzC,0BAA0B,CAAC,IAAI;YAC/B,0BAA0B,CAAC,WAAW;SACvC,CAAC;KACH;IAED,IAAI,QAAQ,KAAK,iBAAiB,CAAC,MAAM,IAAI,QAAQ,KAAK,iBAAiB,CAAC,IAAI,EAAE;QAChF,OAAO;YACL,GAAG,SAAS;YACZ,0BAA0B,CAAC,IAAI;SAChC,CAAC;KACH;IAED,OAAO,SAAS,CAAC;AACnB,CAAC;AAED,0BAA0B;AAC1B,aAAa;AACb,MAAM,UAAU,8BAA8B,CAAC,QAAoC;IACjF,QAAO,QAAQ,EAAE;QACf,KAAK,0BAA0B,CAAC,MAAM;YACpC,OAAO,YAAY,CAAC,SAAS,CAAC,gCAAgC,CAAC,CAAC;QAClE,KAAK,0BAA0B,CAAC,OAAO;YACrC,OAAO,YAAY,CAAC,SAAS,CAAC,iCAAiC,CAAC,CAAC;QACnE,KAAK,0BAA0B,CAAC,OAAO;YACrC,OAAO,YAAY,CAAC,SAAS,CAAC,+BAA+B,CAAC,CAAC;QACjE,KAAK,0BAA0B,CAAC,UAAU;YACxC,OAAO,YAAY,CAAC,SAAS,CAAC,kCAAkC,CAAC,CAAC;QACpE,KAAK,0BAA0B,CAAC,OAAO;YACrC,OAAO,GAAG,CAAC;QACb,KAAK,0BAA0B,CAAC,cAAc;YAC5C,OAAO,IAAI,CAAC;QACd,KAAK,0BAA0B,CAAC,IAAI;YAClC,OAAO,GAAG,CAAC;QACb,KAAK,0BAA0B,CAAC,WAAW;YACzC,OAAO,IAAI,CAAC;QACd,KAAK,0BAA0B,CAAC,IAAI;YAClC,OAAO,YAAY,CAAC,SAAS,CAAC,kCAAkC,CAAC,CAAC;QACpE,KAAK,0BAA0B,CAAC,MAAM;YACpC,OAAO,YAAY,CAAC,SAAS,CAAC,gCAAgC,CAAC,CAAC;QAClE,KAAK,0BAA0B,CAAC,SAAS;YACvC,OAAO,YAAY,CAAC,SAAS,CAAC,mCAAmC,CAAC,CAAC;KACtE;AACH,CAAC;AAED,aAAa;AACb,MAAM,UAAU,6BAA6B,CAAC,QAAoC;IAChF,QAAQ,QAAQ,EAAE;QAChB,KAAK,0BAA0B,CAAC,MAAM,CAAC;QACvC,KAAK,0BAA0B,CAAC,OAAO,CAAC;QACxC,KAAK,0BAA0B,CAAC,MAAM,CAAC;QACvC,KAAK,0BAA0B,CAAC,SAAS;YACvC,OAAO,IAAI,CAAC;KACf;IACD,OAAO,KAAK,CAAC;AACf,CAAC","sourcesContent":["/*---------------------------------------------------------------------------------------------\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n* See LICENSE.md in the project root for license terms and full copyright notice.\n*--------------------------------------------------------------------------------------------*/\nimport { PropertyDescription, StandardTypeNames } from \"@itwin/appui-abstract\";\nimport { UiComponents } from \"../UiComponents\";\n\n/** @alpha */\nexport enum PropertyFilterRuleGroupOperator {\n  And,\n  Or,\n}\n\n/** @alpha */\nexport enum PropertyFilterRuleOperator {\n  IsTrue,\n  IsFalse,\n\n  IsEqual,\n  IsNotEqual,\n\n  Greater,\n  GreaterOrEqual,\n  Less,\n  LessOrEqual,\n\n  Like,\n\n  IsNull,\n  IsNotNull,\n}\n\n/** @alpha */\nexport function getPropertyFilterOperators(property: PropertyDescription) {\n  const typename = property.typename;\n\n  if (typename === StandardTypeNames.Bool || typename === StandardTypeNames.Boolean) {\n    return [\n      PropertyFilterRuleOperator.IsTrue,\n      PropertyFilterRuleOperator.IsFalse,\n    ];\n  }\n\n  const operators = [\n    PropertyFilterRuleOperator.IsEqual,\n    PropertyFilterRuleOperator.IsNotEqual,\n    PropertyFilterRuleOperator.IsNull,\n    PropertyFilterRuleOperator.IsNotNull,\n  ];\n\n  if (typename === StandardTypeNames.Number\n    || typename === StandardTypeNames.Int\n    || typename === StandardTypeNames.Integer\n    || typename === StandardTypeNames.Double\n    || typename === StandardTypeNames.Float\n    || typename === StandardTypeNames.Hex\n    || typename === StandardTypeNames.Hexadecimal\n    || typename === StandardTypeNames.ShortDate\n    || typename === StandardTypeNames.DateTime) {\n    return [\n      ...operators,\n      PropertyFilterRuleOperator.Greater,\n      PropertyFilterRuleOperator.GreaterOrEqual,\n      PropertyFilterRuleOperator.Less,\n      PropertyFilterRuleOperator.LessOrEqual,\n    ];\n  }\n\n  if (typename === StandardTypeNames.String || typename === StandardTypeNames.Text) {\n    return [\n      ...operators,\n      PropertyFilterRuleOperator.Like,\n    ];\n  }\n\n  return operators;\n}\n\n/* istanbul ignore next */\n/** @alpha */\nexport function getPropertyFilterOperatorLabel(operator: PropertyFilterRuleOperator) {\n  switch(operator) {\n    case PropertyFilterRuleOperator.IsTrue:\n      return UiComponents.translate(\"filterBuilder.operators.isTrue\");\n    case PropertyFilterRuleOperator.IsFalse:\n      return UiComponents.translate(\"filterBuilder.operators.isFalse\");\n    case PropertyFilterRuleOperator.IsEqual:\n      return UiComponents.translate(\"filterBuilder.operators.equal\");\n    case PropertyFilterRuleOperator.IsNotEqual:\n      return UiComponents.translate(\"filterBuilder.operators.notEqual\");\n    case PropertyFilterRuleOperator.Greater:\n      return \">\";\n    case PropertyFilterRuleOperator.GreaterOrEqual:\n      return \">=\";\n    case PropertyFilterRuleOperator.Less:\n      return \"<\";\n    case PropertyFilterRuleOperator.LessOrEqual:\n      return \"<=\";\n    case PropertyFilterRuleOperator.Like:\n      return UiComponents.translate(\"filterBuilder.operators.contains\");\n    case PropertyFilterRuleOperator.IsNull:\n      return UiComponents.translate(\"filterBuilder.operators.isNull\");\n    case PropertyFilterRuleOperator.IsNotNull:\n      return UiComponents.translate(\"filterBuilder.operators.isNotNull\");\n  }\n}\n\n/** @alpha */\nexport function isUnaryPropertyFilterOperator(operator: PropertyFilterRuleOperator) {\n  switch (operator) {\n    case PropertyFilterRuleOperator.IsTrue:\n    case PropertyFilterRuleOperator.IsFalse:\n    case PropertyFilterRuleOperator.IsNull:\n    case PropertyFilterRuleOperator.IsNotNull:\n      return true;\n  }\n  return false;\n}\n"]}
+{"version":3,"file":"Operators.js","sourceRoot":"","sources":["../../../../src/components-react/filter-builder/Operators.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAEH,OAAO,EAAuB,iBAAiB,EAAE,MAAM,uBAAuB,CAAC;AAC/E,OAAO,EAAE,YAAY,EAAE,MAAM,iBAAiB,CAAC;AAE/C;;;GAGG;AACH,MAAM,CAAN,IAAY,+BAGX;AAHD,WAAY,+BAA+B;IACzC,mFAAG,CAAA;IACH,iFAAE,CAAA;AACJ,CAAC,EAHW,+BAA+B,KAA/B,+BAA+B,QAG1C;AAED;;;GAGG;AACH,MAAM,CAAN,IAAY,0BAgBX;AAhBD,WAAY,0BAA0B;IACpC,+EAAM,CAAA;IACN,iFAAO,CAAA;IAEP,iFAAO,CAAA;IACP,uFAAU,CAAA;IAEV,iFAAO,CAAA;IACP,+FAAc,CAAA;IACd,2EAAI,CAAA;IACJ,yFAAW,CAAA;IAEX,2EAAI,CAAA;IAEJ,+EAAM,CAAA;IACN,sFAAS,CAAA;AACX,CAAC,EAhBW,0BAA0B,KAA1B,0BAA0B,QAgBrC;AAED;;;GAGG;AACH,MAAM,UAAU,0BAA0B,CAAC,QAA6B;IACtE,MAAM,QAAQ,GAAG,QAAQ,CAAC,QAAQ,CAAC;IAEnC,IAAI,QAAQ,KAAK,iBAAiB,CAAC,IAAI,IAAI,QAAQ,KAAK,iBAAiB,CAAC,OAAO,EAAE;QACjF,OAAO;YACL,0BAA0B,CAAC,MAAM;YACjC,0BAA0B,CAAC,OAAO;SACnC,CAAC;KACH;IAED,MAAM,SAAS,GAAG;QAChB,0BAA0B,CAAC,OAAO;QAClC,0BAA0B,CAAC,UAAU;QACrC,0BAA0B,CAAC,MAAM;QACjC,0BAA0B,CAAC,SAAS;KACrC,CAAC;IAEF,IAAI,QAAQ,KAAK,iBAAiB,CAAC,MAAM;WACpC,QAAQ,KAAK,iBAAiB,CAAC,GAAG;WAClC,QAAQ,KAAK,iBAAiB,CAAC,OAAO;WACtC,QAAQ,KAAK,iBAAiB,CAAC,MAAM;WACrC,QAAQ,KAAK,iBAAiB,CAAC,KAAK;WACpC,QAAQ,KAAK,iBAAiB,CAAC,GAAG;WAClC,QAAQ,KAAK,iBAAiB,CAAC,WAAW;WAC1C,QAAQ,KAAK,iBAAiB,CAAC,SAAS;WACxC,QAAQ,KAAK,iBAAiB,CAAC,QAAQ,EAAE;QAC5C,OAAO;YACL,GAAG,SAAS;YACZ,0BAA0B,CAAC,OAAO;YAClC,0BAA0B,CAAC,cAAc;YACzC,0BAA0B,CAAC,IAAI;YAC/B,0BAA0B,CAAC,WAAW;SACvC,CAAC;KACH;IAED,IAAI,QAAQ,KAAK,iBAAiB,CAAC,MAAM,IAAI,QAAQ,KAAK,iBAAiB,CAAC,IAAI,EAAE;QAChF,OAAO;YACL,GAAG,SAAS;YACZ,0BAA0B,CAAC,IAAI;SAChC,CAAC;KACH;IAED,OAAO,SAAS,CAAC;AACnB,CAAC;AAED,0BAA0B;AAC1B;;;GAGG;AACH,MAAM,UAAU,8BAA8B,CAAC,QAAoC;IACjF,QAAQ,QAAQ,EAAE;QAChB,KAAK,0BAA0B,CAAC,MAAM;YACpC,OAAO,YAAY,CAAC,SAAS,CAAC,gCAAgC,CAAC,CAAC;QAClE,KAAK,0BAA0B,CAAC,OAAO;YACrC,OAAO,YAAY,CAAC,SAAS,CAAC,iCAAiC,CAAC,CAAC;QACnE,KAAK,0BAA0B,CAAC,OAAO;YACrC,OAAO,YAAY,CAAC,SAAS,CAAC,+BAA+B,CAAC,CAAC;QACjE,KAAK,0BAA0B,CAAC,UAAU;YACxC,OAAO,YAAY,CAAC,SAAS,CAAC,kCAAkC,CAAC,CAAC;QACpE,KAAK,0BAA0B,CAAC,OAAO;YACrC,OAAO,GAAG,CAAC;QACb,KAAK,0BAA0B,CAAC,cAAc;YAC5C,OAAO,IAAI,CAAC;QACd,KAAK,0BAA0B,CAAC,IAAI;YAClC,OAAO,GAAG,CAAC;QACb,KAAK,0BAA0B,CAAC,WAAW;YACzC,OAAO,IAAI,CAAC;QACd,KAAK,0BAA0B,CAAC,IAAI;YAClC,OAAO,YAAY,CAAC,SAAS,CAAC,kCAAkC,CAAC,CAAC;QACpE,KAAK,0BAA0B,CAAC,MAAM;YACpC,OAAO,YAAY,CAAC,SAAS,CAAC,gCAAgC,CAAC,CAAC;QAClE,KAAK,0BAA0B,CAAC,SAAS;YACvC,OAAO,YAAY,CAAC,SAAS,CAAC,mCAAmC,CAAC,CAAC;KACtE;AACH,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,6BAA6B,CAAC,QAAoC;IAChF,QAAQ,QAAQ,EAAE;QAChB,KAAK,0BAA0B,CAAC,MAAM,CAAC;QACvC,KAAK,0BAA0B,CAAC,OAAO,CAAC;QACxC,KAAK,0BAA0B,CAAC,MAAM,CAAC;QACvC,KAAK,0BAA0B,CAAC,SAAS;YACvC,OAAO,IAAI,CAAC;KACf;IACD,OAAO,KAAK,CAAC;AACf,CAAC","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\n/** @packageDocumentation\r\n * @module PropertyFilterBuilder\r\n */\r\n\r\nimport { PropertyDescription, StandardTypeNames } from \"@itwin/appui-abstract\";\r\nimport { UiComponents } from \"../UiComponents\";\r\n\r\n/**\r\n * Logical operator for joining rules.\r\n * @beta\r\n */\r\nexport enum PropertyFilterRuleGroupOperator {\r\n  And,\r\n  Or,\r\n}\r\n\r\n/**\r\n * Operators for comparing property value in rule.\r\n * @beta\r\n */\r\nexport enum PropertyFilterRuleOperator {\r\n  IsTrue,\r\n  IsFalse,\r\n\r\n  IsEqual,\r\n  IsNotEqual,\r\n\r\n  Greater,\r\n  GreaterOrEqual,\r\n  Less,\r\n  LessOrEqual,\r\n\r\n  Like,\r\n\r\n  IsNull,\r\n  IsNotNull,\r\n}\r\n\r\n/**\r\n * Function that returns set of available operator based on property type.\r\n * @beta\r\n */\r\nexport function getPropertyFilterOperators(property: PropertyDescription) {\r\n  const typename = property.typename;\r\n\r\n  if (typename === StandardTypeNames.Bool || typename === StandardTypeNames.Boolean) {\r\n    return [\r\n      PropertyFilterRuleOperator.IsTrue,\r\n      PropertyFilterRuleOperator.IsFalse,\r\n    ];\r\n  }\r\n\r\n  const operators = [\r\n    PropertyFilterRuleOperator.IsEqual,\r\n    PropertyFilterRuleOperator.IsNotEqual,\r\n    PropertyFilterRuleOperator.IsNull,\r\n    PropertyFilterRuleOperator.IsNotNull,\r\n  ];\r\n\r\n  if (typename === StandardTypeNames.Number\r\n    || typename === StandardTypeNames.Int\r\n    || typename === StandardTypeNames.Integer\r\n    || typename === StandardTypeNames.Double\r\n    || typename === StandardTypeNames.Float\r\n    || typename === StandardTypeNames.Hex\r\n    || typename === StandardTypeNames.Hexadecimal\r\n    || typename === StandardTypeNames.ShortDate\r\n    || typename === StandardTypeNames.DateTime) {\r\n    return [\r\n      ...operators,\r\n      PropertyFilterRuleOperator.Greater,\r\n      PropertyFilterRuleOperator.GreaterOrEqual,\r\n      PropertyFilterRuleOperator.Less,\r\n      PropertyFilterRuleOperator.LessOrEqual,\r\n    ];\r\n  }\r\n\r\n  if (typename === StandardTypeNames.String || typename === StandardTypeNames.Text) {\r\n    return [\r\n      ...operators,\r\n      PropertyFilterRuleOperator.Like,\r\n    ];\r\n  }\r\n\r\n  return operators;\r\n}\r\n\r\n/* istanbul ignore next */\r\n/**\r\n * Function that returns display label for rule operator.\r\n * @beta\r\n */\r\nexport function getPropertyFilterOperatorLabel(operator: PropertyFilterRuleOperator) {\r\n  switch (operator) {\r\n    case PropertyFilterRuleOperator.IsTrue:\r\n      return UiComponents.translate(\"filterBuilder.operators.isTrue\");\r\n    case PropertyFilterRuleOperator.IsFalse:\r\n      return UiComponents.translate(\"filterBuilder.operators.isFalse\");\r\n    case PropertyFilterRuleOperator.IsEqual:\r\n      return UiComponents.translate(\"filterBuilder.operators.equal\");\r\n    case PropertyFilterRuleOperator.IsNotEqual:\r\n      return UiComponents.translate(\"filterBuilder.operators.notEqual\");\r\n    case PropertyFilterRuleOperator.Greater:\r\n      return \">\";\r\n    case PropertyFilterRuleOperator.GreaterOrEqual:\r\n      return \">=\";\r\n    case PropertyFilterRuleOperator.Less:\r\n      return \"<\";\r\n    case PropertyFilterRuleOperator.LessOrEqual:\r\n      return \"<=\";\r\n    case PropertyFilterRuleOperator.Like:\r\n      return UiComponents.translate(\"filterBuilder.operators.contains\");\r\n    case PropertyFilterRuleOperator.IsNull:\r\n      return UiComponents.translate(\"filterBuilder.operators.isNull\");\r\n    case PropertyFilterRuleOperator.IsNotNull:\r\n      return UiComponents.translate(\"filterBuilder.operators.isNotNull\");\r\n  }\r\n}\r\n\r\n/**\r\n * Function that checks if supplied operator is unary.\r\n * @beta\r\n */\r\nexport function isUnaryPropertyFilterOperator(operator: PropertyFilterRuleOperator) {\r\n  switch (operator) {\r\n    case PropertyFilterRuleOperator.IsTrue:\r\n    case PropertyFilterRuleOperator.IsFalse:\r\n    case PropertyFilterRuleOperator.IsNull:\r\n    case PropertyFilterRuleOperator.IsNotNull:\r\n      return true;\r\n  }\r\n  return false;\r\n}\r\n"]}

package/lib/esm/components-react/filter-builder/Types.d.ts

@@ -1,18 +1,38 @@
+/** @packageDocumentation
+ * @module PropertyFilterBuilder
+ */
 import { PropertyDescription, PropertyValue } from "@itwin/appui-abstract";
 import { PropertyFilterRuleGroupOperator, PropertyFilterRuleOperator } from "./Operators";
-/** @alpha */
-export declare type PropertyFilter = PropertyFilterRule | PropertyFilterRuleGroup;
-/** @alpha */
+/**
+ * Type that describes property filter.
+ * @beta
+ */
+export type PropertyFilter = PropertyFilterRule | PropertyFilterRuleGroup;
+/**
+ * Data structure that describes group of filter rules.
+ * @beta
+ */
 export interface PropertyFilterRuleGroup {
+    /** Operator that should join rules in this group. */
     operator: PropertyFilterRuleGroupOperator;
+    /** Rules in this group. */
     rules: Array<PropertyFilter>;
 }
-/** @alpha */
+/**
+ * Data structure that describes single filter rule.
+ * @beta
+ */
 export interface PropertyFilterRule {
+    /** Property used in this rule. */
     property: PropertyDescription;
+    /** Operator that should be used to compare property value. */
     operator: PropertyFilterRuleOperator;
+    /** Value that property should be compared to. */
     value?: PropertyValue;
 }
-/** @alpha */
+/**
+ * Function that checks if supplied filter is rule group.
+ * @beta
+ */
 export declare function isPropertyFilterRuleGroup(filter: PropertyFilter): filter is PropertyFilterRuleGroup;
 //# sourceMappingURL=Types.d.ts.map

package/lib/esm/components-react/filter-builder/Types.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"Types.d.ts","sourceRoot":"","sources":["../../../../src/components-react/filter-builder/Types.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,mBAAmB,EAAE,aAAa,EAAE,MAAM,uBAAuB,CAAC;AAC3E,OAAO,EAAE,+BAA+B,EAAE,0BAA0B,EAAE,MAAM,aAAa,CAAC;AAE1F,aAAa;AACb,oBAAY,cAAc,GAAG,kBAAkB,GAAG,uBAAuB,CAAC;AAE1E,aAAa;AACb,MAAM,WAAW,uBAAuB;IACtC,QAAQ,EAAE,+BAA+B,CAAC;IAC1C,KAAK,EAAE,KAAK,CAAC,cAAc,CAAC,CAAC;CAC9B;AAED,aAAa;AACb,MAAM,WAAW,kBAAkB;IACjC,QAAQ,EAAE,mBAAmB,CAAC;IAC9B,QAAQ,EAAE,0BAA0B,CAAC;IACrC,KAAK,CAAC,EAAE,aAAa,CAAC;CACvB;AAED,aAAa;AACb,wBAAgB,yBAAyB,CAAC,MAAM,EAAE,cAAc,GAAG,MAAM,IAAI,uBAAuB,CAEnG"}
+{"version":3,"file":"Types.d.ts","sourceRoot":"","sources":["../../../../src/components-react/filter-builder/Types.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,mBAAmB,EAAE,aAAa,EAAE,MAAM,uBAAuB,CAAC;AAC3E,OAAO,EAAE,+BAA+B,EAAE,0BAA0B,EAAE,MAAM,aAAa,CAAC;AAE1F;;;GAGG;AACH,MAAM,MAAM,cAAc,GAAG,kBAAkB,GAAG,uBAAuB,CAAC;AAE1E;;;GAGG;AACH,MAAM,WAAW,uBAAuB;IACtC,qDAAqD;IACrD,QAAQ,EAAE,+BAA+B,CAAC;IAC1C,2BAA2B;IAC3B,KAAK,EAAE,KAAK,CAAC,cAAc,CAAC,CAAC;CAC9B;AAED;;;GAGG;AACH,MAAM,WAAW,kBAAkB;IACjC,kCAAkC;IAClC,QAAQ,EAAE,mBAAmB,CAAC;IAC9B,8DAA8D;IAC9D,QAAQ,EAAE,0BAA0B,CAAC;IACrC,iDAAiD;IACjD,KAAK,CAAC,EAAE,aAAa,CAAC;CACvB;AAED;;;GAGG;AACH,wBAAgB,yBAAyB,CAAC,MAAM,EAAE,cAAc,GAAG,MAAM,IAAI,uBAAuB,CAEnG"}

package/lib/esm/components-react/filter-builder/Types.js

@@ -1,4 +1,14 @@
-/** @alpha */
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+/** @packageDocumentation
+ * @module PropertyFilterBuilder
+ */
+/**
+ * Function that checks if supplied filter is rule group.
+ * @beta
+ */
 export function isPropertyFilterRuleGroup(filter) {
     return filter.rules !== undefined;
 }

package/lib/esm/components-react/filter-builder/Types.js.map

@@ -1 +1 @@
-{"version":3,"file":"Types.js","sourceRoot":"","sources":["../../../../src/components-react/filter-builder/Types.ts"],"names":[],"mappings":"AAuBA,aAAa;AACb,MAAM,UAAU,yBAAyB,CAAC,MAAsB;IAC9D,OAAQ,MAAc,CAAC,KAAK,KAAK,SAAS,CAAC;AAC7C,CAAC","sourcesContent":["/*---------------------------------------------------------------------------------------------\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n* See LICENSE.md in the project root for license terms and full copyright notice.\n*--------------------------------------------------------------------------------------------*/\nimport { PropertyDescription, PropertyValue } from \"@itwin/appui-abstract\";\nimport { PropertyFilterRuleGroupOperator, PropertyFilterRuleOperator } from \"./Operators\";\n\n/** @alpha */\nexport type PropertyFilter = PropertyFilterRule | PropertyFilterRuleGroup;\n\n/** @alpha */\nexport interface PropertyFilterRuleGroup {\n  operator: PropertyFilterRuleGroupOperator;\n  rules: Array<PropertyFilter>;\n}\n\n/** @alpha */\nexport interface PropertyFilterRule {\n  property: PropertyDescription;\n  operator: PropertyFilterRuleOperator;\n  value?: PropertyValue;\n}\n\n/** @alpha */\nexport function isPropertyFilterRuleGroup(filter: PropertyFilter): filter is PropertyFilterRuleGroup {\n  return (filter as any).rules !== undefined;\n}\n"]}
+{"version":3,"file":"Types.js","sourceRoot":"","sources":["../../../../src/components-react/filter-builder/Types.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAmCH;;;GAGG;AACH,MAAM,UAAU,yBAAyB,CAAC,MAAsB;IAC9D,OAAQ,MAAc,CAAC,KAAK,KAAK,SAAS,CAAC;AAC7C,CAAC","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\n/** @packageDocumentation\r\n * @module PropertyFilterBuilder\r\n */\r\n\r\nimport { PropertyDescription, PropertyValue } from \"@itwin/appui-abstract\";\r\nimport { PropertyFilterRuleGroupOperator, PropertyFilterRuleOperator } from \"./Operators\";\r\n\r\n/**\r\n * Type that describes property filter.\r\n * @beta\r\n */\r\nexport type PropertyFilter = PropertyFilterRule | PropertyFilterRuleGroup;\r\n\r\n/**\r\n * Data structure that describes group of filter rules.\r\n * @beta\r\n */\r\nexport interface PropertyFilterRuleGroup {\r\n  /** Operator that should join rules in this group. */\r\n  operator: PropertyFilterRuleGroupOperator;\r\n  /** Rules in this group. */\r\n  rules: Array<PropertyFilter>;\r\n}\r\n\r\n/**\r\n * Data structure that describes single filter rule.\r\n * @beta\r\n */\r\nexport interface PropertyFilterRule {\r\n  /** Property used in this rule. */\r\n  property: PropertyDescription;\r\n  /** Operator that should be used to compare property value. */\r\n  operator: PropertyFilterRuleOperator;\r\n  /** Value that property should be compared to. */\r\n  value?: PropertyValue;\r\n}\r\n\r\n/**\r\n * Function that checks if supplied filter is rule group.\r\n * @beta\r\n */\r\nexport function isPropertyFilterRuleGroup(filter: PropertyFilter): filter is PropertyFilterRuleGroup {\r\n  return (filter as any).rules !== undefined;\r\n}\r\n"]}

package/lib/esm/components-react/filtering/FilteringInput.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"FilteringInput.d.ts","sourceRoot":"","sources":["../../../../src/components-react/filtering/FilteringInput.tsx"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,uBAAuB,CAAC;AAE/B,OAAO,KAAK,KAAK,MAAM,OAAO,CAAC;AAE/B,OAAO,EAAE,WAAW,EAAU,MAAM,mBAAmB,CAAC;AAGxD,OAAO,EAAkB,mBAAmB,EAAE,MAAM,kBAAkB,CAAC;AAEvE;;GAEG;AACH,UAAU,mBAAmB;IAC3B,6CAA6C;IAC7C,UAAU,EAAE,MAAM,CAAC;IACnB;;;MAGE;IACF,aAAa,EAAE,OAAO,CAAC;IAEvB,iBAAiB,EAAE,MAAM,CAAC;CAC3B;AAED;;;GAGG;AACH,MAAM,WAAW,mBAAoB,SAAQ,WAAW;IACtD,6BAA6B;IAC7B,aAAa,EAAE,CAAC,UAAU,EAAE,MAAM,KAAK,IAAI,CAAC;IAC5C,oDAAoD;IACpD,cAAc,EAAE,MAAM,IAAI,CAAC;IAC3B,qDAAqD;IACrD,aAAa,EAAE,MAAM,IAAI,CAAC;IAC1B;;OAEG;IACH,MAAM,EAAE,oBAAoB,CAAC;IAC7B;;;;OAIG;IACH,mBAAmB,CAAC,EAAE,mBAAmB,CAAC;IAC1C,sEAAsE;IACtE,SAAS,CAAC,EAAE,OAAO,CAAC;CACrB;AAED;;;GAGG;AACH,oBAAY,oBAAoB;IAC9B,mCAAmC;IACnC,aAAa,IAAA;IACb,gDAAgD;IAChD,mBAAmB,IAAA;IACnB,gDAAgD;IAChD,iBAAiB,IAAA;CAClB;AAED;;GAEG;AACH,qBAAa,cAAe,SAAQ,KAAK,CAAC,aAAa,CAAC,mBAAmB,EAAE,mBAAmB,CAAC;IAC/F,OAAO,CAAC,aAAa,CAAuC;IAC5D,OAAO,CAAC,YAAY,CAAsC;IAC1D,OAAO,CAAC,YAAY,CAAqC;IACzD,OAAO,CAAC,WAAW,CAAsC;gBAE7C,KAAK,EAAE,mBAAmB;IAStC,OAAO,CAAC,KAAK;IAMb,OAAO,CAAC,oBAAoB,CAU1B;IAEF,OAAO,CAAC,oBAAoB,CAI1B;IAEF,OAAO,CAAC,mBAAmB,CAIzB;IAEF,OAAO,CAAC,gBAAgB,CAUtB;IAEF,OAAO,CAAC,eAAe,CAKrB;IAEF,gBAAgB;IACA,kBAAkB,CAAC,SAAS,EAAE,mBAAmB;IAMjD,MAAM;CAwCvB"}
+{"version":3,"file":"FilteringInput.d.ts","sourceRoot":"","sources":["../../../../src/components-react/filtering/FilteringInput.tsx"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,uBAAuB,CAAC;AAE/B,OAAO,KAAK,KAAK,MAAM,OAAO,CAAC;AAC/B,OAAO,EAAE,WAAW,EAAgB,MAAM,mBAAmB,CAAC;AAG9D,OAAO,EAAkB,mBAAmB,EAAE,MAAM,kBAAkB,CAAC;AAIvE;;GAEG;AACH,UAAU,mBAAmB;IAC3B,6CAA6C;IAC7C,UAAU,EAAE,MAAM,CAAC;IACnB;;;MAGE;IACF,aAAa,EAAE,OAAO,CAAC;IAEvB,iBAAiB,EAAE,MAAM,CAAC;CAC3B;AAED;;;GAGG;AACH,MAAM,WAAW,mBAAoB,SAAQ,WAAW;IACtD,6BAA6B;IAC7B,aAAa,EAAE,CAAC,UAAU,EAAE,MAAM,KAAK,IAAI,CAAC;IAC5C,oDAAoD;IACpD,cAAc,EAAE,MAAM,IAAI,CAAC;IAC3B,qDAAqD;IACrD,aAAa,EAAE,MAAM,IAAI,CAAC;IAC1B;;OAEG;IACH,MAAM,EAAE,oBAAoB,CAAC;IAC7B;;;;OAIG;IACH,mBAAmB,CAAC,EAAE,mBAAmB,CAAC;IAC1C,sEAAsE;IACtE,SAAS,CAAC,EAAE,OAAO,CAAC;CACrB;AAED;;;GAGG;AACH,oBAAY,oBAAoB;IAC9B,mCAAmC;IACnC,aAAa,IAAA;IACb,gDAAgD;IAChD,mBAAmB,IAAA;IACnB,gDAAgD;IAChD,iBAAiB,IAAA;CAClB;AAED;;GAEG;AACH,qBAAa,cAAe,SAAQ,KAAK,CAAC,aAAa,CAAC,mBAAmB,EAAE,mBAAmB,CAAC;IAC/F,OAAO,CAAC,aAAa,CAAuC;IAC5D,OAAO,CAAC,YAAY,CAAsC;IAC1D,OAAO,CAAC,YAAY,CAAqC;IACzD,OAAO,CAAC,WAAW,CAAsC;gBAE7C,KAAK,EAAE,mBAAmB;IAStC,OAAO,CAAC,KAAK;IAMb,OAAO,CAAC,oBAAoB,CAU1B;IAEF,OAAO,CAAC,oBAAoB,CAI1B;IAEF,OAAO,CAAC,mBAAmB,CAIzB;IAEF,OAAO,CAAC,gBAAgB,CAUtB;IAEF,OAAO,CAAC,eAAe,CAKrB;IAEF,gBAAgB;IACA,kBAAkB,CAAC,SAAS,EAAE,mBAAmB;IAMjD,MAAM;CAwCvB"}