@itwin/tree-widget-react 4.0.0-alpha.25 → 4.0.0-alpha.26

package/lib/esm/tree-widget-react/components/trees/common/internal/visibility/BaseSearchResultsTree.js.map

@@ -1 +1 @@
-{"version":3,"file":"BaseSearchResultsTree.js","sourceRoot":"","sources":["../../../../../../../../src/tree-widget-react/components/trees/common/internal/visibility/BaseSearchResultsTree.ts"],"names":[],"mappings":"AAAA;;;gGAGgG;AAEhG,OAAO,EAAE,IAAI,EAAE,MAAM,qBAAqB,CAAC;AAC3C,OAAO,EAAE,aAAa,EAAE,uBAAuB,EAAE,gBAAgB,EAAE,mBAAmB,EAAE,MAAM,iCAAiC,CAAC;AAgChI;;;;;;;GAOG;AACH,MAAM,OAAgB,yBAAyB;IAK7B,IAAI,GAAsD;QACxE,QAAQ,EAAE,IAAI,GAAG,EAAE;KACpB,CAAC;IACc,qBAAqB,GAAG,IAAI,KAAK,EAA0B,CAAC;IA0BrE,KAAK,CAAC,yBAAyB;QAGpC,MAAM,2BAA2B,GAAG,MAAM,IAAI,CAAC,8BAA8B,EAAE,CAAC;QAChF,OAAO;YACL,oBAAoB,EAAE,CAAC,IAAsE,EAAE,EAAE,CAC/F,IAAI,CAAC,oBAAoB,CAAC,IAAI,EAAE,2BAA2B,CAAC;SAC/D,CAAC;IACJ,CAAC;IAED,0DAA0D;IACnD,KAAK,CAAC,MAAM,CAAC,KAInB;QACC,MAAM,EAAE,WAAW,EAAE,UAAU,EAAE,cAAc,EAAE,GAAG,KAAK,CAAC;QAC1D,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,WAAW,CAAC,SAAS,CAAC,CAAC;QAEvD,MAAM,OAAO,GAAG,IAAI,CAAC,2BAA2B,CAAC;YAC/C,IAAI;YACJ,EAAE,EAAE,WAAW,CAAC,EAAE;YAClB,cAAc;YACd,MAAM,EAAE,UAAU;SACnB,CAAC,CAAC;QACH,CAAC,UAAU,CAAC,QAAQ,KAAK,IAAI,GAAG,EAAE,CAAC,CAAC,GAAG,CAAC,WAAW,CAAC,EAAE,EAAE,OAAO,CAAC,CAAC;QACjE,IAAI,CAAC,qBAAqB,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACzC,OAAO,OAAO,CAAC;IACjB,CAAC;IAED,uEAAuE;IAC/D,oBAAoB,CAC1B,IAAsE,EACtE,2BAAyD;QAEzD,IAAI,aAAa,GAAsF,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAEnH,qDAAqD;QACrD,KAAK,MAAM,SAAS,IAAI,IAAI,CAAC,UAAU,EAAE,CAAC;YACxC,IAAI,CAAC,gBAAgB,CAAC,WAAW,CAAC,SAAS,CAAC,EAAE,CAAC;gBAC7C,SAAS;YACX,CAAC;YAED,kJAAkJ;YAClJ,oEAAoE;YACpE,MAAM,WAAW,GAAG,IAAI,CAAC,8BAA8B,CACrD,aAAa,EACb,SAAS,CAAC,YAAY,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,EAAE,CAAC,CAC5C,CAAC;YACF,IAAI,WAAW,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;gBAC7B,OAAO,SAAS,CAAC;YACnB,CAAC;YACD,aAAa,GAAG,WAAW,CAAC;QAC9B,CAAC;QAED,MAAM,GAAG,GAAG,aAAa,CAAC,eAAe,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,YAAY,CAAC,GAAG,CAAC,CAAC,EAAE,EAAE,EAAE,EAAE,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,mBAAmB,CAAC,GAAG,CAAC,CAAC,EAAE,EAAE,EAAE,EAAE,EAAE,CAAC,EAAE,CAAC,CAAC;QAC3I,kDAAkD;QAClD,MAAM,kBAAkB,GAAG,IAAI,CAAC,8BAA8B,CAAC,aAAa,EAAE,GAAG,CAAC,CAAC;QACnF,IAAI,kBAAkB,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YACpC,OAAO,SAAS,CAAC;QACnB,CAAC;QAED,OAAO,IAAI,CAAC,2BAA2B,CAAC,kBAAkB,EAAE,2BAA2B,CAAC,CAAC;IAC3F,CAAC;IAED,4DAA4D;IACpD,8BAA8B,CAAC,aAAgG,EAAE,GAAY;QACnJ,OAAO,aAAa,CAAC,OAAO,CAAC,CAAC,MAAM,EAAE,EAAE;YACtC,MAAM,aAAa,GAAG,KAAK,EAA0B,CAAC;YACtD,KAAK,MAAM,EAAE,IAAI,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE,CAAC;gBACpC,MAAM,IAAI,GAAG,MAAM,CAAC,QAAQ,EAAE,GAAG,CAAC,EAAE,CAAC,CAAC;gBACtC,IAAI,IAAI,EAAE,CAAC;oBACT,aAAa,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;gBAC3B,CAAC;YACH,CAAC;YACD,OAAO,aAAa,CAAC;QACvB,CAAC,CAAC,CAAC;IACL,CAAC;CACF;AAiBD;;;GAGG;AACH,MAAM,CAAC,KAAK,UAAU,uBAAuB,CAI3C,KAAyG;IACzG,MAAM,EAAE,WAAW,EAAE,yBAAyB,EAAE,GAAG,KAAK,CAAC;IAEzD,KAAK,MAAM,UAAU,IAAI,WAAW,EAAE,CAAC;QACrC,MAAM,cAAc,GAAG,mBAAmB,CAAC,SAAS,CAAC,UAAU,CAAC,CAAC,IAAI,CAAC;QAEtE,IAAI,UAAU,GAA+E,yBAAyB,CAAC,IAAI,CAAC;QAC5H,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,cAAc,CAAC,MAAM,EAAE,EAAE,CAAC,EAAE,CAAC;YAC/C,IAAI,MAAM,IAAI,UAAU,IAAI,gBAAgB,IAAI,UAAU,IAAI,UAAU,CAAC,cAAc,EAAE,CAAC;gBACxF,MAAM;YACR,CAAC;YAED,MAAM,UAAU,GAAG,cAAc,CAAC,CAAC,CAAC,CAAC;YAErC,IAAI,CAAC,uBAAuB,CAAC,wBAAwB,CAAC,UAAU,CAAC,EAAE,CAAC;gBAClE,MAAM;YACR,CAAC;YAED,MAAM,WAAW,GAAuC,UAAU,CAAC,QAAQ,EAAE,GAAG,CAAC,UAAU,CAAC,EAAE,CAAC,CAAC;YAChG,IAAI,WAAW,KAAK,SAAS,EAAE,CAAC;gBAC9B,UAAU,GAAG,WAAW,CAAC;gBACzB,SAAS;YACX,CAAC;YACD,UAAU,GAAG,MAAM,yBAAyB,CAAC,MAAM,CAAC;gBAClD,WAAW,EAAE,UAAU;gBACvB,UAAU;gBACV,cAAc,EAAE,CAAC,KAAK,cAAc,CAAC,MAAM,GAAG,CAAC;aAChD,CAAC,CAAC;QACL,CAAC;IACH,CAAC;IACD,MAAM,2BAA2B,GAAG,MAAM,yBAAyB,CAAC,yBAAyB,EAAE,CAAC;IAChG,OAAO;QACL,gBAAgB,EAAE,CAAC,IAAsE,EAAE,EAAE,CAAC,2BAA2B,CAAC,oBAAoB,CAAC,IAAI,CAAC;KACrJ,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 { Id64 } from \"@itwin/core-bentley\";\nimport { HierarchyNode, HierarchyNodeIdentifier, HierarchyNodeKey, HierarchySearchPath } from \"@itwin/presentation-hierarchies\";\n\nimport type { Id64Arg, Id64String } from \"@itwin/core-bentley\";\nimport type { ClassGroupingNodeKey, InstancesNodeKey } from \"@itwin/presentation-hierarchies\";\nimport type { InstanceKey } from \"@itwin/presentation-shared\";\n\n/** @internal */\nexport type SearchResultsTreeNodeChildren<TSearchResultsTreeNode> = Map<Id64String, TSearchResultsTreeNode>;\n\n/**\n * A generic interface for a search results tree root node.\n *\n * It differs from `BaseSearchResultsTreeNode` in that it only contains children details and nothing else.\n * @internal\n */\nexport interface SearchResultsTreeRootNode<TSearchResultsTreeNode extends BaseSearchResultsTreeNode<TSearchResultsTreeNode>> {\n  children: SearchResultsTreeNodeChildren<TSearchResultsTreeNode>;\n}\n\n/**\n * A generic interface for a search results tree node.\n *\n * It represents every node in a search results tree structure.\n * @internal\n * */\nexport interface BaseSearchResultsTreeNode<TSearchResultsTreeNode extends BaseSearchResultsTreeNode<TSearchResultsTreeNode>> {\n  type: string;\n  id: Id64String;\n  children?: SearchResultsTreeNodeChildren<TSearchResultsTreeNode>;\n  isSearchTarget: boolean;\n}\n\n/**\n * Class that provides methods to handle search results nodes in a tree structure.\n *\n * It provides two methods that can be shared across different search results trees:\n * - `processSearchResultsNodes` - processes search results nodes and returns a function to get search targets for a node.\n * - `accept` - accepts a new node and adds it to the tree structure.\n * @internal\n */\nexport abstract class SearchResultsNodesHandler<\n  TProcessedSearchResultsNodes,\n  TSearchTargets,\n  TSearchResultsTreeNode extends BaseSearchResultsTreeNode<TSearchResultsTreeNode>,\n> {\n  public readonly root: SearchResultsTreeRootNode<TSearchResultsTreeNode> = {\n    children: new Map(),\n  };\n  public readonly searchResultsNodesArr = new Array<TSearchResultsTreeNode>();\n\n  /** Returns search results tree node type based on its' className */\n  public abstract getType(className: string): Promise<TSearchResultsTreeNode[\"type\"]>;\n  /** Converts nodes to search targets */\n  public abstract convertNodesToSearchTargets(\n    searchResultsNodes: TSearchResultsTreeNode[],\n    processedSearchResultsNodes: TProcessedSearchResultsNodes,\n  ): TSearchTargets | undefined;\n  /**\n   * Processes search results nodes.\n   *\n   * Nodes are created using search paths, and some information is not present in the search paths.\n   * Because of this, some nodes may need to be processed to get additional information.\n   *\n   * E.g. Retrieving categoryId of elements can't be done using search paths.\n   */\n  public abstract getProcessedSearchResultsNodes(): Promise<TProcessedSearchResultsNodes>;\n  /** Creates search results nodes  */\n  public abstract createSearchResultsTreeNode(props: {\n    type: TSearchResultsTreeNode[\"type\"];\n    id: Id64String;\n    isSearchTarget: boolean;\n    parent: TSearchResultsTreeNode | SearchResultsTreeRootNode<TSearchResultsTreeNode>;\n  }): TSearchResultsTreeNode;\n\n  public async processSearchResultsNodes(): Promise<{\n    getNodeSearchTargets: (node: HierarchyNode & { key: ClassGroupingNodeKey | InstancesNodeKey }) => TSearchTargets | undefined;\n  }> {\n    const processedSearchResultsNodes = await this.getProcessedSearchResultsNodes();\n    return {\n      getNodeSearchTargets: (node: HierarchyNode & { key: ClassGroupingNodeKey | InstancesNodeKey }) =>\n        this.getNodeSearchTargets(node, processedSearchResultsNodes),\n    };\n  }\n\n  /** Takes a new node and adds it to the tree structure. */\n  public async accept(props: {\n    instanceKey: InstanceKey;\n    parentNode: TSearchResultsTreeNode | SearchResultsTreeRootNode<TSearchResultsTreeNode>;\n    isSearchTarget: boolean;\n  }): Promise<TSearchResultsTreeNode> {\n    const { instanceKey, parentNode, isSearchTarget } = props;\n    const type = await this.getType(instanceKey.className);\n\n    const newNode = this.createSearchResultsTreeNode({\n      type,\n      id: instanceKey.id,\n      isSearchTarget,\n      parent: parentNode,\n    });\n    (parentNode.children ??= new Map()).set(instanceKey.id, newNode);\n    this.searchResultsNodesArr.push(newNode);\n    return newNode;\n  }\n\n  /** Takes a specific node and gets all search targets related to it. */\n  private getNodeSearchTargets(\n    node: HierarchyNode & { key: ClassGroupingNodeKey | InstancesNodeKey },\n    processedSearchResultsNodes: TProcessedSearchResultsNodes,\n  ): TSearchTargets | undefined {\n    let lookupParents: Array<SearchResultsTreeRootNode<TSearchResultsTreeNode> | TSearchResultsTreeNode> = [this.root];\n\n    // find the search results parent nodes of the `node`\n    for (const parentKey of node.parentKeys) {\n      if (!HierarchyNodeKey.isInstances(parentKey)) {\n        continue;\n      }\n\n      // tree node might be merged from multiple instances. As search results tree stores only one instance per node, we need to find all matching nodes\n      // and use them when checking for matching node in one level deeper.\n      const parentNodes = this.findMatchingSearchResultsNodes(\n        lookupParents,\n        parentKey.instanceKeys.map((key) => key.id),\n      );\n      if (parentNodes.length === 0) {\n        return undefined;\n      }\n      lookupParents = parentNodes;\n    }\n\n    const ids = HierarchyNode.isInstancesNode(node) ? node.key.instanceKeys.map(({ id }) => id) : node.groupedInstanceKeys.map(({ id }) => id);\n    // find search results nodes that match the `node`\n    const searchResultsNodes = this.findMatchingSearchResultsNodes(lookupParents, ids);\n    if (searchResultsNodes.length === 0) {\n      return undefined;\n    }\n\n    return this.convertNodesToSearchTargets(searchResultsNodes, processedSearchResultsNodes);\n  }\n\n  /** Finds search results nodes that match the given keys. */\n  private findMatchingSearchResultsNodes(lookupParents: Array<SearchResultsTreeRootNode<TSearchResultsTreeNode> | TSearchResultsTreeNode>, ids: Id64Arg) {\n    return lookupParents.flatMap((lookup) => {\n      const childrenArray = Array<TSearchResultsTreeNode>();\n      for (const id of Id64.iterable(ids)) {\n        const node = lookup.children?.get(id);\n        if (node) {\n          childrenArray.push(node);\n        }\n      }\n      return childrenArray;\n    });\n  }\n}\n\n/** @internal */\nexport interface SearchResultsTree<TSearchTargets> {\n  getSearchTargets: (node: HierarchyNode & { key: ClassGroupingNodeKey | InstancesNodeKey }) => TSearchTargets | undefined;\n}\n\n/** @internal */\nexport interface CreateSearchResultsTreeProps<\n  TProcessedSearchResultsNodes,\n  TSearchTargets,\n  TSearchResultsTreeNode extends BaseSearchResultsTreeNode<TSearchResultsTreeNode>,\n> {\n  searchResultsNodesHandler: SearchResultsNodesHandler<TProcessedSearchResultsNodes, TSearchTargets, TSearchResultsTreeNode>;\n  searchPaths: HierarchySearchPath[];\n}\n\n/**\n * Function iterates over search paths and uses `searchResultsNodesHandler` to create a search results tree.\n * @internal\n */\nexport async function createSearchResultsTree<\n  TProcessedSearchResultsNodes,\n  TSearchTargets,\n  TSearchResultsTreeNode extends BaseSearchResultsTreeNode<TSearchResultsTreeNode>,\n>(props: CreateSearchResultsTreeProps<TProcessedSearchResultsNodes, TSearchTargets, TSearchResultsTreeNode>): Promise<SearchResultsTree<TSearchTargets>> {\n  const { searchPaths, searchResultsNodesHandler } = props;\n\n  for (const searchPath of searchPaths) {\n    const normalizedPath = HierarchySearchPath.normalize(searchPath).path;\n\n    let parentNode: SearchResultsTreeRootNode<TSearchResultsTreeNode> | TSearchResultsTreeNode = searchResultsNodesHandler.root;\n    for (let i = 0; i < normalizedPath.length; ++i) {\n      if (\"type\" in parentNode && \"isSearchTarget\" in parentNode && parentNode.isSearchTarget) {\n        break;\n      }\n\n      const identifier = normalizedPath[i];\n\n      if (!HierarchyNodeIdentifier.isInstanceNodeIdentifier(identifier)) {\n        break;\n      }\n\n      const currentNode: TSearchResultsTreeNode | undefined = parentNode.children?.get(identifier.id);\n      if (currentNode !== undefined) {\n        parentNode = currentNode;\n        continue;\n      }\n      parentNode = await searchResultsNodesHandler.accept({\n        instanceKey: identifier,\n        parentNode,\n        isSearchTarget: i === normalizedPath.length - 1,\n      });\n    }\n  }\n  const processedSearchResultsNodes = await searchResultsNodesHandler.processSearchResultsNodes();\n  return {\n    getSearchTargets: (node: HierarchyNode & { key: ClassGroupingNodeKey | InstancesNodeKey }) => processedSearchResultsNodes.getNodeSearchTargets(node),\n  };\n}\n"]}
+{"version":3,"file":"BaseSearchResultsTree.js","sourceRoot":"","sources":["../../../../../../../../src/tree-widget-react/components/trees/common/internal/visibility/BaseSearchResultsTree.ts"],"names":[],"mappings":"AAAA;;;gGAGgG;AAEhG,OAAO,EAAE,IAAI,EAAE,MAAM,qBAAqB,CAAC;AAC3C,OAAO,EAAE,aAAa,EAAE,uBAAuB,EAAE,gBAAgB,EAAE,mBAAmB,EAAE,MAAM,iCAAiC,CAAC;AA6ChI;;;;;;;GAOG;AACH,MAAM,OAAgB,yBAAyB;IAK7B,IAAI,GAAsD;QACxE,QAAQ,EAAE,IAAI,GAAG,EAAE;KACpB,CAAC;IACc,qBAAqB,GAAG,IAAI,KAAK,EAA0B,CAAC;IA4BrE,KAAK,CAAC,yBAAyB;QAGpC,MAAM,2BAA2B,GAAG,MAAM,IAAI,CAAC,8BAA8B,EAAE,CAAC;QAChF,OAAO;YACL,oBAAoB,EAAE,CAAC,IAAsE,EAAE,EAAE,CAC/F,IAAI,CAAC,oBAAoB,CAAC,IAAI,EAAE,2BAA2B,CAAC;SAC/D,CAAC;IACJ,CAAC;IAED,4EAA4E;IACrE,0CAA0C,CAAC,UAAuC;QACvF,OAAO,GAAG,UAAU,CAAC,IAAI,IAAI,UAAU,CAAC,EAAE,EAAE,CAAC;IAC/C,CAAC;IAED,gHAAgH;IACzG,iEAAiE,CAAC,UAA+C;QACtH,MAAM,CAAC,IAAI,EAAE,EAAE,CAAC,GAAG,UAAU,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;QACzC,OAAO,EAAE,SAAS,EAAE,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,EAAE,EAAE,EAAE,CAAC;IACpD,CAAC;IAED,0DAA0D;IACnD,KAAK,CAAC,MAAM,CAAC,KAInB;QACC,MAAM,EAAE,WAAW,EAAE,UAAU,EAAE,cAAc,EAAE,GAAG,KAAK,CAAC;QAC1D,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,WAAW,CAAC,SAAS,CAAC,CAAC;QAEvD,MAAM,OAAO,GAAG,IAAI,CAAC,2BAA2B,CAAC;YAC/C,IAAI;YACJ,EAAE,EAAE,WAAW,CAAC,EAAE;YAClB,cAAc;YACd,MAAM,EAAE,UAAU;SACnB,CAAC,CAAC;QACH,CAAC,UAAU,CAAC,QAAQ,KAAK,IAAI,GAAG,EAAE,CAAC,CAAC,GAAG,CAAC,WAAW,CAAC,EAAE,EAAE,OAAO,CAAC,CAAC;QACjE,IAAI,CAAC,qBAAqB,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACzC,OAAO,OAAO,CAAC;IACjB,CAAC;IAED,uEAAuE;IAC/D,oBAAoB,CAC1B,IAAsE,EACtE,2BAAyD;QAEzD,IAAI,aAAa,GAAsF,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAEnH,qDAAqD;QACrD,KAAK,MAAM,SAAS,IAAI,IAAI,CAAC,UAAU,EAAE,CAAC;YACxC,IAAI,CAAC,gBAAgB,CAAC,WAAW,CAAC,SAAS,CAAC,EAAE,CAAC;gBAC7C,SAAS;YACX,CAAC;YAED,kJAAkJ;YAClJ,oEAAoE;YACpE,MAAM,WAAW,GAAG,IAAI,CAAC,8BAA8B,CACrD,aAAa,EACb,SAAS,CAAC,YAAY,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,EAAE,CAAC,CAC5C,CAAC;YACF,IAAI,WAAW,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;gBAC7B,OAAO,SAAS,CAAC;YACnB,CAAC;YACD,aAAa,GAAG,WAAW,CAAC;QAC9B,CAAC;QAED,MAAM,GAAG,GAAG,aAAa,CAAC,eAAe,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,YAAY,CAAC,GAAG,CAAC,CAAC,EAAE,EAAE,EAAE,EAAE,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,mBAAmB,CAAC,GAAG,CAAC,CAAC,EAAE,EAAE,EAAE,EAAE,EAAE,CAAC,EAAE,CAAC,CAAC;QAC3I,kDAAkD;QAClD,MAAM,kBAAkB,GAAG,IAAI,CAAC,8BAA8B,CAAC,aAAa,EAAE,GAAG,CAAC,CAAC;QACnF,IAAI,kBAAkB,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YACpC,OAAO,SAAS,CAAC;QACnB,CAAC;QAED,OAAO,IAAI,CAAC,2BAA2B,CAAC,kBAAkB,EAAE,2BAA2B,CAAC,CAAC;IAC3F,CAAC;IAED,4DAA4D;IACpD,8BAA8B,CAAC,aAAgG,EAAE,GAAY;QACnJ,OAAO,aAAa,CAAC,OAAO,CAAC,CAAC,MAAM,EAAE,EAAE;YACtC,MAAM,aAAa,GAAG,KAAK,EAA0B,CAAC;YACtD,KAAK,MAAM,EAAE,IAAI,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE,CAAC;gBACpC,MAAM,IAAI,GAAG,MAAM,CAAC,QAAQ,EAAE,GAAG,CAAC,EAAE,CAAC,CAAC;gBACtC,IAAI,IAAI,EAAE,CAAC;oBACT,aAAa,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;gBAC3B,CAAC;YACH,CAAC;YACD,OAAO,aAAa,CAAC;QACvB,CAAC,CAAC,CAAC;IACL,CAAC;CACF;AAiBD;;;GAGG;AACH,MAAM,CAAC,KAAK,UAAU,uBAAuB,CAI3C,KAAyG;IACzG,MAAM,EAAE,WAAW,EAAE,yBAAyB,EAAE,GAAG,KAAK,CAAC;IACzD,kJAAkJ;IAClJ,0JAA0J;IAC1J,iDAAiD;IACjD,MAAM,iBAAiB,GAAG,WAAW,CAAC,IAAI,CAAC,CAAC,GAAG,EAAE,GAAG,EAAE,EAAE,CAAC,mBAAmB,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,MAAM,GAAG,mBAAmB,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;IAC1J,KAAK,MAAM,UAAU,IAAI,iBAAiB,EAAE,CAAC;QAC3C,MAAM,cAAc,GAAG,mBAAmB,CAAC,SAAS,CAAC,UAAU,CAAC,CAAC,IAAI,CAAC;QAEtE,IAAI,UAAU,GAA+E,yBAAyB,CAAC,IAAI,CAAC;QAC5H,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,cAAc,CAAC,MAAM,EAAE,EAAE,CAAC,EAAE,CAAC;YAC/C,IAAI,MAAM,IAAI,UAAU,IAAI,gBAAgB,IAAI,UAAU,IAAI,UAAU,CAAC,cAAc,EAAE,CAAC;gBACxF,MAAM;YACR,CAAC;YAED,MAAM,UAAU,GAAG,cAAc,CAAC,CAAC,CAAC,CAAC;YAErC,IAAI,CAAC,uBAAuB,CAAC,wBAAwB,CAAC,UAAU,CAAC,EAAE,CAAC;gBAClE,MAAM;YACR,CAAC;YAED,MAAM,WAAW,GAAuC,UAAU,CAAC,QAAQ,EAAE,GAAG,CAAC,UAAU,CAAC,EAAE,CAAC,CAAC;YAChG,IAAI,WAAW,KAAK,SAAS,EAAE,CAAC;gBAC9B,UAAU,GAAG,WAAW,CAAC;gBACzB,SAAS;YACX,CAAC;YACD,UAAU,GAAG,MAAM,yBAAyB,CAAC,MAAM,CAAC;gBAClD,WAAW,EAAE,UAAU;gBACvB,UAAU;gBACV,cAAc,EAAE,CAAC,KAAK,cAAc,CAAC,MAAM,GAAG,CAAC;aAChD,CAAC,CAAC;QACL,CAAC;IACH,CAAC;IACD,MAAM,2BAA2B,GAAG,MAAM,yBAAyB,CAAC,yBAAyB,EAAE,CAAC;IAChG,OAAO;QACL,gBAAgB,EAAE,CAAC,IAAsE,EAAE,EAAE,CAAC,2BAA2B,CAAC,oBAAoB,CAAC,IAAI,CAAC;KACrJ,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 { Id64 } from \"@itwin/core-bentley\";\nimport { HierarchyNode, HierarchyNodeIdentifier, HierarchyNodeKey, HierarchySearchPath } from \"@itwin/presentation-hierarchies\";\n\nimport type { Id64Arg, Id64String } from \"@itwin/core-bentley\";\nimport type { ClassGroupingNodeKey, InstancesNodeKey } from \"@itwin/presentation-hierarchies\";\nimport type { InstanceKey } from \"@itwin/presentation-shared\";\n\n/** @internal */\nexport type SearchResultsTreeNodeChildren<TSearchResultsTreeNode> = Map<Id64String, TSearchResultsTreeNode>;\n\n/**\n * A generic interface for a search results tree root node.\n *\n * It differs from `BaseSearchResultsTreeNode` in that it only contains children details and nothing else.\n * @internal\n */\nexport interface SearchResultsTreeRootNode<TSearchResultsTreeNode extends BaseSearchResultsTreeNode<TSearchResultsTreeNode>> {\n  children: SearchResultsTreeNodeChildren<TSearchResultsTreeNode>;\n}\n\ntype SearchResultsNodeType = string;\ntype SearchResultsNodeId = Id64String;\n\n/** @internal */\nexport interface SearchResultsNodeIdentifier {\n  type: SearchResultsNodeType;\n  id: SearchResultsNodeId;\n}\n/** @internal */\nexport type SearchResultsNodeIdentifierAsString = `${SearchResultsNodeType}-${SearchResultsNodeId}`;\n\n/**\n * A generic interface for a search results tree node.\n *\n * It represents every node in a search results tree structure.\n * @internal\n * */\nexport interface BaseSearchResultsTreeNode<TSearchResultsTreeNode extends BaseSearchResultsTreeNode<TSearchResultsTreeNode>> {\n  type: string;\n  id: Id64String;\n  children?: SearchResultsTreeNodeChildren<TSearchResultsTreeNode>;\n  isSearchTarget: boolean;\n  /** Represents the path from the root to this node. It depends on the hierarchy structure. */\n  pathToNode: Array<SearchResultsNodeIdentifier>;\n}\n\n/**\n * Class that provides methods to handle search results nodes in a tree structure.\n *\n * It provides two methods that can be shared across different search results trees:\n * - `processSearchResultsNodes` - processes search results nodes and returns a function to get search targets for a node.\n * - `accept` - accepts a new node and adds it to the tree structure.\n * @internal\n */\nexport abstract class SearchResultsNodesHandler<\n  TProcessedSearchResultsNodes,\n  TSearchTargets,\n  TSearchResultsTreeNode extends BaseSearchResultsTreeNode<TSearchResultsTreeNode>,\n> {\n  public readonly root: SearchResultsTreeRootNode<TSearchResultsTreeNode> = {\n    children: new Map(),\n  };\n  public readonly searchResultsNodesArr = new Array<TSearchResultsTreeNode>();\n\n  /** Returns search results tree node type based on its' className */\n  public abstract getType(className: string): Promise<TSearchResultsTreeNode[\"type\"]>;\n  /** Returns search results tree node className based on its' type */\n  public abstract getClassName(type: TSearchResultsTreeNode[\"type\"]): string;\n  /** Converts nodes to search targets */\n  public abstract convertNodesToSearchTargets(\n    searchResultsNodes: TSearchResultsTreeNode[],\n    processedSearchResultsNodes: TProcessedSearchResultsNodes,\n  ): TSearchTargets | undefined;\n  /**\n   * Processes search results nodes.\n   *\n   * Nodes are created using search paths, and some information is not present in the search paths.\n   * Because of this, some nodes may need to be processed to get additional information.\n   *\n   * E.g. Retrieving categoryId of elements can't be done using search paths.\n   */\n  public abstract getProcessedSearchResultsNodes(): Promise<TProcessedSearchResultsNodes>;\n  /** Creates search results nodes  */\n  public abstract createSearchResultsTreeNode(props: {\n    type: TSearchResultsTreeNode[\"type\"];\n    id: Id64String;\n    isSearchTarget: boolean;\n    parent: TSearchResultsTreeNode | SearchResultsTreeRootNode<TSearchResultsTreeNode>;\n  }): TSearchResultsTreeNode;\n\n  public async processSearchResultsNodes(): Promise<{\n    getNodeSearchTargets: (node: HierarchyNode & { key: ClassGroupingNodeKey | InstancesNodeKey }) => TSearchTargets | undefined;\n  }> {\n    const processedSearchResultsNodes = await this.getProcessedSearchResultsNodes();\n    return {\n      getNodeSearchTargets: (node: HierarchyNode & { key: ClassGroupingNodeKey | InstancesNodeKey }) =>\n        this.getNodeSearchTargets(node, processedSearchResultsNodes),\n    };\n  }\n\n  /** Converts a search results node identifier to a string representation. */\n  public convertSearchResultsNodeIdentifierToString(identifier: SearchResultsNodeIdentifier): SearchResultsNodeIdentifierAsString {\n    return `${identifier.type}-${identifier.id}`;\n  }\n\n  /** Converts a string representation of a search results node identifier back to a hierarchy node identifier. */\n  public convertSearchResultsNodeIdentifierStringToHierarchyNodeIdentifier(identifier: SearchResultsNodeIdentifierAsString): InstanceKey {\n    const [type, id] = identifier.split(\"-\");\n    return { className: this.getClassName(type), id };\n  }\n\n  /** Takes a new node and adds it to the tree structure. */\n  public async accept(props: {\n    instanceKey: InstanceKey;\n    parentNode: TSearchResultsTreeNode | SearchResultsTreeRootNode<TSearchResultsTreeNode>;\n    isSearchTarget: boolean;\n  }): Promise<TSearchResultsTreeNode> {\n    const { instanceKey, parentNode, isSearchTarget } = props;\n    const type = await this.getType(instanceKey.className);\n\n    const newNode = this.createSearchResultsTreeNode({\n      type,\n      id: instanceKey.id,\n      isSearchTarget,\n      parent: parentNode,\n    });\n    (parentNode.children ??= new Map()).set(instanceKey.id, newNode);\n    this.searchResultsNodesArr.push(newNode);\n    return newNode;\n  }\n\n  /** Takes a specific node and gets all search targets related to it. */\n  private getNodeSearchTargets(\n    node: HierarchyNode & { key: ClassGroupingNodeKey | InstancesNodeKey },\n    processedSearchResultsNodes: TProcessedSearchResultsNodes,\n  ): TSearchTargets | undefined {\n    let lookupParents: Array<SearchResultsTreeRootNode<TSearchResultsTreeNode> | TSearchResultsTreeNode> = [this.root];\n\n    // find the search results parent nodes of the `node`\n    for (const parentKey of node.parentKeys) {\n      if (!HierarchyNodeKey.isInstances(parentKey)) {\n        continue;\n      }\n\n      // tree node might be merged from multiple instances. As search results tree stores only one instance per node, we need to find all matching nodes\n      // and use them when checking for matching node in one level deeper.\n      const parentNodes = this.findMatchingSearchResultsNodes(\n        lookupParents,\n        parentKey.instanceKeys.map((key) => key.id),\n      );\n      if (parentNodes.length === 0) {\n        return undefined;\n      }\n      lookupParents = parentNodes;\n    }\n\n    const ids = HierarchyNode.isInstancesNode(node) ? node.key.instanceKeys.map(({ id }) => id) : node.groupedInstanceKeys.map(({ id }) => id);\n    // find search results nodes that match the `node`\n    const searchResultsNodes = this.findMatchingSearchResultsNodes(lookupParents, ids);\n    if (searchResultsNodes.length === 0) {\n      return undefined;\n    }\n\n    return this.convertNodesToSearchTargets(searchResultsNodes, processedSearchResultsNodes);\n  }\n\n  /** Finds search results nodes that match the given keys. */\n  private findMatchingSearchResultsNodes(lookupParents: Array<SearchResultsTreeRootNode<TSearchResultsTreeNode> | TSearchResultsTreeNode>, ids: Id64Arg) {\n    return lookupParents.flatMap((lookup) => {\n      const childrenArray = Array<TSearchResultsTreeNode>();\n      for (const id of Id64.iterable(ids)) {\n        const node = lookup.children?.get(id);\n        if (node) {\n          childrenArray.push(node);\n        }\n      }\n      return childrenArray;\n    });\n  }\n}\n\n/** @internal */\nexport interface SearchResultsTree<TSearchTargets> {\n  getSearchTargets: (node: HierarchyNode & { key: ClassGroupingNodeKey | InstancesNodeKey }) => TSearchTargets | undefined;\n}\n\n/** @internal */\nexport interface CreateSearchResultsTreeProps<\n  TProcessedSearchResultsNodes,\n  TSearchTargets,\n  TSearchResultsTreeNode extends BaseSearchResultsTreeNode<TSearchResultsTreeNode>,\n> {\n  searchResultsNodesHandler: SearchResultsNodesHandler<TProcessedSearchResultsNodes, TSearchTargets, TSearchResultsTreeNode>;\n  searchPaths: HierarchySearchPath[];\n}\n\n/**\n * Function iterates over search paths and uses `searchResultsNodesHandler` to create a search results tree.\n * @internal\n */\nexport async function createSearchResultsTree<\n  TProcessedSearchResultsNodes,\n  TSearchTargets,\n  TSearchResultsTreeNode extends BaseSearchResultsTreeNode<TSearchResultsTreeNode>,\n>(props: CreateSearchResultsTreeProps<TProcessedSearchResultsNodes, TSearchTargets, TSearchResultsTreeNode>): Promise<SearchResultsTree<TSearchTargets>> {\n  const { searchPaths, searchResultsNodesHandler } = props;\n  // Sort search paths by their length, this ensures that nodes which have search target ancestors, and are search targets, won't be included in the\n  // search results tree. Search results tree is only needed to find which nodes might have children missing. Since nodes which have search target ancestors\n  // always have all children, they can be skipped.\n  const sortedSearchPaths = searchPaths.sort((lhs, rhs) => HierarchySearchPath.normalize(lhs).path.length - HierarchySearchPath.normalize(rhs).path.length);\n  for (const searchPath of sortedSearchPaths) {\n    const normalizedPath = HierarchySearchPath.normalize(searchPath).path;\n\n    let parentNode: SearchResultsTreeRootNode<TSearchResultsTreeNode> | TSearchResultsTreeNode = searchResultsNodesHandler.root;\n    for (let i = 0; i < normalizedPath.length; ++i) {\n      if (\"type\" in parentNode && \"isSearchTarget\" in parentNode && parentNode.isSearchTarget) {\n        break;\n      }\n\n      const identifier = normalizedPath[i];\n\n      if (!HierarchyNodeIdentifier.isInstanceNodeIdentifier(identifier)) {\n        break;\n      }\n\n      const currentNode: TSearchResultsTreeNode | undefined = parentNode.children?.get(identifier.id);\n      if (currentNode !== undefined) {\n        parentNode = currentNode;\n        continue;\n      }\n      parentNode = await searchResultsNodesHandler.accept({\n        instanceKey: identifier,\n        parentNode,\n        isSearchTarget: i === normalizedPath.length - 1,\n      });\n    }\n  }\n  const processedSearchResultsNodes = await searchResultsNodesHandler.processSearchResultsNodes();\n  return {\n    getSearchTargets: (node: HierarchyNode & { key: ClassGroupingNodeKey | InstancesNodeKey }) => processedSearchResultsNodes.getNodeSearchTargets(node),\n  };\n}\n"]}

