@itwin/components-react 4.17.0 → 5.0.0-dev.2

package/lib/components-react/propertygrid/component/VirtualizedPropertyGrid.scss

@@ -0,0 +1,100 @@
+/*---------------------------------------------------------------------------------------------
+ * Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+ * See LICENSE.md in the project root for license terms and full copyright notice.
+ *--------------------------------------------------------------------------------------------*/
+@use "~@itwin/core-react/lib/core-react/scrollbar" as *;
+
+.components-virtualized-property-grid-loader {
+  height: 100%;
+  display: flex;
+  align-items: center;
+  justify-content: center;
+}
+
+.components-property-grid-wrapper {
+  @include uicore-touch-scrolling;
+  @include uicore-scrollbar();
+}
+
+.virtualized-grid-node {
+  > :not(.virtualized-grid-node-category) {
+    background: var(--iui-color-background);
+  }
+
+  .nested-border-middle {
+    height: 100%;
+    padding: 0 4px;
+    box-sizing: border-box;
+    border-left: 1px solid var(--iui-color-border);
+    border-right: 1px solid var(--iui-color-border);
+  }
+
+  .nested-border-bottom {
+    border-bottom: 1px solid var(--iui-color-border);
+    padding-bottom: 4px;
+  }
+
+  .components--clickable {
+    cursor: pointer;
+    box-sizing: border-box;
+
+    &:not(.components--selected) {
+      &:hover {
+        // Highlight the whole row of inner-most expandable block
+        margin: 0 -4px;
+        // Compensate the negative margin by adding padding
+        padding: 0 12px;
+
+        background: var(--iui-color-background-hover);
+      }
+    }
+  }
+
+  .components--selected {
+    // Highlight the whole row of inner-most expandable block
+    margin: 0 -4px;
+    // Compensate the negative margin by adding padding (minus one for border)
+    padding: 0px 11px;
+
+    background-color: var(--iui-color-background-accent-muted);
+    border: 1px solid var(--iui-color-border-accent);
+  }
+
+  .components--hoverable {
+    &:hover {
+      background: var(--iui-color-background-hover);
+
+      &:not(.components--selected) {
+        // Highlight the whole row of inner-most expandable block
+        margin: 0 -4px;
+        // Compensate the negative margin by adding padding
+        padding: 0 12px;
+      }
+    }
+  }
+}
+
+.virtualized-grid-node-category {
+  padding-top: 4px;
+
+  .components-expandable-content {
+    // We are rendering virtualized content below the expandable block
+    display: none;
+  }
+}
+
+.virtualized-grid-node-custom-category {
+  padding-top: 4px;
+
+  .components-expandable-content > div {
+    padding: 0 4px 4px 4px;
+  }
+}
+
+.virtualized-grid-node-content {
+  height: 100%;
+}
+
+.virtualized-grid-node-content-wrapper-item {
+  overflow: hidden;
+}

package/lib/components-react/propertygrid/component/VirtualizedPropertyGridWithDataProvider.d.ts

@@ -0,0 +1,30 @@
+/** @packageDocumentation
+ * @module PropertyGrid
+ */
+import React from "react";
+import type { PropertyCategoryRendererManager } from "../PropertyCategoryRendererManager.js";
+import type { IPropertyDataProvider } from "../PropertyDataProvider.js";
+import type { CommonPropertyGridProps, PropertyGridContentHighlightProps } from "./PropertyGridCommons.js";
+/** Properties for [[VirtualizedPropertyGridWithDataProvider]] React component
+ * @public
+ * @deprecated in 4.17.0. Use `React.ComponentProps<typeof VirtualizedPropertyGridWithDataProvider>`
+ */
+export interface VirtualizedPropertyGridWithDataProviderProps extends CommonPropertyGridProps {
+    /** Property data provider used by the property grid */
+    dataProvider: IPropertyDataProvider;
+    /** Properties for highlighting property data in the grid. */
+    highlight?: PropertyGridContentHighlightProps;
+    /** Custom property category renderer manager. Defaults to [[PropertyCategoryRendererManager.defaultManager]]. */
+    propertyCategoryRendererManager?: PropertyCategoryRendererManager;
+    /** Width of the property grid component. */
+    width: number;
+    /** Height of the property grid component. */
+    height: number;
+}
+/**
+ * [[VirtualizedPropertyGrid]] React Component which takes a data provider and
+ * sets up default implementations for `IPropertyGridModelSource` and `IPropertyGridEventHandler`
+ * @public
+ */
+export declare function VirtualizedPropertyGridWithDataProvider(props: VirtualizedPropertyGridWithDataProviderProps): React.JSX.Element;
+//# sourceMappingURL=VirtualizedPropertyGridWithDataProvider.d.ts.map

package/lib/components-react/propertygrid/component/VirtualizedPropertyGridWithDataProvider.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"VirtualizedPropertyGridWithDataProvider.d.ts","sourceRoot":"","sources":["../../../../src/components-react/propertygrid/component/VirtualizedPropertyGridWithDataProvider.tsx"],"names":[],"mappings":"AAKA;;GAEG;AAEH,OAAO,KAA8B,MAAM,OAAO,CAAC;AAMnD,OAAO,KAAK,EAAE,+BAA+B,EAAE,MAAM,uCAAuC,CAAC;AAC7F,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,4BAA4B,CAAC;AACxE,OAAO,KAAK,EACV,uBAAuB,EACvB,iCAAiC,EAClC,MAAM,0BAA0B,CAAC;AAIlC;;;GAGG;AACH,MAAM,WAAW,4CACf,SAAQ,uBAAuB;IAC/B,uDAAuD;IACvD,YAAY,EAAE,qBAAqB,CAAC;IACpC,6DAA6D;IAC7D,SAAS,CAAC,EAAE,iCAAiC,CAAC;IAC9C,iHAAiH;IACjH,+BAA+B,CAAC,EAAE,+BAA+B,CAAC;IAClE,4CAA4C;IAC5C,KAAK,EAAE,MAAM,CAAC;IACd,6CAA6C;IAC7C,MAAM,EAAE,MAAM,CAAC;CAChB;AAED;;;;GAIG;AACH,wBAAgB,uCAAuC,CAErD,KAAK,EAAE,4CAA4C,qBAoBpD"}

package/lib/components-react/propertygrid/component/VirtualizedPropertyGridWithDataProvider.js

@@ -0,0 +1,43 @@
+/*---------------------------------------------------------------------------------------------
+ * Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+ * See LICENSE.md in the project root for license terms and full copyright notice.
+ *--------------------------------------------------------------------------------------------*/
+/** @packageDocumentation
+ * @module PropertyGrid
+ */
+import React, { useEffect, useState } from "react";
+import { usePropertyGridEventHandler, usePropertyGridModel, useTrackedPropertyGridModelSource, } from "../internal/PropertyGridHooks.js";
+import { VirtualizedPropertyGrid } from "./VirtualizedPropertyGrid.js";
+import { ProgressRadial } from "@itwin/itwinui-react";
+/**
+ * [[VirtualizedPropertyGrid]] React Component which takes a data provider and
+ * sets up default implementations for `IPropertyGridModelSource` and `IPropertyGridEventHandler`
+ * @public
+ */
+export function VirtualizedPropertyGridWithDataProvider(
+/* eslint-disable-next-line deprecation/deprecation */
+props) {
+    const { modelSource, inProgress } = useTrackedPropertyGridModelSource({
+        dataProvider: props.dataProvider,
+    });
+    const model = usePropertyGridModel({ modelSource });
+    const eventHandler = usePropertyGridEventHandler({ modelSource });
+    return (React.createElement(DelayedLoaderRenderer, { shouldRenderLoader: inProgress || !model }, model && (React.createElement(VirtualizedPropertyGrid, { ...props, model: model, eventHandler: eventHandler }))));
+}
+function DelayedLoaderRenderer({ children, shouldRenderLoader, }) {
+    const [showSpinner, setShowSpinner] = useState(shouldRenderLoader);
+    useEffect(() => {
+        if (!shouldRenderLoader) {
+            setShowSpinner(shouldRenderLoader);
+            return;
+        }
+        // only set a timeout when shouldRenderLoader is set to `true`
+        const timeout = setTimeout(() => {
+            setShowSpinner(shouldRenderLoader);
+        }, 250);
+        return () => clearTimeout(timeout);
+    }, [shouldRenderLoader]);
+    return !showSpinner ? (React.createElement(React.Fragment, null, children)) : (React.createElement("div", { className: "components-virtualized-property-grid-loader" },
+        React.createElement(ProgressRadial, { indeterminate: true, size: "large" })));
+}
+//# sourceMappingURL=VirtualizedPropertyGridWithDataProvider.js.map

