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

package/lib/esm/components/trees/common/FocusedInstancesContextProvider.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"FocusedInstancesContextProvider.js","sourceRoot":"","sources":["../../../../../src/components/trees/common/FocusedInstancesContextProvider.tsx"],"names":[],"mappings":";AAAA;;;gGAGgG;AAEhG,OAAO,EAAE,SAAS,EAAE,QAAQ,EAAE,MAAM,OAAO,CAAC;AAC5C,OAAO,EAAE,aAAa,EAAE,MAAM,uCAAuC,CAAC;AACtE,OAAO,EAAE,UAAU,EAAE,WAAW,EAAE,MAAM,0BAA0B,CAAC;AACnE,OAAO,EAAE,uBAAuB,EAAE,MAAM,2BAA2B,CAAC;AAQpE,gBAAgB;AAChB,MAAM,UAAU,+BAA+B,CAAC,EAC9C,gBAAgB,EAChB,SAAS,EACT,QAAQ,GACqE;IAC7E,MAAM,CAAC,KAAK,EAAE,QAAQ,CAAC,GAAG,QAAQ,CAA0B;QAC1D,OAAO,EAAE,KAAK;QACd,MAAM,EAAE,GAAG,EAAE;YACX,QAAQ,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,EAAE,GAAG,IAAI,EAAE,OAAO,EAAE,CAAC,IAAI,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC;QAC5D,CAAC;KACF,CAAC,CAAC;IACH,MAAM,OAAO,GAAG,KAAK,CAAC,OAAO,CAAC;IAE9B,SAAS,CAAC,GAAG,EAAE;QACb,IAAI,CAAC,OAAO,EAAE;YACZ,QAAQ,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,EAAE,GAAG,IAAI,EAAE,gBAAgB,EAAE,SAAS,EAAE,CAAC,CAAC,CAAC;YAC/D,OAAO;SACR;QAED,MAAM,kBAAkB,GAAG,GAAG,EAAE;YAC9B,MAAM,SAAS,GAAG,gBAAgB,CAAC,YAAY,CAAC,EAAE,SAAS,EAAE,KAAK,EAAE,CAAC,EAAE,CAAC,CAAC;YACzE,IAAI,WAAW,CAAC,OAAO,CAAC,SAAS,CAAC,EAAE;gBAClC,QAAQ,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,EAAE,GAAG,IAAI,EAAE,gBAAgB,EAAE,SAAS,EAAE,CAAC,CAAC,CAAC;gBAC/D,OAAO;aACR;YAED,MAAM,QAAQ,GAA4F,EAAE,CAAC;YAC7G,WAAW,CAAC,OAAO,CAAC,SAAS,EAAE,CAAC,UAAU,EAAE,EAAE;gBAC5C,IAAI,UAAU,CAAC,aAAa,CAAC,UAAU,CAAC,EAAE;oBACxC,QAAQ,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;oBAC1B,OAAO;iBACR;gBAED,IAAI,eAAe,CAAC,UAAU,CAAC,IAAI,CAAC,IAAI,aAAa,CAAC,cAAc,CAAC,UAAU,CAAC,IAAI,CAAC,EAAE;oBACrF,QAAQ,CAAC,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC;oBAC/B,OAAO;iBACR;gBAED,QAAQ,CAAC,IAAI,CAAC,UAAU,CAAC,gBAAgB,CAAC,CAAC;YAC7C,CAAC,CAAC,CAAC;YAEH,MAAM,gBAAgB,GAAqE,KAAK,SAAS,CAAC;gBACxG,KAAK,MAAM,IAAI,IAAI,QAAQ,EAAE;oBAC3B,IAAI,OAAO,IAAI,KAAK,UAAU,EAAE;wBAC9B,KAAK,CAAC,CAAC,IAAI,EAAE,CAAC;qBACf;yBAAM;wBACL,MAAM,IAAI,CAAC;qBACZ;iBACF;YACH,CAAC,CAAC;YAEF,QAAQ,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,EAAE,GAAG,IAAI,EAAE,gBAAgB,EAAE,CAAC,CAAC,CAAC;QACtD,CAAC,CAAC;QAEF,kBAAkB,EAAE,CAAC;QACrB,OAAO,gBAAgB,CAAC,oBAAoB,CAAC,WAAW,CAAC,CAAC,EAAE,SAAS,EAAE,eAAe,EAAE,KAAK,EAAE,EAAE,EAAE;YACjG,IAAI,eAAe,KAAK,SAAS,IAAI,KAAK,KAAK,CAAC,EAAE;gBAChD,OAAO;aACR;YACD,kBAAkB,EAAE,CAAC;QACvB,CAAC,CAAC,CAAC;IACL,CAAC,EAAE,CAAC,OAAO,EAAE,SAAS,EAAE,gBAAgB,CAAC,CAAC,CAAC;IAE3C,OAAO,KAAC,uBAAuB,CAAC,QAAQ,IAAC,KAAK,EAAE,KAAK,YAAG,QAAQ,GAAoC,CAAC;AACvG,CAAC;AAED,SAAS,eAAe,CAAC,IAAa;IACpC,OAAO,CAAC,CAAC,IAAI,IAAI,OAAO,IAAI,KAAK,QAAQ,IAAI,KAAK,IAAI,IAAI,CAAC;AAC7D,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, useState } from \"react\";\nimport { HierarchyNode } from \"@itwin/presentation-hierarchies-react\";\nimport { Selectable, Selectables } from \"@itwin/unified-selection\";\nimport { focusedInstancesContext } from \"./FocusedInstancesContext\";\n\nimport type { SelectionStorage } from \"@itwin/presentation-hierarchies-react\";\nimport type { PropsWithChildren } from \"react\";\nimport type { InstanceKey } from \"@itwin/presentation-common\";\nimport type { FocusedInstancesContext } from \"./FocusedInstancesContext\";\nimport type { GroupingHierarchyNode } from \"@itwin/presentation-hierarchies\";\n\n/** @internal */\nexport function FocusedInstancesContextProvider({\n  selectionStorage,\n  imodelKey,\n  children,\n}: PropsWithChildren<{ selectionStorage: SelectionStorage; imodelKey: string }>) {\n  const [state, setState] = useState<FocusedInstancesContext>({\n    enabled: false,\n    toggle: () => {\n      setState((prev) => ({ ...prev, enabled: !prev.enabled }));\n    },\n  });\n  const enabled = state.enabled;\n\n  useEffect(() => {\n    if (!enabled) {\n      setState((prev) => ({ ...prev, loadInstanceKeys: undefined }));\n      return;\n    }\n\n    const onSelectionChanged = () => {\n      const selection = selectionStorage.getSelection({ imodelKey, level: 0 });\n      if (Selectables.isEmpty(selection)) {\n        setState((prev) => ({ ...prev, loadInstanceKeys: undefined }));\n        return;\n      }\n\n      const selected: Array<InstanceKey | GroupingHierarchyNode | (() => AsyncIterableIterator<InstanceKey>)> = [];\n      Selectables.forEach(selection, (selectable) => {\n        if (Selectable.isInstanceKey(selectable)) {\n          selected.push(selectable);\n          return;\n        }\n\n        if (isHierarchyNode(selectable.data) && HierarchyNode.isGroupingNode(selectable.data)) {\n          selected.push(selectable.data);\n          return;\n        }\n\n        selected.push(selectable.loadInstanceKeys);\n      });\n\n      const loadInstanceKeys: () => AsyncIterableIterator<InstanceKey | GroupingHierarchyNode> = async function* () {\n        for (const item of selected) {\n          if (typeof item === \"function\") {\n            yield* item();\n          } else {\n            yield item;\n          }\n        }\n      };\n\n      setState((prev) => ({ ...prev, loadInstanceKeys }));\n    };\n\n    onSelectionChanged();\n    return selectionStorage.selectionChangeEvent.addListener(({ imodelKey: changeImodelKey, level }) => {\n      if (changeImodelKey !== imodelKey || level !== 0) {\n        return;\n      }\n      onSelectionChanged();\n    });\n  }, [enabled, imodelKey, selectionStorage]);\n\n  return <focusedInstancesContext.Provider value={state}>{children}</focusedInstancesContext.Provider>;\n}\n\nfunction isHierarchyNode(data: unknown): data is HierarchyNode {\n  return !!data && typeof data === \"object\" && \"key\" in data;\n}\n"]}

