@itwin/components-react 4.17.6 → 5.0.0-dev.3

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

@@ -0,0 +1,49 @@
+/*---------------------------------------------------------------------------------------------
+ * 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 { countMatchesInString } from "../../../common/countMatchesInString.js";
+import { FilteredType, PropertyRecordDataFiltererBase, } from "./PropertyDataFiltererBase.js";
+/**
+ * PropertyData filter which matches on any record type label and includes descendant nodes on match
+ * @public
+ */
+export class LabelPropertyDataFilterer extends PropertyRecordDataFiltererBase {
+    constructor(filterText = "") {
+        super();
+        this._filterText = "";
+        this._filterText = filterText.toLowerCase().trim();
+    }
+    get filterText() {
+        return this._filterText;
+    }
+    set filterText(value) {
+        const lowerValue = value.toLowerCase().trim();
+        if (lowerValue !== this.filterText) {
+            this._filterText = lowerValue;
+            this.onFilterChanged.raiseEvent();
+        }
+    }
+    get isActive() {
+        return this.filterText !== "";
+    }
+    async recordMatchesFilter(node) {
+        if (!this.isActive)
+            return { matchesFilter: true };
+        const displayLabel = node.property.displayLabel.toLowerCase();
+        const matchesCount = countMatchesInString(displayLabel, this.filterText);
+        if (matchesCount === 0)
+            return { matchesFilter: false };
+        return {
+            matchesFilter: true,
+            shouldExpandNodeParents: true,
+            shouldForceIncludeDescendants: true,
+            matchesCount,
+            filteredTypes: [FilteredType.Label],
+        };
+    }
+}
+//# sourceMappingURL=LabelPropertyDataFilterer.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"LabelPropertyDataFilterer.js","sourceRoot":"","sources":["../../../../../src/components-react/propertygrid/dataproviders/filterers/LabelPropertyDataFilterer.ts"],"names":[],"mappings":"AAAA;;;gGAGgG;AAChG;;GAEG;AAGH,OAAO,EAAE,oBAAoB,EAAE,MAAM,yCAAyC,CAAC;AAE/E,OAAO,EACL,YAAY,EACZ,8BAA8B,GAC/B,MAAM,+BAA+B,CAAC;AAEvC;;;GAGG;AACH,MAAM,OAAO,yBAA0B,SAAQ,8BAA8B;IAG3E,YAAmB,aAAqB,EAAE;QACxC,KAAK,EAAE,CAAC;QAHF,gBAAW,GAAW,EAAE,CAAC;QAI/B,IAAI,CAAC,WAAW,GAAG,UAAU,CAAC,WAAW,EAAE,CAAC,IAAI,EAAE,CAAC;IACrD,CAAC;IAED,IAAW,UAAU;QACnB,OAAO,IAAI,CAAC,WAAW,CAAC;IAC1B,CAAC;IAED,IAAW,UAAU,CAAC,KAAa;QACjC,MAAM,UAAU,GAAG,KAAK,CAAC,WAAW,EAAE,CAAC,IAAI,EAAE,CAAC;QAC9C,IAAI,UAAU,KAAK,IAAI,CAAC,UAAU,EAAE,CAAC;YACnC,IAAI,CAAC,WAAW,GAAG,UAAU,CAAC;YAC9B,IAAI,CAAC,eAAe,CAAC,UAAU,EAAE,CAAC;QACpC,CAAC;IACH,CAAC;IAED,IAAW,QAAQ;QACjB,OAAO,IAAI,CAAC,UAAU,KAAK,EAAE,CAAC;IAChC,CAAC;IAEM,KAAK,CAAC,mBAAmB,CAC9B,IAAoB;QAEpB,IAAI,CAAC,IAAI,CAAC,QAAQ;YAAE,OAAO,EAAE,aAAa,EAAE,IAAI,EAAE,CAAC;QAEnD,MAAM,YAAY,GAAG,IAAI,CAAC,QAAQ,CAAC,YAAY,CAAC,WAAW,EAAE,CAAC;QAC9D,MAAM,YAAY,GAAG,oBAAoB,CAAC,YAAY,EAAE,IAAI,CAAC,UAAU,CAAC,CAAC;QACzE,IAAI,YAAY,KAAK,CAAC;YAAE,OAAO,EAAE,aAAa,EAAE,KAAK,EAAE,CAAC;QAExD,OAAO;YACL,aAAa,EAAE,IAAI;YACnB,uBAAuB,EAAE,IAAI;YAC7B,6BAA6B,EAAE,IAAI;YACnC,YAAY;YACZ,aAAa,EAAE,CAAC,YAAY,CAAC,KAAK,CAAC;SACpC,CAAC;IACJ,CAAC;CACF","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 { countMatchesInString } from \"../../../common/countMatchesInString.js\";\nimport type { PropertyDataFilterResult } from \"./PropertyDataFiltererBase.js\";\nimport {\n  FilteredType,\n  PropertyRecordDataFiltererBase,\n} from \"./PropertyDataFiltererBase.js\";\n\n/**\n * PropertyData filter which matches on any record type label and includes descendant nodes on match\n * @public\n */\nexport class LabelPropertyDataFilterer extends PropertyRecordDataFiltererBase {\n  private _filterText: string = \"\";\n\n  public constructor(filterText: string = \"\") {\n    super();\n    this._filterText = filterText.toLowerCase().trim();\n  }\n\n  public get filterText(): string {\n    return this._filterText;\n  }\n\n  public set filterText(value: string) {\n    const lowerValue = value.toLowerCase().trim();\n    if (lowerValue !== this.filterText) {\n      this._filterText = lowerValue;\n      this.onFilterChanged.raiseEvent();\n    }\n  }\n\n  public get isActive() {\n    return this.filterText !== \"\";\n  }\n\n  public async recordMatchesFilter(\n    node: PropertyRecord\n  ): Promise<PropertyDataFilterResult> {\n    if (!this.isActive) return { matchesFilter: true };\n\n    const displayLabel = node.property.displayLabel.toLowerCase();\n    const matchesCount = countMatchesInString(displayLabel, this.filterText);\n    if (matchesCount === 0) return { matchesFilter: false };\n\n    return {\n      matchesFilter: true,\n      shouldExpandNodeParents: true,\n      shouldForceIncludeDescendants: true,\n      matchesCount,\n      filteredTypes: [FilteredType.Label],\n    };\n  }\n}\n"]}

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

@@ -0,0 +1,19 @@
+/** @packageDocumentation
+ * @module PropertyGrid
+ */
+import type { PropertyCategory } from "../../PropertyDataProvider.js";
+import type { PropertyDataFilterResult } from "./PropertyDataFiltererBase.js";
+import { PropertyCategoryDataFiltererBase } from "./PropertyDataFiltererBase.js";
+/**
+ * PropertyData filterer which matches on PropertyCategory's label.
+ * @public
+ */
+export declare class PropertyCategoryLabelFilterer extends PropertyCategoryDataFiltererBase {
+    private _filterText;
+    constructor(filterText?: string);
+    get filterText(): string;
+    set filterText(value: string);
+    get isActive(): boolean;
+    categoryMatchesFilter(node: PropertyCategory): Promise<PropertyDataFilterResult>;
+}
+//# sourceMappingURL=PropertyCategoryLabelFilterer.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"PropertyCategoryLabelFilterer.d.ts","sourceRoot":"","sources":["../../../../../src/components-react/propertygrid/dataproviders/filterers/PropertyCategoryLabelFilterer.ts"],"names":[],"mappings":"AAIA;;GAEG;AAGH,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,+BAA+B,CAAC;AACtE,OAAO,KAAK,EAAE,wBAAwB,EAAE,MAAM,+BAA+B,CAAC;AAC9E,OAAO,EAEL,gCAAgC,EACjC,MAAM,+BAA+B,CAAC;AAEvC;;;GAGG;AACH,qBAAa,6BAA8B,SAAQ,gCAAgC;IACjF,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,qBAAqB,CAChC,IAAI,EAAE,gBAAgB,GACrB,OAAO,CAAC,wBAAwB,CAAC;CAgBrC"}

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