package/lib/components-react/propertygrid/component/VirtualizedPropertyGridWithDataProvider.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"VirtualizedPropertyGridWithDataProvider.js","sourceRoot":"","sources":["../../../../src/components-react/propertygrid/component/VirtualizedPropertyGridWithDataProvider.tsx"],"names":[],"mappings":"AAAA;;;gGAGgG;AAEhG;;GAEG;AAEH,OAAO,KAAK,EAAE,EAAE,SAAS,EAAE,QAAQ,EAAE,MAAM,OAAO,CAAC;AACnD,OAAO,EACL,2BAA2B,EAC3B,oBAAoB,EACpB,iCAAiC,GAClC,MAAM,kCAAkC,CAAC;AAO1C,OAAO,EAAE,uBAAuB,EAAE,MAAM,8BAA8B,CAAC;AACvE,OAAO,EAAE,cAAc,EAAE,MAAM,sBAAsB,CAAC;AAoBtD;;;;GAIG;AACH,MAAM,UAAU,uCAAuC;AACrD,sDAAsD;AACtD,KAAmD;IAEnD,MAAM,EAAE,WAAW,EAAE,UAAU,EAAE,GAAG,iCAAiC,CAAC;QACpE,YAAY,EAAE,KAAK,CAAC,YAAY;KACjC,CAAC,CAAC;IAEH,MAAM,KAAK,GAAG,oBAAoB,CAAC,EAAE,WAAW,EAAE,CAAC,CAAC;IACpD,MAAM,YAAY,GAAG,2BAA2B,CAAC,EAAE,WAAW,EAAE,CAAC,CAAC;IAElE,OAAO,CACL,oBAAC,qBAAqB,IAAC,kBAAkB,EAAE,UAAU,IAAI,CAAC,KAAK,IAC5D,KAAK,IAAI,CACR,oBAAC,uBAAuB,OAClB,KAAK,EACT,KAAK,EAAE,KAAK,EACZ,YAAY,EAAE,YAAY,GAC1B,CACH,CACqB,CACzB,CAAC;AACJ,CAAC;AAMD,SAAS,qBAAqB,CAAC,EAC7B,QAAQ,EACR,kBAAkB,GACkC;IACpD,MAAM,CAAC,WAAW,EAAE,cAAc,CAAC,GAAG,QAAQ,CAAC,kBAAkB,CAAC,CAAC;IACnE,SAAS,CAAC,GAAG,EAAE;QACb,IAAI,CAAC,kBAAkB,EAAE,CAAC;YACxB,cAAc,CAAC,kBAAkB,CAAC,CAAC;YACnC,OAAO;QACT,CAAC;QAED,8DAA8D;QAC9D,MAAM,OAAO,GAAG,UAAU,CAAC,GAAG,EAAE;YAC9B,cAAc,CAAC,kBAAkB,CAAC,CAAC;QACrC,CAAC,EAAE,GAAG,CAAC,CAAC;QAER,OAAO,GAAG,EAAE,CAAC,YAAY,CAAC,OAAO,CAAC,CAAC;IACrC,CAAC,EAAE,CAAC,kBAAkB,CAAC,CAAC,CAAC;IAEzB,OAAO,CAAC,WAAW,CAAC,CAAC,CAAC,CACpB,0CAAG,QAAQ,CAAI,CAChB,CAAC,CAAC,CAAC,CACF,6BAAK,SAAS,EAAC,6CAA6C;QAC1D,oBAAC,cAAc,IAAC,aAAa,QAAC,IAAI,EAAE,OAAO,GAAI,CAC3C,CACP,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 *--------------------------------------------------------------------------------------------*/\n\n/** @packageDocumentation\n * @module PropertyGrid\n */\n\nimport React, { useEffect, useState } from \"react\";\nimport {\n  usePropertyGridEventHandler,\n  usePropertyGridModel,\n  useTrackedPropertyGridModelSource,\n} from \"../internal/PropertyGridHooks.js\";\nimport type { PropertyCategoryRendererManager } from \"../PropertyCategoryRendererManager.js\";\nimport type { IPropertyDataProvider } from \"../PropertyDataProvider.js\";\nimport type {\n  CommonPropertyGridProps,\n  PropertyGridContentHighlightProps,\n} from \"./PropertyGridCommons.js\";\nimport { VirtualizedPropertyGrid } from \"./VirtualizedPropertyGrid.js\";\nimport { ProgressRadial } from \"@itwin/itwinui-react\";\n\n/** Properties for [[VirtualizedPropertyGridWithDataProvider]] React component\n * @public\n * @deprecated in 4.17.0. Use `React.ComponentProps<typeof VirtualizedPropertyGridWithDataProvider>`\n */\nexport interface VirtualizedPropertyGridWithDataProviderProps\n  extends CommonPropertyGridProps {\n  /** Property data provider used by the property grid */\n  dataProvider: IPropertyDataProvider;\n  /** Properties for highlighting property data in the grid. */\n  highlight?: PropertyGridContentHighlightProps;\n  /** Custom property category renderer manager. Defaults to [[PropertyCategoryRendererManager.defaultManager]]. */\n  propertyCategoryRendererManager?: PropertyCategoryRendererManager;\n  /** Width of the property grid component. */\n  width: number;\n  /** Height of the property grid component. */\n  height: number;\n}\n\n/**\n * [[VirtualizedPropertyGrid]] React Component which takes a data provider and\n * sets up default implementations for `IPropertyGridModelSource` and `IPropertyGridEventHandler`\n * @public\n */\nexport function VirtualizedPropertyGridWithDataProvider(\n  /* eslint-disable-next-line deprecation/deprecation */\n  props: VirtualizedPropertyGridWithDataProviderProps\n) {\n  const { modelSource, inProgress } = useTrackedPropertyGridModelSource({\n    dataProvider: props.dataProvider,\n  });\n\n  const model = usePropertyGridModel({ modelSource });\n  const eventHandler = usePropertyGridEventHandler({ modelSource });\n\n  return (\n    <DelayedLoaderRenderer shouldRenderLoader={inProgress || !model}>\n      {model && (\n        <VirtualizedPropertyGrid\n          {...props}\n          model={model}\n          eventHandler={eventHandler}\n        />\n      )}\n    </DelayedLoaderRenderer>\n  );\n}\n\ninterface DelayedLoaderRendererProps {\n  shouldRenderLoader: boolean;\n}\n\nfunction DelayedLoaderRenderer({\n  children,\n  shouldRenderLoader,\n}: React.PropsWithChildren<DelayedLoaderRendererProps>) {\n  const [showSpinner, setShowSpinner] = useState(shouldRenderLoader);\n  useEffect(() => {\n    if (!shouldRenderLoader) {\n      setShowSpinner(shouldRenderLoader);\n      return;\n    }\n\n    // only set a timeout when shouldRenderLoader is set to `true`\n    const timeout = setTimeout(() => {\n      setShowSpinner(shouldRenderLoader);\n    }, 250);\n\n    return () => clearTimeout(timeout);\n  }, [shouldRenderLoader]);\n\n  return !showSpinner ? (\n    <>{children}</>\n  ) : (\n    <div className=\"components-virtualized-property-grid-loader\">\n      <ProgressRadial indeterminate size={\"large\"} />\n    </div>\n  );\n}\n"]}

package/lib/components-react/propertygrid/dataproviders/FilteringDataProvider.d.ts

@@ -0,0 +1,43 @@
+/** @packageDocumentation
+ * @module PropertyGrid
+ */
+import type { IDisposable } from "@itwin/core-bentley";
+import type { HighlightInfo } from "../../common/HighlightingComponentProps.js";
+import type { IPropertyDataProvider, PropertyData } from "../PropertyDataProvider.js";
+import { PropertyDataChangeEvent } from "../PropertyDataProvider.js";
+import type { FilteredType, IPropertyDataFilterer } from "./filterers/PropertyDataFiltererBase.js";
+/**
+ * Data returned by [[FilteringPropertyDataProvider]]
+ * @public
+ */
+export interface FilteredPropertyData extends PropertyData {
+    /**
+     * Shows how many matches were found when filtering data.
+     * `undefined` when filterer is not active
+     */
+    matchesCount?: number;
+    /**
+     * Function used for getting [[HighlightInfo]] by index from all the filtered matches.
+     * `undefined` when filterer is not active
+     */
+    getMatchByIndex?: (index: number) => HighlightInfo | undefined;
+    /** Types of objects that were used for filtering. */
+    filteredTypes?: FilteredType[];
+}
+/**
+ * [[IPropertyDataProvider]] implementation which filters wrapped provider [[PropertyData]] using passed [[IPropertyDataFilterer]].
+ * @public
+ */
+export declare class FilteringPropertyDataProvider implements IPropertyDataProvider, IDisposable {
+    private _dataProvider;
+    private _filterer;
+    onDataChanged: PropertyDataChangeEvent;
+    private _filteredPropertyData;
+    private _disposeFilterChangedListener;
+    private _disposeDataChangedListener;
+    constructor(_dataProvider: IPropertyDataProvider, _filterer: IPropertyDataFilterer);
+    dispose(): void;
+    getData(): Promise<FilteredPropertyData>;
+    private filterPropertyData;
+}
+//# sourceMappingURL=FilteringDataProvider.d.ts.map

package/lib/components-react/propertygrid/dataproviders/FilteringDataProvider.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"FilteringDataProvider.d.ts","sourceRoot":"","sources":["../../../../src/components-react/propertygrid/dataproviders/FilteringDataProvider.ts"],"names":[],"mappings":"AAIA;;GAEG;AAIH,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,qBAAqB,CAAC;AACvD,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,4CAA4C,CAAC;AAEhF,OAAO,KAAK,EACV,qBAAqB,EAErB,YAAY,EACb,MAAM,4BAA4B,CAAC;AACpC,OAAO,EAAE,uBAAuB,EAAE,MAAM,4BAA4B,CAAC;AACrE,OAAO,KAAK,EACV,YAAY,EACZ,qBAAqB,EAEtB,MAAM,yCAAyC,CAAC;AAWjD;;;GAGG;AACH,MAAM,WAAW,oBAAqB,SAAQ,YAAY;IACxD;;;OAGG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;;OAGG;IACH,eAAe,CAAC,EAAE,CAAC,KAAK,EAAE,MAAM,KAAK,aAAa,GAAG,SAAS,CAAC;IAE/D,qDAAqD;IACrD,aAAa,CAAC,EAAE,YAAY,EAAE,CAAC;CAChC;AAED;;;GAGG;AACH,qBAAa,6BACX,YAAW,qBAAqB,EAAE,WAAW;IAS3C,OAAO,CAAC,aAAa;IACrB,OAAO,CAAC,SAAS;IARZ,aAAa,0BAAiC;IACrD,OAAO,CAAC,qBAAqB,CACjB;IACZ,OAAO,CAAC,6BAA6B,CAAW;IAChD,OAAO,CAAC,2BAA2B,CAAW;gBAGpC,aAAa,EAAE,qBAAqB,EACpC,SAAS,EAAE,qBAAqB;IAcnC,OAAO,IAAI,IAAI;IAKT,OAAO,IAAI,OAAO,CAAC,oBAAoB,CAAC;YAgBvC,kBAAkB;CA0CjC"}

