@itwin/tree-widget-react 2.3.2 → 3.0.0-dev.1

package/lib/cjs/components/trees/common/UseFiltering.js

@@ -0,0 +1,29 @@
+"use strict";
+/*---------------------------------------------------------------------------------------------
+ * Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+ * See LICENSE.md in the project root for license terms and full copyright notice.
+ *--------------------------------------------------------------------------------------------*/
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.useFiltering = void 0;
+const react_1 = require("react");
+/** @internal */
+function useFiltering() {
+    const [filter, setFilter] = (0, react_1.useState)("");
+    const [activeMatchIndex, setActiveMatchIndex] = (0, react_1.useState)(0);
+    const [totalMatches, setTotalMatches] = (0, react_1.useState)(0);
+    const applyFilter = (0, react_1.useCallback)((newFilter) => {
+        setActiveMatchIndex(0);
+        setFilter(newFilter);
+    }, []);
+    const clearFilter = (0, react_1.useCallback)(() => {
+        setActiveMatchIndex(0);
+        setFilter("");
+    }, []);
+    const onHighlightChanged = (0, react_1.useCallback)((index, matches) => {
+        setActiveMatchIndex(index);
+        matches && setTotalMatches(matches);
+    }, []);
+    return { filter, activeMatchIndex, totalMatches, applyFilter, clearFilter, onHighlightChanged };
+}
+exports.useFiltering = useFiltering;
+//# sourceMappingURL=UseFiltering.js.map

package/lib/cjs/components/trees/common/UseFiltering.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"UseFiltering.js","sourceRoot":"","sources":["../../../../../src/components/trees/common/UseFiltering.ts"],"names":[],"mappings":";AAAA;;;gGAGgG;;;AAEhG,iCAA8C;AAW9C,gBAAgB;AAChB,SAAgB,YAAY;IAC1B,MAAM,CAAC,MAAM,EAAE,SAAS,CAAC,GAAG,IAAA,gBAAQ,EAAC,EAAE,CAAC,CAAC;IACzC,MAAM,CAAC,gBAAgB,EAAE,mBAAmB,CAAC,GAAG,IAAA,gBAAQ,EAAC,CAAC,CAAC,CAAC;IAC5D,MAAM,CAAC,YAAY,EAAE,eAAe,CAAC,GAAG,IAAA,gBAAQ,EAAC,CAAC,CAAC,CAAC;IAEpD,MAAM,WAAW,GAAG,IAAA,mBAAW,EAAC,CAAC,SAAiB,EAAE,EAAE;QACpD,mBAAmB,CAAC,CAAC,CAAC,CAAC;QACvB,SAAS,CAAC,SAAS,CAAC,CAAC;IACvB,CAAC,EAAE,EAAE,CAAC,CAAC;IAEP,MAAM,WAAW,GAAG,IAAA,mBAAW,EAAC,GAAG,EAAE;QACnC,mBAAmB,CAAC,CAAC,CAAC,CAAC;QACvB,SAAS,CAAC,EAAE,CAAC,CAAC;IAChB,CAAC,EAAE,EAAE,CAAC,CAAC;IAEP,MAAM,kBAAkB,GAAG,IAAA,mBAAW,EAAC,CAAC,KAAa,EAAE,OAAgB,EAAE,EAAE;QACzE,mBAAmB,CAAC,KAAK,CAAC,CAAC;QAC3B,OAAO,IAAI,eAAe,CAAC,OAAO,CAAC,CAAC;IACtC,CAAC,EAAE,EAAE,CAAC,CAAC;IAEP,OAAO,EAAE,MAAM,EAAE,gBAAgB,EAAE,YAAY,EAAE,WAAW,EAAE,WAAW,EAAE,kBAAkB,EAAE,CAAC;AAClG,CAAC;AArBD,oCAqBC","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\nimport { useCallback, useState } from \"react\";\n\ninterface UseFilteringResult {\n  filter: string;\n  activeMatchIndex: number;\n  totalMatches: number;\n  applyFilter: (filter: string) => void;\n  clearFilter: () => void;\n  onHighlightChanged: (index: number, matches?: number) => void;\n}\n\n/** @internal */\nexport function useFiltering(): UseFilteringResult {\n  const [filter, setFilter] = useState(\"\");\n  const [activeMatchIndex, setActiveMatchIndex] = useState(0);\n  const [totalMatches, setTotalMatches] = useState(0);\n\n  const applyFilter = useCallback((newFilter: string) => {\n    setActiveMatchIndex(0);\n    setFilter(newFilter);\n  }, []);\n\n  const clearFilter = useCallback(() => {\n    setActiveMatchIndex(0);\n    setFilter(\"\");\n  }, []);\n\n  const onHighlightChanged = useCallback((index: number, matches?: number) => {\n    setActiveMatchIndex(index);\n    matches && setTotalMatches(matches);\n  }, []);\n\n  return { filter, activeMatchIndex, totalMatches, applyFilter, clearFilter, onHighlightChanged };\n}\n"]}

package/lib/cjs/components/trees/common/UseHierarchiesLocalization.d.ts

@@ -0,0 +1,8 @@
+import type { TreeRenderer, useTree } from "@itwin/presentation-hierarchies-react";
+type UseTreeLocalizedStrings = Parameters<typeof useTree>[0]["localizedStrings"];
+type TreeRendererLocalizedStrings = Parameters<typeof TreeRenderer>[0]["localizedStrings"];
+type UseHierarchiesLocalizationResult = UseTreeLocalizedStrings & TreeRendererLocalizedStrings;
+/** @internal */
+export declare function useHierarchiesLocalization(): UseHierarchiesLocalizationResult;
+export {};
+//# sourceMappingURL=UseHierarchiesLocalization.d.ts.map

package/lib/cjs/components/trees/common/UseHierarchiesLocalization.js

@@ -0,0 +1,33 @@
+"use strict";
+/*---------------------------------------------------------------------------------------------
+ * Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+ * See LICENSE.md in the project root for license terms and full copyright notice.
+ *--------------------------------------------------------------------------------------------*/
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.useHierarchiesLocalization = void 0;
+const react_1 = require("react");
+const TreeWidget_1 = require("../../../TreeWidget");
+/** @internal */
+function useHierarchiesLocalization() {
+    const stringValues = Object.values(getLocalizedStrings());
+    const localizedStrings = (0, react_1.useMemo)(getLocalizedStrings, stringValues);
+    return localizedStrings;
+}
+exports.useHierarchiesLocalization = useHierarchiesLocalization;
+function getLocalizedStrings() {
+    return {
+        // strings for the `useUnifiedSelectionTree` hook
+        unspecified: TreeWidget_1.TreeWidget.translate("presentation-hierarchies.unspecified"),
+        other: TreeWidget_1.TreeWidget.translate("presentation-hierarchies.other"),
+        // strings for `TreeRenderer` and `TreeNodeRenderer`
+        loading: TreeWidget_1.TreeWidget.translate("presentation-hierarchies.loading"),
+        filterHierarchyLevel: TreeWidget_1.TreeWidget.translate("presentation-hierarchies.filterHierarchyLevel"),
+        clearHierarchyLevelFilter: TreeWidget_1.TreeWidget.translate("presentation-hierarchies.clearHierarchyLevelFilter"),
+        noFilteredChildren: TreeWidget_1.TreeWidget.translate("presentation-hierarchies.noFilteredChildren"),
+        resultLimitExceeded: TreeWidget_1.TreeWidget.translate("presentation-hierarchies.resultLimitExceeded"),
+        resultLimitExceededWithFiltering: TreeWidget_1.TreeWidget.translate("presentation-hierarchies.resultLimitExceededWithFiltering"),
+        increaseHierarchyLimit: TreeWidget_1.TreeWidget.translate("presentation-hierarchies.increaseHierarchyLimit"),
+        increaseHierarchyLimitWithFiltering: TreeWidget_1.TreeWidget.translate("presentation-hierarchies.increaseHierarchyLimitWithFiltering"),
+    };
+}
+//# sourceMappingURL=UseHierarchiesLocalization.js.map