@@ -0,0 +1,49 @@
+/*---------------------------------------------------------------------------------------------
+ * 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 { countMatchesInString } from "../../../common/countMatchesInString.js";
+import { FilteredType, PropertyCategoryDataFiltererBase, } from "./PropertyDataFiltererBase.js";
+/**
+ * PropertyData filterer which matches on PropertyCategory's label.
+ * @public
+ */
+export class PropertyCategoryLabelFilterer extends PropertyCategoryDataFiltererBase {
+    constructor(filterText = "") {
+        super();
+        this._filterText = "";
+        this._filterText = filterText.toLowerCase().trim();
+    }
+    get filterText() {
+        return this._filterText;
+    }
+    set filterText(value) {
+        const lowerValue = value.toLowerCase().trim();
+        if (lowerValue !== this.filterText) {
+            this._filterText = lowerValue;
+            this.onFilterChanged.raiseEvent();
+        }
+    }
+    get isActive() {
+        return this.filterText !== "";
+    }
+    async categoryMatchesFilter(node) {
+        if (!this.isActive)
+            return { matchesFilter: true };
+        const displayLabel = node.label.toLowerCase();
+        const matchesCount = countMatchesInString(displayLabel, this.filterText);
+        if (matchesCount === 0)
+            return { matchesFilter: false };
+        return {
+            matchesFilter: true,
+            shouldExpandNodeParents: true,
+            shouldForceIncludeDescendants: true,
+            matchesCount,
+            filteredTypes: [FilteredType.Category],
+        };
+    }
+}
+//# sourceMappingURL=PropertyCategoryLabelFilterer.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"PropertyCategoryLabelFilterer.js","sourceRoot":"","sources":["../../../../../src/components-react/propertygrid/dataproviders/filterers/PropertyCategoryLabelFilterer.ts"],"names":[],"mappings":"AAAA;;;gGAGgG;AAChG;;GAEG;AAEH,OAAO,EAAE,oBAAoB,EAAE,MAAM,yCAAyC,CAAC;AAG/E,OAAO,EACL,YAAY,EACZ,gCAAgC,GACjC,MAAM,+BAA+B,CAAC;AAEvC;;;GAGG;AACH,MAAM,OAAO,6BAA8B,SAAQ,gCAAgC;IAGjF,YAAmB,aAAqB,EAAE;QACxC,KAAK,EAAE,CAAC;QAHF,gBAAW,GAAW,EAAE,CAAC;QAI/B,IAAI,CAAC,WAAW,GAAG,UAAU,CAAC,WAAW,EAAE,CAAC,IAAI,EAAE,CAAC;IACrD,CAAC;IAED,IAAW,UAAU;QACnB,OAAO,IAAI,CAAC,WAAW,CAAC;IAC1B,CAAC;IAED,IAAW,UAAU,CAAC,KAAa;QACjC,MAAM,UAAU,GAAG,KAAK,CAAC,WAAW,EAAE,CAAC,IAAI,EAAE,CAAC;QAC9C,IAAI,UAAU,KAAK,IAAI,CAAC,UAAU,EAAE,CAAC;YACnC,IAAI,CAAC,WAAW,GAAG,UAAU,CAAC;YAC9B,IAAI,CAAC,eAAe,CAAC,UAAU,EAAE,CAAC;QACpC,CAAC;IACH,CAAC;IAED,IAAW,QAAQ;QACjB,OAAO,IAAI,CAAC,UAAU,KAAK,EAAE,CAAC;IAChC,CAAC;IAEM,KAAK,CAAC,qBAAqB,CAChC,IAAsB;QAEtB,IAAI,CAAC,IAAI,CAAC,QAAQ;YAAE,OAAO,EAAE,aAAa,EAAE,IAAI,EAAE,CAAC;QAEnD,MAAM,YAAY,GAAG,IAAI,CAAC,KAAK,CAAC,WAAW,EAAE,CAAC;QAC9C,MAAM,YAAY,GAAG,oBAAoB,CAAC,YAAY,EAAE,IAAI,CAAC,UAAU,CAAC,CAAC;QAEzE,IAAI,YAAY,KAAK,CAAC;YAAE,OAAO,EAAE,aAAa,EAAE,KAAK,EAAE,CAAC;QAExD,OAAO;YACL,aAAa,EAAE,IAAI;YACnB,uBAAuB,EAAE,IAAI;YAC7B,6BAA6B,EAAE,IAAI;YACnC,YAAY;YACZ,aAAa,EAAE,CAAC,YAAY,CAAC,QAAQ,CAAC;SACvC,CAAC;IACJ,CAAC;CACF","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 { countMatchesInString } from \"../../../common/countMatchesInString.js\";\nimport type { PropertyCategory } from \"../../PropertyDataProvider.js\";\nimport type { PropertyDataFilterResult } from \"./PropertyDataFiltererBase.js\";\nimport {\n  FilteredType,\n  PropertyCategoryDataFiltererBase,\n} from \"./PropertyDataFiltererBase.js\";\n\n/**\n * PropertyData filterer which matches on PropertyCategory's label.\n * @public\n */\nexport class PropertyCategoryLabelFilterer extends PropertyCategoryDataFiltererBase {\n  private _filterText: string = \"\";\n\n  public constructor(filterText: string = \"\") {\n    super();\n    this._filterText = filterText.toLowerCase().trim();\n  }\n\n  public get filterText(): string {\n    return this._filterText;\n  }\n\n  public set filterText(value: string) {\n    const lowerValue = value.toLowerCase().trim();\n    if (lowerValue !== this.filterText) {\n      this._filterText = lowerValue;\n      this.onFilterChanged.raiseEvent();\n    }\n  }\n\n  public get isActive() {\n    return this.filterText !== \"\";\n  }\n\n  public async categoryMatchesFilter(\n    node: PropertyCategory\n  ): Promise<PropertyDataFilterResult> {\n    if (!this.isActive) return { matchesFilter: true };\n\n    const displayLabel = node.label.toLowerCase();\n    const matchesCount = countMatchesInString(displayLabel, this.filterText);\n\n    if (matchesCount === 0) return { matchesFilter: false };\n\n    return {\n      matchesFilter: true,\n      shouldExpandNodeParents: true,\n      shouldForceIncludeDescendants: true,\n      matchesCount,\n      filteredTypes: [FilteredType.Category],\n    };\n  }\n}\n"]}

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