package/lib/esm/components/trees/common/Rxjs.d.ts

@@ -0,0 +1,10 @@
+import type { Observable, ObservableInput, OperatorFunction } from "rxjs";
+/**
+ * Applies reduce function and "returns" early if the predicate returns `false` for the accumulator.
+ */
+export declare function reduceWhile<TValue, TAccumulator>(predicate: (x: TAccumulator) => boolean, reduceFunc: (acc: TAccumulator, val: TValue) => TAccumulator, initial: TAccumulator): OperatorFunction<TValue, TAccumulator | undefined>;
+/** Same as `firstValueFrom` except it won't throw if the observable emits no values. */
+export declare function toVoidPromise(obs: Observable<any>): Promise<void>;
+/** Returns observable results in an array */
+export declare function collect<T>(obs: ObservableInput<T>): Promise<T[]>;
+//# sourceMappingURL=Rxjs.d.ts.map

package/lib/esm/components/trees/common/Rxjs.js

@@ -0,0 +1,40 @@
+/*---------------------------------------------------------------------------------------------
+ * Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+ * See LICENSE.md in the project root for license terms and full copyright notice.
+ *--------------------------------------------------------------------------------------------*/
+import { defaultIfEmpty, from, last, scan, takeWhile } from "rxjs";
+/**
+ * Applies reduce function and "returns" early if the predicate returns `false` for the accumulator.
+ */
+export function reduceWhile(predicate, reduceFunc, initial) {
+    return (obs) => {
+        return obs.pipe(scan(reduceFunc, initial), takeWhile(predicate, true), defaultIfEmpty(undefined), last());
+    };
+}
+/** Same as `firstValueFrom` except it won't throw if the observable emits no values. */
+export async function toVoidPromise(obs) {
+    return new Promise((resolve, reject) => {
+        obs.subscribe({
+            complete: () => resolve(),
+            error: reject,
+        });
+    });
+}
+/** Returns observable results in an array */
+export async function collect(obs) {
+    return new Promise((resolve, reject) => {
+        const arr = new Array();
+        from(obs).subscribe({
+            next(item) {
+                arr.push(item);
+            },
+            complete() {
+                resolve(arr);
+            },
+            error(reason) {
+                reject(reason);
+            },
+        });
+    });
+}
+//# sourceMappingURL=Rxjs.js.map