package/lib/cjs/components/trees/common/UseHierarchiesLocalization.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"UseHierarchiesLocalization.js","sourceRoot":"","sources":["../../../../../src/components/trees/common/UseHierarchiesLocalization.ts"],"names":[],"mappings":";AAAA;;;gGAGgG;;;AAEhG,iCAAgC;AAChC,oDAAiD;AASjD,gBAAgB;AAChB,SAAgB,0BAA0B;IACxC,MAAM,YAAY,GAAG,MAAM,CAAC,MAAM,CAAC,mBAAmB,EAAG,CAAC,CAAC;IAC3D,MAAM,gBAAgB,GAAG,IAAA,eAAO,EAAC,mBAAmB,EAAE,YAAY,CAAC,CAAC;IACpE,OAAO,gBAAgB,CAAC;AAC1B,CAAC;AAJD,gEAIC;AAED,SAAS,mBAAmB;IAC1B,OAAO;QACL,iDAAiD;QACjD,WAAW,EAAE,uBAAU,CAAC,SAAS,CAAC,sCAAsC,CAAC;QACzE,KAAK,EAAE,uBAAU,CAAC,SAAS,CAAC,gCAAgC,CAAC;QAE7D,oDAAoD;QACpD,OAAO,EAAE,uBAAU,CAAC,SAAS,CAAC,kCAAkC,CAAC;QACjE,oBAAoB,EAAE,uBAAU,CAAC,SAAS,CAAC,+CAA+C,CAAC;QAC3F,yBAAyB,EAAE,uBAAU,CAAC,SAAS,CAAC,oDAAoD,CAAC;QACrG,kBAAkB,EAAE,uBAAU,CAAC,SAAS,CAAC,6CAA6C,CAAC;QACvF,mBAAmB,EAAE,uBAAU,CAAC,SAAS,CAAC,8CAA8C,CAAC;QACzF,gCAAgC,EAAE,uBAAU,CAAC,SAAS,CAAC,2DAA2D,CAAC;QACnH,sBAAsB,EAAE,uBAAU,CAAC,SAAS,CAAC,iDAAiD,CAAC;QAC/F,mCAAmC,EAAE,uBAAU,CAAC,SAAS,CAAC,8DAA8D,CAAC;KAC1H,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\nimport { useMemo } from \"react\";\nimport { TreeWidget } from \"../../../TreeWidget\";\n\nimport type { TreeRenderer, useTree } from \"@itwin/presentation-hierarchies-react\";\n\ntype UseTreeLocalizedStrings = Parameters<typeof useTree>[0][\"localizedStrings\"];\ntype TreeRendererLocalizedStrings = Parameters<typeof TreeRenderer>[0][\"localizedStrings\"];\n\ntype UseHierarchiesLocalizationResult = UseTreeLocalizedStrings & TreeRendererLocalizedStrings;\n\n/** @internal */\nexport function useHierarchiesLocalization(): UseHierarchiesLocalizationResult {\n  const stringValues = Object.values(getLocalizedStrings()!);\n  const localizedStrings = useMemo(getLocalizedStrings, stringValues);\n  return localizedStrings;\n}\n\nfunction getLocalizedStrings(): UseHierarchiesLocalizationResult {\n  return {\n    // strings for the `useUnifiedSelectionTree` hook\n    unspecified: TreeWidget.translate(\"presentation-hierarchies.unspecified\"),\n    other: TreeWidget.translate(\"presentation-hierarchies.other\"),\n\n    // strings for `TreeRenderer` and `TreeNodeRenderer`\n    loading: TreeWidget.translate(\"presentation-hierarchies.loading\"),\n    filterHierarchyLevel: TreeWidget.translate(\"presentation-hierarchies.filterHierarchyLevel\"),\n    clearHierarchyLevelFilter: TreeWidget.translate(\"presentation-hierarchies.clearHierarchyLevelFilter\"),\n    noFilteredChildren: TreeWidget.translate(\"presentation-hierarchies.noFilteredChildren\"),\n    resultLimitExceeded: TreeWidget.translate(\"presentation-hierarchies.resultLimitExceeded\"),\n    resultLimitExceededWithFiltering: TreeWidget.translate(\"presentation-hierarchies.resultLimitExceededWithFiltering\"),\n    increaseHierarchyLimit: TreeWidget.translate(\"presentation-hierarchies.increaseHierarchyLimit\"),\n    increaseHierarchyLimitWithFiltering: TreeWidget.translate(\"presentation-hierarchies.increaseHierarchyLimitWithFiltering\"),\n  };\n}\n"]}

package/lib/cjs/components/trees/common/UseHierarchyFiltering.d.ts

@@ -0,0 +1,19 @@
+/// <reference types="react" />
+import type { IModelConnection } from "@itwin/core-frontend";
+import type { HierarchyLevelDetails } from "@itwin/presentation-hierarchies-react";
+import type { UsageTrackedFeatures } from "./UseFeatureReporting";
+interface UseHierarchyLevelFilteringProps {
+    imodel: IModelConnection;
+    defaultHierarchyLevelSizeLimit: number;
+    reportUsage?: (props: {
+        featureId?: UsageTrackedFeatures;
+        reportInteraction: true;
+    }) => void;
+}
+/** @internal */
+export declare function useHierarchyLevelFiltering({ imodel, defaultHierarchyLevelSizeLimit, reportUsage }: UseHierarchyLevelFilteringProps): {
+    onFilterClick: import("react").Dispatch<import("react").SetStateAction<HierarchyLevelDetails | undefined>>;
+    filteringDialog: JSX.Element;
+};
+export {};
+//# sourceMappingURL=UseHierarchyFiltering.d.ts.map

package/lib/cjs/components/trees/common/UseHierarchyFiltering.js

@@ -0,0 +1,157 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.useHierarchyLevelFiltering = void 0;
+const jsx_runtime_1 = require("react/jsx-runtime");
+/*---------------------------------------------------------------------------------------------
+ * Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+ * See LICENSE.md in the project root for license terms and full copyright notice.
+ *--------------------------------------------------------------------------------------------*/
+const react_1 = require("react");
+const components_react_1 = require("@itwin/components-react");
+const core_bentley_1 = require("@itwin/core-bentley");
+const itwinui_react_1 = require("@itwin/itwinui-react");
+const presentation_common_1 = require("@itwin/presentation-common");
+const presentation_components_1 = require("@itwin/presentation-components");
+const presentation_frontend_1 = require("@itwin/presentation-frontend");
+const presentation_hierarchies_1 = require("@itwin/presentation-hierarchies");
+const TreeWidget_1 = require("../../../TreeWidget");
+const Delayed_1 = require("./components/Delayed");
+/** @internal */
+function useHierarchyLevelFiltering({ imodel, defaultHierarchyLevelSizeLimit, reportUsage }) {
+    const [filteringOptions, setFilteringOptions] = (0, react_1.useState)();
+    const propertiesSource = (0, react_1.useMemo)(() => {
+        if (!filteringOptions) {
+            return undefined;
+        }
+        return async () => {
+            const keySet = await collectInstanceKeys(filteringOptions.getInstanceKeysIterator());
+            if (keySet.isEmpty) {
+                throw new Error("Hierarchy level is empty - unable to create content descriptor.");
+            }
+            const descriptor = await presentation_frontend_1.Presentation.presentation.getContentDescriptor({
+                imodel,
+                rulesetOrId: {
+                    id: `Hierarchy level descriptor ruleset`,
+                    rules: [
+                        {
+                            ruleType: "Content",
+                            specifications: [
+                                {
+                                    specType: "SelectedNodeInstances",
+                                },
+                            ],
+                        },
+                    ],
+                },
+                displayType: presentation_common_1.DefaultContentDisplayTypes.PropertyPane,
+                keys: keySet,
+            });
+            if (!descriptor) {
+                throw new Error("Failed to create content descriptor");
+            }
+            return { descriptor, inputKeys: keySet };
+        };
+    }, [filteringOptions, imodel]);
+    const getInitialFilter = (0, react_1.useMemo)(() => {
+        const currentFilter = filteringOptions?.instanceFilter;
+        if (!currentFilter) {
+            return undefined;
+        }
+        return (descriptor) => fromGenericFilter(descriptor, currentFilter);
+    }, [filteringOptions]);
+    const filteringDialog = ((0, jsx_runtime_1.jsx)(presentation_components_1.PresentationInstanceFilterDialog, { imodel: imodel, isOpen: !!filteringOptions, onApply: (info) => {
+            if (!filteringOptions) {
+                return;
+            }
+            reportUsage?.({ featureId: info ? "hierarchy-level-filtering" : undefined, reportInteraction: true });
+            filteringOptions.setInstanceFilter(toGenericFilter(info));
+            setFilteringOptions(undefined);
+        }, onClose: () => {
+            setFilteringOptions(undefined);
+        }, propertiesSource: propertiesSource, initialFilter: getInitialFilter, filterResultsCountRenderer: (filter) => {
+            if (!filteringOptions) {
+                return null;
+            }
+            return ((0, jsx_runtime_1.jsx)(MatchingInstancesCount, { filter: filter, hierarchyLevelDetails: filteringOptions, defaultHierarchyLevelSizeLimit: defaultHierarchyLevelSizeLimit }));
+        } }));
+    return {
+        onFilterClick: setFilteringOptions,
+        filteringDialog,
+    };
+}
+exports.useHierarchyLevelFiltering = useHierarchyLevelFiltering;
+function MatchingInstancesCount({ filter, defaultHierarchyLevelSizeLimit, hierarchyLevelDetails }) {
+    const { value, inProgress } = (0, components_react_1.useDebouncedAsyncValue)((0, react_1.useCallback)(async () => {
+        const instanceFilter = toGenericFilter(filter);
+        try {
+            const instanceCount = await countInstanceKeys(hierarchyLevelDetails.getInstanceKeysIterator({
+                instanceFilter,
+                hierarchyLevelSizeLimit: hierarchyLevelDetails.sizeLimit ?? defaultHierarchyLevelSizeLimit,
+            }));
+            return TreeWidget_1.TreeWidget.translate("filteringDialog.matchingInstancesCount", {
+                instanceCount: instanceCount.toLocaleString(undefined, { useGrouping: true }),
+            });
+        }
+        catch (e) {
+            if (e instanceof presentation_hierarchies_1.RowsLimitExceededError) {
+                return TreeWidget_1.TreeWidget.translate("filteringDialog.filterExceedsLimit", { limit: e.limit.toLocaleString(undefined, { useGrouping: true }) });
+            }
+            return TreeWidget_1.TreeWidget.translate("filteringDialog.failedToCalculateMatchingInstancesCount");
+        }
+    }, [filter, hierarchyLevelDetails, defaultHierarchyLevelSizeLimit]));
+    if (inProgress) {
+        return ((0, jsx_runtime_1.jsxs)(Delayed_1.Delayed, { show: true, children: [TreeWidget_1.TreeWidget.translate("filteringDialog.matchingInstancesCount", { instanceCount: "" }), (0, jsx_runtime_1.jsx)(itwinui_react_1.ProgressRadial, { size: "x-small" })] }));
+    }
+    return value ? (0, jsx_runtime_1.jsx)(jsx_runtime_1.Fragment, { children: value }) : null;
+}
+async function countInstanceKeys(iterator) {
+    let result = 0;
+    for await (const _ of iterator) {
+        result++;
+    }
+    return result;
+}
+async function collectInstanceKeys(iterator) {
+    const idsByClassName = new Map();
+    for await (const { className, id } of iterator) {
+        let idSet = idsByClassName.get(className);
+        if (!idSet) {
+            idSet = [];
+            idsByClassName.set(className, idSet);
+        }
+        idSet.push(id);
+    }
+    const instanceKeys = new Array();
+    for (const [className, ids] of idsByClassName) {
+        instanceKeys.push([className.toLowerCase(), core_bentley_1.CompressedId64Set.sortAndCompress(ids)]);
+    }
+    return presentation_common_1.KeySet.fromJSON({ instanceKeys, nodeKeys: [] });
+}
+function fromGenericFilter(descriptor, filter) {
+    const presentationFilter = presentation_hierarchies_1.GenericInstanceFilter.isFilterRuleGroup(filter.rules) && filter.rules.rules.length === 0
+        ? undefined
+        : presentation_components_1.PresentationInstanceFilter.fromGenericInstanceFilter(descriptor, filter);
+    return {
+        filter: presentationFilter,
+        usedClasses: (filter.filteredClassNames ?? [])
+            .map((name) => descriptor.selectClasses.find((selectClass) => selectClass.selectClassInfo.name === name)?.selectClassInfo)
+            .filter((classInfo) => classInfo !== undefined),
+    };
+}
+function toGenericFilter(filterInfo) {
+    if (!filterInfo) {
+        return undefined;
+    }
+    if (!filterInfo.filter) {
+        return filterInfo.usedClasses.length > 0
+            ? {
+                propertyClassNames: [],
+                relatedInstances: [],
+                filteredClassNames: filterInfo.usedClasses.map((info) => info.name),
+                rules: { operator: "and", rules: [] },
+            }
+            : undefined;
+    }
+    return presentation_components_1.PresentationInstanceFilter.toGenericInstanceFilter(filterInfo.filter, filterInfo.usedClasses);
+}
+//# sourceMappingURL=UseHierarchyFiltering.js.map