package/lib/esm/tree-widget-react/components/trees/common/internal/visibility/BaseVisibilityHelper.d.ts

@@ -1,9 +1,12 @@
 import type { Observable } from "rxjs";
-import type { Id64Arg, Id64Array, Id64Set, Id64String } from "@itwin/core-bentley";
-import type { HierarchyNode } from "@itwin/presentation-hierarchies";
+import type { Id64Arg, Id64String } from "@itwin/core-bentley";
+import type { ClassGroupingNodeKey, HierarchyNode, InstancesNodeKey } from "@itwin/presentation-hierarchies";
 import type { TreeWidgetViewport } from "../../TreeWidgetViewport.js";
 import type { HierarchyVisibilityHandlerOverridableMethod, HierarchyVisibilityOverrideHandler, VisibilityStatus } from "../../UseHierarchyVisibility.js";
-import type { AlwaysAndNeverDrawnElementInfo } from "../AlwaysAndNeverDrawnElementInfo.js";
+import type { AlwaysAndNeverDrawnElementInfoCache } from "../caches/AlwaysAndNeverDrawnElementInfoCache.js";
+import type { BaseIdsCacheImpl } from "../caches/BaseIdsCache.js";
+import type { NonPartialVisibilityStatus } from "../Tooltip.js";
+import type { CategoryId } from "../Types.js";
 /**
  * Functionality of tree visibility handler methods that can be overridden.
  * Each callback is provided original implementation and reference to a `HierarchyVisibilityHandler`.
@@ -38,44 +41,6 @@ export interface BaseTreeVisibilityHandlerOverrides {
         on: boolean;
     }) => Promise<void>>;
 }
-/** @internal */
-export interface BaseIdsCache {
-    hasSubModel: (elementId: Id64String) => Observable<boolean>;
-    getElementsCount: (props: {
-        modelId: Id64String;
-        categoryId: Id64String;
-    }) => Observable<number>;
-    getSubCategories: (props: {
-        categoryId: Id64String;
-    }) => Observable<Id64Array>;
-    getModels: (props: {
-        categoryIds: Id64Arg;
-    }) => Observable<{
-        id: Id64String;
-        models: Id64Arg | undefined;
-    }>;
-    getCategories: (props: {
-        modelIds: Id64Arg;
-    }) => Observable<{
-        id: Id64String;
-        drawingCategories?: Id64Arg;
-        spatialCategories?: Id64Arg;
-    }>;
-    getSubModels: (props: {
-        modelIds: Id64Arg;
-        categoryId?: Id64String;
-    } | {
-        categoryIds: Id64Arg;
-        modelId: Id64String | undefined;
-    }) => Observable<{
-        id: Id64String;
-        subModels: Id64Arg | undefined;
-    }>;
-    getAllCategories: () => Observable<{
-        drawingCategories?: Id64Set;
-        spatialCategories?: Id64Set;
-    }>;
-}
 /**
  * Interface for a tree visibility handler that provides methods to get and change visibility status of hierarchy nodes.
  * @internal
@@ -83,16 +48,18 @@ export interface BaseIdsCache {
 export interface TreeSpecificVisibilityHandler<TSearchTargets> {
     getVisibilityStatus: (node: HierarchyNode) => Observable<VisibilityStatus>;
     changeVisibilityStatus: (node: HierarchyNode, on: boolean) => Observable<void>;
-    getSearchTargetsVisibilityStatus: (targets: TSearchTargets) => Observable<VisibilityStatus>;
+    getSearchTargetsVisibilityStatus: (targets: TSearchTargets, node: HierarchyNode & {
+        key: ClassGroupingNodeKey | InstancesNodeKey;
+    }) => Observable<VisibilityStatus>;
     changeSearchTargetsVisibilityStatus: (targets: TSearchTargets, on: boolean) => Observable<void>;
 }
 /** @internal */
 export interface BaseVisibilityHelperProps {
     viewport: TreeWidgetViewport;
-    alwaysAndNeverDrawnElementInfo: AlwaysAndNeverDrawnElementInfo;
+    alwaysAndNeverDrawnElementInfo: AlwaysAndNeverDrawnElementInfoCache;
     overrideHandler?: HierarchyVisibilityOverrideHandler;
     overrides?: BaseTreeVisibilityHandlerOverrides;
-    baseIdsCache: BaseIdsCache;
+    baseIdsCache: BaseIdsCacheImpl;
 }
 /**
  * Base class for visibility status getters and modifiers.
@@ -110,7 +77,7 @@ export declare class BaseVisibilityHelper implements Disposable {
      * This is achieved by:
      * - Resets `alwaysDrawn` exclusive flag to `false`;
      * - Turns off all categories;
-     * - Clears always drawn list;
+     * - Clears never drawn list;
      * - Removes all per-model category overrides. */
     removeAlwaysDrawnExclusive(): Observable<void>;
     /**
@@ -123,25 +90,11 @@ export declare class BaseVisibilityHelper implements Disposable {
      */
     getModelsVisibilityStatus(props: {
         modelIds: Id64Arg;
-        type: "GeometricModel3d" | "GeometricModel2d";
     }): Observable<VisibilityStatus>;
