@itwin/tree-widget-react 4.0.0-alpha.2 → 4.0.0-alpha.20

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

@@ -0,0 +1 @@
+{"version":3,"file":"TreeWidgetViewport.js","sourceRoot":"","sources":["../../../../../../src/tree-widget-react/components/trees/common/TreeWidgetViewport.ts"],"names":[],"mappings":"AAAA;;;gGAGgG;AAEhG,OAAO,EAAE,0BAA0B,EAAE,MAAM,sBAAsB,CAAC;AAQlE;;;GAGG;AACH,MAAM,UAAU,wBAAwB,CAAC,QAAkB;IACzD,OAAO;QACL,IAAI,QAAQ;YACV,OAAO,QAAQ,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,QAAQ,CAAC,IAAI,CAAC,aAAa,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,OAAO,CAAC;QACtF,CAAC;QACD,IAAI,MAAM;YACR,OAAO,QAAQ,CAAC,MAAM,CAAC;QACzB,CAAC;QACD,UAAU,EAAE,CAAC,OAAO,EAAE,EAAE,CAAC,QAAQ,CAAC,IAAI,CAAC,UAAU,CAAC,OAAO,CAAC;QAC1D,kBAAkB,EAAE,CAAC,KAAK,EAAE,EAAE;YAC5B,IAAI,KAAK,CAAC,OAAO,EAAE,CAAC;gBAClB,KAAK,QAAQ,CAAC,eAAe,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC;gBAC9C,OAAO;YACT,CAAC;YACD,QAAQ,CAAC,kBAAkB,CAAC,KAAK,CAAC,QAAQ,EAAE,KAAK,CAAC,CAAC;QACrD,CAAC;QACD,aAAa,EAAE,CAAC,UAAU,EAAE,EAAE,CAAC,QAAQ,CAAC,IAAI,CAAC,aAAa,CAAC,UAAU,CAAC;QACtE,qBAAqB,EAAE,CAAC,KAAK,EAAE,EAAE,CAAC,QAAQ,CAAC,qBAAqB,CAAC,KAAK,CAAC,WAAW,EAAE,KAAK,CAAC,OAAO,EAAE,KAAK,CAAC,sBAAsB,CAAC;QAChI,gBAAgB,EAAE,CAAC,aAAa,EAAE,EAAE,CAAC,QAAQ,CAAC,oBAAoB,CAAC,aAAa,CAAC;QACjF,wBAAwB,EAAE,CAAC,KAAK,EAAE,EAAE,CAAC,QAAQ,CAAC,wBAAwB,CAAC,KAAK,CAAC,aAAa,EAAE,KAAK,CAAC,OAAO,CAAC;QAC1G,IAAI,yBAAyB;YAC3B,OAAO,QAAQ,CAAC,0BAA0B,CAAC;QAC7C,CAAC;QACD,2BAA2B,EAAE,CAAC,KAAK,EAAE,EAAE;YACrC,MAAM,QAAQ,GACZ,KAAK,CAAC,QAAQ,KAAK,MAAM;gBACvB,CAAC,CAAC,0BAA0B,CAAC,QAAQ,CAAC,IAAI;gBAC1C,CAAC,CAAC,KAAK,CAAC,QAAQ,KAAK,MAAM;oBACzB,CAAC,CAAC,0BAA0B,CAAC,QAAQ,CAAC,IAAI;oBAC1C,CAAC,CAAC,0BAA0B,CAAC,QAAQ,CAAC,IAAI,CAAC;YACjD,QAAQ,CAAC,0BAA0B,CAAC,WAAW,CAAC,KAAK,CAAC,QAAQ,EAAE,KAAK,CAAC,WAAW,EAAE,QAAQ,CAAC,CAAC;QAC/F,CAAC;QACD,2BAA2B,EAAE,CAAC,KAAK,EAAE,EAAE;YACrC,MAAM,QAAQ,GAAG,QAAQ,CAAC,0BAA0B,CAAC,WAAW,CAAC,KAAK,CAAC,OAAO,EAAE,KAAK,CAAC,UAAU,CAAC,CAAC;YAClG,OAAO,QAAQ,KAAK,0BAA0B,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,QAAQ,KAAK,0BAA0B,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,MAAM,CAAC;QAClJ,CAAC;QACD,8BAA8B,EAAE,CAAC,KAAK,EAAE,EAAE,CAAC,QAAQ,CAAC,0BAA0B,CAAC,cAAc,CAAC,KAAK,EAAE,QAAQ,CAAC;QAC9G,IAAI,UAAU;YACZ,OAAO,QAAQ,CAAC,UAAU,CAAC;QAC7B,CAAC;QACD,aAAa,EAAE,CAAC,KAAK,EAAE,EAAE,CAAC,QAAQ,CAAC,aAAa,CAAC,KAAK,CAAC,UAAU,CAAC;QAClE,eAAe,EAAE,GAAG,EAAE,CAAC,QAAQ,CAAC,eAAe,EAAE;QACjD,IAAI,WAAW;YACb,OAAO,QAAQ,CAAC,WAAW,CAAC;QAC9B,CAAC;QACD,cAAc,EAAE,CAAC,KAAK,EAAE,EAAE,CAAC,QAAQ,CAAC,cAAc,CAAC,KAAK,CAAC,UAAU,EAAE,KAAK,CAAC,SAAS,CAAC;QACrF,gBAAgB,EAAE,GAAG,EAAE,CAAC,QAAQ,CAAC,gBAAgB,EAAE;QACnD,IAAI,sBAAsB;YACxB,OAAO,QAAQ,CAAC,sBAAsB,CAAC;QACzC,CAAC;QACD,IAAI,oBAAoB;YACtB,OAAO,QAAQ,CAAC,oBAAoB,CAAC;QACvC,CAAC;QACD,IAAI,mBAAmB;YACrB,OAAO,QAAQ,CAAC,mBAAmB,CAAC;QACtC,CAAC;QACD,IAAI,qBAAqB;YACvB,OAAO,QAAQ,CAAC,IAAI,CAAC,qBAAqB,CAAC;QAC7C,CAAC;QACD,IAAI,wBAAwB;YAC1B,OAAO,QAAQ,CAAC,qBAAqB,CAAC;QACxC,CAAC;QACD,IAAI,4BAA4B;YAC9B,OAAO,QAAQ,CAAC,yBAAyB,CAAC;QAC5C,CAAC;QACD,IAAI,oCAAoC;YACtC,OAAO,QAAQ,CAAC,iCAAiC,CAAC;QACpD,CAAC;KACF,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 { PerModelCategoryVisibility } from \"@itwin/core-frontend\";\n\nimport type { BeEvent, Id64Arg, Id64String } from \"@itwin/core-bentley\";\nimport type { IModelConnection, Viewport } from \"@itwin/core-frontend\";\n\n/** @public */\nexport type PerModelCategoryOverride = \"show\" | \"hide\" | \"none\";\n\n/**\n * Creates a `TreeWidgetViewport`.\n * @beta\n */\nexport function createTreeWidgetViewport(viewport: Viewport): TreeWidgetViewport {\n  return {\n    get viewType() {\n      return viewport.view.is2d() ? \"2d\" : viewport.view.isSpatialView() ? \"3d\" : \"other\";\n    },\n    get iModel() {\n      return viewport.iModel;\n    },\n    viewsModel: (modelId) => viewport.view.viewsModel(modelId),\n    changeModelDisplay: (props) => {\n      if (props.display) {\n        void viewport.addViewedModels(props.modelIds);\n        return;\n      }\n      viewport.changeModelDisplay(props.modelIds, false);\n    },\n    viewsCategory: (categoryId) => viewport.view.viewsCategory(categoryId),\n    changeCategoryDisplay: (props) => viewport.changeCategoryDisplay(props.categoryIds, props.display, props.enableAllSubCategories),\n    viewsSubCategory: (subCategoryId) => viewport.isSubCategoryVisible(subCategoryId),\n    changeSubCategoryDisplay: (props) => viewport.changeSubCategoryDisplay(props.subCategoryId, props.display),\n    get perModelCategoryOverrides() {\n      return viewport.perModelCategoryVisibility;\n    },\n    setPerModelCategoryOverride: (props) => {\n      const override =\n        props.override === \"show\"\n          ? PerModelCategoryVisibility.Override.Show\n          : props.override === \"hide\"\n            ? PerModelCategoryVisibility.Override.Hide\n            : PerModelCategoryVisibility.Override.None;\n      viewport.perModelCategoryVisibility.setOverride(props.modelIds, props.categoryIds, override);\n    },\n    getPerModelCategoryOverride: (props) => {\n      const override = viewport.perModelCategoryVisibility.getOverride(props.modelId, props.categoryId);\n      return override === PerModelCategoryVisibility.Override.Show ? \"show\" : override === PerModelCategoryVisibility.Override.Hide ? \"hide\" : \"none\";\n    },\n    clearPerModelCategoryOverrides: (props) => viewport.perModelCategoryVisibility.clearOverrides(props?.modelIds),\n    get neverDrawn() {\n      return viewport.neverDrawn;\n    },\n    setNeverDrawn: (props) => viewport.setNeverDrawn(props.elementIds),\n    clearNeverDrawn: () => viewport.clearNeverDrawn(),\n    get alwaysDrawn() {\n      return viewport.alwaysDrawn;\n    },\n    setAlwaysDrawn: (props) => viewport.setAlwaysDrawn(props.elementIds, props.exclusive),\n    clearAlwaysDrawn: () => viewport.clearAlwaysDrawn(),\n    get isAlwaysDrawnExclusive() {\n      return viewport.isAlwaysDrawnExclusive;\n    },\n    get onAlwaysDrawnChanged() {\n      return viewport.onAlwaysDrawnChanged;\n    },\n    get onNeverDrawnChanged() {\n      return viewport.onNeverDrawnChanged;\n    },\n    get onDisplayStyleChanged() {\n      return viewport.view.onDisplayStyleChanged;\n    },\n    get onDisplayedModelsChanged() {\n      return viewport.onViewedModelsChanged;\n    },\n    get onDisplayedCategoriesChanged() {\n      return viewport.onViewedCategoriesChanged;\n    },\n    get onPerModelCategoriesOverridesChanged() {\n      return viewport.onViewedCategoriesPerModelChanged;\n    },\n  };\n}\n\n/**\n * A simplified interface for a Viewport that is used by the Tree Widget to control and determine visibility.\n *\n * Viewport should only display elements. Since elements have model, category and sub-category assigned to them, each of these can affect element visibility.\n *\n * The order of precedence for visibility is:\n * 1. Model visibility - if model is not visible, elements from that model should never be displayed.\n * 2. `neverDrawn` set - elements in that set should never be displayed.\n * 3. `alwaysDrawn` set - elements in that set should always be displayed.\n * 4. Per-model category visibility overrides:\n * -  if a per-model-category has `Hide` override, elements which have that category and model should not be displayed.\n * -  if a per-model-category has `Show` override, elements which have that category and model should be displayed.\n * 5. Category and sub-category visibility - if element's category or sub-category is turned off, it should not be displayed.\n *\n * Based on this order of precedence, element can only be displayed in these scenarios:\n * - Model is visible *AND* element is in `alwaysDrawn` set.\n * - Model is visible *AND* element is not in `neverDrawn` set *AND* per-model category override is set to show `Show`.\n * - Model is visible *AND* element is not in `neverDrawn` set *AND* per-model category override is not set to `Hide` *AND* category and sub-category are visible.\n * @public\n */\nexport interface TreeWidgetViewport {\n  /**\n   * The type of the view. Generally it should be either `3d` or `2d`.\n   *\n   * The `other` value is reserved for edge cases when viewport doesn't show any elements, e.g. a blank viewport.\n   */\n  viewType: \"2d\" | \"3d\" | \"other\";\n  /** The iModel of this Viewport. */\n  iModel: IModelConnection;\n  /**\n   * Should return true if model specified by `modelId` is visible in the viewport.\n   *\n   * Model display should not take into account its' child elements display.\n   *\n   * When model is not displayed, all elements that have that model should not be shown in the viewport.\n   */\n  viewsModel: (modelId: Id64String) => boolean;\n  /**\n   * Should add or remove a set of models from those models currently displayed in this viewport.\n   *\n   * **NOTE** When turning model display to:\n   * - `true`, model display should be turned on. This does not mean that any elements should be turned on, it only means that\n   * model visibility should not interfere with elements visibility.\n   * - `false`, model display should be turned off. All elements which have that model should not be displayed in the viewport.\n   */\n  changeModelDisplay: (props: { modelIds: Id64Arg; display: boolean }) => void;\n  /**\n   * Should return true if category specified by `categoryId` is visible in the viewport.\n   *\n   * Category display should not take into account its' child elements or sub-categories display.\n   *\n   * When category is not displayed, all elements and sub-categories which have that category should not be shown in the viewport.\n   *\n   * **NOTE** Elements might still be visible if per-model category `Show` override or `alwaysDrawn` set makes them visible.\n   */\n  viewsCategory: (categoryId: Id64String) => boolean;\n  /**\n   * Should enable or disable display of elements belonging to a set of categories specified by Id.\n   *\n   * Visibility of individual sub-categories belonging to a category can be controlled separately through the use of `changeSubCategoryDisplay`.\n   *\n   * By default, enabling display of a category does not affect display of sub-categories thereof which have been set to be invisible.\n   *\n   * Changing category visibility should not change per-model category overrides.\n   *\n   * **NOTE** When turning category display to:\n   * - `true`, category display should be turned on. All elements which have specified category should be turned on if model is visible,\n   * category does not have per-model `hide` override and element is not in the `neverDrawn` set.\n   * - `false`, category and its' sub-categories display should be turned off. All elements which have that category should not be displayed in the viewport,\n   * unless element has per-model category `Show` override, or is in the `alwaysDrawn` set.\n   */\n  changeCategoryDisplay: (props: { categoryIds: Id64Arg; display: boolean; enableAllSubCategories?: boolean }) => void;\n  /**\n   * Should return true if sub-category specified by `subCategoryId` is visible in the viewport.\n   *\n   * Sub-category display should not take into account its' child elements.\n   *\n   * When sub-category is not displayed, all elements that have that sub-category should not be shown in the viewport, unless they have per-model category `Show` override or are in the `alwaysDrawn` list.\n   */\n  viewsSubCategory: (subCategoryId: Id64String) => boolean;\n  /**\n   * Should enable or disable display of elements belonging to sub-category specified by Id.\n   *\n   * Changing sub-category display should not change category display.\n   *\n   * **NOTE** When turning sub-category display to:\n   * - `true`, sub-category display should be turned on. All elements which have specified sub-category should be turned on if model and category are visible,\n   * category does not have per-model `hide` override and element is not in the `neverDrawn` set.\n   * - `false`, sub-category display should be turned off. All elements that have that sub-category should not be displayed in the viewport,\n   * unless element has per-model category `Show` override, or is in the `alwaysDrawn` set.\n   */\n  changeSubCategoryDisplay: (props: { subCategoryId: Id64String; display: boolean }) => void;\n  /** Returns an iterable of per-model-category overrides. */\n  perModelCategoryOverrides: Readonly<Iterable<{ modelId: Id64String; categoryId: Id64String; visible: boolean }>>;\n  /** Should change the override state of one or more categories for one or more models. */\n  setPerModelCategoryOverride: (props: { modelIds: Id64Arg; categoryIds: Id64Arg; override: PerModelCategoryOverride }) => void;\n  /** Should return the per-model category override. */\n  getPerModelCategoryOverride: (props: { modelId: Id64String; categoryId: Id64String }) => PerModelCategoryOverride;\n  /** Should remove per-model category override for the specified models. */\n  clearPerModelCategoryOverrides: (props?: { modelIds?: Id64Arg }) => void;\n  /**\n   * Ids of elements which should not be displayed.\n   *\n   * This set takes precedence over category and sub-category display, per-model category overrides, and the `alwaysDrawn` set.\n   */\n  neverDrawn: ReadonlySet<Id64String> | undefined;\n  /** Ids of elements which should not be displayed in the viewport, regardless of category and sub-category visibility. */\n  setNeverDrawn: (props: { elementIds: Set<Id64String> }) => void;\n  /** Should clear the set of never-drawn elements. */\n  clearNeverDrawn: () => void;\n  /**\n   * Ids of elements which should be displayed.\n   *\n   * Elements in this set should be displayed only when model is displayed as well.\n   *\n   * This set takes precedence over category and sub-category display and per-model category override.\n   */\n  alwaysDrawn: ReadonlySet<Id64String> | undefined;\n  /**\n   * Ids of elements which should be displayed in the viewport, regardless of category and sub-category visibility.\n   *\n   * These elements should be displayed only when their models are displayed as well.\n   *\n   * When the `exclusive` prop is set to `true`, only the specified elements should be drawn.\n   */\n  setAlwaysDrawn: (props: { elementIds: Set<Id64String>; exclusive?: boolean }) => void;\n  /** Should clear the set of always-drawn elements. */\n  clearAlwaysDrawn: () => void;\n  /**\n   * Should return true if elements in the [[alwaysDrawn]] set are the *only* elements that are displayed when their models are visible.\n   *\n   * Should be set to true when `setAlwaysDrawn` is called with `exclusive` flag. Should be set to false\n   * when `setAlwaysDrawn` is called with `exclusive` set to `false` or `undefined`, or when `clearAlwaysDrawn` is called.\n   */\n  readonly isAlwaysDrawnExclusive: boolean;\n  /** Event that should be raised when set of always-drawn elements changes. */\n  onAlwaysDrawnChanged: BeEvent<() => void>;\n  /** Event that should be raised when set of never-drawn elements changes. */\n  onNeverDrawnChanged: BeEvent<() => void>;\n  /** Event that should be raised when per-model category overrides changes. */\n  onPerModelCategoriesOverridesChanged: BeEvent<() => void>;\n  /** Event that should be raised when category display changes. */\n  onDisplayedCategoriesChanged: BeEvent<() => void>;\n  /** Event that should be raised when model display changes. */\n  onDisplayedModelsChanged: BeEvent<() => void>;\n  /** Event that should be raised when view changes between `2d`, `3d` or `other`. */\n  onDisplayStyleChanged: BeEvent<() => void>;\n}\n"]}

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