@@ -0,0 +1,90 @@
+/** @packageDocumentation
+ * @module PropertyGrid
+ */
+import type { PropertyRecord } from "@itwin/appui-abstract";
+import { BeEvent } from "@itwin/core-bentley";
+import type { PropertyCategory } from "../../PropertyDataProvider.js";
+/**
+ * Enumeration of possible component filtered types
+ * @public
+ */
+export declare enum FilteredType {
+    Category = 0,
+    Label = 1,
+    Value = 2
+}
+/**
+ * Data structure for storing [[IPropertyDataFilterer]] matching results
+ * @public
+ */
+export interface PropertyDataFilterResult {
+    /** Indicates whether provided item matched filter */
+    matchesFilter: boolean;
+    /**
+     * Indicates whether descendants nodes should be forcefully included in filtered results.
+     * Can only be true for nodes that have `matchesFilter` set to true.
+     */
+    shouldForceIncludeDescendants?: boolean;
+    /**
+     * Indicates whether parents of node should be expanded up to this match node.
+     * Can only be true for nodes that have `matchesFilter` set to true.
+     */
+    shouldExpandNodeParents?: boolean;
+    /**
+     * Indicates how many times filter was matched in the provided item.
+     */
+    matchesCount?: number;
+    /**
+     * Indicates what item types were matched.
+     */
+    filteredTypes?: FilteredType[];
+}
+/**
+ * A signature for property data change listeners
+ * @public
+ */
+export declare type PropertyFilterChangesListener = () => void;
+/**
+ * An event broadcasted when property filter changes
+ * @public
+ */
+export declare class PropertyFilterChangeEvent extends BeEvent<PropertyFilterChangesListener> {
+}
+/**
+ * An interface for a filterer that filters [[PropertyData]] based on content of [[PropertyRecord]]
+ * and [[PropertyCategory]] objects.
+ * @public
+ */
+export interface IPropertyDataFilterer {
+    readonly isActive: boolean;
+    recordMatchesFilter: (node: PropertyRecord, parents: PropertyRecord[]) => Promise<PropertyDataFilterResult>;
+    categoryMatchesFilter: (node: PropertyCategory, parents: PropertyCategory[]) => Promise<PropertyDataFilterResult>;
+    onFilterChanged: PropertyFilterChangeEvent;
+}
+/**
+ * An abstract implementation of [[IPropertyDataFilterer]] to share common behavior between different implementations.
+ * @public
+ */
+export declare abstract class PropertyDataFiltererBase implements IPropertyDataFilterer {
+    onFilterChanged: PropertyFilterChangeEvent;
+    abstract get isActive(): boolean;
+    abstract recordMatchesFilter(node: PropertyRecord, parents: PropertyRecord[]): Promise<PropertyDataFilterResult>;
+    abstract categoryMatchesFilter(node: PropertyCategory, parents: PropertyCategory[]): Promise<PropertyDataFilterResult>;
+}
+/**
+ * An abstract implementation of [[IPropertyDataFilterer]] that can be used as base for all
+ * filterers that filter based on [[PropertyCategory]] content.
+ * @public
+ */
+export declare abstract class PropertyCategoryDataFiltererBase extends PropertyDataFiltererBase {
+    recordMatchesFilter(): Promise<PropertyDataFilterResult>;
+}
+/**
+ * An abstract implementation of [[IPropertyDataFilterer]] that can be used as base for all
+ * filterers that filter based on [[PropertyRecord]] content.
+ * @public
+ */
+export declare abstract class PropertyRecordDataFiltererBase extends PropertyDataFiltererBase {
+    categoryMatchesFilter(): Promise<PropertyDataFilterResult>;
+}
+//# sourceMappingURL=PropertyDataFiltererBase.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"PropertyDataFiltererBase.d.ts","sourceRoot":"","sources":["../../../../../src/components-react/propertygrid/dataproviders/filterers/PropertyDataFiltererBase.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,uBAAuB,CAAC;AAC5D,OAAO,EAAE,OAAO,EAAE,MAAM,qBAAqB,CAAC;AAC9C,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,+BAA+B,CAAC;AAEtE;;;GAGG;AACH,oBAAY,YAAY;IACtB,QAAQ,IAAA;IACR,KAAK,IAAA;IACL,KAAK,IAAA;CACN;AAED;;;GAGG;AACH,MAAM,WAAW,wBAAwB;IACvC,qDAAqD;IACrD,aAAa,EAAE,OAAO,CAAC;IAEvB;;;OAGG;IACH,6BAA6B,CAAC,EAAE,OAAO,CAAC;IAExC;;;OAGG;IACH,uBAAuB,CAAC,EAAE,OAAO,CAAC;IAElC;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,aAAa,CAAC,EAAE,YAAY,EAAE,CAAC;CAChC;AAED;;;GAGG;AACH,MAAM,CAAC,OAAO,MAAM,6BAA6B,GAAG,MAAM,IAAI,CAAC;AAE/D;;;GAGG;AACH,qBAAa,yBAA0B,SAAQ,OAAO,CAAC,6BAA6B,CAAC;CAAG;AAExF;;;;GAIG;AACH,MAAM,WAAW,qBAAqB;IACpC,QAAQ,CAAC,QAAQ,EAAE,OAAO,CAAC;IAC3B,mBAAmB,EAAE,CACnB,IAAI,EAAE,cAAc,EACpB,OAAO,EAAE,cAAc,EAAE,KACtB,OAAO,CAAC,wBAAwB,CAAC,CAAC;IACvC,qBAAqB,EAAE,CACrB,IAAI,EAAE,gBAAgB,EACtB,OAAO,EAAE,gBAAgB,EAAE,KACxB,OAAO,CAAC,wBAAwB,CAAC,CAAC;IACvC,eAAe,EAAE,yBAAyB,CAAC;CAC5C;AAED;;;GAGG;AACH,8BAAsB,wBACpB,YAAW,qBAAqB;IAEzB,eAAe,EAAE,yBAAyB,CACf;IAClC,aAAoB,QAAQ,IAAI,OAAO,CAAC;aACxB,mBAAmB,CACjC,IAAI,EAAE,cAAc,EACpB,OAAO,EAAE,cAAc,EAAE,GACxB,OAAO,CAAC,wBAAwB,CAAC;aACpB,qBAAqB,CACnC,IAAI,EAAE,gBAAgB,EACtB,OAAO,EAAE,gBAAgB,EAAE,GAC1B,OAAO,CAAC,wBAAwB,CAAC;CACrC;AAED;;;;GAIG;AACH,8BAAsB,gCAAiC,SAAQ,wBAAwB;IACxE,mBAAmB,IAAI,OAAO,CAAC,wBAAwB,CAAC;CAGtE;AAED;;;;GAIG;AACH,8BAAsB,8BAA+B,SAAQ,wBAAwB;IACtE,qBAAqB,IAAI,OAAO,CAAC,wBAAwB,CAAC;CAGxE"}

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

@@ -0,0 +1 @@
+{"version":3,"file":"PropertyDataFiltererBase.js","sourceRoot":"","sources":["../../../../../src/components-react/propertygrid/dataproviders/filterers/PropertyDataFiltererBase.ts"],"names":[],"mappings":"AAAA;;;gGAGgG;AAChG;;GAEG;AAGH,OAAO,EAAE,OAAO,EAAE,MAAM,qBAAqB,CAAC;AAG9C;;;GAGG;AACH,MAAM,CAAN,IAAY,YAIX;AAJD,WAAY,YAAY;IACtB,uDAAQ,CAAA;IACR,iDAAK,CAAA;IACL,iDAAK,CAAA;AACP,CAAC,EAJW,YAAY,KAAZ,YAAY,QAIvB;AAuCD;;;GAGG;AACH,MAAM,OAAO,yBAA0B,SAAQ,OAAsC;CAAG;AAoBxF;;;GAGG;AACH,MAAM,OAAgB,wBAAwB;IAA9C;QAGS,oBAAe,GACpB,IAAI,yBAAyB,EAAE,CAAC;IAUpC,CAAC;CAAA;AAED;;;;GAIG;AACH,MAAM,OAAgB,gCAAiC,SAAQ,wBAAwB;IAC9E,KAAK,CAAC,mBAAmB;QAC9B,OAAO,EAAE,aAAa,EAAE,CAAC,IAAI,CAAC,QAAQ,EAAE,CAAC;IAC3C,CAAC;CACF;AAED;;;;GAIG;AACH,MAAM,OAAgB,8BAA+B,SAAQ,wBAAwB;IAC5E,KAAK,CAAC,qBAAqB;QAChC,OAAO,EAAE,aAAa,EAAE,CAAC,IAAI,CAAC,QAAQ,EAAE,CAAC;IAC3C,CAAC;CACF","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 { BeEvent } from \"@itwin/core-bentley\";\nimport type { PropertyCategory } from \"../../PropertyDataProvider.js\";\n\n/**\n * Enumeration of possible component filtered types\n * @public\n */\nexport enum FilteredType {\n  Category,\n  Label,\n  Value,\n}\n\n/**\n * Data structure for storing [[IPropertyDataFilterer]] matching results\n * @public\n */\nexport interface PropertyDataFilterResult {\n  /** Indicates whether provided item matched filter */\n  matchesFilter: boolean;\n\n  /**\n   * Indicates whether descendants nodes should be forcefully included in filtered results.\n   * Can only be true for nodes that have `matchesFilter` set to true.\n   */\n  shouldForceIncludeDescendants?: boolean;\n\n  /**\n   * Indicates whether parents of node should be expanded up to this match node.\n   * Can only be true for nodes that have `matchesFilter` set to true.\n   */\n  shouldExpandNodeParents?: boolean;\n\n  /**\n   * Indicates how many times filter was matched in the provided item.\n   */\n  matchesCount?: number;\n\n  /**\n   * Indicates what item types were matched.\n   */\n  filteredTypes?: FilteredType[];\n}\n\n/**\n * A signature for property data change listeners\n * @public\n */\nexport declare type PropertyFilterChangesListener = () => void;\n\n/**\n * An event broadcasted when property filter changes\n * @public\n */\nexport class PropertyFilterChangeEvent extends BeEvent<PropertyFilterChangesListener> {}\n\n/**\n * An interface for a filterer that filters [[PropertyData]] based on content of [[PropertyRecord]]\n * and [[PropertyCategory]] objects.\n * @public\n */\nexport interface IPropertyDataFilterer {\n  readonly isActive: boolean;\n  recordMatchesFilter: (\n    node: PropertyRecord,\n    parents: PropertyRecord[]\n  ) => Promise<PropertyDataFilterResult>;\n  categoryMatchesFilter: (\n    node: PropertyCategory,\n    parents: PropertyCategory[]\n  ) => Promise<PropertyDataFilterResult>;\n  onFilterChanged: PropertyFilterChangeEvent;\n}\n\n/**\n * An abstract implementation of [[IPropertyDataFilterer]] to share common behavior between different implementations.\n * @public\n */\nexport abstract class PropertyDataFiltererBase\n  implements IPropertyDataFilterer\n{\n  public onFilterChanged: PropertyFilterChangeEvent =\n    new PropertyFilterChangeEvent();\n  public abstract get isActive(): boolean;\n  public abstract recordMatchesFilter(\n    node: PropertyRecord,\n    parents: PropertyRecord[]\n  ): Promise<PropertyDataFilterResult>;\n  public abstract categoryMatchesFilter(\n    node: PropertyCategory,\n    parents: PropertyCategory[]\n  ): Promise<PropertyDataFilterResult>;\n}\n\n/**\n * An abstract implementation of [[IPropertyDataFilterer]] that can be used as base for all\n * filterers that filter based on [[PropertyCategory]] content.\n * @public\n */\nexport abstract class PropertyCategoryDataFiltererBase extends PropertyDataFiltererBase {\n  public async recordMatchesFilter(): Promise<PropertyDataFilterResult> {\n    return { matchesFilter: !this.isActive };\n  }\n}\n\n/**\n * An abstract implementation of [[IPropertyDataFilterer]] that can be used as base for all\n * filterers that filter based on [[PropertyRecord]] content.\n * @public\n */\nexport abstract class PropertyRecordDataFiltererBase extends PropertyDataFiltererBase {\n  public async categoryMatchesFilter(): Promise<PropertyDataFilterResult> {\n    return { matchesFilter: !this.isActive };\n  }\n}\n"]}