package/lib/components-react/propertygrid/dataproviders/FilteringDataProvider.js

@@ -0,0 +1,215 @@
+/*---------------------------------------------------------------------------------------------
+ * Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+ * See LICENSE.md in the project root for license terms and full copyright notice.
+ *--------------------------------------------------------------------------------------------*/
+/** @packageDocumentation
+ * @module PropertyGrid
+ */
+import { PropertyValueFormat } from "@itwin/appui-abstract";
+import { PropertyDataChangeEvent } from "../PropertyDataProvider.js";
+/**
+ * [[IPropertyDataProvider]] implementation which filters wrapped provider [[PropertyData]] using passed [[IPropertyDataFilterer]].
+ * @public
+ */
+export class FilteringPropertyDataProvider {
+    constructor(_dataProvider, _filterer) {
+        this._dataProvider = _dataProvider;
+        this._filterer = _filterer;
+        this.onDataChanged = new PropertyDataChangeEvent();
+        this._filteredPropertyData = undefined;
+        this._disposeFilterChangedListener =
+            this._filterer.onFilterChanged.addListener(() => {
+                this._filteredPropertyData = undefined;
+                this.onDataChanged.raiseEvent();
+            });
+        this._disposeDataChangedListener =
+            this._dataProvider.onDataChanged.addListener(() => {
+                this._filteredPropertyData = undefined;
+                this.onDataChanged.raiseEvent();
+            });
+    }
+    dispose() {
+        this._disposeDataChangedListener();
+        this._disposeFilterChangedListener();
+    }
+    async getData() {
+        if (this._filteredPropertyData) {
+            return this._filteredPropertyData;
+        }
+        this._filteredPropertyData = this._dataProvider
+            .getData()
+            .then(async (propertyData) => {
+            return this._filterer.isActive
+                ? this.filterPropertyData(propertyData)
+                : propertyData;
+        });
+        return this._filteredPropertyData;
+    }
+    async filterPropertyData(propertyData) {
+        const { categories, records, label, description } = { ...propertyData };
+        const { filteredCategories, filteredRecords, matchesCount, filteredResultMatches, filteredTypes, } = await matchHierarchy(this._filterer, categories, records, undefined);
+        const uniqueTypes = [...new Set(filteredTypes)];
+        const getMatchByIndex = (index) => {
+            let activeMatch;
+            if (index <= 0)
+                return undefined;
+            let i = 1;
+            for (const record of filteredResultMatches) {
+                const fullMatchesCount = record.matchesCount;
+                if (index < i + fullMatchesCount) {
+                    activeMatch = {
+                        highlightedItemIdentifier: record.id,
+                        highlightIndex: index - i,
+                    };
+                    break;
+                }
+                i += fullMatchesCount;
+            }
+            return activeMatch;
+        };
+        return {
+            label,
+            description,
+            categories: filteredCategories,
+            records: filteredRecords,
+            reusePropertyDataState: false,
+            matchesCount,
+            getMatchByIndex,
+            filteredTypes: uniqueTypes,
+        };
+    }
+}
+async function matchHierarchy(filterer, categories, records, newRecords, parentMatchInfo) {
+    const newCategories = [];
+    newRecords = newRecords ?? {};
+    let matchesCount = 0;
+    let allFilteredResultMatches = [];
+    let allFilteredTypes = [];
+    for (const category of categories) {
+        const matchInfo = await filterer.categoryMatchesFilter(category, []);
+        if (matchInfo.matchesFilter) {
+            allFilteredResultMatches.push({
+                id: category.name,
+                matchesCount: matchInfo.matchesCount ?? 0,
+            });
+            allFilteredTypes = allFilteredTypes.concat(matchInfo.filteredTypes ?? []);
+            matchesCount += matchInfo.matchesCount ?? 0;
+        }
+        const childRecords = records[category.name] ?? [];
+        const { filteredRecords, matchesCount: count, filteredResultMatches, filteredTypes, } = await matchRecordHierarchy(filterer, childRecords, []);
+        allFilteredResultMatches = allFilteredResultMatches.concat(filteredResultMatches);
+        allFilteredTypes = allFilteredTypes.concat(filteredTypes);
+        matchesCount += count;
+        const parentInfo = parentMatchInfo?.matchesFilter
+            ? parentMatchInfo
+            : matchInfo;
+        const childCategories = category.childCategories ?? [];
+        const { filteredCategories, matchesCount: childCount, filteredResultMatches: childFilteredResultMatches, filteredTypes: childFilteredTypes, } = await matchHierarchy(filterer, childCategories, records, newRecords, parentInfo);
+        allFilteredResultMatches = allFilteredResultMatches.concat(childFilteredResultMatches);
+        allFilteredTypes = allFilteredTypes.concat(childFilteredTypes);
+        matchesCount += childCount;
+        let expand = !(count === 0 && childCount === 0);
+        if (matchInfo.matchesFilter ||
+            (parentMatchInfo?.matchesFilter &&
+                parentMatchInfo.shouldForceIncludeDescendants)) {
+            newRecords[category.name] = records[category.name];
+            if (matchInfo.matchesFilter) {
+                expand = true;
+            }
+            const newCategory = copyPropertyCategory(category, filteredCategories, expand);
+            newCategories.push(newCategory);
+        }
+        if ((filteredRecords.length !== 0 || filteredCategories.length !== 0) &&
+            !matchInfo.matchesFilter &&
+            !(parentMatchInfo?.shouldExpandNodeParents &&
+                parentMatchInfo.matchesFilter)) {
+            const newCategory = copyPropertyCategory(category, filteredCategories, expand);
+            newRecords[newCategory.name] = filteredRecords;
+            newCategories.push(newCategory);
+        }
+    }
+    return {
+        filteredCategories: newCategories,
+        filteredRecords: newRecords,
+        matchesCount,
+        filteredResultMatches: allFilteredResultMatches,
+        filteredTypes: allFilteredTypes,
+    };
+}
+async function matchRecordHierarchy(filterer, records, parents, forceIncludeItem = false) {
+    const newMatchedRecords = [];
+    let expandParent = false; // property passed back to parent to indicate whether it should be expanded
+    let matchesCount = 0;
+    let filteredResultMatches = [];
+    let filteredTypes = [];
+    for (const record of records) {
+        const matchInfo = await filterer.recordMatchesFilter(record, parents);
+        const shouldForceIncludeDescendants = forceIncludeItem || matchInfo.shouldForceIncludeDescendants;
+        const { filteredRecords: filteredChildren, shouldExpandNodeParents, matchesCount: childrenMatchesCount, filteredResultMatches: childrenResultMatches, filteredTypes: childrenFilteredTypes, } = await matchRecordHierarchy(filterer, record.getChildrenRecords(), [...parents, record], shouldForceIncludeDescendants);
+        filteredResultMatches = filteredResultMatches.concat(childrenResultMatches);
+        filteredTypes = [...filteredTypes, ...childrenFilteredTypes];
+        matchesCount += childrenMatchesCount;
+        // if child hierarchy indicates parents should be expanded, then it should be passed back up to the top parent
+        expandParent = expandParent || shouldExpandNodeParents;
+        let newRecord;
+        if (matchInfo.matchesFilter) {
+            filteredTypes = [...filteredTypes, ...(matchInfo.filteredTypes ?? [])];
+            const recordMatchesCount = matchInfo.matchesCount ?? 0;
+            matchesCount += recordMatchesCount;
+            // Item is included if it matches filter
+            // If at least one matched record from records list needs its parent expanded,
+            // then `expandParent` should be set to true
+            expandParent = expandParent || !!matchInfo.shouldExpandNodeParents;
+            newRecord = copyPropertyRecord(record, filteredChildren, shouldExpandNodeParents);
+            filteredResultMatches.push({
+                id: newRecord.property.name,
+                matchesCount: recordMatchesCount,
+            });
+        }
+        else if (filteredChildren.length !== 0 || forceIncludeItem) {
+            // Item is also included if it has at least one matched child or is forcefully included by its parent
+            newRecord = copyPropertyRecord(record, filteredChildren, shouldExpandNodeParents);
+        }
+        if (newRecord)
+            newMatchedRecords.push(newRecord);
+    }
+    return {
+        filteredRecords: newMatchedRecords,
+        shouldExpandNodeParents: expandParent,
+        matchesCount,
+        filteredResultMatches,
+        filteredTypes,
+    };
+}
+function copyPropertyCategory(propertyCategory, newChildren, expand) {
+    return {
+        ...propertyCategory,
+        childCategories: newChildren,
+        expand,
+    };
+}
+function copyPropertyRecord(record, newChildren, autoExpand) {
+    const r = record.copyWithNewValue(createNewPropertyValue(record.value, newChildren));
+    r.autoExpand = autoExpand;
+    return r;
+}
+function createNewPropertyValue(value, newChildren) {
+    switch (value.valueFormat) {
+        case PropertyValueFormat.Primitive:
+            return { ...value };
+        case PropertyValueFormat.Array:
+            return {
+                valueFormat: PropertyValueFormat.Array,
+                itemsTypeName: value.itemsTypeName,
+                items: newChildren,
+            };
+        case PropertyValueFormat.Struct:
+            const members = {};
+            newChildren.forEach((child) => (members[child.property.name] = child));
+            return {
+                valueFormat: PropertyValueFormat.Struct,
+                members,
+            };
+    }
+}
+//# sourceMappingURL=FilteringDataProvider.js.map