-    /**
-     * Gets visibility status of a model's categories, assuming model is visible.
-     *
-     * Determines visibility status by checking:
-     * - Elements in the viewports' always/never drawn lists;
-     * - Default categories visibility status in the viewport;
-     * - SubModels that are related to the modelId and categoryIds
-     */
-    private getVisibleModelCategoriesVisibilityStatus;
-    /** Gets visibility status of sub-categories, assuming category is visible. */
-    private getVisibleCategorySubCategoriesVisibilityStatus;
     /**
      * Gets visibility status of sub-categories.
      *
      * Determines visibility status by checking:
-     * - Models that contain the category visibility;
-     * - Per model category visibility overrides;
      * - Category selector visibility in the viewport.
      * - Sub-categories visibility in the viewport.
      */
@@ -160,19 +113,27 @@ export declare class BaseVisibilityHelper implements Disposable {
     getCategoriesVisibilityStatus(props: {
         categoryIds: Id64Arg;
         modelId: Id64String | undefined;
-        type: "DrawingCategory" | "SpatialCategory";
     }): Observable<VisibilityStatus>;
     /**
-     * Gets visibility status of categories, assuming model is visible.
+     * Gets visibility status of a model's category.
+     *
+     * Determines visibility status by checking:
+     * - Elements in the viewports' always/never drawn lists;
+     * - Default categories visibility status in the viewport;
+     * - SubModels that are related to the modelId and categoryId.
+     */
+    private getModelWithCategoryVisibilityStatus;
+    /**
+     * Gets visibility status of category, assuming model is visible.
      *
      * Determines visibility status by checking:
      * - Per model category visibility overrides;
      * - Category selector visibility in the viewport.
      */
-    getVisibleModelCategoriesDirectVisibilityStatus({ modelId, categoryIds }: {
-        categoryIds: Id64Arg;
+    getVisibleModelCategoryDirectVisibilityStatus({ modelId, categoryId }: {
+        categoryId: Id64String;
         modelId: Id64String;
-    }): VisibilityStatus;
+    }): NonPartialVisibilityStatus;
     /**
      * Gets visibility status of elements.
      *
@@ -185,7 +146,9 @@ export declare class BaseVisibilityHelper implements Disposable {
         elementIds: Id64Arg;
         modelId: Id64String;
         categoryId: Id64String;
-        type: "GeometricElement3d" | "GeometricElement2d";
+        categoryOfTopMostParentElement: CategoryId;
+        parentElementsIdsPath: Array<Id64Arg>;
+        childrenCount: number | undefined;
     }): Observable<VisibilityStatus>;
     /** Gets visibility status of elements based on viewport's always/never drawn elements and related categories and models. */
     private getVisibilityFromAlwaysAndNeverDrawnElements;
@@ -205,16 +168,28 @@ export declare class BaseVisibilityHelper implements Disposable {
     /**
      * Changes categories visibility status.
      *
-     * Also:
-     * - Turns on models in cases where categories need to be turned on and models are not already on.
-     * - Removed related elements from always/never drawn elements.
-     * - changes visibility of sub-models that are related to the specified categories.
+     * - Changes category selector for specified categories
+     * - Removes per-model category overrides
+     * - Clears always and never drawn elements related to those categories
+     * - Changes sub-models visibility status that are related to specified categories.
+     * - If `on` is set to true:
+     *   - Turns on models of those categories without affecting any visibilities
+     *   - Turns on sub-categories visibility status of specified categories.
      */
     changeCategoriesVisibilityStatus(props: {
-        modelId: Id64String | undefined;
         categoryIds: Id64Arg;
         on: boolean;
+        modelId: Id64String | undefined;
     }): Observable<void>;
+    /**
+     * Changes categories under specific model visibility status.
+     *
+     * - Turns on model without affecting it's elements or categories
+     * - sets per-model category overrides for specified categories.
+     * - Clears always and never drawn elements related to those categories
+     * - Changes sub-models visibility status that are related to specified categories in the model.
+     */
+    private changeCategoriesUnderModelVisibilityStatus;
     /**
      * Changes visibility status of elements by adding them to the viewport's always/never drawn elements.
      *
@@ -225,6 +200,7 @@ export declare class BaseVisibilityHelper implements Disposable {
         modelId: Id64String;
         categoryId: Id64String;
         on: boolean;
+        children: Id64Arg | undefined;
     }): Observable<void>;
     /** Queues visibility change for elements. */
     private queueElementsVisibilityChange;