package/lib/components-react/propertygrid/internal/PropertyGridEventHandler.d.ts

@@ -0,0 +1,25 @@
+/** @packageDocumentation
+ * @module PropertyGrid
+ */
+import type { IPropertyGridModelSource } from "./PropertyGridModelSource.js";
+/**
+ * Handles events and changes on PropertyGridModel data.
+ * @public
+ */
+export interface IPropertyGridEventHandler {
+    onExpansionToggled: (selectionKey: string) => void;
+}
+/**
+ * Handles events and changes on PropertyGridModel data.
+ * @public
+ */
+export declare class PropertyGridEventHandler {
+    private _modelSource;
+    constructor(_modelSource: IPropertyGridModelSource);
+    /**
+     * Flips isExpand on item by given selectionKey
+     * @param selectionKey item to be modified
+     */
+    onExpansionToggled: (selectionKey: string) => void;
+}
+//# sourceMappingURL=PropertyGridEventHandler.d.ts.map

package/lib/components-react/propertygrid/internal/PropertyGridEventHandler.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"PropertyGridEventHandler.d.ts","sourceRoot":"","sources":["../../../../src/components-react/propertygrid/internal/PropertyGridEventHandler.ts"],"names":[],"mappings":"AAKA;;GAEG;AACH,OAAO,KAAK,EAAE,wBAAwB,EAAE,MAAM,8BAA8B,CAAC;AAE7E;;;GAGG;AACH,MAAM,WAAW,yBAAyB;IACxC,kBAAkB,EAAE,CAAC,YAAY,EAAE,MAAM,KAAK,IAAI,CAAC;CACpD;AAED;;;GAGG;AACH,qBAAa,wBAAwB;IAChB,OAAO,CAAC,YAAY;gBAAZ,YAAY,EAAE,wBAAwB;IAEjE;;;OAGG;IACI,kBAAkB,iBAAkB,MAAM,UAK/C;CACH"}

package/lib/components-react/propertygrid/internal/PropertyGridEventHandler.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"PropertyGridEventHandler.js","sourceRoot":"","sources":["../../../../src/components-react/propertygrid/internal/PropertyGridEventHandler.ts"],"names":[],"mappings":"AAAA;;;gGAGgG;AAehG;;;GAGG;AACH,MAAM,OAAO,wBAAwB;IACnC,YAA2B,YAAsC;QAAtC,iBAAY,GAAZ,YAAY,CAA0B;QAEjE;;;WAGG;QACI,uBAAkB,GAAG,CAAC,YAAoB,EAAE,EAAE;YACnD,IAAI,CAAC,YAAY,CAAC,WAAW,CAAC,CAAC,UAAU,EAAE,EAAE;gBAC3C,MAAM,IAAI,GAAG,UAAU,CAAC,OAAO,CAAC,YAAY,CAAC,CAAC;gBAC9C,IAAI,CAAC,UAAU,GAAG,CAAC,IAAI,CAAC,UAAU,CAAC;YACrC,CAAC,CAAC,CAAC;QACL,CAAC,CAAC;IAXkE,CAAC;CAYtE","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 */\nimport type { IPropertyGridModelSource } from \"./PropertyGridModelSource.js\";\n\n/**\n * Handles events and changes on PropertyGridModel data.\n * @public\n */\nexport interface IPropertyGridEventHandler {\n  onExpansionToggled: (selectionKey: string) => void;\n}\n\n/**\n * Handles events and changes on PropertyGridModel data.\n * @public\n */\nexport class PropertyGridEventHandler {\n  public constructor(private _modelSource: IPropertyGridModelSource) {}\n\n  /**\n   * Flips isExpand on item by given selectionKey\n   * @param selectionKey item to be modified\n   */\n  public onExpansionToggled = (selectionKey: string) => {\n    this._modelSource.modifyModel((draftModel) => {\n      const item = draftModel.getItem(selectionKey);\n      item.isExpanded = !item.isExpanded;\n    });\n  };\n}\n"]}

package/lib/components-react/propertygrid/internal/PropertyGridHooks.d.ts

@@ -0,0 +1,54 @@
+/** @packageDocumentation
+ * @module PropertyGrid
+ */
+import type { IPropertyDataProvider } from "../PropertyDataProvider.js";
+import { PropertyGridEventHandler } from "./PropertyGridEventHandler.js";
+import type { IPropertyGridModel } from "./PropertyGridModel.js";
+import type { IPropertyGridModelSource } from "./PropertyGridModelSource.js";
+import { PropertyGridModelSource } from "./PropertyGridModelSource.js";
+/**
+ * Custom hook that gets [[PropertyData]] from given [[IPropertyDataProvider]] and subscribes to further data changes.
+ * @throws if/when `IPropertyDataProvider.getData()` promise is rejected. The error is thrown in the React's render loop, so it can be caught using an error boundary.
+ * @public
+ */
+export declare function usePropertyData(props: {
+    dataProvider: IPropertyDataProvider;
+}): {
+    value: import("../PropertyDataProvider.js").PropertyData | undefined;
+    inProgress: boolean;
+};
+/**
+ * Custom hook that creates a [[PropertyGridModelSource]] and subscribes it to data updates from the data provider.
+ * @throws if/when `IPropertyDataProvider.getData()` promise is rejected. The error is thrown in the React's render loop, so it can be caught using an error boundary.
+ * @public
+ * @deprecated in 4.9.0. Use `useTrackedPropertyGridModelSource` instead.
+ */
+export declare function usePropertyGridModelSource(props: {
+    dataProvider: IPropertyDataProvider;
+}): PropertyGridModelSource;
+/**
+ * Custom hook that creates a [[PropertyGridModelSource]] and subscribes it to data updates from the data provider while also providing information on data update progress.
+ * @throws if/when `IPropertyDataProvider.getData()` promise is rejected. The error is thrown in the React's render loop, so it can be caught using an error boundary.
+ * @public
+ */
+export declare function useTrackedPropertyGridModelSource(props: {
+    dataProvider: IPropertyDataProvider;
+}): {
+    modelSource: PropertyGridModelSource;
+    inProgress: boolean;
+};
+/**
+ * Custom hook that creates memoized version of [[PropertyGridEventHandler]] that modifies given modelSource
+ * @public
+ */
+export declare function usePropertyGridEventHandler(props: {
+    modelSource: IPropertyGridModelSource;
+}): PropertyGridEventHandler;
+/**
+ * Custom hook that automatically listens and retrieves latest model from model source
+ * @public
+ */
+export declare function usePropertyGridModel(props: {
+    modelSource: IPropertyGridModelSource;
+}): IPropertyGridModel | undefined;
+//# sourceMappingURL=PropertyGridHooks.d.ts.map

package/lib/components-react/propertygrid/internal/PropertyGridHooks.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"PropertyGridHooks.d.ts","sourceRoot":"","sources":["../../../../src/components-react/propertygrid/internal/PropertyGridHooks.ts"],"names":[],"mappings":"AAIA;;GAEG;AAIH,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,4BAA4B,CAAC;AAExE,OAAO,EAAE,wBAAwB,EAAE,MAAM,+BAA+B,CAAC;AACzE,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,wBAAwB,CAAC;AACjE,OAAO,KAAK,EAAE,wBAAwB,EAAE,MAAM,8BAA8B,CAAC;AAC7E,OAAO,EAAE,uBAAuB,EAAE,MAAM,8BAA8B,CAAC;AAEvE;;;;GAIG;AACH,wBAAgB,eAAe,CAAC,KAAK,EAAE;IACrC,YAAY,EAAE,qBAAqB,CAAC;CACrC;;;EAkBA;AAED;;;;;GAKG;AACH,wBAAgB,0BAA0B,CAAC,KAAK,EAAE;IAChD,YAAY,EAAE,qBAAqB,CAAC;CACrC,2BAgBA;AAED;;;;GAIG;AACH,wBAAgB,iCAAiC,CAAC,KAAK,EAAE;IACvD,YAAY,EAAE,qBAAqB,CAAC;CACrC;;;EAgBA;AAED;;;GAGG;AACH,wBAAgB,2BAA2B,CAAC,KAAK,EAAE;IACjD,WAAW,EAAE,wBAAwB,CAAC;CACvC,4BAKA;AAED;;;GAGG;AACH,wBAAgB,oBAAoB,CAAC,KAAK,EAAE;IAC1C,WAAW,EAAE,wBAAwB,CAAC;CACvC,kCAaA"}