package/lib/components-react/propertygrid/dataproviders/FilteringDataProvider.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"FilteringDataProvider.js","sourceRoot":"","sources":["../../../../src/components-react/propertygrid/dataproviders/FilteringDataProvider.ts"],"names":[],"mappings":"AAAA;;;gGAGgG;AAChG;;GAEG;AAGH,OAAO,EAAE,mBAAmB,EAAE,MAAM,uBAAuB,CAAC;AAS5D,OAAO,EAAE,uBAAuB,EAAE,MAAM,4BAA4B,CAAC;AAqCrE;;;GAGG;AACH,MAAM,OAAO,6BAA6B;IASxC,YACU,aAAoC,EACpC,SAAgC;QADhC,kBAAa,GAAb,aAAa,CAAuB;QACpC,cAAS,GAAT,SAAS,CAAuB;QARnC,kBAAa,GAAG,IAAI,uBAAuB,EAAE,CAAC;QAC7C,0BAAqB,GAC3B,SAAS,CAAC;QAQV,IAAI,CAAC,6BAA6B;YAChC,IAAI,CAAC,SAAS,CAAC,eAAe,CAAC,WAAW,CAAC,GAAG,EAAE;gBAC9C,IAAI,CAAC,qBAAqB,GAAG,SAAS,CAAC;gBACvC,IAAI,CAAC,aAAa,CAAC,UAAU,EAAE,CAAC;YAClC,CAAC,CAAC,CAAC;QACL,IAAI,CAAC,2BAA2B;YAC9B,IAAI,CAAC,aAAa,CAAC,aAAa,CAAC,WAAW,CAAC,GAAG,EAAE;gBAChD,IAAI,CAAC,qBAAqB,GAAG,SAAS,CAAC;gBACvC,IAAI,CAAC,aAAa,CAAC,UAAU,EAAE,CAAC;YAClC,CAAC,CAAC,CAAC;IACP,CAAC;IAEM,OAAO;QACZ,IAAI,CAAC,2BAA2B,EAAE,CAAC;QACnC,IAAI,CAAC,6BAA6B,EAAE,CAAC;IACvC,CAAC;IAEM,KAAK,CAAC,OAAO;QAClB,IAAI,IAAI,CAAC,qBAAqB,EAAE,CAAC;YAC/B,OAAO,IAAI,CAAC,qBAAqB,CAAC;QACpC,CAAC;QAED,IAAI,CAAC,qBAAqB,GAAG,IAAI,CAAC,aAAa;aAC5C,OAAO,EAAE;aACT,IAAI,CAAC,KAAK,EAAE,YAAY,EAAE,EAAE;YAC3B,OAAO,IAAI,CAAC,SAAS,CAAC,QAAQ;gBAC5B,CAAC,CAAC,IAAI,CAAC,kBAAkB,CAAC,YAAY,CAAC;gBACvC,CAAC,CAAC,YAAY,CAAC;QACnB,CAAC,CAAC,CAAC;QAEL,OAAO,IAAI,CAAC,qBAAqB,CAAC;IACpC,CAAC;IAEO,KAAK,CAAC,kBAAkB,CAAC,YAA0B;QACzD,MAAM,EAAE,UAAU,EAAE,OAAO,EAAE,KAAK,EAAE,WAAW,EAAE,GAAG,EAAE,GAAG,YAAY,EAAE,CAAC;QACxE,MAAM,EACJ,kBAAkB,EAClB,eAAe,EACf,YAAY,EACZ,qBAAqB,EACrB,aAAa,GACd,GAAG,MAAM,cAAc,CAAC,IAAI,CAAC,SAAS,EAAE,UAAU,EAAE,OAAO,EAAE,SAAS,CAAC,CAAC;QAEzE,MAAM,WAAW,GAAG,CAAC,GAAG,IAAI,GAAG,CAAC,aAAa,CAAC,CAAC,CAAC;QAChD,MAAM,eAAe,GAAG,CAAC,KAAa,EAAE,EAAE;YACxC,IAAI,WAAsC,CAAC;YAC3C,IAAI,KAAK,IAAI,CAAC;gBAAE,OAAO,SAAS,CAAC;YAEjC,IAAI,CAAC,GAAG,CAAC,CAAC;YACV,KAAK,MAAM,MAAM,IAAI,qBAAqB,EAAE,CAAC;gBAC3C,MAAM,gBAAgB,GAAG,MAAM,CAAC,YAAY,CAAC;gBAC7C,IAAI,KAAK,GAAG,CAAC,GAAG,gBAAgB,EAAE,CAAC;oBACjC,WAAW,GAAG;wBACZ,yBAAyB,EAAE,MAAM,CAAC,EAAE;wBACpC,cAAc,EAAE,KAAK,GAAG,CAAC;qBAC1B,CAAC;oBACF,MAAM;gBACR,CAAC;gBAED,CAAC,IAAI,gBAAgB,CAAC;YACxB,CAAC;YACD,OAAO,WAAW,CAAC;QACrB,CAAC,CAAC;QAEF,OAAO;YACL,KAAK;YACL,WAAW;YACX,UAAU,EAAE,kBAAkB;YAC9B,OAAO,EAAE,eAAe;YACxB,sBAAsB,EAAE,KAAK;YAC7B,YAAY;YACZ,eAAe;YACf,aAAa,EAAE,WAAW;SAC3B,CAAC;IACJ,CAAC;CACF;AAED,KAAK,UAAU,cAAc,CAC3B,QAA+B,EAC/B,UAA8B,EAC9B,OAA4B,EAC5B,UAAgC,EAChC,eAA0C;IAE1C,MAAM,aAAa,GAAuB,EAAE,CAAC;IAC7C,UAAU,GAAG,UAAU,IAAI,EAAE,CAAC;IAC9B,IAAI,YAAY,GAAG,CAAC,CAAC;IACrB,IAAI,wBAAwB,GAA2C,EAAE,CAAC;IAC1E,IAAI,gBAAgB,GAAmB,EAAE,CAAC;IAE1C,KAAK,MAAM,QAAQ,IAAI,UAAU,EAAE,CAAC;QAClC,MAAM,SAAS,GAAG,MAAM,QAAQ,CAAC,qBAAqB,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC;QAErE,IAAI,SAAS,CAAC,aAAa,EAAE,CAAC;YAC5B,wBAAwB,CAAC,IAAI,CAAC;gBAC5B,EAAE,EAAE,QAAQ,CAAC,IAAI;gBACjB,YAAY,EAAE,SAAS,CAAC,YAAY,IAAI,CAAC;aAC1C,CAAC,CAAC;YACH,gBAAgB,GAAG,gBAAgB,CAAC,MAAM,CAAC,SAAS,CAAC,aAAa,IAAI,EAAE,CAAC,CAAC;YAC1E,YAAY,IAAI,SAAS,CAAC,YAAY,IAAI,CAAC,CAAC;QAC9C,CAAC;QAED,MAAM,YAAY,GAAG,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC;QAClD,MAAM,EACJ,eAAe,EACf,YAAY,EAAE,KAAK,EACnB,qBAAqB,EACrB,aAAa,GACd,GAAG,MAAM,oBAAoB,CAAC,QAAQ,EAAE,YAAY,EAAE,EAAE,CAAC,CAAC;QAC3D,wBAAwB,GAAG,wBAAwB,CAAC,MAAM,CACxD,qBAAqB,CACtB,CAAC;QACF,gBAAgB,GAAG,gBAAgB,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC;QAC1D,YAAY,IAAI,KAAK,CAAC;QAEtB,MAAM,UAAU,GAAG,eAAe,EAAE,aAAa;YAC/C,CAAC,CAAC,eAAe;YACjB,CAAC,CAAC,SAAS,CAAC;QAEd,MAAM,eAAe,GAAG,QAAQ,CAAC,eAAe,IAAI,EAAE,CAAC;QACvD,MAAM,EACJ,kBAAkB,EAClB,YAAY,EAAE,UAAU,EACxB,qBAAqB,EAAE,0BAA0B,EACjD,aAAa,EAAE,kBAAkB,GAClC,GAAG,MAAM,cAAc,CACtB,QAAQ,EACR,eAAe,EACf,OAAO,EACP,UAAU,EACV,UAAU,CACX,CAAC;QACF,wBAAwB,GAAG,wBAAwB,CAAC,MAAM,CACxD,0BAA0B,CAC3B,CAAC;QACF,gBAAgB,GAAG,gBAAgB,CAAC,MAAM,CAAC,kBAAkB,CAAC,CAAC;QAC/D,YAAY,IAAI,UAAU,CAAC;QAE3B,IAAI,MAAM,GAAG,CAAC,CAAC,KAAK,KAAK,CAAC,IAAI,UAAU,KAAK,CAAC,CAAC,CAAC;QAChD,IACE,SAAS,CAAC,aAAa;YACvB,CAAC,eAAe,EAAE,aAAa;gBAC7B,eAAe,CAAC,6BAA6B,CAAC,EAChD,CAAC;YACD,UAAU,CAAC,QAAQ,CAAC,IAAI,CAAC,GAAG,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;YACnD,IAAI,SAAS,CAAC,aAAa,EAAE,CAAC;gBAC5B,MAAM,GAAG,IAAI,CAAC;YAChB,CAAC;YACD,MAAM,WAAW,GAAG,oBAAoB,CACtC,QAAQ,EACR,kBAAkB,EAClB,MAAM,CACP,CAAC;YACF,aAAa,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;QAClC,CAAC;QAED,IACE,CAAC,eAAe,CAAC,MAAM,KAAK,CAAC,IAAI,kBAAkB,CAAC,MAAM,KAAK,CAAC,CAAC;YACjE,CAAC,SAAS,CAAC,aAAa;YACxB,CAAC,CACC,eAAe,EAAE,uBAAuB;gBACxC,eAAe,CAAC,aAAa,CAC9B,EACD,CAAC;YACD,MAAM,WAAW,GAAG,oBAAoB,CACtC,QAAQ,EACR,kBAAkB,EAClB,MAAM,CACP,CAAC;YACF,UAAU,CAAC,WAAW,CAAC,IAAI,CAAC,GAAG,eAAe,CAAC;YAC/C,aAAa,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;QAClC,CAAC;IACH,CAAC;IAED,OAAO;QACL,kBAAkB,EAAE,aAAa;QACjC,eAAe,EAAE,UAAU;QAC3B,YAAY;QACZ,qBAAqB,EAAE,wBAAwB;QAC/C,aAAa,EAAE,gBAAgB;KAChC,CAAC;AACJ,CAAC;AAED,KAAK,UAAU,oBAAoB,CACjC,QAA+B,EAC/B,OAAyB,EACzB,OAAyB,EACzB,mBAA4B,KAAK;IAEjC,MAAM,iBAAiB,GAAqB,EAAE,CAAC;IAC/C,IAAI,YAAY,GAAG,KAAK,CAAC,CAAC,2EAA2E;IACrG,IAAI,YAAY,GAAG,CAAC,CAAC;IACrB,IAAI,qBAAqB,GAA2C,EAAE,CAAC;IACvE,IAAI,aAAa,GAAmB,EAAE,CAAC;IAEvC,KAAK,MAAM,MAAM,IAAI,OAAO,EAAE,CAAC;QAC7B,MAAM,SAAS,GAAG,MAAM,QAAQ,CAAC,mBAAmB,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;QACtE,MAAM,6BAA6B,GACjC,gBAAgB,IAAI,SAAS,CAAC,6BAA6B,CAAC;QAC9D,MAAM,EACJ,eAAe,EAAE,gBAAgB,EACjC,uBAAuB,EACvB,YAAY,EAAE,oBAAoB,EAClC,qBAAqB,EAAE,qBAAqB,EAC5C,aAAa,EAAE,qBAAqB,GACrC,GAAG,MAAM,oBAAoB,CAC5B,QAAQ,EACR,MAAM,CAAC,kBAAkB,EAAE,EAC3B,CAAC,GAAG,OAAO,EAAE,MAAM,CAAC,EACpB,6BAA6B,CAC9B,CAAC;QACF,qBAAqB,GAAG,qBAAqB,CAAC,MAAM,CAAC,qBAAqB,CAAC,CAAC;QAC5E,aAAa,GAAG,CAAC,GAAG,aAAa,EAAE,GAAG,qBAAqB,CAAC,CAAC;QAC7D,YAAY,IAAI,oBAAoB,CAAC;QACrC,8GAA8G;QAC9G,YAAY,GAAG,YAAY,IAAI,uBAAuB,CAAC;QAEvD,IAAI,SAAqC,CAAC;QAC1C,IAAI,SAAS,CAAC,aAAa,EAAE,CAAC;YAC5B,aAAa,GAAG,CAAC,GAAG,aAAa,EAAE,GAAG,CAAC,SAAS,CAAC,aAAa,IAAI,EAAE,CAAC,CAAC,CAAC;YACvE,MAAM,kBAAkB,GAAG,SAAS,CAAC,YAAY,IAAI,CAAC,CAAC;YACvD,YAAY,IAAI,kBAAkB,CAAC;YACnC,wCAAwC;YACxC,8EAA8E;YAC9E,4CAA4C;YAC5C,YAAY,GAAG,YAAY,IAAI,CAAC,CAAC,SAAS,CAAC,uBAAuB,CAAC;YACnE,SAAS,GAAG,kBAAkB,CAC5B,MAAM,EACN,gBAAgB,EAChB,uBAAuB,CACxB,CAAC;YACF,qBAAqB,CAAC,IAAI,CAAC;gBACzB,EAAE,EAAE,SAAS,CAAC,QAAQ,CAAC,IAAI;gBAC3B,YAAY,EAAE,kBAAkB;aACjC,CAAC,CAAC;QACL,CAAC;aAAM,IAAI,gBAAgB,CAAC,MAAM,KAAK,CAAC,IAAI,gBAAgB,EAAE,CAAC;YAC7D,qGAAqG;YACrG,SAAS,GAAG,kBAAkB,CAC5B,MAAM,EACN,gBAAgB,EAChB,uBAAuB,CACxB,CAAC;QACJ,CAAC;QAED,IAAI,SAAS;YAAE,iBAAiB,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;IACnD,CAAC;IAED,OAAO;QACL,eAAe,EAAE,iBAAiB;QAClC,uBAAuB,EAAE,YAAY;QACrC,YAAY;QACZ,qBAAqB;QACrB,aAAa;KACd,CAAC;AACJ,CAAC;AAED,SAAS,oBAAoB,CAC3B,gBAAkC,EAClC,WAA+B,EAC/B,MAAe;IAEf,OAAO;QACL,GAAG,gBAAgB;QACnB,eAAe,EAAE,WAAW;QAC5B,MAAM;KACP,CAAC;AACJ,CAAC;AAED,SAAS,kBAAkB,CACzB,MAAsB,EACtB,WAA6B,EAC7B,UAAmB;IAEnB,MAAM,CAAC,GAAG,MAAM,CAAC,gBAAgB,CAC/B,sBAAsB,CAAC,MAAM,CAAC,KAAK,EAAE,WAAW,CAAC,CAClD,CAAC;IACF,CAAC,CAAC,UAAU,GAAG,UAAU,CAAC;IAC1B,OAAO,CAAC,CAAC;AACX,CAAC;AAED,SAAS,sBAAsB,CAC7B,KAAoB,EACpB,WAA6B;IAE7B,QAAQ,KAAK,CAAC,WAAW,EAAE,CAAC;QAC1B,KAAK,mBAAmB,CAAC,SAAS;YAChC,OAAO,EAAE,GAAG,KAAK,EAAE,CAAC;QACtB,KAAK,mBAAmB,CAAC,KAAK;YAC5B,OAAO;gBACL,WAAW,EAAE,mBAAmB,CAAC,KAAK;gBACtC,aAAa,EAAE,KAAK,CAAC,aAAa;gBAClC,KAAK,EAAE,WAAW;aACnB,CAAC;QACJ,KAAK,mBAAmB,CAAC,MAAM;YAC7B,MAAM,OAAO,GAAuC,EAAE,CAAC;YACvD,WAAW,CAAC,OAAO,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC,OAAO,CAAC,KAAK,CAAC,QAAQ,CAAC,IAAI,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC;YACvE,OAAO;gBACL,WAAW,EAAE,mBAAmB,CAAC,MAAM;gBACvC,OAAO;aACR,CAAC;IACN,CAAC;AACH,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 *--------------------------------------------------------------------------------------------*/\n/** @packageDocumentation\n * @module PropertyGrid\n */\n\nimport type { PropertyRecord, PropertyValue } from \"@itwin/appui-abstract\";\nimport { PropertyValueFormat } from \"@itwin/appui-abstract\";\nimport type { IDisposable } from \"@itwin/core-bentley\";\nimport type { HighlightInfo } from \"../../common/HighlightingComponentProps.js\";\nimport type { CategoryRecordsDict } from \"../internal/flat-items/MutableGridCategory.js\";\nimport type {\n  IPropertyDataProvider,\n  PropertyCategory,\n  PropertyData,\n} from \"../PropertyDataProvider.js\";\nimport { PropertyDataChangeEvent } from \"../PropertyDataProvider.js\";\nimport type {\n  FilteredType,\n  IPropertyDataFilterer,\n  PropertyDataFilterResult,\n} from \"./filterers/PropertyDataFiltererBase.js\";\n\ninterface FilteredRecords {\n  filteredRecords: PropertyRecord[];\n  shouldExpandNodeParents: boolean;\n  matchesCount: number;\n  activeMatch?: HighlightInfo;\n  filteredResultMatches: { id: string; matchesCount: number }[];\n  filteredTypes: FilteredType[];\n}\n\n/**\n * Data returned by [[FilteringPropertyDataProvider]]\n * @public\n */\nexport interface FilteredPropertyData extends PropertyData {\n  /**\n   * Shows how many matches were found when filtering data.\n   * `undefined` when filterer is not active\n   */\n  matchesCount?: number;\n\n  /**\n   * Function used for getting [[HighlightInfo]] by index from all the filtered matches.\n   * `undefined` when filterer is not active\n   */\n  getMatchByIndex?: (index: number) => HighlightInfo | undefined;\n\n  /** Types of objects that were used for filtering. */\n  filteredTypes?: FilteredType[];\n}\n\n/**\n * [[IPropertyDataProvider]] implementation which filters wrapped provider [[PropertyData]] using passed [[IPropertyDataFilterer]].\n * @public\n */\nexport class FilteringPropertyDataProvider\n  implements IPropertyDataProvider, IDisposable\n{\n  public onDataChanged = new PropertyDataChangeEvent();\n  private _filteredPropertyData: Promise<FilteredPropertyData> | undefined =\n    undefined;\n  private _disposeFilterChangedListener: Function;\n  private _disposeDataChangedListener: Function;\n\n  public constructor(\n    private _dataProvider: IPropertyDataProvider,\n    private _filterer: IPropertyDataFilterer\n  ) {\n    this._disposeFilterChangedListener =\n      this._filterer.onFilterChanged.addListener(() => {\n        this._filteredPropertyData = undefined;\n        this.onDataChanged.raiseEvent();\n      });\n    this._disposeDataChangedListener =\n      this._dataProvider.onDataChanged.addListener(() => {\n        this._filteredPropertyData = undefined;\n        this.onDataChanged.raiseEvent();\n      });\n  }\n\n  public dispose(): void {\n    this._disposeDataChangedListener();\n    this._disposeFilterChangedListener();\n  }\n\n  public async getData(): Promise<FilteredPropertyData> {\n    if (this._filteredPropertyData) {\n      return this._filteredPropertyData;\n    }\n\n    this._filteredPropertyData = this._dataProvider\n      .getData()\n      .then(async (propertyData) => {\n        return this._filterer.isActive\n          ? this.filterPropertyData(propertyData)\n          : propertyData;\n      });\n\n    return this._filteredPropertyData;\n  }\n\n  private async filterPropertyData(propertyData: PropertyData) {\n    const { categories, records, label, description } = { ...propertyData };\n    const {\n      filteredCategories,\n      filteredRecords,\n      matchesCount,\n      filteredResultMatches,\n      filteredTypes,\n    } = await matchHierarchy(this._filterer, categories, records, undefined);\n\n    const uniqueTypes = [...new Set(filteredTypes)];\n    const getMatchByIndex = (index: number) => {\n      let activeMatch: HighlightInfo | undefined;\n      if (index <= 0) return undefined;\n\n      let i = 1;\n      for (const record of filteredResultMatches) {\n        const fullMatchesCount = record.matchesCount;\n        if (index < i + fullMatchesCount) {\n          activeMatch = {\n            highlightedItemIdentifier: record.id,\n            highlightIndex: index - i,\n          };\n          break;\n        }\n\n        i += fullMatchesCount;\n      }\n      return activeMatch;\n    };\n\n    return {\n      label,\n      description,\n      categories: filteredCategories,\n      records: filteredRecords,\n      reusePropertyDataState: false,\n      matchesCount,\n      getMatchByIndex,\n      filteredTypes: uniqueTypes,\n    };\n  }\n}\n\nasync function matchHierarchy(\n  filterer: IPropertyDataFilterer,\n  categories: PropertyCategory[],\n  records: CategoryRecordsDict,\n  newRecords?: CategoryRecordsDict,\n  parentMatchInfo?: PropertyDataFilterResult\n) {\n  const newCategories: PropertyCategory[] = [];\n  newRecords = newRecords ?? {};\n  let matchesCount = 0;\n  let allFilteredResultMatches: { id: string; matchesCount: number }[] = [];\n  let allFilteredTypes: FilteredType[] = [];\n\n  for (const category of categories) {\n    const matchInfo = await filterer.categoryMatchesFilter(category, []);\n\n    if (matchInfo.matchesFilter) {\n      allFilteredResultMatches.push({\n        id: category.name,\n        matchesCount: matchInfo.matchesCount ?? 0,\n      });\n      allFilteredTypes = allFilteredTypes.concat(matchInfo.filteredTypes ?? []);\n      matchesCount += matchInfo.matchesCount ?? 0;\n    }\n\n    const childRecords = records[category.name] ?? [];\n    const {\n      filteredRecords,\n      matchesCount: count,\n      filteredResultMatches,\n      filteredTypes,\n    } = await matchRecordHierarchy(filterer, childRecords, []);\n    allFilteredResultMatches = allFilteredResultMatches.concat(\n      filteredResultMatches\n    );\n    allFilteredTypes = allFilteredTypes.concat(filteredTypes);\n    matchesCount += count;\n\n    const parentInfo = parentMatchInfo?.matchesFilter\n      ? parentMatchInfo\n      : matchInfo;\n\n    const childCategories = category.childCategories ?? [];\n    const {\n      filteredCategories,\n      matchesCount: childCount,\n      filteredResultMatches: childFilteredResultMatches,\n      filteredTypes: childFilteredTypes,\n    } = await matchHierarchy(\n      filterer,\n      childCategories,\n      records,\n      newRecords,\n      parentInfo\n    );\n    allFilteredResultMatches = allFilteredResultMatches.concat(\n      childFilteredResultMatches\n    );\n    allFilteredTypes = allFilteredTypes.concat(childFilteredTypes);\n    matchesCount += childCount;\n\n    let expand = !(count === 0 && childCount === 0);\n    if (\n      matchInfo.matchesFilter ||\n      (parentMatchInfo?.matchesFilter &&\n        parentMatchInfo.shouldForceIncludeDescendants)\n    ) {\n      newRecords[category.name] = records[category.name];\n      if (matchInfo.matchesFilter) {\n        expand = true;\n      }\n      const newCategory = copyPropertyCategory(\n        category,\n        filteredCategories,\n        expand\n      );\n      newCategories.push(newCategory);\n    }\n\n    if (\n      (filteredRecords.length !== 0 || filteredCategories.length !== 0) &&\n      !matchInfo.matchesFilter &&\n      !(\n        parentMatchInfo?.shouldExpandNodeParents &&\n        parentMatchInfo.matchesFilter\n      )\n    ) {\n      const newCategory = copyPropertyCategory(\n        category,\n        filteredCategories,\n        expand\n      );\n      newRecords[newCategory.name] = filteredRecords;\n      newCategories.push(newCategory);\n    }\n  }\n\n  return {\n    filteredCategories: newCategories,\n    filteredRecords: newRecords,\n    matchesCount,\n    filteredResultMatches: allFilteredResultMatches,\n    filteredTypes: allFilteredTypes,\n  };\n}\n\nasync function matchRecordHierarchy(\n  filterer: IPropertyDataFilterer,\n  records: PropertyRecord[],\n  parents: PropertyRecord[],\n  forceIncludeItem: boolean = false\n): Promise<FilteredRecords> {\n  const newMatchedRecords: PropertyRecord[] = [];\n  let expandParent = false; // property passed back to parent to indicate whether it should be expanded\n  let matchesCount = 0;\n  let filteredResultMatches: { id: string; matchesCount: number }[] = [];\n  let filteredTypes: FilteredType[] = [];\n\n  for (const record of records) {\n    const matchInfo = await filterer.recordMatchesFilter(record, parents);\n    const shouldForceIncludeDescendants =\n      forceIncludeItem || matchInfo.shouldForceIncludeDescendants;\n    const {\n      filteredRecords: filteredChildren,\n      shouldExpandNodeParents,\n      matchesCount: childrenMatchesCount,\n      filteredResultMatches: childrenResultMatches,\n      filteredTypes: childrenFilteredTypes,\n    } = await matchRecordHierarchy(\n      filterer,\n      record.getChildrenRecords(),\n      [...parents, record],\n      shouldForceIncludeDescendants\n    );\n    filteredResultMatches = filteredResultMatches.concat(childrenResultMatches);\n    filteredTypes = [...filteredTypes, ...childrenFilteredTypes];\n    matchesCount += childrenMatchesCount;\n    // if child hierarchy indicates parents should be expanded, then it should be passed back up to the top parent\n    expandParent = expandParent || shouldExpandNodeParents;\n\n    let newRecord: PropertyRecord | undefined;\n    if (matchInfo.matchesFilter) {\n      filteredTypes = [...filteredTypes, ...(matchInfo.filteredTypes ?? [])];\n      const recordMatchesCount = matchInfo.matchesCount ?? 0;\n      matchesCount += recordMatchesCount;\n      // Item is included if it matches filter\n      // If at least one matched record from records list needs its parent expanded,\n      // then `expandParent` should be set to true\n      expandParent = expandParent || !!matchInfo.shouldExpandNodeParents;\n      newRecord = copyPropertyRecord(\n        record,\n        filteredChildren,\n        shouldExpandNodeParents\n      );\n      filteredResultMatches.push({\n        id: newRecord.property.name,\n        matchesCount: recordMatchesCount,\n      });\n    } else if (filteredChildren.length !== 0 || forceIncludeItem) {\n      // Item is also included if it has at least one matched child or is forcefully included by its parent\n      newRecord = copyPropertyRecord(\n        record,\n        filteredChildren,\n        shouldExpandNodeParents\n      );\n    }\n\n    if (newRecord) newMatchedRecords.push(newRecord);\n  }\n\n  return {\n    filteredRecords: newMatchedRecords,\n    shouldExpandNodeParents: expandParent,\n    matchesCount,\n    filteredResultMatches,\n    filteredTypes,\n  };\n}\n\nfunction copyPropertyCategory(\n  propertyCategory: PropertyCategory,\n  newChildren: PropertyCategory[],\n  expand: boolean\n): PropertyCategory {\n  return {\n    ...propertyCategory,\n    childCategories: newChildren,\n    expand,\n  };\n}\n\nfunction copyPropertyRecord(\n  record: PropertyRecord,\n  newChildren: PropertyRecord[],\n  autoExpand: boolean\n) {\n  const r = record.copyWithNewValue(\n    createNewPropertyValue(record.value, newChildren)\n  );\n  r.autoExpand = autoExpand;\n  return r;\n}\n\nfunction createNewPropertyValue(\n  value: PropertyValue,\n  newChildren: PropertyRecord[]\n): PropertyValue {\n  switch (value.valueFormat) {\n    case PropertyValueFormat.Primitive:\n      return { ...value };\n    case PropertyValueFormat.Array:\n      return {\n        valueFormat: PropertyValueFormat.Array,\n        itemsTypeName: value.itemsTypeName,\n        items: newChildren,\n      };\n    case PropertyValueFormat.Struct:\n      const members: { [name: string]: PropertyRecord } = {};\n      newChildren.forEach((child) => (members[child.property.name] = child));\n      return {\n        valueFormat: PropertyValueFormat.Struct,\n        members,\n      };\n  }\n}\n"]}

