@itwin/tree-widget-react 4.0.0-alpha.6 → 4.0.0-alpha.8

package/lib/esm/tree-widget-react/components/trees/categories-tree/internal/UseFilteredPaths.js

@@ -0,0 +1,133 @@
+/*---------------------------------------------------------------------------------------------
+ * Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+ * See LICENSE.md in the project root for license terms and full copyright notice.
+ *--------------------------------------------------------------------------------------------*/
+import { useEffect, useMemo, useState } from "react";
+import { assert } from "@itwin/core-bentley";
+import { HierarchyFilteringPath, HierarchyNodeIdentifier } from "@itwin/presentation-hierarchies";
+import { DEFINITION_CONTAINER_CLASS_NAME, SUB_CATEGORY_CLASS_NAME } from "../../common/internal/ClassNameDefinitions.js";
+import { getClassesByView } from "../../common/internal/Utils.js";
+import { FilterLimitExceededError } from "../../common/TreeErrors.js";
+import { useTelemetryContext } from "../../common/UseTelemetryContext.js";
+import { CategoriesTreeDefinition } from "../CategoriesTreeDefinition.js";
+/** @internal */
+export function useFilteredPaths({ filter, viewType, hierarchyConfiguration, getCategoriesTreeIdsCache, onCategoriesFiltered, onFilteredPathsChanged, }) {
+    const [filteringError, setFilteringError] = useState();
+    const { onFeatureUsed } = useTelemetryContext();
+    useEffect(() => {
+        setFilteringError(undefined);
+        onCategoriesFiltered?.({ categories: undefined, models: undefined });
+        if (!filter) {
+            onFilteredPathsChanged(undefined);
+        }
+    }, [filter, onCategoriesFiltered, onFilteredPathsChanged]);
+    const getFilteredPaths = useMemo(() => {
+        if (!filter) {
+            return undefined;
+        }
+        return async ({ imodelAccess }) => {
+            onFeatureUsed({ featureId: "filtering", reportInteraction: true });
+            try {
+                const paths = await CategoriesTreeDefinition.createInstanceKeyPaths({
+                    imodelAccess,
+                    label: filter,
+                    viewType,
+                    idsCache: getCategoriesTreeIdsCache(),
+                    hierarchyConfig: hierarchyConfiguration,
+                });
+                onFilteredPathsChanged(paths);
+                const { elementClass, modelClass } = getClassesByView(viewType);
+                onCategoriesFiltered?.(await getCategoriesFromPaths(paths, getCategoriesTreeIdsCache(), elementClass, modelClass));
+                return paths;
+            }
+            catch (e) {
+                const newError = e instanceof FilterLimitExceededError ? "tooManyFilterMatches" : "unknownFilterError";
+                if (newError !== "tooManyFilterMatches") {
+                    const feature = e instanceof Error && e.message.includes("query too long to execute or server is too busy") ? "error-timeout" : "error-unknown";
+                    onFeatureUsed({ featureId: feature, reportInteraction: false });
+                }
+                setFilteringError(newError);
+                return [];
+            }
+        };
+    }, [onCategoriesFiltered, filter, onFilteredPathsChanged, onFeatureUsed, viewType, getCategoriesTreeIdsCache, hierarchyConfiguration]);
+    return {
+        getPaths: getFilteredPaths,
+        filteringError,
+    };
+}
+async function getCategoriesFromPaths(paths, idsCache, elementClassName, modelsClassName) {
+    if (!paths) {
+        return { categories: undefined };
+    }
+    const rootFilteredElementIds = new Set();
+    const subModelIds = new Set();
+    const categories = new Map();
+    for (const path of paths) {
+        const currPath = HierarchyFilteringPath.normalize(path).path;
+        if (currPath.length === 0) {
+            continue;
+        }
+        let category;
+        let subCategory;
+        let lastNodeInfo;
+        for (let i = 0; i < currPath.length; ++i) {
+            const currentNode = currPath[i];
+            if (!HierarchyNodeIdentifier.isInstanceNodeIdentifier(currentNode)) {
+                continue;
+            }
+            if (currentNode.className === elementClassName) {
+                rootFilteredElementIds.add(currentNode.id);
+                for (let j = i + 1; j < currPath.length; ++j) {
+                    const childNode = currPath[j];
+                    if (!HierarchyNodeIdentifier.isInstanceNodeIdentifier(childNode)) {
+                        continue;
+                    }
+                    if (childNode.className === modelsClassName) {
+                        subModelIds.add(childNode.id);
+                    }
+                }
+                break;
+            }
+            lastNodeInfo = { lastNode: currentNode, nodeIndex: i };
+        }
+        assert(lastNodeInfo !== undefined && HierarchyNodeIdentifier.isInstanceNodeIdentifier(lastNodeInfo.lastNode));
+        if (lastNodeInfo.lastNode.className === DEFINITION_CONTAINER_CLASS_NAME) {
+            const definitionContainerCategories = await idsCache.getAllContainedCategories([lastNodeInfo.lastNode.id]);
+            for (const categoryId of definitionContainerCategories) {
+                const value = categories.get(categoryId);
+                if (value === undefined) {
+                    categories.set(categoryId, []);
+                }
+            }
+            continue;
+        }
+        if (lastNodeInfo.lastNode.className === SUB_CATEGORY_CLASS_NAME) {
+            const secondToLastNode = lastNodeInfo.nodeIndex > 0 ? currPath[lastNodeInfo.nodeIndex - 1] : undefined;
+            assert(secondToLastNode !== undefined && HierarchyNodeIdentifier.isInstanceNodeIdentifier(secondToLastNode));
+            subCategory = lastNodeInfo.lastNode;
+            category = secondToLastNode;
+        }
+        else {
+            category = lastNodeInfo.lastNode;
+        }
+        let entry = categories.get(category.id);
+        if (entry === undefined) {
+            entry = [];
+            categories.set(category.id, entry);
+        }
+        if (subCategory) {
+            entry.push(subCategory.id);
+        }
+    }
+    const rootElementModelMap = await idsCache.getFilteredElementsModels([...rootFilteredElementIds]);
+    const models = [...subModelIds, ...new Set(rootElementModelMap.values())];
+    return {
+        categories: [...categories.entries()].map(([categoryId, subCategoryIds]) => ({
+            categoryId,
+            subCategoryIds: subCategoryIds.length === 0 ? undefined : subCategoryIds,
+        })),
+        models,
+    };
+}
+//# sourceMappingURL=UseFilteredPaths.js.map