package/lib/components-react/propertygrid/internal/PropertyGridHooks.js

@@ -0,0 +1,91 @@
+/*---------------------------------------------------------------------------------------------
+ * 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 { useCallback, useEffect, useMemo, useReducer, useState } from "react";
+import { useDebouncedAsyncValue } from "../../common/UseDebouncedAsyncValue.js";
+import { MutableGridItemFactory } from "./flat-items/MutableGridItemFactory.js";
+import { PropertyGridEventHandler } from "./PropertyGridEventHandler.js";
+import { PropertyGridModelSource } from "./PropertyGridModelSource.js";
+/**
+ * Custom hook that gets [[PropertyData]] from given [[IPropertyDataProvider]] and subscribes to further data changes.
+ * @throws if/when `IPropertyDataProvider.getData()` promise is rejected. The error is thrown in the React's render loop, so it can be caught using an error boundary.
+ * @public
+ */
+export function usePropertyData(props) {
+    const { dataProvider } = props;
+    const [forcedUpdate, triggerForcedUpdate] = useReducer(() => ({}), {});
+    useEffect(() => {
+        return dataProvider.onDataChanged.addListener(() => {
+            triggerForcedUpdate();
+        });
+    }, [dataProvider]);
+    // forcedUpdate is added to dependency list to re-memo getData promise when onDataChanged emits an event.
+    return useDebouncedAsyncValue(useCallback(async () => dataProvider.getData(), 
+    // eslint-disable-next-line react-hooks/exhaustive-deps
+    [dataProvider, forcedUpdate]));
+}
+/**
+ * Custom hook that creates a [[PropertyGridModelSource]] and subscribes it to data updates from the data provider.
+ * @throws if/when `IPropertyDataProvider.getData()` promise is rejected. The error is thrown in the React's render loop, so it can be caught using an error boundary.
+ * @public
+ * @deprecated in 4.9.0. Use `useTrackedPropertyGridModelSource` instead.
+ */
+export function usePropertyGridModelSource(props) {
+    const { value: propertyData } = usePropertyData(props);
+    const { dataProvider } = { ...props };
+    // Model source needs to be recreated if data provider changes
+    const modelSource = useMemo(() => new PropertyGridModelSource(new MutableGridItemFactory()), 
+    // eslint-disable-next-line react-hooks/exhaustive-deps
+    [dataProvider]);
+    useEffect(() => {
+        if (propertyData)
+            modelSource.setPropertyData(propertyData);
+    }, [modelSource, propertyData]);
+    return modelSource;
+}
+/**
+ * Custom hook that creates a [[PropertyGridModelSource]] and subscribes it to data updates from the data provider while also providing information on data update progress.
+ * @throws if/when `IPropertyDataProvider.getData()` promise is rejected. The error is thrown in the React's render loop, so it can be caught using an error boundary.
+ * @public
+ */
+export function useTrackedPropertyGridModelSource(props) {
+    const { value: propertyData, inProgress } = usePropertyData(props);
+    const { dataProvider } = { ...props };
+    // Model source needs to be recreated if data provider changes
+    const modelSource = useMemo(() => new PropertyGridModelSource(new MutableGridItemFactory()), 
+    // eslint-disable-next-line react-hooks/exhaustive-deps
+    [dataProvider]);
+    useEffect(() => {
+        if (propertyData)
+            modelSource.setPropertyData(propertyData);
+    }, [modelSource, propertyData]);
+    return { modelSource, inProgress };
+}
+/**
+ * Custom hook that creates memoized version of [[PropertyGridEventHandler]] that modifies given modelSource
+ * @public
+ */
+export function usePropertyGridEventHandler(props) {
+    return useMemo(() => new PropertyGridEventHandler(props.modelSource), [props.modelSource]);
+}
+/**
+ * Custom hook that automatically listens and retrieves latest model from model source
+ * @public
+ */
+export function usePropertyGridModel(props) {
+    const { modelSource } = { ...props };
+    const [model, setModel] = useState();
+    useEffect(() => {
+        const modelChanged = () => {
+            setModel(modelSource.getModel());
+        };
+        modelChanged();
+        return modelSource.onModelChanged.addListener(modelChanged);
+    }, [modelSource]);
+    return model;
+}
+//# sourceMappingURL=PropertyGridHooks.js.map