package/lib/esm/components/trees/common/Rxjs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Rxjs.js","sourceRoot":"","sources":["../../../../../src/components/trees/common/Rxjs.ts"],"names":[],"mappings":"AAAA;;;gGAGgG;AAEhG,OAAO,EAAE,cAAc,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,SAAS,EAAE,MAAM,MAAM,CAAC;AAInE;;GAEG;AACH,MAAM,UAAU,WAAW,CACzB,SAAuC,EACvC,UAA4D,EAC5D,OAAqB;IAErB,OAAO,CAAC,GAAG,EAAE,EAAE;QACb,OAAO,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE,OAAO,CAAC,EAAE,SAAS,CAAC,SAAS,EAAE,IAAI,CAAC,EAAE,cAAc,CAAC,SAAS,CAAC,EAAE,IAAI,EAAE,CAAC,CAAC;IAC5G,CAAC,CAAC;AACJ,CAAC;AAED,wFAAwF;AACxF,MAAM,CAAC,KAAK,UAAU,aAAa,CAAC,GAAoB;IACtD,OAAO,IAAI,OAAO,CAAO,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;QAC3C,GAAG,CAAC,SAAS,CAAC;YACZ,QAAQ,EAAE,GAAG,EAAE,CAAC,OAAO,EAAE;YACzB,KAAK,EAAE,MAAM;SACd,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;AACL,CAAC;AAED,6CAA6C;AAC7C,MAAM,CAAC,KAAK,UAAU,OAAO,CAAI,GAAuB;IACtD,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;QACrC,MAAM,GAAG,GAAG,IAAI,KAAK,EAAK,CAAC;QAC3B,IAAI,CAAC,GAAG,CAAC,CAAC,SAAS,CAAC;YAClB,IAAI,CAAC,IAAO;gBACV,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YACjB,CAAC;YACD,QAAQ;gBACN,OAAO,CAAC,GAAG,CAAC,CAAC;YACf,CAAC;YACD,KAAK,CAAC,MAAM;gBACV,MAAM,CAAC,MAAM,CAAC,CAAC;YACjB,CAAC;SACF,CAAC,CAAC;IACL,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 { defaultIfEmpty, from, last, scan, takeWhile } from \"rxjs\";\n\nimport type { Observable, ObservableInput, OperatorFunction } from \"rxjs\";\n\n/**\n * Applies reduce function and \"returns\" early if the predicate returns `false` for the accumulator.\n */\nexport function reduceWhile<TValue, TAccumulator>(\n  predicate: (x: TAccumulator) => boolean,\n  reduceFunc: (acc: TAccumulator, val: TValue) => TAccumulator,\n  initial: TAccumulator,\n): OperatorFunction<TValue, TAccumulator | undefined> {\n  return (obs) => {\n    return obs.pipe(scan(reduceFunc, initial), takeWhile(predicate, true), defaultIfEmpty(undefined), last());\n  };\n}\n\n/** Same as `firstValueFrom` except it won't throw if the observable emits no values. */\nexport async function toVoidPromise(obs: Observable<any>): Promise<void> {\n  return new Promise<void>((resolve, reject) => {\n    obs.subscribe({\n      complete: () => resolve(),\n      error: reject,\n    });\n  });\n}\n\n/** Returns observable results in an array */\nexport async function collect<T>(obs: ObservableInput<T>): Promise<T[]> {\n  return new Promise((resolve, reject) => {\n    const arr = new Array<T>();\n    from(obs).subscribe({\n      next(item: T) {\n        arr.push(item);\n      },\n      complete() {\n        resolve(arr);\n      },\n      error(reason) {\n        reject(reason);\n      },\n    });\n  });\n}\n"]}

package/lib/esm/components/trees/common/UseFeatureReporting.d.ts

@@ -20,4 +20,15 @@ export type UsageTrackedFeatures = "visibility-change" | "hierarchy-level-filter
  * @internal
  */
 export declare function useFeatureReporting(props: UseFeatureReportingProps): UseFeatureReportingResult;
+interface UseReportingActionProps<T> {
+    action: T;
+    featureId?: UsageTrackedFeatures;
+    reportUsage?: (props: {
+        featureId?: UsageTrackedFeatures;
+        reportInteraction: true;
+    }) => void;
+}
+/** @internal */
+export declare function useReportingAction<T extends (...args: any[]) => void>({ action, featureId, reportUsage }: UseReportingActionProps<T>): (...args: Parameters<T>) => void;
+export {};
 //# sourceMappingURL=UseFeatureReporting.d.ts.map

package/lib/esm/components/trees/common/UseFeatureReporting.js

@@ -23,4 +23,12 @@ export function useFeatureReporting(props) {
     }, [treeIdentifier]);
     return { reportUsage };
 }
+/** @internal */
+// istanbul ignore next
+export function useReportingAction({ action, featureId, reportUsage }) {
+    return useCallback((...args) => {
+        reportUsage?.({ featureId, reportInteraction: true });
+        action(...args);
+    }, [action, reportUsage, featureId]);
+}
 //# sourceMappingURL=UseFeatureReporting.js.map

package/lib/esm/components/trees/common/UseFeatureReporting.js.map