package/lib/cjs/components/trees/common/UseHierarchyFiltering.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"UseHierarchyFiltering.js","sourceRoot":"","sources":["../../../../../src/components/trees/common/UseHierarchyFiltering.tsx"],"names":[],"mappings":";;;;AAAA;;;gGAGgG;AAEhG,iCAAuD;AACvD,8DAAiE;AACjE,sDAAwD;AACxD,wDAAsD;AACtD,oEAAgF;AAChF,4EAA8G;AAC9G,wEAA4D;AAC5D,8EAAgG;AAChG,oDAAiD;AACjD,kDAA+C;AAgB/C,gBAAgB;AAChB,SAAgB,0BAA0B,CAAC,EAAE,MAAM,EAAE,8BAA8B,EAAE,WAAW,EAAmC;IACjI,MAAM,CAAC,gBAAgB,EAAE,mBAAmB,CAAC,GAAG,IAAA,gBAAQ,GAAyB,CAAC;IAElF,MAAM,gBAAgB,GAAG,IAAA,eAAO,EAA0E,GAAG,EAAE;QAC7G,IAAI,CAAC,gBAAgB,EAAE;YACrB,OAAO,SAAS,CAAC;SAClB;QAED,OAAO,KAAK,IAAI,EAAE;YAChB,MAAM,MAAM,GAAG,MAAM,mBAAmB,CAAC,gBAAgB,CAAC,uBAAuB,EAAE,CAAC,CAAC;YACrF,IAAI,MAAM,CAAC,OAAO,EAAE;gBAClB,MAAM,IAAI,KAAK,CAAC,iEAAiE,CAAC,CAAC;aACpF;YAED,MAAM,UAAU,GAAG,MAAM,oCAAY,CAAC,YAAY,CAAC,oBAAoB,CAAC;gBACtE,MAAM;gBACN,WAAW,EAAE;oBACX,EAAE,EAAE,oCAAoC;oBACxC,KAAK,EAAE;wBACL;4BACE,QAAQ,EAAE,SAAS;4BACnB,cAAc,EAAE;gCACd;oCACE,QAAQ,EAAE,uBAAuB;iCAClC;6BACF;yBACF;qBACF;iBACF;gBACD,WAAW,EAAE,gDAA0B,CAAC,YAAY;gBACpD,IAAI,EAAE,MAAM;aACb,CAAC,CAAC;YACH,IAAI,CAAC,UAAU,EAAE;gBACf,MAAM,IAAI,KAAK,CAAC,qCAAqC,CAAC,CAAC;aACxD;YAED,OAAO,EAAE,UAAU,EAAE,SAAS,EAAE,MAAM,EAAE,CAAC;QAC3C,CAAC,CAAC;IACJ,CAAC,EAAE,CAAC,gBAAgB,EAAE,MAAM,CAAC,CAAC,CAAC;IAE/B,MAAM,gBAAgB,GAAG,IAAA,eAAO,EAAC,GAAG,EAAE;QACpC,MAAM,aAAa,GAAG,gBAAgB,EAAE,cAAc,CAAC;QACvD,IAAI,CAAC,aAAa,EAAE;YAClB,OAAO,SAAS,CAAC;SAClB;QAED,OAAO,CAAC,UAAsB,EAAE,EAAE,CAAC,iBAAiB,CAAC,UAAU,EAAE,aAAa,CAAC,CAAC;IAClF,CAAC,EAAE,CAAC,gBAAgB,CAAC,CAAC,CAAC;IAEvB,MAAM,eAAe,GAAG,CACtB,uBAAC,0DAAgC,IAC/B,MAAM,EAAE,MAAM,EACd,MAAM,EAAE,CAAC,CAAC,gBAAgB,EAC1B,OAAO,EAAE,CAAC,IAAI,EAAE,EAAE;YAChB,IAAI,CAAC,gBAAgB,EAAE;gBACrB,OAAO;aACR;YACD,WAAW,EAAE,CAAC,EAAE,SAAS,EAAE,IAAI,CAAC,CAAC,CAAC,2BAA2B,CAAC,CAAC,CAAC,SAAS,EAAE,iBAAiB,EAAE,IAAI,EAAE,CAAC,CAAC;YACtG,gBAAgB,CAAC,iBAAiB,CAAC,eAAe,CAAC,IAAI,CAAC,CAAC,CAAC;YAC1D,mBAAmB,CAAC,SAAS,CAAC,CAAC;QACjC,CAAC,EACD,OAAO,EAAE,GAAG,EAAE;YACZ,mBAAmB,CAAC,SAAS,CAAC,CAAC;QACjC,CAAC,EACD,gBAAgB,EAAE,gBAAgB,EAClC,aAAa,EAAE,gBAAgB,EAC/B,0BAA0B,EAAE,CAAC,MAAM,EAAE,EAAE;YACrC,IAAI,CAAC,gBAAgB,EAAE;gBACrB,OAAO,IAAI,CAAC;aACb;YAED,OAAO,CACL,uBAAC,sBAAsB,IAAC,MAAM,EAAE,MAAM,EAAE,qBAAqB,EAAE,gBAAgB,EAAE,8BAA8B,EAAE,8BAA8B,GAAI,CACpJ,CAAC;QACJ,CAAC,GACD,CACH,CAAC;IAEF,OAAO;QACL,aAAa,EAAE,mBAAmB;QAClC,eAAe;KAChB,CAAC;AACJ,CAAC;AAlFD,gEAkFC;AAQD,SAAS,sBAAsB,CAAC,EAAE,MAAM,EAAE,8BAA8B,EAAE,qBAAqB,EAA+B;IAC5H,MAAM,EAAE,KAAK,EAAE,UAAU,EAAE,GAAG,IAAA,yCAAsB,EAClD,IAAA,mBAAW,EAAC,KAAK,IAAI,EAAE;QACrB,MAAM,cAAc,GAAG,eAAe,CAAC,MAAM,CAAC,CAAC;QAC/C,IAAI;YACF,MAAM,aAAa,GAAG,MAAM,iBAAiB,CAC3C,qBAAqB,CAAC,uBAAuB,CAAC;gBAC5C,cAAc;gBACd,uBAAuB,EAAE,qBAAqB,CAAC,SAAS,IAAI,8BAA8B;aAC3F,CAAC,CACH,CAAC;YACF,OAAO,uBAAU,CAAC,SAAS,CAAC,wCAAwC,EAAE;gBACpE,aAAa,EAAE,aAAa,CAAC,cAAc,CAAC,SAAS,EAAE,EAAE,WAAW,EAAE,IAAI,EAAE,CAAC;aAC9E,CAAC,CAAC;SACJ;QAAC,OAAO,CAAC,EAAE;YACV,IAAI,CAAC,YAAY,iDAAsB,EAAE;gBACvC,OAAO,uBAAU,CAAC,SAAS,CAAC,oCAAoC,EAAE,EAAE,KAAK,EAAE,CAAC,CAAC,KAAK,CAAC,cAAc,CAAC,SAAS,EAAE,EAAE,WAAW,EAAE,IAAI,EAAE,CAAC,EAAE,CAAC,CAAC;aACxI;YACD,OAAO,uBAAU,CAAC,SAAS,CAAC,yDAAyD,CAAC,CAAC;SACxF;IACH,CAAC,EAAE,CAAC,MAAM,EAAE,qBAAqB,EAAE,8BAA8B,CAAC,CAAC,CACpE,CAAC;IAEF,IAAI,UAAU,EAAE;QACd,OAAO,CACL,wBAAC,iBAAO,IAAC,IAAI,EAAE,IAAI,aAChB,uBAAU,CAAC,SAAS,CAAC,wCAAwC,EAAE,EAAE,aAAa,EAAE,EAAE,EAAE,CAAC,EACtF,uBAAC,8BAAc,IAAC,IAAI,EAAC,SAAS,GAAG,IACzB,CACX,CAAC;KACH;IAED,OAAO,KAAK,CAAC,CAAC,CAAC,2DAAG,KAAK,GAAI,CAAC,CAAC,CAAC,IAAI,CAAC;AACrC,CAAC;AAED,KAAK,UAAU,iBAAiB,CAAC,QAA4C;IAC3E,IAAI,MAAM,GAAG,CAAC,CAAC;IACf,IAAI,KAAK,EAAE,MAAM,CAAC,IAAI,QAAQ,EAAE;QAC9B,MAAM,EAAE,CAAC;KACV;IACD,OAAO,MAAM,CAAC;AAChB,CAAC;AAED,KAAK,UAAU,mBAAmB,CAAC,QAA4C;IAC7E,MAAM,cAAc,GAAG,IAAI,GAAG,EAAyB,CAAC;IACxD,IAAI,KAAK,EAAE,MAAM,EAAE,SAAS,EAAE,EAAE,EAAE,IAAI,QAAQ,EAAE;QAC9C,IAAI,KAAK,GAAG,cAAc,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC;QAC1C,IAAI,CAAC,KAAK,EAAE;YACV,KAAK,GAAG,EAAE,CAAC;YACX,cAAc,CAAC,GAAG,CAAC,SAAS,EAAE,KAAK,CAAC,CAAC;SACtC;QACD,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;KAChB;IAED,MAAM,YAAY,GAAG,IAAI,KAAK,EAAyD,CAAC;IACxF,KAAK,MAAM,CAAC,SAAS,EAAE,GAAG,CAAC,IAAI,cAAc,EAAE;QAC7C,YAAY,CAAC,IAAI,CAAC,CAAC,SAAS,CAAC,WAAW,EAAE,EAAE,gCAAiB,CAAC,eAAe,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;KACtF;IACD,OAAO,4BAAM,CAAC,QAAQ,CAAC,EAAE,YAAY,EAAE,QAAQ,EAAE,EAAE,EAAE,CAAC,CAAC;AACzD,CAAC;AAED,SAAS,iBAAiB,CAAC,UAAsB,EAAE,MAA6B;IAC9E,MAAM,kBAAkB,GACtB,gDAAqB,CAAC,iBAAiB,CAAC,MAAM,CAAC,KAAK,CAAC,IAAI,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC,MAAM,KAAK,CAAC;QACtF,CAAC,CAAC,SAAS;QACX,CAAC,CAAC,oDAA0B,CAAC,yBAAyB,CAAC,UAAU,EAAE,MAAM,CAAC,CAAC;IAC/E,OAAO;QACL,MAAM,EAAE,kBAAkB;QAC1B,WAAW,EAAE,CAAC,MAAM,CAAC,kBAAkB,IAAI,EAAE,CAAC;aAC3C,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,UAAU,CAAC,aAAa,CAAC,IAAI,CAAC,CAAC,WAAW,EAAE,EAAE,CAAC,WAAW,CAAC,eAAe,CAAC,IAAI,KAAK,IAAI,CAAC,EAAE,eAAe,CAAC;aACzH,MAAM,CAAC,CAAC,SAAS,EAA0B,EAAE,CAAC,SAAS,KAAK,SAAS,CAAC;KAC1E,CAAC;AACJ,CAAC;AAED,SAAS,eAAe,CAAC,UAA2C;IAClE,IAAI,CAAC,UAAU,EAAE;QACf,OAAO,SAAS,CAAC;KAClB;IAED,IAAI,CAAC,UAAU,CAAC,MAAM,EAAE;QACtB,OAAO,UAAU,CAAC,WAAW,CAAC,MAAM,GAAG,CAAC;YACtC,CAAC,CAAC;gBACE,kBAAkB,EAAE,EAAE;gBACtB,gBAAgB,EAAE,EAAE;gBACpB,kBAAkB,EAAE,UAAU,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC;gBACnE,KAAK,EAAE,EAAE,QAAQ,EAAE,KAAK,EAAE,KAAK,EAAE,EAAE,EAAE;aACtC;YACH,CAAC,CAAC,SAAS,CAAC;KACf;IAED,OAAO,oDAA0B,CAAC,uBAAuB,CAAC,UAAU,CAAC,MAAM,EAAE,UAAU,CAAC,WAAW,CAAC,CAAC;AACvG,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\nimport { useCallback, useMemo, useState } from \"react\";\nimport { useDebouncedAsyncValue } from \"@itwin/components-react\";\nimport { CompressedId64Set } from \"@itwin/core-bentley\";\nimport { ProgressRadial } from \"@itwin/itwinui-react\";\nimport { DefaultContentDisplayTypes, KeySet } from \"@itwin/presentation-common\";\nimport { PresentationInstanceFilter, PresentationInstanceFilterDialog } from \"@itwin/presentation-components\";\nimport { Presentation } from \"@itwin/presentation-frontend\";\nimport { GenericInstanceFilter, RowsLimitExceededError } from \"@itwin/presentation-hierarchies\";\nimport { TreeWidget } from \"../../../TreeWidget\";\nimport { Delayed } from \"./components/Delayed\";\n\nimport type { Id64Array, Id64String } from \"@itwin/core-bentley\";\nimport type { IModelConnection } from \"@itwin/core-frontend\";\nimport type { ClassInfo, Descriptor } from \"@itwin/presentation-common\";\nimport type { PresentationInstanceFilterInfo, PresentationInstanceFilterPropertiesSource } from \"@itwin/presentation-components\";\nimport type { HierarchyLevelDetails } from \"@itwin/presentation-hierarchies-react\";\nimport type { InstanceKey } from \"@itwin/presentation-shared\";\nimport type { UsageTrackedFeatures } from \"./UseFeatureReporting\";\n\ninterface UseHierarchyLevelFilteringProps {\n  imodel: IModelConnection;\n  defaultHierarchyLevelSizeLimit: number;\n  reportUsage?: (props: { featureId?: UsageTrackedFeatures; reportInteraction: true }) => void;\n}\n\n/** @internal */\nexport function useHierarchyLevelFiltering({ imodel, defaultHierarchyLevelSizeLimit, reportUsage }: UseHierarchyLevelFilteringProps) {\n  const [filteringOptions, setFilteringOptions] = useState<HierarchyLevelDetails>();\n\n  const propertiesSource = useMemo<(() => Promise<PresentationInstanceFilterPropertiesSource>) | undefined>(() => {\n    if (!filteringOptions) {\n      return undefined;\n    }\n\n    return async () => {\n      const keySet = await collectInstanceKeys(filteringOptions.getInstanceKeysIterator());\n      if (keySet.isEmpty) {\n        throw new Error(\"Hierarchy level is empty - unable to create content descriptor.\");\n      }\n\n      const descriptor = await Presentation.presentation.getContentDescriptor({\n        imodel,\n        rulesetOrId: {\n          id: `Hierarchy level descriptor ruleset`,\n          rules: [\n            {\n              ruleType: \"Content\",\n              specifications: [\n                {\n                  specType: \"SelectedNodeInstances\",\n                },\n              ],\n            },\n          ],\n        },\n        displayType: DefaultContentDisplayTypes.PropertyPane,\n        keys: keySet,\n      });\n      if (!descriptor) {\n        throw new Error(\"Failed to create content descriptor\");\n      }\n\n      return { descriptor, inputKeys: keySet };\n    };\n  }, [filteringOptions, imodel]);\n\n  const getInitialFilter = useMemo(() => {\n    const currentFilter = filteringOptions?.instanceFilter;\n    if (!currentFilter) {\n      return undefined;\n    }\n\n    return (descriptor: Descriptor) => fromGenericFilter(descriptor, currentFilter);\n  }, [filteringOptions]);\n\n  const filteringDialog = (\n    <PresentationInstanceFilterDialog\n      imodel={imodel}\n      isOpen={!!filteringOptions}\n      onApply={(info) => {\n        if (!filteringOptions) {\n          return;\n        }\n        reportUsage?.({ featureId: info ? \"hierarchy-level-filtering\" : undefined, reportInteraction: true });\n        filteringOptions.setInstanceFilter(toGenericFilter(info));\n        setFilteringOptions(undefined);\n      }}\n      onClose={() => {\n        setFilteringOptions(undefined);\n      }}\n      propertiesSource={propertiesSource}\n      initialFilter={getInitialFilter}\n      filterResultsCountRenderer={(filter) => {\n        if (!filteringOptions) {\n          return null;\n        }\n\n        return (\n          <MatchingInstancesCount filter={filter} hierarchyLevelDetails={filteringOptions} defaultHierarchyLevelSizeLimit={defaultHierarchyLevelSizeLimit} />\n        );\n      }}\n    />\n  );\n\n  return {\n    onFilterClick: setFilteringOptions,\n    filteringDialog,\n  };\n}\n\ninterface MatchingInstancesCountProps {\n  filter: PresentationInstanceFilterInfo;\n  hierarchyLevelDetails: HierarchyLevelDetails;\n  defaultHierarchyLevelSizeLimit: number;\n}\n\nfunction MatchingInstancesCount({ filter, defaultHierarchyLevelSizeLimit, hierarchyLevelDetails }: MatchingInstancesCountProps) {\n  const { value, inProgress } = useDebouncedAsyncValue(\n    useCallback(async () => {\n      const instanceFilter = toGenericFilter(filter);\n      try {\n        const instanceCount = await countInstanceKeys(\n          hierarchyLevelDetails.getInstanceKeysIterator({\n            instanceFilter,\n            hierarchyLevelSizeLimit: hierarchyLevelDetails.sizeLimit ?? defaultHierarchyLevelSizeLimit,\n          }),\n        );\n        return TreeWidget.translate(\"filteringDialog.matchingInstancesCount\", {\n          instanceCount: instanceCount.toLocaleString(undefined, { useGrouping: true }),\n        });\n      } catch (e) {\n        if (e instanceof RowsLimitExceededError) {\n          return TreeWidget.translate(\"filteringDialog.filterExceedsLimit\", { limit: e.limit.toLocaleString(undefined, { useGrouping: true }) });\n        }\n        return TreeWidget.translate(\"filteringDialog.failedToCalculateMatchingInstancesCount\");\n      }\n    }, [filter, hierarchyLevelDetails, defaultHierarchyLevelSizeLimit]),\n  );\n\n  if (inProgress) {\n    return (\n      <Delayed show={true}>\n        {TreeWidget.translate(\"filteringDialog.matchingInstancesCount\", { instanceCount: \"\" })}\n        <ProgressRadial size=\"x-small\" />\n      </Delayed>\n    );\n  }\n\n  return value ? <>{value}</> : null;\n}\n\nasync function countInstanceKeys(iterator: AsyncIterableIterator<InstanceKey>) {\n  let result = 0;\n  for await (const _ of iterator) {\n    result++;\n  }\n  return result;\n}\n\nasync function collectInstanceKeys(iterator: AsyncIterableIterator<InstanceKey>) {\n  const idsByClassName = new Map<Id64String, Id64Array>();\n  for await (const { className, id } of iterator) {\n    let idSet = idsByClassName.get(className);\n    if (!idSet) {\n      idSet = [];\n      idsByClassName.set(className, idSet);\n    }\n    idSet.push(id);\n  }\n\n  const instanceKeys = new Array<[className: string, compressedIds: CompressedId64Set]>();\n  for (const [className, ids] of idsByClassName) {\n    instanceKeys.push([className.toLowerCase(), CompressedId64Set.sortAndCompress(ids)]);\n  }\n  return KeySet.fromJSON({ instanceKeys, nodeKeys: [] });\n}\n\nfunction fromGenericFilter(descriptor: Descriptor, filter: GenericInstanceFilter): PresentationInstanceFilterInfo {\n  const presentationFilter =\n    GenericInstanceFilter.isFilterRuleGroup(filter.rules) && filter.rules.rules.length === 0\n      ? undefined\n      : PresentationInstanceFilter.fromGenericInstanceFilter(descriptor, filter);\n  return {\n    filter: presentationFilter,\n    usedClasses: (filter.filteredClassNames ?? [])\n      .map((name) => descriptor.selectClasses.find((selectClass) => selectClass.selectClassInfo.name === name)?.selectClassInfo)\n      .filter((classInfo): classInfo is ClassInfo => classInfo !== undefined),\n  };\n}\n\nfunction toGenericFilter(filterInfo?: PresentationInstanceFilterInfo): GenericInstanceFilter | undefined {\n  if (!filterInfo) {\n    return undefined;\n  }\n\n  if (!filterInfo.filter) {\n    return filterInfo.usedClasses.length > 0\n      ? {\n          propertyClassNames: [],\n          relatedInstances: [],\n          filteredClassNames: filterInfo.usedClasses.map((info) => info.name),\n          rules: { operator: \"and\", rules: [] },\n        }\n      : undefined;\n  }\n\n  return PresentationInstanceFilter.toGenericInstanceFilter(filterInfo.filter, filterInfo.usedClasses);\n}\n"]}