package/lib/esm/tree-widget-react/components/trees/categories-tree/internal/UseFilteredPaths.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"UseFilteredPaths.js","sourceRoot":"","sources":["../../../../../../../src/tree-widget-react/components/trees/categories-tree/internal/UseFilteredPaths.ts"],"names":[],"mappings":"AAAA;;;gGAGgG;AAEhG,OAAO,EAAE,SAAS,EAAE,OAAO,EAAE,QAAQ,EAAE,MAAM,OAAO,CAAC;AACrD,OAAO,EAAE,MAAM,EAAE,MAAM,qBAAqB,CAAC;AAC7C,OAAO,EAAE,sBAAsB,EAAE,uBAAuB,EAAE,MAAM,iCAAiC,CAAC;AAClG,OAAO,EAAE,+BAA+B,EAAE,uBAAuB,EAAE,MAAM,+CAA+C,CAAC;AACzH,OAAO,EAAE,gBAAgB,EAAE,MAAM,gCAAgC,CAAC;AAClE,OAAO,EAAE,wBAAwB,EAAE,MAAM,4BAA4B,CAAC;AACtE,OAAO,EAAE,mBAAmB,EAAE,MAAM,qCAAqC,CAAC;AAC1E,OAAO,EAAE,wBAAwB,EAAE,MAAM,gCAAgC,CAAC;AAa1E,gBAAgB;AAChB,MAAM,UAAU,gBAAgB,CAAC,EAC/B,MAAM,EACN,QAAQ,EACR,sBAAsB,EACtB,yBAAyB,EACzB,oBAAoB,EACpB,sBAAsB,GAQvB;IAIC,MAAM,CAAC,cAAc,EAAE,iBAAiB,CAAC,GAAG,QAAQ,EAA4C,CAAC;IACjG,MAAM,EAAE,aAAa,EAAE,GAAG,mBAAmB,EAAE,CAAC;IAEhD,SAAS,CAAC,GAAG,EAAE;QACb,iBAAiB,CAAC,SAAS,CAAC,CAAC;QAC7B,oBAAoB,EAAE,CAAC,EAAE,UAAU,EAAE,SAAS,EAAE,MAAM,EAAE,SAAS,EAAE,CAAC,CAAC;QACrE,IAAI,CAAC,MAAM,EAAE;YACX,sBAAsB,CAAC,SAAS,CAAC,CAAC;SACnC;IACH,CAAC,EAAE,CAAC,MAAM,EAAE,oBAAoB,EAAE,sBAAsB,CAAC,CAAC,CAAC;IAE3D,MAAM,gBAAgB,GAAG,OAAO,CAAsD,GAAG,EAAE;QACzF,IAAI,CAAC,MAAM,EAAE;YACX,OAAO,SAAS,CAAC;SAClB;QAED,OAAO,KAAK,EAAE,EAAE,YAAY,EAAE,EAAE,EAAE;YAChC,aAAa,CAAC,EAAE,SAAS,EAAE,WAAW,EAAE,iBAAiB,EAAE,IAAI,EAAE,CAAC,CAAC;YACnE,IAAI;gBACF,MAAM,KAAK,GAAG,MAAM,wBAAwB,CAAC,sBAAsB,CAAC;oBAClE,YAAY;oBACZ,KAAK,EAAE,MAAM;oBACb,QAAQ;oBACR,QAAQ,EAAE,yBAAyB,EAAE;oBACrC,eAAe,EAAE,sBAAsB;iBACxC,CAAC,CAAC;gBACH,sBAAsB,CAAC,KAAK,CAAC,CAAC;gBAC9B,MAAM,EAAE,YAAY,EAAE,UAAU,EAAE,GAAG,gBAAgB,CAAC,QAAQ,CAAC,CAAC;gBAChE,oBAAoB,EAAE,CAAC,MAAM,sBAAsB,CAAC,KAAK,EAAE,yBAAyB,EAAE,EAAE,YAAY,EAAE,UAAU,CAAC,CAAC,CAAC;gBACnH,OAAO,KAAK,CAAC;aACd;YAAC,OAAO,CAAC,EAAE;gBACV,MAAM,QAAQ,GAAG,CAAC,YAAY,wBAAwB,CAAC,CAAC,CAAC,sBAAsB,CAAC,CAAC,CAAC,oBAAoB,CAAC;gBACvG,IAAI,QAAQ,KAAK,sBAAsB,EAAE;oBACvC,MAAM,OAAO,GAAG,CAAC,YAAY,KAAK,IAAI,CAAC,CAAC,OAAO,CAAC,QAAQ,CAAC,iDAAiD,CAAC,CAAC,CAAC,CAAC,eAAe,CAAC,CAAC,CAAC,eAAe,CAAC;oBAChJ,aAAa,CAAC,EAAE,SAAS,EAAE,OAAO,EAAE,iBAAiB,EAAE,KAAK,EAAE,CAAC,CAAC;iBACjE;gBACD,iBAAiB,CAAC,QAAQ,CAAC,CAAC;gBAC5B,OAAO,EAAE,CAAC;aACX;QACH,CAAC,CAAC;IACJ,CAAC,EAAE,CAAC,oBAAoB,EAAE,MAAM,EAAE,sBAAsB,EAAE,aAAa,EAAE,QAAQ,EAAE,yBAAyB,EAAE,sBAAsB,CAAC,CAAC,CAAC;IAEvI,OAAO;QACL,QAAQ,EAAE,gBAAgB;QAC1B,cAAc;KACf,CAAC;AACJ,CAAC;AAED,KAAK,UAAU,sBAAsB,CACnC,KAA8B,EAC9B,QAAgC,EAChC,gBAAwB,EACxB,eAAuB;IAEvB,IAAI,CAAC,KAAK,EAAE;QACV,OAAO,EAAE,UAAU,EAAE,SAAS,EAAE,CAAC;KAClC;IAED,MAAM,sBAAsB,GAAG,IAAI,GAAG,EAAa,CAAC;IACpD,MAAM,WAAW,GAAG,IAAI,GAAG,EAAW,CAAC;IAEvC,MAAM,UAAU,GAAG,IAAI,GAAG,EAAoC,CAAC;IAC/D,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE;QACxB,MAAM,QAAQ,GAAG,sBAAsB,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC;QAC7D,IAAI,QAAQ,CAAC,MAAM,KAAK,CAAC,EAAE;YACzB,SAAS;SACV;QAED,IAAI,QAAiC,CAAC;QACtC,IAAI,WAAgD,CAAC;QAErD,IAAI,YAAkF,CAAC;QAEvF,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,QAAQ,CAAC,MAAM,EAAE,EAAE,CAAC,EAAE;YACxC,MAAM,WAAW,GAAG,QAAQ,CAAC,CAAC,CAAC,CAAC;YAChC,IAAI,CAAC,uBAAuB,CAAC,wBAAwB,CAAC,WAAW,CAAC,EAAE;gBAClE,SAAS;aACV;YACD,IAAI,WAAW,CAAC,SAAS,KAAK,gBAAgB,EAAE;gBAC9C,sBAAsB,CAAC,GAAG,CAAC,WAAW,CAAC,EAAE,CAAC,CAAC;gBAC3C,KAAK,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,QAAQ,CAAC,MAAM,EAAE,EAAE,CAAC,EAAE;oBAC5C,MAAM,SAAS,GAAG,QAAQ,CAAC,CAAC,CAAC,CAAC;oBAC9B,IAAI,CAAC,uBAAuB,CAAC,wBAAwB,CAAC,SAAS,CAAC,EAAE;wBAChE,SAAS;qBACV;oBACD,IAAI,SAAS,CAAC,SAAS,KAAK,eAAe,EAAE;wBAC3C,WAAW,CAAC,GAAG,CAAC,SAAS,CAAC,EAAE,CAAC,CAAC;qBAC/B;iBACF;gBACD,MAAM;aACP;YACD,YAAY,GAAG,EAAE,QAAQ,EAAE,WAAW,EAAE,SAAS,EAAE,CAAC,EAAE,CAAC;SACxD;QAED,MAAM,CAAC,YAAY,KAAK,SAAS,IAAI,uBAAuB,CAAC,wBAAwB,CAAC,YAAY,CAAC,QAAQ,CAAC,CAAC,CAAC;QAE9G,IAAI,YAAY,CAAC,QAAQ,CAAC,SAAS,KAAK,+BAA+B,EAAE;YACvE,MAAM,6BAA6B,GAAG,MAAM,QAAQ,CAAC,yBAAyB,CAAC,CAAC,YAAY,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC,CAAC;YAC3G,KAAK,MAAM,UAAU,IAAI,6BAA6B,EAAE;gBACtD,MAAM,KAAK,GAAG,UAAU,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC;gBACzC,IAAI,KAAK,KAAK,SAAS,EAAE;oBACvB,UAAU,CAAC,GAAG,CAAC,UAAU,EAAE,EAAE,CAAC,CAAC;iBAChC;aACF;YACD,SAAS;SACV;QAED,IAAI,YAAY,CAAC,QAAQ,CAAC,SAAS,KAAK,uBAAuB,EAAE;YAC/D,MAAM,gBAAgB,GAAG,YAAY,CAAC,SAAS,GAAG,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,YAAY,CAAC,SAAS,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;YACvG,MAAM,CAAC,gBAAgB,KAAK,SAAS,IAAI,uBAAuB,CAAC,wBAAwB,CAAC,gBAAgB,CAAC,CAAC,CAAC;YAE7G,WAAW,GAAG,YAAY,CAAC,QAAQ,CAAC;YACpC,QAAQ,GAAG,gBAAgB,CAAC;SAC7B;aAAM;YACL,QAAQ,GAAG,YAAY,CAAC,QAAQ,CAAC;SAClC;QAED,IAAI,KAAK,GAAG,UAAU,CAAC,GAAG,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC;QACxC,IAAI,KAAK,KAAK,SAAS,EAAE;YACvB,KAAK,GAAG,EAAE,CAAC;YACX,UAAU,CAAC,GAAG,CAAC,QAAQ,CAAC,EAAE,EAAE,KAAK,CAAC,CAAC;SACpC;QAED,IAAI,WAAW,EAAE;YACf,KAAK,CAAC,IAAI,CAAC,WAAW,CAAC,EAAE,CAAC,CAAC;SAC5B;KACF;IACD,MAAM,mBAAmB,GAAG,MAAM,QAAQ,CAAC,yBAAyB,CAAC,CAAC,GAAG,sBAAsB,CAAC,CAAC,CAAC;IAClG,MAAM,MAAM,GAAG,CAAC,GAAG,WAAW,EAAE,GAAG,IAAI,GAAG,CAAC,mBAAmB,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC;IAC1E,OAAO;QACL,UAAU,EAAE,CAAC,GAAG,UAAU,CAAC,OAAO,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,UAAU,EAAE,cAAc,CAAC,EAAE,EAAE,CAAC,CAAC;YAC3E,UAAU;YACV,cAAc,EAAE,cAAc,CAAC,MAAM,KAAK,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,cAAc;SACzE,CAAC,CAAC;QACH,MAAM;KACP,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, useMemo, useState } from \"react\";\nimport { assert } from \"@itwin/core-bentley\";\nimport { HierarchyFilteringPath, HierarchyNodeIdentifier } from \"@itwin/presentation-hierarchies\";\nimport { DEFINITION_CONTAINER_CLASS_NAME, SUB_CATEGORY_CLASS_NAME } from \"../../common/internal/ClassNameDefinitions.js\";\nimport { getClassesByView } from \"../../common/internal/Utils.js\";\nimport { FilterLimitExceededError } from \"../../common/TreeErrors.js\";\nimport { useTelemetryContext } from \"../../common/UseTelemetryContext.js\";\nimport { CategoriesTreeDefinition } from \"../CategoriesTreeDefinition.js\";\n\nimport type { VisibilityTreeProps } from \"../../common/components/VisibilityTree.js\";\nimport type { CategoriesTreeHierarchyConfiguration } from \"../CategoriesTreeDefinition.js\";\nimport type { CategoriesTreeIdsCache } from \"./CategoriesTreeIdsCache.js\";\nimport type { CategoryId, ElementId, ModelId, SubCategoryId } from \"../../common/internal/Types.js\";\nimport type { CategoryInfo } from \"../../common/CategoriesVisibilityUtils.js\";\n\n/** @internal */\nexport type CategoriesTreeFilteringError = \"tooManyFilterMatches\" | \"unknownFilterError\";\n\ntype HierarchyFilteringPaths = Awaited<ReturnType<Required<VisibilityTreeProps>[\"getFilteredPaths\"]>>;\n\n/** @internal */\nexport function useFilteredPaths({\n  filter,\n  viewType,\n  hierarchyConfiguration,\n  getCategoriesTreeIdsCache,\n  onCategoriesFiltered,\n  onFilteredPathsChanged,\n}: {\n  viewType: \"2d\" | \"3d\";\n  filter?: string;\n  hierarchyConfiguration: CategoriesTreeHierarchyConfiguration;\n  getCategoriesTreeIdsCache: () => CategoriesTreeIdsCache;\n  onCategoriesFiltered?: (categories: { categories: CategoryInfo[] | undefined; models?: Array<ModelId> }) => void;\n  onFilteredPathsChanged: (paths: HierarchyFilteringPaths | undefined) => void;\n}): {\n  getPaths: VisibilityTreeProps[\"getFilteredPaths\"] | undefined;\n  filteringError: CategoriesTreeFilteringError | undefined;\n} {\n  const [filteringError, setFilteringError] = useState<CategoriesTreeFilteringError | undefined>();\n  const { onFeatureUsed } = useTelemetryContext();\n\n  useEffect(() => {\n    setFilteringError(undefined);\n    onCategoriesFiltered?.({ categories: undefined, models: undefined });\n    if (!filter) {\n      onFilteredPathsChanged(undefined);\n    }\n  }, [filter, onCategoriesFiltered, onFilteredPathsChanged]);\n\n  const getFilteredPaths = useMemo<VisibilityTreeProps[\"getFilteredPaths\"] | undefined>(() => {\n    if (!filter) {\n      return undefined;\n    }\n\n    return async ({ imodelAccess }) => {\n      onFeatureUsed({ featureId: \"filtering\", reportInteraction: true });\n      try {\n        const paths = await CategoriesTreeDefinition.createInstanceKeyPaths({\n          imodelAccess,\n          label: filter,\n          viewType,\n          idsCache: getCategoriesTreeIdsCache(),\n          hierarchyConfig: hierarchyConfiguration,\n        });\n        onFilteredPathsChanged(paths);\n        const { elementClass, modelClass } = getClassesByView(viewType);\n        onCategoriesFiltered?.(await getCategoriesFromPaths(paths, getCategoriesTreeIdsCache(), elementClass, modelClass));\n        return paths;\n      } catch (e) {\n        const newError = e instanceof FilterLimitExceededError ? \"tooManyFilterMatches\" : \"unknownFilterError\";\n        if (newError !== \"tooManyFilterMatches\") {\n          const feature = e instanceof Error && e.message.includes(\"query too long to execute or server is too busy\") ? \"error-timeout\" : \"error-unknown\";\n          onFeatureUsed({ featureId: feature, reportInteraction: false });\n        }\n        setFilteringError(newError);\n        return [];\n      }\n    };\n  }, [onCategoriesFiltered, filter, onFilteredPathsChanged, onFeatureUsed, viewType, getCategoriesTreeIdsCache, hierarchyConfiguration]);\n\n  return {\n    getPaths: getFilteredPaths,\n    filteringError,\n  };\n}\n\nasync function getCategoriesFromPaths(\n  paths: HierarchyFilteringPaths,\n  idsCache: CategoriesTreeIdsCache,\n  elementClassName: string,\n  modelsClassName: string,\n): Promise<{ categories: CategoryInfo[] | undefined; models?: Array<ModelId> }> {\n  if (!paths) {\n    return { categories: undefined };\n  }\n\n  const rootFilteredElementIds = new Set<ElementId>();\n  const subModelIds = new Set<ModelId>();\n\n  const categories = new Map<CategoryId, Array<SubCategoryId>>();\n  for (const path of paths) {\n    const currPath = HierarchyFilteringPath.normalize(path).path;\n    if (currPath.length === 0) {\n      continue;\n    }\n\n    let category: HierarchyNodeIdentifier;\n    let subCategory: HierarchyNodeIdentifier | undefined;\n\n    let lastNodeInfo: { lastNode: HierarchyNodeIdentifier; nodeIndex: number } | undefined;\n\n    for (let i = 0; i < currPath.length; ++i) {\n      const currentNode = currPath[i];\n      if (!HierarchyNodeIdentifier.isInstanceNodeIdentifier(currentNode)) {\n        continue;\n      }\n      if (currentNode.className === elementClassName) {\n        rootFilteredElementIds.add(currentNode.id);\n        for (let j = i + 1; j < currPath.length; ++j) {\n          const childNode = currPath[j];\n          if (!HierarchyNodeIdentifier.isInstanceNodeIdentifier(childNode)) {\n            continue;\n          }\n          if (childNode.className === modelsClassName) {\n            subModelIds.add(childNode.id);\n          }\n        }\n        break;\n      }\n      lastNodeInfo = { lastNode: currentNode, nodeIndex: i };\n    }\n\n    assert(lastNodeInfo !== undefined && HierarchyNodeIdentifier.isInstanceNodeIdentifier(lastNodeInfo.lastNode));\n\n    if (lastNodeInfo.lastNode.className === DEFINITION_CONTAINER_CLASS_NAME) {\n      const definitionContainerCategories = await idsCache.getAllContainedCategories([lastNodeInfo.lastNode.id]);\n      for (const categoryId of definitionContainerCategories) {\n        const value = categories.get(categoryId);\n        if (value === undefined) {\n          categories.set(categoryId, []);\n        }\n      }\n      continue;\n    }\n\n    if (lastNodeInfo.lastNode.className === SUB_CATEGORY_CLASS_NAME) {\n      const secondToLastNode = lastNodeInfo.nodeIndex > 0 ? currPath[lastNodeInfo.nodeIndex - 1] : undefined;\n      assert(secondToLastNode !== undefined && HierarchyNodeIdentifier.isInstanceNodeIdentifier(secondToLastNode));\n\n      subCategory = lastNodeInfo.lastNode;\n      category = secondToLastNode;\n    } else {\n      category = lastNodeInfo.lastNode;\n    }\n\n    let entry = categories.get(category.id);\n    if (entry === undefined) {\n      entry = [];\n      categories.set(category.id, entry);\n    }\n\n    if (subCategory) {\n      entry.push(subCategory.id);\n    }\n  }\n  const rootElementModelMap = await idsCache.getFilteredElementsModels([...rootFilteredElementIds]);\n  const models = [...subModelIds, ...new Set(rootElementModelMap.values())];\n  return {\n    categories: [...categories.entries()].map(([categoryId, subCategoryIds]) => ({\n      categoryId,\n      subCategoryIds: subCategoryIds.length === 0 ? undefined : subCategoryIds,\n    })),\n    models,\n  };\n}\n"]}