package/lib/components-react/propertygrid/dataproviders/filterers/CompositePropertyDataFilterer.d.ts

@@ -0,0 +1,30 @@
+/** @packageDocumentation
+ * @module PropertyGrid
+ */
+import type { PropertyRecord } from "@itwin/appui-abstract";
+import type { PropertyCategory } from "../../PropertyDataProvider.js";
+import type { IPropertyDataFilterer, PropertyDataFilterResult } from "./PropertyDataFiltererBase.js";
+import { PropertyDataFiltererBase } from "./PropertyDataFiltererBase.js";
+/**
+ * Logical operator for composite filterer.
+ * @public
+ */
+export declare enum CompositeFilterType {
+    And = 0,
+    Or = 1
+}
+/**
+ * Composite PropertyData filter which can join two filters using logic operators
+ * @public
+ */
+export declare class CompositePropertyDataFilterer extends PropertyDataFiltererBase {
+    private _leftFilterer;
+    private _operator;
+    private _rightFilterer;
+    constructor(_leftFilterer: IPropertyDataFilterer, _operator: CompositeFilterType, _rightFilterer: IPropertyDataFilterer);
+    get isActive(): boolean;
+    recordMatchesFilter(node: PropertyRecord, parents: PropertyRecord[]): Promise<PropertyDataFilterResult>;
+    categoryMatchesFilter(node: PropertyCategory, parents: PropertyCategory[]): Promise<PropertyDataFilterResult>;
+    private getFiltererResult;
+}
+//# sourceMappingURL=CompositePropertyDataFilterer.d.ts.map