package/lib/cjs/components/trees/common/UseHierarchyVisibility.d.ts

@@ -0,0 +1,30 @@
+import type { HierarchyNode, PresentationHierarchyNode } from "@itwin/presentation-hierarchies-react";
+import type { TreeNodeCheckboxState } from "./components/TreeNodeCheckbox";
+import type { BeEvent, IDisposable } from "@itwin/core-bentley";
+/**
+ * Data structure that describes instance visibility status.
+ * @internal
+ */
+export interface VisibilityStatus {
+    state: "visible" | "partial" | "hidden";
+    isDisabled?: boolean;
+    tooltip?: string;
+}
+/** @internal */
+export interface HierarchyVisibilityHandler extends IDisposable {
+    readonly onVisibilityChange: BeEvent<() => void>;
+    getVisibilityStatus(node: HierarchyNode): Promise<VisibilityStatus> | VisibilityStatus;
+    changeVisibility(node: HierarchyNode, on: boolean): Promise<void>;
+}
+interface UseHierarchyVisibilityProps {
+    visibilityHandlerFactory: () => HierarchyVisibilityHandler;
+}
+interface UseHierarchyVisibilityResult {
+    onCheckboxClicked: (node: PresentationHierarchyNode, checked: boolean) => void;
+    getCheckboxState: (node: PresentationHierarchyNode) => TreeNodeCheckboxState;
+    triggerRefresh: () => void;
+}
+/** @internal */
+export declare function useHierarchyVisibility({ visibilityHandlerFactory }: UseHierarchyVisibilityProps): UseHierarchyVisibilityResult;
+export {};
+//# sourceMappingURL=UseHierarchyVisibility.d.ts.map