package/lib/esm/tree-widget-react/components/trees/categories-tree/internal/UseIdsCache.d.ts

@@ -0,0 +1,8 @@
+import { CategoriesTreeIdsCache } from "./CategoriesTreeIdsCache.js";
+import type { IModelConnection } from "@itwin/core-frontend";
+import type { HierarchyFilteringPath } from "@itwin/presentation-hierarchies";
+/** @internal */
+export declare function useIdsCache(imodel: IModelConnection, viewType: "2d" | "3d", filteredPaths?: HierarchyFilteringPath[]): {
+    getCache: () => CategoriesTreeIdsCache;
+};
+//# sourceMappingURL=UseIdsCache.d.ts.map

package/lib/esm/tree-widget-react/components/trees/categories-tree/internal/UseIdsCache.js

@@ -0,0 +1,48 @@
+/*---------------------------------------------------------------------------------------------
+ * Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+ * See LICENSE.md in the project root for license terms and full copyright notice.
+ *--------------------------------------------------------------------------------------------*/
+import { useCallback, useEffect, useRef, useState } from "react";
+import { createECSqlQueryExecutor } from "@itwin/presentation-core-interop";
+import { useIModelChangeListener } from "../../common/internal/UseIModelChangeListener.js";
+import { CategoriesTreeIdsCache } from "./CategoriesTreeIdsCache.js";
+/** @internal */
+export function useIdsCache(imodel, viewType, filteredPaths) {
+    const cacheRef = useRef(undefined);
+    const clearCacheRef = useRef(() => () => {
+        cacheRef.current?.[Symbol.dispose]?.();
+        cacheRef.current = undefined;
+    });
+    const createCacheGetterRef = useRef((currImodel, currViewType) => () => {
+        if (cacheRef.current === undefined) {
+            cacheRef.current = new CategoriesTreeIdsCache(createECSqlQueryExecutor(currImodel), currViewType);
+        }
+        return cacheRef.current;
+    });
+    const [getCache, setCacheGetter] = useState(() => createCacheGetterRef.current(imodel, viewType));
+    useEffect(() => {
+        // clear cache in case it was created before `useEffect` was run first time
+        clearCacheRef.current();
+        // make sure all cache users rerender
+        setCacheGetter(() => createCacheGetterRef.current(imodel, viewType));
+        return () => {
+            // eslint-disable-next-line react-hooks/exhaustive-deps
+            clearCacheRef.current();
+        };
+    }, [imodel, viewType]);
+    useEffect(() => {
+        cacheRef.current?.clearFilteredElementsModels();
+    }, [filteredPaths]);
+    useIModelChangeListener({
+        imodel,
+        action: useCallback(() => {
+            clearCacheRef.current();
+            // make sure all cache users rerender
+            setCacheGetter(() => createCacheGetterRef.current(imodel, viewType));
+        }, [imodel, viewType]),
+    });
+    return {
+        getCache,
+    };
+}
+//# sourceMappingURL=UseIdsCache.js.map

package/lib/esm/tree-widget-react/components/trees/categories-tree/internal/UseIdsCache.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"UseIdsCache.js","sourceRoot":"","sources":["../../../../../../../src/tree-widget-react/components/trees/categories-tree/internal/UseIdsCache.ts"],"names":[],"mappings":"AAAA;;;gGAGgG;AAEhG,OAAO,EAAE,WAAW,EAAE,SAAS,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,OAAO,CAAC;AACjE,OAAO,EAAE,wBAAwB,EAAE,MAAM,kCAAkC,CAAC;AAC5E,OAAO,EAAE,uBAAuB,EAAE,MAAM,kDAAkD,CAAC;AAC3F,OAAO,EAAE,sBAAsB,EAAE,MAAM,6BAA6B,CAAC;AAKrE,gBAAgB;AAChB,MAAM,UAAU,WAAW,CAAC,MAAwB,EAAE,QAAqB,EAAE,aAAwC;IACnH,MAAM,QAAQ,GAAG,MAAM,CAAqC,SAAS,CAAC,CAAC;IACvE,MAAM,aAAa,GAAG,MAAM,CAAC,GAAG,EAAE,CAAC,GAAG,EAAE;QACtC,QAAQ,CAAC,OAAO,EAAE,CAAC,MAAM,CAAC,OAAO,CAAC,EAAE,EAAE,CAAC;QACvC,QAAQ,CAAC,OAAO,GAAG,SAAS,CAAC;IAC/B,CAAC,CAAC,CAAC;IACH,MAAM,oBAAoB,GAAG,MAAM,CAAC,CAAC,UAA4B,EAAE,YAAyB,EAAE,EAAE,CAAC,GAAG,EAAE;QACpG,IAAI,QAAQ,CAAC,OAAO,KAAK,SAAS,EAAE;YAClC,QAAQ,CAAC,OAAO,GAAG,IAAI,sBAAsB,CAAC,wBAAwB,CAAC,UAAU,CAAC,EAAE,YAAY,CAAC,CAAC;SACnG;QACD,OAAO,QAAQ,CAAC,OAAO,CAAC;IAC1B,CAAC,CAAC,CAAC;IACH,MAAM,CAAC,QAAQ,EAAE,cAAc,CAAC,GAAG,QAAQ,CAA+B,GAAG,EAAE,CAAC,oBAAoB,CAAC,OAAO,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAC,CAAC;IAEhI,SAAS,CAAC,GAAG,EAAE;QACb,2EAA2E;QAC3E,aAAa,CAAC,OAAO,EAAE,CAAC;QAExB,qCAAqC;QACrC,cAAc,CAAC,GAAG,EAAE,CAAC,oBAAoB,CAAC,OAAO,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAC,CAAC;QACrE,OAAO,GAAG,EAAE;YACV,uDAAuD;YACvD,aAAa,CAAC,OAAO,EAAE,CAAC;QAC1B,CAAC,CAAC;IACJ,CAAC,EAAE,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAC,CAAC;IAEvB,SAAS,CAAC,GAAG,EAAE;QACb,QAAQ,CAAC,OAAO,EAAE,2BAA2B,EAAE,CAAC;IAClD,CAAC,EAAE,CAAC,aAAa,CAAC,CAAC,CAAC;IAEpB,uBAAuB,CAAC;QACtB,MAAM;QACN,MAAM,EAAE,WAAW,CAAC,GAAG,EAAE;YACvB,aAAa,CAAC,OAAO,EAAE,CAAC;YACxB,qCAAqC;YACrC,cAAc,CAAC,GAAG,EAAE,CAAC,oBAAoB,CAAC,OAAO,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAC,CAAC;QACvE,CAAC,EAAE,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAC;KACvB,CAAC,CAAC;IAEH,OAAO;QACL,QAAQ;KACT,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 { useCallback, useEffect, useRef, useState } from \"react\";\nimport { createECSqlQueryExecutor } from \"@itwin/presentation-core-interop\";\nimport { useIModelChangeListener } from \"../../common/internal/UseIModelChangeListener.js\";\nimport { CategoriesTreeIdsCache } from \"./CategoriesTreeIdsCache.js\";\n\nimport type { IModelConnection } from \"@itwin/core-frontend\";\nimport type { HierarchyFilteringPath } from \"@itwin/presentation-hierarchies\";\n\n/** @internal */\nexport function useIdsCache(imodel: IModelConnection, viewType: \"2d\" | \"3d\", filteredPaths?: HierarchyFilteringPath[]) {\n  const cacheRef = useRef<CategoriesTreeIdsCache | undefined>(undefined);\n  const clearCacheRef = useRef(() => () => {\n    cacheRef.current?.[Symbol.dispose]?.();\n    cacheRef.current = undefined;\n  });\n  const createCacheGetterRef = useRef((currImodel: IModelConnection, currViewType: \"2d\" | \"3d\") => () => {\n    if (cacheRef.current === undefined) {\n      cacheRef.current = new CategoriesTreeIdsCache(createECSqlQueryExecutor(currImodel), currViewType);\n    }\n    return cacheRef.current;\n  });\n  const [getCache, setCacheGetter] = useState<() => CategoriesTreeIdsCache>(() => createCacheGetterRef.current(imodel, viewType));\n\n  useEffect(() => {\n    // clear cache in case it was created before `useEffect` was run first time\n    clearCacheRef.current();\n\n    // make sure all cache users rerender\n    setCacheGetter(() => createCacheGetterRef.current(imodel, viewType));\n    return () => {\n      // eslint-disable-next-line react-hooks/exhaustive-deps\n      clearCacheRef.current();\n    };\n  }, [imodel, viewType]);\n\n  useEffect(() => {\n    cacheRef.current?.clearFilteredElementsModels();\n  }, [filteredPaths]);\n\n  useIModelChangeListener({\n    imodel,\n    action: useCallback(() => {\n      clearCacheRef.current();\n      // make sure all cache users rerender\n      setCacheGetter(() => createCacheGetterRef.current(imodel, viewType));\n    }, [imodel, viewType]),\n  });\n\n  return {\n    getCache,\n  };\n}\n"]}

package/lib/esm/tree-widget-react/components/trees/common/CategoriesVisibilityUtils.d.ts

@@ -1,35 +1,23 @@
+import type { Id64Array, Id64String } from "@itwin/core-bentley";
 import type { Viewport } from "@itwin/core-frontend";
 /**
  * Data structure that describes category.
  * @beta
  */
 export interface CategoryInfo {
-    categoryId: string;
-    subCategoryIds?: string[];
+    categoryId: Id64String;
+    subCategoryIds?: Id64Array;
 }
-/**
- * Toggles visibility of categories to show or hide.
- */
-export declare function toggleAllCategories(viewport: Viewport, display: boolean): Promise<void>;
-/**
- * Changes category display in the viewport.
- */
-export declare function enableCategoryDisplay(viewport: Viewport, ids: string[], enabled: boolean, enableAllSubCategories?: boolean): Promise<void>;
-/**
- * Changes subcategory display in the viewport
- */
-export declare function enableSubCategoryDisplay(viewport: Viewport, key: string, enabled: boolean): void;
-export declare function loadCategoriesFromViewport(vp: Viewport): Promise<CategoryInfo[]>;
 /**
  * Enable display of all given categories.
  * @public
  */
-export declare function showAllCategories(categories: string[], viewport: Viewport): Promise<void>;
+export declare function showAllCategories(categories: Id64Array, viewport: Viewport): Promise<void>;
 /**
  * Disable display of all given categories.
  * @public
  */
-export declare function hideAllCategories(categories: string[], viewport: Viewport): Promise<void>;
+export declare function hideAllCategories(categories: Id64Array, viewport: Viewport): Promise<void>;
 /**
  * Invert display of all given categories.
  * @public

package/lib/esm/tree-widget-react/components/trees/common/CategoriesVisibilityUtils.js

@@ -2,64 +2,7 @@
  * Copyright (c) Bentley Systems, Incorporated. All rights reserved.
  * See LICENSE.md in the project root for license terms and full copyright notice.
  *--------------------------------------------------------------------------------------------*/