package/lib/components-react/propertygrid/dataproviders/filterers/CompositePropertyDataFilterer.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"CompositePropertyDataFilterer.d.ts","sourceRoot":"","sources":["../../../../../src/components-react/propertygrid/dataproviders/filterers/CompositePropertyDataFilterer.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,uBAAuB,CAAC;AAC5D,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,+BAA+B,CAAC;AACtE,OAAO,KAAK,EAEV,qBAAqB,EACrB,wBAAwB,EACzB,MAAM,+BAA+B,CAAC;AACvC,OAAO,EAAE,wBAAwB,EAAE,MAAM,+BAA+B,CAAC;AAEzE;;;GAGG;AACH,oBAAY,mBAAmB;IAC7B,GAAG,IAAA;IACH,EAAE,IAAA;CACH;AAED;;;GAGG;AACH,qBAAa,6BAA8B,SAAQ,wBAAwB;IAEvE,OAAO,CAAC,aAAa;IACrB,OAAO,CAAC,SAAS;IACjB,OAAO,CAAC,cAAc;gBAFd,aAAa,EAAE,qBAAqB,EACpC,SAAS,EAAE,mBAAmB,EAC9B,cAAc,EAAE,qBAAqB;IAW/C,IAAW,QAAQ,YAElB;IAEY,mBAAmB,CAC9B,IAAI,EAAE,cAAc,EACpB,OAAO,EAAE,cAAc,EAAE,GACxB,OAAO,CAAC,wBAAwB,CAAC;IASvB,qBAAqB,CAChC,IAAI,EAAE,gBAAgB,EACtB,OAAO,EAAE,gBAAgB,EAAE,GAC1B,OAAO,CAAC,wBAAwB,CAAC;IASpC,OAAO,CAAC,iBAAiB;CAyB1B"}