package/lib/cjs/components/trees/common/UseHierarchyVisibility.js

@@ -0,0 +1,98 @@
+"use strict";
+/*---------------------------------------------------------------------------------------------
+ * Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+ * See LICENSE.md in the project root for license terms and full copyright notice.
+ *--------------------------------------------------------------------------------------------*/
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.useHierarchyVisibility = void 0;
+const react_1 = require("react");
+const rxjs_1 = require("rxjs");
+/** @internal */
+function useHierarchyVisibility({ visibilityHandlerFactory }) {
+    const nodesStateMap = (0, react_1.useRef)(new Map());
+    const [state, setState] = (0, react_1.useState)({
+        getCheckboxState: () => ({ state: "off", isDisabled: true }),
+        onCheckboxClicked: () => { },
+        triggerRefresh: () => { },
+    });
+    (0, react_1.useEffect)(() => {
+        nodesStateMap.current.clear();
+        const handler = visibilityHandlerFactory();
+        const visibilityChanged = new rxjs_1.Subject();
+        const calculate = new rxjs_1.Subject();
+        const calculateNodeStatus = (node) => {
+            calculate.next(node);
+        };
+        const resetCache = () => {
+            nodesStateMap.current.forEach((value) => {
+                value.needsRefresh = true;
+            });
+            visibilityChanged.next();
+        };
+        const triggerCheckboxUpdate = () => {
+            setState((prev) => ({
+                ...prev,
+                getCheckboxState: createStateGetter(nodesStateMap, calculateNodeStatus),
+            }));
+        };
+        const subscription = calculate
+            .pipe((0, rxjs_1.distinct)(undefined, visibilityChanged), (0, rxjs_1.mergeMap)((node) => (0, rxjs_1.defer)(async () => ({ node, status: await handler.getVisibilityStatus(node.nodeData) })).pipe((0, rxjs_1.takeUntil)(visibilityChanged))))
+            .subscribe({
+            next: ({ node, status }) => {
+                nodesStateMap.current.set(node.id, {
+                    node,
+                    state: {
+                        state: status.state === "visible" ? "on" : status.state === "partial" ? "partial" : "off",
+                        tooltip: status.tooltip,
+                        isDisabled: status.isDisabled,
+                    },
+                    needsRefresh: false,
+                });
+                triggerCheckboxUpdate();
+            },
+        });
+        const changeVisibility = (node, checked) => {
+            void handler.changeVisibility(node.nodeData, checked);
+            const entry = nodesStateMap.current.get(node.id);
+            if (!entry) {
+                return;
+            }
+            entry.state.state = checked ? "on" : "off";
+            entry.state.tooltip = undefined;
+            triggerCheckboxUpdate();
+        };
+        setState({
+            onCheckboxClicked: changeVisibility,
+            getCheckboxState: createStateGetter(nodesStateMap, calculateNodeStatus),
+            triggerRefresh: () => {
+                resetCache();
+                triggerCheckboxUpdate();
+            },
+        });
+        const removeListener = handler.onVisibilityChange.addListener(() => {
+            resetCache();
+            triggerCheckboxUpdate();
+        });
+        return () => {
+            subscription.unsubscribe();
+            removeListener();
+            handler.dispose();
+        };
+    }, [visibilityHandlerFactory]);
+    return state;
+}
+exports.useHierarchyVisibility = useHierarchyVisibility;
+function createStateGetter(map, calculateVisibility) {
+    return (node) => {
+        const entry = map.current.get(node.id);
+        if (entry === undefined) {
+            calculateVisibility(node);
+            return { state: "off", isDisabled: true };
+        }
+        if (entry.needsRefresh) {
+            calculateVisibility(node);
+        }
+        return entry.state;
+    };
+}
+//# sourceMappingURL=UseHierarchyVisibility.js.map