@@ -1,7 +1,7 @@
 import type { Observable } from "rxjs";
-import type { BeEvent, IDisposable } from "@itwin/core-bentley";
+import type { BeEvent } from "@itwin/core-bentley";
 import type { HierarchyNode } from "@itwin/presentation-hierarchies-react";
-import type { TreeItemVisibilityButtonProps } from "./components/TreeNodeVisibilityButton.js";
+import type { VisibilityContext } from "./components/TreeNodeVisibilityButton.js";
 /**
  * Data structure that describes instance visibility status.
  * @beta
@@ -11,14 +11,12 @@ 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.
  * @beta
  */
-export interface HierarchyVisibilityHandler extends IDisposable {
+export interface HierarchyVisibilityHandler extends Disposable {
     /** Event used to notify tree about visibility changes from outside. */
     readonly onVisibilityChange: BeEvent<() => void>;
     /** Returns current visibility status for tree node. */
@@ -29,7 +27,8 @@ export interface HierarchyVisibilityHandler extends IDisposable {
 interface UseHierarchyVisibilityProps {
     visibilityHandlerFactory: () => HierarchyVisibilityHandler;
 }
-export declare function useHierarchyVisibility({ visibilityHandlerFactory, }: UseHierarchyVisibilityProps): TreeItemVisibilityButtonProps & {
+/** @internal */
+export declare function useHierarchyVisibility({ visibilityHandlerFactory }: UseHierarchyVisibilityProps): VisibilityContext & {
     triggerRefresh: () => void;
 };
 /**
@@ -50,6 +49,15 @@ export type HierarchyVisibilityHandlerOverridableMethodProps<TFunc> = TFunc exte
  * @beta
  */
 export type HierarchyVisibilityHandlerOverridableMethod<TFunc> = TFunc extends (...args: any[]) => infer TResult ? (props: HierarchyVisibilityHandlerOverridableMethodProps<TFunc>) => TResult : never;
-export declare function createVisibilityHandlerResult<TResult, TOverrideProps>(handler: HierarchyVisibilityHandler, props: TOverrideProps, obs: Observable<TResult>, override: HierarchyVisibilityHandlerOverridableMethod<(props: TOverrideProps) => Promise<TResult>> | undefined): Observable<TResult>;
+/** @internal */
+export declare class HierarchyVisibilityOverrideHandler {
+    #private;
+    constructor(baseHandler: HierarchyVisibilityHandler);
+    createVisibilityHandlerResult<TResult, TOverrideProps>(props: {
+        nonOverriddenResult: Observable<TResult>;
+        override: HierarchyVisibilityHandlerOverridableMethod<(props: TOverrideProps) => Promise<TResult>> | undefined;
+        overrideProps: TOverrideProps;
+    }): 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";
-export function useHierarchyVisibility({ visibilityHandlerFactory, }) {
+/** @internal */
+export function useHierarchyVisibility({ visibilityHandlerFactory }) {
     const visibilityStatusMap = useRef(new Map());
     const [state, setState] = useState({
-        getVisibilityButtonState: () => ({ state: "hidden", isDisabled: true }),
+        getVisibilityButtonState: () => ({ isLoading: 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,
                 });
             },
@@ -57,8 +62,11 @@ export function useHierarchyVisibility({ visibilityHandlerFactory, }) {
             if (!entry) {
                 return;
             }
-            entry.status.state = visibilityState;
-            entry.status.tooltip = undefined;
+            entry.status = {
+                ...entry.status,
+                state: visibilityState,
+                tooltip: createTooltip("determining"),
+            };
             triggerCheckboxUpdate();
         };
         setState({
@@ -76,7 +84,7 @@ export function useHierarchyVisibility({ visibilityHandlerFactory, }) {
         return () => {
             subscription.unsubscribe();
             removeListener();
-            handler.dispose();
+            handler[Symbol.dispose]();
         };
     }, [visibilityHandlerFactory, onFeatureUsed]);
     return state;
@@ -86,26 +94,29 @@ function createStateGetter(map, calculateVisibility) {
         const entry = map.current.get(node.id);
         if (entry === undefined) {
             calculateVisibility(node);
-            return { state: "hidden", isDisabled: true };
+            return { isLoading: true };
         }
         if (entry.needsRefresh) {
             calculateVisibility(node);
         }
-        const status = entry.status;
-        return {
-            state: status.state,
-            tooltip: status.tooltip,
-            isDisabled: status.isDisabled,
-        };
+        return entry.status;
     };
 }
-export function createVisibilityHandlerResult(handler, props, obs, override) {
-    return override
-        ? from(override({
-            ...props,
-            originalImplementation: async () => lastValueFrom(obs, { defaultValue: undefined }),
-            handler,
-        }))
-        : obs;
+/** @internal */
+export class HierarchyVisibilityOverrideHandler {
+    #baseHandler;
+    constructor(baseHandler) {
+        this.#baseHandler = baseHandler;
+    }
+    createVisibilityHandlerResult(props) {
+        const { nonOverriddenResult, override, overrideProps } = props;
+        return override
+            ? from(override({
+                ...overrideProps,
+                originalImplementation: async () => lastValueFrom(nonOverriddenResult, { defaultValue: undefined }),
+                handler: this.#baseHandler,
+            }))
+            : nonOverriddenResult;
+    }
 }
 //# sourceMappingURL=UseHierarchyVisibility.js.map

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,EAAE,wBAAwB,EAA+B;IAC9F,MAAM,mBAAmB,GAAG,MAAM,CAAC,IAAI,GAAG,EAA6G,CAAC,CAAC;IACzJ,MAAM,CAAC,KAAK,EAAE,QAAQ,CAAC,GAAG,QAAQ,CAAqD;QACrF,wBAAwB,EAAE,GAAG,EAAE,CAAC,CAAC,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC;QACrD,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,GAAiD,CAAC,IAAI,EAAE,eAAe,EAAE,EAAE;YAC/F,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,CAAC;gBACX,OAAO;YACT,CAAC;YACD,KAAK,CAAC,MAAM,GAAG;gBACb,GAAG,KAAK,CAAC,MAAM;gBACf,KAAK,EAAE,eAAe;gBACtB,OAAO,EAAE,aAAa,CAAC,aAAa,CAAC;aACtC,CAAC;YACF,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,MAAM,CAAC,OAAO,CAAC,EAAE,CAAC;QAC5B,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,CAAC;YACxB,mBAAmB,CAAC,IAAI,CAAC,CAAC;YAC1B,OAAO,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC;QAC7B,CAAC;QAED,IAAI,KAAK,CAAC,YAAY,EAAE,CAAC;YACvB,mBAAmB,CAAC,IAAI,CAAC,CAAC;QAC5B,CAAC;QAED,OAAO,KAAK,CAAC,MAAM,CAAC;IACtB,CAAC,CAAC;AACJ,CAAC;AA0BD,gBAAgB;AAChB,MAAM,OAAO,kCAAkC;IAC7C,YAAY,CAA6B;IACzC,YAAY,WAAuC;QACjD,IAAI,CAAC,YAAY,GAAG,WAAW,CAAC;IAClC,CAAC;IACM,6BAA6B,CAA0B,KAI7D;QACC,MAAM,EAAE,mBAAmB,EAAE,QAAQ,EAAE,aAAa,EAAE,GAAG,KAAK,CAAC;QAC/D,OAAO,QAAQ;YACb,CAAC,CAAC,IAAI,CACF,QAAQ,CAAC;gBACP,GAAG,aAAa;gBAChB,sBAAsB,EAAE,KAAK,IAAI,EAAE,CAAC,aAAa,CAAC,mBAAmB,EAAE,EAAE,YAAY,EAAE,SAAoB,EAAE,CAAC;gBAC9G,OAAO,EAAE,IAAI,CAAC,YAAY;aAC3B,CAAC,CACH;YACH,CAAC,CAAC,mBAAmB,CAAC;IAC1B,CAAC;CACF","sourcesContent":["/*---------------------------------------------------------------------------------------------\n * Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n * See LICENSE.md in the project root for license terms and full copyright notice.\n *--------------------------------------------------------------------------------------------*/\n\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 { MutableRefObject } from \"react\";\nimport type { Observable } from \"rxjs\";\nimport type { BeEvent } from \"@itwin/core-bentley\";\nimport type { HierarchyNode, PresentationHierarchyNode } from \"@itwin/presentation-hierarchies-react\";\nimport type { TreeItemVisibilityButtonState, VisibilityContext } 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 Disposable {\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({ visibilityHandlerFactory }: UseHierarchyVisibilityProps): VisibilityContext & { triggerRefresh: () => void } {\n  const visibilityStatusMap = useRef(new Map<string, { node: PresentationHierarchyNode; status: TreeItemVisibilityButtonState; needsRefresh: boolean }>());\n  const [state, setState] = useState<VisibilityContext & { triggerRefresh: () => void }>({\n    getVisibilityButtonState: () => ({ isLoading: 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: VisibilityContext[\"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 = {\n        ...entry.status,\n        state: visibilityState,\n        tooltip: createTooltip(\"determining\"),\n      };\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[Symbol.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): VisibilityContext[\"getVisibilityButtonState\"] {\n  return (node) => {\n    const entry = map.current.get(node.id);\n    if (entry === undefined) {\n      calculateVisibility(node);\n      return { isLoading: true };\n    }\n\n    if (entry.needsRefresh) {\n      calculateVisibility(node);\n    }\n\n    return entry.status;\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 class HierarchyVisibilityOverrideHandler {\n  #baseHandler: HierarchyVisibilityHandler;\n  constructor(baseHandler: HierarchyVisibilityHandler) {\n    this.#baseHandler = baseHandler;\n  }\n  public createVisibilityHandlerResult<TResult, TOverrideProps>(props: {\n    nonOverriddenResult: Observable<TResult>;\n    override: HierarchyVisibilityHandlerOverridableMethod<(props: TOverrideProps) => Promise<TResult>> | undefined;\n    overrideProps: TOverrideProps;\n  }): Observable<TResult> {\n    const { nonOverriddenResult, override, overrideProps } = props;\n    return override\n      ? from(\n          override({\n            ...overrideProps,\n            originalImplementation: async () => lastValueFrom(nonOverriddenResult, { defaultValue: undefined as TResult }),\n            handler: this.#baseHandler,\n          }),\n        )\n      : nonOverriddenResult;\n  }\n}\n"]}

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

@@ -18,6 +18,7 @@ export interface TelemetryContextProviderProps {
 }
 /** @beta */
 export declare function TelemetryContextProvider({ children, onPerformanceMeasured, onFeatureUsed, componentIdentifier, }: PropsWithChildren<TelemetryContextProviderProps>): import("react/jsx-runtime").JSX.Element;
+/** @internal */
 export declare function useTelemetryContext(): TelemetryContext;
 interface UseReportingActionProps<TAction> {
     action: TAction;

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

@@ -4,7 +4,7 @@ import { jsx as _jsx } from "react/jsx-runtime";
  * See LICENSE.md in the project root for license terms and full copyright notice.
  *--------------------------------------------------------------------------------------------*/
 import { createContext, useCallback, useContext, useMemo } from "react";
-import { useLatest } from "./Utils.js";
+import { useLatest } from "./internal/Utils.js";
 const telemetryContext = createContext(undefined);
 /** @beta */
 export function TelemetryContextProvider({ children, onPerformanceMeasured, onFeatureUsed, componentIdentifier, }) {
@@ -29,6 +29,7 @@ const defaultContextValue = {
     onPerformanceMeasured: () => { },
     onFeatureUsed: () => { },
 };
+/** @internal */
 export function useTelemetryContext() {
     return useContext(telemetryContext) ?? defaultContextValue;
 }

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

@@ -1 +1 @@
-{"version":3,"file":"UseTelemetryContext.js","sourceRoot":"","sources":["../../../../../../src/tree-widget-react/components/trees/common/UseTelemetryContext.tsx"],"names":[],"mappings":";AAAA;;;gGAGgG;AAEhG,OAAO,EAAE,aAAa,EAAE,WAAW,EAAE,UAAU,EAAE,OAAO,EAAE,MAAM,OAAO,CAAC;AACxE,OAAO,EAAE,SAAS,EAAE,MAAM,YAAY,CAAC;AAkBvC,MAAM,gBAAgB,GAAG,aAAa,CAA+B,SAAS,CAAC,CAAC;AAYhF,YAAY;AACZ,MAAM,UAAU,wBAAwB,CAAC,EACvC,QAAQ,EACR,qBAAqB,EACrB,aAAa,EACb,mBAAmB,GAC8B;IACjD,MAAM,wBAAwB,GAAG,SAAS,CAAC,qBAAqB,CAAC,CAAC;IAClE,MAAM,gBAAgB,GAAG,SAAS,CAAC,aAAa,CAAC,CAAC;IAElD,MAAM,YAAY,GAAG,OAAO,CAAmB,GAAG,EAAE;QAClD,OAAO;YACL,qBAAqB,EAAE,CAAC,SAAS,EAAE,QAAQ,EAAE,EAAE,CAAC,wBAAwB,CAAC,OAAO,EAAE,CAAC,GAAG,mBAAmB,IAAI,SAAS,EAAE,EAAE,QAAQ,CAAC;YACnI,aAAa,EAAE,CAAC,EAAE,SAAS,EAAE,iBAAiB,EAAE,EAAE,EAAE;gBAClD,IAAI,iBAAiB,KAAK,KAAK,EAAE;oBAC/B,gBAAgB,CAAC,OAAO,EAAE,CAAC,OAAO,mBAAmB,EAAE,CAAC,CAAC;iBAC1D;gBACD,IAAI,SAAS,EAAE;oBACb,gBAAgB,CAAC,OAAO,EAAE,CAAC,GAAG,mBAAmB,IAAI,SAAS,EAAE,CAAC,CAAC;iBACnE;YACH,CAAC;SACF,CAAC;IACJ,CAAC,EAAE,CAAC,mBAAmB,EAAE,wBAAwB,EAAE,gBAAgB,CAAC,CAAC,CAAC;IAEtE,OAAO,KAAC,gBAAgB,CAAC,QAAQ,IAAC,KAAK,EAAE,YAAY,YAAG,QAAQ,GAA6B,CAAC;AAChG,CAAC;AAED,MAAM,mBAAmB,GAAqB;IAC5C,qBAAqB,EAAE,GAAG,EAAE,GAAE,CAAC;IAC/B,aAAa,EAAE,GAAG,EAAE,GAAE,CAAC;CACxB,CAAC;AAEF,MAAM,UAAU,mBAAmB;IACjC,OAAO,UAAU,CAAC,gBAAgB,CAAC,IAAI,mBAAmB,CAAC;AAC7D,CAAC;AAOD,gBAAgB;AAChB,MAAM,UAAU,kBAAkB,CAA2C,EAAE,MAAM,EAAE,SAAS,EAAoC;IAClI,MAAM,EAAE,aAAa,EAAE,GAAG,mBAAmB,EAAE,CAAC;IAChD,OAAO,WAAW,CAChB,CAAC,GAAG,IAAI,EAAE,EAAE;QACV,aAAa,CAAC,EAAE,SAAS,EAAE,iBAAiB,EAAE,IAAI,EAAE,CAAC,CAAC;QACtD,MAAM,CAAC,GAAG,IAAI,CAAC,CAAC;IAClB,CAAC,EACD,CAAC,MAAM,EAAE,SAAS,EAAE,aAAa,CAAC,CACnC,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 { createContext, useCallback, useContext, useMemo } from \"react\";\nimport { useLatest } from \"./Utils.js\";\n\nimport type { PropsWithChildren } from \"react\";\n\ntype TrackedFeatures =\n  | \"visibility-change\"\n  | \"hierarchy-level-filtering\"\n  | \"filtering\"\n  | \"hierarchy-level-size-limit-hit\"\n  | \"zoom-to-node\"\n  | \"error-timeout\"\n  | \"error-unknown\";\n\ninterface TelemetryContext {\n  onPerformanceMeasured: (featureId: string, duration: number) => void;\n  onFeatureUsed: (props: { featureId?: TrackedFeatures; reportInteraction: boolean }) => void;\n}\n\nconst telemetryContext = createContext<TelemetryContext | undefined>(undefined);\n\n/** @beta */\nexport interface TelemetryContextProviderProps {\n  /** Callback that is invoked when performance of tracked feature is measured. */\n  onPerformanceMeasured?: (featureId: string, duration: number) => void;\n  /** Callback that is invoked when a tracked feature is used. */\n  onFeatureUsed?: (featureId: string) => void;\n  /** Unique identifier that is appended to feature id to help track which component used that feature. */\n  componentIdentifier: string;\n}\n\n/** @beta */\nexport function TelemetryContextProvider({\n  children,\n  onPerformanceMeasured,\n  onFeatureUsed,\n  componentIdentifier,\n}: PropsWithChildren<TelemetryContextProviderProps>) {\n  const onPerformanceMeasuredRef = useLatest(onPerformanceMeasured);\n  const onFeatureUsedRef = useLatest(onFeatureUsed);\n\n  const contextValue = useMemo<TelemetryContext>(() => {\n    return {\n      onPerformanceMeasured: (featureId, duration) => onPerformanceMeasuredRef.current?.(`${componentIdentifier}-${featureId}`, duration),\n      onFeatureUsed: ({ featureId, reportInteraction }) => {\n        if (reportInteraction !== false) {\n          onFeatureUsedRef.current?.(`use-${componentIdentifier}`);\n        }\n        if (featureId) {\n          onFeatureUsedRef.current?.(`${componentIdentifier}-${featureId}`);\n        }\n      },\n    };\n  }, [componentIdentifier, onPerformanceMeasuredRef, onFeatureUsedRef]);\n\n  return <telemetryContext.Provider value={contextValue}>{children}</telemetryContext.Provider>;\n}\n\nconst defaultContextValue: TelemetryContext = {\n  onPerformanceMeasured: () => {},\n  onFeatureUsed: () => {},\n};\n\nexport function useTelemetryContext() {\n  return useContext(telemetryContext) ?? defaultContextValue;\n}\n\ninterface UseReportingActionProps<TAction> {\n  action: TAction;\n  featureId?: TrackedFeatures;\n}\n\n/** @internal */\nexport function useReportingAction<TAction extends (...args: any[]) => void>({ action, featureId }: UseReportingActionProps<TAction>) {\n  const { onFeatureUsed } = useTelemetryContext();\n  return useCallback<(...args: Parameters<TAction>) => void>(\n    (...args) => {\n      onFeatureUsed({ featureId, reportInteraction: true });\n      action(...args);\n    },\n    [action, featureId, onFeatureUsed],\n  );\n}\n"]}
+{"version":3,"file":"UseTelemetryContext.js","sourceRoot":"","sources":["../../../../../../src/tree-widget-react/components/trees/common/UseTelemetryContext.tsx"],"names":[],"mappings":";AAAA;;;gGAGgG;AAEhG,OAAO,EAAE,aAAa,EAAE,WAAW,EAAE,UAAU,EAAE,OAAO,EAAE,MAAM,OAAO,CAAC;AACxE,OAAO,EAAE,SAAS,EAAE,MAAM,qBAAqB,CAAC;AAkBhD,MAAM,gBAAgB,GAAG,aAAa,CAA+B,SAAS,CAAC,CAAC;AAYhF,YAAY;AACZ,MAAM,UAAU,wBAAwB,CAAC,EACvC,QAAQ,EACR,qBAAqB,EACrB,aAAa,EACb,mBAAmB,GAC8B;IACjD,MAAM,wBAAwB,GAAG,SAAS,CAAC,qBAAqB,CAAC,CAAC;IAClE,MAAM,gBAAgB,GAAG,SAAS,CAAC,aAAa,CAAC,CAAC;IAElD,MAAM,YAAY,GAAG,OAAO,CAAmB,GAAG,EAAE;QAClD,OAAO;YACL,qBAAqB,EAAE,CAAC,SAAS,EAAE,QAAQ,EAAE,EAAE,CAAC,wBAAwB,CAAC,OAAO,EAAE,CAAC,GAAG,mBAAmB,IAAI,SAAS,EAAE,EAAE,QAAQ,CAAC;YACnI,aAAa,EAAE,CAAC,EAAE,SAAS,EAAE,iBAAiB,EAAE,EAAE,EAAE;gBAClD,IAAI,iBAAiB,KAAK,KAAK,EAAE,CAAC;oBAChC,gBAAgB,CAAC,OAAO,EAAE,CAAC,OAAO,mBAAmB,EAAE,CAAC,CAAC;gBAC3D,CAAC;gBACD,IAAI,SAAS,EAAE,CAAC;oBACd,gBAAgB,CAAC,OAAO,EAAE,CAAC,GAAG,mBAAmB,IAAI,SAAS,EAAE,CAAC,CAAC;gBACpE,CAAC;YACH,CAAC;SACF,CAAC;IACJ,CAAC,EAAE,CAAC,mBAAmB,EAAE,wBAAwB,EAAE,gBAAgB,CAAC,CAAC,CAAC;IAEtE,OAAO,KAAC,gBAAgB,CAAC,QAAQ,IAAC,KAAK,EAAE,YAAY,YAAG,QAAQ,GAA6B,CAAC;AAChG,CAAC;AAED,MAAM,mBAAmB,GAAqB;IAC5C,qBAAqB,EAAE,GAAG,EAAE,GAAE,CAAC;IAC/B,aAAa,EAAE,GAAG,EAAE,GAAE,CAAC;CACxB,CAAC;AAEF,gBAAgB;AAChB,MAAM,UAAU,mBAAmB;IACjC,OAAO,UAAU,CAAC,gBAAgB,CAAC,IAAI,mBAAmB,CAAC;AAC7D,CAAC;AAOD,gBAAgB;AAChB,MAAM,UAAU,kBAAkB,CAA2C,EAAE,MAAM,EAAE,SAAS,EAAoC;IAClI,MAAM,EAAE,aAAa,EAAE,GAAG,mBAAmB,EAAE,CAAC;IAChD,OAAO,WAAW,CAChB,CAAC,GAAG,IAAI,EAAE,EAAE;QACV,aAAa,CAAC,EAAE,SAAS,EAAE,iBAAiB,EAAE,IAAI,EAAE,CAAC,CAAC;QACtD,MAAM,CAAC,GAAG,IAAI,CAAC,CAAC;IAClB,CAAC,EACD,CAAC,MAAM,EAAE,SAAS,EAAE,aAAa,CAAC,CACnC,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 { createContext, useCallback, useContext, useMemo } from \"react\";\nimport { useLatest } from \"./internal/Utils.js\";\n\nimport type { PropsWithChildren } from \"react\";\n\ntype TrackedFeatures =\n  | \"visibility-change\"\n  | \"hierarchy-level-filtering\"\n  | \"filtering\"\n  | \"hierarchy-level-size-limit-hit\"\n  | \"zoom-to-node\"\n  | \"error-timeout\"\n  | \"error-unknown\";\n\ninterface TelemetryContext {\n  onPerformanceMeasured: (featureId: string, duration: number) => void;\n  onFeatureUsed: (props: { featureId?: TrackedFeatures; reportInteraction: boolean }) => void;\n}\n\nconst telemetryContext = createContext<TelemetryContext | undefined>(undefined);\n\n/** @beta */\nexport interface TelemetryContextProviderProps {\n  /** Callback that is invoked when performance of tracked feature is measured. */\n  onPerformanceMeasured?: (featureId: string, duration: number) => void;\n  /** Callback that is invoked when a tracked feature is used. */\n  onFeatureUsed?: (featureId: string) => void;\n  /** Unique identifier that is appended to feature id to help track which component used that feature. */\n  componentIdentifier: string;\n}\n\n/** @beta */\nexport function TelemetryContextProvider({\n  children,\n  onPerformanceMeasured,\n  onFeatureUsed,\n  componentIdentifier,\n}: PropsWithChildren<TelemetryContextProviderProps>) {\n  const onPerformanceMeasuredRef = useLatest(onPerformanceMeasured);\n  const onFeatureUsedRef = useLatest(onFeatureUsed);\n\n  const contextValue = useMemo<TelemetryContext>(() => {\n    return {\n      onPerformanceMeasured: (featureId, duration) => onPerformanceMeasuredRef.current?.(`${componentIdentifier}-${featureId}`, duration),\n      onFeatureUsed: ({ featureId, reportInteraction }) => {\n        if (reportInteraction !== false) {\n          onFeatureUsedRef.current?.(`use-${componentIdentifier}`);\n        }\n        if (featureId) {\n          onFeatureUsedRef.current?.(`${componentIdentifier}-${featureId}`);\n        }\n      },\n    };\n  }, [componentIdentifier, onPerformanceMeasuredRef, onFeatureUsedRef]);\n\n  return <telemetryContext.Provider value={contextValue}>{children}</telemetryContext.Provider>;\n}\n\nconst defaultContextValue: TelemetryContext = {\n  onPerformanceMeasured: () => {},\n  onFeatureUsed: () => {},\n};\n\n/** @internal */\nexport function useTelemetryContext() {\n  return useContext(telemetryContext) ?? defaultContextValue;\n}\n\ninterface UseReportingActionProps<TAction> {\n  action: TAction;\n  featureId?: TrackedFeatures;\n}\n\n/** @internal */\nexport function useReportingAction<TAction extends (...args: any[]) => void>({ action, featureId }: UseReportingActionProps<TAction>) {\n  const { onFeatureUsed } = useTelemetryContext();\n  return useCallback<(...args: Parameters<TAction>) => void>(\n    (...args) => {\n      onFeatureUsed({ featureId, reportInteraction: true });\n      action(...args);\n    },\n    [action, featureId, onFeatureUsed],\n  );\n}\n"]}

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

@@ -1,27 +1,49 @@
-/// <reference types="react" />
-import type { Id64Array } from "@itwin/core-bentley";
-import type { IModelConnection } from "@itwin/core-frontend";
-import type { SchemaContext } from "@itwin/ecschema-metadata";
+import { HierarchyFilteringPath } from "@itwin/presentation-hierarchies";
+import type { GuidString, Id64Array } from "@itwin/core-bentley";
+import type { HierarchyNodeIdentifiersPath } from "@itwin/presentation-hierarchies";
+import type { TreeWidgetViewport } from "./TreeWidgetViewport.js";
+/**
+ * This is a logging namespace for public log messages that may be interesting to consumers.
+ * @internal
+ */
+export declare const LOGGING_NAMESPACE = "TreeWidget";
 /** @beta */
 export type FunctionProps<THook extends (props: any) => any> = Parameters<THook>[0];
+/**
+ * Disables display of all given models.
+ * @public
+ */
+export declare function hideAllModels(models: string[], viewport: TreeWidgetViewport): void;
+/**
+ * Enables display of all given models. Also enables display of all categories and clears always and
+ * never drawn lists in the viewport.
+ * @public
+ */
+export declare function showAll(props: {
+    /** ID's of models to enable */
+    models: Id64Array;
+    /** ID's of categories to enable, if set to undefined, all categories will be enabled */
+    categories?: Id64Array;
+    viewport: TreeWidgetViewport;
+    componentId?: GuidString;
+}): Promise<void>;
+/**
+ * Inverts display of all given models.
+ * @public
+ */
+export declare function invertAllModels(models: Id64Array, viewport: TreeWidgetViewport): void;
+/**
+ * Based on the value of `enable` argument, either enables or disables display of given models.
+ * @public
+ */
+export declare function toggleModels(models: string[], enable: boolean, viewport: TreeWidgetViewport): void;
+/**
+ * Checks if all given models are displayed in given viewport.
+ * @public
+ */
+export declare function areAllModelsVisible(models: string[], viewport: TreeWidgetViewport): boolean;
+/** @public */
+export type NormalizedHierarchyFilteringPath = ReturnType<(typeof HierarchyFilteringPath)["normalize"]>;
 /** @internal */
-export declare function createIdsSelector(ids: Id64Array): string;
-/** @internal */
-export declare function parseIdsSelectorResult(selectorResult: any): Id64Array;
-/** @internal */
-export declare function pushToMap<TKey, TValue>(targetMap: Map<TKey, Set<TValue>>, key: TKey, value: TValue): void;
-/** @internal */
-export declare function createIModelAccess({ imodel, getSchemaContext }: {
-    imodel: IModelConnection;
-    getSchemaContext: (imodel: IModelConnection) => SchemaContext;
-}): {
-    createQueryReader(query: import("@itwin/presentation-shared").ECSqlQueryDef, config?: (import("@itwin/presentation-shared").ECSqlQueryReaderOptions & {
-        limit?: number | "unbounded" | undefined;
-    }) | undefined): AsyncIterableIterator<import("@itwin/presentation-shared").ECSqlQueryRow>;
-    classDerivesFrom(derivedClassFullName: string, candidateBaseClassFullName: string): boolean | Promise<boolean>;
-    getSchema(schemaName: string): Promise<import("@itwin/presentation-shared").EC.Schema | undefined>;
-    imodelKey: string;
-};
-/** @internal */
-export declare function useLatest<T>(value: T): import("react").MutableRefObject<T>;
+export declare function joinHierarchyFilteringPaths(subTreePaths: HierarchyNodeIdentifiersPath[], filteringPaths: NormalizedHierarchyFilteringPath[]): NormalizedHierarchyFilteringPath[];
 //# sourceMappingURL=Utils.d.ts.map

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

@@ -2,57 +2,123 @@
  * Copyright (c) Bentley Systems, Incorporated. All rights reserved.
  * See LICENSE.md in the project root for license terms and full copyright notice.
  *--------------------------------------------------------------------------------------------*/
-import { useEffect, useRef } from "react";
-import { createECSchemaProvider, createECSqlQueryExecutor } from "@itwin/presentation-core-interop";
-import { createLimitingECSqlQueryExecutor } from "@itwin/presentation-hierarchies";
-import { createCachingECClassHierarchyInspector } from "@itwin/presentation-shared";
-/** @internal */
-export function createIdsSelector(ids) {
-    // Note: `json_array` function only accepts up to 127 arguments and we may have more `ids` than that. As a workaround,
-    // we're creating an array of arrays
-    const slices = new Array();
-    for (let sliceStartIndex = 0; sliceStartIndex < ids.length; sliceStartIndex += 127) {
-        let sliceEndIndex = sliceStartIndex + 127;
-        if (sliceEndIndex > ids.length) {
-            sliceEndIndex = undefined;
+import { HierarchyFilteringPath, HierarchyNodeIdentifier } from "@itwin/presentation-hierarchies";
+import { showAllCategories } from "./CategoriesVisibilityUtils.js";
+import { enableCategoryDisplay, loadCategoriesFromViewport } from "./internal/VisibilityUtils.js";
+/**
+ * This is a logging namespace for public log messages that may be interesting to consumers.
+ * @internal
+ */
+export const LOGGING_NAMESPACE = "TreeWidget";
+/**
+ * Disables display of all given models.
+ * @public
+ */
+export function hideAllModels(models, viewport) {
+    viewport.changeModelDisplay({ modelIds: models, display: false });
+}
+/**
+ * Enables display of all given models. Also enables display of all categories and clears always and
+ * never drawn lists in the viewport.
+ * @public
+ */
+export async function showAll(props) {
+    const { models, categories, viewport, componentId } = props;
+    viewport.changeModelDisplay({ modelIds: models, display: true });
+    viewport.clearNeverDrawn();
+    viewport.clearAlwaysDrawn();
+    if (categories) {
+        await showAllCategories(categories, viewport);
+    }
+    else {
+        const categoryInfos = await loadCategoriesFromViewport(viewport, componentId);
+        if (categoryInfos.length === 0) {
+            return;
         }
-        slices.push(ids.slice(sliceStartIndex, sliceEndIndex));
+        const ids = categoryInfos.map((categoryInfo) => categoryInfo.categoryId);
+        await enableCategoryDisplay(viewport, ids, true);
     }
-    return `json_array(${slices.map((sliceIds) => `json_array(${sliceIds.map((id) => `'${id}'`).join(",")})`).join(",")})`;
 }
-/** @internal */
-export function parseIdsSelectorResult(selectorResult) {
-    if (!Array.isArray(selectorResult)) {
-        return [];
-    }
-    return selectorResult.reduce((arr, ids) => [...arr, ...(Array.isArray(ids) ? ids : [ids])], new Array());
+/**
+ * Inverts display of all given models.
+ * @public
+ */
+export function invertAllModels(models, viewport) {
+    const notViewedModels = new Array();
+    const viewedModels = new Array();
+    models.forEach((modelId) => {
+        if (viewport.viewsModel(modelId)) {
+            viewedModels.push(modelId);
+        }
+        else {
+            notViewedModels.push(modelId);
+        }
+    });
+    viewport.changeModelDisplay({ modelIds: notViewedModels, display: true });
+    viewport.changeModelDisplay({ modelIds: viewedModels, display: false });
 }
-/** @internal */
-export function pushToMap(targetMap, key, value) {
-    let set = targetMap.get(key);
-    if (!set) {
-        set = new Set();
-        targetMap.set(key, set);
+/**
+ * Based on the value of `enable` argument, either enables or disables display of given models.
+ * @public
+ */
+export function toggleModels(models, enable, viewport) {
+    if (!models) {
+        return;
     }
-    set.add(value);
+    viewport.changeModelDisplay({ modelIds: models, display: enable });
 }
-/** @internal */
-export function createIModelAccess({ imodel, getSchemaContext }) {
-    const schemas = getSchemaContext(imodel);
-    const schemaProvider = createECSchemaProvider(schemas);
-    return {
-        imodelKey: imodel.key,
-        ...schemaProvider,
-        ...createCachingECClassHierarchyInspector({ schemaProvider, cacheSize: 100 }),
-        ...createLimitingECSqlQueryExecutor(createECSqlQueryExecutor(imodel), 1000),
-    };
+/**
+ * Checks if all given models are displayed in given viewport.
+ * @public
+ */
+export function areAllModelsVisible(models, viewport) {
+    return models.length !== 0 ? models.every((id) => viewport.viewsModel(id)) : false;
 }
 /** @internal */
-export function useLatest(value) {
-    const ref = useRef(value);
-    useEffect(() => {
-        ref.current = value;
-    }, [value]);
-    return ref;
+export function joinHierarchyFilteringPaths(subTreePaths, filteringPaths) {
+    const result = new Array();
+    const filteringPathsToIncludeIndexes = new Set();
+    subTreePaths.forEach((subTreePath) => {
+        let options;
+        let addSubTreePathToResult = false;
+        for (let i = 0; i < filteringPaths.length; ++i) {
+            const filteringPath = filteringPaths[i];
+            if (filteringPath.path.length === 0) {
+                continue;
+            }
+            for (let j = 0; j < subTreePath.length; ++j) {
+                const identifier = subTreePath[j];
+                if (filteringPath.path.length <= j || !HierarchyNodeIdentifier.equal(filteringPath.path[j], identifier)) {
+                    break;
+                }
+                // filtering paths that are shorter or equal than subTree paths length don't need to be added to the result
+                if (filteringPath.path.length === j + 1) {
+                    addSubTreePathToResult = true;
+                    // If filtering path has reveal set to true, it means that we should expand only to the targeted filtered node
+                    // This is done by setting depthInPath
+                    options =
+                        filteringPath.options?.reveal !== true
+                            ? HierarchyFilteringPath.mergeOptions(options, filteringPath.options)
+                            : { reveal: { depthInPath: filteringPath.path.length - 1 } };
+                    break;
+                }
+                // filtering paths that are longer than subTree paths need to be added to the result
+                if (subTreePath.length === j + 1) {
+                    addSubTreePathToResult = true;
+                    filteringPathsToIncludeIndexes.add(i);
+                }
+            }
+        }
+        if (addSubTreePathToResult) {
+            result.push({
+                path: subTreePath,
+                options,
+            });
+        }
+    });
+    for (const index of filteringPathsToIncludeIndexes) {
+        result.push(filteringPaths[index]);
+    }
+    return result;
 }
 //# sourceMappingURL=Utils.js.map

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

@@ -1 +1 @@
-{"version":3,"file":"Utils.js","sourceRoot":"","sources":["../../../../../../src/tree-widget-react/components/trees/common/Utils.ts"],"names":[],"mappings":"AAAA;;;gGAGgG;AAEhG,OAAO,EAAE,SAAS,EAAE,MAAM,EAAE,MAAM,OAAO,CAAC;AAC1C,OAAO,EAAE,sBAAsB,EAAE,wBAAwB,EAAE,MAAM,kCAAkC,CAAC;AACpG,OAAO,EAAE,gCAAgC,EAAE,MAAM,iCAAiC,CAAC;AACnF,OAAO,EAAE,sCAAsC,EAAE,MAAM,4BAA4B,CAAC;AASpF,gBAAgB;AAChB,MAAM,UAAU,iBAAiB,CAAC,GAAc;IAC9C,sHAAsH;IACtH,oCAAoC;IACpC,MAAM,MAAM,GAAG,IAAI,KAAK,EAAgB,CAAC;IACzC,KAAK,IAAI,eAAe,GAAG,CAAC,EAAE,eAAe,GAAG,GAAG,CAAC,MAAM,EAAE,eAAe,IAAI,GAAG,EAAE;QAClF,IAAI,aAAa,GAAuB,eAAe,GAAG,GAAG,CAAC;QAC9D,IAAI,aAAa,GAAG,GAAG,CAAC,MAAM,EAAE;YAC9B,aAAa,GAAG,SAAS,CAAC;SAC3B;QACD,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,eAAe,EAAE,aAAa,CAAC,CAAC,CAAC;KACxD;IACD,OAAO,cAAc,MAAM,CAAC,GAAG,CAAC,CAAC,QAAQ,EAAE,EAAE,CAAC,cAAc,QAAQ,CAAC,GAAG,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC;AACzH,CAAC;AAED,gBAAgB;AAChB,MAAM,UAAU,sBAAsB,CAAC,cAAmB;IACxD,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,cAAc,CAAC,EAAE;QAClC,OAAO,EAAE,CAAC;KACX;IACD,OAAO,cAAc,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,GAA8B,EAAE,EAAE,CAAC,CAAC,GAAG,GAAG,EAAE,GAAG,CAAC,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,IAAI,KAAK,EAAc,CAAC,CAAC;AAClJ,CAAC;AAED,gBAAgB;AAChB,MAAM,UAAU,SAAS,CAAe,SAAiC,EAAE,GAAS,EAAE,KAAa;IACjG,IAAI,GAAG,GAAG,SAAS,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;IAC7B,IAAI,CAAC,GAAG,EAAE;QACR,GAAG,GAAG,IAAI,GAAG,EAAE,CAAC;QAChB,SAAS,CAAC,GAAG,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC;KACzB;IACD,GAAG,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;AACjB,CAAC;AAED,gBAAgB;AAChB,MAAM,UAAU,kBAAkB,CAAC,EAAE,MAAM,EAAE,gBAAgB,EAA+F;IAC1J,MAAM,OAAO,GAAG,gBAAgB,CAAC,MAAM,CAAC,CAAC;IACzC,MAAM,cAAc,GAAG,sBAAsB,CAAC,OAAO,CAAC,CAAC;IACvD,OAAO;QACL,SAAS,EAAE,MAAM,CAAC,GAAG;QACrB,GAAG,cAAc;QACjB,GAAG,sCAAsC,CAAC,EAAE,cAAc,EAAE,SAAS,EAAE,GAAG,EAAE,CAAC;QAC7E,GAAG,gCAAgC,CAAC,wBAAwB,CAAC,MAAM,CAAC,EAAE,IAAI,CAAC;KAC5E,CAAC;AACJ,CAAC;AAED,gBAAgB;AAChB,MAAM,UAAU,SAAS,CAAI,KAAQ;IACnC,MAAM,GAAG,GAAG,MAAM,CAAC,KAAK,CAAC,CAAC;IAC1B,SAAS,CAAC,GAAG,EAAE;QACb,GAAG,CAAC,OAAO,GAAG,KAAK,CAAC;IACtB,CAAC,EAAE,CAAC,KAAK,CAAC,CAAC,CAAC;IACZ,OAAO,GAAG,CAAC;AACb,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 } from \"react\";\nimport { createECSchemaProvider, createECSqlQueryExecutor } from \"@itwin/presentation-core-interop\";\nimport { createLimitingECSqlQueryExecutor } from \"@itwin/presentation-hierarchies\";\nimport { createCachingECClassHierarchyInspector } from \"@itwin/presentation-shared\";\n\nimport type { Id64Array, Id64String } from \"@itwin/core-bentley\";\nimport type { IModelConnection } from \"@itwin/core-frontend\";\nimport type { SchemaContext } from \"@itwin/ecschema-metadata\";\n\n/** @beta */\nexport type FunctionProps<THook extends (props: any) => any> = Parameters<THook>[0];\n\n/** @internal */\nexport function createIdsSelector(ids: Id64Array): string {\n  // Note: `json_array` function only accepts up to 127 arguments and we may have more `ids` than that. As a workaround,\n  // we're creating an array of arrays\n  const slices = new Array<Id64String[]>();\n  for (let sliceStartIndex = 0; sliceStartIndex < ids.length; sliceStartIndex += 127) {\n    let sliceEndIndex: number | undefined = sliceStartIndex + 127;\n    if (sliceEndIndex > ids.length) {\n      sliceEndIndex = undefined;\n    }\n    slices.push(ids.slice(sliceStartIndex, sliceEndIndex));\n  }\n  return `json_array(${slices.map((sliceIds) => `json_array(${sliceIds.map((id) => `'${id}'`).join(\",\")})`).join(\",\")})`;\n}\n\n/** @internal */\nexport function parseIdsSelectorResult(selectorResult: any): Id64Array {\n  if (!Array.isArray(selectorResult)) {\n    return [];\n  }\n  return selectorResult.reduce((arr, ids: Id64String | Id64String[]) => [...arr, ...(Array.isArray(ids) ? ids : [ids])], new Array<Id64String>());\n}\n\n/** @internal */\nexport function pushToMap<TKey, TValue>(targetMap: Map<TKey, Set<TValue>>, key: TKey, value: TValue) {\n  let set = targetMap.get(key);\n  if (!set) {\n    set = new Set();\n    targetMap.set(key, set);\n  }\n  set.add(value);\n}\n\n/** @internal */\nexport function createIModelAccess({ imodel, getSchemaContext }: { imodel: IModelConnection; getSchemaContext: (imodel: IModelConnection) => SchemaContext }) {\n  const schemas = getSchemaContext(imodel);\n  const schemaProvider = createECSchemaProvider(schemas);\n  return {\n    imodelKey: imodel.key,\n    ...schemaProvider,\n    ...createCachingECClassHierarchyInspector({ schemaProvider, cacheSize: 100 }),\n    ...createLimitingECSqlQueryExecutor(createECSqlQueryExecutor(imodel), 1000),\n  };\n}\n\n/** @internal */\nexport function useLatest<T>(value: T) {\n  const ref = useRef(value);\n  useEffect(() => {\n    ref.current = value;\n  }, [value]);\n  return ref;\n}\n"]}
+{"version":3,"file":"Utils.js","sourceRoot":"","sources":["../../../../../../src/tree-widget-react/components/trees/common/Utils.ts"],"names":[],"mappings":"AAAA;;;gGAGgG;AAEhG,OAAO,EAAE,sBAAsB,EAAE,uBAAuB,EAAE,MAAM,iCAAiC,CAAC;AAClG,OAAO,EAAE,iBAAiB,EAAE,MAAM,gCAAgC,CAAC;AACnE,OAAO,EAAE,qBAAqB,EAAE,0BAA0B,EAAE,MAAM,+BAA+B,CAAC;AAMlG;;;GAGG;AACH,MAAM,CAAC,MAAM,iBAAiB,GAAG,YAAY,CAAC;AAK9C;;;GAGG;AACH,MAAM,UAAU,aAAa,CAAC,MAAgB,EAAE,QAA4B;IAC1E,QAAQ,CAAC,kBAAkB,CAAC,EAAE,QAAQ,EAAE,MAAM,EAAE,OAAO,EAAE,KAAK,EAAE,CAAC,CAAC;AACpE,CAAC;AAED;;;;GAIG;AACH,MAAM,CAAC,KAAK,UAAU,OAAO,CAAC,KAO7B;IACC,MAAM,EAAE,MAAM,EAAE,UAAU,EAAE,QAAQ,EAAE,WAAW,EAAE,GAAG,KAAK,CAAC;IAC5D,QAAQ,CAAC,kBAAkB,CAAC,EAAE,QAAQ,EAAE,MAAM,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC,CAAC;IACjE,QAAQ,CAAC,eAAe,EAAE,CAAC;IAC3B,QAAQ,CAAC,gBAAgB,EAAE,CAAC;IAC5B,IAAI,UAAU,EAAE,CAAC;QACf,MAAM,iBAAiB,CAAC,UAAU,EAAE,QAAQ,CAAC,CAAC;IAChD,CAAC;SAAM,CAAC;QACN,MAAM,aAAa,GAAG,MAAM,0BAA0B,CAAC,QAAQ,EAAE,WAAW,CAAC,CAAC;QAC9E,IAAI,aAAa,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YAC/B,OAAO;QACT,CAAC;QACD,MAAM,GAAG,GAAG,aAAa,CAAC,GAAG,CAAC,CAAC,YAAY,EAAE,EAAE,CAAC,YAAY,CAAC,UAAU,CAAC,CAAC;QACzE,MAAM,qBAAqB,CAAC,QAAQ,EAAE,GAAG,EAAE,IAAI,CAAC,CAAC;IACnD,CAAC;AACH,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,eAAe,CAAC,MAAiB,EAAE,QAA4B;IAC7E,MAAM,eAAe,GAAG,IAAI,KAAK,EAAc,CAAC;IAChD,MAAM,YAAY,GAAG,IAAI,KAAK,EAAc,CAAC;IAC7C,MAAM,CAAC,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE;QACzB,IAAI,QAAQ,CAAC,UAAU,CAAC,OAAO,CAAC,EAAE,CAAC;YACjC,YAAY,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QAC7B,CAAC;aAAM,CAAC;YACN,eAAe,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QAChC,CAAC;IACH,CAAC,CAAC,CAAC;IACH,QAAQ,CAAC,kBAAkB,CAAC,EAAE,QAAQ,EAAE,eAAe,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC,CAAC;IAC1E,QAAQ,CAAC,kBAAkB,CAAC,EAAE,QAAQ,EAAE,YAAY,EAAE,OAAO,EAAE,KAAK,EAAE,CAAC,CAAC;AAC1E,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,YAAY,CAAC,MAAgB,EAAE,MAAe,EAAE,QAA4B;IAC1F,IAAI,CAAC,MAAM,EAAE,CAAC;QACZ,OAAO;IACT,CAAC;IACD,QAAQ,CAAC,kBAAkB,CAAC,EAAE,QAAQ,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,CAAC,CAAC;AACrE,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,mBAAmB,CAAC,MAAgB,EAAE,QAA4B;IAChF,OAAO,MAAM,CAAC,MAAM,KAAK,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC,QAAQ,CAAC,UAAU,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC;AACrF,CAAC;AAKD,gBAAgB;AAChB,MAAM,UAAU,2BAA2B,CACzC,YAA4C,EAC5C,cAAkD;IAElD,MAAM,MAAM,GAAG,IAAI,KAAK,EAAoC,CAAC;IAC7D,MAAM,8BAA8B,GAAG,IAAI,GAAG,EAAU,CAAC;IAEzD,YAAY,CAAC,OAAO,CAAC,CAAC,WAAW,EAAE,EAAE;QACnC,IAAI,OAAkD,CAAC;QACvD,IAAI,sBAAsB,GAAG,KAAK,CAAC;QAEnC,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,cAAc,CAAC,MAAM,EAAE,EAAE,CAAC,EAAE,CAAC;YAC/C,MAAM,aAAa,GAAG,cAAc,CAAC,CAAC,CAAC,CAAC;YACxC,IAAI,aAAa,CAAC,IAAI,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;gBACpC,SAAS;YACX,CAAC;YAED,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,WAAW,CAAC,MAAM,EAAE,EAAE,CAAC,EAAE,CAAC;gBAC5C,MAAM,UAAU,GAAG,WAAW,CAAC,CAAC,CAAC,CAAC;gBAClC,IAAI,aAAa,CAAC,IAAI,CAAC,MAAM,IAAI,CAAC,IAAI,CAAC,uBAAuB,CAAC,KAAK,CAAC,aAAa,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,UAAU,CAAC,EAAE,CAAC;oBACxG,MAAM;gBACR,CAAC;gBAED,2GAA2G;gBAC3G,IAAI,aAAa,CAAC,IAAI,CAAC,MAAM,KAAK,CAAC,GAAG,CAAC,EAAE,CAAC;oBACxC,sBAAsB,GAAG,IAAI,CAAC;oBAC9B,8GAA8G;oBAC9G,sCAAsC;oBACtC,OAAO;wBACL,aAAa,CAAC,OAAO,EAAE,MAAM,KAAK,IAAI;4BACpC,CAAC,CAAC,sBAAsB,CAAC,YAAY,CAAC,OAAO,EAAE,aAAa,CAAC,OAAO,CAAC;4BACrE,CAAC,CAAC,EAAE,MAAM,EAAE,EAAE,WAAW,EAAE,aAAa,CAAC,IAAI,CAAC,MAAM,GAAG,CAAC,EAAE,EAAE,CAAC;oBACjE,MAAM;gBACR,CAAC;gBAED,oFAAoF;gBACpF,IAAI,WAAW,CAAC,MAAM,KAAK,CAAC,GAAG,CAAC,EAAE,CAAC;oBACjC,sBAAsB,GAAG,IAAI,CAAC;oBAC9B,8BAA8B,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;gBACxC,CAAC;YACH,CAAC;QACH,CAAC;QAED,IAAI,sBAAsB,EAAE,CAAC;YAC3B,MAAM,CAAC,IAAI,CAAC;gBACV,IAAI,EAAE,WAAW;gBACjB,OAAO;aACR,CAAC,CAAC;QACL,CAAC;IACH,CAAC,CAAC,CAAC;IACH,KAAK,MAAM,KAAK,IAAI,8BAA8B,EAAE,CAAC;QACnD,MAAM,CAAC,IAAI,CAAC,cAAc,CAAC,KAAK,CAAC,CAAC,CAAC;IACrC,CAAC;IACD,OAAO,MAAM,CAAC;AAChB,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 { HierarchyFilteringPath, HierarchyNodeIdentifier } from \"@itwin/presentation-hierarchies\";\nimport { showAllCategories } from \"./CategoriesVisibilityUtils.js\";\nimport { enableCategoryDisplay, loadCategoriesFromViewport } from \"./internal/VisibilityUtils.js\";\n\nimport type { GuidString, Id64Array, Id64String } from \"@itwin/core-bentley\";\nimport type { HierarchyFilteringPathOptions, HierarchyNodeIdentifiersPath } from \"@itwin/presentation-hierarchies\";\nimport type { TreeWidgetViewport } from \"./TreeWidgetViewport.js\";\n\n/**\n * This is a logging namespace for public log messages that may be interesting to consumers.\n * @internal\n */\nexport const LOGGING_NAMESPACE = \"TreeWidget\";\n\n/** @beta */\nexport type FunctionProps<THook extends (props: any) => any> = Parameters<THook>[0];\n\n/**\n * Disables display of all given models.\n * @public\n */\nexport function hideAllModels(models: string[], viewport: TreeWidgetViewport) {\n  viewport.changeModelDisplay({ modelIds: models, display: false });\n}\n\n/**\n * Enables display of all given models. Also enables display of all categories and clears always and\n * never drawn lists in the viewport.\n * @public\n */\nexport async function showAll(props: {\n  /** ID's of models to enable */\n  models: Id64Array;\n  /** ID's of categories to enable, if set to undefined, all categories will be enabled */\n  categories?: Id64Array;\n  viewport: TreeWidgetViewport;\n  componentId?: GuidString;\n}) {\n  const { models, categories, viewport, componentId } = props;\n  viewport.changeModelDisplay({ modelIds: models, display: true });\n  viewport.clearNeverDrawn();\n  viewport.clearAlwaysDrawn();\n  if (categories) {\n    await showAllCategories(categories, viewport);\n  } else {\n    const categoryInfos = await loadCategoriesFromViewport(viewport, componentId);\n    if (categoryInfos.length === 0) {\n      return;\n    }\n    const ids = categoryInfos.map((categoryInfo) => categoryInfo.categoryId);\n    await enableCategoryDisplay(viewport, ids, true);\n  }\n}\n\n/**\n * Inverts display of all given models.\n * @public\n */\nexport function invertAllModels(models: Id64Array, viewport: TreeWidgetViewport) {\n  const notViewedModels = new Array<Id64String>();\n  const viewedModels = new Array<Id64String>();\n  models.forEach((modelId) => {\n    if (viewport.viewsModel(modelId)) {\n      viewedModels.push(modelId);\n    } else {\n      notViewedModels.push(modelId);\n    }\n  });\n  viewport.changeModelDisplay({ modelIds: notViewedModels, display: true });\n  viewport.changeModelDisplay({ modelIds: viewedModels, display: false });\n}\n\n/**\n * Based on the value of `enable` argument, either enables or disables display of given models.\n * @public\n */\nexport function toggleModels(models: string[], enable: boolean, viewport: TreeWidgetViewport) {\n  if (!models) {\n    return;\n  }\n  viewport.changeModelDisplay({ modelIds: models, display: enable });\n}\n\n/**\n * Checks if all given models are displayed in given viewport.\n * @public\n */\nexport function areAllModelsVisible(models: string[], viewport: TreeWidgetViewport) {\n  return models.length !== 0 ? models.every((id) => viewport.viewsModel(id)) : false;\n}\n\n/** @public */\nexport type NormalizedHierarchyFilteringPath = ReturnType<(typeof HierarchyFilteringPath)[\"normalize\"]>;\n\n/** @internal */\nexport function joinHierarchyFilteringPaths(\n  subTreePaths: HierarchyNodeIdentifiersPath[],\n  filteringPaths: NormalizedHierarchyFilteringPath[],\n): NormalizedHierarchyFilteringPath[] {\n  const result = new Array<NormalizedHierarchyFilteringPath>();\n  const filteringPathsToIncludeIndexes = new Set<number>();\n\n  subTreePaths.forEach((subTreePath) => {\n    let options: HierarchyFilteringPathOptions | undefined;\n    let addSubTreePathToResult = false;\n\n    for (let i = 0; i < filteringPaths.length; ++i) {\n      const filteringPath = filteringPaths[i];\n      if (filteringPath.path.length === 0) {\n        continue;\n      }\n\n      for (let j = 0; j < subTreePath.length; ++j) {\n        const identifier = subTreePath[j];\n        if (filteringPath.path.length <= j || !HierarchyNodeIdentifier.equal(filteringPath.path[j], identifier)) {\n          break;\n        }\n\n        // filtering paths that are shorter or equal than subTree paths length don't need to be added to the result\n        if (filteringPath.path.length === j + 1) {\n          addSubTreePathToResult = true;\n          // If filtering path has reveal set to true, it means that we should expand only to the targeted filtered node\n          // This is done by setting depthInPath\n          options =\n            filteringPath.options?.reveal !== true\n              ? HierarchyFilteringPath.mergeOptions(options, filteringPath.options)\n              : { reveal: { depthInPath: filteringPath.path.length - 1 } };\n          break;\n        }\n\n        // filtering paths that are longer than subTree paths need to be added to the result\n        if (subTreePath.length === j + 1) {\n          addSubTreePathToResult = true;\n          filteringPathsToIncludeIndexes.add(i);\n        }\n      }\n    }\n\n    if (addSubTreePathToResult) {\n      result.push({\n        path: subTreePath,\n        options,\n      });\n    }\n  });\n  for (const index of filteringPathsToIncludeIndexes) {\n    result.push(filteringPaths[index]);\n  }\n  return result;\n}\n"]}

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

@@ -1,7 +1,6 @@
-/// <reference types="react" />
-import { TreeRenderer as PresentationTree } from "@itwin/presentation-hierarchies-react";
+import { StrataKitTreeRenderer as PresentationTree } from "@itwin/presentation-hierarchies-react";
 /** @beta */
 export type BaseTreeRendererProps = React.ComponentPropsWithoutRef<typeof PresentationTree>;
 /** @internal */
-export declare function BaseTreeRenderer({ rootNodes, onNodeClick, expandNode, actions, ...props }: BaseTreeRendererProps): import("react/jsx-runtime").JSX.Element;
+export declare function BaseTreeRenderer(props: BaseTreeRendererProps): import("react/jsx-runtime").JSX.Element;
 //# sourceMappingURL=BaseTreeRenderer.d.ts.map