@itwin/presentation-hierarchies-react 0.7.1 → 0.8.0

package/lib/esm/presentation-hierarchies-react/UseIModelTree.d.ts

@@ -0,0 +1,53 @@
+import { createIModelHierarchyProvider, HierarchyDefinition, HierarchyFilteringPath } from "@itwin/presentation-hierarchies";
+import { UseUnifiedTreeSelectionProps } from "./internal/UseUnifiedSelection";
+import { UseTreeProps, UseTreeResult } from "./UseTree";
+/** @beta */
+type IModelHierarchyProviderProps = Parameters<typeof createIModelHierarchyProvider>[0];
+/** @beta */
+type IModelAccess = IModelHierarchyProviderProps["imodelAccess"];
+/**
+ * Props for `useIModelTree` and `useIModelUnifiedSelectionTree` hooks.
+ * @beta
+ */
+type UseIModelTreeProps = Omit<UseTreeProps, "getHierarchyProvider" | "getFilteredPaths"> & Pick<IModelHierarchyProviderProps, "localizedStrings" | "imodelAccess" | "imodelChanged"> & {
+    /** Provides the hierarchy definition for the tree. */
+    getHierarchyDefinition: (props: {
+        imodelAccess: IModelAccess;
+    }) => HierarchyDefinition;
+    /** Provides paths to filtered nodes. */
+    getFilteredPaths?: (props: {
+        /** Object that provides access to the iModel schema and can run queries against the iModel. */
+        imodelAccess: IModelAccess;
+    }) => Promise<HierarchyFilteringPath[] | undefined>;
+};
+/**
+ * A React hook that creates state for a tree component whose displayed hierarchy is based on
+ * iModel data.
+ *
+ * The hook uses `@itwin/presentation-hierarchies` package to load the hierarchy data and returns a
+ * component-agnostic result which may be used to render the hierarchy using any UI framework.
+ *
+ * See `README.md` for an example
+ *
+ * @see `useTree`
+ * @see `useIModelUnifiedSelectionTree`
+ * @beta
+ */
+export declare function useIModelTree(props: UseIModelTreeProps): UseTreeResult;
+/**
+ * A React hook that creates state for a tree component whose displayed hierarchy is based on
+ * iModel data and that is integrated with unified selection through context provided by `UnifiedSelectionProvider`.
+ *
+ * The hook uses `@itwin/presentation-hierarchies` package to load the hierarchy data and returns a
+ * component-agnostic result which may be used to render the hierarchy using any UI framework.
+ *
+ * See `README.md` for an example
+ *
+ * @see `useIModelTree`
+ * @see `useUnifiedSelectionTree`
+ * @see `UnifiedSelectionProvider`
+ * @beta
+ */
+export declare function useIModelUnifiedSelectionTree(props: UseIModelTreeProps & UseUnifiedTreeSelectionProps): UseTreeResult;
+export {};
+//# sourceMappingURL=UseIModelTree.d.ts.map

package/lib/esm/presentation-hierarchies-react/UseIModelTree.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"UseIModelTree.d.ts","sourceRoot":"","sources":["../../../src/presentation-hierarchies-react/UseIModelTree.ts"],"names":[],"mappings":"AAMA,OAAO,EAAE,6BAA6B,EAAE,mBAAmB,EAAE,sBAAsB,EAAE,MAAM,iCAAiC,CAAC;AAC7H,OAAO,EAAE,4BAA4B,EAAE,MAAM,gCAAgC,CAAC;AAC9E,OAAO,EAAW,YAAY,EAAE,aAAa,EAA2B,MAAM,WAAW,CAAC;AAE1F,YAAY;AACZ,KAAK,4BAA4B,GAAG,UAAU,CAAC,OAAO,6BAA6B,CAAC,CAAC,CAAC,CAAC,CAAC;AAExF,YAAY;AACZ,KAAK,YAAY,GAAG,4BAA4B,CAAC,cAAc,CAAC,CAAC;AAEjE;;;GAGG;AACH,KAAK,kBAAkB,GAAG,IAAI,CAAC,YAAY,EAAE,sBAAsB,GAAG,kBAAkB,CAAC,GACvF,IAAI,CAAC,4BAA4B,EAAE,kBAAkB,GAAG,cAAc,GAAG,eAAe,CAAC,GAAG;IAC1F,sDAAsD;IACtD,sBAAsB,EAAE,CAAC,KAAK,EAAE;QAAE,YAAY,EAAE,YAAY,CAAA;KAAE,KAAK,mBAAmB,CAAC;IAEvF,wCAAwC;IACxC,gBAAgB,CAAC,EAAE,CAAC,KAAK,EAAE;QACzB,+FAA+F;QAC/F,YAAY,EAAE,YAAY,CAAC;KAC5B,KAAK,OAAO,CAAC,sBAAsB,EAAE,GAAG,SAAS,CAAC,CAAC;CACrD,CAAC;AAEJ;;;;;;;;;;;;GAYG;AACH,wBAAgB,aAAa,CAAC,KAAK,EAAE,kBAAkB,GAAG,aAAa,CAMtE;AAED;;;;;;;;;;;;;GAaG;AACH,wBAAgB,6BAA6B,CAAC,KAAK,EAAE,kBAAkB,GAAG,4BAA4B,GAAG,aAAa,CAMrH"}

package/lib/esm/presentation-hierarchies-react/UseIModelTree.js

@@ -0,0 +1,61 @@
+/*---------------------------------------------------------------------------------------------
+ * Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+ * See LICENSE.md in the project root for license terms and full copyright notice.
+ *--------------------------------------------------------------------------------------------*/
+import { useCallback } from "react";
+import { createIModelHierarchyProvider } from "@itwin/presentation-hierarchies";
+import { useTree, useUnifiedSelectionTree } from "./UseTree";
+/**
+ * A React hook that creates state for a tree component whose displayed hierarchy is based on
+ * iModel data.
+ *
+ * The hook uses `@itwin/presentation-hierarchies` package to load the hierarchy data and returns a
+ * component-agnostic result which may be used to render the hierarchy using any UI framework.
+ *
+ * See `README.md` for an example
+ *
+ * @see `useTree`
+ * @see `useIModelUnifiedSelectionTree`
+ * @beta
+ */
+export function useIModelTree(props) {
+    const { imodelAccess, imodelChanged, getHierarchyDefinition, getFilteredPaths, localizedStrings, ...rest } = props;
+    return useTree({
+        ...rest,
+        ...useIModelTreeProps({ imodelAccess, imodelChanged, getHierarchyDefinition, getFilteredPaths, localizedStrings }),
+    });
+}
+/**
+ * A React hook that creates state for a tree component whose displayed hierarchy is based on
+ * iModel data and that is integrated with unified selection through context provided by `UnifiedSelectionProvider`.
+ *
+ * The hook uses `@itwin/presentation-hierarchies` package to load the hierarchy data and returns a
+ * component-agnostic result which may be used to render the hierarchy using any UI framework.
+ *
+ * See `README.md` for an example
+ *
+ * @see `useIModelTree`
+ * @see `useUnifiedSelectionTree`
+ * @see `UnifiedSelectionProvider`
+ * @beta
+ */
+export function useIModelUnifiedSelectionTree(props) {
+    const { imodelAccess, imodelChanged, getHierarchyDefinition, getFilteredPaths, localizedStrings, ...rest } = props;
+    return useUnifiedSelectionTree({
+        ...rest,
+        ...useIModelTreeProps({ imodelAccess, imodelChanged, getHierarchyDefinition, getFilteredPaths, localizedStrings }),
+    });
+}
+function useIModelTreeProps(props) {
+    const { imodelAccess, imodelChanged, getHierarchyDefinition, getFilteredPaths, localizedStrings } = props;
+    return {
+        getHierarchyProvider: useCallback(() => createIModelHierarchyProvider({
+            imodelAccess,
+            imodelChanged,
+            hierarchyDefinition: getHierarchyDefinition({ imodelAccess }),
+            localizedStrings,
+        }), [imodelAccess, imodelChanged, getHierarchyDefinition, localizedStrings]),
+        getFilteredPaths: useCallback(async () => getFilteredPaths?.({ imodelAccess }), [imodelAccess, getFilteredPaths]),
+    };
+}
+//# sourceMappingURL=UseIModelTree.js.map

package/lib/esm/presentation-hierarchies-react/UseIModelTree.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"UseIModelTree.js","sourceRoot":"","sources":["../../../src/presentation-hierarchies-react/UseIModelTree.ts"],"names":[],"mappings":"AAAA;;;gGAGgG;AAEhG,OAAO,EAAE,WAAW,EAAE,MAAM,OAAO,CAAC;AACpC,OAAO,EAAE,6BAA6B,EAA+C,MAAM,iCAAiC,CAAC;AAE7H,OAAO,EAAE,OAAO,EAA+B,uBAAuB,EAAE,MAAM,WAAW,CAAC;AAwB1F;;;;;;;;;;;;GAYG;AACH,MAAM,UAAU,aAAa,CAAC,KAAyB;IACrD,MAAM,EAAE,YAAY,EAAE,aAAa,EAAE,sBAAsB,EAAE,gBAAgB,EAAE,gBAAgB,EAAE,GAAG,IAAI,EAAE,GAAG,KAAK,CAAC;IACnH,OAAO,OAAO,CAAC;QACb,GAAG,IAAI;QACP,GAAG,kBAAkB,CAAC,EAAE,YAAY,EAAE,aAAa,EAAE,sBAAsB,EAAE,gBAAgB,EAAE,gBAAgB,EAAE,CAAC;KACnH,CAAC,CAAC;AACL,CAAC;AAED;;;;;;;;;;;;;GAaG;AACH,MAAM,UAAU,6BAA6B,CAAC,KAAwD;IACpG,MAAM,EAAE,YAAY,EAAE,aAAa,EAAE,sBAAsB,EAAE,gBAAgB,EAAE,gBAAgB,EAAE,GAAG,IAAI,EAAE,GAAG,KAAK,CAAC;IACnH,OAAO,uBAAuB,CAAC;QAC7B,GAAG,IAAI;QACP,GAAG,kBAAkB,CAAC,EAAE,YAAY,EAAE,aAAa,EAAE,sBAAsB,EAAE,gBAAgB,EAAE,gBAAgB,EAAE,CAAC;KACnH,CAAC,CAAC;AACL,CAAC;AAED,SAAS,kBAAkB,CACzB,KAAsI;IAEtI,MAAM,EAAE,YAAY,EAAE,aAAa,EAAE,sBAAsB,EAAE,gBAAgB,EAAE,gBAAgB,EAAE,GAAG,KAAK,CAAC;IAC1G,OAAO;QACL,oBAAoB,EAAE,WAAW,CAC/B,GAAG,EAAE,CACH,6BAA6B,CAAC;YAC5B,YAAY;YACZ,aAAa;YACb,mBAAmB,EAAE,sBAAsB,CAAC,EAAE,YAAY,EAAE,CAAC;YAC7D,gBAAgB;SACjB,CAAC,EACJ,CAAC,YAAY,EAAE,aAAa,EAAE,sBAAsB,EAAE,gBAAgB,CAAC,CACxE;QACD,gBAAgB,EAAE,WAAW,CAAC,KAAK,IAAI,EAAE,CAAC,gBAAgB,EAAE,CAAC,EAAE,YAAY,EAAE,CAAC,EAAE,CAAC,YAAY,EAAE,gBAAgB,CAAC,CAAC;KAClH,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 } from \"react\";\nimport { createIModelHierarchyProvider, HierarchyDefinition, HierarchyFilteringPath } from \"@itwin/presentation-hierarchies\";\nimport { UseUnifiedTreeSelectionProps } from \"./internal/UseUnifiedSelection\";\nimport { useTree, UseTreeProps, UseTreeResult, useUnifiedSelectionTree } from \"./UseTree\";\n\n/** @beta */\ntype IModelHierarchyProviderProps = Parameters<typeof createIModelHierarchyProvider>[0];\n\n/** @beta */\ntype IModelAccess = IModelHierarchyProviderProps[\"imodelAccess\"];\n\n/**\n * Props for `useIModelTree` and `useIModelUnifiedSelectionTree` hooks.\n * @beta\n */\ntype UseIModelTreeProps = Omit<UseTreeProps, \"getHierarchyProvider\" | \"getFilteredPaths\"> &\n  Pick<IModelHierarchyProviderProps, \"localizedStrings\" | \"imodelAccess\" | \"imodelChanged\"> & {\n    /** Provides the hierarchy definition for the tree. */\n    getHierarchyDefinition: (props: { imodelAccess: IModelAccess }) => HierarchyDefinition;\n\n    /** Provides paths to filtered nodes. */\n    getFilteredPaths?: (props: {\n      /** Object that provides access to the iModel schema and can run queries against the iModel. */\n      imodelAccess: IModelAccess;\n    }) => Promise<HierarchyFilteringPath[] | undefined>;\n  };\n\n/**\n * A React hook that creates state for a tree component whose displayed hierarchy is based on\n * iModel data.\n *\n * The hook uses `@itwin/presentation-hierarchies` package to load the hierarchy data and returns a\n * component-agnostic result which may be used to render the hierarchy using any UI framework.\n *\n * See `README.md` for an example\n *\n * @see `useTree`\n * @see `useIModelUnifiedSelectionTree`\n * @beta\n */\nexport function useIModelTree(props: UseIModelTreeProps): UseTreeResult {\n  const { imodelAccess, imodelChanged, getHierarchyDefinition, getFilteredPaths, localizedStrings, ...rest } = props;\n  return useTree({\n    ...rest,\n    ...useIModelTreeProps({ imodelAccess, imodelChanged, getHierarchyDefinition, getFilteredPaths, localizedStrings }),\n  });\n}\n\n/**\n * A React hook that creates state for a tree component whose displayed hierarchy is based on\n * iModel data and that is integrated with unified selection through context provided by `UnifiedSelectionProvider`.\n *\n * The hook uses `@itwin/presentation-hierarchies` package to load the hierarchy data and returns a\n * component-agnostic result which may be used to render the hierarchy using any UI framework.\n *\n * See `README.md` for an example\n *\n * @see `useIModelTree`\n * @see `useUnifiedSelectionTree`\n * @see `UnifiedSelectionProvider`\n * @beta\n */\nexport function useIModelUnifiedSelectionTree(props: UseIModelTreeProps & UseUnifiedTreeSelectionProps): UseTreeResult {\n  const { imodelAccess, imodelChanged, getHierarchyDefinition, getFilteredPaths, localizedStrings, ...rest } = props;\n  return useUnifiedSelectionTree({\n    ...rest,\n    ...useIModelTreeProps({ imodelAccess, imodelChanged, getHierarchyDefinition, getFilteredPaths, localizedStrings }),\n  });\n}\n\nfunction useIModelTreeProps(\n  props: Pick<UseIModelTreeProps, \"imodelAccess\" | \"imodelChanged\" | \"getHierarchyDefinition\" | \"getFilteredPaths\" | \"localizedStrings\">,\n): Pick<UseTreeProps, \"getHierarchyProvider\" | \"getFilteredPaths\"> {\n  const { imodelAccess, imodelChanged, getHierarchyDefinition, getFilteredPaths, localizedStrings } = props;\n  return {\n    getHierarchyProvider: useCallback(\n      () =>\n        createIModelHierarchyProvider({\n          imodelAccess,\n          imodelChanged,\n          hierarchyDefinition: getHierarchyDefinition({ imodelAccess }),\n          localizedStrings,\n        }),\n      [imodelAccess, imodelChanged, getHierarchyDefinition, localizedStrings],\n    ),\n    getFilteredPaths: useCallback(async () => getFilteredPaths?.({ imodelAccess }), [imodelAccess, getFilteredPaths]),\n  };\n}\n"]}