package/lib/cjs/components/trees/common/UseHierarchyVisibility.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"UseHierarchyVisibility.js","sourceRoot":"","sources":["../../../../../src/components/trees/common/UseHierarchyVisibility.ts"],"names":[],"mappings":";AAAA;;;gGAGgG;;;AAEhG,iCAAoD;AACpD,+BAAqE;AAkCrE,gBAAgB;AAChB,SAAgB,sBAAsB,CAAC,EAAE,wBAAwB,EAA+B;IAC9F,MAAM,aAAa,GAAG,IAAA,cAAM,EAAC,IAAI,GAAG,EAAoG,CAAC,CAAC;IAC1I,MAAM,CAAC,KAAK,EAAE,QAAQ,CAAC,GAAG,IAAA,gBAAQ,EAA+B;QAC/D,gBAAgB,EAAE,GAAG,EAAE,CAAC,CAAC,EAAE,KAAK,EAAE,KAAK,EAAE,UAAU,EAAE,IAAI,EAAE,CAAC;QAC5D,iBAAiB,EAAE,GAAG,EAAE,GAAE,CAAC;QAC3B,cAAc,EAAE,GAAG,EAAE,GAAE,CAAC;KACzB,CAAC,CAAC;IAEH,IAAA,iBAAS,EAAC,GAAG,EAAE;QACb,aAAa,CAAC,OAAO,CAAC,KAAK,EAAE,CAAC;QAC9B,MAAM,OAAO,GAAG,wBAAwB,EAAE,CAAC;QAE3C,MAAM,iBAAiB,GAAG,IAAI,cAAO,EAAQ,CAAC;QAC9C,MAAM,SAAS,GAAG,IAAI,cAAO,EAA6B,CAAC;QAC3D,MAAM,mBAAmB,GAAG,CAAC,IAA+B,EAAE,EAAE;YAC9D,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QACvB,CAAC,CAAC;QAEF,MAAM,UAAU,GAAG,GAAG,EAAE;YACtB,aAAa,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,KAAK,EAAE,EAAE;gBACtC,KAAK,CAAC,YAAY,GAAG,IAAI,CAAC;YAC5B,CAAC,CAAC,CAAC;YACH,iBAAiB,CAAC,IAAI,EAAE,CAAC;QAC3B,CAAC,CAAC;QAEF,MAAM,qBAAqB,GAAG,GAAG,EAAE;YACjC,QAAQ,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC;gBAClB,GAAG,IAAI;gBACP,gBAAgB,EAAE,iBAAiB,CAAC,aAAa,EAAE,mBAAmB,CAAC;aACxE,CAAC,CAAC,CAAC;QACN,CAAC,CAAC;QAEF,MAAM,YAAY,GAAG,SAAS;aAC3B,IAAI,CACH,IAAA,eAAQ,EAAC,SAAS,EAAE,iBAAiB,CAAC,EACtC,IAAA,eAAQ,EAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAA,YAAK,EAAC,KAAK,IAAI,EAAE,CAAC,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,MAAM,OAAO,CAAC,mBAAmB,CAAC,IAAI,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,IAAA,gBAAS,EAAC,iBAAiB,CAAC,CAAC,CAAC,CAC/I;aACA,SAAS,CAAC;YACT,IAAI,EAAE,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,EAAE,EAAE;gBACzB,aAAa,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,EAAE;oBACjC,IAAI;oBACJ,KAAK,EAAE;wBACL,KAAK,EAAE,MAAM,CAAC,KAAK,KAAK,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,KAAK,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,KAAK;wBACzF,OAAO,EAAE,MAAM,CAAC,OAAO;wBACvB,UAAU,EAAE,MAAM,CAAC,UAAU;qBAC9B;oBACD,YAAY,EAAE,KAAK;iBACpB,CAAC,CAAC;gBACH,qBAAqB,EAAE,CAAC;YAC1B,CAAC;SACF,CAAC,CAAC;QAEL,MAAM,gBAAgB,GAAG,CAAC,IAA+B,EAAE,OAAgB,EAAE,EAAE;YAC7E,KAAK,OAAO,CAAC,gBAAgB,CAAC,IAAI,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC;YACtD,MAAM,KAAK,GAAG,aAAa,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;YACjD,IAAI,CAAC,KAAK,EAAE;gBACV,OAAO;aACR;YACD,KAAK,CAAC,KAAK,CAAC,KAAK,GAAG,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,KAAK,CAAC;YAC3C,KAAK,CAAC,KAAK,CAAC,OAAO,GAAG,SAAS,CAAC;YAChC,qBAAqB,EAAE,CAAC;QAC1B,CAAC,CAAC;QAEF,QAAQ,CAAC;YACP,iBAAiB,EAAE,gBAAgB;YACnC,gBAAgB,EAAE,iBAAiB,CAAC,aAAa,EAAE,mBAAmB,CAAC;YACvE,cAAc,EAAE,GAAG,EAAE;gBACnB,UAAU,EAAE,CAAC;gBACb,qBAAqB,EAAE,CAAC;YAC1B,CAAC;SACF,CAAC,CAAC;QAEH,MAAM,cAAc,GAAG,OAAO,CAAC,kBAAkB,CAAC,WAAW,CAAC,GAAG,EAAE;YACjE,UAAU,EAAE,CAAC;YACb,qBAAqB,EAAE,CAAC;QAC1B,CAAC,CAAC,CAAC;QAEH,OAAO,GAAG,EAAE;YACV,YAAY,CAAC,WAAW,EAAE,CAAC;YAC3B,cAAc,EAAE,CAAC;YACjB,OAAO,CAAC,OAAO,EAAE,CAAC;QACpB,CAAC,CAAC;IACJ,CAAC,EAAE,CAAC,wBAAwB,CAAC,CAAC,CAAC;IAE/B,OAAO,KAAK,CAAC;AACf,CAAC;AArFD,wDAqFC;AAED,SAAS,iBAAiB,CACxB,GAA4H,EAC5H,mBAA8D;IAE9D,OAAO,CAAC,IAA+B,EAAyB,EAAE;QAChE,MAAM,KAAK,GAAG,GAAG,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;QACvC,IAAI,KAAK,KAAK,SAAS,EAAE;YACvB,mBAAmB,CAAC,IAAI,CAAC,CAAC;YAC1B,OAAO,EAAE,KAAK,EAAE,KAAK,EAAE,UAAU,EAAE,IAAI,EAAE,CAAC;SAC3C;QACD,IAAI,KAAK,CAAC,YAAY,EAAE;YACtB,mBAAmB,CAAC,IAAI,CAAC,CAAC;SAC3B;QAED,OAAO,KAAK,CAAC,KAAK,CAAC;IACrB,CAAC,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\nimport { useEffect, useRef, useState } from \"react\";\nimport { defer, distinct, mergeMap, Subject, takeUntil } from \"rxjs\";\n\nimport type { HierarchyNode, PresentationHierarchyNode } from \"@itwin/presentation-hierarchies-react\";\nimport type { MutableRefObject } from \"react\";\nimport type { TreeNodeCheckboxState } from \"./components/TreeNodeCheckbox\";\nimport type { BeEvent, IDisposable } from \"@itwin/core-bentley\";\n\n/**\n * Data structure that describes instance visibility status.\n * @internal\n */\nexport interface VisibilityStatus {\n  state: \"visible\" | \"partial\" | \"hidden\";\n  isDisabled?: boolean;\n  tooltip?: string;\n}\n\n/** @internal */\nexport interface HierarchyVisibilityHandler extends IDisposable {\n  readonly onVisibilityChange: BeEvent<() => void>;\n  getVisibilityStatus(node: HierarchyNode): Promise<VisibilityStatus> | VisibilityStatus;\n  changeVisibility(node: HierarchyNode, on: boolean): Promise<void>;\n}\n\ninterface UseHierarchyVisibilityProps {\n  visibilityHandlerFactory: () => HierarchyVisibilityHandler;\n}\n\ninterface UseHierarchyVisibilityResult {\n  onCheckboxClicked: (node: PresentationHierarchyNode, checked: boolean) => void;\n  getCheckboxState: (node: PresentationHierarchyNode) => TreeNodeCheckboxState;\n  triggerRefresh: () => void;\n}\n\n/** @internal */\nexport function useHierarchyVisibility({ visibilityHandlerFactory }: UseHierarchyVisibilityProps): UseHierarchyVisibilityResult {\n  const nodesStateMap = useRef(new Map<string, { node: PresentationHierarchyNode; state: TreeNodeCheckboxState; needsRefresh: boolean }>());\n  const [state, setState] = useState<UseHierarchyVisibilityResult>({\n    getCheckboxState: () => ({ state: \"off\", isDisabled: true }),\n    onCheckboxClicked: () => {},\n    triggerRefresh: () => {},\n  });\n\n  useEffect(() => {\n    nodesStateMap.current.clear();\n    const handler = visibilityHandlerFactory();\n\n    const visibilityChanged = new Subject<void>();\n    const calculate = new Subject<PresentationHierarchyNode>();\n    const calculateNodeStatus = (node: PresentationHierarchyNode) => {\n      calculate.next(node);\n    };\n\n    const resetCache = () => {\n      nodesStateMap.current.forEach((value) => {\n        value.needsRefresh = true;\n      });\n      visibilityChanged.next();\n    };\n\n    const triggerCheckboxUpdate = () => {\n      setState((prev) => ({\n        ...prev,\n        getCheckboxState: createStateGetter(nodesStateMap, calculateNodeStatus),\n      }));\n    };\n\n    const subscription = calculate\n      .pipe(\n        distinct(undefined, visibilityChanged),\n        mergeMap((node) => defer(async () => ({ node, status: await handler.getVisibilityStatus(node.nodeData) })).pipe(takeUntil(visibilityChanged))),\n      )\n      .subscribe({\n        next: ({ node, status }) => {\n          nodesStateMap.current.set(node.id, {\n            node,\n            state: {\n              state: status.state === \"visible\" ? \"on\" : status.state === \"partial\" ? \"partial\" : \"off\",\n              tooltip: status.tooltip,\n              isDisabled: status.isDisabled,\n            },\n            needsRefresh: false,\n          });\n          triggerCheckboxUpdate();\n        },\n      });\n\n    const changeVisibility = (node: PresentationHierarchyNode, checked: boolean) => {\n      void handler.changeVisibility(node.nodeData, checked);\n      const entry = nodesStateMap.current.get(node.id);\n      if (!entry) {\n        return;\n      }\n      entry.state.state = checked ? \"on\" : \"off\";\n      entry.state.tooltip = undefined;\n      triggerCheckboxUpdate();\n    };\n\n    setState({\n      onCheckboxClicked: changeVisibility,\n      getCheckboxState: createStateGetter(nodesStateMap, calculateNodeStatus),\n      triggerRefresh: () => {\n        resetCache();\n        triggerCheckboxUpdate();\n      },\n    });\n\n    const removeListener = handler.onVisibilityChange.addListener(() => {\n      resetCache();\n      triggerCheckboxUpdate();\n    });\n\n    return () => {\n      subscription.unsubscribe();\n      removeListener();\n      handler.dispose();\n    };\n  }, [visibilityHandlerFactory]);\n\n  return state;\n}\n\nfunction createStateGetter(\n  map: MutableRefObject<Map<string, { node: PresentationHierarchyNode; state: TreeNodeCheckboxState; needsRefresh: boolean }>>,\n  calculateVisibility: (node: PresentationHierarchyNode) => void,\n) {\n  return (node: PresentationHierarchyNode): TreeNodeCheckboxState => {\n    const entry = map.current.get(node.id);\n    if (entry === undefined) {\n      calculateVisibility(node);\n      return { state: \"off\", isDisabled: true };\n    }\n    if (entry.needsRefresh) {\n      calculateVisibility(node);\n    }\n\n    return entry.state;\n  };\n}\n"]}