package/lib/components-react/propertygrid/internal/PropertyGridHooks.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"PropertyGridHooks.js","sourceRoot":"","sources":["../../../../src/components-react/propertygrid/internal/PropertyGridHooks.ts"],"names":[],"mappings":"AAAA;;;gGAGgG;AAChG;;GAEG;AAEH,OAAO,EAAE,WAAW,EAAE,SAAS,EAAE,OAAO,EAAE,UAAU,EAAE,QAAQ,EAAE,MAAM,OAAO,CAAC;AAC9E,OAAO,EAAE,sBAAsB,EAAE,MAAM,wCAAwC,CAAC;AAEhF,OAAO,EAAE,sBAAsB,EAAE,MAAM,wCAAwC,CAAC;AAChF,OAAO,EAAE,wBAAwB,EAAE,MAAM,+BAA+B,CAAC;AAGzE,OAAO,EAAE,uBAAuB,EAAE,MAAM,8BAA8B,CAAC;AAEvE;;;;GAIG;AACH,MAAM,UAAU,eAAe,CAAC,KAE/B;IACC,MAAM,EAAE,YAAY,EAAE,GAAG,KAAK,CAAC;IAE/B,MAAM,CAAC,YAAY,EAAE,mBAAmB,CAAC,GAAG,UAAU,CAAC,GAAG,EAAE,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC;IACvE,SAAS,CAAC,GAAG,EAAE;QACb,OAAO,YAAY,CAAC,aAAa,CAAC,WAAW,CAAC,GAAG,EAAE;YACjD,mBAAmB,EAAE,CAAC;QACxB,CAAC,CAAC,CAAC;IACL,CAAC,EAAE,CAAC,YAAY,CAAC,CAAC,CAAC;IAEnB,yGAAyG;IACzG,OAAO,sBAAsB,CAC3B,WAAW,CACT,KAAK,IAAI,EAAE,CAAC,YAAY,CAAC,OAAO,EAAE;IAClC,uDAAuD;IACvD,CAAC,YAAY,EAAE,YAAY,CAAC,CAC7B,CACF,CAAC;AACJ,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,0BAA0B,CAAC,KAE1C;IACC,MAAM,EAAE,KAAK,EAAE,YAAY,EAAE,GAAG,eAAe,CAAC,KAAK,CAAC,CAAC;IACvD,MAAM,EAAE,YAAY,EAAE,GAAG,EAAE,GAAG,KAAK,EAAE,CAAC;IAEtC,8DAA8D;IAC9D,MAAM,WAAW,GAAG,OAAO,CACzB,GAAG,EAAE,CAAC,IAAI,uBAAuB,CAAC,IAAI,sBAAsB,EAAE,CAAC;IAC/D,uDAAuD;IACvD,CAAC,YAAY,CAAC,CACf,CAAC;IAEF,SAAS,CAAC,GAAG,EAAE;QACb,IAAI,YAAY;YAAE,WAAW,CAAC,eAAe,CAAC,YAAY,CAAC,CAAC;IAC9D,CAAC,EAAE,CAAC,WAAW,EAAE,YAAY,CAAC,CAAC,CAAC;IAEhC,OAAO,WAAW,CAAC;AACrB,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,iCAAiC,CAAC,KAEjD;IACC,MAAM,EAAE,KAAK,EAAE,YAAY,EAAE,UAAU,EAAE,GAAG,eAAe,CAAC,KAAK,CAAC,CAAC;IACnE,MAAM,EAAE,YAAY,EAAE,GAAG,EAAE,GAAG,KAAK,EAAE,CAAC;IAEtC,8DAA8D;IAC9D,MAAM,WAAW,GAAG,OAAO,CACzB,GAAG,EAAE,CAAC,IAAI,uBAAuB,CAAC,IAAI,sBAAsB,EAAE,CAAC;IAC/D,uDAAuD;IACvD,CAAC,YAAY,CAAC,CACf,CAAC;IAEF,SAAS,CAAC,GAAG,EAAE;QACb,IAAI,YAAY;YAAE,WAAW,CAAC,eAAe,CAAC,YAAY,CAAC,CAAC;IAC9D,CAAC,EAAE,CAAC,WAAW,EAAE,YAAY,CAAC,CAAC,CAAC;IAEhC,OAAO,EAAE,WAAW,EAAE,UAAU,EAAE,CAAC;AACrC,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,2BAA2B,CAAC,KAE3C;IACC,OAAO,OAAO,CACZ,GAAG,EAAE,CAAC,IAAI,wBAAwB,CAAC,KAAK,CAAC,WAAW,CAAC,EACrD,CAAC,KAAK,CAAC,WAAW,CAAC,CACpB,CAAC;AACJ,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,oBAAoB,CAAC,KAEpC;IACC,MAAM,EAAE,WAAW,EAAE,GAAG,EAAE,GAAG,KAAK,EAAE,CAAC;IACrC,MAAM,CAAC,KAAK,EAAE,QAAQ,CAAC,GAAG,QAAQ,EAAsB,CAAC;IAEzD,SAAS,CAAC,GAAG,EAAE;QACb,MAAM,YAAY,GAAG,GAAG,EAAE;YACxB,QAAQ,CAAC,WAAW,CAAC,QAAQ,EAAE,CAAC,CAAC;QACnC,CAAC,CAAC;QACF,YAAY,EAAE,CAAC;QACf,OAAO,WAAW,CAAC,cAAc,CAAC,WAAW,CAAC,YAAY,CAAC,CAAC;IAC9D,CAAC,EAAE,CAAC,WAAW,CAAC,CAAC,CAAC;IAElB,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 *--------------------------------------------------------------------------------------------*/\n/** @packageDocumentation\n * @module PropertyGrid\n */\n\nimport { useCallback, useEffect, useMemo, useReducer, useState } from \"react\";\nimport { useDebouncedAsyncValue } from \"../../common/UseDebouncedAsyncValue.js\";\nimport type { IPropertyDataProvider } from \"../PropertyDataProvider.js\";\nimport { MutableGridItemFactory } from \"./flat-items/MutableGridItemFactory.js\";\nimport { PropertyGridEventHandler } from \"./PropertyGridEventHandler.js\";\nimport type { IPropertyGridModel } from \"./PropertyGridModel.js\";\nimport type { IPropertyGridModelSource } from \"./PropertyGridModelSource.js\";\nimport { PropertyGridModelSource } from \"./PropertyGridModelSource.js\";\n\n/**\n * Custom hook that gets [[PropertyData]] from given [[IPropertyDataProvider]] and subscribes to further data changes.\n * @throws if/when `IPropertyDataProvider.getData()` promise is rejected. The error is thrown in the React's render loop, so it can be caught using an error boundary.\n * @public\n */\nexport function usePropertyData(props: {\n  dataProvider: IPropertyDataProvider;\n}) {\n  const { dataProvider } = props;\n\n  const [forcedUpdate, triggerForcedUpdate] = useReducer(() => ({}), {});\n  useEffect(() => {\n    return dataProvider.onDataChanged.addListener(() => {\n      triggerForcedUpdate();\n    });\n  }, [dataProvider]);\n\n  // forcedUpdate is added to dependency list to re-memo getData promise when onDataChanged emits an event.\n  return useDebouncedAsyncValue(\n    useCallback(\n      async () => dataProvider.getData(),\n      // eslint-disable-next-line react-hooks/exhaustive-deps\n      [dataProvider, forcedUpdate]\n    )\n  );\n}\n\n/**\n * Custom hook that creates a [[PropertyGridModelSource]] and subscribes it to data updates from the data provider.\n * @throws if/when `IPropertyDataProvider.getData()` promise is rejected. The error is thrown in the React's render loop, so it can be caught using an error boundary.\n * @public\n * @deprecated in 4.9.0. Use `useTrackedPropertyGridModelSource` instead.\n */\nexport function usePropertyGridModelSource(props: {\n  dataProvider: IPropertyDataProvider;\n}) {\n  const { value: propertyData } = usePropertyData(props);\n  const { dataProvider } = { ...props };\n\n  // Model source needs to be recreated if data provider changes\n  const modelSource = useMemo(\n    () => new PropertyGridModelSource(new MutableGridItemFactory()),\n    // eslint-disable-next-line react-hooks/exhaustive-deps\n    [dataProvider]\n  );\n\n  useEffect(() => {\n    if (propertyData) modelSource.setPropertyData(propertyData);\n  }, [modelSource, propertyData]);\n\n  return modelSource;\n}\n\n/**\n * Custom hook that creates a [[PropertyGridModelSource]] and subscribes it to data updates from the data provider while also providing information on data update progress.\n * @throws if/when `IPropertyDataProvider.getData()` promise is rejected. The error is thrown in the React's render loop, so it can be caught using an error boundary.\n * @public\n */\nexport function useTrackedPropertyGridModelSource(props: {\n  dataProvider: IPropertyDataProvider;\n}) {\n  const { value: propertyData, inProgress } = usePropertyData(props);\n  const { dataProvider } = { ...props };\n\n  // Model source needs to be recreated if data provider changes\n  const modelSource = useMemo(\n    () => new PropertyGridModelSource(new MutableGridItemFactory()),\n    // eslint-disable-next-line react-hooks/exhaustive-deps\n    [dataProvider]\n  );\n\n  useEffect(() => {\n    if (propertyData) modelSource.setPropertyData(propertyData);\n  }, [modelSource, propertyData]);\n\n  return { modelSource, inProgress };\n}\n\n/**\n * Custom hook that creates memoized version of [[PropertyGridEventHandler]] that modifies given modelSource\n * @public\n */\nexport function usePropertyGridEventHandler(props: {\n  modelSource: IPropertyGridModelSource;\n}) {\n  return useMemo(\n    () => new PropertyGridEventHandler(props.modelSource),\n    [props.modelSource]\n  );\n}\n\n/**\n * Custom hook that automatically listens and retrieves latest model from model source\n * @public\n */\nexport function usePropertyGridModel(props: {\n  modelSource: IPropertyGridModelSource;\n}) {\n  const { modelSource } = { ...props };\n  const [model, setModel] = useState<IPropertyGridModel>();\n\n  useEffect(() => {\n    const modelChanged = () => {\n      setModel(modelSource.getModel());\n    };\n    modelChanged();\n    return modelSource.onModelChanged.addListener(modelChanged);\n  }, [modelSource]);\n\n  return model;\n}\n"]}

package/lib/components-react/propertygrid/internal/PropertyGridModel.d.ts

@@ -0,0 +1,66 @@
+/** @packageDocumentation
+ * @module PropertyGrid
+ */
+import { immerable } from "immer";
+import type { PropertyData } from "../PropertyDataProvider.js";
+import type { FlatGridItem, GridCategoryItem } from "./flat-items/FlatGridItem.js";
+import type { IMutableFlatGridItem, IMutableGridCategoryItem } from "./flat-items/MutableFlatGridItem.js";
+import type { IMutableGridItemFactory } from "./flat-items/MutableGridItemFactory.js";
+/**
+ * PropertyGridModel interface for working with immutable FlatGridItems
+ * @public
+ */
+export interface IPropertyGridModel {
+    getItem: (selectionKey: string) => FlatGridItem;
+    getRootCategories: () => GridCategoryItem[];
+    getFlatGrid: () => FlatGridItem[];
+    getVisibleFlatGrid: () => FlatGridItem[];
+}
+/**
+ * PropertyGridModel interface for working with mutable FlatGridItems
+ * @public
+ */
+export interface IMutablePropertyGridModel {
+    getItem: (selectionKey: string) => IMutableFlatGridItem;
+    getRootCategories: () => IMutableGridCategoryItem[];
+    getFlatGrid: () => IMutableFlatGridItem[];
+    getVisibleFlatGrid: () => IMutableFlatGridItem[];
+}
+/**
+ * Implementation of PropertyGridModel for working with and converting PropertyData to mutable FlatGridItems
+ * @public
+ */
+export declare class MutablePropertyGridModel implements IPropertyGridModel, IMutablePropertyGridModel {
+    private _gridItemFactory;
+    [immerable]: boolean;
+    private _categories;
+    constructor(propertyData: PropertyData, _gridItemFactory: IMutableGridItemFactory);
+    /**
+     * Retrieves grid item from model.
+     * @param selectionKey unique key for identifying item to retrieve.
+     */
+    getItem(selectionKey: string): IMutableFlatGridItem;
+    /**
+     * Walks the grid item hierarchy and finds item matching key
+     * @param items items and their descendants to check
+     * @param selectionKey unique key for identifying item
+     * @returns FlatGridItem if items with key exists, undefined otherwise
+     */
+    private findItem;
+    /**
+     * Gets all GridCategoryItems that do not have parent categories.
+     * @returns array of GridCategoryItems
+     */
+    getRootCategories(): IMutableGridCategoryItem[];
+    /**
+     * Gets an array of all FlatGridItems.
+     * @returns 1-Dimensional array of GridCategories and CategorizedProperties
+     */
+    getFlatGrid(): IMutableFlatGridItem[];
+    /**
+     * Gets an array of all currently visible FlatGridItems.
+     * @returns 1-Dimensional array of GridCategories and CategorizedProperties
+     */
+    getVisibleFlatGrid(): IMutableFlatGridItem[];
+}
+//# sourceMappingURL=PropertyGridModel.d.ts.map