package/lib/esm/presentation-hierarchies-react/UseTree.d.ts

@@ -1,5 +1,5 @@
-import { createHierarchyProvider, GenericInstanceFilter, HierarchyDefinition, HierarchyNode, LimitingECSqlQueryExecutor } from "@itwin/presentation-hierarchies";
-import { ECClassHierarchyInspector, ECSchemaProvider, InstanceKey, IPrimitiveValueFormatter } from "@itwin/presentation-shared";
+import { GenericInstanceFilter, HierarchyFilteringPath, HierarchyNode, HierarchyProvider } from "@itwin/presentation-hierarchies";
+import { InstanceKey, IPrimitiveValueFormatter } from "@itwin/presentation-shared";
 import { UseUnifiedTreeSelectionProps } from "./internal/UseUnifiedSelection";
 import { PresentationTreeNode } from "./TreeNode";
 import { SelectionChangeType } from "./UseSelectionHandler";
@@ -33,6 +33,7 @@ export interface HierarchyLevelDetails {
  * See `README.md` for an example
  *
  * @see `useUnifiedSelectionTree`
+ * @see `useIModelTree`
  * @beta
  */
 export declare function useTree(props: UseTreeProps): UseTreeResult;
@@ -46,31 +47,17 @@ export declare function useTree(props: UseTreeProps): UseTreeResult;
  * See `README.md` for an example
  *
  * @see `useTree`
+ * @see `useIModelUnifiedSelectionTree`
  * @see `UnifiedSelectionProvider`
  * @beta
  */
-export declare function useUnifiedSelectionTree({ imodelKey, sourceName, ...props }: UseTreeProps & UseUnifiedTreeSelectionProps): UseTreeResult;
+export declare function useUnifiedSelectionTree({ sourceName, ...props }: UseTreeProps & UseUnifiedTreeSelectionProps): UseTreeResult;
 /** @beta */
-type IModelAccess = ECSchemaProvider & LimitingECSqlQueryExecutor & ECClassHierarchyInspector;
-/** @beta */
-interface GetFilteredPathsProps {
-    /** Object that provides access to the iModel schema and can run queries against the iModel. */
-    imodelAccess: IModelAccess;
-}
-/** @beta */
-type HierarchyProviderProps = Parameters<typeof createHierarchyProvider>[0];
-/** @beta */
-type HierarchyFilteringPaths = NonNullable<NonNullable<HierarchyProviderProps["filtering"]>["paths"]>;
-/** @beta */
-interface UseTreeProps extends Pick<HierarchyProviderProps, "localizedStrings"> {
-    /** Object that provides access to the iModel schema and can run queries against the iModel. */
-    imodelAccess: ECSchemaProvider & LimitingECSqlQueryExecutor & ECClassHierarchyInspector;
-    /** Provides the hierarchy definition for the tree. */
-    getHierarchyDefinition: (props: {
-        imodelAccess: IModelAccess;
-    }) => HierarchyDefinition;
+export interface UseTreeProps {
+    /** Provides the hierarchy provider for the tree. */
+    getHierarchyProvider: () => HierarchyProvider;
     /** Provides paths to filtered nodes. */
-    getFilteredPaths?: (props: GetFilteredPathsProps) => Promise<HierarchyFilteringPaths | undefined>;
+    getFilteredPaths?: () => Promise<HierarchyFilteringPath[] | undefined>;
     /**
      * Callback that is called just after a certain action is finished.
      * Can be used for performance tracking.
@@ -88,8 +75,13 @@ interface UseTreeProps extends Pick<HierarchyProviderProps, "localizedStrings">
         type: "timeout" | "unknown";
     }) => void;
 }
-/** @beta */
-interface ReloadTreeCommonOptions {
+/**
+ * Options for doing either full or a sub tree reload.
+ * @beta
+ */
+interface ReloadTreeOptions {
+    /** Specifies parent node under which sub tree should be reloaded. */
+    parentNodeId: string | undefined;
     /**
      * Specifies how current tree state should be handled:
      * - `keep` - try to keep current tree state (expanded/collapsed nodes, instance filters, etc.).
@@ -100,29 +92,8 @@ interface ReloadTreeCommonOptions {
      */
     state?: "keep" | "discard" | "reset";
 }
-/**
- * Options for full tree reload.
- * @beta
- */
-type FullTreeReloadOptions = {
-    /** Specifies that data source changed and caches should be cleared before reloading tree. */
-    dataSourceChanged?: true;
-} & ReloadTreeCommonOptions;
-/**
- * Options for subtree reload.
- * @beta
- */
-type SubtreeReloadOptions = {
-    /** Specifies parent node under which sub tree should be reloaded. */
-    parentNodeId: string;
-} & ReloadTreeCommonOptions;
-/**
- * Options for doing either full or a sub tree reload.
- * @beta
- */
-type ReloadTreeOptions = FullTreeReloadOptions | SubtreeReloadOptions;
 /** @beta */
-interface UseTreeResult {
+export interface UseTreeResult {
     /**
      * Array containing root tree nodes. It is `undefined` on initial render until any nodes are loaded.
      */

package/lib/esm/presentation-hierarchies-react/UseTree.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"UseTree.d.ts","sourceRoot":"","sources":["../../../src/presentation-hierarchies-react/UseTree.ts"],"names":[],"mappings":"AAMA,OAAO,EACL,uBAAuB,EACvB,qBAAqB,EACrB,mBAAmB,EACnB,aAAa,EAEb,0BAA0B,EAC3B,MAAM,iCAAiC,CAAC;AACzC,OAAO,EAAE,yBAAyB,EAAE,gBAAgB,EAAE,WAAW,EAAE,wBAAwB,EAAE,MAAM,4BAA4B,CAAC;AAGhI,OAAO,EAA2B,4BAA4B,EAAE,MAAM,gCAAgC,CAAC;AACvG,OAAO,EAA6B,oBAAoB,EAAE,MAAM,YAAY,CAAC;AAC7E,OAAO,EAAE,mBAAmB,EAAE,MAAM,uBAAuB,CAAC;AAE5D;;;GAGG;AACH,MAAM,WAAW,qBAAqB;IACpC,8FAA8F;IAC9F,aAAa,EAAE,aAAa,GAAG,SAAS,CAAC;IAEzC,8DAA8D;IAC9D,uBAAuB,EAAE,CAAC,KAAK,CAAC,EAAE;QAChC,cAAc,CAAC,EAAE,qBAAqB,CAAC;QACvC,uBAAuB,CAAC,EAAE,MAAM,GAAG,WAAW,CAAC;KAChD,KAAK,qBAAqB,CAAC,WAAW,CAAC,CAAC;IAEzC,6EAA6E;IAC7E,SAAS,CAAC,EAAE,MAAM,GAAG,WAAW,CAAC;IACjC,6EAA6E;IAC7E,YAAY,EAAE,CAAC,KAAK,EAAE,SAAS,GAAG,MAAM,GAAG,WAAW,KAAK,IAAI,CAAC;IAEhE,sEAAsE;IACtE,cAAc,CAAC,EAAE,qBAAqB,CAAC;IACvC,+DAA+D;IAC/D,iBAAiB,EAAE,CAAC,MAAM,EAAE,qBAAqB,GAAG,SAAS,KAAK,IAAI,CAAC;CACxE;AAED;;;;;;;;;;GAUG;AACH,wBAAgB,OAAO,CAAC,KAAK,EAAE,YAAY,GAAG,aAAa,CAG1D;AAED;;;;;;;;;;;;GAYG;AACH,wBAAgB,uBAAuB,CAAC,EAAE,SAAS,EAAE,UAAU,EAAE,GAAG,KAAK,EAAE,EAAE,YAAY,GAAG,4BAA4B,GAAG,aAAa,CAGvI;AAED,YAAY;AACZ,KAAK,YAAY,GAAG,gBAAgB,GAAG,0BAA0B,GAAG,yBAAyB,CAAC;AAE9F,YAAY;AACZ,UAAU,qBAAqB;IAC7B,+FAA+F;IAC/F,YAAY,EAAE,YAAY,CAAC;CAC5B;AAED,YAAY;AACZ,KAAK,sBAAsB,GAAG,UAAU,CAAC,OAAO,uBAAuB,CAAC,CAAC,CAAC,CAAC,CAAC;AAE5E,YAAY;AACZ,KAAK,uBAAuB,GAAG,WAAW,CAAC,WAAW,CAAC,sBAAsB,CAAC,WAAW,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC;AAEtG,YAAY;AACZ,UAAU,YAAa,SAAQ,IAAI,CAAC,sBAAsB,EAAE,kBAAkB,CAAC;IAC7E,+FAA+F;IAC/F,YAAY,EAAE,gBAAgB,GAAG,0BAA0B,GAAG,yBAAyB,CAAC;IACxF,sDAAsD;IACtD,sBAAsB,EAAE,CAAC,KAAK,EAAE;QAAE,YAAY,EAAE,YAAY,CAAA;KAAE,KAAK,mBAAmB,CAAC;IACvF,wCAAwC;IACxC,gBAAgB,CAAC,EAAE,CAAC,KAAK,EAAE,qBAAqB,KAAK,OAAO,CAAC,uBAAuB,GAAG,SAAS,CAAC,CAAC;IAClG;;;OAGG;IACH,qBAAqB,CAAC,EAAE,CAAC,MAAM,EAAE,cAAc,GAAG,sBAAsB,GAAG,QAAQ,EAAE,QAAQ,EAAE,MAAM,KAAK,IAAI,CAAC;IAC/G,2FAA2F;IAC3F,wBAAwB,CAAC,EAAE,CAAC,KAAK,EAAE;QAAE,QAAQ,CAAC,EAAE,MAAM,CAAC;QAAC,MAAM,CAAC,EAAE,qBAAqB,CAAC;QAAC,KAAK,CAAC,EAAE,MAAM,GAAG,WAAW,CAAA;KAAE,KAAK,IAAI,CAAC;IAChI,sEAAsE;IACtE,oBAAoB,CAAC,EAAE,CAAC,KAAK,EAAE;QAAE,QAAQ,CAAC,EAAE,MAAM,CAAC;QAAC,IAAI,EAAE,SAAS,GAAG,SAAS,CAAA;KAAE,KAAK,IAAI,CAAC;CAC5F;AAED,YAAY;AACZ,UAAU,uBAAuB;IAC/B;;;;;;;OAOG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,SAAS,GAAG,OAAO,CAAC;CACtC;AAED;;;GAGG;AACH,KAAK,qBAAqB,GAAG;IAC3B,6FAA6F;IAC7F,iBAAiB,CAAC,EAAE,IAAI,CAAC;CAC1B,GAAG,uBAAuB,CAAC;AAE5B;;;GAGG;AACH,KAAK,oBAAoB,GAAG;IAC1B,qEAAqE;IACrE,YAAY,EAAE,MAAM,CAAC;CACtB,GAAG,uBAAuB,CAAC;AAE5B;;;GAGG;AACH,KAAK,iBAAiB,GAAG,qBAAqB,GAAG,oBAAoB,CAAC;AAEtE,YAAY;AACZ,UAAU,aAAa;IACrB;;OAEG;IACH,SAAS,EAAE,oBAAoB,EAAE,GAAG,SAAS,CAAC;IAC9C;;;OAGG;IACH,SAAS,EAAE,OAAO,CAAC;IACnB;;OAEG;IACH,UAAU,EAAE,CAAC,OAAO,CAAC,EAAE,iBAAiB,KAAK,IAAI,CAAC;IAClD;;OAEG;IACH,UAAU,EAAE,CAAC,MAAM,EAAE,MAAM,EAAE,UAAU,EAAE,OAAO,KAAK,IAAI,CAAC;IAC1D;;;;OAIG;IACH,WAAW,EAAE,CAAC,OAAO,EAAE,KAAK,CAAC,MAAM,CAAC,EAAE,UAAU,EAAE,mBAAmB,KAAK,IAAI,CAAC;IAC/E,mDAAmD;IACnD,cAAc,EAAE,CAAC,MAAM,EAAE,MAAM,KAAK,OAAO,CAAC;IAC5C,2DAA2D;IAC3D,wBAAwB,EAAE,CAAC,MAAM,EAAE,MAAM,GAAG,SAAS,KAAK,qBAAqB,GAAG,SAAS,CAAC;IAC5F,qFAAqF;IACrF,YAAY,EAAE,CAAC,SAAS,EAAE,wBAAwB,GAAG,SAAS,KAAK,IAAI,CAAC;CACzE"}
+{"version":3,"file":"UseTree.d.ts","sourceRoot":"","sources":["../../../src/presentation-hierarchies-react/UseTree.ts"],"names":[],"mappings":"AAOA,OAAO,EAAE,qBAAqB,EAAE,sBAAsB,EAAE,aAAa,EAAE,iBAAiB,EAAE,MAAM,iCAAiC,CAAC;AAClI,OAAO,EAAE,WAAW,EAAE,wBAAwB,EAAE,MAAM,4BAA4B,CAAC;AAGnF,OAAO,EAA2B,4BAA4B,EAAE,MAAM,gCAAgC,CAAC;AACvG,OAAO,EAA6B,oBAAoB,EAAE,MAAM,YAAY,CAAC;AAC7E,OAAO,EAAE,mBAAmB,EAAE,MAAM,uBAAuB,CAAC;AAE5D;;;GAGG;AACH,MAAM,WAAW,qBAAqB;IACpC,8FAA8F;IAC9F,aAAa,EAAE,aAAa,GAAG,SAAS,CAAC;IAEzC,8DAA8D;IAC9D,uBAAuB,EAAE,CAAC,KAAK,CAAC,EAAE;QAChC,cAAc,CAAC,EAAE,qBAAqB,CAAC;QACvC,uBAAuB,CAAC,EAAE,MAAM,GAAG,WAAW,CAAC;KAChD,KAAK,qBAAqB,CAAC,WAAW,CAAC,CAAC;IAEzC,6EAA6E;IAC7E,SAAS,CAAC,EAAE,MAAM,GAAG,WAAW,CAAC;IACjC,6EAA6E;IAC7E,YAAY,EAAE,CAAC,KAAK,EAAE,SAAS,GAAG,MAAM,GAAG,WAAW,KAAK,IAAI,CAAC;IAEhE,sEAAsE;IACtE,cAAc,CAAC,EAAE,qBAAqB,CAAC;IACvC,+DAA+D;IAC/D,iBAAiB,EAAE,CAAC,MAAM,EAAE,qBAAqB,GAAG,SAAS,KAAK,IAAI,CAAC;CACxE;AAED;;;;;;;;;;;GAWG;AACH,wBAAgB,OAAO,CAAC,KAAK,EAAE,YAAY,GAAG,aAAa,CAG1D;AAED;;;;;;;;;;;;;GAaG;AACH,wBAAgB,uBAAuB,CAAC,EAAE,UAAU,EAAE,GAAG,KAAK,EAAE,EAAE,YAAY,GAAG,4BAA4B,GAAG,aAAa,CAG5H;AAED,YAAY;AACZ,MAAM,WAAW,YAAY;IAC3B,oDAAoD;IACpD,oBAAoB,EAAE,MAAM,iBAAiB,CAAC;IAC9C,wCAAwC;IACxC,gBAAgB,CAAC,EAAE,MAAM,OAAO,CAAC,sBAAsB,EAAE,GAAG,SAAS,CAAC,CAAC;IACvE;;;OAGG;IACH,qBAAqB,CAAC,EAAE,CAAC,MAAM,EAAE,cAAc,GAAG,sBAAsB,GAAG,QAAQ,EAAE,QAAQ,EAAE,MAAM,KAAK,IAAI,CAAC;IAC/G,2FAA2F;IAC3F,wBAAwB,CAAC,EAAE,CAAC,KAAK,EAAE;QAAE,QAAQ,CAAC,EAAE,MAAM,CAAC;QAAC,MAAM,CAAC,EAAE,qBAAqB,CAAC;QAAC,KAAK,CAAC,EAAE,MAAM,GAAG,WAAW,CAAA;KAAE,KAAK,IAAI,CAAC;IAChI,sEAAsE;IACtE,oBAAoB,CAAC,EAAE,CAAC,KAAK,EAAE;QAAE,QAAQ,CAAC,EAAE,MAAM,CAAC;QAAC,IAAI,EAAE,SAAS,GAAG,SAAS,CAAA;KAAE,KAAK,IAAI,CAAC;CAC5F;AAED;;;GAGG;AACH,UAAU,iBAAiB;IACzB,qEAAqE;IACrE,YAAY,EAAE,MAAM,GAAG,SAAS,CAAC;IAEjC;;;;;;;OAOG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,SAAS,GAAG,OAAO,CAAC;CACtC;AAED,YAAY;AACZ,MAAM,WAAW,aAAa;IAC5B;;OAEG;IACH,SAAS,EAAE,oBAAoB,EAAE,GAAG,SAAS,CAAC;IAC9C;;;OAGG;IACH,SAAS,EAAE,OAAO,CAAC;IACnB;;OAEG;IACH,UAAU,EAAE,CAAC,OAAO,CAAC,EAAE,iBAAiB,KAAK,IAAI,CAAC;IAClD;;OAEG;IACH,UAAU,EAAE,CAAC,MAAM,EAAE,MAAM,EAAE,UAAU,EAAE,OAAO,KAAK,IAAI,CAAC;IAC1D;;;;OAIG;IACH,WAAW,EAAE,CAAC,OAAO,EAAE,KAAK,CAAC,MAAM,CAAC,EAAE,UAAU,EAAE,mBAAmB,KAAK,IAAI,CAAC;IAC/E,mDAAmD;IACnD,cAAc,EAAE,CAAC,MAAM,EAAE,MAAM,KAAK,OAAO,CAAC;IAC5C,2DAA2D;IAC3D,wBAAwB,EAAE,CAAC,MAAM,EAAE,MAAM,GAAG,SAAS,KAAK,qBAAqB,GAAG,SAAS,CAAC;IAC5F,qFAAqF;IACrF,YAAY,EAAE,CAAC,SAAS,EAAE,wBAAwB,GAAG,SAAS,KAAK,IAAI,CAAC;CACzE"}

package/lib/esm/presentation-hierarchies-react/UseTree.js

@@ -3,7 +3,8 @@
  * See LICENSE.md in the project root for license terms and full copyright notice.
  *--------------------------------------------------------------------------------------------*/
 import { useCallback, useEffect, useRef, useState } from "react";
-import { createHierarchyProvider, HierarchyNode, } from "@itwin/presentation-hierarchies";
+import { isIDisposable } from "@itwin/core-bentley";
+import { HierarchyNode } from "@itwin/presentation-hierarchies";
 import { TreeActions } from "./internal/TreeActions";
 import { isTreeModelHierarchyNode, isTreeModelInfoNode, TreeModel } from "./internal/TreeModel";
 import { useUnifiedTreeSelection } from "./internal/UseUnifiedSelection";
@@ -16,6 +17,7 @@ import { useUnifiedTreeSelection } from "./internal/UseUnifiedSelection";
  * See `README.md` for an example
  *
  * @see `useUnifiedSelectionTree`
+ * @see `useIModelTree`
  * @beta
  */
 export function useTree(props) {
@@ -32,19 +34,19 @@ export function useTree(props) {
  * See `README.md` for an example
  *
  * @see `useTree`
+ * @see `useIModelUnifiedSelectionTree`
  * @see `UnifiedSelectionProvider`
  * @beta
  */
-export function useUnifiedSelectionTree({ imodelKey, sourceName, ...props }) {
+export function useUnifiedSelectionTree({ sourceName, ...props }) {
     const { getNode, ...rest } = useTreeInternal(props);
-    return { ...rest, ...useUnifiedTreeSelection({ imodelKey, sourceName, getNode }) };
+    return { ...rest, ...useUnifiedTreeSelection({ sourceName, getNode }) };
 }
-function useTreeInternal({ imodelAccess, getHierarchyDefinition, getFilteredPaths, localizedStrings, onPerformanceMeasured, onHierarchyLimitExceeded, onHierarchyLoadError, }) {
+function useTreeInternal({ getHierarchyProvider, getFilteredPaths, onPerformanceMeasured, onHierarchyLimitExceeded, onHierarchyLoadError, }) {
     const [state, setState] = useState({
         model: { idToNode: new Map(), parentChildMap: new Map(), rootNode: { id: undefined, nodeData: undefined } },
         rootNodes: undefined,
     });
-    const [hierarchySource, setHierarchySource] = useState({ isFiltering: false });
     const onPerformanceMeasuredRef = useLatest(onPerformanceMeasured);
     const onHierarchyLimitExceededRef = useLatest(onHierarchyLimitExceeded);
     const onHierarchyLoadErrorRef = useLatest(onHierarchyLoadError);
@@ -56,51 +58,52 @@ function useTreeInternal({ imodelAccess, getHierarchyDefinition, getFilteredPath
         });
     }, (actionType, duration) => onPerformanceMeasuredRef.current?.(actionType, duration), (props) => onHierarchyLimitExceededRef.current?.(props), (props) => onHierarchyLoadErrorRef.current?.(props)));
     const currentFormatter = useRef();
+    const [hierarchyProvider, setHierarchyProvider] = useState();
     useEffect(() => {
-        const updateHierarchyProvider = (provider, filtered) => {
-            actions.setHierarchyProvider(provider);
-            actions.reloadTree({ state: filtered ? "discard" : "keep" });
-            setHierarchySource({ hierarchyProvider: provider, isFiltering: false });
-        };
-        const createProvider = (paths) => {
-            return createHierarchyProvider({
-                imodelAccess,
-                hierarchyDefinition: getHierarchyDefinition({ imodelAccess }),
-                localizedStrings,
-                formatter: currentFormatter.current,
-                filtering: paths !== undefined
-                    ? {
-                        paths,
-                    }
-                    : undefined,
-            });
+        const provider = getHierarchyProvider();
+        provider.setFormatter(currentFormatter.current);
+        const removeHierarchyChangedListener = provider.hierarchyChanged.addListener(() => actions.reloadTree());
+        actions.setHierarchyProvider(provider);
+        actions.reloadTree({ state: "keep" });
+        setHierarchyProvider(provider);
+        return () => {
+            removeHierarchyChangedListener();
+            actions.dispose();
+            if (isIDisposable(provider)) {
+                provider.dispose();
+            }
+            setHierarchyProvider(undefined);
         };
-        const loadHierarchyProvider = async () => {
-            if (!getFilteredPaths) {
-                return { provider: createProvider(undefined), filtered: false };
+    }, [actions, getHierarchyProvider]);
+    const [isFiltering, setIsFiltering] = useState(false);
+    useEffect(() => {
+        let disposed = false;
+        void (async () => {
+            if (!getFilteredPaths || !hierarchyProvider) {
+                hierarchyProvider?.setHierarchyFilter(undefined);
+                actions.reloadTree({ state: "keep" });
+                setIsFiltering(false);
+                return;
             }
-            setHierarchySource((prev) => ({ ...prev, isFiltering: true }));
+            setIsFiltering(true);
+            let paths;
             try {
-                const filteredPaths = await getFilteredPaths({ imodelAccess });
-                return { provider: createProvider(filteredPaths), filtered: filteredPaths !== undefined };
+                paths = await getFilteredPaths();
             }
             catch {
-                return { provider: createProvider(undefined), filtered: false };
             }
-        };
-        let disposed = false;
-        void (async () => {
-            const { provider, filtered } = await loadHierarchyProvider();
-            if (disposed) {
-                return;
+            finally {
+                if (!disposed) {
+                    hierarchyProvider.setHierarchyFilter(paths ? { paths } : undefined);
+                    actions.reloadTree({ state: paths ? "discard" : "keep" });
+                }
+                setIsFiltering(false);
             }
-            updateHierarchyProvider(provider, filtered);
         })();
         return () => {
             disposed = true;
-            actions.dispose();
         };
-    }, [actions, imodelAccess, localizedStrings, getHierarchyDefinition, getFilteredPaths]);
+    }, [actions, hierarchyProvider, getFilteredPaths]);
     const getNode = useCallback((nodeId) => {
         return actions.getNode(nodeId);
     }, [actions]);
@@ -108,11 +111,8 @@ function useTreeInternal({ imodelAccess, getHierarchyDefinition, getFilteredPath
         actions.expandNode(nodeId, isExpanded);
     }, [actions]);
     const reloadTree = useCallback((options) => {
-        if (options && "dataSourceChanged" in options) {
-            hierarchySource.hierarchyProvider?.notifyDataSourceChanged();
-        }
         actions.reloadTree(options);
-    }, [actions, hierarchySource]);
+    }, [actions]);
     const selectNodes = useCallback((nodeIds, changeType) => {
         actions.selectNodes(nodeIds, changeType);
     }, [actions]);
@@ -120,15 +120,14 @@ function useTreeInternal({ imodelAccess, getHierarchyDefinition, getFilteredPath
     const setFormatter = useCallback((formatter) => {
         currentFormatter.current = formatter;
         // istanbul ignore if
-        if (!hierarchySource.hierarchyProvider) {
+        if (!hierarchyProvider) {
             return;
         }
-        hierarchySource.hierarchyProvider.setFormatter(formatter);
+        hierarchyProvider.setFormatter(formatter);
         actions.reloadTree();
-    }, [hierarchySource.hierarchyProvider, actions]);
+    }, [hierarchyProvider, actions]);
     const getHierarchyLevelDetails = useCallback((nodeId) => {
         const node = actions.getNode(nodeId);
-        const hierarchyProvider = hierarchySource.hierarchyProvider;
         if (!hierarchyProvider || !node || isTreeModelInfoNode(node)) {
             return undefined;
         }
@@ -148,10 +147,10 @@ function useTreeInternal({ imodelAccess, getHierarchyDefinition, getFilteredPath
             sizeLimit: node.hierarchyLimit,
             setSizeLimit: (value) => actions.setHierarchyLimit(nodeId, value),
         };
-    }, [actions, hierarchySource.hierarchyProvider]);
+    }, [actions, hierarchyProvider]);
     return {
         rootNodes: state.rootNodes,
-        isLoading: !!state.model.rootNode.isLoading || hierarchySource.isFiltering,
+        isLoading: !!state.model.rootNode.isLoading || isFiltering,
         expandNode,
         reloadTree,
         selectNodes,

package/lib/esm/presentation-hierarchies-react/UseTree.js.map

@@ -1 +1 @@
-{"version":3,"file":"UseTree.js","sourceRoot":"","sources":["../../../src/presentation-hierarchies-react/UseTree.ts"],"names":[],"mappings":"AAAA;;;gGAGgG;AAEhG,OAAO,EAAE,WAAW,EAAE,SAAS,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,OAAO,CAAC;AACjE,OAAO,EACL,uBAAuB,EAGvB,aAAa,GAGd,MAAM,iCAAiC,CAAC;AAEzC,OAAO,EAAE,WAAW,EAAE,MAAM,wBAAwB,CAAC;AACrD,OAAO,EAAE,wBAAwB,EAAE,mBAAmB,EAAE,SAAS,EAA4D,MAAM,sBAAsB,CAAC;AAC1J,OAAO,EAAE,uBAAuB,EAAgC,MAAM,gCAAgC,CAAC;AA6BvG;;;;;;;;;;GAUG;AACH,MAAM,UAAU,OAAO,CAAC,KAAmB;IACzC,MAAM,EAAE,OAAO,EAAE,CAAC,EAAE,GAAG,IAAI,EAAE,GAAG,eAAe,CAAC,KAAK,CAAC,CAAC;IACvD,OAAO,IAAI,CAAC;AACd,CAAC;AAED;;;;;;;;;;;;GAYG;AACH,MAAM,UAAU,uBAAuB,CAAC,EAAE,SAAS,EAAE,UAAU,EAAE,GAAG,KAAK,EAA+C;IACtH,MAAM,EAAE,OAAO,EAAE,GAAG,IAAI,EAAE,GAAG,eAAe,CAAC,KAAK,CAAC,CAAC;IACpD,OAAO,EAAE,GAAG,IAAI,EAAE,GAAG,uBAAuB,CAAC,EAAE,SAAS,EAAE,UAAU,EAAE,OAAO,EAAE,CAAC,EAAE,CAAC;AACrF,CAAC;AA+GD,SAAS,eAAe,CAAC,EACvB,YAAY,EACZ,sBAAsB,EACtB,gBAAgB,EAChB,gBAAgB,EAChB,qBAAqB,EACrB,wBAAwB,EACxB,oBAAoB,GACP;IACb,MAAM,CAAC,KAAK,EAAE,QAAQ,CAAC,GAAG,QAAQ,CAAY;QAC5C,KAAK,EAAE,EAAE,QAAQ,EAAE,IAAI,GAAG,EAAE,EAAE,cAAc,EAAE,IAAI,GAAG,EAAE,EAAE,QAAQ,EAAE,EAAE,EAAE,EAAE,SAAS,EAAE,QAAQ,EAAE,SAAS,EAAE,EAAE;QAC3G,SAAS,EAAE,SAAS;KACrB,CAAC,CAAC;IACH,MAAM,CAAC,eAAe,EAAE,kBAAkB,CAAC,GAAG,QAAQ,CAAkE,EAAE,WAAW,EAAE,KAAK,EAAE,CAAC,CAAC;IAChJ,MAAM,wBAAwB,GAAG,SAAS,CAAC,qBAAqB,CAAC,CAAC;IAClE,MAAM,2BAA2B,GAAG,SAAS,CAAC,wBAAwB,CAAC,CAAC;IACxE,MAAM,uBAAuB,GAAG,SAAS,CAAC,oBAAoB,CAAC,CAAC;IAEhE,MAAM,CAAC,OAAO,CAAC,GAAG,QAAQ,CACxB,GAAG,EAAE,CACH,IAAI,WAAW,CACb,CAAC,KAAK,EAAE,EAAE;QACR,MAAM,SAAS,GAAG,KAAK,CAAC,cAAc,CAAC,GAAG,CAAC,SAAS,CAAC,KAAK,SAAS,CAAC,CAAC,CAAC,qBAAqB,CAAC,SAAS,EAAE,KAAK,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;QAC1H,QAAQ,CAAC;YACP,KAAK;YACL,SAAS;SACV,CAAC,CAAC;IACL,CAAC,EACD,CAAC,UAAU,EAAE,QAAQ,EAAE,EAAE,CAAC,wBAAwB,CAAC,OAAO,EAAE,CAAC,UAAU,EAAE,QAAQ,CAAC,EAClF,CAAC,KAAK,EAAE,EAAE,CAAC,2BAA2B,CAAC,OAAO,EAAE,CAAC,KAAK,CAAC,EACvD,CAAC,KAAK,EAAE,EAAE,CAAC,uBAAuB,CAAC,OAAO,EAAE,CAAC,KAAK,CAAC,CACpD,CACJ,CAAC;IACF,MAAM,gBAAgB,GAAG,MAAM,EAA4B,CAAC;IAE5D,SAAS,CAAC,GAAG,EAAE;QACb,MAAM,uBAAuB,GAAG,CAAC,QAA2B,EAAE,QAAiB,EAAE,EAAE;YACjF,OAAO,CAAC,oBAAoB,CAAC,QAAQ,CAAC,CAAC;YACvC,OAAO,CAAC,UAAU,CAAC,EAAE,KAAK,EAAE,QAAQ,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC;YAC7D,kBAAkB,CAAC,EAAE,iBAAiB,EAAE,QAAQ,EAAE,WAAW,EAAE,KAAK,EAAE,CAAC,CAAC;QAC1E,CAAC,CAAC;QAEF,MAAM,cAAc,GAAG,CAAC,KAA0C,EAAE,EAAE;YACpE,OAAO,uBAAuB,CAAC;gBAC7B,YAAY;gBACZ,mBAAmB,EAAE,sBAAsB,CAAC,EAAE,YAAY,EAAE,CAAC;gBAC7D,gBAAgB;gBAChB,SAAS,EAAE,gBAAgB,CAAC,OAAO;gBACnC,SAAS,EACP,KAAK,KAAK,SAAS;oBACjB,CAAC,CAAC;wBACE,KAAK;qBACN;oBACH,CAAC,CAAC,SAAS;aAChB,CAAC,CAAC;QACL,CAAC,CAAC;QAEF,MAAM,qBAAqB,GAAG,KAAK,IAAI,EAAE;YACvC,IAAI,CAAC,gBAAgB,EAAE,CAAC;gBACtB,OAAO,EAAE,QAAQ,EAAE,cAAc,CAAC,SAAS,CAAC,EAAE,QAAQ,EAAE,KAAK,EAAE,CAAC;YAClE,CAAC;YAED,kBAAkB,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,EAAE,GAAG,IAAI,EAAE,WAAW,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC;YAC/D,IAAI,CAAC;gBACH,MAAM,aAAa,GAAG,MAAM,gBAAgB,CAAC,EAAE,YAAY,EAAE,CAAC,CAAC;gBAC/D,OAAO,EAAE,QAAQ,EAAE,cAAc,CAAC,aAAa,CAAC,EAAE,QAAQ,EAAE,aAAa,KAAK,SAAS,EAAE,CAAC;YAC5F,CAAC;YAAC,MAAM,CAAC;gBACP,OAAO,EAAE,QAAQ,EAAE,cAAc,CAAC,SAAS,CAAC,EAAE,QAAQ,EAAE,KAAK,EAAE,CAAC;YAClE,CAAC;QACH,CAAC,CAAC;QAEF,IAAI,QAAQ,GAAG,KAAK,CAAC;QACrB,KAAK,CAAC,KAAK,IAAI,EAAE;YACf,MAAM,EAAE,QAAQ,EAAE,QAAQ,EAAE,GAAG,MAAM,qBAAqB,EAAE,CAAC;YAC7D,IAAI,QAAQ,EAAE,CAAC;gBACb,OAAO;YACT,CAAC;YACD,uBAAuB,CAAC,QAAQ,EAAE,QAAQ,CAAC,CAAC;QAC9C,CAAC,CAAC,EAAE,CAAC;QAEL,OAAO,GAAG,EAAE;YACV,QAAQ,GAAG,IAAI,CAAC;YAChB,OAAO,CAAC,OAAO,EAAE,CAAC;QACpB,CAAC,CAAC;IACJ,CAAC,EAAE,CAAC,OAAO,EAAE,YAAY,EAAE,gBAAgB,EAAE,sBAAsB,EAAE,gBAAgB,CAAC,CAAC,CAAC;IAExF,MAAM,OAAO,GAAG,WAAW,CACzB,CAAC,MAAc,EAAE,EAAE;QACjB,OAAO,OAAO,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;IACjC,CAAC,EACD,CAAC,OAAO,CAAC,CACV,CAAC;IAEF,MAAM,UAAU,GAAG,WAAW,CAC5B,CAAC,MAAc,EAAE,UAAmB,EAAE,EAAE;QACtC,OAAO,CAAC,UAAU,CAAC,MAAM,EAAE,UAAU,CAAC,CAAC;IACzC,CAAC,EACD,CAAC,OAAO,CAAC,CACV,CAAC;IAEF,MAAM,UAAU,GAAG,WAAW,CAC5B,CAAC,OAAO,EAAE,EAAE;QACV,IAAI,OAAO,IAAI,mBAAmB,IAAI,OAAO,EAAE,CAAC;YAC9C,eAAe,CAAC,iBAAiB,EAAE,uBAAuB,EAAE,CAAC;QAC/D,CAAC;QACD,OAAO,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC;IAC9B,CAAC,EACD,CAAC,OAAO,EAAE,eAAe,CAAC,CAC3B,CAAC;IAEF,MAAM,WAAW,GAAG,WAAW,CAC7B,CAAC,OAAsB,EAAE,UAA+B,EAAE,EAAE;QAC1D,OAAO,CAAC,WAAW,CAAC,OAAO,EAAE,UAAU,CAAC,CAAC;IAC3C,CAAC,EACD,CAAC,OAAO,CAAC,CACV,CAAC;IAEF,MAAM,cAAc,GAAG,WAAW,CAAkC,CAAC,MAAc,EAAE,EAAE,CAAC,SAAS,CAAC,cAAc,CAAC,KAAK,CAAC,KAAK,EAAE,MAAM,CAAC,EAAE,CAAC,KAAK,CAAC,CAAC,CAAC;IAEhJ,MAAM,YAAY,GAAG,WAAW,CAC9B,CAAC,SAA+C,EAAE,EAAE;QAClD,gBAAgB,CAAC,OAAO,GAAG,SAAS,CAAC;QACrC,qBAAqB;QACrB,IAAI,CAAC,eAAe,CAAC,iBAAiB,EAAE,CAAC;YACvC,OAAO;QACT,CAAC;QAED,eAAe,CAAC,iBAAiB,CAAC,YAAY,CAAC,SAAS,CAAC,CAAC;QAC1D,OAAO,CAAC,UAAU,EAAE,CAAC;IACvB,CAAC,EACD,CAAC,eAAe,CAAC,iBAAiB,EAAE,OAAO,CAAC,CAC7C,CAAC;IAEF,MAAM,wBAAwB,GAAG,WAAW,CAC1C,CAAC,MAAM,EAAE,EAAE;QACT,MAAM,IAAI,GAAG,OAAO,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;QACrC,MAAM,iBAAiB,GAAG,eAAe,CAAC,iBAAiB,CAAC;QAC5D,IAAI,CAAC,iBAAiB,IAAI,CAAC,IAAI,IAAI,mBAAmB,CAAC,IAAI,CAAC,EAAE,CAAC;YAC7D,OAAO,SAAS,CAAC;QACnB,CAAC;QACD,MAAM,aAAa,GAAG,IAAI,CAAC,QAAQ,CAAC;QACpC,IAAI,aAAa,IAAI,aAAa,CAAC,cAAc,CAAC,aAAa,CAAC,EAAE,CAAC;YACjE,OAAO,SAAS,CAAC;QACnB,CAAC;QAED,OAAO;YACL,aAAa;YACb,uBAAuB,EAAE,CAAC,KAAK,EAAE,EAAE,CACjC,iBAAiB,CAAC,mBAAmB,CAAC;gBACpC,UAAU,EAAE,aAAa;gBACzB,cAAc,EAAE,KAAK,EAAE,cAAc;gBACrC,uBAAuB,EAAE,KAAK,EAAE,uBAAuB;aACxD,CAAC;YACJ,cAAc,EAAE,IAAI,CAAC,cAAc;YACnC,iBAAiB,EAAE,CAAC,MAAM,EAAE,EAAE,CAAC,OAAO,CAAC,iBAAiB,CAAC,MAAM,EAAE,MAAM,CAAC;YACxE,SAAS,EAAE,IAAI,CAAC,cAAc;YAC9B,YAAY,EAAE,CAAC,KAAK,EAAE,EAAE,CAAC,OAAO,CAAC,iBAAiB,CAAC,MAAM,EAAE,KAAK,CAAC;SAClE,CAAC;IACJ,CAAC,EACD,CAAC,OAAO,EAAE,eAAe,CAAC,iBAAiB,CAAC,CAC7C,CAAC;IAEF,OAAO;QACL,SAAS,EAAE,KAAK,CAAC,SAAS;QAC1B,SAAS,EAAE,CAAC,CAAC,KAAK,CAAC,KAAK,CAAC,QAAQ,CAAC,SAAS,IAAI,eAAe,CAAC,WAAW;QAC1E,UAAU;QACV,UAAU;QACV,WAAW;QACX,cAAc;QACd,OAAO;QACP,wBAAwB;QACxB,YAAY;KACb,CAAC;AACJ,CAAC;AAED,SAAS,qBAAqB,CAAC,YAAgC,EAAE,KAAgB;IAC/E,MAAM,eAAe,GAAG,KAAK,CAAC,cAAc,CAAC,GAAG,CAAC,YAAY,CAAC,CAAC;IAC/D,IAAI,CAAC,eAAe,EAAE,CAAC;QACrB,OAAO,SAAS,CAAC;IACnB,CAAC;IAED,OAAO,eAAe;SACnB,GAAG,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,KAAK,CAAC,QAAQ,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;SAC7C,MAAM,CAAC,CAAC,IAAI,EAAyB,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC;SAC/C,GAAG,CAAuB,CAAC,IAAI,EAAE,EAAE;QAClC,IAAI,wBAAwB,CAAC,IAAI,CAAC,EAAE,CAAC;YACnC,MAAM,QAAQ,GAAG,qBAAqB,CAAC,IAAI,CAAC,EAAE,EAAE,KAAK,CAAC,CAAC;YACvD,OAAO;gBACL,GAAG,+BAA+B,CAAC,IAAI,CAAC;gBACxC,QAAQ,EAAE,QAAQ,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,QAAQ,KAAK,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE;aACnE,CAAC;QACJ,CAAC;QAED,IAAI,IAAI,CAAC,IAAI,KAAK,mBAAmB,EAAE,CAAC;YACtC,OAAO;gBACL,EAAE,EAAE,IAAI,CAAC,EAAE;gBACX,YAAY;gBACZ,IAAI,EAAE,IAAI,CAAC,IAAI;gBACf,kBAAkB,EAAE,IAAI,CAAC,kBAAkB;aAC5C,CAAC;QACJ,CAAC;QAED,IAAI,IAAI,CAAC,IAAI,KAAK,iBAAiB,EAAE,CAAC;YACpC,OAAO;gBACL,EAAE,EAAE,IAAI,CAAC,EAAE;gBACX,YAAY;gBACZ,IAAI,EAAE,IAAI,CAAC,IAAI;aAChB,CAAC;QACJ,CAAC;QAED,OAAO;YACL,EAAE,EAAE,IAAI,CAAC,EAAE;YACX,YAAY;YACZ,IAAI,EAAE,IAAI,CAAC,IAAI;YACf,OAAO,EAAE,IAAI,CAAC,OAAO;SACtB,CAAC;IACJ,CAAC,CAAC,CAAC;AACP,CAAC;AAED,SAAS,+BAA+B,CAAC,IAA4B;IACnE,OAAO;QACL,EAAE,EAAE,IAAI,CAAC,EAAE;QACX,KAAK,EAAE,IAAI,CAAC,KAAK;QACjB,QAAQ,EAAE,IAAI,CAAC,QAAQ;QACvB,SAAS,EAAE,CAAC,CAAC,IAAI,CAAC,SAAS;QAC3B,UAAU,EAAE,CAAC,CAAC,IAAI,CAAC,UAAU;QAC7B,YAAY,EAAE,CAAC,aAAa,CAAC,cAAc,CAAC,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,iBAAiB,IAAI,IAAI,CAAC,QAAQ;QAChH,UAAU,EAAE,CAAC,CAAC,IAAI,CAAC,cAAc;QACjC,YAAY,EAAE,IAAI,CAAC,QAAQ,CAAC,YAAY;KACzC,CAAC;AACJ,CAAC;AAED,SAAS,SAAS,CAAI,KAAQ;IAC5B,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;IAEZ,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 { useCallback, useEffect, useRef, useState } from \"react\";\nimport {\n  createHierarchyProvider,\n  GenericInstanceFilter,\n  HierarchyDefinition,\n  HierarchyNode,\n  HierarchyProvider,\n  LimitingECSqlQueryExecutor,\n} from \"@itwin/presentation-hierarchies\";\nimport { ECClassHierarchyInspector, ECSchemaProvider, InstanceKey, IPrimitiveValueFormatter } from \"@itwin/presentation-shared\";\nimport { TreeActions } from \"./internal/TreeActions\";\nimport { isTreeModelHierarchyNode, isTreeModelInfoNode, TreeModel, TreeModelHierarchyNode, TreeModelNode, TreeModelRootNode } from \"./internal/TreeModel\";\nimport { useUnifiedTreeSelection, UseUnifiedTreeSelectionProps } from \"./internal/UseUnifiedSelection\";\nimport { PresentationHierarchyNode, PresentationTreeNode } from \"./TreeNode\";\nimport { SelectionChangeType } from \"./UseSelectionHandler\";\n\n/**\n * A data structure that contains information about a single hierarchy level.\n * @beta\n */\nexport interface HierarchyLevelDetails {\n  /** The parent node whose hierarchy level's information is contained in this data structure */\n  hierarchyNode: HierarchyNode | undefined;\n\n  /** A function to get instance keys of the hierarchy level. */\n  getInstanceKeysIterator: (props?: {\n    instanceFilter?: GenericInstanceFilter;\n    hierarchyLevelSizeLimit?: number | \"unbounded\";\n  }) => AsyncIterableIterator<InstanceKey>;\n\n  /** Get the limit of how many nodes can be loaded in this hierarchy level. */\n  sizeLimit?: number | \"unbounded\";\n  /** Set the limit of how many nodes can be loaded in this hierarchy level. */\n  setSizeLimit: (value: undefined | number | \"unbounded\") => void;\n\n  /** Get the active instance filter applied to this hierarchy level. */\n  instanceFilter?: GenericInstanceFilter;\n  /** Set the instance filter to apply to this hierarchy level */\n  setInstanceFilter: (filter: GenericInstanceFilter | undefined) => void;\n}\n\n/**\n * A React hook that creates state for a tree component.\n *\n * The hook uses `@itwin/presentation-hierarchies` package to load the hierarchy data and returns a\n * component-agnostic result which may be used to render the hierarchy using any UI framework.\n *\n * See `README.md` for an example\n *\n * @see `useUnifiedSelectionTree`\n * @beta\n */\nexport function useTree(props: UseTreeProps): UseTreeResult {\n  const { getNode: _, ...rest } = useTreeInternal(props);\n  return rest;\n}\n\n/**\n * A React hook that creates state for a tree component, that is integrated with unified selection\n * through context provided by `UnifiedSelectionProvider`.\n *\n * The hook uses `@itwin/presentation-hierarchies` package to load the hierarchy data and returns a\n * component-agnostic result which may be used to render the hierarchy using any UI framework.\n *\n * See `README.md` for an example\n *\n * @see `useTree`\n * @see `UnifiedSelectionProvider`\n * @beta\n */\nexport function useUnifiedSelectionTree({ imodelKey, sourceName, ...props }: UseTreeProps & UseUnifiedTreeSelectionProps): UseTreeResult {\n  const { getNode, ...rest } = useTreeInternal(props);\n  return { ...rest, ...useUnifiedTreeSelection({ imodelKey, sourceName, getNode }) };\n}\n\n/** @beta */\ntype IModelAccess = ECSchemaProvider & LimitingECSqlQueryExecutor & ECClassHierarchyInspector;\n\n/** @beta */\ninterface GetFilteredPathsProps {\n  /** Object that provides access to the iModel schema and can run queries against the iModel. */\n  imodelAccess: IModelAccess;\n}\n\n/** @beta */\ntype HierarchyProviderProps = Parameters<typeof createHierarchyProvider>[0];\n\n/** @beta */\ntype HierarchyFilteringPaths = NonNullable<NonNullable<HierarchyProviderProps[\"filtering\"]>[\"paths\"]>;\n\n/** @beta */\ninterface UseTreeProps extends Pick<HierarchyProviderProps, \"localizedStrings\"> {\n  /** Object that provides access to the iModel schema and can run queries against the iModel. */\n  imodelAccess: ECSchemaProvider & LimitingECSqlQueryExecutor & ECClassHierarchyInspector;\n  /** Provides the hierarchy definition for the tree. */\n  getHierarchyDefinition: (props: { imodelAccess: IModelAccess }) => HierarchyDefinition;\n  /** Provides paths to filtered nodes. */\n  getFilteredPaths?: (props: GetFilteredPathsProps) => Promise<HierarchyFilteringPaths | undefined>;\n  /**\n   * Callback that is called just after a certain action is finished.\n   * Can be used for performance tracking.\n   */\n  onPerformanceMeasured?: (action: \"initial-load\" | \"hierarchy-level-load\" | \"reload\", duration: number) => void;\n  /** Action to perform when hierarchy level contains more items that the specified limit. */\n  onHierarchyLimitExceeded?: (props: { parentId?: string; filter?: GenericInstanceFilter; limit?: number | \"unbounded\" }) => void;\n  /** Action to perform when an error occurs while loading hierarchy. */\n  onHierarchyLoadError?: (props: { parentId?: string; type: \"timeout\" | \"unknown\" }) => void;\n}\n\n/** @beta */\ninterface ReloadTreeCommonOptions {\n  /**\n   * Specifies how current tree state should be handled:\n   * - `keep` - try to keep current tree state (expanded/collapsed nodes, instance filters, etc.).\n   * - `discard` - do not try to keep current tree state. Tree model will be update after nodes are reloaded.\n   * - `reset` - remove subtree from the model before reloading and reload nodes ignoring cache.\n   *\n   * Defaults to `\"keep\"`.\n   */\n  state?: \"keep\" | \"discard\" | \"reset\";\n}\n\n/**\n * Options for full tree reload.\n * @beta\n */\ntype FullTreeReloadOptions = {\n  /** Specifies that data source changed and caches should be cleared before reloading tree. */\n  dataSourceChanged?: true;\n} & ReloadTreeCommonOptions;\n\n/**\n * Options for subtree reload.\n * @beta\n */\ntype SubtreeReloadOptions = {\n  /** Specifies parent node under which sub tree should be reloaded. */\n  parentNodeId: string;\n} & ReloadTreeCommonOptions;\n\n/**\n * Options for doing either full or a sub tree reload.\n * @beta\n */\ntype ReloadTreeOptions = FullTreeReloadOptions | SubtreeReloadOptions;\n\n/** @beta */\ninterface UseTreeResult {\n  /**\n   * Array containing root tree nodes. It is `undefined` on initial render until any nodes are loaded.\n   */\n  rootNodes: PresentationTreeNode[] | undefined;\n  /**\n   * Specifies whether tree is loading or not. It is set to `true` when initial tree load is in progress\n   * or tree is reloading.\n   */\n  isLoading: boolean;\n  /**\n   * A function that should be called to reload the tree.\n   */\n  reloadTree: (options?: ReloadTreeOptions) => void;\n  /**\n   * A function that should be called to either expand or collapse the given node.\n   */\n  expandNode: (nodeId: string, isExpanded: boolean) => void;\n  /**\n   * A function that should be called to select nodes in the tree.\n   * @param nodeIds Ids of the nodes that are selected.\n   * @param changeType Type of change that occurred for the selection.\n   */\n  selectNodes: (nodeIds: Array<string>, changeType: SelectionChangeType) => void;\n  /** Determines whether a given node is selected. */\n  isNodeSelected: (nodeId: string) => boolean;\n  /** Returns hierarchy level details for a given node ID. */\n  getHierarchyLevelDetails: (nodeId: string | undefined) => HierarchyLevelDetails | undefined;\n  /** Sets a formatter for the primitive values that are displayed in the hierarchy. */\n  setFormatter: (formatter: IPrimitiveValueFormatter | undefined) => void;\n}\n\ninterface TreeState {\n  model: TreeModel;\n  rootNodes: Array<PresentationTreeNode> | undefined;\n}\n\nfunction useTreeInternal({\n  imodelAccess,\n  getHierarchyDefinition,\n  getFilteredPaths,\n  localizedStrings,\n  onPerformanceMeasured,\n  onHierarchyLimitExceeded,\n  onHierarchyLoadError,\n}: UseTreeProps): UseTreeResult & { getNode: (nodeId: string) => TreeModelRootNode | TreeModelNode | undefined } {\n  const [state, setState] = useState<TreeState>({\n    model: { idToNode: new Map(), parentChildMap: new Map(), rootNode: { id: undefined, nodeData: undefined } },\n    rootNodes: undefined,\n  });\n  const [hierarchySource, setHierarchySource] = useState<{ hierarchyProvider?: HierarchyProvider; isFiltering: boolean }>({ isFiltering: false });\n  const onPerformanceMeasuredRef = useLatest(onPerformanceMeasured);\n  const onHierarchyLimitExceededRef = useLatest(onHierarchyLimitExceeded);\n  const onHierarchyLoadErrorRef = useLatest(onHierarchyLoadError);\n\n  const [actions] = useState<TreeActions>(\n    () =>\n      new TreeActions(\n        (model) => {\n          const rootNodes = model.parentChildMap.get(undefined) !== undefined ? generateTreeStructure(undefined, model) : undefined;\n          setState({\n            model,\n            rootNodes,\n          });\n        },\n        (actionType, duration) => onPerformanceMeasuredRef.current?.(actionType, duration),\n        (props) => onHierarchyLimitExceededRef.current?.(props),\n        (props) => onHierarchyLoadErrorRef.current?.(props),\n      ),\n  );\n  const currentFormatter = useRef<IPrimitiveValueFormatter>();\n\n  useEffect(() => {\n    const updateHierarchyProvider = (provider: HierarchyProvider, filtered: boolean) => {\n      actions.setHierarchyProvider(provider);\n      actions.reloadTree({ state: filtered ? \"discard\" : \"keep\" });\n      setHierarchySource({ hierarchyProvider: provider, isFiltering: false });\n    };\n\n    const createProvider = (paths: HierarchyFilteringPaths | undefined) => {\n      return createHierarchyProvider({\n        imodelAccess,\n        hierarchyDefinition: getHierarchyDefinition({ imodelAccess }),\n        localizedStrings,\n        formatter: currentFormatter.current,\n        filtering:\n          paths !== undefined\n            ? {\n                paths,\n              }\n            : undefined,\n      });\n    };\n\n    const loadHierarchyProvider = async () => {\n      if (!getFilteredPaths) {\n        return { provider: createProvider(undefined), filtered: false };\n      }\n\n      setHierarchySource((prev) => ({ ...prev, isFiltering: true }));\n      try {\n        const filteredPaths = await getFilteredPaths({ imodelAccess });\n        return { provider: createProvider(filteredPaths), filtered: filteredPaths !== undefined };\n      } catch {\n        return { provider: createProvider(undefined), filtered: false };\n      }\n    };\n\n    let disposed = false;\n    void (async () => {\n      const { provider, filtered } = await loadHierarchyProvider();\n      if (disposed) {\n        return;\n      }\n      updateHierarchyProvider(provider, filtered);\n    })();\n\n    return () => {\n      disposed = true;\n      actions.dispose();\n    };\n  }, [actions, imodelAccess, localizedStrings, getHierarchyDefinition, getFilteredPaths]);\n\n  const getNode = useCallback<(nodeId: string) => TreeModelRootNode | TreeModelNode | undefined>(\n    (nodeId: string) => {\n      return actions.getNode(nodeId);\n    },\n    [actions],\n  );\n\n  const expandNode = useCallback<UseTreeResult[\"expandNode\"]>(\n    (nodeId: string, isExpanded: boolean) => {\n      actions.expandNode(nodeId, isExpanded);\n    },\n    [actions],\n  );\n\n  const reloadTree = useCallback<UseTreeResult[\"reloadTree\"]>(\n    (options) => {\n      if (options && \"dataSourceChanged\" in options) {\n        hierarchySource.hierarchyProvider?.notifyDataSourceChanged();\n      }\n      actions.reloadTree(options);\n    },\n    [actions, hierarchySource],\n  );\n\n  const selectNodes = useCallback<UseTreeResult[\"selectNodes\"]>(\n    (nodeIds: Array<string>, changeType: SelectionChangeType) => {\n      actions.selectNodes(nodeIds, changeType);\n    },\n    [actions],\n  );\n\n  const isNodeSelected = useCallback<UseTreeResult[\"isNodeSelected\"]>((nodeId: string) => TreeModel.isNodeSelected(state.model, nodeId), [state]);\n\n  const setFormatter = useCallback<UseTreeResult[\"setFormatter\"]>(\n    (formatter: IPrimitiveValueFormatter | undefined) => {\n      currentFormatter.current = formatter;\n      // istanbul ignore if\n      if (!hierarchySource.hierarchyProvider) {\n        return;\n      }\n\n      hierarchySource.hierarchyProvider.setFormatter(formatter);\n      actions.reloadTree();\n    },\n    [hierarchySource.hierarchyProvider, actions],\n  );\n\n  const getHierarchyLevelDetails = useCallback<UseTreeResult[\"getHierarchyLevelDetails\"]>(\n    (nodeId) => {\n      const node = actions.getNode(nodeId);\n      const hierarchyProvider = hierarchySource.hierarchyProvider;\n      if (!hierarchyProvider || !node || isTreeModelInfoNode(node)) {\n        return undefined;\n      }\n      const hierarchyNode = node.nodeData;\n      if (hierarchyNode && HierarchyNode.isGroupingNode(hierarchyNode)) {\n        return undefined;\n      }\n\n      return {\n        hierarchyNode,\n        getInstanceKeysIterator: (props) =>\n          hierarchyProvider.getNodeInstanceKeys({\n            parentNode: hierarchyNode,\n            instanceFilter: props?.instanceFilter,\n            hierarchyLevelSizeLimit: props?.hierarchyLevelSizeLimit,\n          }),\n        instanceFilter: node.instanceFilter,\n        setInstanceFilter: (filter) => actions.setInstanceFilter(nodeId, filter),\n        sizeLimit: node.hierarchyLimit,\n        setSizeLimit: (value) => actions.setHierarchyLimit(nodeId, value),\n      };\n    },\n    [actions, hierarchySource.hierarchyProvider],\n  );\n\n  return {\n    rootNodes: state.rootNodes,\n    isLoading: !!state.model.rootNode.isLoading || hierarchySource.isFiltering,\n    expandNode,\n    reloadTree,\n    selectNodes,\n    isNodeSelected,\n    getNode,\n    getHierarchyLevelDetails,\n    setFormatter,\n  };\n}\n\nfunction generateTreeStructure(parentNodeId: string | undefined, model: TreeModel): Array<PresentationTreeNode> | undefined {\n  const currentChildren = model.parentChildMap.get(parentNodeId);\n  if (!currentChildren) {\n    return undefined;\n  }\n\n  return currentChildren\n    .map((childId) => model.idToNode.get(childId))\n    .filter((node): node is TreeModelNode => !!node)\n    .map<PresentationTreeNode>((node) => {\n      if (isTreeModelHierarchyNode(node)) {\n        const children = generateTreeStructure(node.id, model);\n        return {\n          ...toPresentationHierarchyNodeBase(node),\n          children: children ? children : node.children === true ? true : [],\n        };\n      }\n\n      if (node.type === \"ResultSetTooLarge\") {\n        return {\n          id: node.id,\n          parentNodeId,\n          type: node.type,\n          resultSetSizeLimit: node.resultSetSizeLimit,\n        };\n      }\n\n      if (node.type === \"NoFilterMatches\") {\n        return {\n          id: node.id,\n          parentNodeId,\n          type: node.type,\n        };\n      }\n\n      return {\n        id: node.id,\n        parentNodeId,\n        type: node.type,\n        message: node.message,\n      };\n    });\n}\n\nfunction toPresentationHierarchyNodeBase(node: TreeModelHierarchyNode): Omit<PresentationHierarchyNode, \"children\"> {\n  return {\n    id: node.id,\n    label: node.label,\n    nodeData: node.nodeData,\n    isLoading: !!node.isLoading,\n    isExpanded: !!node.isExpanded,\n    isFilterable: !HierarchyNode.isGroupingNode(node.nodeData) && !!node.nodeData.supportsFiltering && node.children,\n    isFiltered: !!node.instanceFilter,\n    extendedData: node.nodeData.extendedData,\n  };\n}\n\nfunction useLatest<T>(value: T) {\n  const ref = useRef(value);\n  useEffect(() => {\n    ref.current = value;\n  }, [value]);\n\n  return ref;\n}\n"]}
+{"version":3,"file":"UseTree.js","sourceRoot":"","sources":["../../../src/presentation-hierarchies-react/UseTree.ts"],"names":[],"mappings":"AAAA;;;gGAGgG;AAEhG,OAAO,EAAE,WAAW,EAAE,SAAS,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,OAAO,CAAC;AACjE,OAAO,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAC;AACpD,OAAO,EAAiD,aAAa,EAAqB,MAAM,iCAAiC,CAAC;AAElI,OAAO,EAAE,WAAW,EAAE,MAAM,wBAAwB,CAAC;AACrD,OAAO,EAAE,wBAAwB,EAAE,mBAAmB,EAAE,SAAS,EAA4D,MAAM,sBAAsB,CAAC;AAC1J,OAAO,EAAE,uBAAuB,EAAgC,MAAM,gCAAgC,CAAC;AA6BvG;;;;;;;;;;;GAWG;AACH,MAAM,UAAU,OAAO,CAAC,KAAmB;IACzC,MAAM,EAAE,OAAO,EAAE,CAAC,EAAE,GAAG,IAAI,EAAE,GAAG,eAAe,CAAC,KAAK,CAAC,CAAC;IACvD,OAAO,IAAI,CAAC;AACd,CAAC;AAED;;;;;;;;;;;;;GAaG;AACH,MAAM,UAAU,uBAAuB,CAAC,EAAE,UAAU,EAAE,GAAG,KAAK,EAA+C;IAC3G,MAAM,EAAE,OAAO,EAAE,GAAG,IAAI,EAAE,GAAG,eAAe,CAAC,KAAK,CAAC,CAAC;IACpD,OAAO,EAAE,GAAG,IAAI,EAAE,GAAG,uBAAuB,CAAC,EAAE,UAAU,EAAE,OAAO,EAAE,CAAC,EAAE,CAAC;AAC1E,CAAC;AA4ED,SAAS,eAAe,CAAC,EACvB,oBAAoB,EACpB,gBAAgB,EAChB,qBAAqB,EACrB,wBAAwB,EACxB,oBAAoB,GACP;IACb,MAAM,CAAC,KAAK,EAAE,QAAQ,CAAC,GAAG,QAAQ,CAAY;QAC5C,KAAK,EAAE,EAAE,QAAQ,EAAE,IAAI,GAAG,EAAE,EAAE,cAAc,EAAE,IAAI,GAAG,EAAE,EAAE,QAAQ,EAAE,EAAE,EAAE,EAAE,SAAS,EAAE,QAAQ,EAAE,SAAS,EAAE,EAAE;QAC3G,SAAS,EAAE,SAAS;KACrB,CAAC,CAAC;IACH,MAAM,wBAAwB,GAAG,SAAS,CAAC,qBAAqB,CAAC,CAAC;IAClE,MAAM,2BAA2B,GAAG,SAAS,CAAC,wBAAwB,CAAC,CAAC;IACxE,MAAM,uBAAuB,GAAG,SAAS,CAAC,oBAAoB,CAAC,CAAC;IAEhE,MAAM,CAAC,OAAO,CAAC,GAAG,QAAQ,CACxB,GAAG,EAAE,CACH,IAAI,WAAW,CACb,CAAC,KAAK,EAAE,EAAE;QACR,MAAM,SAAS,GAAG,KAAK,CAAC,cAAc,CAAC,GAAG,CAAC,SAAS,CAAC,KAAK,SAAS,CAAC,CAAC,CAAC,qBAAqB,CAAC,SAAS,EAAE,KAAK,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;QAC1H,QAAQ,CAAC;YACP,KAAK;YACL,SAAS;SACV,CAAC,CAAC;IACL,CAAC,EACD,CAAC,UAAU,EAAE,QAAQ,EAAE,EAAE,CAAC,wBAAwB,CAAC,OAAO,EAAE,CAAC,UAAU,EAAE,QAAQ,CAAC,EAClF,CAAC,KAAK,EAAE,EAAE,CAAC,2BAA2B,CAAC,OAAO,EAAE,CAAC,KAAK,CAAC,EACvD,CAAC,KAAK,EAAE,EAAE,CAAC,uBAAuB,CAAC,OAAO,EAAE,CAAC,KAAK,CAAC,CACpD,CACJ,CAAC;IACF,MAAM,gBAAgB,GAAG,MAAM,EAA4B,CAAC;IAE5D,MAAM,CAAC,iBAAiB,EAAE,oBAAoB,CAAC,GAAG,QAAQ,EAAiC,CAAC;IAC5F,SAAS,CAAC,GAAG,EAAE;QACb,MAAM,QAAQ,GAAG,oBAAoB,EAAE,CAAC;QACxC,QAAQ,CAAC,YAAY,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;QAChD,MAAM,8BAA8B,GAAG,QAAQ,CAAC,gBAAgB,CAAC,WAAW,CAAC,GAAG,EAAE,CAAC,OAAO,CAAC,UAAU,EAAE,CAAC,CAAC;QACzG,OAAO,CAAC,oBAAoB,CAAC,QAAQ,CAAC,CAAC;QACvC,OAAO,CAAC,UAAU,CAAC,EAAE,KAAK,EAAE,MAAM,EAAE,CAAC,CAAC;QACtC,oBAAoB,CAAC,QAAQ,CAAC,CAAC;QAC/B,OAAO,GAAG,EAAE;YACV,8BAA8B,EAAE,CAAC;YACjC,OAAO,CAAC,OAAO,EAAE,CAAC;YAClB,IAAI,aAAa,CAAC,QAAQ,CAAC,EAAE,CAAC;gBAC5B,QAAQ,CAAC,OAAO,EAAE,CAAC;YACrB,CAAC;YACD,oBAAoB,CAAC,SAAS,CAAC,CAAC;QAClC,CAAC,CAAC;IACJ,CAAC,EAAE,CAAC,OAAO,EAAE,oBAAoB,CAAC,CAAC,CAAC;IAEpC,MAAM,CAAC,WAAW,EAAE,cAAc,CAAC,GAAG,QAAQ,CAAC,KAAK,CAAC,CAAC;IACtD,SAAS,CAAC,GAAG,EAAE;QACb,IAAI,QAAQ,GAAG,KAAK,CAAC;QACrB,KAAK,CAAC,KAAK,IAAI,EAAE;YACf,IAAI,CAAC,gBAAgB,IAAI,CAAC,iBAAiB,EAAE,CAAC;gBAC5C,iBAAiB,EAAE,kBAAkB,CAAC,SAAS,CAAC,CAAC;gBACjD,OAAO,CAAC,UAAU,CAAC,EAAE,KAAK,EAAE,MAAM,EAAE,CAAC,CAAC;gBACtC,cAAc,CAAC,KAAK,CAAC,CAAC;gBACtB,OAAO;YACT,CAAC;YAED,cAAc,CAAC,IAAI,CAAC,CAAC;YACrB,IAAI,KAA2C,CAAC;YAChD,IAAI,CAAC;gBACH,KAAK,GAAG,MAAM,gBAAgB,EAAE,CAAC;YACnC,CAAC;YAAC,MAAM,CAAC;YACT,CAAC;oBAAS,CAAC;gBACT,IAAI,CAAC,QAAQ,EAAE,CAAC;oBACd,iBAAiB,CAAC,kBAAkB,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC;oBACpE,OAAO,CAAC,UAAU,CAAC,EAAE,KAAK,EAAE,KAAK,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC;gBAC5D,CAAC;gBACD,cAAc,CAAC,KAAK,CAAC,CAAC;YACxB,CAAC;QACH,CAAC,CAAC,EAAE,CAAC;QACL,OAAO,GAAG,EAAE;YACV,QAAQ,GAAG,IAAI,CAAC;QAClB,CAAC,CAAC;IACJ,CAAC,EAAE,CAAC,OAAO,EAAE,iBAAiB,EAAE,gBAAgB,CAAC,CAAC,CAAC;IAEnD,MAAM,OAAO,GAAG,WAAW,CACzB,CAAC,MAAc,EAAE,EAAE;QACjB,OAAO,OAAO,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;IACjC,CAAC,EACD,CAAC,OAAO,CAAC,CACV,CAAC;IAEF,MAAM,UAAU,GAAG,WAAW,CAC5B,CAAC,MAAc,EAAE,UAAmB,EAAE,EAAE;QACtC,OAAO,CAAC,UAAU,CAAC,MAAM,EAAE,UAAU,CAAC,CAAC;IACzC,CAAC,EACD,CAAC,OAAO,CAAC,CACV,CAAC;IAEF,MAAM,UAAU,GAAG,WAAW,CAC5B,CAAC,OAAO,EAAE,EAAE;QACV,OAAO,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC;IAC9B,CAAC,EACD,CAAC,OAAO,CAAC,CACV,CAAC;IAEF,MAAM,WAAW,GAAG,WAAW,CAC7B,CAAC,OAAsB,EAAE,UAA+B,EAAE,EAAE;QAC1D,OAAO,CAAC,WAAW,CAAC,OAAO,EAAE,UAAU,CAAC,CAAC;IAC3C,CAAC,EACD,CAAC,OAAO,CAAC,CACV,CAAC;IAEF,MAAM,cAAc,GAAG,WAAW,CAAkC,CAAC,MAAc,EAAE,EAAE,CAAC,SAAS,CAAC,cAAc,CAAC,KAAK,CAAC,KAAK,EAAE,MAAM,CAAC,EAAE,CAAC,KAAK,CAAC,CAAC,CAAC;IAEhJ,MAAM,YAAY,GAAG,WAAW,CAC9B,CAAC,SAA+C,EAAE,EAAE;QAClD,gBAAgB,CAAC,OAAO,GAAG,SAAS,CAAC;QACrC,qBAAqB;QACrB,IAAI,CAAC,iBAAiB,EAAE,CAAC;YACvB,OAAO;QACT,CAAC;QAED,iBAAiB,CAAC,YAAY,CAAC,SAAS,CAAC,CAAC;QAC1C,OAAO,CAAC,UAAU,EAAE,CAAC;IACvB,CAAC,EACD,CAAC,iBAAiB,EAAE,OAAO,CAAC,CAC7B,CAAC;IAEF,MAAM,wBAAwB,GAAG,WAAW,CAC1C,CAAC,MAAM,EAAE,EAAE;QACT,MAAM,IAAI,GAAG,OAAO,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;QACrC,IAAI,CAAC,iBAAiB,IAAI,CAAC,IAAI,IAAI,mBAAmB,CAAC,IAAI,CAAC,EAAE,CAAC;YAC7D,OAAO,SAAS,CAAC;QACnB,CAAC;QACD,MAAM,aAAa,GAAG,IAAI,CAAC,QAAQ,CAAC;QACpC,IAAI,aAAa,IAAI,aAAa,CAAC,cAAc,CAAC,aAAa,CAAC,EAAE,CAAC;YACjE,OAAO,SAAS,CAAC;QACnB,CAAC;QAED,OAAO;YACL,aAAa;YACb,uBAAuB,EAAE,CAAC,KAAK,EAAE,EAAE,CACjC,iBAAiB,CAAC,mBAAmB,CAAC;gBACpC,UAAU,EAAE,aAAa;gBACzB,cAAc,EAAE,KAAK,EAAE,cAAc;gBACrC,uBAAuB,EAAE,KAAK,EAAE,uBAAuB;aACxD,CAAC;YACJ,cAAc,EAAE,IAAI,CAAC,cAAc;YACnC,iBAAiB,EAAE,CAAC,MAAM,EAAE,EAAE,CAAC,OAAO,CAAC,iBAAiB,CAAC,MAAM,EAAE,MAAM,CAAC;YACxE,SAAS,EAAE,IAAI,CAAC,cAAc;YAC9B,YAAY,EAAE,CAAC,KAAK,EAAE,EAAE,CAAC,OAAO,CAAC,iBAAiB,CAAC,MAAM,EAAE,KAAK,CAAC;SAClE,CAAC;IACJ,CAAC,EACD,CAAC,OAAO,EAAE,iBAAiB,CAAC,CAC7B,CAAC;IAEF,OAAO;QACL,SAAS,EAAE,KAAK,CAAC,SAAS;QAC1B,SAAS,EAAE,CAAC,CAAC,KAAK,CAAC,KAAK,CAAC,QAAQ,CAAC,SAAS,IAAI,WAAW;QAC1D,UAAU;QACV,UAAU;QACV,WAAW;QACX,cAAc;QACd,OAAO;QACP,wBAAwB;QACxB,YAAY;KACb,CAAC;AACJ,CAAC;AAED,SAAS,qBAAqB,CAAC,YAAgC,EAAE,KAAgB;IAC/E,MAAM,eAAe,GAAG,KAAK,CAAC,cAAc,CAAC,GAAG,CAAC,YAAY,CAAC,CAAC;IAC/D,IAAI,CAAC,eAAe,EAAE,CAAC;QACrB,OAAO,SAAS,CAAC;IACnB,CAAC;IAED,OAAO,eAAe;SACnB,GAAG,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,KAAK,CAAC,QAAQ,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;SAC7C,MAAM,CAAC,CAAC,IAAI,EAAyB,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC;SAC/C,GAAG,CAAuB,CAAC,IAAI,EAAE,EAAE;QAClC,IAAI,wBAAwB,CAAC,IAAI,CAAC,EAAE,CAAC;YACnC,MAAM,QAAQ,GAAG,qBAAqB,CAAC,IAAI,CAAC,EAAE,EAAE,KAAK,CAAC,CAAC;YACvD,OAAO;gBACL,GAAG,+BAA+B,CAAC,IAAI,CAAC;gBACxC,QAAQ,EAAE,QAAQ,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,QAAQ,KAAK,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE;aACnE,CAAC;QACJ,CAAC;QAED,IAAI,IAAI,CAAC,IAAI,KAAK,mBAAmB,EAAE,CAAC;YACtC,OAAO;gBACL,EAAE,EAAE,IAAI,CAAC,EAAE;gBACX,YAAY;gBACZ,IAAI,EAAE,IAAI,CAAC,IAAI;gBACf,kBAAkB,EAAE,IAAI,CAAC,kBAAkB;aAC5C,CAAC;QACJ,CAAC;QAED,IAAI,IAAI,CAAC,IAAI,KAAK,iBAAiB,EAAE,CAAC;YACpC,OAAO;gBACL,EAAE,EAAE,IAAI,CAAC,EAAE;gBACX,YAAY;gBACZ,IAAI,EAAE,IAAI,CAAC,IAAI;aAChB,CAAC;QACJ,CAAC;QAED,OAAO;YACL,EAAE,EAAE,IAAI,CAAC,EAAE;YACX,YAAY;YACZ,IAAI,EAAE,IAAI,CAAC,IAAI;YACf,OAAO,EAAE,IAAI,CAAC,OAAO;SACtB,CAAC;IACJ,CAAC,CAAC,CAAC;AACP,CAAC;AAED,SAAS,+BAA+B,CAAC,IAA4B;IACnE,OAAO;QACL,EAAE,EAAE,IAAI,CAAC,EAAE;QACX,KAAK,EAAE,IAAI,CAAC,KAAK;QACjB,QAAQ,EAAE,IAAI,CAAC,QAAQ;QACvB,SAAS,EAAE,CAAC,CAAC,IAAI,CAAC,SAAS;QAC3B,UAAU,EAAE,CAAC,CAAC,IAAI,CAAC,UAAU;QAC7B,YAAY,EAAE,CAAC,aAAa,CAAC,cAAc,CAAC,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,iBAAiB,IAAI,IAAI,CAAC,QAAQ;QAChH,UAAU,EAAE,CAAC,CAAC,IAAI,CAAC,cAAc;QACjC,YAAY,EAAE,IAAI,CAAC,QAAQ,CAAC,YAAY;KACzC,CAAC;AACJ,CAAC;AAED,SAAS,SAAS,CAAI,KAAQ;IAC5B,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;IAEZ,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 { useCallback, useEffect, useRef, useState } from \"react\";\nimport { isIDisposable } from \"@itwin/core-bentley\";\nimport { GenericInstanceFilter, HierarchyFilteringPath, HierarchyNode, HierarchyProvider } from \"@itwin/presentation-hierarchies\";\nimport { InstanceKey, IPrimitiveValueFormatter } from \"@itwin/presentation-shared\";\nimport { TreeActions } from \"./internal/TreeActions\";\nimport { isTreeModelHierarchyNode, isTreeModelInfoNode, TreeModel, TreeModelHierarchyNode, TreeModelNode, TreeModelRootNode } from \"./internal/TreeModel\";\nimport { useUnifiedTreeSelection, UseUnifiedTreeSelectionProps } from \"./internal/UseUnifiedSelection\";\nimport { PresentationHierarchyNode, PresentationTreeNode } from \"./TreeNode\";\nimport { SelectionChangeType } from \"./UseSelectionHandler\";\n\n/**\n * A data structure that contains information about a single hierarchy level.\n * @beta\n */\nexport interface HierarchyLevelDetails {\n  /** The parent node whose hierarchy level's information is contained in this data structure */\n  hierarchyNode: HierarchyNode | undefined;\n\n  /** A function to get instance keys of the hierarchy level. */\n  getInstanceKeysIterator: (props?: {\n    instanceFilter?: GenericInstanceFilter;\n    hierarchyLevelSizeLimit?: number | \"unbounded\";\n  }) => AsyncIterableIterator<InstanceKey>;\n\n  /** Get the limit of how many nodes can be loaded in this hierarchy level. */\n  sizeLimit?: number | \"unbounded\";\n  /** Set the limit of how many nodes can be loaded in this hierarchy level. */\n  setSizeLimit: (value: undefined | number | \"unbounded\") => void;\n\n  /** Get the active instance filter applied to this hierarchy level. */\n  instanceFilter?: GenericInstanceFilter;\n  /** Set the instance filter to apply to this hierarchy level */\n  setInstanceFilter: (filter: GenericInstanceFilter | undefined) => void;\n}\n\n/**\n * A React hook that creates state for a tree component.\n *\n * The hook uses `@itwin/presentation-hierarchies` package to load the hierarchy data and returns a\n * component-agnostic result which may be used to render the hierarchy using any UI framework.\n *\n * See `README.md` for an example\n *\n * @see `useUnifiedSelectionTree`\n * @see `useIModelTree`\n * @beta\n */\nexport function useTree(props: UseTreeProps): UseTreeResult {\n  const { getNode: _, ...rest } = useTreeInternal(props);\n  return rest;\n}\n\n/**\n * A React hook that creates state for a tree component, that is integrated with unified selection\n * through context provided by `UnifiedSelectionProvider`.\n *\n * The hook uses `@itwin/presentation-hierarchies` package to load the hierarchy data and returns a\n * component-agnostic result which may be used to render the hierarchy using any UI framework.\n *\n * See `README.md` for an example\n *\n * @see `useTree`\n * @see `useIModelUnifiedSelectionTree`\n * @see `UnifiedSelectionProvider`\n * @beta\n */\nexport function useUnifiedSelectionTree({ sourceName, ...props }: UseTreeProps & UseUnifiedTreeSelectionProps): UseTreeResult {\n  const { getNode, ...rest } = useTreeInternal(props);\n  return { ...rest, ...useUnifiedTreeSelection({ sourceName, getNode }) };\n}\n\n/** @beta */\nexport interface UseTreeProps {\n  /** Provides the hierarchy provider for the tree. */\n  getHierarchyProvider: () => HierarchyProvider;\n  /** Provides paths to filtered nodes. */\n  getFilteredPaths?: () => Promise<HierarchyFilteringPath[] | undefined>;\n  /**\n   * Callback that is called just after a certain action is finished.\n   * Can be used for performance tracking.\n   */\n  onPerformanceMeasured?: (action: \"initial-load\" | \"hierarchy-level-load\" | \"reload\", duration: number) => void;\n  /** Action to perform when hierarchy level contains more items that the specified limit. */\n  onHierarchyLimitExceeded?: (props: { parentId?: string; filter?: GenericInstanceFilter; limit?: number | \"unbounded\" }) => void;\n  /** Action to perform when an error occurs while loading hierarchy. */\n  onHierarchyLoadError?: (props: { parentId?: string; type: \"timeout\" | \"unknown\" }) => void;\n}\n\n/**\n * Options for doing either full or a sub tree reload.\n * @beta\n */\ninterface ReloadTreeOptions {\n  /** Specifies parent node under which sub tree should be reloaded. */\n  parentNodeId: string | undefined;\n\n  /**\n   * Specifies how current tree state should be handled:\n   * - `keep` - try to keep current tree state (expanded/collapsed nodes, instance filters, etc.).\n   * - `discard` - do not try to keep current tree state. Tree model will be update after nodes are reloaded.\n   * - `reset` - remove subtree from the model before reloading and reload nodes ignoring cache.\n   *\n   * Defaults to `\"keep\"`.\n   */\n  state?: \"keep\" | \"discard\" | \"reset\";\n}\n\n/** @beta */\nexport interface UseTreeResult {\n  /**\n   * Array containing root tree nodes. It is `undefined` on initial render until any nodes are loaded.\n   */\n  rootNodes: PresentationTreeNode[] | undefined;\n  /**\n   * Specifies whether tree is loading or not. It is set to `true` when initial tree load is in progress\n   * or tree is reloading.\n   */\n  isLoading: boolean;\n  /**\n   * A function that should be called to reload the tree.\n   */\n  reloadTree: (options?: ReloadTreeOptions) => void;\n  /**\n   * A function that should be called to either expand or collapse the given node.\n   */\n  expandNode: (nodeId: string, isExpanded: boolean) => void;\n  /**\n   * A function that should be called to select nodes in the tree.\n   * @param nodeIds Ids of the nodes that are selected.\n   * @param changeType Type of change that occurred for the selection.\n   */\n  selectNodes: (nodeIds: Array<string>, changeType: SelectionChangeType) => void;\n  /** Determines whether a given node is selected. */\n  isNodeSelected: (nodeId: string) => boolean;\n  /** Returns hierarchy level details for a given node ID. */\n  getHierarchyLevelDetails: (nodeId: string | undefined) => HierarchyLevelDetails | undefined;\n  /** Sets a formatter for the primitive values that are displayed in the hierarchy. */\n  setFormatter: (formatter: IPrimitiveValueFormatter | undefined) => void;\n}\n\ninterface TreeState {\n  model: TreeModel;\n  rootNodes: Array<PresentationTreeNode> | undefined;\n}\n\nfunction useTreeInternal({\n  getHierarchyProvider,\n  getFilteredPaths,\n  onPerformanceMeasured,\n  onHierarchyLimitExceeded,\n  onHierarchyLoadError,\n}: UseTreeProps): UseTreeResult & { getNode: (nodeId: string) => TreeModelRootNode | TreeModelNode | undefined } {\n  const [state, setState] = useState<TreeState>({\n    model: { idToNode: new Map(), parentChildMap: new Map(), rootNode: { id: undefined, nodeData: undefined } },\n    rootNodes: undefined,\n  });\n  const onPerformanceMeasuredRef = useLatest(onPerformanceMeasured);\n  const onHierarchyLimitExceededRef = useLatest(onHierarchyLimitExceeded);\n  const onHierarchyLoadErrorRef = useLatest(onHierarchyLoadError);\n\n  const [actions] = useState<TreeActions>(\n    () =>\n      new TreeActions(\n        (model) => {\n          const rootNodes = model.parentChildMap.get(undefined) !== undefined ? generateTreeStructure(undefined, model) : undefined;\n          setState({\n            model,\n            rootNodes,\n          });\n        },\n        (actionType, duration) => onPerformanceMeasuredRef.current?.(actionType, duration),\n        (props) => onHierarchyLimitExceededRef.current?.(props),\n        (props) => onHierarchyLoadErrorRef.current?.(props),\n      ),\n  );\n  const currentFormatter = useRef<IPrimitiveValueFormatter>();\n\n  const [hierarchyProvider, setHierarchyProvider] = useState<HierarchyProvider | undefined>();\n  useEffect(() => {\n    const provider = getHierarchyProvider();\n    provider.setFormatter(currentFormatter.current);\n    const removeHierarchyChangedListener = provider.hierarchyChanged.addListener(() => actions.reloadTree());\n    actions.setHierarchyProvider(provider);\n    actions.reloadTree({ state: \"keep\" });\n    setHierarchyProvider(provider);\n    return () => {\n      removeHierarchyChangedListener();\n      actions.dispose();\n      if (isIDisposable(provider)) {\n        provider.dispose();\n      }\n      setHierarchyProvider(undefined);\n    };\n  }, [actions, getHierarchyProvider]);\n\n  const [isFiltering, setIsFiltering] = useState(false);\n  useEffect(() => {\n    let disposed = false;\n    void (async () => {\n      if (!getFilteredPaths || !hierarchyProvider) {\n        hierarchyProvider?.setHierarchyFilter(undefined);\n        actions.reloadTree({ state: \"keep\" });\n        setIsFiltering(false);\n        return;\n      }\n\n      setIsFiltering(true);\n      let paths: HierarchyFilteringPath[] | undefined;\n      try {\n        paths = await getFilteredPaths();\n      } catch {\n      } finally {\n        if (!disposed) {\n          hierarchyProvider.setHierarchyFilter(paths ? { paths } : undefined);\n          actions.reloadTree({ state: paths ? \"discard\" : \"keep\" });\n        }\n        setIsFiltering(false);\n      }\n    })();\n    return () => {\n      disposed = true;\n    };\n  }, [actions, hierarchyProvider, getFilteredPaths]);\n\n  const getNode = useCallback<(nodeId: string) => TreeModelRootNode | TreeModelNode | undefined>(\n    (nodeId: string) => {\n      return actions.getNode(nodeId);\n    },\n    [actions],\n  );\n\n  const expandNode = useCallback<UseTreeResult[\"expandNode\"]>(\n    (nodeId: string, isExpanded: boolean) => {\n      actions.expandNode(nodeId, isExpanded);\n    },\n    [actions],\n  );\n\n  const reloadTree = useCallback<UseTreeResult[\"reloadTree\"]>(\n    (options) => {\n      actions.reloadTree(options);\n    },\n    [actions],\n  );\n\n  const selectNodes = useCallback<UseTreeResult[\"selectNodes\"]>(\n    (nodeIds: Array<string>, changeType: SelectionChangeType) => {\n      actions.selectNodes(nodeIds, changeType);\n    },\n    [actions],\n  );\n\n  const isNodeSelected = useCallback<UseTreeResult[\"isNodeSelected\"]>((nodeId: string) => TreeModel.isNodeSelected(state.model, nodeId), [state]);\n\n  const setFormatter = useCallback<UseTreeResult[\"setFormatter\"]>(\n    (formatter: IPrimitiveValueFormatter | undefined) => {\n      currentFormatter.current = formatter;\n      // istanbul ignore if\n      if (!hierarchyProvider) {\n        return;\n      }\n\n      hierarchyProvider.setFormatter(formatter);\n      actions.reloadTree();\n    },\n    [hierarchyProvider, actions],\n  );\n\n  const getHierarchyLevelDetails = useCallback<UseTreeResult[\"getHierarchyLevelDetails\"]>(\n    (nodeId) => {\n      const node = actions.getNode(nodeId);\n      if (!hierarchyProvider || !node || isTreeModelInfoNode(node)) {\n        return undefined;\n      }\n      const hierarchyNode = node.nodeData;\n      if (hierarchyNode && HierarchyNode.isGroupingNode(hierarchyNode)) {\n        return undefined;\n      }\n\n      return {\n        hierarchyNode,\n        getInstanceKeysIterator: (props) =>\n          hierarchyProvider.getNodeInstanceKeys({\n            parentNode: hierarchyNode,\n            instanceFilter: props?.instanceFilter,\n            hierarchyLevelSizeLimit: props?.hierarchyLevelSizeLimit,\n          }),\n        instanceFilter: node.instanceFilter,\n        setInstanceFilter: (filter) => actions.setInstanceFilter(nodeId, filter),\n        sizeLimit: node.hierarchyLimit,\n        setSizeLimit: (value) => actions.setHierarchyLimit(nodeId, value),\n      };\n    },\n    [actions, hierarchyProvider],\n  );\n\n  return {\n    rootNodes: state.rootNodes,\n    isLoading: !!state.model.rootNode.isLoading || isFiltering,\n    expandNode,\n    reloadTree,\n    selectNodes,\n    isNodeSelected,\n    getNode,\n    getHierarchyLevelDetails,\n    setFormatter,\n  };\n}\n\nfunction generateTreeStructure(parentNodeId: string | undefined, model: TreeModel): Array<PresentationTreeNode> | undefined {\n  const currentChildren = model.parentChildMap.get(parentNodeId);\n  if (!currentChildren) {\n    return undefined;\n  }\n\n  return currentChildren\n    .map((childId) => model.idToNode.get(childId))\n    .filter((node): node is TreeModelNode => !!node)\n    .map<PresentationTreeNode>((node) => {\n      if (isTreeModelHierarchyNode(node)) {\n        const children = generateTreeStructure(node.id, model);\n        return {\n          ...toPresentationHierarchyNodeBase(node),\n          children: children ? children : node.children === true ? true : [],\n        };\n      }\n\n      if (node.type === \"ResultSetTooLarge\") {\n        return {\n          id: node.id,\n          parentNodeId,\n          type: node.type,\n          resultSetSizeLimit: node.resultSetSizeLimit,\n        };\n      }\n\n      if (node.type === \"NoFilterMatches\") {\n        return {\n          id: node.id,\n          parentNodeId,\n          type: node.type,\n        };\n      }\n\n      return {\n        id: node.id,\n        parentNodeId,\n        type: node.type,\n        message: node.message,\n      };\n    });\n}\n\nfunction toPresentationHierarchyNodeBase(node: TreeModelHierarchyNode): Omit<PresentationHierarchyNode, \"children\"> {\n  return {\n    id: node.id,\n    label: node.label,\n    nodeData: node.nodeData,\n    isLoading: !!node.isLoading,\n    isExpanded: !!node.isExpanded,\n    isFilterable: !HierarchyNode.isGroupingNode(node.nodeData) && !!node.nodeData.supportsFiltering && node.children,\n    isFiltered: !!node.instanceFilter,\n    extendedData: node.nodeData.extendedData,\n  };\n}\n\nfunction useLatest<T>(value: T) {\n  const ref = useRef(value);\n  useEffect(() => {\n    ref.current = value;\n  }, [value]);\n\n  return ref;\n}\n"]}

package/lib/esm/presentation-hierarchies-react/internal/TreeActions.d.ts

@@ -1,4 +1,4 @@
-import { GenericInstanceFilter, HierarchyProvider } from "@itwin/presentation-hierarchies";
+import { GenericInstanceFilter, HierarchyNode, HierarchyProvider } from "@itwin/presentation-hierarchies";
 import { SelectionChangeType } from "../UseSelectionHandler";
 import { TreeModel, TreeModelNode, TreeModelRootNode } from "./TreeModel";
 /** @internal */
@@ -8,6 +8,7 @@ export declare class TreeActions {
     private _onHierarchyLimitExceeded;
     private _onHierarchyLoadError;
     private _loader;
+    private _nodeIdFactory;
     private _currentModel;
     private _disposed;
     constructor(_onModelChanged: (model: TreeModel) => void, _onLoad: (actionType: "initial-load" | "hierarchy-level-load" | "reload", duration: number) => void, _onHierarchyLimitExceeded: (props: {
@@ -17,7 +18,7 @@ export declare class TreeActions {
     }) => void, _onHierarchyLoadError: (props: {
         parentId?: string;
         type: "timeout" | "unknown";
-    }) => void, seed?: TreeModel);
+    }) => void, nodeIdFactory?: (node: Pick<HierarchyNode, "key" | "parentKeys">) => string, seed?: TreeModel);
     private updateTreeModel;
     private handleLoadedHierarchy;
     private onLoadingComplete;

package/lib/esm/presentation-hierarchies-react/internal/TreeActions.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"TreeActions.d.ts","sourceRoot":"","sources":["../../../../src/presentation-hierarchies-react/internal/TreeActions.ts"],"names":[],"mappings":"AAOA,OAAO,EAAE,qBAAqB,EAAiB,iBAAiB,EAAE,MAAM,iCAAiC,CAAC;AAC1G,OAAO,EAAE,mBAAmB,EAAE,MAAM,wBAAwB,CAAC;AAE7D,OAAO,EAAiD,SAAS,EAA0B,aAAa,EAAE,iBAAiB,EAAE,MAAM,aAAa,CAAC;AAKjJ,gBAAgB;AAChB,qBAAa,WAAW;IAMpB,OAAO,CAAC,eAAe;IACvB,OAAO,CAAC,OAAO;IACf,OAAO,CAAC,yBAAyB;IACjC,OAAO,CAAC,qBAAqB;IAR/B,OAAO,CAAC,OAAO,CAAc;IAC7B,OAAO,CAAC,aAAa,CAAY;IACjC,OAAO,CAAC,SAAS,CAAuB;gBAG9B,eAAe,EAAE,CAAC,KAAK,EAAE,SAAS,KAAK,IAAI,EAC3C,OAAO,EAAE,CAAC,UAAU,EAAE,cAAc,GAAG,sBAAsB,GAAG,QAAQ,EAAE,QAAQ,EAAE,MAAM,KAAK,IAAI,EACnG,yBAAyB,EAAE,CAAC,KAAK,EAAE;QAAE,QAAQ,CAAC,EAAE,MAAM,CAAC;QAAC,MAAM,CAAC,EAAE,qBAAqB,CAAC;QAAC,KAAK,CAAC,EAAE,MAAM,GAAG,WAAW,CAAA;KAAE,KAAK,IAAI,EAC/H,qBAAqB,EAAE,CAAC,KAAK,EAAE;QAAE,QAAQ,CAAC,EAAE,MAAM,CAAC;QAAC,IAAI,EAAE,SAAS,GAAG,SAAS,CAAA;KAAE,KAAK,IAAI,EAClG,IAAI,CAAC,EAAE,SAAS;IAUlB,OAAO,CAAC,eAAe;IAUvB,OAAO,CAAC,qBAAqB;IAM7B,OAAO,CAAC,iBAAiB;IAMzB,OAAO,CAAC,aAAa;IAIrB,OAAO,CAAC,WAAW;IAyBnB,OAAO,CAAC,SAAS;IAejB,OAAO,CAAC,aAAa;IAuCd,OAAO;IAIP,oBAAoB,CAAC,QAAQ,CAAC,EAAE,iBAAiB;IAYjD,OAAO,CAAC,MAAM,EAAE,MAAM,GAAG,SAAS,GAAG,aAAa,GAAG,iBAAiB,GAAG,SAAS;IAIlF,WAAW,CAAC,OAAO,EAAE,KAAK,CAAC,MAAM,CAAC,EAAE,UAAU,EAAE,mBAAmB;IAMnE,UAAU,CAAC,MAAM,EAAE,MAAM,EAAE,UAAU,EAAE,OAAO;IAa9C,iBAAiB,CAAC,MAAM,EAAE,MAAM,GAAG,SAAS,EAAE,KAAK,CAAC,EAAE,MAAM,GAAG,WAAW;IAc1E,iBAAiB,CAAC,MAAM,EAAE,MAAM,GAAG,SAAS,EAAE,MAAM,CAAC,EAAE,qBAAqB;IAc5E,UAAU,CAAC,OAAO,CAAC,EAAE;QAAE,YAAY,CAAC,EAAE,MAAM,CAAC;QAAC,KAAK,CAAC,EAAE,MAAM,GAAG,SAAS,GAAG,OAAO,CAAA;KAAE;CAa5F"}
+{"version":3,"file":"TreeActions.d.ts","sourceRoot":"","sources":["../../../../src/presentation-hierarchies-react/internal/TreeActions.ts"],"names":[],"mappings":"AAOA,OAAO,EAAE,qBAAqB,EAAE,aAAa,EAAE,iBAAiB,EAAE,MAAM,iCAAiC,CAAC;AAC1G,OAAO,EAAE,mBAAmB,EAAE,MAAM,wBAAwB,CAAC;AAE7D,OAAO,EAAiD,SAAS,EAA0B,aAAa,EAAE,iBAAiB,EAAE,MAAM,aAAa,CAAC;AAKjJ,gBAAgB;AAChB,qBAAa,WAAW;IAOpB,OAAO,CAAC,eAAe;IACvB,OAAO,CAAC,OAAO;IACf,OAAO,CAAC,yBAAyB;IACjC,OAAO,CAAC,qBAAqB;IAT/B,OAAO,CAAC,OAAO,CAAc;IAC7B,OAAO,CAAC,cAAc,CAA8D;IACpF,OAAO,CAAC,aAAa,CAAY;IACjC,OAAO,CAAC,SAAS,CAAuB;gBAG9B,eAAe,EAAE,CAAC,KAAK,EAAE,SAAS,KAAK,IAAI,EAC3C,OAAO,EAAE,CAAC,UAAU,EAAE,cAAc,GAAG,sBAAsB,GAAG,QAAQ,EAAE,QAAQ,EAAE,MAAM,KAAK,IAAI,EACnG,yBAAyB,EAAE,CAAC,KAAK,EAAE;QAAE,QAAQ,CAAC,EAAE,MAAM,CAAC;QAAC,MAAM,CAAC,EAAE,qBAAqB,CAAC;QAAC,KAAK,CAAC,EAAE,MAAM,GAAG,WAAW,CAAA;KAAE,KAAK,IAAI,EAC/H,qBAAqB,EAAE,CAAC,KAAK,EAAE;QAAE,QAAQ,CAAC,EAAE,MAAM,CAAC;QAAC,IAAI,EAAE,SAAS,GAAG,SAAS,CAAA;KAAE,KAAK,IAAI,EAClG,aAAa,CAAC,EAAE,CAAC,IAAI,EAAE,IAAI,CAAC,aAAa,EAAE,KAAK,GAAG,YAAY,CAAC,KAAK,MAAM,EAC3E,IAAI,CAAC,EAAE,SAAS;IAWlB,OAAO,CAAC,eAAe;IAUvB,OAAO,CAAC,qBAAqB;IAM7B,OAAO,CAAC,iBAAiB;IAMzB,OAAO,CAAC,aAAa;IAIrB,OAAO,CAAC,WAAW;IAyBnB,OAAO,CAAC,SAAS;IAejB,OAAO,CAAC,aAAa;IAuCd,OAAO;IAIP,oBAAoB,CAAC,QAAQ,CAAC,EAAE,iBAAiB;IAiBjD,OAAO,CAAC,MAAM,EAAE,MAAM,GAAG,SAAS,GAAG,aAAa,GAAG,iBAAiB,GAAG,SAAS;IAIlF,WAAW,CAAC,OAAO,EAAE,KAAK,CAAC,MAAM,CAAC,EAAE,UAAU,EAAE,mBAAmB;IAMnE,UAAU,CAAC,MAAM,EAAE,MAAM,EAAE,UAAU,EAAE,OAAO;IAa9C,iBAAiB,CAAC,MAAM,EAAE,MAAM,GAAG,SAAS,EAAE,KAAK,CAAC,EAAE,MAAM,GAAG,WAAW;IAc1E,iBAAiB,CAAC,MAAM,EAAE,MAAM,GAAG,SAAS,EAAE,MAAM,CAAC,EAAE,qBAAqB;IAc5E,UAAU,CAAC,OAAO,CAAC,EAAE;QAAE,YAAY,CAAC,EAAE,MAAM,CAAC;QAAC,KAAK,CAAC,EAAE,MAAM,GAAG,SAAS,GAAG,OAAO,CAAA;KAAE;CAa5F"}

package/lib/esm/presentation-hierarchies-react/internal/TreeActions.js

@@ -16,14 +16,16 @@ export class TreeActions {
     _onHierarchyLimitExceeded;
     _onHierarchyLoadError;
     _loader;
+    _nodeIdFactory;
     _currentModel;
     _disposed = new Subject();
-    constructor(_onModelChanged, _onLoad, _onHierarchyLimitExceeded, _onHierarchyLoadError, seed) {
+    constructor(_onModelChanged, _onLoad, _onHierarchyLimitExceeded, _onHierarchyLoadError, nodeIdFactory, seed) {
         this._onModelChanged = _onModelChanged;
         this._onLoad = _onLoad;
         this._onHierarchyLimitExceeded = _onHierarchyLimitExceeded;
         this._onHierarchyLoadError = _onHierarchyLoadError;
         this._loader = new NoopTreeLoader();
+        this._nodeIdFactory = nodeIdFactory ?? createNodeId;
         this._currentModel = seed ?? /* istanbul ignore next */ {
             idToNode: new Map(),
             parentChildMap: new Map(),
@@ -82,7 +84,7 @@ export class TreeActions {
         }
         this.loadSubTree({
             parent: parentNode,
-            getHierarchyLevelOptions: (node) => createHierarchyLevelOptions(this._currentModel, getNonGroupedParentId(node)),
+            getHierarchyLevelOptions: (node) => createHierarchyLevelOptions(this._currentModel, getNonGroupedParentId(node, this._nodeIdFactory)),
             shouldLoadChildren: (node) => !!node.nodeData.autoExpand,
             ignoreCache,
         });
@@ -95,7 +97,7 @@ export class TreeActions {
             if (!!options?.discardState) {
                 return { instanceFilter: undefined, hierarchyLevelSizeLimit: undefined };
             }
-            const filteredNodeId = getNonGroupedParentId(node);
+            const filteredNodeId = getNonGroupedParentId(node, this._nodeIdFactory);
             return createHierarchyLevelOptions(filteredNodeId === parentId ? currModel : oldModel, filteredNodeId);
         };
         const shouldLoadChildren = (node) => {
@@ -130,7 +132,7 @@ export class TreeActions {
                     this._onLoad(loadAction, Number.MAX_SAFE_INTEGER);
                 }
                 this._onHierarchyLoadError({ parentId, type });
-            })
+            }, this._nodeIdFactory)
             : /* istanbul ignore next */ new NoopTreeLoader();
     }
     getNode(nodeId) {
@@ -229,14 +231,14 @@ function collectNodes(parentId, model, pred) {
     }
     return [currNode, ...currentChildren.flatMap((child) => collectNodes(child, model, pred))];
 }
-function getNonGroupedParentId(node) {
+function getNonGroupedParentId(node, nodeIdFactory) {
     if (!node.nodeData || !HierarchyNode.isGroupingNode(node.nodeData)) {
         return node.id;
     }
     if (!node.nodeData.nonGroupingAncestor) {
         return undefined;
     }
-    return createNodeId(node.nodeData.nonGroupingAncestor);
+    return nodeIdFactory(node.nodeData.nonGroupingAncestor);
 }
 function createHierarchyLevelOptions(model, nodeId) {
     if (nodeId === undefined) {