@@ -1 +1 @@
-{"version":3,"file":"UseFeatureReporting.js","sourceRoot":"","sources":["../../../../../src/components/trees/common/UseFeatureReporting.ts"],"names":[],"mappings":"AAAA;;;gGAGgG;AAEhG,OAAO,EAAE,WAAW,EAAE,SAAS,EAAE,MAAM,EAAE,MAAM,OAAO,CAAC;AAmBvD;;;GAGG;AACH,MAAM,UAAU,mBAAmB,CAAC,KAA+B;IACjE,MAAM,EAAE,cAAc,EAAE,aAAa,EAAE,GAAG,KAAK,CAAC;IAChD,MAAM,gBAAgB,GAAG,MAAM,CAAC,aAAa,CAAC,CAAC;IAE/C,SAAS,CAAC,GAAG,EAAE;QACb,gBAAgB,CAAC,OAAO,GAAG,aAAa,CAAC;IAC3C,CAAC,EAAE,CAAC,aAAa,CAAC,CAAC,CAAC;IAEpB,MAAM,WAAW,GAAG,WAAW,CAC7B,CAAC,EAAE,SAAS,EAAE,iBAAiB,EAAoE,EAAE,EAAE;QACrG,IAAI,iBAAiB,KAAK,KAAK,EAAE;YAC/B,gBAAgB,CAAC,OAAO,EAAE,CAAC,OAAO,cAAc,EAAE,CAAC,CAAC;SACrD;QACD,IAAI,SAAS,EAAE;YACb,gBAAgB,CAAC,OAAO,EAAE,CAAC,GAAG,cAAc,IAAI,SAAS,EAAE,CAAC,CAAC;SAC9D;IACH,CAAC,EACD,CAAC,cAAc,CAAC,CACjB,CAAC;IAEF,OAAO,EAAE,WAAW,EAAE,CAAC;AACzB,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 } from \"react\";\n\n/** @internal */\nexport interface UseFeatureReportingProps {\n  treeIdentifier: string;\n  onFeatureUsed?: (featureId: string) => void;\n}\n\n/** @internal */\nexport interface UseFeatureReportingResult {\n  reportUsage: (props: { featureId?: UsageTrackedFeatures; reportInteraction: boolean }) => void;\n}\n\n/**\n * Features that are tracked for usage.\n * @internal\n */\nexport type UsageTrackedFeatures = \"visibility-change\" | \"hierarchy-level-filtering\" | \"filtering\" | \"hierarchy-level-size-limit-hit\" | \"zoom-to-node\";\n\n/**\n * Enables feature reporting for a tree component.\n * @internal\n */\nexport function useFeatureReporting(props: UseFeatureReportingProps): UseFeatureReportingResult {\n  const { treeIdentifier, onFeatureUsed } = props;\n  const onFeatureUsedRef = useRef(onFeatureUsed);\n\n  useEffect(() => {\n    onFeatureUsedRef.current = onFeatureUsed;\n  }, [onFeatureUsed]);\n\n  const reportUsage = useCallback(\n    ({ featureId, reportInteraction }: { featureId?: UsageTrackedFeatures; reportInteraction: boolean }) => {\n      if (reportInteraction !== false) {\n        onFeatureUsedRef.current?.(`use-${treeIdentifier}`);\n      }\n      if (featureId) {\n        onFeatureUsedRef.current?.(`${treeIdentifier}-${featureId}`);\n      }\n    },\n    [treeIdentifier],\n  );\n\n  return { reportUsage };\n}\n"]}
+{"version":3,"file":"UseFeatureReporting.js","sourceRoot":"","sources":["../../../../../src/components/trees/common/UseFeatureReporting.ts"],"names":[],"mappings":"AAAA;;;gGAGgG;AAEhG,OAAO,EAAE,WAAW,EAAE,SAAS,EAAE,MAAM,EAAE,MAAM,OAAO,CAAC;AAmBvD;;;GAGG;AACH,MAAM,UAAU,mBAAmB,CAAC,KAA+B;IACjE,MAAM,EAAE,cAAc,EAAE,aAAa,EAAE,GAAG,KAAK,CAAC;IAChD,MAAM,gBAAgB,GAAG,MAAM,CAAC,aAAa,CAAC,CAAC;IAE/C,SAAS,CAAC,GAAG,EAAE;QACb,gBAAgB,CAAC,OAAO,GAAG,aAAa,CAAC;IAC3C,CAAC,EAAE,CAAC,aAAa,CAAC,CAAC,CAAC;IAEpB,MAAM,WAAW,GAAG,WAAW,CAC7B,CAAC,EAAE,SAAS,EAAE,iBAAiB,EAAoE,EAAE,EAAE;QACrG,IAAI,iBAAiB,KAAK,KAAK,EAAE;YAC/B,gBAAgB,CAAC,OAAO,EAAE,CAAC,OAAO,cAAc,EAAE,CAAC,CAAC;SACrD;QACD,IAAI,SAAS,EAAE;YACb,gBAAgB,CAAC,OAAO,EAAE,CAAC,GAAG,cAAc,IAAI,SAAS,EAAE,CAAC,CAAC;SAC9D;IACH,CAAC,EACD,CAAC,cAAc,CAAC,CACjB,CAAC;IAEF,OAAO,EAAE,WAAW,EAAE,CAAC;AACzB,CAAC;AAQD,gBAAgB;AAChB,uBAAuB;AACvB,MAAM,UAAU,kBAAkB,CAAqC,EAAE,MAAM,EAAE,SAAS,EAAE,WAAW,EAA8B;IACnI,OAAO,WAAW,CAChB,CAAC,GAAG,IAAI,EAAE,EAAE;QACV,WAAW,EAAE,CAAC,EAAE,SAAS,EAAE,iBAAiB,EAAE,IAAI,EAAE,CAAC,CAAC;QACtD,MAAM,CAAC,GAAG,IAAI,CAAC,CAAC;IAClB,CAAC,EACD,CAAC,MAAM,EAAE,WAAW,EAAE,SAAS,CAAC,CACjC,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 } from \"react\";\n\n/** @internal */\nexport interface UseFeatureReportingProps {\n  treeIdentifier: string;\n  onFeatureUsed?: (featureId: string) => void;\n}\n\n/** @internal */\nexport interface UseFeatureReportingResult {\n  reportUsage: (props: { featureId?: UsageTrackedFeatures; reportInteraction: boolean }) => void;\n}\n\n/**\n * Features that are tracked for usage.\n * @internal\n */\nexport type UsageTrackedFeatures = \"visibility-change\" | \"hierarchy-level-filtering\" | \"filtering\" | \"hierarchy-level-size-limit-hit\" | \"zoom-to-node\";\n\n/**\n * Enables feature reporting for a tree component.\n * @internal\n */\nexport function useFeatureReporting(props: UseFeatureReportingProps): UseFeatureReportingResult {\n  const { treeIdentifier, onFeatureUsed } = props;\n  const onFeatureUsedRef = useRef(onFeatureUsed);\n\n  useEffect(() => {\n    onFeatureUsedRef.current = onFeatureUsed;\n  }, [onFeatureUsed]);\n\n  const reportUsage = useCallback(\n    ({ featureId, reportInteraction }: { featureId?: UsageTrackedFeatures; reportInteraction: boolean }) => {\n      if (reportInteraction !== false) {\n        onFeatureUsedRef.current?.(`use-${treeIdentifier}`);\n      }\n      if (featureId) {\n        onFeatureUsedRef.current?.(`${treeIdentifier}-${featureId}`);\n      }\n    },\n    [treeIdentifier],\n  );\n\n  return { reportUsage };\n}\n\ninterface UseReportingActionProps<T> {\n  action: T;\n  featureId?: UsageTrackedFeatures;\n  reportUsage?: (props: { featureId?: UsageTrackedFeatures; reportInteraction: true }) => void;\n}\n\n/** @internal */\n// istanbul ignore next\nexport function useReportingAction<T extends (...args: any[]) => void>({ action, featureId, reportUsage }: UseReportingActionProps<T>) {\n  return useCallback<(...args: Parameters<T>) => void>(\n    (...args) => {\n      reportUsage?.({ featureId, reportInteraction: true });\n      action(...args);\n    },\n    [action, reportUsage, featureId],\n  );\n}\n"]}

