@itwin/presentation-hierarchies-react 0.6.0 → 0.7.0

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,GAId,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;AAyGD,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,KAAiD,EAAE,EAAE;YAC3E,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  HierarchyNodeIdentifiersPath,\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 */\ninterface UseTreeProps extends Pick<Parameters<typeof createHierarchyProvider>[0], \"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<HierarchyNodeIdentifiersPath[] | 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: HierarchyNodeIdentifiersPath[] | 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,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"]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@itwin/presentation-hierarchies-react",
-  "version": "0.6.0",
+  "version": "0.7.0",
   "description": "React components based on `@itwin/presentation-hierarchies`",
   "license": "MIT",
   "author": {
@@ -37,9 +37,9 @@
     "immer": "^10.0.4",
     "react-error-boundary": "^4.0.13",
     "rxjs": "^7.8.1",
-    "@itwin/presentation-hierarchies": "^0.3.0",
-    "@itwin/presentation-shared": "^0.3.2",
-    "@itwin/unified-selection": "^0.4.5"
+    "@itwin/presentation-hierarchies": "^0.4.0",
+    "@itwin/presentation-shared": "^0.4.0",
+    "@itwin/unified-selection": "^0.4.6"
   },
   "peerDependencies": {
     "@itwin/itwinui-react": "^3.0.0",
@@ -54,35 +54,35 @@
   "devDependencies": {
     "@itwin/build-tools": "^4.7.1",
     "@itwin/itwinui-react": "^3.12.1",
-    "@testing-library/dom": "^9.3.4",
-    "@testing-library/react": "^14.3.1",
+    "@testing-library/dom": "^10.3.2",
+    "@testing-library/react": "^16.0.0",
     "@testing-library/user-event": "^14.5.2",
-    "@types/chai": "^4.3.14",
+    "@types/chai": "^4.3.16",
     "@types/chai-as-promised": "^7.1.8",
     "@types/chai-subset": "^1.3.5",
-    "@types/jsdom": "^21.1.6",
-    "@types/mocha": "^10.0.6",
-    "@types/react": "^18.2.79",
-    "@types/react-dom": "^18.2.25",
+    "@types/jsdom": "^21.1.7",
+    "@types/mocha": "^10.0.7",
+    "@types/react": "^18.3.3",
+    "@types/react-dom": "^18.3.0",
     "@types/sinon": "^17.0.3",
     "@types/sinon-chai": "^3.2.12",
     "chai": "^4.4.1",
-    "chai-as-promised": "^7.1.1",
+    "chai-as-promised": "^7.1.2",
     "chai-subset": "^1.6.0",
     "cpx2": "^7.0.1",
     "eslint": "^8.57.0",
     "eslint-plugin-react": "^7.34.1",
     "global-jsdom": "^24.0.0",
     "ignore-styles": "^5.0.1",
-    "jsdom": "^24.0.0",
-    "mocha": "^10.4.0",
-    "nyc": "^15.1.0",
-    "react": "^18.2.0",
-    "react-dom": "^18.2.0",
-    "rimraf": "^5.0.5",
-    "sinon": "^17.0.1",
+    "jsdom": "^24.1.0",
+    "mocha": "^10.6.0",
+    "nyc": "^17.0.0",
+    "react": "^18.3.1",
+    "react-dom": "^18.3.1",
+    "rimraf": "^6.0.1",
+    "sinon": "^18.0.0",
     "sinon-chai": "^3.7.0",
-    "typescript": "~5.4.5",
+    "typescript": "~5.5.3",
     "presentation-build-tools": "^0.0.0",
     "presentation-test-utilities": "^0.0.0"
   },
@@ -99,6 +99,8 @@
     "test": "mocha --enable-source-maps --config ./.mocharc.json \"./lib/cjs/test/**/*.test.js\"",
     "test:watch": "npm -s test -- --reporter min --watch-extensions ts,tsx --watch",
     "extract-api": "extract-api --entry=presentation-hierarchies-react --apiReportFolder=./api --apiReportTempFolder=./api/temp --apiSummaryFolder=./api",
-    "check-internal": "node ../../scripts/checkInternal.js --apiSummary ./api/presentation-hierarchies-react.api.md"
+    "check-internal": "node ../../scripts/checkInternal.js --apiSummary ./api/presentation-hierarchies-react.api.md",
+    "update-extractions": "node ../../scripts/updateExtractions.js --targets=./README.md",
+    "check-extractions": "node ../../scripts/updateExtractions.js --targets=./README.md --check"
   }
 }