package/lib/cjs/components/trees/common/UseIModelChangeListener.d.ts

@@ -0,0 +1,9 @@
+import type { IModelConnection } from "@itwin/core-frontend";
+interface UseIModelChangeListenerProps {
+    imodel: IModelConnection;
+    action: () => void;
+}
+/** @internal */
+export declare function useIModelChangeListener({ imodel, action }: UseIModelChangeListenerProps): void;
+export {};
+//# sourceMappingURL=UseIModelChangeListener.d.ts.map

package/lib/cjs/components/trees/common/UseIModelChangeListener.js

@@ -0,0 +1,20 @@
+"use strict";
+/*---------------------------------------------------------------------------------------------
+ * Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+ * See LICENSE.md in the project root for license terms and full copyright notice.
+ *--------------------------------------------------------------------------------------------*/
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.useIModelChangeListener = void 0;
+const react_1 = require("react");
+const presentation_core_interop_1 = require("@itwin/presentation-core-interop");
+/** @internal */
+function useIModelChangeListener({ imodel, action }) {
+    (0, react_1.useEffect)(() => {
+        if (!imodel.isBriefcaseConnection()) {
+            return;
+        }
+        (0, presentation_core_interop_1.registerTxnListeners)(imodel.txns, action);
+    }, [imodel, action]);
+}
+exports.useIModelChangeListener = useIModelChangeListener;
+//# sourceMappingURL=UseIModelChangeListener.js.map