package/lib/esm/components/trees/common/UseFiltering.d.ts

@@ -0,0 +1,12 @@
+interface UseFilteringResult {
+    filter: string;
+    activeMatchIndex: number;
+    totalMatches: number;
+    applyFilter: (filter: string) => void;
+    clearFilter: () => void;
+    onHighlightChanged: (index: number, matches?: number) => void;
+}
+/** @internal */
+export declare function useFiltering(): UseFilteringResult;
+export {};
+//# sourceMappingURL=UseFiltering.d.ts.map

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

@@ -0,0 +1,25 @@
+/*---------------------------------------------------------------------------------------------
+ * Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+ * See LICENSE.md in the project root for license terms and full copyright notice.
+ *--------------------------------------------------------------------------------------------*/
+import { useCallback, useState } from "react";
+/** @internal */
+export function useFiltering() {
+    const [filter, setFilter] = useState("");
+    const [activeMatchIndex, setActiveMatchIndex] = useState(0);
+    const [totalMatches, setTotalMatches] = useState(0);
+    const applyFilter = useCallback((newFilter) => {
+        setActiveMatchIndex(0);
+        setFilter(newFilter);
+    }, []);
+    const clearFilter = useCallback(() => {
+        setActiveMatchIndex(0);
+        setFilter("");
+    }, []);
+    const onHighlightChanged = useCallback((index, matches) => {
+        setActiveMatchIndex(index);
+        matches && setTotalMatches(matches);
+    }, []);
+    return { filter, activeMatchIndex, totalMatches, applyFilter, clearFilter, onHighlightChanged };
+}
+//# sourceMappingURL=UseFiltering.js.map

package/lib/esm/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,OAAO,EAAE,WAAW,EAAE,QAAQ,EAAE,MAAM,OAAO,CAAC;AAW9C,gBAAgB;AAChB,MAAM,UAAU,YAAY;IAC1B,MAAM,CAAC,MAAM,EAAE,SAAS,CAAC,GAAG,QAAQ,CAAC,EAAE,CAAC,CAAC;IACzC,MAAM,CAAC,gBAAgB,EAAE,mBAAmB,CAAC,GAAG,QAAQ,CAAC,CAAC,CAAC,CAAC;IAC5D,MAAM,CAAC,YAAY,EAAE,eAAe,CAAC,GAAG,QAAQ,CAAC,CAAC,CAAC,CAAC;IAEpD,MAAM,WAAW,GAAG,WAAW,CAAC,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,WAAW,CAAC,GAAG,EAAE;QACnC,mBAAmB,CAAC,CAAC,CAAC,CAAC;QACvB,SAAS,CAAC,EAAE,CAAC,CAAC;IAChB,CAAC,EAAE,EAAE,CAAC,CAAC;IAEP,MAAM,kBAAkB,GAAG,WAAW,CAAC,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","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/stateless → esm/components/trees}/common/UseHierarchiesLocalization.d.ts

@@ -1,8 +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;
+type UseHierarchiesLocalizationResult = UseTreeLocalizedStrings & TreeRendererLocalizedStrings;
 /** @internal */
-export declare function useHierarchiesLocalization(): useHierarchiesLocalizationResult;
+export declare function useHierarchiesLocalization(): UseHierarchiesLocalizationResult;
 export {};
 //# sourceMappingURL=UseHierarchiesLocalization.d.ts.map

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

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