package/lib/components-react/propertygrid/dataproviders/filterers/CompositePropertyDataFilterer.js

@@ -0,0 +1,74 @@
+/*---------------------------------------------------------------------------------------------
+ * Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+ * See LICENSE.md in the project root for license terms and full copyright notice.
+ *--------------------------------------------------------------------------------------------*/
+/** @packageDocumentation
+ * @module PropertyGrid
+ */
+import { PropertyDataFiltererBase } from "./PropertyDataFiltererBase.js";
+/**
+ * Logical operator for composite filterer.
+ * @public
+ */
+export var CompositeFilterType;
+(function (CompositeFilterType) {
+    CompositeFilterType[CompositeFilterType["And"] = 0] = "And";
+    CompositeFilterType[CompositeFilterType["Or"] = 1] = "Or";
+})(CompositeFilterType || (CompositeFilterType = {}));
+/**
+ * Composite PropertyData filter which can join two filters using logic operators
+ * @public
+ */
+export class CompositePropertyDataFilterer extends PropertyDataFiltererBase {
+    constructor(_leftFilterer, _operator, _rightFilterer) {
+        super();
+        this._leftFilterer = _leftFilterer;
+        this._operator = _operator;
+        this._rightFilterer = _rightFilterer;
+        this._leftFilterer.onFilterChanged.addListener(() => this.onFilterChanged.raiseEvent());
+        this._rightFilterer.onFilterChanged.addListener(() => this.onFilterChanged.raiseEvent());
+    }
+    get isActive() {
+        return this._leftFilterer.isActive || this._rightFilterer.isActive;
+    }
+    async recordMatchesFilter(node, parents) {
+        const [lhs, rhs] = await Promise.all([
+            this._leftFilterer.recordMatchesFilter(node, parents),
+            this._rightFilterer.recordMatchesFilter(node, parents),
+        ]);
+        return this.getFiltererResult(lhs, rhs);
+    }
+    async categoryMatchesFilter(node, parents) {
+        const [lhs, rhs] = await Promise.all([
+            this._leftFilterer.categoryMatchesFilter(node, parents),
+            this._rightFilterer.categoryMatchesFilter(node, parents),
+        ]);
+        return this.getFiltererResult(lhs, rhs);
+    }
+    getFiltererResult(lhs, rhs) {
+        const matchesFilter = this._operator === CompositeFilterType.And
+            ? lhs.matchesFilter && rhs.matchesFilter
+            : lhs.matchesFilter || rhs.matchesFilter;
+        if (!matchesFilter)
+            return { matchesFilter: false };
+        const filteredTypes = joinNullableArrays(lhs.matchesFilter ? lhs.filteredTypes : undefined, rhs.matchesFilter ? rhs.filteredTypes : undefined);
+        return {
+            matchesFilter: true,
+            shouldExpandNodeParents: lhs.shouldExpandNodeParents || rhs.shouldExpandNodeParents,
+            shouldForceIncludeDescendants: lhs.shouldForceIncludeDescendants || rhs.shouldForceIncludeDescendants,
+            matchesCount: sumNullableNumbers(lhs.matchesCount, rhs.matchesCount),
+            filteredTypes,
+        };
+    }
+}
+function sumNullableNumbers(lhs, rhs) {
+    if (undefined === lhs && undefined === rhs)
+        return undefined;
+    return (lhs ?? 0) + (rhs ?? 0);
+}
+function joinNullableArrays(lhs, rhs) {
+    if (undefined === lhs && undefined === rhs)
+        return undefined;
+    return [...(lhs ?? []), ...(rhs ?? [])];
+}
+//# sourceMappingURL=CompositePropertyDataFilterer.js.map