package/lib/components-react/propertygrid/internal/PropertyGridModel.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"PropertyGridModel.d.ts","sourceRoot":"","sources":["../../../../src/components-react/propertygrid/internal/PropertyGridModel.ts"],"names":[],"mappings":"AAIA;;GAEG;AACH,OAAO,EAAE,SAAS,EAAE,MAAM,OAAO,CAAC;AAClC,OAAO,KAAK,EAEV,YAAY,EACb,MAAM,4BAA4B,CAAC;AACpC,OAAO,KAAK,EACV,YAAY,EACZ,gBAAgB,EACjB,MAAM,8BAA8B,CAAC;AACtC,OAAO,KAAK,EACV,oBAAoB,EACpB,wBAAwB,EACzB,MAAM,qCAAqC,CAAC;AAC7C,OAAO,KAAK,EAAE,uBAAuB,EAAE,MAAM,wCAAwC,CAAC;AAEtF;;;GAGG;AACH,MAAM,WAAW,kBAAkB;IACjC,OAAO,EAAE,CAAC,YAAY,EAAE,MAAM,KAAK,YAAY,CAAC;IAChD,iBAAiB,EAAE,MAAM,gBAAgB,EAAE,CAAC;IAC5C,WAAW,EAAE,MAAM,YAAY,EAAE,CAAC;IAClC,kBAAkB,EAAE,MAAM,YAAY,EAAE,CAAC;CAC1C;AAED;;;GAGG;AACH,MAAM,WAAW,yBAAyB;IACxC,OAAO,EAAE,CAAC,YAAY,EAAE,MAAM,KAAK,oBAAoB,CAAC;IACxD,iBAAiB,EAAE,MAAM,wBAAwB,EAAE,CAAC;IACpD,WAAW,EAAE,MAAM,oBAAoB,EAAE,CAAC;IAC1C,kBAAkB,EAAE,MAAM,oBAAoB,EAAE,CAAC;CAClD;AAED;;;GAGG;AACH,qBAAa,wBACX,YAAW,kBAAkB,EAAE,yBAAyB;IAOtD,OAAO,CAAC,gBAAgB;IALnB,CAAC,SAAS,CAAC,UAAQ;IAE1B,OAAO,CAAC,WAAW,CAA6B;gBAE9C,YAAY,EAAE,YAAY,EAClB,gBAAgB,EAAE,uBAAuB;IAQnD;;;OAGG;IACI,OAAO,CAAC,YAAY,EAAE,MAAM;IAQnC;;;;;OAKG;IACH,OAAO,CAAC,QAAQ;IAiBhB;;;OAGG;IACI,iBAAiB,IAAI,wBAAwB,EAAE;IAItD;;;OAGG;IACI,WAAW,IAAI,oBAAoB,EAAE;IAS5C;;;OAGG;IACI,kBAAkB,IAAI,oBAAoB,EAAE;CAQpD"}

package/lib/components-react/propertygrid/internal/PropertyGridModel.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"PropertyGridModel.js","sourceRoot":"","sources":["../../../../src/components-react/propertygrid/internal/PropertyGridModel.ts"],"names":[],"mappings":";AAAA;;;gGAGgG;AAChG;;GAEG;AACH,OAAO,EAAE,SAAS,EAAE,MAAM,OAAO,CAAC;AAqClC;;;GAGG;AACH,MAAM,OAAO,wBAAwB;IAMnC,YACE,YAA0B,EAClB,gBAAyC;QAAzC,qBAAgB,GAAhB,gBAAgB,CAAyB;QAL5C,QAAW,GAAG,IAAI,CAAC;QAOxB,IAAI,CAAC,WAAW,GAAG,YAAY,CAAC,UAAU,CAAC,GAAG,CAC5C,CAAC,QAA0B,EAAE,EAAE,CAC7B,IAAI,CAAC,gBAAgB,CAAC,kBAAkB,CAAC,QAAQ,EAAE,YAAY,CAAC,OAAO,CAAC,CAC3E,CAAC;IACJ,CAAC;IAED;;;OAGG;IACI,OAAO,CAAC,YAAoB;QACjC,MAAM,IAAI,GAAG,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,WAAW,EAAE,YAAY,CAAC,CAAC;QAC3D,IAAI,CAAC,IAAI;YACP,MAAM,IAAI,KAAK,CAAC,wCAAwC,YAAY,EAAE,CAAC,CAAC;QAE1E,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;OAKG;IACK,QAAQ,CACd,KAA6B,EAC7B,YAAoB;QAEpB,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC;YACzB,2IAA2I;YAC3I,IAAI,CAAC,YAAY,CAAC,UAAU,CAAC,IAAI,CAAC,YAAY,CAAC;gBAAE,SAAS;YAE1D,IAAI,IAAI,CAAC,YAAY,KAAK,YAAY;gBAAE,OAAO,IAAI,CAAC;YAEpD,MAAM,SAAS,GAAG,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,WAAW,EAAE,EAAE,YAAY,CAAC,CAAC;YAClE,IAAI,SAAS;gBAAE,OAAO,SAAS,CAAC;QAClC,CAAC;QAED,OAAO,SAAS,CAAC;IACnB,CAAC;IAED;;;OAGG;IACI,iBAAiB;QACtB,OAAO,IAAI,CAAC,WAAW,CAAC;IAC1B,CAAC;IAED;;;OAGG;IACI,WAAW;QAChB,MAAM,QAAQ,GAA2B,EAAE,CAAC;QAC5C,IAAI,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC,QAAQ,EAAE,EAAE,CACpC,QAAQ,CAAC,IAAI,CAAC,GAAG,QAAQ,CAAC,qBAAqB,EAAE,CAAC,CACnD,CAAC;QAEF,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED;;;OAGG;IACI,kBAAkB;QACvB,MAAM,YAAY,GAA2B,EAAE,CAAC;QAChD,IAAI,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC,QAAQ,EAAE,EAAE,CACpC,YAAY,CAAC,IAAI,CAAC,GAAG,QAAQ,CAAC,4BAA4B,EAAE,CAAC,CAC9D,CAAC;QAEF,OAAO,YAAY,CAAC;IACtB,CAAC;CACF;KAjFS,SAAS","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 */\nimport { immerable } from \"immer\";\nimport type {\n  PropertyCategory,\n  PropertyData,\n} from \"../PropertyDataProvider.js\";\nimport type {\n  FlatGridItem,\n  GridCategoryItem,\n} from \"./flat-items/FlatGridItem.js\";\nimport type {\n  IMutableFlatGridItem,\n  IMutableGridCategoryItem,\n} from \"./flat-items/MutableFlatGridItem.js\";\nimport type { IMutableGridItemFactory } from \"./flat-items/MutableGridItemFactory.js\";\n\n/**\n * PropertyGridModel interface for working with immutable FlatGridItems\n * @public\n */\nexport interface IPropertyGridModel {\n  getItem: (selectionKey: string) => FlatGridItem;\n  getRootCategories: () => GridCategoryItem[];\n  getFlatGrid: () => FlatGridItem[];\n  getVisibleFlatGrid: () => FlatGridItem[];\n}\n\n/**\n * PropertyGridModel interface for working with mutable FlatGridItems\n * @public\n */\nexport interface IMutablePropertyGridModel {\n  getItem: (selectionKey: string) => IMutableFlatGridItem;\n  getRootCategories: () => IMutableGridCategoryItem[];\n  getFlatGrid: () => IMutableFlatGridItem[];\n  getVisibleFlatGrid: () => IMutableFlatGridItem[];\n}\n\n/**\n * Implementation of PropertyGridModel for working with and converting PropertyData to mutable FlatGridItems\n * @public\n */\nexport class MutablePropertyGridModel\n  implements IPropertyGridModel, IMutablePropertyGridModel\n{\n  public [immerable] = true;\n\n  private _categories: IMutableGridCategoryItem[];\n  public constructor(\n    propertyData: PropertyData,\n    private _gridItemFactory: IMutableGridItemFactory\n  ) {\n    this._categories = propertyData.categories.map(\n      (category: PropertyCategory) =>\n        this._gridItemFactory.createGridCategory(category, propertyData.records)\n    );\n  }\n\n  /**\n   * Retrieves grid item from model.\n   * @param selectionKey unique key for identifying item to retrieve.\n   */\n  public getItem(selectionKey: string) {\n    const item = this.findItem(this._categories, selectionKey);\n    if (!item)\n      throw new Error(`Grid item at provided key not found: ${selectionKey}`);\n\n    return item;\n  }\n\n  /**\n   * Walks the grid item hierarchy and finds item matching key\n   * @param items items and their descendants to check\n   * @param selectionKey unique key for identifying item\n   * @returns FlatGridItem if items with key exists, undefined otherwise\n   */\n  private findItem(\n    items: IMutableFlatGridItem[],\n    selectionKey: string\n  ): IMutableFlatGridItem | undefined {\n    for (const item of items) {\n      // Each items key is prefixed with it's parent key, so we can ignore the ones that aren't prefixed to reduce checking unnecessary branches.\n      if (!selectionKey.startsWith(item.selectionKey)) continue;\n\n      if (item.selectionKey === selectionKey) return item;\n\n      const foundItem = this.findItem(item.getChildren(), selectionKey);\n      if (foundItem) return foundItem;\n    }\n\n    return undefined;\n  }\n\n  /**\n   * Gets all GridCategoryItems that do not have parent categories.\n   * @returns array of GridCategoryItems\n   */\n  public getRootCategories(): IMutableGridCategoryItem[] {\n    return this._categories;\n  }\n\n  /**\n   * Gets an array of all FlatGridItems.\n   * @returns 1-Dimensional array of GridCategories and CategorizedProperties\n   */\n  public getFlatGrid(): IMutableFlatGridItem[] {\n    const flatGrid: IMutableFlatGridItem[] = [];\n    this._categories.forEach((category) =>\n      flatGrid.push(...category.getDescendantsAndSelf())\n    );\n\n    return flatGrid;\n  }\n\n  /**\n   * Gets an array of all currently visible FlatGridItems.\n   * @returns 1-Dimensional array of GridCategories and CategorizedProperties\n   */\n  public getVisibleFlatGrid(): IMutableFlatGridItem[] {\n    const visibleItems: IMutableFlatGridItem[] = [];\n    this._categories.forEach((category) =>\n      visibleItems.push(...category.getVisibleDescendantsAndSelf())\n    );\n\n    return visibleItems;\n  }\n}\n"]}

