@itwin/presentation-hierarchies-react 2.0.0-alpha.53 → 2.0.0-alpha.55

package/CHANGELOG.md

@@ -1,5 +1,43 @@
 # @itwin/presentation-hierarchies-react
 
+## 2.0.0-alpha.55
+
+### Major Changes
+
+- [#1223](https://github.com/iTwin/presentation/pull/1223): Reworked `localization` to use `i18next`-compatible approach. Instead of passing a `localizedStrings` object into `LocalizationContextProvider`, the package now delivers an English locale JSON file and resolves strings through a `getLocalizedString` function at runtime.
+
+  **Breaking changes**
+  - `LocalizationContextProvider` no longer accepts a `localizedStrings` object. It now requires a `localization` prop — an object with a `getLocalizedString(key: string): string` method (compatible with `Localization` from @itwin/core-common).
+  - `LOCALIZATION_NAMESPACES` must be registered with your localization provider during app initialization to make localized strings available.
+
+### Minor Changes
+
+- [#1221](https://github.com/iTwin/presentation/pull/1221): Add `getTreeNodeError` callback prop to `useTree` hook and its derivatives, providing a way to set custom errors on tree nodes.
+
+### Patch Changes
+
+- [#1219](https://github.com/iTwin/presentation/pull/1219): Fix component documentation mentioning iTwinUI
+- Updated dependencies:
+  - @itwin/presentation-shared@2.0.0-alpha.8
+  - @itwin/presentation-hierarchies@2.0.0-alpha.12
+  - @itwin/unified-selection@1.6.8-alpha.0
+
+## 2.0.0-alpha.54
+
+### Patch Changes
+
+- [#1198](https://github.com/iTwin/presentation/pull/1198): Change `HierarchyProvider.hierarchyChanged` argument to be required.
+
+  This simplifies the API for users of `HierarchyProvider`, as they no longer need to check for `undefined` when handling hierarchy changes.
+
+  For implementors of custom `HierarchyProvider`, this change means that they must always provide an even argument when raising the `hierarchyChanged` event. Since all members of the argument type are optional, it's okay to raise the even with an empty object, e.g.: `this.hierarchyChanged.raiseEvent({})`.
+
+- [#1200](https://github.com/iTwin/presentation/pull/1200): Removed unnecessary, always-truthy condition checks.
+- [#1193](https://github.com/iTwin/presentation/pull/1193): Process package output with [React Compiler](https://react.dev/reference/react-compiler/compiling-libraries).
+- Updated dependencies:
+  - @itwin/presentation-shared@2.0.0-alpha.7
+  - @itwin/presentation-hierarchies@2.0.0-alpha.11
+
 ## 2.0.0-alpha.53
 
 ### Patch Changes
@@ -770,6 +808,26 @@
 
 - [#847](https://github.com/iTwin/presentation/pull/847): Moving tree rendering components to a new design systems.
 
+## 1.9.12
+
+### Patch Changes
+
+- [#1215](https://github.com/iTwin/presentation/pull/1215): Update dependencies.
+- Updated dependencies:
+  - @itwin/presentation-hierarchies@1.7.10
+  - @itwin/presentation-shared@1.2.9
+  - @itwin/unified-selection@1.6.7
+
+## 1.9.11
+
+### Patch Changes
+
+- [#1208](https://github.com/iTwin/presentation/pull/1208): Bump dependencies.
+- Updated dependencies:
+  - @itwin/presentation-hierarchies@1.7.9
+  - @itwin/presentation-shared@1.2.8
+  - @itwin/unified-selection@1.6.6
+
 ## 1.9.10
 
 ### Patch Changes

package/README.md

@@ -214,79 +214,41 @@ function MyTreeComponentInternal({ imodelAccess, selectionStorage }: { imodelAcc
 
 ## Localization
 
-Localization can be enabled for `TreeRenderer` component and [tree state hooks](#tree-state-hooks) by providing an object with localized strings that will be used instead of the default English ones.
-
-Example:
+This package delivers a locale JSON file with English strings that follows the [`i18next JSON format`](https://www.i18next.com/misc/json-format). To enable localization, register `LOCALIZATION_NAMESPACES` during initialization and wrap components in `LocalizationContextProvider`:
 
 ```tsx
-import { Props } from "@itwin/presentation-shared";
-
-import { useIModelUnifiedSelectionTree } from "@itwin/presentation-hierarchies-react";
-
-type IModelAccess = Props<typeof useIModelUnifiedSelectionTree>["imodelAccess"];
+import {
+  LocalizationContextProvider,
+  LOCALIZATION_NAMESPACES,
+  StrataKitTreeRenderer,
+  useIModelUnifiedSelectionTree,
+} from "@itwin/presentation-hierarchies-react";
+
+// Register localization namespaces with `i18next` based localization provider.
+for (const namespace of LOCALIZATION_NAMESPACES) {
+  await localization.registerNamespace(namespace);
+}
 
-const localizedStrings = {
-  // strings for the `useIModelUnifiedSelectionTree` hook
-  unspecified: "Unspecified",
-  other: "Other",
-
-  // strings for `TreeRenderer` and `TreeNodeRenderer`
-  loading: "Loading...",
-  filterHierarchyLevel: "Apply hierarchy filter",
-  clearHierarchyLevelFilter: "Clear active filter",
-  noFilteredChildren: "No child nodes match current filter",
-  resultLimitExceeded: "There are more items than allowed limit of {{limit}}.",
-  resultLimitExceededWithFiltering: "Please provide <link>additional filtering</link> - there are more items than allowed limit of {{limit}}.",
-  increaseHierarchyLimit: "<link>Increase the hierarchy level size limit to {{limit}}.</link>",
-  increaseHierarchyLimitWithFiltering: "Or, <link>increase the hierarchy level size limit to {{limit}}.</link>",
-};
+// Wrap components with LocalizationContextProvider
+function Tree() {
+  return (
+    <LocalizationContextProvider localization={localization}>
+      <MyTreeComponent imodelAccess={imodelAccess} />
+    </LocalizationContextProvider>
+  );
+}
 
 function MyTreeComponent({ imodelAccess }: { imodelAccess: IModelAccess }) {
   const { rootNodes, expandNode } = useIModelUnifiedSelectionTree({
     sourceName: "MyTreeComponent",
     imodelAccess,
-    localizedStrings,
     getHierarchyDefinition,
   });
   if (!rootNodes) {
-    return localizedStrings.loading;
+    return <Spinner />;
   }
-  return <TreeRenderer rootNodes={rootNodes} expandNode={expandNode} localizedStrings={localizedStrings} onFilterClick={() => {}} />;
+  return <StrataKitTreeRenderer rootNodes={rootNodes} expandNode={expandNode} />;
 }
 ```
 
-In case the `TreeNodeRenderer` component is used within a custom tree renderer, the tree component should supply localized strings through `LocalizationContextProvider`:
-
-```tsx
-import { Props } from "@itwin/presentation-shared";
-
-import { ComponentPropsWithoutRef, useCallback } from "react";
-import { Tree } from "@stratakit/bricks";
-import { LocalizationContextProvider, TreeRenderer, useFlatTreeNodeList } from "@itwin/presentation-hierarchies-react";
-
-type TreeRendererProps = Props<typeof TreeRenderer>;
-
-function MyTreeRenderer({ rootNodes }: TreeRendererProps) {
-  const flatNodes = useFlatTreeNodeList(rootNodes);
-
-  return (
-    <LocalizationContextProvider localizedStrings={localizedStrings}>
-      <Tree.Root>
-        {flatNodes.map((flatNode) =>
-          isPlaceholderNode(flatNode) ? (
-            <Tree.Item key={flatNode.id} aria-level={flatNode.level} aria-posinset={1} aria-setsize={1} label="Loading" />
-          ) : (
-            <Tree.Item
-              key={flatNode.id}
-              aria-level={flatNode.level}
-              aria-posinset={flatNode.posInLevel}
-              aria-setsize={flatNode.levelSize}
-              label={flatNode.label}
-            />
-          ),
-        )}
-      </Tree.Root>
-    </LocalizationContextProvider>
-  );
-}
-```
+`LocalizationContextProvider` accepts a `localization` prop — an object with a `getLocalizedString(key: string): string` method. It is designed to work with the `Localization` interface from `@itwin/core-common`, but a custom implementation can be used as well by providing an object with a custom `getLocalizedString` function. The provider uses it internally to resolve translation keys prefixed with localization namespace.

package/lib/presentation-hierarchies-react/Renderers.d.ts

@@ -0,0 +1,92 @@
+import { ErrorInfo, TreeNode } from "./TreeNode.js";
+import { SelectionChangeType } from "./UseSelectionHandler.js";
+import { GenericInstanceFilter, HierarchyNode } from "@itwin/presentation-hierarchies";
+import { InstanceKey } from "@itwin/presentation-shared";
+
+//#region src/presentation-hierarchies-react/Renderers.d.ts
+/**
+ * Type definition used to render tree rendering UI component.
+ * @alpha
+ */
+type TreeRendererProps = {
+  /**
+   * Array containing root tree nodes.
+   */
+  rootNodes: TreeNode[];
+  /**
+   * A function that should be called to either expand or collapse the given node.
+   */
+  expandNode: (nodeId: string, isExpanded: boolean) => void;
+  /**
+   * A function that should be called to select nodes in the tree.
+   * @param nodeIds Ids of the nodes that are selected.
+   * @param changeType Type of change that occurred for the selection.
+   */
+  selectNodes: (nodeIds: Array<string>, changeType: SelectionChangeType) => void;
+  /**
+   * Determines whether a given node is selected.
+   */
+  isNodeSelected: (nodeId: string) => boolean;
+} & CommonRendererProps;
+/**
+ * Type definition used to render root error handling UI component.
+ * @alpha
+ */
+type RootErrorRendererProps = {
+  /**
+   * Object containing root error information
+   */
+  error: ErrorInfo;
+} & CommonRendererProps;
+/**
+ * @alpha
+ */
+interface CommonRendererProps {
+  /**
+   * A function that should be called to reload the tree.
+   */
+  reloadTree: (options?: ReloadTreeOptions) => void;
+  /** Returns hierarchy level details for a given node ID. */
+  getHierarchyLevelDetails: (nodeId: string | undefined) => HierarchyLevelDetails | undefined;
+}
+/**
+ * Options for doing either full or a sub tree reload.
+ * @public
+ */
+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.).
+   * - `discard` - do not try to keep current tree state. Tree model will be update after nodes are reloaded.
+   * - `reset` - remove subtree from the model before reloading and reload nodes ignoring cache.
+   *
+   * Defaults to `"keep"`.
+   */
+  state?: "keep" | "discard" | "reset";
+}
+/**
+ * A data structure that contains information about a single hierarchy level.
+ * @public
+ */
+interface HierarchyLevelDetails {
+  /** The parent node whose hierarchy level's information is contained in this data structure */
+  hierarchyNode: HierarchyNode | undefined;
+  /** A function to get instance keys of the hierarchy level. */
+  getInstanceKeysIterator: (props?: {
+    instanceFilter?: GenericInstanceFilter;
+    hierarchyLevelSizeLimit?: number | "unbounded";
+  }) => AsyncIterableIterator<InstanceKey>;
+  /** Get the limit of how many nodes can be loaded in this hierarchy level. */
+  sizeLimit?: number | "unbounded";
+  /** Set the limit of how many nodes can be loaded in this hierarchy level. */
+  setSizeLimit: (value: undefined | number | "unbounded") => void;
+  /** Get the active instance filter applied to this hierarchy level. */
+  instanceFilter?: GenericInstanceFilter;
+  /** Set the instance filter to apply to this hierarchy level */
+  setInstanceFilter: (filter: GenericInstanceFilter | undefined) => void;
+}
+//#endregion
+export { HierarchyLevelDetails, RootErrorRendererProps, TreeRendererProps };
+//# sourceMappingURL=Renderers.d.ts.map

package/lib/presentation-hierarchies-react/Renderers.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Renderers.d.ts","names":[],"sources":["../../src/presentation-hierarchies-react/Renderers.ts"],"mappings":";;;;;;;;AAcA;;KAAY,iBAAA;EAIC;;;EAAX,SAAA,EAAW,QAAA;EAeU;;;EAXrB,UAAA,GAAa,MAAA,UAAgB,UAAA;EAA7B;;;;;EAMA,WAAA,GAAc,OAAA,EAAS,KAAA,UAAe,UAAA,EAAY,mBAAA;EAAA;;;EAIlD,cAAA,GAAiB,MAAA;AAAA,IACf,mBAAA;;;AAMJ;;KAAY,sBAAA;EAKW;;;EADrB,KAAA,EAAO,SAAA;AAAA,IACL,mBAAA;;AAAoB;;UAKd,mBAAA;EAMuE;;;EAF/E,UAAA,GAAa,OAAA,GAAU,iBAAA;EAEvB;EAAA,wBAAA,GAA2B,MAAA,yBAA+B,qBAAA;AAAA;;;AAAqB;;UAOvE,iBAAA;EAER;EAAA,YAAA;EAiBe;;;;;;;;EAPf,KAAA;AAAA;;;;;UAOe,qBAAA;EAMI;EAJnB,aAAA,EAAe,aAAA;EAGW;EAA1B,uBAAA,GAA0B,KAAA;IACxB,cAAA,GAAiB,qBAAA;IACjB,uBAAA;EAAA,MACI,qBAAA,CAAsB,WAAA;EAKb;EAFf,SAAA;EAKiB;EAHjB,YAAA,GAAe,KAAA;EAKa;EAF5B,cAAA,GAAiB,qBAAA;EAE4C;EAA7D,iBAAA,GAAoB,MAAA,EAAQ,qBAAA;AAAA"}

package/lib/{esm/presentation-hierarchies-react → presentation-hierarchies-react}/TreeNode.d.ts

@@ -1,20 +1,22 @@
 import { HierarchyNode } from "@itwin/presentation-hierarchies";
+
+//#region src/presentation-hierarchies-react/TreeNode.d.ts
 /**
  * A type that defines an node in a UI tree component, built with `useTree` hook.
  * @public
  */
-export interface TreeNode {
-    id: string;
-    label: string;
-    children: true | Array<TreeNode>;
-    isExpanded: boolean;
-    isLoading: boolean;
-    isFilterable: boolean;
-    isFiltered: boolean;
-    /** UI-agnostic source of this node object. */
-    nodeData: HierarchyNode;
-    /** Contains error encountered from expanding the node */
-    error?: ErrorInfo;
+interface TreeNode {
+  id: string;
+  label: string;
+  children: true | Array<TreeNode>;
+  isExpanded: boolean;
+  isLoading: boolean;
+  isFilterable: boolean;
+  isFiltered: boolean;
+  /** UI-agnostic source of this node object. */
+  nodeData: HierarchyNode;
+  /** Contains error encountered from expanding the node */
+  error?: ErrorInfo;
 }
 /**
  * A type of `ErrorInfo` that is returned,
@@ -22,9 +24,9 @@ export interface TreeNode {
  *
  * @public
  */
-export interface NoFilterMatchesErrorInfo {
-    id: string;
-    type: "NoFilterMatches";
+interface NoFilterMatchesErrorInfo {
+  id: string;
+  type: "NoFilterMatches";
 }
 /**
  * A type of `ErrorInfo` that is returned, when the
@@ -33,10 +35,10 @@ export interface NoFilterMatchesErrorInfo {
  *
  * @public
  */
-export interface ResultSetTooLargeErrorInfo {
-    id: string;
-    type: "ResultSetTooLarge";
-    resultSetSizeLimit: number;
+interface ResultSetTooLargeErrorInfo {
+  id: string;
+  type: "ResultSetTooLarge";
+  resultSetSizeLimit: number;
 }
 /**
  * A type of `ErrorInfo` that contains a user-friendly message to be displayed in the UI.
@@ -45,10 +47,10 @@ export interface ResultSetTooLargeErrorInfo {
  *
  * @public
  */
-export interface ChildrenLoadErrorInfo {
-    id: string;
-    type: "ChildrenLoad";
-    message: string;
+interface ChildrenLoadErrorInfo {
+  id: string;
+  type: "ChildrenLoad";
+  message: string;
 }
 /**
  * A type of `ErrorInfo` that can be used to show/handle generic errors,
@@ -58,11 +60,11 @@ export interface ChildrenLoadErrorInfo {
  *
  * @public
  */
-export interface GenericErrorInfo {
-    id: string;
-    type: "Unknown";
-    message: string;
-    additionalData?: unknown;
+interface GenericErrorInfo {
+  id: string;
+  type: "Unknown";
+  message: string;
+  additionalData?: unknown;
 }
 /**
  * A collection of types that defines an error state for `TreeNode` node in a UI tree component, built
@@ -70,5 +72,7 @@ export interface GenericErrorInfo {
  *
  * @public
  */
-export type ErrorInfo = GenericErrorInfo | ResultSetTooLargeErrorInfo | NoFilterMatchesErrorInfo | ChildrenLoadErrorInfo;
+type ErrorInfo = GenericErrorInfo | ResultSetTooLargeErrorInfo | NoFilterMatchesErrorInfo | ChildrenLoadErrorInfo;
+//#endregion
+export { ErrorInfo, GenericErrorInfo, ResultSetTooLargeErrorInfo, TreeNode };
 //# sourceMappingURL=TreeNode.d.ts.map

package/lib/presentation-hierarchies-react/TreeNode.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"TreeNode.d.ts","names":[],"sources":["../../src/presentation-hierarchies-react/TreeNode.ts"],"mappings":";;;;;AAWA;;UAAiB,QAAA;EACf,EAAA;EACA,KAAA;EACA,QAAA,SAAiB,KAAA,CAAM,QAAA;EACvB,UAAA;EACA,SAAA;EACA,YAAA;EACA,UAAA;EALA;EAOA,QAAA,EAAU,aAAA;EANO;EAQjB,KAAA,GAAQ,SAAA;AAAA;;;;;;;UASO,wBAAA;EACf,EAAA;EACA,IAAA;AAAA;;;;;AAUF;;;UAAiB,0BAAA;EACf,EAAA;EACA,IAAA;EACA,kBAAA;AAAA;;AAUF;;;;;;UAAiB,qBAAA;EACf,EAAA;EACA,IAAA;EACA,OAAA;AAAA;;;;;;;;;UAWe,gBAAA;EACf,EAAA;EACA,IAAA;EACA,OAAA;EACA,cAAA;AAAA;;;;;;;KASU,SAAA,GAAY,gBAAA,GAAmB,0BAAA,GAA6B,wBAAA,GAA2B,qBAAA"}

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

@@ -1,7 +1,9 @@
-import { createIModelHierarchyProvider, HierarchyDefinition, HierarchySearchPath } from "@itwin/presentation-hierarchies";
-import { Props } from "@itwin/presentation-shared";
 import { UseUnifiedTreeSelectionProps } from "./internal/UseUnifiedSelection.js";
 import { UseTreeProps, UseTreeResult } from "./UseTree.js";
+import { HierarchyDefinition, HierarchySearchPath, createIModelHierarchyProvider } from "@itwin/presentation-hierarchies";
+import { Props } from "@itwin/presentation-shared";
+
+//#region src/presentation-hierarchies-react/UseIModelTree.d.ts
 /** @public */
 type IModelHierarchyProviderProps = Props<typeof createIModelHierarchyProvider>;
 /** @public */
@@ -10,18 +12,26 @@ type IModelAccess = IModelHierarchyProviderProps["imodelAccess"];
  * Props for `useIModelTree` and `useIModelUnifiedSelectionTree` hooks.
  * @public
  */
-type UseIModelTreeProps = Omit<UseTreeProps, "getHierarchyProvider" | "getSearchPaths"> & Pick<IModelHierarchyProviderProps, "localizedStrings" | "imodelAccess" | "imodelChanged"> & {
-    /** Provides the hierarchy definition for the tree. */
-    getHierarchyDefinition: (props: {
-        imodelAccess: IModelAccess;
-    }) => HierarchyDefinition;
-    /** Provides paths to target nodes. */
-    getSearchPaths?: (props: {
-        /** Object that provides access to the iModel schema and can run queries against the iModel. */
-        imodelAccess: IModelAccess;
-        /** Signal indicating that that the request was canceled */
-        abortSignal: AbortSignal;
-    }) => Promise<HierarchySearchPath[] | undefined>;
+type UseIModelTreeProps = Omit<UseTreeProps, "getHierarchyProvider" | "getSearchPaths"> & Pick<IModelHierarchyProviderProps, "imodelAccess" | "imodelChanged"> & {
+  /**
+   * Provides the hierarchy definition for the tree.
+   */
+  getHierarchyDefinition: (props: {
+    imodelAccess: IModelAccess;
+  }) => HierarchyDefinition;
+  /**
+   * Provides paths to target nodes.
+   */
+  getSearchPaths?: (props: {
+    /**
+     * Object that provides access to the iModel schema and can run queries against the iModel.
+     */
+    imodelAccess: IModelAccess;
+    /**
+     * Signal indicating that that the request was canceled
+     */
+    abortSignal: AbortSignal;
+  }) => Promise<HierarchySearchPath[] | undefined>;
 };
 /**
  * A React hook that creates state for a tree component whose displayed hierarchy is based on
@@ -36,7 +46,7 @@ type UseIModelTreeProps = Omit<UseTreeProps, "getHierarchyProvider" | "getSearch
  * @see `useIModelUnifiedSelectionTree`
  * @public
  */
-export declare function useIModelTree(props: UseIModelTreeProps): UseTreeResult;
+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 the given selection
@@ -52,6 +62,7 @@ export declare function useIModelTree(props: UseIModelTreeProps): UseTreeResult;
  * @see `UnifiedSelectionProvider`
  * @public
  */
-export declare function useIModelUnifiedSelectionTree(props: UseIModelTreeProps & UseUnifiedTreeSelectionProps): UseTreeResult;
-export {};
+declare function useIModelUnifiedSelectionTree(props: UseIModelTreeProps & UseUnifiedTreeSelectionProps): UseTreeResult;
+//#endregion
+export { useIModelTree, useIModelUnifiedSelectionTree };
 //# sourceMappingURL=UseIModelTree.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"UseIModelTree.d.ts","names":[],"sources":["../../src/presentation-hierarchies-react/UseIModelTree.ts"],"mappings":";;;;;;;KAgBK,4BAAA,GAA+B,KAAA,QAAa,6BAAA;;KAG5C,YAAA,GAAe,4BAAA;;;AAH0D;;KASzE,kBAAA,GAAqB,IAAA,CAAK,YAAA,+CAC7B,IAAA,CAAK,4BAAA;EAPa;;AAA4B;EAW5C,sBAAA,GAAyB,KAAA;IAAS,YAAA,EAAc,YAAA;EAAA,MAAmB,mBAAA;EAL7C;;;EAUtB,cAAA,IAAkB,KAAA;IALiD;;;IASjE,YAAA,EAAc,YAAA;IAKV;;;IADJ,WAAA,EAAa,WAAA;EAAA,MACT,OAAA,CAAQ,mBAAA;AAAA;;;;;;;;;;;;;;iBAgBF,aAAA,CAAc,KAAA,EAAO,kBAAA,GAAqB,aAAA;;;AAA1D;;;;;;;;;AAuBA;;;;iBAAgB,6BAAA,CAA8B,KAAA,EAAO,kBAAA,GAAqB,4BAAA,GAA+B,aAAA"}

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

@@ -0,0 +1,184 @@
+import { useTree, useUnifiedSelectionTree } from "./UseTree.js";
+import { useTranslation } from "./stratakit/LocalizationContext.js";
+import { c } from "react-compiler-runtime";
+import { createIModelHierarchyProvider } from "@itwin/presentation-hierarchies";
+
+//#region src/presentation-hierarchies-react/UseIModelTree.ts
+/**
+* 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`
+* @public
+*/
+function useIModelTree(props) {
+	const $ = c(14);
+	let getHierarchyDefinition;
+	let getSearchPaths;
+	let imodelAccess;
+	let imodelChanged;
+	let rest;
+	if ($[0] !== props) {
+		({imodelAccess, imodelChanged, getHierarchyDefinition, getSearchPaths, ...rest} = props);
+		$[0] = props;
+		$[1] = getHierarchyDefinition;
+		$[2] = getSearchPaths;
+		$[3] = imodelAccess;
+		$[4] = imodelChanged;
+		$[5] = rest;
+	} else {
+		getHierarchyDefinition = $[1];
+		getSearchPaths = $[2];
+		imodelAccess = $[3];
+		imodelChanged = $[4];
+		rest = $[5];
+	}
+	let t0;
+	if ($[6] !== getHierarchyDefinition || $[7] !== getSearchPaths || $[8] !== imodelAccess || $[9] !== imodelChanged) {
+		t0 = {
+			imodelAccess,
+			imodelChanged,
+			getHierarchyDefinition,
+			getSearchPaths
+		};
+		$[6] = getHierarchyDefinition;
+		$[7] = getSearchPaths;
+		$[8] = imodelAccess;
+		$[9] = imodelChanged;
+		$[10] = t0;
+	} else t0 = $[10];
+	const t1 = useIModelTreeProps(t0);
+	let t2;
+	if ($[11] !== rest || $[12] !== t1) {
+		t2 = {
+			...rest,
+			...t1
+		};
+		$[11] = rest;
+		$[12] = t1;
+		$[13] = t2;
+	} else t2 = $[13];
+	return useTree(t2);
+}
+/**
+* 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 the given selection
+* storage (previously the storage was provided through the, now deprecated, `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`
+* @public
+*/
+function useIModelUnifiedSelectionTree(props) {
+	const $ = c(14);
+	let getHierarchyDefinition;
+	let getSearchPaths;
+	let imodelAccess;
+	let imodelChanged;
+	let rest;
+	if ($[0] !== props) {
+		({imodelAccess, imodelChanged, getHierarchyDefinition, getSearchPaths, ...rest} = props);
+		$[0] = props;
+		$[1] = getHierarchyDefinition;
+		$[2] = getSearchPaths;
+		$[3] = imodelAccess;
+		$[4] = imodelChanged;
+		$[5] = rest;
+	} else {
+		getHierarchyDefinition = $[1];
+		getSearchPaths = $[2];
+		imodelAccess = $[3];
+		imodelChanged = $[4];
+		rest = $[5];
+	}
+	let t0;
+	if ($[6] !== getHierarchyDefinition || $[7] !== getSearchPaths || $[8] !== imodelAccess || $[9] !== imodelChanged) {
+		t0 = {
+			imodelAccess,
+			imodelChanged,
+			getHierarchyDefinition,
+			getSearchPaths
+		};
+		$[6] = getHierarchyDefinition;
+		$[7] = getSearchPaths;
+		$[8] = imodelAccess;
+		$[9] = imodelChanged;
+		$[10] = t0;
+	} else t0 = $[10];
+	const t1 = useIModelTreeProps(t0);
+	let t2;
+	if ($[11] !== rest || $[12] !== t1) {
+		t2 = {
+			...rest,
+			...t1
+		};
+		$[11] = rest;
+		$[12] = t1;
+		$[13] = t2;
+	} else t2 = $[13];
+	return useUnifiedSelectionTree(t2);
+}
+function useIModelTreeProps(props) {
+	const $ = c(11);
+	const { imodelAccess, imodelChanged, getHierarchyDefinition, getSearchPaths } = props;
+	const translate = useTranslation();
+	let t0;
+	if ($[0] !== getHierarchyDefinition || $[1] !== imodelAccess || $[2] !== imodelChanged || $[3] !== translate) {
+		t0 = () => createIModelHierarchyProvider({
+			imodelAccess,
+			imodelChanged,
+			hierarchyDefinition: getHierarchyDefinition({ imodelAccess }),
+			localizedStrings: {
+				other: translate("other"),
+				unspecified: translate("unspecified")
+			}
+		});
+		$[0] = getHierarchyDefinition;
+		$[1] = imodelAccess;
+		$[2] = imodelChanged;
+		$[3] = translate;
+		$[4] = t0;
+	} else t0 = $[4];
+	const t1 = t0;
+	let t2;
+	if ($[5] !== getSearchPaths || $[6] !== imodelAccess) {
+		t2 = async (t3) => {
+			const { abortSignal } = t3;
+			return getSearchPaths?.({
+				imodelAccess,
+				abortSignal
+			});
+		};
+		$[5] = getSearchPaths;
+		$[6] = imodelAccess;
+		$[7] = t2;
+	} else t2 = $[7];
+	const t3 = t2;
+	let t4;
+	if ($[8] !== t1 || $[9] !== t3) {
+		t4 = {
+			getHierarchyProvider: t1,
+			getSearchPaths: t3
+		};
+		$[8] = t1;
+		$[9] = t3;
+		$[10] = t4;
+	} else t4 = $[10];
+	return t4;
+}
+
+//#endregion
+export { useIModelTree, useIModelUnifiedSelectionTree };
+//# sourceMappingURL=UseIModelTree.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"UseIModelTree.js","names":["useCallback","createIModelHierarchyProvider","useTranslation","useTree","useUnifiedSelectionTree","HierarchyDefinition","HierarchySearchPath","Props","UseUnifiedTreeSelectionProps","UseTreeProps","UseTreeResult","IModelHierarchyProviderProps","IModelAccess","UseIModelTreeProps","Omit","Pick","getHierarchyDefinition","props","imodelAccess","getSearchPaths","abortSignal","AbortSignal","Promise","useIModelTree","$","_c","imodelChanged","rest","t0","t1","useIModelTreeProps","t2","useIModelUnifiedSelectionTree","translate","hierarchyDefinition","localizedStrings","other","unspecified","t3","t4","getHierarchyProvider"],"sources":["../../src/presentation-hierarchies-react/UseIModelTree.ts"],"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 } from \"@itwin/presentation-hierarchies\";\nimport { useTranslation } from \"./stratakit/LocalizationContext.js\";\nimport { useTree, useUnifiedSelectionTree } from \"./UseTree.js\";\n\nimport type { HierarchyDefinition, HierarchySearchPath } from \"@itwin/presentation-hierarchies\";\nimport type { Props } from \"@itwin/presentation-shared\";\nimport type { UseUnifiedTreeSelectionProps } from \"./internal/UseUnifiedSelection.js\";\nimport type { UseTreeProps, UseTreeResult } from \"./UseTree.js\";\n\n/** @public */\ntype IModelHierarchyProviderProps = Props<typeof createIModelHierarchyProvider>;\n\n/** @public */\ntype IModelAccess = IModelHierarchyProviderProps[\"imodelAccess\"];\n\n/**\n * Props for `useIModelTree` and `useIModelUnifiedSelectionTree` hooks.\n * @public\n */\ntype UseIModelTreeProps = Omit<UseTreeProps, \"getHierarchyProvider\" | \"getSearchPaths\"> &\n  Pick<IModelHierarchyProviderProps, \"imodelAccess\" | \"imodelChanged\"> & {\n    /**\n     * Provides the hierarchy definition for the tree.\n     */\n    getHierarchyDefinition: (props: { imodelAccess: IModelAccess }) => HierarchyDefinition;\n\n    /**\n     * Provides paths to target nodes.\n     */\n    getSearchPaths?: (props: {\n      /**\n       * Object that provides access to the iModel schema and can run queries against the iModel.\n       */\n      imodelAccess: IModelAccess;\n      /**\n       * Signal indicating that that the request was canceled\n       */\n      abortSignal: AbortSignal;\n    }) => Promise<HierarchySearchPath[] | 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 * @public\n */\nexport function useIModelTree(props: UseIModelTreeProps): UseTreeResult {\n  const { imodelAccess, imodelChanged, getHierarchyDefinition, getSearchPaths, ...rest } = props;\n  return useTree({\n    ...rest,\n    ...useIModelTreeProps({ imodelAccess, imodelChanged, getHierarchyDefinition, getSearchPaths }),\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 the given selection\n * storage (previously the storage was provided through the, now deprecated, `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 * @public\n */\nexport function useIModelUnifiedSelectionTree(props: UseIModelTreeProps & UseUnifiedTreeSelectionProps): UseTreeResult {\n  const { imodelAccess, imodelChanged, getHierarchyDefinition, getSearchPaths, ...rest } = props;\n  return useUnifiedSelectionTree({\n    ...rest,\n    ...useIModelTreeProps({ imodelAccess, imodelChanged, getHierarchyDefinition, getSearchPaths }),\n  });\n}\n\nfunction useIModelTreeProps(\n  props: Pick<UseIModelTreeProps, \"imodelAccess\" | \"imodelChanged\" | \"getHierarchyDefinition\" | \"getSearchPaths\">,\n): Pick<UseTreeProps, \"getHierarchyProvider\" | \"getSearchPaths\"> {\n  const { imodelAccess, imodelChanged, getHierarchyDefinition, getSearchPaths } = props;\n  const translate = useTranslation();\n  return {\n    getHierarchyProvider: useCallback(\n      () =>\n        createIModelHierarchyProvider({\n          imodelAccess,\n          imodelChanged,\n          hierarchyDefinition: getHierarchyDefinition({ imodelAccess }),\n          localizedStrings: {\n            other: translate(\"other\"),\n            unspecified: translate(\"unspecified\"),\n          },\n        }),\n      [imodelAccess, imodelChanged, translate, getHierarchyDefinition],\n    ),\n    getSearchPaths: useCallback(\n      async ({ abortSignal }: { abortSignal: AbortSignal }) => getSearchPaths?.({ imodelAccess, abortSignal }),\n      [imodelAccess, getSearchPaths],\n    ),\n  };\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;AA4DA,SAAOuB,cAAAN,OAAA;CAAA,MAAAO,IAAAC,EAAA,GAAA;CAAA,IAAAT;CAAA,IAAAG;CAAA,IAAAD;CAAA,IAAAQ;CAAA,IAAAC;AAAA,KAAAH,EAAA,OAAAP,OAAA;AACL,GAAA,CAAAC,cAAAQ,eAAAV,wBAAAG,mBAAAQ,QAAyFV;AAAMO,IAAA,KAAAP;AAAAO,IAAA,KAAAR;AAAAQ,IAAA,KAAAL;AAAAK,IAAA,KAAAN;AAAAM,IAAA,KAAAE;AAAAF,IAAA,KAAAG;QAAA;AAAAX,2BAAAQ,EAAA;AAAAL,mBAAAK,EAAA;AAAAN,iBAAAM,EAAA;AAAAE,kBAAAF,EAAA;AAAAG,SAAAH,EAAA;;CAAA,IAAAI;AAAA,KAAAJ,EAAA,OAAAR,0BAAAQ,EAAA,OAAAL,kBAAAK,EAAA,OAAAN,gBAAAM,EAAA,OAAAE,eAAA;AAGvEE,OAAA;GAAAV;GAAAQ;GAAAV;GAAAG;GAAuE;AAAAK,IAAA,KAAAR;AAAAQ,IAAA,KAAAL;AAAAK,IAAA,KAAAN;AAAAM,IAAA,KAAAE;AAAAF,IAAA,MAAAI;OAAAA,MAAAJ,EAAA;CAA1F,MAAAK,KAAAC,mBAAmBF,GAAwE;CAAA,IAAAG;AAAA,KAAAP,EAAA,QAAAG,QAAAH,EAAA,QAAAK,IAAA;AAFjFE,OAAA;GAAA,GACVJ;GAAI,GACJE;GACJ;AAAAL,IAAA,MAAAG;AAAAH,IAAA,MAAAK;AAAAL,IAAA,MAAAO;OAAAA,MAAAP,EAAA;AAAA,QAHMrB,QAAQ4B,GAGb;;;;;;;;;;;;;;;;;AAkBJ,SAAOC,8BAAAf,OAAA;CAAA,MAAAO,IAAAC,EAAA,GAAA;CAAA,IAAAT;CAAA,IAAAG;CAAA,IAAAD;CAAA,IAAAQ;CAAA,IAAAC;AAAA,KAAAH,EAAA,OAAAP,OAAA;AACL,GAAA,CAAAC,cAAAQ,eAAAV,wBAAAG,mBAAAQ,QAAyFV;AAAMO,IAAA,KAAAP;AAAAO,IAAA,KAAAR;AAAAQ,IAAA,KAAAL;AAAAK,IAAA,KAAAN;AAAAM,IAAA,KAAAE;AAAAF,IAAA,KAAAG;QAAA;AAAAX,2BAAAQ,EAAA;AAAAL,mBAAAK,EAAA;AAAAN,iBAAAM,EAAA;AAAAE,kBAAAF,EAAA;AAAAG,SAAAH,EAAA;;CAAA,IAAAI;AAAA,KAAAJ,EAAA,OAAAR,0BAAAQ,EAAA,OAAAL,kBAAAK,EAAA,OAAAN,gBAAAM,EAAA,OAAAE,eAAA;AAGvEE,OAAA;GAAAV;GAAAQ;GAAAV;GAAAG;GAAuE;AAAAK,IAAA,KAAAR;AAAAQ,IAAA,KAAAL;AAAAK,IAAA,KAAAN;AAAAM,IAAA,KAAAE;AAAAF,IAAA,MAAAI;OAAAA,MAAAJ,EAAA;CAA1F,MAAAK,KAAAC,mBAAmBF,GAAwE;CAAA,IAAAG;AAAA,KAAAP,EAAA,QAAAG,QAAAH,EAAA,QAAAK,IAAA;AAFjEE,OAAA;GAAA,GAC1BJ;GAAI,GACJE;GACJ;AAAAL,IAAA,MAAAG;AAAAH,IAAA,MAAAK;AAAAL,IAAA,MAAAO;OAAAA,MAAAP,EAAA;AAAA,QAHMpB,wBAAwB2B,GAG7B;;AAGJ,SAAAD,mBAAAb,OAAA;CAAA,MAAAO,IAAAC,EAAA,GAAA;CAGE,MAAA,EAAAP,cAAAQ,eAAAV,wBAAAG,mBAAgFF;CAChF,MAAAgB,YAAkB/B,gBAAgB;CAAC,IAAA0B;AAAA,KAAAJ,EAAA,OAAAR,0BAAAQ,EAAA,OAAAN,gBAAAM,EAAA,OAAAE,iBAAAF,EAAA,OAAAS,WAAA;AAG/BL,aACE3B,8BAA8B;GAAAiB;GAAAQ;GAAAQ,qBAGPlB,uBAAuB,EAAAE,cAAgB,CAAC;GAAAiB,kBAC3C;IAAAC,OACTH,UAAU,QAAQ;IAAAI,aACZJ,UAAU,cAAa;IACtC;GACD,CAAC;AAAAT,IAAA,KAAAR;AAAAQ,IAAA,KAAAN;AAAAM,IAAA,KAAAE;AAAAF,IAAA,KAAAS;AAAAT,IAAA,KAAAI;OAAAA,MAAAJ,EAAA;CAVgB,MAAAK,KAAAD;CAYrB,IAAAG;AAAA,KAAAP,EAAA,OAAAL,kBAAAK,EAAA,OAAAN,cAAA;AAECa,OAAA,OAAAO,OAAA;GAAO,MAAA,EAAAlB,gBAAAkB;AAA6C,UAAKnB,iBAAiB;IAAAD;IAAAE;IAA6B,CAAC;;AAAAI,IAAA,KAAAL;AAAAK,IAAA,KAAAN;AAAAM,IAAA,KAAAO;OAAAA,MAAAP,EAAA;CAD1F,MAAAc,KAAAP;CAGf,IAAAQ;AAAA,KAAAf,EAAA,OAAAK,MAAAL,EAAA,OAAAc,IAAA;AAjBIC,OAAA;GAAAC,sBACiBX;GAYrBV,gBACemB;GAIjB;AAAAd,IAAA,KAAAK;AAAAL,IAAA,KAAAc;AAAAd,IAAA,MAAAe;OAAAA,MAAAf,EAAA;AAAA,QAlBMe"}