-import { QueryRowFormat } from "@itwin/core-common";
-import { PerModelCategoryVisibility } from "@itwin/core-frontend";
-/**
- * Toggles visibility of categories to show or hide.
- */
-export async function toggleAllCategories(viewport, display) {
-    const ids = await getCategories(viewport);
-    if (ids.length === 0) {
-        return;
-    }
-    await enableCategoryDisplay(viewport, ids, display);
-}
-/**
- * Gets ids of all categories from specified imodel and viewport.
- */
-async function getCategories(viewport) {
-    const categories = await loadCategoriesFromViewport(viewport);
-    return categories.map((category) => category.categoryId);
-}
-/**
- * Changes category display in the viewport.
- */
-export async function enableCategoryDisplay(viewport, ids, enabled, enableAllSubCategories = true) {
-    viewport.changeCategoryDisplay(ids, enabled, enableAllSubCategories);
-    // remove category overrides per model
-    const modelsContainingOverrides = [];
-    for (const ovr of viewport.perModelCategoryVisibility) {
-        if (ids.findIndex((id) => id === ovr.categoryId) !== -1) {
-            modelsContainingOverrides.push(ovr.modelId);
-        }
-    }
-    viewport.perModelCategoryVisibility.setOverride(modelsContainingOverrides, ids, PerModelCategoryVisibility.Override.None);
-    // changeCategoryDisplay only enables subcategories, it does not disabled them. So we must do that ourselves.
-    if (false === enabled) {
-        (await viewport.iModel.categories.getCategoryInfo(ids)).forEach((categoryInfo) => {
-            categoryInfo.subCategories.forEach((value) => enableSubCategoryDisplay(viewport, value.id, false));
-        });
-    }
-}
-/**
- * Changes subcategory display in the viewport
- */
-export function enableSubCategoryDisplay(viewport, key, enabled) {
-    viewport.changeSubCategoryDisplay(key, enabled);
-}
-export async function loadCategoriesFromViewport(vp) {
-    // Query categories and add them to state
-    const selectUsedSpatialCategoryIds = "SELECT DISTINCT Category.Id as id from BisCore.GeometricElement3d WHERE Category.Id IN (SELECT ECInstanceId from BisCore.SpatialCategory)";
-    const selectUsedDrawingCategoryIds = "SELECT DISTINCT Category.Id as id from BisCore.GeometricElement2d WHERE Model.Id=? AND Category.Id IN (SELECT ECInstanceId from BisCore.DrawingCategory)";
-    const ecsql = vp.view.is3d() ? selectUsedSpatialCategoryIds : selectUsedDrawingCategoryIds;
-    const ecsql2 = `SELECT ECInstanceId as id FROM ${vp.view.is3d() ? "BisCore.SpatialCategory" : "BisCore.DrawingCategory"} WHERE ECInstanceId IN (${ecsql})`;
-    const categories = [];
-    const rows = await vp.iModel.createQueryReader(ecsql2, undefined, { rowFormat: QueryRowFormat.UseJsPropertyNames }).toArray();
-    (await vp.iModel.categories.getCategoryInfo(rows.map((row) => row.id))).forEach((val) => {
-        categories.push({ categoryId: val.id, subCategoryIds: val.subCategories.size ? [...val.subCategories.keys()] : undefined });
-    });
-    return categories;
-}
+import { enableCategoryDisplay, enableSubCategoryDisplay } from "./internal/VisibilityUtils.js";
 /**
  * Enable display of all given categories.
  * @public
@@ -79,10 +22,10 @@ export async function hideAllCategories(categories, viewport) {
  * @public
  */
 export async function invertAllCategories(categories, viewport) {
-    const enabled = [];
-    const disabled = [];
-    const enabledSubCategories = [];
-    const disabledSubCategories = [];
+    const enabled = new Array();
+    const disabled = new Array();
+    const enabledSubCategories = new Array();
+    const disabledSubCategories = new Array();
     for (const category of categories) {
         if (!viewport.view.viewsCategory(category.categoryId)) {
             disabled.push(category.categoryId);

package/lib/esm/tree-widget-react/components/trees/common/CategoriesVisibilityUtils.js.map

@@ -1 +1 @@
-{"version":3,"file":"CategoriesVisibilityUtils.js","sourceRoot":"","sources":["../../../../../../src/tree-widget-react/components/trees/common/CategoriesVisibilityUtils.ts"],"names":[],"mappings":"AAAA;;;gGAGgG;AAEhG,OAAO,EAAE,cAAc,EAAE,MAAM,oBAAoB,CAAC;AACpD,OAAO,EAAE,0BAA0B,EAAE,MAAM,sBAAsB,CAAC;AAalE;;GAEG;AACH,MAAM,CAAC,KAAK,UAAU,mBAAmB,CAAC,QAAkB,EAAE,OAAgB;IAC5E,MAAM,GAAG,GAAG,MAAM,aAAa,CAAC,QAAQ,CAAC,CAAC;IAC1C,IAAI,GAAG,CAAC,MAAM,KAAK,CAAC,EAAE;QACpB,OAAO;KACR;IAED,MAAM,qBAAqB,CAAC,QAAQ,EAAE,GAAG,EAAE,OAAO,CAAC,CAAC;AACtD,CAAC;AAED;;GAEG;AACH,KAAK,UAAU,aAAa,CAAC,QAAkB;IAC7C,MAAM,UAAU,GAAG,MAAM,0BAA0B,CAAC,QAAQ,CAAC,CAAC;IAC9D,OAAO,UAAU,CAAC,GAAG,CAAC,CAAC,QAAQ,EAAE,EAAE,CAAC,QAAQ,CAAC,UAAU,CAAC,CAAC;AAC3D,CAAC;AAED;;GAEG;AACH,MAAM,CAAC,KAAK,UAAU,qBAAqB,CAAC,QAAkB,EAAE,GAAa,EAAE,OAAgB,EAAE,sBAAsB,GAAG,IAAI;IAC5H,QAAQ,CAAC,qBAAqB,CAAC,GAAG,EAAE,OAAO,EAAE,sBAAsB,CAAC,CAAC;IAErE,sCAAsC;IACtC,MAAM,yBAAyB,GAAa,EAAE,CAAC;IAC/C,KAAK,MAAM,GAAG,IAAI,QAAQ,CAAC,0BAA0B,EAAE;QACrD,IAAI,GAAG,CAAC,SAAS,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE,KAAK,GAAG,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC,EAAE;YACvD,yBAAyB,CAAC,IAAI,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;SAC7C;KACF;IACD,QAAQ,CAAC,0BAA0B,CAAC,WAAW,CAAC,yBAAyB,EAAE,GAAG,EAAE,0BAA0B,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;IAE1H,6GAA6G;IAC7G,IAAI,KAAK,KAAK,OAAO,EAAE;QACrB,CAAC,MAAM,QAAQ,CAAC,MAAM,CAAC,UAAU,CAAC,eAAe,CAAC,GAAG,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,YAAY,EAAE,EAAE;YAC/E,YAAY,CAAC,aAAa,CAAC,OAAO,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,wBAAwB,CAAC,QAAQ,EAAE,KAAK,CAAC,EAAE,EAAE,KAAK,CAAC,CAAC,CAAC;QACrG,CAAC,CAAC,CAAC;KACJ;AACH,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,wBAAwB,CAAC,QAAkB,EAAE,GAAW,EAAE,OAAgB;IACxF,QAAQ,CAAC,wBAAwB,CAAC,GAAG,EAAE,OAAO,CAAC,CAAC;AAClD,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,0BAA0B,CAAC,EAAY;IAC3D,yCAAyC;IACzC,MAAM,4BAA4B,GAChC,2IAA2I,CAAC;IAC9I,MAAM,4BAA4B,GAChC,0JAA0J,CAAC;IAC7J,MAAM,KAAK,GAAG,EAAE,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,4BAA4B,CAAC,CAAC,CAAC,4BAA4B,CAAC;IAC3F,MAAM,MAAM,GAAG,kCAAkC,EAAE,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,yBAAyB,CAAC,CAAC,CAAC,yBAAyB,2BAA2B,KAAK,GAAG,CAAC;IAE3J,MAAM,UAAU,GAAmB,EAAE,CAAC;IAEtC,MAAM,IAAI,GAAG,MAAM,EAAE,CAAC,MAAM,CAAC,iBAAiB,CAAC,MAAM,EAAE,SAAS,EAAE,EAAE,SAAS,EAAE,cAAc,CAAC,kBAAkB,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC;IAC9H,CAAC,MAAM,EAAE,CAAC,MAAM,CAAC,UAAU,CAAC,eAAe,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,GAAG,EAAE,EAAE;QACtF,UAAU,CAAC,IAAI,CAAC,EAAE,UAAU,EAAE,GAAG,CAAC,EAAE,EAAE,cAAc,EAAE,GAAG,CAAC,aAAa,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,GAAG,GAAG,CAAC,aAAa,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC,SAAS,EAAE,CAAC,CAAC;IAC9H,CAAC,CAAC,CAAC;IACH,OAAO,UAAU,CAAC;AACpB,CAAC;AAED;;;GAGG;AACH,MAAM,CAAC,KAAK,UAAU,iBAAiB,CAAC,UAAoB,EAAE,QAAkB;IAC9E,MAAM,qBAAqB,CAAC,QAAQ,EAAE,UAAU,EAAE,IAAI,EAAE,IAAI,CAAC,CAAC;AAChE,CAAC;AAED;;;GAGG;AACH,MAAM,CAAC,KAAK,UAAU,iBAAiB,CAAC,UAAoB,EAAE,QAAkB;IAC9E,MAAM,qBAAqB,CAAC,QAAQ,EAAE,UAAU,EAAE,KAAK,EAAE,IAAI,CAAC,CAAC;AACjE,CAAC;AAED;;;GAGG;AACH,MAAM,CAAC,KAAK,UAAU,mBAAmB,CAAC,UAA0B,EAAE,QAAkB;IACtF,MAAM,OAAO,GAAa,EAAE,CAAC;IAC7B,MAAM,QAAQ,GAAa,EAAE,CAAC;IAC9B,MAAM,oBAAoB,GAAa,EAAE,CAAC;IAC1C,MAAM,qBAAqB,GAAa,EAAE,CAAC;IAE3C,KAAK,MAAM,QAAQ,IAAI,UAAU,EAAE;QACjC,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,aAAa,CAAC,QAAQ,CAAC,UAAU,CAAC,EAAE;YACrD,QAAQ,CAAC,IAAI,CAAC,QAAQ,CAAC,UAAU,CAAC,CAAC;YACnC,SAAS;SACV;QACD,iJAAiJ;QACjJ,IAAI,QAAQ,CAAC,cAAc,EAAE,IAAI,CAAC,CAAC,WAAW,EAAE,EAAE,CAAC,CAAC,QAAQ,CAAC,oBAAoB,CAAC,WAAW,CAAC,CAAC,EAAE;YAC/F,KAAK,MAAM,WAAW,IAAI,QAAQ,CAAC,cAAc,EAAE;gBACjD,QAAQ,CAAC,oBAAoB,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,oBAAoB,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,qBAAqB,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;aAC/H;SACF;aAAM;YACL,OAAO,CAAC,IAAI,CAAC,QAAQ,CAAC,UAAU,CAAC,CAAC;SACnC;KACF;IAED,kBAAkB;IAClB,oBAAoB,CAAC,OAAO,CAAC,CAAC,WAAW,EAAE,EAAE,CAAC,wBAAwB,CAAC,QAAQ,EAAE,WAAW,EAAE,KAAK,CAAC,CAAC,CAAC;IAEtG,MAAM,qBAAqB,CAAC,QAAQ,EAAE,OAAO,EAAE,KAAK,EAAE,IAAI,CAAC,CAAC;IAE5D,kBAAkB;IAClB,qBAAqB,CAAC,OAAO,CAAC,CAAC,WAAW,EAAE,EAAE,CAAC,wBAAwB,CAAC,QAAQ,EAAE,WAAW,EAAE,IAAI,CAAC,CAAC,CAAC;IAEtG,MAAM,qBAAqB,CAAC,QAAQ,EAAE,QAAQ,EAAE,IAAI,EAAE,IAAI,CAAC,CAAC;AAC9D,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 { QueryRowFormat } from \"@itwin/core-common\";\nimport { PerModelCategoryVisibility } from \"@itwin/core-frontend\";\n\nimport type { Viewport } from \"@itwin/core-frontend\";\n\n/**\n * Data structure that describes category.\n * @beta\n */\nexport interface CategoryInfo {\n  categoryId: string;\n  subCategoryIds?: string[];\n}\n\n/**\n * Toggles visibility of categories to show or hide.\n */\nexport async function toggleAllCategories(viewport: Viewport, display: boolean) {\n  const ids = await getCategories(viewport);\n  if (ids.length === 0) {\n    return;\n  }\n\n  await enableCategoryDisplay(viewport, ids, display);\n}\n\n/**\n * Gets ids of all categories from specified imodel and viewport.\n */\nasync function getCategories(viewport: Viewport) {\n  const categories = await loadCategoriesFromViewport(viewport);\n  return categories.map((category) => category.categoryId);\n}\n\n/**\n * Changes category display in the viewport.\n */\nexport async function enableCategoryDisplay(viewport: Viewport, ids: string[], enabled: boolean, enableAllSubCategories = true) {\n  viewport.changeCategoryDisplay(ids, enabled, enableAllSubCategories);\n\n  // remove category overrides per model\n  const modelsContainingOverrides: string[] = [];\n  for (const ovr of viewport.perModelCategoryVisibility) {\n    if (ids.findIndex((id) => id === ovr.categoryId) !== -1) {\n      modelsContainingOverrides.push(ovr.modelId);\n    }\n  }\n  viewport.perModelCategoryVisibility.setOverride(modelsContainingOverrides, ids, PerModelCategoryVisibility.Override.None);\n\n  // changeCategoryDisplay only enables subcategories, it does not disabled them. So we must do that ourselves.\n  if (false === enabled) {\n    (await viewport.iModel.categories.getCategoryInfo(ids)).forEach((categoryInfo) => {\n      categoryInfo.subCategories.forEach((value) => enableSubCategoryDisplay(viewport, value.id, false));\n    });\n  }\n}\n\n/**\n * Changes subcategory display in the viewport\n */\nexport function enableSubCategoryDisplay(viewport: Viewport, key: string, enabled: boolean) {\n  viewport.changeSubCategoryDisplay(key, enabled);\n}\n\nexport async function loadCategoriesFromViewport(vp: Viewport) {\n  // Query categories and add them to state\n  const selectUsedSpatialCategoryIds =\n    \"SELECT DISTINCT Category.Id as id from BisCore.GeometricElement3d WHERE Category.Id IN (SELECT ECInstanceId from BisCore.SpatialCategory)\";\n  const selectUsedDrawingCategoryIds =\n    \"SELECT DISTINCT Category.Id as id from BisCore.GeometricElement2d WHERE Model.Id=? AND Category.Id IN (SELECT ECInstanceId from BisCore.DrawingCategory)\";\n  const ecsql = vp.view.is3d() ? selectUsedSpatialCategoryIds : selectUsedDrawingCategoryIds;\n  const ecsql2 = `SELECT ECInstanceId as id FROM ${vp.view.is3d() ? \"BisCore.SpatialCategory\" : \"BisCore.DrawingCategory\"} WHERE ECInstanceId IN (${ecsql})`;\n\n  const categories: CategoryInfo[] = [];\n\n  const rows = await vp.iModel.createQueryReader(ecsql2, undefined, { rowFormat: QueryRowFormat.UseJsPropertyNames }).toArray();\n  (await vp.iModel.categories.getCategoryInfo(rows.map((row) => row.id))).forEach((val) => {\n    categories.push({ categoryId: val.id, subCategoryIds: val.subCategories.size ? [...val.subCategories.keys()] : undefined });\n  });\n  return categories;\n}\n\n/**\n * Enable display of all given categories.\n * @public\n */\nexport async function showAllCategories(categories: string[], viewport: Viewport) {\n  await enableCategoryDisplay(viewport, categories, true, true);\n}\n\n/**\n * Disable display of all given categories.\n * @public\n */\nexport async function hideAllCategories(categories: string[], viewport: Viewport) {\n  await enableCategoryDisplay(viewport, categories, false, true);\n}\n\n/**\n * Invert display of all given categories.\n * @public\n */\nexport async function invertAllCategories(categories: CategoryInfo[], viewport: Viewport) {\n  const enabled: string[] = [];\n  const disabled: string[] = [];\n  const enabledSubCategories: string[] = [];\n  const disabledSubCategories: string[] = [];\n\n  for (const category of categories) {\n    if (!viewport.view.viewsCategory(category.categoryId)) {\n      disabled.push(category.categoryId);\n      continue;\n    }\n    // First, we need to check if at least one subcategory is disabled. If it is true, then only subcategories should change display, not categories.\n    if (category.subCategoryIds?.some((subCategory) => !viewport.isSubCategoryVisible(subCategory))) {\n      for (const subCategory of category.subCategoryIds) {\n        viewport.isSubCategoryVisible(subCategory) ? enabledSubCategories.push(subCategory) : disabledSubCategories.push(subCategory);\n      }\n    } else {\n      enabled.push(category.categoryId);\n    }\n  }\n\n  // Disable enabled\n  enabledSubCategories.forEach((subCategory) => enableSubCategoryDisplay(viewport, subCategory, false));\n\n  await enableCategoryDisplay(viewport, enabled, false, true);\n\n  // Enable disabled\n  disabledSubCategories.forEach((subCategory) => enableSubCategoryDisplay(viewport, subCategory, true));\n\n  await enableCategoryDisplay(viewport, disabled, true, true);\n}\n"]}
+{"version":3,"file":"CategoriesVisibilityUtils.js","sourceRoot":"","sources":["../../../../../../src/tree-widget-react/components/trees/common/CategoriesVisibilityUtils.ts"],"names":[],"mappings":"AAAA;;;gGAGgG;AAEhG,OAAO,EAAE,qBAAqB,EAAE,wBAAwB,EAAE,MAAM,+BAA+B,CAAC;AAchG;;;GAGG;AACH,MAAM,CAAC,KAAK,UAAU,iBAAiB,CAAC,UAAqB,EAAE,QAAkB;IAC/E,MAAM,qBAAqB,CAAC,QAAQ,EAAE,UAAU,EAAE,IAAI,EAAE,IAAI,CAAC,CAAC;AAChE,CAAC;AAED;;;GAGG;AACH,MAAM,CAAC,KAAK,UAAU,iBAAiB,CAAC,UAAqB,EAAE,QAAkB;IAC/E,MAAM,qBAAqB,CAAC,QAAQ,EAAE,UAAU,EAAE,KAAK,EAAE,IAAI,CAAC,CAAC;AACjE,CAAC;AAED;;;GAGG;AACH,MAAM,CAAC,KAAK,UAAU,mBAAmB,CAAC,UAA0B,EAAE,QAAkB;IACtF,MAAM,OAAO,GAAG,IAAI,KAAK,EAAc,CAAC;IACxC,MAAM,QAAQ,GAAG,IAAI,KAAK,EAAc,CAAC;IACzC,MAAM,oBAAoB,GAAG,IAAI,KAAK,EAAc,CAAC;IACrD,MAAM,qBAAqB,GAAG,IAAI,KAAK,EAAc,CAAC;IAEtD,KAAK,MAAM,QAAQ,IAAI,UAAU,EAAE;QACjC,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,aAAa,CAAC,QAAQ,CAAC,UAAU,CAAC,EAAE;YACrD,QAAQ,CAAC,IAAI,CAAC,QAAQ,CAAC,UAAU,CAAC,CAAC;YACnC,SAAS;SACV;QACD,iJAAiJ;QACjJ,IAAI,QAAQ,CAAC,cAAc,EAAE,IAAI,CAAC,CAAC,WAAW,EAAE,EAAE,CAAC,CAAC,QAAQ,CAAC,oBAAoB,CAAC,WAAW,CAAC,CAAC,EAAE;YAC/F,KAAK,MAAM,WAAW,IAAI,QAAQ,CAAC,cAAc,EAAE;gBACjD,QAAQ,CAAC,oBAAoB,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,oBAAoB,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,qBAAqB,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;aAC/H;SACF;aAAM;YACL,OAAO,CAAC,IAAI,CAAC,QAAQ,CAAC,UAAU,CAAC,CAAC;SACnC;KACF;IAED,kBAAkB;IAClB,oBAAoB,CAAC,OAAO,CAAC,CAAC,WAAW,EAAE,EAAE,CAAC,wBAAwB,CAAC,QAAQ,EAAE,WAAW,EAAE,KAAK,CAAC,CAAC,CAAC;IAEtG,MAAM,qBAAqB,CAAC,QAAQ,EAAE,OAAO,EAAE,KAAK,EAAE,IAAI,CAAC,CAAC;IAE5D,kBAAkB;IAClB,qBAAqB,CAAC,OAAO,CAAC,CAAC,WAAW,EAAE,EAAE,CAAC,wBAAwB,CAAC,QAAQ,EAAE,WAAW,EAAE,IAAI,CAAC,CAAC,CAAC;IAEtG,MAAM,qBAAqB,CAAC,QAAQ,EAAE,QAAQ,EAAE,IAAI,EAAE,IAAI,CAAC,CAAC;AAC9D,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 { enableCategoryDisplay, enableSubCategoryDisplay } from \"./internal/VisibilityUtils.js\";\n\nimport type { Id64Array, Id64String } from \"@itwin/core-bentley\";\nimport type { Viewport } from \"@itwin/core-frontend\";\n\n/**\n * Data structure that describes category.\n * @beta\n */\nexport interface CategoryInfo {\n  categoryId: Id64String;\n  subCategoryIds?: Id64Array;\n}\n\n/**\n * Enable display of all given categories.\n * @public\n */\nexport async function showAllCategories(categories: Id64Array, viewport: Viewport) {\n  await enableCategoryDisplay(viewport, categories, true, true);\n}\n\n/**\n * Disable display of all given categories.\n * @public\n */\nexport async function hideAllCategories(categories: Id64Array, viewport: Viewport) {\n  await enableCategoryDisplay(viewport, categories, false, true);\n}\n\n/**\n * Invert display of all given categories.\n * @public\n */\nexport async function invertAllCategories(categories: CategoryInfo[], viewport: Viewport) {\n  const enabled = new Array<Id64String>();\n  const disabled = new Array<Id64String>();\n  const enabledSubCategories = new Array<Id64String>();\n  const disabledSubCategories = new Array<Id64String>();\n\n  for (const category of categories) {\n    if (!viewport.view.viewsCategory(category.categoryId)) {\n      disabled.push(category.categoryId);\n      continue;\n    }\n    // First, we need to check if at least one subcategory is disabled. If it is true, then only subcategories should change display, not categories.\n    if (category.subCategoryIds?.some((subCategory) => !viewport.isSubCategoryVisible(subCategory))) {\n      for (const subCategory of category.subCategoryIds) {\n        viewport.isSubCategoryVisible(subCategory) ? enabledSubCategories.push(subCategory) : disabledSubCategories.push(subCategory);\n      }\n    } else {\n      enabled.push(category.categoryId);\n    }\n  }\n\n  // Disable enabled\n  enabledSubCategories.forEach((subCategory) => enableSubCategoryDisplay(viewport, subCategory, false));\n\n  await enableCategoryDisplay(viewport, enabled, false, true);\n\n  // Enable disabled\n  disabledSubCategories.forEach((subCategory) => enableSubCategoryDisplay(viewport, subCategory, true));\n\n  await enableCategoryDisplay(viewport, disabled, true, true);\n}\n"]}

package/lib/esm/tree-widget-react/components/trees/common/UseHierarchyVisibility.d.ts

@@ -11,8 +11,6 @@ export interface VisibilityStatus {
     state: "visible" | "partial" | "hidden";
     /** Specifies whether visibility changing is disabled or not. */
     isDisabled?: boolean;
-    /** Tooltip that should be displayed when hovering over the visibility checkbox. */
-    tooltip?: string;
 }
 /**
  * Handler that can be used to determine and change visibility of instances represented by tree nodes.
@@ -29,6 +27,7 @@ export interface HierarchyVisibilityHandler extends IDisposable {
 interface UseHierarchyVisibilityProps {
     visibilityHandlerFactory: () => HierarchyVisibilityHandler;
 }
+/** @internal */
 export declare function useHierarchyVisibility({ visibilityHandlerFactory, }: UseHierarchyVisibilityProps): TreeItemVisibilityButtonProps & {
     triggerRefresh: () => void;
 };
@@ -50,6 +49,7 @@ export type HierarchyVisibilityHandlerOverridableMethodProps<TFunc> = TFunc exte
  * @beta
  */
 export type HierarchyVisibilityHandlerOverridableMethod<TFunc> = TFunc extends (...args: any[]) => infer TResult ? (props: HierarchyVisibilityHandlerOverridableMethodProps<TFunc>) => TResult : never;
+/** @internal */
 export declare function createVisibilityHandlerResult<TResult, TOverrideProps>(handler: HierarchyVisibilityHandler, props: TOverrideProps, obs: Observable<TResult>, override: HierarchyVisibilityHandlerOverridableMethod<(props: TOverrideProps) => Promise<TResult>> | undefined): Observable<TResult>;
 export {};
 //# sourceMappingURL=UseHierarchyVisibility.d.ts.map

package/lib/esm/tree-widget-react/components/trees/common/UseHierarchyVisibility.js

@@ -4,11 +4,13 @@
  *--------------------------------------------------------------------------------------------*/
 import { useEffect, useRef, useState } from "react";
 import { asyncScheduler, defer, distinct, EMPTY, from, lastValueFrom, mergeMap, observeOn, onErrorResumeNextWith, Subject, takeUntil, tap, throttleTime, } from "rxjs";
+import { createTooltip } from "./internal/Tooltip.js";
 import { useTelemetryContext } from "./UseTelemetryContext.js";
+/** @internal */
 export function useHierarchyVisibility({ visibilityHandlerFactory, }) {
     const visibilityStatusMap = useRef(new Map());
     const [state, setState] = useState({
-        getVisibilityButtonState: () => ({ state: "hidden", isDisabled: true }),
+        getVisibilityButtonState: () => ({ state: "visible", isDisabled: true }),
         onVisibilityButtonClick: () => { },
         triggerRefresh: () => { },
     });
@@ -30,7 +32,7 @@ export function useHierarchyVisibility({ visibilityHandlerFactory, }) {
         const triggerCheckboxUpdate = () => {
             setState((prev) => ({
                 ...prev,
-                getCheckboxState: createStateGetter(visibilityStatusMap, calculateNodeStatus),
+                getVisibilityButtonState: createStateGetter(visibilityStatusMap, calculateNodeStatus),
             }));
         };
         const subscription = calculate
@@ -38,7 +40,10 @@ export function useHierarchyVisibility({ visibilityHandlerFactory, }) {
             next: (status) => {
                 visibilityStatusMap.current.set(node.id, {
                     node,
-                    status,
+                    status: {
+                        ...status,
+                        tooltip: createTooltip(status.state),
+                    },
                     needsRefresh: false,
                 });
             },
@@ -58,7 +63,7 @@ export function useHierarchyVisibility({ visibilityHandlerFactory, }) {
                 return;
             }
             entry.status.state = visibilityState;
-            entry.status.tooltip = undefined;
+            entry.status.tooltip = createTooltip("determining");
             triggerCheckboxUpdate();
         };
         setState({
@@ -86,7 +91,7 @@ function createStateGetter(map, calculateVisibility) {
         const entry = map.current.get(node.id);
         if (entry === undefined) {
             calculateVisibility(node);
-            return { state: "hidden", isDisabled: true };
+            return { state: "visible", isDisabled: true, tooltip: createTooltip("determining") };
         }
         if (entry.needsRefresh) {
             calculateVisibility(node);
@@ -99,6 +104,7 @@ function createStateGetter(map, calculateVisibility) {
         };
     };
 }
+/** @internal */
 export function createVisibilityHandlerResult(handler, props, obs, override) {
     return override
         ? from(override({

package/lib/esm/tree-widget-react/components/trees/common/UseHierarchyVisibility.js.map

@@ -1 +1 @@
-{"version":3,"file":"UseHierarchyVisibility.js","sourceRoot":"","sources":["../../../../../../src/tree-widget-react/components/trees/common/UseHierarchyVisibility.ts"],"names":[],"mappings":"AAAA;;;gGAGgG;AAEhG,OAAO,EAAE,SAAS,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,OAAO,CAAC;AACpD,OAAO,EACL,cAAc,EACd,KAAK,EACL,QAAQ,EACR,KAAK,EACL,IAAI,EACJ,aAAa,EACb,QAAQ,EACR,SAAS,EACT,qBAAqB,EACrB,OAAO,EACP,SAAS,EACT,GAAG,EACH,YAAY,GACb,MAAM,MAAM,CAAC;AACd,OAAO,EAAE,mBAAmB,EAAE,MAAM,0BAA0B,CAAC;AAsC/D,MAAM,UAAU,sBAAsB,CAAC,EACrC,wBAAwB,GACI;IAC5B,MAAM,mBAAmB,GAAG,MAAM,CAAC,IAAI,GAAG,EAAgG,CAAC,CAAC;IAC5I,MAAM,CAAC,KAAK,EAAE,QAAQ,CAAC,GAAG,QAAQ,CAAiE;QACjG,wBAAwB,EAAE,GAAG,EAAE,CAAC,CAAC,EAAE,KAAK,EAAE,QAAQ,EAAE,UAAU,EAAE,IAAI,EAAE,CAAC;QACvE,uBAAuB,EAAE,GAAG,EAAE,GAAE,CAAC;QACjC,cAAc,EAAE,GAAG,EAAE,GAAE,CAAC;KACzB,CAAC,CAAC;IACH,MAAM,EAAE,aAAa,EAAE,GAAG,mBAAmB,EAAE,CAAC;IAEhD,SAAS,CAAC,GAAG,EAAE;QACb,mBAAmB,CAAC,OAAO,CAAC,KAAK,EAAE,CAAC;QACpC,MAAM,OAAO,GAAG,wBAAwB,EAAE,CAAC;QAE3C,MAAM,iBAAiB,GAAG,IAAI,OAAO,EAAQ,CAAC;QAC9C,MAAM,SAAS,GAAG,IAAI,OAAO,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,mBAAmB,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,KAAK,EAAE,EAAE;gBAC5C,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,mBAAmB,EAAE,mBAAmB,CAAC;aAC9E,CAAC,CAAC,CAAC;QACN,CAAC,CAAC;QAEF,MAAM,YAAY,GAAG,SAAS;aAC3B,IAAI,CACH,QAAQ,CAAC,SAAS,EAAE,iBAAiB,CAAC,EACtC,SAAS,CAAC,cAAc,CAAC,EACzB,QAAQ,CAAC,CAAC,IAAI,EAAE,EAAE,CAChB,KAAK,CAAC,KAAK,IAAI,EAAE,CAAC,OAAO,CAAC,mBAAmB,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,IAAI,CAChE,GAAG,CAAC;YACF,IAAI,EAAE,CAAC,MAAM,EAAE,EAAE;gBACf,mBAAmB,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,EAAE;oBACvC,IAAI;oBACJ,MAAM;oBACN,YAAY,EAAE,KAAK;iBACpB,CAAC,CAAC;YACL,CAAC;SACF,CAAC,EACF,SAAS,CAAC,iBAAiB,CAAC,EAC5B,qBAAqB,CAAC,KAAK,CAAC,CAC7B,CACF,EACD,YAAY,CAAC,GAAG,EAAE,SAAS,EAAE,EAAE,OAAO,EAAE,KAAK,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC,CACjE;aACA,SAAS,CAAC;YACT,IAAI,EAAE,GAAG,EAAE;gBACT,qBAAqB,EAAE,CAAC;YAC1B,CAAC;SACF,CAAC,CAAC;QAEL,MAAM,gBAAgB,GAA6D,CAAC,IAAI,EAAE,eAAe,EAAE,EAAE;YAC3G,aAAa,CAAC,EAAE,SAAS,EAAE,mBAAmB,EAAE,iBAAiB,EAAE,IAAI,EAAE,CAAC,CAAC;YAC3E,gGAAgG;YAChG,MAAM,EAAE,GAAG,eAAe,KAAK,SAAS,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC;YACxD,KAAK,OAAO,CAAC,gBAAgB,CAAC,IAAI,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC;YACjD,MAAM,KAAK,GAAG,mBAAmB,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;YACvD,IAAI,CAAC,KAAK,EAAE;gBACV,OAAO;aACR;YACD,KAAK,CAAC,MAAM,CAAC,KAAK,GAAG,eAAe,CAAC;YACrC,KAAK,CAAC,MAAM,CAAC,OAAO,GAAG,SAAS,CAAC;YACjC,qBAAqB,EAAE,CAAC;QAC1B,CAAC,CAAC;QAEF,QAAQ,CAAC;YACP,uBAAuB,EAAE,gBAAgB;YACzC,wBAAwB,EAAE,iBAAiB,CAAC,mBAAmB,EAAE,mBAAmB,CAAC;YACrF,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,EAAE,aAAa,CAAC,CAAC,CAAC;IAE9C,OAAO,KAAK,CAAC;AACf,CAAC;AAED,SAAS,iBAAiB,CACxB,GAAwH,EACxH,mBAA8D;IAE9D,OAAO,CAAC,IAAI,EAAE,EAAE;QACd,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,QAAQ,EAAE,UAAU,EAAE,IAAI,EAAE,CAAC;SAC9C;QACD,IAAI,KAAK,CAAC,YAAY,EAAE;YACtB,mBAAmB,CAAC,IAAI,CAAC,CAAC;SAC3B;QAED,MAAM,MAAM,GAAG,KAAK,CAAC,MAAM,CAAC;QAC5B,OAAO;YACL,KAAK,EAAE,MAAM,CAAC,KAAK;YACnB,OAAO,EAAE,MAAM,CAAC,OAAO;YACvB,UAAU,EAAE,MAAM,CAAC,UAAU;SAC9B,CAAC;IACJ,CAAC,CAAC;AACJ,CAAC;AA0BD,MAAM,UAAU,6BAA6B,CAC3C,OAAmC,EACnC,KAAqB,EACrB,GAAwB,EACxB,QAA8G;IAE9G,OAAO,QAAQ;QACb,CAAC,CAAC,IAAI,CACF,QAAQ,CAAC;YACP,GAAG,KAAK;YACR,sBAAsB,EAAE,KAAK,IAAI,EAAE,CAAC,aAAa,CAAC,GAAG,EAAE,EAAE,YAAY,EAAE,SAAoB,EAAE,CAAC;YAC9F,OAAO;SACR,CAAC,CACH;QACH,CAAC,CAAC,GAAG,CAAC;AACV,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 {\n  asyncScheduler,\n  defer,\n  distinct,\n  EMPTY,\n  from,\n  lastValueFrom,\n  mergeMap,\n  observeOn,\n  onErrorResumeNextWith,\n  Subject,\n  takeUntil,\n  tap,\n  throttleTime,\n} from \"rxjs\";\nimport { useTelemetryContext } from \"./UseTelemetryContext.js\";\n\nimport type { Observable } from \"rxjs\";\nimport type { MutableRefObject } from \"react\";\nimport type { BeEvent, IDisposable } from \"@itwin/core-bentley\";\nimport type { HierarchyNode, PresentationHierarchyNode } from \"@itwin/presentation-hierarchies-react\";\nimport type { TreeItemVisibilityButtonProps } from \"./components/TreeNodeVisibilityButton.js\";\n\n/**\n * Data structure that describes instance visibility status.\n * @beta\n */\nexport interface VisibilityStatus {\n  /** Instance visibility state. */\n  state: \"visible\" | \"partial\" | \"hidden\";\n  /** Specifies whether visibility changing is disabled or not. */\n  isDisabled?: boolean;\n  /** Tooltip that should be displayed when hovering over the visibility checkbox. */\n  tooltip?: string;\n}\n\n/**\n * Handler that can be used to determine and change visibility of instances represented by tree nodes.\n * @beta\n */\nexport interface HierarchyVisibilityHandler extends IDisposable {\n  /** Event used to notify tree about visibility changes from outside. */\n  readonly onVisibilityChange: BeEvent<() => void>;\n  /** Returns current visibility status for tree node. */\n  getVisibilityStatus(node: HierarchyNode): Promise<VisibilityStatus> | VisibilityStatus;\n  /** Changes visibility of the instance represented by tree node. */\n  changeVisibility(node: HierarchyNode, on: boolean): Promise<void>;\n}\n\ninterface UseHierarchyVisibilityProps {\n  visibilityHandlerFactory: () => HierarchyVisibilityHandler;\n}\n\nexport function useHierarchyVisibility({\n  visibilityHandlerFactory,\n}: UseHierarchyVisibilityProps): TreeItemVisibilityButtonProps & { triggerRefresh: () => void } {\n  const visibilityStatusMap = useRef(new Map<string, { node: PresentationHierarchyNode; status: VisibilityStatus; needsRefresh: boolean }>());\n  const [state, setState] = useState<TreeItemVisibilityButtonProps & { triggerRefresh: () => void }>({\n    getVisibilityButtonState: () => ({ state: \"hidden\", isDisabled: true }),\n    onVisibilityButtonClick: () => {},\n    triggerRefresh: () => {},\n  });\n  const { onFeatureUsed } = useTelemetryContext();\n\n  useEffect(() => {\n    visibilityStatusMap.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      visibilityStatusMap.current.forEach((value) => {\n        value.needsRefresh = true;\n      });\n      visibilityChanged.next();\n    };\n\n    const triggerCheckboxUpdate = () => {\n      setState((prev) => ({\n        ...prev,\n        getCheckboxState: createStateGetter(visibilityStatusMap, calculateNodeStatus),\n      }));\n    };\n\n    const subscription = calculate\n      .pipe(\n        distinct(undefined, visibilityChanged),\n        observeOn(asyncScheduler),\n        mergeMap((node) =>\n          defer(async () => handler.getVisibilityStatus(node.nodeData)).pipe(\n            tap({\n              next: (status) => {\n                visibilityStatusMap.current.set(node.id, {\n                  node,\n                  status,\n                  needsRefresh: false,\n                });\n              },\n            }),\n            takeUntil(visibilityChanged),\n            onErrorResumeNextWith(EMPTY),\n          ),\n        ),\n        throttleTime(100, undefined, { leading: false, trailing: true }),\n      )\n      .subscribe({\n        next: () => {\n          triggerCheckboxUpdate();\n        },\n      });\n\n    const changeVisibility: TreeItemVisibilityButtonProps[\"onVisibilityButtonClick\"] = (node, visibilityState) => {\n      onFeatureUsed({ featureId: \"visibility-change\", reportInteraction: true });\n      // visible should become hidden, partial and hidden should become visible TODO: redo for clarity\n      const on = visibilityState === \"visible\" ? false : true;\n      void handler.changeVisibility(node.nodeData, on);\n      const entry = visibilityStatusMap.current.get(node.id);\n      if (!entry) {\n        return;\n      }\n      entry.status.state = visibilityState;\n      entry.status.tooltip = undefined;\n      triggerCheckboxUpdate();\n    };\n\n    setState({\n      onVisibilityButtonClick: changeVisibility,\n      getVisibilityButtonState: createStateGetter(visibilityStatusMap, 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, onFeatureUsed]);\n\n  return state;\n}\n\nfunction createStateGetter(\n  map: MutableRefObject<Map<string, { node: PresentationHierarchyNode; status: VisibilityStatus; needsRefresh: boolean }>>,\n  calculateVisibility: (node: PresentationHierarchyNode) => void,\n): TreeItemVisibilityButtonProps[\"getVisibilityButtonState\"] {\n  return (node) => {\n    const entry = map.current.get(node.id);\n    if (entry === undefined) {\n      calculateVisibility(node);\n      return { state: \"hidden\", isDisabled: true };\n    }\n    if (entry.needsRefresh) {\n      calculateVisibility(node);\n    }\n\n    const status = entry.status;\n    return {\n      state: status.state,\n      tooltip: status.tooltip,\n      isDisabled: status.isDisabled,\n    };\n  };\n}\n\n/**\n * Properties for an overridden method of a `HierarchyVisibilityHandler` implementation.\n * @beta\n */\nexport type HierarchyVisibilityHandlerOverridableMethodProps<TFunc> = TFunc extends (props: infer TProps) => infer TResult\n  ? TProps & {\n      /** A callback that produces the value from the original implementation. */\n      readonly originalImplementation: () => TResult;\n      /**\n       * Reference to the hierarchy based handler.\n       * @note Calling `getVisibility` or `changeVisibility` of this object invokes the overridden implementation as well.\n       */\n      readonly handler: HierarchyVisibilityHandler;\n    }\n  : never;\n\n/**\n * Function type for an overridden method of `HierarchyVisibilityHandler`.\n * @beta\n */\nexport type HierarchyVisibilityHandlerOverridableMethod<TFunc> = TFunc extends (...args: any[]) => infer TResult\n  ? (props: HierarchyVisibilityHandlerOverridableMethodProps<TFunc>) => TResult\n  : never;\n\nexport function createVisibilityHandlerResult<TResult, TOverrideProps>(\n  handler: HierarchyVisibilityHandler,\n  props: TOverrideProps,\n  obs: Observable<TResult>,\n  override: HierarchyVisibilityHandlerOverridableMethod<(props: TOverrideProps) => Promise<TResult>> | undefined,\n): Observable<TResult> {\n  return override\n    ? from(\n        override({\n          ...props,\n          originalImplementation: async () => lastValueFrom(obs, { defaultValue: undefined as TResult }),\n          handler,\n        }),\n      )\n    : obs;\n}\n"]}
+{"version":3,"file":"UseHierarchyVisibility.js","sourceRoot":"","sources":["../../../../../../src/tree-widget-react/components/trees/common/UseHierarchyVisibility.ts"],"names":[],"mappings":"AAAA;;;gGAGgG;AAEhG,OAAO,EAAE,SAAS,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,OAAO,CAAC;AACpD,OAAO,EACL,cAAc,EACd,KAAK,EACL,QAAQ,EACR,KAAK,EACL,IAAI,EACJ,aAAa,EACb,QAAQ,EACR,SAAS,EACT,qBAAqB,EACrB,OAAO,EACP,SAAS,EACT,GAAG,EACH,YAAY,GACb,MAAM,MAAM,CAAC;AACd,OAAO,EAAE,aAAa,EAAE,MAAM,uBAAuB,CAAC;AACtD,OAAO,EAAE,mBAAmB,EAAE,MAAM,0BAA0B,CAAC;AAoC/D,gBAAgB;AAChB,MAAM,UAAU,sBAAsB,CAAC,EACrC,wBAAwB,GACI;IAC5B,MAAM,mBAAmB,GAAG,MAAM,CAAC,IAAI,GAAG,EAA6G,CAAC,CAAC;IACzJ,MAAM,CAAC,KAAK,EAAE,QAAQ,CAAC,GAAG,QAAQ,CAAiE;QACjG,wBAAwB,EAAE,GAAG,EAAE,CAAC,CAAC,EAAE,KAAK,EAAE,SAAS,EAAE,UAAU,EAAE,IAAI,EAAE,CAAC;QACxE,uBAAuB,EAAE,GAAG,EAAE,GAAE,CAAC;QACjC,cAAc,EAAE,GAAG,EAAE,GAAE,CAAC;KACzB,CAAC,CAAC;IACH,MAAM,EAAE,aAAa,EAAE,GAAG,mBAAmB,EAAE,CAAC;IAEhD,SAAS,CAAC,GAAG,EAAE;QACb,mBAAmB,CAAC,OAAO,CAAC,KAAK,EAAE,CAAC;QACpC,MAAM,OAAO,GAAG,wBAAwB,EAAE,CAAC;QAE3C,MAAM,iBAAiB,GAAG,IAAI,OAAO,EAAQ,CAAC;QAC9C,MAAM,SAAS,GAAG,IAAI,OAAO,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,mBAAmB,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,KAAK,EAAE,EAAE;gBAC5C,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,wBAAwB,EAAE,iBAAiB,CAAC,mBAAmB,EAAE,mBAAmB,CAAC;aACtF,CAAC,CAAC,CAAC;QACN,CAAC,CAAC;QAEF,MAAM,YAAY,GAAG,SAAS;aAC3B,IAAI,CACH,QAAQ,CAAC,SAAS,EAAE,iBAAiB,CAAC,EACtC,SAAS,CAAC,cAAc,CAAC,EACzB,QAAQ,CAAC,CAAC,IAAI,EAAE,EAAE,CAChB,KAAK,CAAC,KAAK,IAAI,EAAE,CAAC,OAAO,CAAC,mBAAmB,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,IAAI,CAChE,GAAG,CAAC;YACF,IAAI,EAAE,CAAC,MAAM,EAAE,EAAE;gBACf,mBAAmB,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,EAAE;oBACvC,IAAI;oBACJ,MAAM,EAAE;wBACN,GAAG,MAAM;wBACT,OAAO,EAAE,aAAa,CAAC,MAAM,CAAC,KAAK,CAAC;qBACrC;oBACD,YAAY,EAAE,KAAK;iBACpB,CAAC,CAAC;YACL,CAAC;SACF,CAAC,EACF,SAAS,CAAC,iBAAiB,CAAC,EAC5B,qBAAqB,CAAC,KAAK,CAAC,CAC7B,CACF,EACD,YAAY,CAAC,GAAG,EAAE,SAAS,EAAE,EAAE,OAAO,EAAE,KAAK,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC,CACjE;aACA,SAAS,CAAC;YACT,IAAI,EAAE,GAAG,EAAE;gBACT,qBAAqB,EAAE,CAAC;YAC1B,CAAC;SACF,CAAC,CAAC;QAEL,MAAM,gBAAgB,GAA6D,CAAC,IAAI,EAAE,eAAe,EAAE,EAAE;YAC3G,aAAa,CAAC,EAAE,SAAS,EAAE,mBAAmB,EAAE,iBAAiB,EAAE,IAAI,EAAE,CAAC,CAAC;YAC3E,gGAAgG;YAChG,MAAM,EAAE,GAAG,eAAe,KAAK,SAAS,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC;YACxD,KAAK,OAAO,CAAC,gBAAgB,CAAC,IAAI,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC;YACjD,MAAM,KAAK,GAAG,mBAAmB,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;YACvD,IAAI,CAAC,KAAK,EAAE;gBACV,OAAO;aACR;YACD,KAAK,CAAC,MAAM,CAAC,KAAK,GAAG,eAAe,CAAC;YACrC,KAAK,CAAC,MAAM,CAAC,OAAO,GAAG,aAAa,CAAC,aAAa,CAAC,CAAC;YACpD,qBAAqB,EAAE,CAAC;QAC1B,CAAC,CAAC;QAEF,QAAQ,CAAC;YACP,uBAAuB,EAAE,gBAAgB;YACzC,wBAAwB,EAAE,iBAAiB,CAAC,mBAAmB,EAAE,mBAAmB,CAAC;YACrF,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,EAAE,aAAa,CAAC,CAAC,CAAC;IAE9C,OAAO,KAAK,CAAC;AACf,CAAC;AAED,SAAS,iBAAiB,CACxB,GAAqI,EACrI,mBAA8D;IAE9D,OAAO,CAAC,IAAI,EAAE,EAAE;QACd,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,SAAS,EAAE,UAAU,EAAE,IAAI,EAAE,OAAO,EAAE,aAAa,CAAC,aAAa,CAAC,EAAE,CAAC;SACtF;QACD,IAAI,KAAK,CAAC,YAAY,EAAE;YACtB,mBAAmB,CAAC,IAAI,CAAC,CAAC;SAC3B;QAED,MAAM,MAAM,GAAG,KAAK,CAAC,MAAM,CAAC;QAC5B,OAAO;YACL,KAAK,EAAE,MAAM,CAAC,KAAK;YACnB,OAAO,EAAE,MAAM,CAAC,OAAO;YACvB,UAAU,EAAE,MAAM,CAAC,UAAU;SAC9B,CAAC;IACJ,CAAC,CAAC;AACJ,CAAC;AA0BD,gBAAgB;AAChB,MAAM,UAAU,6BAA6B,CAC3C,OAAmC,EACnC,KAAqB,EACrB,GAAwB,EACxB,QAA8G;IAE9G,OAAO,QAAQ;QACb,CAAC,CAAC,IAAI,CACF,QAAQ,CAAC;YACP,GAAG,KAAK;YACR,sBAAsB,EAAE,KAAK,IAAI,EAAE,CAAC,aAAa,CAAC,GAAG,EAAE,EAAE,YAAY,EAAE,SAAoB,EAAE,CAAC;YAC9F,OAAO;SACR,CAAC,CACH;QACH,CAAC,CAAC,GAAG,CAAC;AACV,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 {\n  asyncScheduler,\n  defer,\n  distinct,\n  EMPTY,\n  from,\n  lastValueFrom,\n  mergeMap,\n  observeOn,\n  onErrorResumeNextWith,\n  Subject,\n  takeUntil,\n  tap,\n  throttleTime,\n} from \"rxjs\";\nimport { createTooltip } from \"./internal/Tooltip.js\";\nimport { useTelemetryContext } from \"./UseTelemetryContext.js\";\n\nimport type { Observable } from \"rxjs\";\nimport type { MutableRefObject } from \"react\";\nimport type { BeEvent, IDisposable } from \"@itwin/core-bentley\";\nimport type { HierarchyNode, PresentationHierarchyNode } from \"@itwin/presentation-hierarchies-react\";\nimport type { TreeItemVisibilityButtonProps, TreeItemVisibilityButtonState } from \"./components/TreeNodeVisibilityButton.js\";\n\n/**\n * Data structure that describes instance visibility status.\n * @beta\n */\nexport interface VisibilityStatus {\n  /** Instance visibility state. */\n  state: \"visible\" | \"partial\" | \"hidden\";\n  /** Specifies whether visibility changing is disabled or not. */\n  isDisabled?: boolean;\n}\n\n/**\n * Handler that can be used to determine and change visibility of instances represented by tree nodes.\n * @beta\n */\nexport interface HierarchyVisibilityHandler extends IDisposable {\n  /** Event used to notify tree about visibility changes from outside. */\n  readonly onVisibilityChange: BeEvent<() => void>;\n  /** Returns current visibility status for tree node. */\n  getVisibilityStatus(node: HierarchyNode): Promise<VisibilityStatus> | VisibilityStatus;\n  /** Changes visibility of the instance represented by tree node. */\n  changeVisibility(node: HierarchyNode, on: boolean): Promise<void>;\n}\n\ninterface UseHierarchyVisibilityProps {\n  visibilityHandlerFactory: () => HierarchyVisibilityHandler;\n}\n\n/** @internal */\nexport function useHierarchyVisibility({\n  visibilityHandlerFactory,\n}: UseHierarchyVisibilityProps): TreeItemVisibilityButtonProps & { triggerRefresh: () => void } {\n  const visibilityStatusMap = useRef(new Map<string, { node: PresentationHierarchyNode; status: TreeItemVisibilityButtonState; needsRefresh: boolean }>());\n  const [state, setState] = useState<TreeItemVisibilityButtonProps & { triggerRefresh: () => void }>({\n    getVisibilityButtonState: () => ({ state: \"visible\", isDisabled: true }),\n    onVisibilityButtonClick: () => {},\n    triggerRefresh: () => {},\n  });\n  const { onFeatureUsed } = useTelemetryContext();\n\n  useEffect(() => {\n    visibilityStatusMap.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      visibilityStatusMap.current.forEach((value) => {\n        value.needsRefresh = true;\n      });\n      visibilityChanged.next();\n    };\n\n    const triggerCheckboxUpdate = () => {\n      setState((prev) => ({\n        ...prev,\n        getVisibilityButtonState: createStateGetter(visibilityStatusMap, calculateNodeStatus),\n      }));\n    };\n\n    const subscription = calculate\n      .pipe(\n        distinct(undefined, visibilityChanged),\n        observeOn(asyncScheduler),\n        mergeMap((node) =>\n          defer(async () => handler.getVisibilityStatus(node.nodeData)).pipe(\n            tap({\n              next: (status) => {\n                visibilityStatusMap.current.set(node.id, {\n                  node,\n                  status: {\n                    ...status,\n                    tooltip: createTooltip(status.state),\n                  },\n                  needsRefresh: false,\n                });\n              },\n            }),\n            takeUntil(visibilityChanged),\n            onErrorResumeNextWith(EMPTY),\n          ),\n        ),\n        throttleTime(100, undefined, { leading: false, trailing: true }),\n      )\n      .subscribe({\n        next: () => {\n          triggerCheckboxUpdate();\n        },\n      });\n\n    const changeVisibility: TreeItemVisibilityButtonProps[\"onVisibilityButtonClick\"] = (node, visibilityState) => {\n      onFeatureUsed({ featureId: \"visibility-change\", reportInteraction: true });\n      // visible should become hidden, partial and hidden should become visible TODO: redo for clarity\n      const on = visibilityState === \"visible\" ? false : true;\n      void handler.changeVisibility(node.nodeData, on);\n      const entry = visibilityStatusMap.current.get(node.id);\n      if (!entry) {\n        return;\n      }\n      entry.status.state = visibilityState;\n      entry.status.tooltip = createTooltip(\"determining\");\n      triggerCheckboxUpdate();\n    };\n\n    setState({\n      onVisibilityButtonClick: changeVisibility,\n      getVisibilityButtonState: createStateGetter(visibilityStatusMap, 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, onFeatureUsed]);\n\n  return state;\n}\n\nfunction createStateGetter(\n  map: MutableRefObject<Map<string, { node: PresentationHierarchyNode; status: TreeItemVisibilityButtonState; needsRefresh: boolean }>>,\n  calculateVisibility: (node: PresentationHierarchyNode) => void,\n): TreeItemVisibilityButtonProps[\"getVisibilityButtonState\"] {\n  return (node) => {\n    const entry = map.current.get(node.id);\n    if (entry === undefined) {\n      calculateVisibility(node);\n      return { state: \"visible\", isDisabled: true, tooltip: createTooltip(\"determining\") };\n    }\n    if (entry.needsRefresh) {\n      calculateVisibility(node);\n    }\n\n    const status = entry.status;\n    return {\n      state: status.state,\n      tooltip: status.tooltip,\n      isDisabled: status.isDisabled,\n    };\n  };\n}\n\n/**\n * Properties for an overridden method of a `HierarchyVisibilityHandler` implementation.\n * @beta\n */\nexport type HierarchyVisibilityHandlerOverridableMethodProps<TFunc> = TFunc extends (props: infer TProps) => infer TResult\n  ? TProps & {\n      /** A callback that produces the value from the original implementation. */\n      readonly originalImplementation: () => TResult;\n      /**\n       * Reference to the hierarchy based handler.\n       * @note Calling `getVisibility` or `changeVisibility` of this object invokes the overridden implementation as well.\n       */\n      readonly handler: HierarchyVisibilityHandler;\n    }\n  : never;\n\n/**\n * Function type for an overridden method of `HierarchyVisibilityHandler`.\n * @beta\n */\nexport type HierarchyVisibilityHandlerOverridableMethod<TFunc> = TFunc extends (...args: any[]) => infer TResult\n  ? (props: HierarchyVisibilityHandlerOverridableMethodProps<TFunc>) => TResult\n  : never;\n\n/** @internal */\nexport function createVisibilityHandlerResult<TResult, TOverrideProps>(\n  handler: HierarchyVisibilityHandler,\n  props: TOverrideProps,\n  obs: Observable<TResult>,\n  override: HierarchyVisibilityHandlerOverridableMethod<(props: TOverrideProps) => Promise<TResult>> | undefined,\n): Observable<TResult> {\n  return override\n    ? from(\n        override({\n          ...props,\n          originalImplementation: async () => lastValueFrom(obs, { defaultValue: undefined as TResult }),\n          handler,\n        }),\n      )\n    : obs;\n}\n"]}

package/lib/esm/tree-widget-react/components/trees/common/UseNodeHighlighting.d.ts

@@ -15,6 +15,7 @@ interface UseNodeHighlightingResult {
     activeNodeId?: string;
     getLabel: (node: PresentationHierarchyNode) => React.ReactElement;
 }
+/** @internal */
 export declare function useNodeHighlighting({ rootNodes, highlight }: UseNodeHighlightingProps): UseNodeHighlightingResult;
 export {};
 //# sourceMappingURL=UseNodeHighlighting.d.ts.map

package/lib/esm/tree-widget-react/components/trees/common/UseNodeHighlighting.js

@@ -3,40 +3,42 @@ import { Fragment as _Fragment, jsx as _jsx } from "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.
  *--------------------------------------------------------------------------------------------*/
-import { useCallback, useEffect, useRef, useState } from "react";
+import { useCallback, useEffect, useState } from "react";
 import { isPresentationHierarchyNode } from "@itwin/presentation-hierarchies-react";
-import { useLatest } from "./Utils.js";
+import { useLatest } from "./internal/Utils.js";
+/** @internal */
 export function useNodeHighlighting({ rootNodes, highlight }) {
-    const state = useRef({ nodeInfoMap: new Map(), totalMatches: 0 });
+    const [state, setState] = useState({ nodeInfoMap: new Map(), totalMatches: 0 });
     const [activeNodeId, setActiveNodeId] = useState();
     const activeMatchIndexRef = useLatest(highlight?.activeMatchIndex);
     const activeNodeIdRef = useLatest(activeNodeId);
     const onHighlightChangedRef = useLatest(highlight?.onHighlightChanged);
+    const prevStateRef = useLatest(state);
     const searchText = highlight?.text;
     useEffect(() => {
         const { state: newState, activeIndex } = rootNodes && searchText
-            ? computeHighlightState(rootNodes, searchText, state.current, activeNodeIdRef.current, activeMatchIndexRef.current)
+            ? computeHighlightState(rootNodes, searchText, prevStateRef.current, activeNodeIdRef.current, activeMatchIndexRef.current)
             : { state: { nodeInfoMap: new Map(), totalMatches: 0 }, activeIndex: 0 };
-        state.current = newState;
+        setState(newState);
         if (newState.totalMatches === 0) {
             setActiveNodeId(undefined);
         }
         onHighlightChangedRef.current?.(newState.totalMatches === 0 ? 0 : activeIndex, newState.totalMatches);
-    }, [rootNodes, searchText, activeNodeIdRef, activeMatchIndexRef, onHighlightChangedRef]);
+    }, [rootNodes, searchText, activeNodeIdRef, activeMatchIndexRef, onHighlightChangedRef, prevStateRef]);
     useEffect(() => {
-        for (const nodeId of state.current.nodeInfoMap.keys()) {
-            if (getNodeChunkInfo(state.current, nodeId, highlight?.activeMatchIndex)?.activeChunkIndex !== undefined) {
+        for (const nodeId of state.nodeInfoMap.keys()) {
+            if (getNodeChunkInfo(state, nodeId, highlight?.activeMatchIndex)?.activeChunkIndex !== undefined) {
                 setActiveNodeId(nodeId);
             }
         }
-    }, [highlight?.activeMatchIndex]);
+    }, [state, highlight?.activeMatchIndex]);
     const getLabel = useCallback((node) => {
-        const chunkInfo = getNodeChunkInfo(state.current, node.id, highlight?.activeMatchIndex);
+        const chunkInfo = getNodeChunkInfo(state, node.id, highlight?.activeMatchIndex);
         if (searchText && chunkInfo) {
             return _jsx(_Fragment, { children: markChunks(node.label, chunkInfo.chunks, chunkInfo.activeChunkIndex) });
         }
         return _jsx("span", { children: node.label });
-    }, [searchText, highlight?.activeMatchIndex]);
+    }, [state, searchText, highlight?.activeMatchIndex]);
     return { activeNodeId, getLabel };
 }
 function getNodeChunkInfo(state, nodeId, activeIndex) {