package/lib/components-react/propertygrid/internal/PropertyGridModelChangeEvent.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"PropertyGridModelChangeEvent.d.ts","sourceRoot":"","sources":["../../../../src/components-react/propertygrid/internal/PropertyGridModelChangeEvent.ts"],"names":[],"mappings":"AAKA;;GAEG;AACH,OAAO,EAAE,OAAO,EAAE,MAAM,qBAAqB,CAAC;AAE9C;;;GAGG;AACH,MAAM,MAAM,+BAA+B,GAAG,MAAM,IAAI,CAAC;AAEzD;;;GAGG;AACH,qBAAa,4BAA6B,SAAQ,OAAO,CAAC,+BAA+B,CAAC;CAAG"}

package/lib/components-react/propertygrid/internal/PropertyGridModelChangeEvent.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"PropertyGridModelChangeEvent.js","sourceRoot":"","sources":["../../../../src/components-react/propertygrid/internal/PropertyGridModelChangeEvent.ts"],"names":[],"mappings":"AAAA;;;gGAGgG;AAEhG;;GAEG;AACH,OAAO,EAAE,OAAO,EAAE,MAAM,qBAAqB,CAAC;AAQ9C;;;GAGG;AACH,MAAM,OAAO,4BAA6B,SAAQ,OAAwC;CAAG","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 */\nimport { BeEvent } from \"@itwin/core-bentley\";\n\n/**\n * A signature for property grid model change listeners\n * @public\n */\nexport type PropertyGridModelChangeListener = () => void;\n\n/**\n * An event broadcasted on property grid model changes\n * @public\n */\nexport class PropertyGridModelChangeEvent extends BeEvent<PropertyGridModelChangeListener> {}\n"]}

package/lib/components-react/propertygrid/internal/PropertyGridModelSource.d.ts

@@ -0,0 +1,37 @@
+/** @packageDocumentation
+ * @module PropertyGrid
+ */
+import type { PropertyData } from "../PropertyDataProvider.js";
+import type { IMutableGridItemFactory } from "./flat-items/MutableGridItemFactory.js";
+import type { IMutablePropertyGridModel, IPropertyGridModel } from "./PropertyGridModel.js";
+import { PropertyGridModelChangeEvent } from "./PropertyGridModelChangeEvent.js";
+/** @public */
+export interface IPropertyGridModelSource {
+    onModelChanged: PropertyGridModelChangeEvent;
+    setPropertyData: (data: PropertyData) => void;
+    modifyModel(callback: (model: IMutablePropertyGridModel) => void): void;
+    getModel(): IPropertyGridModel | undefined;
+}
+/**
+ * Controls property grid model.
+ * It is used to modify property grid model model and inform when the model changes.
+ * @public
+ */
+export declare class PropertyGridModelSource implements IPropertyGridModelSource {
+    private _gridFactory;
+    private _model?;
+    /** Event that is emitted every time property model is changed. */
+    onModelChanged: PropertyGridModelChangeEvent;
+    constructor(_gridFactory: IMutableGridItemFactory);
+    private getFullModelMap;
+    private moveOldModelState;
+    setPropertyData(data: PropertyData): void;
+    /**
+     * Modifies property grid model using provided callback.
+     * If changes to model are detected, onModelChanged emits an event to all subscribers.
+     */
+    modifyModel(callback: (model: IMutablePropertyGridModel) => void): void;
+    /** Returns property grid model. */
+    getModel(): IPropertyGridModel | undefined;
+}
+//# sourceMappingURL=PropertyGridModelSource.d.ts.map

package/lib/components-react/propertygrid/internal/PropertyGridModelSource.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"PropertyGridModelSource.d.ts","sourceRoot":"","sources":["../../../../src/components-react/propertygrid/internal/PropertyGridModelSource.ts"],"names":[],"mappings":"AAIA;;GAEG;AAGH,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,4BAA4B,CAAC;AAE/D,OAAO,KAAK,EAAE,uBAAuB,EAAE,MAAM,wCAAwC,CAAC;AACtF,OAAO,KAAK,EACV,yBAAyB,EACzB,kBAAkB,EACnB,MAAM,wBAAwB,CAAC;AAEhC,OAAO,EAAE,4BAA4B,EAAE,MAAM,mCAAmC,CAAC;AAEjF,cAAc;AACd,MAAM,WAAW,wBAAwB;IACvC,cAAc,EAAE,4BAA4B,CAAC;IAC7C,eAAe,EAAE,CAAC,IAAI,EAAE,YAAY,KAAK,IAAI,CAAC;IAC9C,WAAW,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAE,yBAAyB,KAAK,IAAI,GAAG,IAAI,CAAC;IACxE,QAAQ,IAAI,kBAAkB,GAAG,SAAS,CAAC;CAC5C;AAED;;;;GAIG;AACH,qBAAa,uBAAwB,YAAW,wBAAwB;IAKnD,OAAO,CAAC,YAAY;IAJvC,OAAO,CAAC,MAAM,CAAC,CAA4B;IAC3C,kEAAkE;IAC3D,cAAc,+BAAsC;gBAEhC,YAAY,EAAE,uBAAuB;IAEhE,OAAO,CAAC,eAAe;IAYvB,OAAO,CAAC,iBAAiB;IAalB,eAAe,CAAC,IAAI,EAAE,YAAY;IASzC;;;OAGG;IACI,WAAW,CAChB,QAAQ,EAAE,CAAC,KAAK,EAAE,yBAAyB,KAAK,IAAI,GACnD,IAAI;IAOP,mCAAmC;IAC5B,QAAQ,IAAI,kBAAkB,GAAG,SAAS;CAGlD"}