package/lib/components-react/propertygrid/dataproviders/filterers/CompositePropertyDataFilterer.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"CompositePropertyDataFilterer.js","sourceRoot":"","sources":["../../../../../src/components-react/propertygrid/dataproviders/filterers/CompositePropertyDataFilterer.ts"],"names":[],"mappings":"AAAA;;;gGAGgG;AAChG;;GAEG;AASH,OAAO,EAAE,wBAAwB,EAAE,MAAM,+BAA+B,CAAC;AAEzE;;;GAGG;AACH,MAAM,CAAN,IAAY,mBAGX;AAHD,WAAY,mBAAmB;IAC7B,2DAAG,CAAA;IACH,yDAAE,CAAA;AACJ,CAAC,EAHW,mBAAmB,KAAnB,mBAAmB,QAG9B;AAED;;;GAGG;AACH,MAAM,OAAO,6BAA8B,SAAQ,wBAAwB;IACzE,YACU,aAAoC,EACpC,SAA8B,EAC9B,cAAqC;QAE7C,KAAK,EAAE,CAAC;QAJA,kBAAa,GAAb,aAAa,CAAuB;QACpC,cAAS,GAAT,SAAS,CAAqB;QAC9B,mBAAc,GAAd,cAAc,CAAuB;QAG7C,IAAI,CAAC,aAAa,CAAC,eAAe,CAAC,WAAW,CAAC,GAAG,EAAE,CAClD,IAAI,CAAC,eAAe,CAAC,UAAU,EAAE,CAClC,CAAC;QACF,IAAI,CAAC,cAAc,CAAC,eAAe,CAAC,WAAW,CAAC,GAAG,EAAE,CACnD,IAAI,CAAC,eAAe,CAAC,UAAU,EAAE,CAClC,CAAC;IACJ,CAAC;IAED,IAAW,QAAQ;QACjB,OAAO,IAAI,CAAC,aAAa,CAAC,QAAQ,IAAI,IAAI,CAAC,cAAc,CAAC,QAAQ,CAAC;IACrE,CAAC;IAEM,KAAK,CAAC,mBAAmB,CAC9B,IAAoB,EACpB,OAAyB;QAEzB,MAAM,CAAC,GAAG,EAAE,GAAG,CAAC,GAAG,MAAM,OAAO,CAAC,GAAG,CAAC;YACnC,IAAI,CAAC,aAAa,CAAC,mBAAmB,CAAC,IAAI,EAAE,OAAO,CAAC;YACrD,IAAI,CAAC,cAAc,CAAC,mBAAmB,CAAC,IAAI,EAAE,OAAO,CAAC;SACvD,CAAC,CAAC;QAEH,OAAO,IAAI,CAAC,iBAAiB,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC;IAC1C,CAAC;IAEM,KAAK,CAAC,qBAAqB,CAChC,IAAsB,EACtB,OAA2B;QAE3B,MAAM,CAAC,GAAG,EAAE,GAAG,CAAC,GAAG,MAAM,OAAO,CAAC,GAAG,CAAC;YACnC,IAAI,CAAC,aAAa,CAAC,qBAAqB,CAAC,IAAI,EAAE,OAAO,CAAC;YACvD,IAAI,CAAC,cAAc,CAAC,qBAAqB,CAAC,IAAI,EAAE,OAAO,CAAC;SACzD,CAAC,CAAC;QAEH,OAAO,IAAI,CAAC,iBAAiB,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC;IAC1C,CAAC;IAEO,iBAAiB,CACvB,GAA6B,EAC7B,GAA6B;QAE7B,MAAM,aAAa,GACjB,IAAI,CAAC,SAAS,KAAK,mBAAmB,CAAC,GAAG;YACxC,CAAC,CAAC,GAAG,CAAC,aAAa,IAAI,GAAG,CAAC,aAAa;YACxC,CAAC,CAAC,GAAG,CAAC,aAAa,IAAI,GAAG,CAAC,aAAa,CAAC;QAC7C,IAAI,CAAC,aAAa;YAAE,OAAO,EAAE,aAAa,EAAE,KAAK,EAAE,CAAC;QAEpD,MAAM,aAAa,GAAG,kBAAkB,CACtC,GAAG,CAAC,aAAa,CAAC,CAAC,CAAC,GAAG,CAAC,aAAa,CAAC,CAAC,CAAC,SAAS,EACjD,GAAG,CAAC,aAAa,CAAC,CAAC,CAAC,GAAG,CAAC,aAAa,CAAC,CAAC,CAAC,SAAS,CAClD,CAAC;QAEF,OAAO;YACL,aAAa,EAAE,IAAI;YACnB,uBAAuB,EACrB,GAAG,CAAC,uBAAuB,IAAI,GAAG,CAAC,uBAAuB;YAC5D,6BAA6B,EAC3B,GAAG,CAAC,6BAA6B,IAAI,GAAG,CAAC,6BAA6B;YACxE,YAAY,EAAE,kBAAkB,CAAC,GAAG,CAAC,YAAY,EAAE,GAAG,CAAC,YAAY,CAAC;YACpE,aAAa;SACd,CAAC;IACJ,CAAC;CACF;AAED,SAAS,kBAAkB,CAAC,GAAuB,EAAE,GAAuB;IAC1E,IAAI,SAAS,KAAK,GAAG,IAAI,SAAS,KAAK,GAAG;QAAE,OAAO,SAAS,CAAC;IAC7D,OAAO,CAAC,GAAG,IAAI,CAAC,CAAC,GAAG,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC;AACjC,CAAC;AAED,SAAS,kBAAkB,CACzB,GAA+B,EAC/B,GAA+B;IAE/B,IAAI,SAAS,KAAK,GAAG,IAAI,SAAS,KAAK,GAAG;QAAE,OAAO,SAAS,CAAC;IAC7D,OAAO,CAAC,GAAG,CAAC,GAAG,IAAI,EAAE,CAAC,EAAE,GAAG,CAAC,GAAG,IAAI,EAAE,CAAC,CAAC,CAAC;AAC1C,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 *--------------------------------------------------------------------------------------------*/\n/** @packageDocumentation\n * @module PropertyGrid\n */\n\nimport type { PropertyRecord } from \"@itwin/appui-abstract\";\nimport type { PropertyCategory } from \"../../PropertyDataProvider.js\";\nimport type {\n  FilteredType,\n  IPropertyDataFilterer,\n  PropertyDataFilterResult,\n} from \"./PropertyDataFiltererBase.js\";\nimport { PropertyDataFiltererBase } from \"./PropertyDataFiltererBase.js\";\n\n/**\n * Logical operator for composite filterer.\n * @public\n */\nexport enum CompositeFilterType {\n  And,\n  Or,\n}\n\n/**\n * Composite PropertyData filter which can join two filters using logic operators\n * @public\n */\nexport class CompositePropertyDataFilterer extends PropertyDataFiltererBase {\n  public constructor(\n    private _leftFilterer: IPropertyDataFilterer,\n    private _operator: CompositeFilterType,\n    private _rightFilterer: IPropertyDataFilterer\n  ) {\n    super();\n    this._leftFilterer.onFilterChanged.addListener(() =>\n      this.onFilterChanged.raiseEvent()\n    );\n    this._rightFilterer.onFilterChanged.addListener(() =>\n      this.onFilterChanged.raiseEvent()\n    );\n  }\n\n  public get isActive() {\n    return this._leftFilterer.isActive || this._rightFilterer.isActive;\n  }\n\n  public async recordMatchesFilter(\n    node: PropertyRecord,\n    parents: PropertyRecord[]\n  ): Promise<PropertyDataFilterResult> {\n    const [lhs, rhs] = await Promise.all([\n      this._leftFilterer.recordMatchesFilter(node, parents),\n      this._rightFilterer.recordMatchesFilter(node, parents),\n    ]);\n\n    return this.getFiltererResult(lhs, rhs);\n  }\n\n  public async categoryMatchesFilter(\n    node: PropertyCategory,\n    parents: PropertyCategory[]\n  ): Promise<PropertyDataFilterResult> {\n    const [lhs, rhs] = await Promise.all([\n      this._leftFilterer.categoryMatchesFilter(node, parents),\n      this._rightFilterer.categoryMatchesFilter(node, parents),\n    ]);\n\n    return this.getFiltererResult(lhs, rhs);\n  }\n\n  private getFiltererResult(\n    lhs: PropertyDataFilterResult,\n    rhs: PropertyDataFilterResult\n  ) {\n    const matchesFilter =\n      this._operator === CompositeFilterType.And\n        ? lhs.matchesFilter && rhs.matchesFilter\n        : lhs.matchesFilter || rhs.matchesFilter;\n    if (!matchesFilter) return { matchesFilter: false };\n\n    const filteredTypes = joinNullableArrays(\n      lhs.matchesFilter ? lhs.filteredTypes : undefined,\n      rhs.matchesFilter ? rhs.filteredTypes : undefined\n    );\n\n    return {\n      matchesFilter: true,\n      shouldExpandNodeParents:\n        lhs.shouldExpandNodeParents || rhs.shouldExpandNodeParents,\n      shouldForceIncludeDescendants:\n        lhs.shouldForceIncludeDescendants || rhs.shouldForceIncludeDescendants,\n      matchesCount: sumNullableNumbers(lhs.matchesCount, rhs.matchesCount),\n      filteredTypes,\n    };\n  }\n}\n\nfunction sumNullableNumbers(lhs: number | undefined, rhs: number | undefined) {\n  if (undefined === lhs && undefined === rhs) return undefined;\n  return (lhs ?? 0) + (rhs ?? 0);\n}\n\nfunction joinNullableArrays(\n  lhs: FilteredType[] | undefined,\n  rhs: FilteredType[] | undefined\n) {\n  if (undefined === lhs && undefined === rhs) return undefined;\n  return [...(lhs ?? []), ...(rhs ?? [])];\n}\n"]}

package/lib/components-react/propertygrid/dataproviders/filterers/DisplayValuePropertyDataFilterer.d.ts

@@ -0,0 +1,19 @@
+/** @packageDocumentation
+ * @module PropertyGrid
+ */
+import type { PropertyRecord } from "@itwin/appui-abstract";
+import type { PropertyDataFilterResult } from "./PropertyDataFiltererBase.js";
+import { PropertyRecordDataFiltererBase } from "./PropertyDataFiltererBase.js";
+/**
+ * Property data filterer which matches on Primitive Property Record display value text.
+ * @public
+ */
+export declare class DisplayValuePropertyDataFilterer extends PropertyRecordDataFiltererBase {
+    private _filterText;
+    constructor(filterText?: string);
+    get filterText(): string;
+    set filterText(value: string);
+    get isActive(): boolean;
+    recordMatchesFilter(node: PropertyRecord): Promise<PropertyDataFilterResult>;
+}
+//# sourceMappingURL=DisplayValuePropertyDataFilterer.d.ts.map

package/lib/components-react/propertygrid/dataproviders/filterers/DisplayValuePropertyDataFilterer.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"DisplayValuePropertyDataFilterer.d.ts","sourceRoot":"","sources":["../../../../../src/components-react/propertygrid/dataproviders/filterers/DisplayValuePropertyDataFilterer.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,uBAAuB,CAAC;AAG5D,OAAO,KAAK,EAAE,wBAAwB,EAAE,MAAM,+BAA+B,CAAC;AAC9E,OAAO,EAEL,8BAA8B,EAC/B,MAAM,+BAA+B,CAAC;AAEvC;;;GAGG;AACH,qBAAa,gCAAiC,SAAQ,8BAA8B;IAClF,OAAO,CAAC,WAAW,CAAc;gBAEd,UAAU,GAAE,MAAW;IAK1C,IAAW,UAAU,IAAI,MAAM,CAE9B;IAED,IAAW,UAAU,CAAC,KAAK,EAAE,MAAM,EAMlC;IAED,IAAW,QAAQ,YAElB;IAEY,mBAAmB,CAC9B,IAAI,EAAE,cAAc,GACnB,OAAO,CAAC,wBAAwB,CAAC;CAkBrC"}