package/lib/esm/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,OAAO,EAAE,OAAO,EAAE,MAAM,OAAO,CAAC;AAChC,OAAO,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAC;AASjD,gBAAgB;AAChB,MAAM,UAAU,0BAA0B;IACxC,MAAM,YAAY,GAAG,MAAM,CAAC,MAAM,CAAC,mBAAmB,EAAG,CAAC,CAAC;IAC3D,MAAM,gBAAgB,GAAG,OAAO,CAAC,mBAAmB,EAAE,YAAY,CAAC,CAAC;IACpE,OAAO,gBAAgB,CAAC;AAC1B,CAAC;AAED,SAAS,mBAAmB;IAC1B,OAAO;QACL,iDAAiD;QACjD,WAAW,EAAE,UAAU,CAAC,SAAS,CAAC,sCAAsC,CAAC;QACzE,KAAK,EAAE,UAAU,CAAC,SAAS,CAAC,gCAAgC,CAAC;QAE7D,oDAAoD;QACpD,OAAO,EAAE,UAAU,CAAC,SAAS,CAAC,kCAAkC,CAAC;QACjE,oBAAoB,EAAE,UAAU,CAAC,SAAS,CAAC,+CAA+C,CAAC;QAC3F,yBAAyB,EAAE,UAAU,CAAC,SAAS,CAAC,oDAAoD,CAAC;QACrG,kBAAkB,EAAE,UAAU,CAAC,SAAS,CAAC,6CAA6C,CAAC;QACvF,mBAAmB,EAAE,UAAU,CAAC,SAAS,CAAC,8CAA8C,CAAC;QACzF,gCAAgC,EAAE,UAAU,CAAC,SAAS,CAAC,2DAA2D,CAAC;QACnH,sBAAsB,EAAE,UAAU,CAAC,SAAS,CAAC,iDAAiD,CAAC;QAC/F,mCAAmC,EAAE,UAAU,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/esm/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/esm/components/trees/{stateless/common → common}/UseHierarchyFiltering.js

@@ -1,29 +1,28 @@
-import { jsx as _jsx, Fragment as _Fragment } from "react/jsx-runtime";
+import { jsx as _jsx, jsxs as _jsxs, Fragment as _Fragment } 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, useMemo, useState } from "react";
 import { useDebouncedAsyncValue } from "@itwin/components-react";
+import { CompressedId64Set } from "@itwin/core-bentley";
+import { ProgressRadial } from "@itwin/itwinui-react";
 import { DefaultContentDisplayTypes, KeySet } from "@itwin/presentation-common";
 import { PresentationInstanceFilter, PresentationInstanceFilterDialog } from "@itwin/presentation-components";
 import { Presentation } from "@itwin/presentation-frontend";
 import { GenericInstanceFilter, RowsLimitExceededError } from "@itwin/presentation-hierarchies";
-import { TreeWidget } from "../../../../TreeWidget";
+import { TreeWidget } from "../../../TreeWidget";
+import { Delayed } from "./components/Delayed";
 /** @internal */