package/lib/cjs/components/trees/common/UseIModelChangeListener.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"UseIModelChangeListener.js","sourceRoot":"","sources":["../../../../../src/components/trees/common/UseIModelChangeListener.ts"],"names":[],"mappings":";AAAA;;;gGAGgG;;;AAEhG,iCAAkC;AAClC,gFAAwE;AASxE,gBAAgB;AAChB,SAAgB,uBAAuB,CAAC,EAAE,MAAM,EAAE,MAAM,EAAgC;IACtF,IAAA,iBAAS,EAAC,GAAG,EAAE;QACb,IAAI,CAAC,MAAM,CAAC,qBAAqB,EAAE,EAAE;YACnC,OAAO;SACR;QAED,IAAA,gDAAoB,EAAC,MAAM,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;IAC5C,CAAC,EAAE,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,CAAC;AACvB,CAAC;AARD,0DAQC","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\nimport { useEffect } from \"react\";\nimport { registerTxnListeners } from \"@itwin/presentation-core-interop\";\n\nimport type { IModelConnection } from \"@itwin/core-frontend\";\n\ninterface UseIModelChangeListenerProps {\n  imodel: IModelConnection;\n  action: () => void;\n}\n\n/** @internal */\nexport function useIModelChangeListener({ imodel, action }: UseIModelChangeListenerProps) {\n  useEffect(() => {\n    if (!imodel.isBriefcaseConnection()) {\n      return;\n    }\n\n    registerTxnListeners(imodel.txns, action);\n  }, [imodel, action]);\n}\n"]}

package/lib/cjs/components/trees/common/UseMultiCheckboxHandler.d.ts

@@ -0,0 +1,13 @@
+import type { PresentationHierarchyNode, PresentationTreeNode } from "@itwin/presentation-hierarchies-react";
+interface UseMultiCheckboxHandlerProps {
+    rootNodes: PresentationTreeNode[] | undefined;
+    isNodeSelected: (nodeId: string) => boolean;
+    onClick: (node: PresentationHierarchyNode, checked: boolean) => void;
+}
+interface UseMultiCheckboxHandlerResult {
+    onCheckboxClicked: (node: PresentationHierarchyNode, checked: boolean) => void;
+}
+/** @internal */
+export declare function useMultiCheckboxHandler({ rootNodes, isNodeSelected, onClick }: UseMultiCheckboxHandlerProps): UseMultiCheckboxHandlerResult;
+export {};
+//# sourceMappingURL=UseMultiCheckboxHandler.d.ts.map

package/lib/cjs/components/trees/common/UseMultiCheckboxHandler.js

@@ -0,0 +1,35 @@
+"use strict";
+/*---------------------------------------------------------------------------------------------
+ * Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+ * See LICENSE.md in the project root for license terms and full copyright notice.
+ *--------------------------------------------------------------------------------------------*/
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.useMultiCheckboxHandler = void 0;
+const react_1 = require("react");
+const presentation_hierarchies_react_1 = require("@itwin/presentation-hierarchies-react");
+/** @internal */
+function useMultiCheckboxHandler({ rootNodes, isNodeSelected, onClick }) {
+    const onCheckboxClicked = (0, react_1.useCallback)((clickedNode, checked) => {
+        if (!isNodeSelected(clickedNode.id)) {
+            onClick(clickedNode, checked);
+            return;
+        }
+        rootNodes && forEachSelectedNode(rootNodes, isNodeSelected, (node) => onClick(node, checked));
+    }, [rootNodes, isNodeSelected, onClick]);
+    return { onCheckboxClicked };
+}
+exports.useMultiCheckboxHandler = useMultiCheckboxHandler;
+function forEachSelectedNode(nodes, isNodeSelected, callback) {
+    nodes.forEach((node) => {
+        if (!(0, presentation_hierarchies_react_1.isPresentationHierarchyNode)(node)) {
+            return;
+        }
+        if (isNodeSelected(node.id)) {
+            callback(node);
+        }
+        if (node.isExpanded && typeof node.children !== "boolean") {
+            forEachSelectedNode(node.children, isNodeSelected, callback);
+        }
+    });
+}
+//# sourceMappingURL=UseMultiCheckboxHandler.js.map

package/lib/cjs/components/trees/common/UseMultiCheckboxHandler.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"UseMultiCheckboxHandler.js","sourceRoot":"","sources":["../../../../../src/components/trees/common/UseMultiCheckboxHandler.ts"],"names":[],"mappings":";AAAA;;;gGAGgG;;;AAEhG,iCAAoC;AACpC,0FAAoF;AAcpF,gBAAgB;AAChB,SAAgB,uBAAuB,CAAC,EAAE,SAAS,EAAE,cAAc,EAAE,OAAO,EAAgC;IAC1G,MAAM,iBAAiB,GAAG,IAAA,mBAAW,EACnC,CAAC,WAAsC,EAAE,OAAgB,EAAE,EAAE;QAC3D,IAAI,CAAC,cAAc,CAAC,WAAW,CAAC,EAAE,CAAC,EAAE;YACnC,OAAO,CAAC,WAAW,EAAE,OAAO,CAAC,CAAC;YAC9B,OAAO;SACR;QACD,SAAS,IAAI,mBAAmB,CAAC,SAAS,EAAE,cAAc,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,OAAO,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC,CAAC;IAChG,CAAC,EACD,CAAC,SAAS,EAAE,cAAc,EAAE,OAAO,CAAC,CACrC,CAAC;IAEF,OAAO,EAAE,iBAAiB,EAAE,CAAC;AAC/B,CAAC;AAbD,0DAaC;AAED,SAAS,mBAAmB,CAC1B,KAAkC,EAClC,cAA2C,EAC3C,QAAmD;IAEnD,KAAK,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,EAAE;QACrB,IAAI,CAAC,IAAA,4DAA2B,EAAC,IAAI,CAAC,EAAE;YACtC,OAAO;SACR;QACD,IAAI,cAAc,CAAC,IAAI,CAAC,EAAE,CAAC,EAAE;YAC3B,QAAQ,CAAC,IAAI,CAAC,CAAC;SAChB;QACD,IAAI,IAAI,CAAC,UAAU,IAAI,OAAO,IAAI,CAAC,QAAQ,KAAK,SAAS,EAAE;YACzD,mBAAmB,CAAC,IAAI,CAAC,QAAQ,EAAE,cAAc,EAAE,QAAQ,CAAC,CAAC;SAC9D;IACH,CAAC,CAAC,CAAC;AACL,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\nimport { useCallback } from \"react\";\nimport { isPresentationHierarchyNode } from \"@itwin/presentation-hierarchies-react\";\n\nimport type { PresentationHierarchyNode, PresentationTreeNode } from \"@itwin/presentation-hierarchies-react\";\n\ninterface UseMultiCheckboxHandlerProps {\n  rootNodes: PresentationTreeNode[] | undefined;\n  isNodeSelected: (nodeId: string) => boolean;\n  onClick: (node: PresentationHierarchyNode, checked: boolean) => void;\n}\n\ninterface UseMultiCheckboxHandlerResult {\n  onCheckboxClicked: (node: PresentationHierarchyNode, checked: boolean) => void;\n}\n\n/** @internal */\nexport function useMultiCheckboxHandler({ rootNodes, isNodeSelected, onClick }: UseMultiCheckboxHandlerProps): UseMultiCheckboxHandlerResult {\n  const onCheckboxClicked = useCallback(\n    (clickedNode: PresentationHierarchyNode, checked: boolean) => {\n      if (!isNodeSelected(clickedNode.id)) {\n        onClick(clickedNode, checked);\n        return;\n      }\n      rootNodes && forEachSelectedNode(rootNodes, isNodeSelected, (node) => onClick(node, checked));\n    },\n    [rootNodes, isNodeSelected, onClick],\n  );\n\n  return { onCheckboxClicked };\n}\n\nfunction forEachSelectedNode(\n  nodes: Array<PresentationTreeNode>,\n  isNodeSelected: (nodeId: string) => boolean,\n  callback: (node: PresentationHierarchyNode) => void,\n) {\n  nodes.forEach((node) => {\n    if (!isPresentationHierarchyNode(node)) {\n      return;\n    }\n    if (isNodeSelected(node.id)) {\n      callback(node);\n    }\n    if (node.isExpanded && typeof node.children !== \"boolean\") {\n      forEachSelectedNode(node.children, isNodeSelected, callback);\n    }\n  });\n}\n"]}

package/lib/cjs/components/trees/common/UseNodeHighlighting.d.ts

@@ -0,0 +1,16 @@
+/// <reference types="react" />
+import type { PresentationHierarchyNode, PresentationTreeNode } from "@itwin/presentation-hierarchies-react";
+interface UseNodeHighlightingProps {
+    rootNodes: PresentationTreeNode[] | undefined;
+    searchText?: string;
+    activeMatchIndex?: number;
+    onHighlightChanged?: (activeMatchIndex: number, matches: number) => void;
+}
+interface UseNodeHighlightingResult {
+    activeNodeId?: string;
+    getLabel: (node: PresentationHierarchyNode) => React.ReactElement;
+}
+/** @internal */
+export declare function useNodeHighlighting({ rootNodes, searchText, activeMatchIndex, onHighlightChanged }: UseNodeHighlightingProps): UseNodeHighlightingResult;
+export {};
+//# sourceMappingURL=UseNodeHighlighting.d.ts.map