-export function useHierarchyLevelFiltering({ imodel, defaultHierarchyLevelSizeLimit, getHierarchyLevelDetails }) {
+export function useHierarchyLevelFiltering({ imodel, defaultHierarchyLevelSizeLimit, reportUsage }) {
     const [filteringOptions, setFilteringOptions] = useState();
-    const onFilterClick = useCallback((nodeId) => {
-        const hierarchyDetails = getHierarchyLevelDetails(nodeId);
-        setFilteringOptions(hierarchyDetails ? { nodeId, hierarchyDetails } : undefined);
-    }, [getHierarchyLevelDetails]);
     const propertiesSource = useMemo(() => {
         if (!filteringOptions) {
             return undefined;
         }
         return async () => {
-            const inputKeys = await collectInstanceKeys(filteringOptions.hierarchyDetails.getInstanceKeysIterator());
-            if (inputKeys.length === 0) {
+            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.presentation.getContentDescriptor({
@@ -42,16 +41,16 @@ export function useHierarchyLevelFiltering({ imodel, defaultHierarchyLevelSizeLi
                     ],
                 },
                 displayType: DefaultContentDisplayTypes.PropertyPane,
-                keys: new KeySet(inputKeys),
+                keys: keySet,
             });
             if (!descriptor) {
                 throw new Error("Failed to create content descriptor");
             }
-            return { descriptor, inputKeys };
+            return { descriptor, inputKeys: keySet };
         };
     }, [filteringOptions, imodel]);
     const getInitialFilter = useMemo(() => {
-        const currentFilter = filteringOptions?.hierarchyDetails.instanceFilter;
+        const currentFilter = filteringOptions?.instanceFilter;
         if (!currentFilter) {
             return undefined;
         }
@@ -61,7 +60,8 @@ export function useHierarchyLevelFiltering({ imodel, defaultHierarchyLevelSizeLi
             if (!filteringOptions) {
                 return;
             }
-            filteringOptions.hierarchyDetails.setInstanceFilter(toGenericFilter(info));
+            reportUsage?.({ featureId: info ? "hierarchy-level-filtering" : undefined, reportInteraction: true });
+            filteringOptions.setInstanceFilter(toGenericFilter(info));
             setFilteringOptions(undefined);
         }, onClose: () => {
             setFilteringOptions(undefined);
@@ -69,41 +69,59 @@ export function useHierarchyLevelFiltering({ imodel, defaultHierarchyLevelSizeLi
             if (!filteringOptions) {
                 return null;
             }
-            return (_jsx(MatchingInstancesCount, { filter: filter, hierarchyLevelDetails: filteringOptions.hierarchyDetails, defaultHierarchyLevelSizeLimit: defaultHierarchyLevelSizeLimit }));
+            return (_jsx(MatchingInstancesCount, { filter: filter, hierarchyLevelDetails: filteringOptions, defaultHierarchyLevelSizeLimit: defaultHierarchyLevelSizeLimit }));
         } }));
     return {
-        onFilterClick,
+        onFilterClick: setFilteringOptions,
         filteringDialog,
     };
 }
 function MatchingInstancesCount({ filter, defaultHierarchyLevelSizeLimit, hierarchyLevelDetails }) {
-    const { value } = useDebouncedAsyncValue(useCallback(async () => {
+    const { value, inProgress } = useDebouncedAsyncValue(useCallback(async () => {
         const instanceFilter = toGenericFilter(filter);
         try {
-            const instanceKeys = await collectInstanceKeys(hierarchyLevelDetails.getInstanceKeysIterator({
+            const instanceCount = await countInstanceKeys(hierarchyLevelDetails.getInstanceKeysIterator({
                 instanceFilter,
                 hierarchyLevelSizeLimit: hierarchyLevelDetails.sizeLimit ?? defaultHierarchyLevelSizeLimit,
             }));
-            return TreeWidget.translate("stateless.matchingInstancesCount", { count: instanceKeys.length });
+            return TreeWidget.translate("filteringDialog.matchingInstancesCount", {
+                instanceCount: instanceCount.toLocaleString(undefined, { useGrouping: true }),
+            });
         }
         catch (e) {
             if (e instanceof RowsLimitExceededError) {
-                return TreeWidget.translate("stateless.filterExceedsLimit", { limit: e.limit });
+                return TreeWidget.translate("filteringDialog.filterExceedsLimit", { limit: e.limit.toLocaleString(undefined, { useGrouping: true }) });
             }
-            return TreeWidget.translate("stateless.failedToCalculateMatchingInstances");
+            return TreeWidget.translate("filteringDialog.failedToCalculateMatchingInstancesCount");
         }
     }, [filter, hierarchyLevelDetails, defaultHierarchyLevelSizeLimit]));
-    if (!value) {
-        return null;
+    if (inProgress) {
+        return (_jsxs(Delayed, { show: true, children: [TreeWidget.translate("filteringDialog.matchingInstancesCount", { instanceCount: "" }), _jsx(ProgressRadial, { size: "x-small" })] }));
+    }
+    return value ? _jsx(_Fragment, { children: value }) : null;
+}
+async function countInstanceKeys(iterator) {
+    let result = 0;
+    for await (const _ of iterator) {
+        result++;
     }
-    return _jsx(_Fragment, { children: value });
+    return result;
 }
 async function collectInstanceKeys(iterator) {
-    const inputKeys = [];
-    for await (const inputKey of iterator) {
-        inputKeys.push(inputKey);
+    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(), CompressedId64Set.sortAndCompress(ids)]);
     }
-    return inputKeys;
+    return KeySet.fromJSON({ instanceKeys, nodeKeys: [] });
 }
 function fromGenericFilter(descriptor, filter) {
     const presentationFilter = GenericInstanceFilter.isFilterRuleGroup(filter.rules) && filter.rules.rules.length === 0

package/lib/esm/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,OAAO,EAAE,WAAW,EAAE,OAAO,EAAE,QAAQ,EAAE,MAAM,OAAO,CAAC;AACvD,OAAO,EAAE,sBAAsB,EAAE,MAAM,yBAAyB,CAAC;AACjE,OAAO,EAAE,iBAAiB,EAAE,MAAM,qBAAqB,CAAC;AACxD,OAAO,EAAE,cAAc,EAAE,MAAM,sBAAsB,CAAC;AACtD,OAAO,EAAE,0BAA0B,EAAE,MAAM,EAAE,MAAM,4BAA4B,CAAC;AAChF,OAAO,EAAE,0BAA0B,EAAE,gCAAgC,EAAE,MAAM,gCAAgC,CAAC;AAC9G,OAAO,EAAE,YAAY,EAAE,MAAM,8BAA8B,CAAC;AAC5D,OAAO,EAAE,qBAAqB,EAAE,sBAAsB,EAAE,MAAM,iCAAiC,CAAC;AAChG,OAAO,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAC;AACjD,OAAO,EAAE,OAAO,EAAE,MAAM,sBAAsB,CAAC;AAgB/C,gBAAgB;AAChB,MAAM,UAAU,0BAA0B,CAAC,EAAE,MAAM,EAAE,8BAA8B,EAAE,WAAW,EAAmC;IACjI,MAAM,CAAC,gBAAgB,EAAE,mBAAmB,CAAC,GAAG,QAAQ,EAAyB,CAAC;IAElF,MAAM,gBAAgB,GAAG,OAAO,CAA0E,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,YAAY,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,0BAA0B,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,OAAO,CAAC,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,KAAC,gCAAgC,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,KAAC,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;AAQD,SAAS,sBAAsB,CAAC,EAAE,MAAM,EAAE,8BAA8B,EAAE,qBAAqB,EAA+B;IAC5H,MAAM,EAAE,KAAK,EAAE,UAAU,EAAE,GAAG,sBAAsB,CAClD,WAAW,CAAC,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,UAAU,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,sBAAsB,EAAE;gBACvC,OAAO,UAAU,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,UAAU,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,MAAC,OAAO,IAAC,IAAI,EAAE,IAAI,aAChB,UAAU,CAAC,SAAS,CAAC,wCAAwC,EAAE,EAAE,aAAa,EAAE,EAAE,EAAE,CAAC,EACtF,KAAC,cAAc,IAAC,IAAI,EAAC,SAAS,GAAG,IACzB,CACX,CAAC;KACH;IAED,OAAO,KAAK,CAAC,CAAC,CAAC,4BAAG,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,iBAAiB,CAAC,eAAe,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;KACtF;IACD,OAAO,MAAM,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,qBAAqB,CAAC,iBAAiB,CAAC,MAAM,CAAC,KAAK,CAAC,IAAI,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC,MAAM,KAAK,CAAC;QACtF,CAAC,CAAC,SAAS;QACX,CAAC,CAAC,0BAA0B,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,0BAA0B,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/esm/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/esm/components/trees/{stateless/common → common}/UseHierarchyVisibility.js

@@ -6,53 +6,69 @@ import { useEffect, useRef, useState } from "react";
 import { defer, distinct, mergeMap, Subject, takeUntil } from "rxjs";
 /** @internal */
 export function useHierarchyVisibility({ visibilityHandlerFactory }) {
-    const statusMap = useRef(new Map());
+    const nodesStateMap = useRef(new Map());
     const [state, setState] = useState({
-        getCheckboxStatus: (_node) => ({ state: "hidden", isDisabled: true }),
-        onCheckboxClicked: (_node, _checked) => { },
+        getCheckboxState: () => ({ state: "off", isDisabled: true }),
+        onCheckboxClicked: () => { },
+        triggerRefresh: () => { },
     });
     useEffect(() => {
-        statusMap.current.clear();
+        nodesStateMap.current.clear();
         const handler = visibilityHandlerFactory();
         const visibilityChanged = new Subject();
         const calculate = new 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(distinct(undefined, visibilityChanged), mergeMap((node) => defer(async () => ({ node, status: await handler.getVisibilityStatus(node.nodeData) })).pipe(takeUntil(visibilityChanged))))
             .subscribe({
             next: ({ node, status }) => {
-                statusMap.current.set(node.id, { node, status, needsRefresh: false });
-                setState((prev) => ({
-                    ...prev,
-                    getCheckboxStatus: createStatusGetter(statusMap, calculateNodeStatus),
-                }));
+                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 status = statusMap.current.get(node.id);
-            if (!status) {
+            const entry = nodesStateMap.current.get(node.id);
+            if (!entry) {
                 return;
             }
-            status.status.state = checked ? "visible" : "hidden";
-            status.status.tooltip = undefined;
-            setState((prev) => ({ ...prev, getCheckboxStatus: createStatusGetter(statusMap, calculateNodeStatus) }));
+            entry.state.state = checked ? "on" : "off";
+            entry.state.tooltip = undefined;
+            triggerCheckboxUpdate();
         };
         setState({
             onCheckboxClicked: changeVisibility,
-            getCheckboxStatus: createStatusGetter(statusMap, calculateNodeStatus),
+            getCheckboxState: createStateGetter(nodesStateMap, calculateNodeStatus),
+            triggerRefresh: () => {
+                resetCache();
+                triggerCheckboxUpdate();
+            },
         });
         const removeListener = handler.onVisibilityChange.addListener(() => {
-            statusMap.current.forEach((value) => {
-                value.needsRefresh = true;
-            });
-            visibilityChanged.next();
-            setState((prev) => ({
-                ...prev,
-                getCheckboxStatus: createStatusGetter(statusMap, calculateNodeStatus),
-            }));
+            resetCache();
+            triggerCheckboxUpdate();
         });
         return () => {
             subscription.unsubscribe();
@@ -62,17 +78,17 @@ export function useHierarchyVisibility({ visibilityHandlerFactory }) {
     }, [visibilityHandlerFactory]);
     return state;
 }
-function createStatusGetter(map, calculateVisibility) {
+function createStateGetter(map, calculateVisibility) {
     return (node) => {
-        const status = map.current.get(node.id);
-        if (status === undefined) {
+        const entry = map.current.get(node.id);
+        if (entry === undefined) {
             calculateVisibility(node);
-            return { state: "hidden", isDisabled: true };
+            return { state: "off", isDisabled: true };
         }
-        if (status.needsRefresh) {
+        if (entry.needsRefresh) {
             calculateVisibility(node);
         }
-        return status.status;
+        return entry.state;
     };
 }
 //# sourceMappingURL=UseHierarchyVisibility.js.map

package/lib/esm/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,OAAO,EAAE,SAAS,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,OAAO,CAAC;AACpD,OAAO,EAAE,KAAK,EAAE,QAAQ,EAAE,QAAQ,EAAE,OAAO,EAAE,SAAS,EAAE,MAAM,MAAM,CAAC;AAkCrE,gBAAgB;AAChB,MAAM,UAAU,sBAAsB,CAAC,EAAE,wBAAwB,EAA+B;IAC9F,MAAM,aAAa,GAAG,MAAM,CAAC,IAAI,GAAG,EAAoG,CAAC,CAAC;IAC1I,MAAM,CAAC,KAAK,EAAE,QAAQ,CAAC,GAAG,QAAQ,CAA+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,SAAS,CAAC,GAAG,EAAE;QACb,aAAa,CAAC,OAAO,CAAC,KAAK,EAAE,CAAC;QAC9B,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,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,QAAQ,CAAC,SAAS,EAAE,iBAAiB,CAAC,EACtC,QAAQ,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,KAAK,CAAC,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,SAAS,CAAC,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;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/esm/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/esm/components/trees/common/UseIModelChangeListener.js

@@ -0,0 +1,16 @@
+/*---------------------------------------------------------------------------------------------
+ * Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+ * See LICENSE.md in the project root for license terms and full copyright notice.
+ *--------------------------------------------------------------------------------------------*/
+import { useEffect } from "react";
+import { registerTxnListeners } from "@itwin/presentation-core-interop";
+/** @internal */
+export function useIModelChangeListener({ imodel, action }) {
+    useEffect(() => {
+        if (!imodel.isBriefcaseConnection()) {
+            return;
+        }
+        registerTxnListeners(imodel.txns, action);
+    }, [imodel, action]);
+}
+//# sourceMappingURL=UseIModelChangeListener.js.map