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

package/lib/esm/tree-widget-react/components/trees/classifications-tree/UseClassificationsTreeDefinition.d.ts

@@ -1,5 +1,6 @@
-import type { HierarchyDefinition } from "@itwin/presentation-hierarchies";
-import type { useIModelTree, useTree } from "@itwin/presentation-hierarchies-react";
+import type { IModelConnection } from "@itwin/core-frontend";
+import type { HierarchyDefinition, HierarchySearchPath } from "@itwin/presentation-hierarchies";
+import type { useTree } from "@itwin/presentation-hierarchies-react";
 import type { InstanceKey } from "@itwin/presentation-shared";
 import type { FunctionProps } from "../common/Utils.js";
 import type { ClassificationsTreeHierarchyConfiguration } from "./ClassificationsTreeDefinition.js";
@@ -11,12 +12,7 @@ interface UseClassificationsTreeDefinitionProps {
      * **Warning:** These **must** all be different versions of the same iModel, ordered from the earliest to the
      * latest version. Not obeying this rule may result in undefined behavior.
      */
-    imodels: Array<{
-        /**
-         * An object that provides access to iModel's data and metadata.
-         */
-        imodelAccess: FunctionProps<typeof useIModelTree>["imodelAccess"];
-    }>;
+    imodels: Array<IModelConnection>;
     hierarchyConfig: ClassificationsTreeHierarchyConfiguration;
     /**
      * Optional parameters to search for tree nodes.
@@ -32,13 +28,20 @@ interface UseClassificationsTreeDefinitionProps {
          */
         targetItems: Array<InstanceKey>;
     };
+    /**
+     * Action to perform when search paths change.
+     */
+    onSearchPathsChanged?: (paths: HierarchySearchPath[] | undefined) => void;
 }
 /** @alpha */
 interface UseClassificationsTreeDefinitionResult {
     definition: HierarchyDefinition;
     getSearchPaths?: FunctionProps<typeof useTree>["getSearchPaths"];
 }
-/** @alpha */
+/**
+ * Requires `SharedTreeContextProvider` to be present in components tree above.
+ * @alpha
+ */
 export declare function useClassificationsTreeDefinition(props: UseClassificationsTreeDefinitionProps): UseClassificationsTreeDefinitionResult;
 export {};
 //# sourceMappingURL=UseClassificationsTreeDefinition.d.ts.map

package/lib/esm/tree-widget-react/components/trees/classifications-tree/UseClassificationsTreeDefinition.js

@@ -2,61 +2,65 @@
  * Copyright (c) Bentley Systems, Incorporated. All rights reserved.
  * See LICENSE.md in the project root for license terms and full copyright notice.
  *--------------------------------------------------------------------------------------------*/
-import { useMemo, useRef } from "react";
-import { assert } from "@itwin/core-bentley";
+import { useEffect, useMemo } from "react";
+import { useSharedTreeContextInternal } from "../common/internal/SharedTreeContextProviderInternal.js";
+import { createIModelAccess } from "../common/internal/UseIModelAccess.js";
+import { useTelemetryContext } from "../common/UseTelemetryContext.js";
 import { ClassificationsTreeDefinition } from "./ClassificationsTreeDefinition.js";
-import { ClassificationsTreeIdsCache } from "./internal/ClassificationsTreeIdsCache.js";
-/** @alpha */
+import { getClassificationsTreeIdsCache } from "./UseClassificationsTree.js";
+/**
+ * Requires `SharedTreeContextProvider` to be present in components tree above.
+ * @alpha
+ */
 export function useClassificationsTreeDefinition(props) {
-    const { imodels, hierarchyConfig, search } = props;
-    const idsCaches = useRef(new Map());
+    const { imodels, hierarchyConfig, search, onSearchPathsChanged } = props;
+    const { getBaseIdsCache, getCache } = useSharedTreeContextInternal();
+    const { onFeatureUsed } = useTelemetryContext();
+    const imodelsWithCaches = useMemo(() => {
+        return imodels.map((imodel) => {
+            return {
+                imodelAccess: createIModelAccess({ imodel, hierarchyLevelSizeLimit: 1000 }),
+                cache: getClassificationsTreeIdsCache({ getBaseIdsCache, getCache, imodel, hierarchyConfig }),
+            };
+        });
+    }, [imodels, getBaseIdsCache, getCache, hierarchyConfig]);
     const definition = useMemo(() => {
         return new ClassificationsTreeDefinition({
-            imodelAccess: imodels[imodels.length - 1].imodelAccess,
-            getIdsCache: (imodelKey) => getOrCreateIdsCache({
-                imodelKey,
-                imodels,
-                idsCaches,
-                hierarchyConfig,
-            }),
+            imodelAccess: imodelsWithCaches[imodelsWithCaches.length - 1].imodelAccess,
+            getIdsCache: (imodelKey) => imodelsWithCaches.find(({ imodelAccess }) => imodelAccess.imodelKey === imodelKey).cache,
             hierarchyConfig,
         });
-    }, [imodels, hierarchyConfig]);
+    }, [hierarchyConfig, imodelsWithCaches]);
     const searchTerm = search ? ("searchText" in search ? search.searchText : search.targetItems) : undefined;
+    useEffect(() => {
+        if (!searchTerm) {
+            onSearchPathsChanged?.(undefined);
+        }
+    }, [onSearchPathsChanged, searchTerm]);
     const getSearchPaths = useMemo(() => {
         if (!searchTerm) {
             return undefined;
         }
         return async ({ abortSignal }) => {
-            const [first, ...rest] = await Promise.all(imodels.map(async ({ imodelAccess }) => ClassificationsTreeDefinition.createInstanceKeyPaths({
-                hierarchyConfig,
-                idsCache: getOrCreateIdsCache({
-                    imodelKey: imodelAccess.imodelKey,
-                    imodels,
-                    idsCaches,
+            onFeatureUsed({ featureId: "search", reportInteraction: true });
+            const [first, ...rest] = await Promise.all(imodelsWithCaches.map(async ({ imodelAccess, cache }) => {
+                return ClassificationsTreeDefinition.createInstanceKeyPaths({
                     hierarchyConfig,
-                }),
-                imodelAccess,
-                abortSignal,
-                limit: typeof searchTerm !== "string" ? "unbounded" : undefined,
-                ...(typeof searchTerm === "string" ? { label: searchTerm } : { targetItems: searchTerm }),
-            })));
-            return first.concat(...rest);
+                    idsCache: cache,
+                    imodelAccess,
+                    abortSignal,
+                    limit: typeof searchTerm !== "string" ? "unbounded" : undefined,
+                    ...(typeof searchTerm === "string" ? { label: searchTerm } : { targetItems: searchTerm }),
+                });
+            }));
+            const joinedPaths = first.concat(...rest);
+            onSearchPathsChanged?.(joinedPaths);
+            return joinedPaths;
         };
-    }, [imodels, hierarchyConfig, searchTerm]);
+    }, [searchTerm, onFeatureUsed, imodelsWithCaches, onSearchPathsChanged, hierarchyConfig]);
     return {
         definition,
         getSearchPaths,
     };
 }
-function getOrCreateIdsCache({ imodelKey, imodels, hierarchyConfig, idsCaches, }) {
-    let idsCache = idsCaches.current.get(imodelKey);
-    if (!idsCache) {
-        const imodel = imodels.find((currImodel) => currImodel.imodelAccess.imodelKey === imodelKey);
-        assert(!!imodel);
-        idsCache = new ClassificationsTreeIdsCache(imodel.imodelAccess, hierarchyConfig);
-        idsCaches.current.set(imodelKey, idsCache);
-    }
-    return idsCache;
-}
 //# sourceMappingURL=UseClassificationsTreeDefinition.js.map

package/lib/esm/tree-widget-react/components/trees/classifications-tree/UseClassificationsTreeDefinition.js.map

@@ -1 +1 @@
-{"version":3,"file":"UseClassificationsTreeDefinition.js","sourceRoot":"","sources":["../../../../../../src/tree-widget-react/components/trees/classifications-tree/UseClassificationsTreeDefinition.ts"],"names":[],"mappings":"AAAA;;;gGAGgG;AAEhG,OAAO,EAAE,OAAO,EAAE,MAAM,EAAE,MAAM,OAAO,CAAC;AACxC,OAAO,EAAE,MAAM,EAAE,MAAM,qBAAqB,CAAC;AAC7C,OAAO,EAAE,6BAA6B,EAAE,MAAM,oCAAoC,CAAC;AACnF,OAAO,EAAE,2BAA2B,EAAE,MAAM,2CAA2C,CAAC;AAgDxF,aAAa;AACb,MAAM,UAAU,gCAAgC,CAAC,KAA4C;IAC3F,MAAM,EAAE,OAAO,EAAE,eAAe,EAAE,MAAM,EAAE,GAAG,KAAK,CAAC;IAEnD,MAAM,SAAS,GAAG,MAAM,CAA2C,IAAI,GAAG,EAAE,CAAC,CAAC;IAE9E,MAAM,UAAU,GAAG,OAAO,CAAC,GAAG,EAAE;QAC9B,OAAO,IAAI,6BAA6B,CAAC;YACvC,YAAY,EAAE,OAAO,CAAC,OAAO,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,YAAY;YACtD,WAAW,EAAE,CAAC,SAAiB,EAAE,EAAE,CACjC,mBAAmB,CAAC;gBAClB,SAAS;gBACT,OAAO;gBACP,SAAS;gBACT,eAAe;aAChB,CAAC;YACJ,eAAe;SAChB,CAAC,CAAC;IACL,CAAC,EAAE,CAAC,OAAO,EAAE,eAAe,CAAC,CAAC,CAAC;IAE/B,MAAM,UAAU,GAAG,MAAM,CAAC,CAAC,CAAC,CAAC,YAAY,IAAI,MAAM,CAAC,CAAC,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;IAC1G,MAAM,cAAc,GAAG,OAAO,CAAkD,GAAG,EAAE;QACnF,IAAI,CAAC,UAAU,EAAE,CAAC;YAChB,OAAO,SAAS,CAAC;QACnB,CAAC;QAED,OAAO,KAAK,EAAE,EAAE,WAAW,EAAE,EAAE,EAAE;YAC/B,MAAM,CAAC,KAAK,EAAE,GAAG,IAAI,CAAC,GAAG,MAAM,OAAO,CAAC,GAAG,CACxC,OAAO,CAAC,GAAG,CAAC,KAAK,EAAE,EAAE,YAAY,EAAE,EAAE,EAAE,CACrC,6BAA6B,CAAC,sBAAsB,CAAC;gBACnD,eAAe;gBACf,QAAQ,EAAE,mBAAmB,CAAC;oBAC5B,SAAS,EAAE,YAAY,CAAC,SAAS;oBACjC,OAAO;oBACP,SAAS;oBACT,eAAe;iBAChB,CAAC;gBACF,YAAY;gBACZ,WAAW;gBACX,KAAK,EAAE,OAAO,UAAU,KAAK,QAAQ,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC,SAAS;gBAC/D,GAAG,CAAC,OAAO,UAAU,KAAK,QAAQ,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,UAAU,EAAE,CAAC,CAAC,CAAC,EAAE,WAAW,EAAE,UAAU,EAAE,CAAC;aAC1F,CAAC,CACH,CACF,CAAC;YAEF,OAAO,KAAK,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC,CAAC;QAC/B,CAAC,CAAC;IACJ,CAAC,EAAE,CAAC,OAAO,EAAE,eAAe,EAAE,UAAU,CAAC,CAAC,CAAC;IAE3C,OAAO;QACL,UAAU;QACV,cAAc;KACf,CAAC;AACJ,CAAC;AAED,SAAS,mBAAmB,CAAC,EAC3B,SAAS,EACT,OAAO,EACP,eAAe,EACf,SAAS,GAQV;IACC,IAAI,QAAQ,GAAG,SAAS,CAAC,OAAO,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC;IAChD,IAAI,CAAC,QAAQ,EAAE,CAAC;QACd,MAAM,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC,UAAU,EAAE,EAAE,CAAC,UAAU,CAAC,YAAY,CAAC,SAAS,KAAK,SAAS,CAAC,CAAC;QAC7F,MAAM,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC;QACjB,QAAQ,GAAG,IAAI,2BAA2B,CAAC,MAAM,CAAC,YAAY,EAAE,eAAe,CAAC,CAAC;QACjF,SAAS,CAAC,OAAO,CAAC,GAAG,CAAC,SAAS,EAAE,QAAQ,CAAC,CAAC;IAC7C,CAAC;IACD,OAAO,QAAQ,CAAC;AAClB,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 { useMemo, useRef } from \"react\";\nimport { assert } from \"@itwin/core-bentley\";\nimport { ClassificationsTreeDefinition } from \"./ClassificationsTreeDefinition.js\";\nimport { ClassificationsTreeIdsCache } from \"./internal/ClassificationsTreeIdsCache.js\";\n\nimport type { MutableRefObject } from \"react\";\nimport type { HierarchyDefinition } from \"@itwin/presentation-hierarchies\";\nimport type { useIModelTree, useTree } from \"@itwin/presentation-hierarchies-react\";\nimport type { InstanceKey } from \"@itwin/presentation-shared\";\nimport type { FunctionProps } from \"../common/Utils.js\";\nimport type { ClassificationsTreeHierarchyConfiguration } from \"./ClassificationsTreeDefinition.js\";\n\n/** @alpha */\ninterface UseClassificationsTreeDefinitionProps {\n  /**\n   * A list of iModels to create merged hierarchy for.\n   *\n   * **Warning:** These **must** all be different versions of the same iModel, ordered from the earliest to the\n   * latest version. Not obeying this rule may result in undefined behavior.\n   */\n  imodels: Array<{\n    /**\n     * An object that provides access to iModel's data and metadata.\n     */\n    imodelAccess: FunctionProps<typeof useIModelTree>[\"imodelAccess\"];\n  }>;\n  hierarchyConfig: ClassificationsTreeHierarchyConfiguration;\n  /**\n   * Optional parameters to search for tree nodes.\n   */\n  search?:\n    | {\n        /**\n         * Text used to search tree nodes by label.\n         */\n        searchText: string;\n      }\n    | {\n        /**\n         * List of instance keys to search tree nodes by.\n         */\n        targetItems: Array<InstanceKey>;\n      };\n}\n\n/** @alpha */\ninterface UseClassificationsTreeDefinitionResult {\n  definition: HierarchyDefinition;\n  getSearchPaths?: FunctionProps<typeof useTree>[\"getSearchPaths\"];\n}\n\n/** @alpha */\nexport function useClassificationsTreeDefinition(props: UseClassificationsTreeDefinitionProps): UseClassificationsTreeDefinitionResult {\n  const { imodels, hierarchyConfig, search } = props;\n\n  const idsCaches = useRef<Map<string, ClassificationsTreeIdsCache>>(new Map());\n\n  const definition = useMemo(() => {\n    return new ClassificationsTreeDefinition({\n      imodelAccess: imodels[imodels.length - 1].imodelAccess,\n      getIdsCache: (imodelKey: string) =>\n        getOrCreateIdsCache({\n          imodelKey,\n          imodels,\n          idsCaches,\n          hierarchyConfig,\n        }),\n      hierarchyConfig,\n    });\n  }, [imodels, hierarchyConfig]);\n\n  const searchTerm = search ? (\"searchText\" in search ? search.searchText : search.targetItems) : undefined;\n  const getSearchPaths = useMemo<FunctionProps<typeof useTree>[\"getSearchPaths\"]>(() => {\n    if (!searchTerm) {\n      return undefined;\n    }\n\n    return async ({ abortSignal }) => {\n      const [first, ...rest] = await Promise.all(\n        imodels.map(async ({ imodelAccess }) =>\n          ClassificationsTreeDefinition.createInstanceKeyPaths({\n            hierarchyConfig,\n            idsCache: getOrCreateIdsCache({\n              imodelKey: imodelAccess.imodelKey,\n              imodels,\n              idsCaches,\n              hierarchyConfig,\n            }),\n            imodelAccess,\n            abortSignal,\n            limit: typeof searchTerm !== \"string\" ? \"unbounded\" : undefined,\n            ...(typeof searchTerm === \"string\" ? { label: searchTerm } : { targetItems: searchTerm }),\n          }),\n        ),\n      );\n\n      return first.concat(...rest);\n    };\n  }, [imodels, hierarchyConfig, searchTerm]);\n\n  return {\n    definition,\n    getSearchPaths,\n  };\n}\n\nfunction getOrCreateIdsCache({\n  imodelKey,\n  imodels,\n  hierarchyConfig,\n  idsCaches,\n}: {\n  imodelKey: string;\n  imodels: Array<{\n    imodelAccess: FunctionProps<typeof useIModelTree>[\"imodelAccess\"];\n  }>;\n  hierarchyConfig: ClassificationsTreeHierarchyConfiguration;\n  idsCaches: MutableRefObject<Map<string, ClassificationsTreeIdsCache>>;\n}) {\n  let idsCache = idsCaches.current.get(imodelKey);\n  if (!idsCache) {\n    const imodel = imodels.find((currImodel) => currImodel.imodelAccess.imodelKey === imodelKey);\n    assert(!!imodel);\n    idsCache = new ClassificationsTreeIdsCache(imodel.imodelAccess, hierarchyConfig);\n    idsCaches.current.set(imodelKey, idsCache);\n  }\n  return idsCache;\n}\n"]}
+{"version":3,"file":"UseClassificationsTreeDefinition.js","sourceRoot":"","sources":["../../../../../../src/tree-widget-react/components/trees/classifications-tree/UseClassificationsTreeDefinition.ts"],"names":[],"mappings":"AAAA;;;gGAGgG;AAEhG,OAAO,EAAE,SAAS,EAAE,OAAO,EAAE,MAAM,OAAO,CAAC;AAC3C,OAAO,EAAE,4BAA4B,EAAE,MAAM,yDAAyD,CAAC;AACvG,OAAO,EAAE,kBAAkB,EAAE,MAAM,uCAAuC,CAAC;AAC3E,OAAO,EAAE,mBAAmB,EAAE,MAAM,kCAAkC,CAAC;AACvE,OAAO,EAAE,6BAA6B,EAAE,MAAM,oCAAoC,CAAC;AACnF,OAAO,EAAE,8BAA8B,EAAE,MAAM,6BAA6B,CAAC;AA+C7E;;;GAGG;AACH,MAAM,UAAU,gCAAgC,CAAC,KAA4C;IAC3F,MAAM,EAAE,OAAO,EAAE,eAAe,EAAE,MAAM,EAAE,oBAAoB,EAAE,GAAG,KAAK,CAAC;IACzE,MAAM,EAAE,eAAe,EAAE,QAAQ,EAAE,GAAG,4BAA4B,EAAE,CAAC;IACrE,MAAM,EAAE,aAAa,EAAE,GAAG,mBAAmB,EAAE,CAAC;IAEhD,MAAM,iBAAiB,GAAG,OAAO,CAAC,GAAG,EAAE;QACrC,OAAO,OAAO,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE;YAC5B,OAAO;gBACL,YAAY,EAAE,kBAAkB,CAAC,EAAE,MAAM,EAAE,uBAAuB,EAAE,IAAI,EAAE,CAAC;gBAC3E,KAAK,EAAE,8BAA8B,CAAC,EAAE,eAAe,EAAE,QAAQ,EAAE,MAAM,EAAE,eAAe,EAAE,CAAC;aAC9F,CAAC;QACJ,CAAC,CAAC,CAAC;IACL,CAAC,EAAE,CAAC,OAAO,EAAE,eAAe,EAAE,QAAQ,EAAE,eAAe,CAAC,CAAC,CAAC;IAE1D,MAAM,UAAU,GAAG,OAAO,CAAC,GAAG,EAAE;QAC9B,OAAO,IAAI,6BAA6B,CAAC;YACvC,YAAY,EAAE,iBAAiB,CAAC,iBAAiB,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,YAAY;YAC1E,WAAW,EAAE,CAAC,SAAiB,EAAE,EAAE,CAAC,iBAAiB,CAAC,IAAI,CAAC,CAAC,EAAE,YAAY,EAAE,EAAE,EAAE,CAAC,YAAY,CAAC,SAAS,KAAK,SAAS,CAAE,CAAC,KAAK;YAC7H,eAAe;SAChB,CAAC,CAAC;IACL,CAAC,EAAE,CAAC,eAAe,EAAE,iBAAiB,CAAC,CAAC,CAAC;IAEzC,MAAM,UAAU,GAAG,MAAM,CAAC,CAAC,CAAC,CAAC,YAAY,IAAI,MAAM,CAAC,CAAC,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;IAE1G,SAAS,CAAC,GAAG,EAAE;QACb,IAAI,CAAC,UAAU,EAAE,CAAC;YAChB,oBAAoB,EAAE,CAAC,SAAS,CAAC,CAAC;QACpC,CAAC;IACH,CAAC,EAAE,CAAC,oBAAoB,EAAE,UAAU,CAAC,CAAC,CAAC;IAEvC,MAAM,cAAc,GAAG,OAAO,CAAkD,GAAG,EAAE;QACnF,IAAI,CAAC,UAAU,EAAE,CAAC;YAChB,OAAO,SAAS,CAAC;QACnB,CAAC;QAED,OAAO,KAAK,EAAE,EAAE,WAAW,EAAE,EAAE,EAAE;YAC/B,aAAa,CAAC,EAAE,SAAS,EAAE,QAAQ,EAAE,iBAAiB,EAAE,IAAI,EAAE,CAAC,CAAC;YAChE,MAAM,CAAC,KAAK,EAAE,GAAG,IAAI,CAAC,GAAG,MAAM,OAAO,CAAC,GAAG,CACxC,iBAAiB,CAAC,GAAG,CAAC,KAAK,EAAE,EAAE,YAAY,EAAE,KAAK,EAAE,EAAE,EAAE;gBACtD,OAAO,6BAA6B,CAAC,sBAAsB,CAAC;oBAC1D,eAAe;oBACf,QAAQ,EAAE,KAAK;oBACf,YAAY;oBACZ,WAAW;oBACX,KAAK,EAAE,OAAO,UAAU,KAAK,QAAQ,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC,SAAS;oBAC/D,GAAG,CAAC,OAAO,UAAU,KAAK,QAAQ,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,UAAU,EAAE,CAAC,CAAC,CAAC,EAAE,WAAW,EAAE,UAAU,EAAE,CAAC;iBAC1F,CAAC,CAAC;YACL,CAAC,CAAC,CACH,CAAC;YAEF,MAAM,WAAW,GAAG,KAAK,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC,CAAC;YAC1C,oBAAoB,EAAE,CAAC,WAAW,CAAC,CAAC;YACpC,OAAO,WAAW,CAAC;QACrB,CAAC,CAAC;IACJ,CAAC,EAAE,CAAC,UAAU,EAAE,aAAa,EAAE,iBAAiB,EAAE,oBAAoB,EAAE,eAAe,CAAC,CAAC,CAAC;IAE1F,OAAO;QACL,UAAU;QACV,cAAc;KACf,CAAC;AACJ,CAAC","sourcesContent":["/*---------------------------------------------------------------------------------------------\n * Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n * See LICENSE.md in the project root for license terms and full copyright notice.\n *--------------------------------------------------------------------------------------------*/\n\nimport { useEffect, useMemo } from \"react\";\nimport { useSharedTreeContextInternal } from \"../common/internal/SharedTreeContextProviderInternal.js\";\nimport { createIModelAccess } from \"../common/internal/UseIModelAccess.js\";\nimport { useTelemetryContext } from \"../common/UseTelemetryContext.js\";\nimport { ClassificationsTreeDefinition } from \"./ClassificationsTreeDefinition.js\";\nimport { getClassificationsTreeIdsCache } from \"./UseClassificationsTree.js\";\n\nimport type { IModelConnection } from \"@itwin/core-frontend\";\nimport type { HierarchyDefinition, HierarchySearchPath } from \"@itwin/presentation-hierarchies\";\nimport type { useTree } from \"@itwin/presentation-hierarchies-react\";\nimport type { InstanceKey } from \"@itwin/presentation-shared\";\nimport type { FunctionProps } from \"../common/Utils.js\";\nimport type { ClassificationsTreeHierarchyConfiguration } from \"./ClassificationsTreeDefinition.js\";\n\n/** @alpha */\ninterface UseClassificationsTreeDefinitionProps {\n  /**\n   * A list of iModels to create merged hierarchy for.\n   *\n   * **Warning:** These **must** all be different versions of the same iModel, ordered from the earliest to the\n   * latest version. Not obeying this rule may result in undefined behavior.\n   */\n  imodels: Array<IModelConnection>;\n  hierarchyConfig: ClassificationsTreeHierarchyConfiguration;\n  /**\n   * Optional parameters to search for tree nodes.\n   */\n  search?:\n    | {\n        /**\n         * Text used to search tree nodes by label.\n         */\n        searchText: string;\n      }\n    | {\n        /**\n         * List of instance keys to search tree nodes by.\n         */\n        targetItems: Array<InstanceKey>;\n      };\n  /**\n   * Action to perform when search paths change.\n   */\n  onSearchPathsChanged?: (paths: HierarchySearchPath[] | undefined) => void;\n}\n\n/** @alpha */\ninterface UseClassificationsTreeDefinitionResult {\n  definition: HierarchyDefinition;\n  getSearchPaths?: FunctionProps<typeof useTree>[\"getSearchPaths\"];\n}\n\n/**\n * Requires `SharedTreeContextProvider` to be present in components tree above.\n * @alpha\n */\nexport function useClassificationsTreeDefinition(props: UseClassificationsTreeDefinitionProps): UseClassificationsTreeDefinitionResult {\n  const { imodels, hierarchyConfig, search, onSearchPathsChanged } = props;\n  const { getBaseIdsCache, getCache } = useSharedTreeContextInternal();\n  const { onFeatureUsed } = useTelemetryContext();\n\n  const imodelsWithCaches = useMemo(() => {\n    return imodels.map((imodel) => {\n      return {\n        imodelAccess: createIModelAccess({ imodel, hierarchyLevelSizeLimit: 1000 }),\n        cache: getClassificationsTreeIdsCache({ getBaseIdsCache, getCache, imodel, hierarchyConfig }),\n      };\n    });\n  }, [imodels, getBaseIdsCache, getCache, hierarchyConfig]);\n\n  const definition = useMemo(() => {\n    return new ClassificationsTreeDefinition({\n      imodelAccess: imodelsWithCaches[imodelsWithCaches.length - 1].imodelAccess,\n      getIdsCache: (imodelKey: string) => imodelsWithCaches.find(({ imodelAccess }) => imodelAccess.imodelKey === imodelKey)!.cache,\n      hierarchyConfig,\n    });\n  }, [hierarchyConfig, imodelsWithCaches]);\n\n  const searchTerm = search ? (\"searchText\" in search ? search.searchText : search.targetItems) : undefined;\n\n  useEffect(() => {\n    if (!searchTerm) {\n      onSearchPathsChanged?.(undefined);\n    }\n  }, [onSearchPathsChanged, searchTerm]);\n\n  const getSearchPaths = useMemo<FunctionProps<typeof useTree>[\"getSearchPaths\"]>(() => {\n    if (!searchTerm) {\n      return undefined;\n    }\n\n    return async ({ abortSignal }) => {\n      onFeatureUsed({ featureId: \"search\", reportInteraction: true });\n      const [first, ...rest] = await Promise.all(\n        imodelsWithCaches.map(async ({ imodelAccess, cache }) => {\n          return ClassificationsTreeDefinition.createInstanceKeyPaths({\n            hierarchyConfig,\n            idsCache: cache,\n            imodelAccess,\n            abortSignal,\n            limit: typeof searchTerm !== \"string\" ? \"unbounded\" : undefined,\n            ...(typeof searchTerm === \"string\" ? { label: searchTerm } : { targetItems: searchTerm }),\n          });\n        }),\n      );\n\n      const joinedPaths = first.concat(...rest);\n      onSearchPathsChanged?.(joinedPaths);\n      return joinedPaths;\n    };\n  }, [searchTerm, onFeatureUsed, imodelsWithCaches, onSearchPathsChanged, hierarchyConfig]);\n\n  return {\n    definition,\n    getSearchPaths,\n  };\n}\n"]}

package/lib/esm/tree-widget-react/components/trees/classifications-tree/internal/ClassificationsTreeIdsCache.d.ts

@@ -1,56 +1,33 @@
+import { BaseIdsCacheImpl } from "../../common/internal/caches/BaseIdsCache.js";
 import type { Observable } from "rxjs";
-import type { GuidString, Id64Arg, Id64Array, Id64Set, Id64String } from "@itwin/core-bentley";
+import type { Id64Arg, Id64Array, Id64String } from "@itwin/core-bentley";
 import type { HierarchyNodeIdentifiersPath, LimitingECSqlQueryExecutor } from "@itwin/presentation-hierarchies";
-import type { CategoryId, ElementId, ModelId, SubCategoryId } from "../../common/internal/Types.js";
+import type { BaseIdsCacheImplProps } from "../../common/internal/caches/BaseIdsCache.js";
+import type { CategoryId, ClassificationId, ElementId } from "../../common/internal/Types.js";
 import type { ClassificationsTreeHierarchyConfiguration } from "../ClassificationsTreeDefinition.js";
+interface ClassificationsTreeIdsCacheProps extends BaseIdsCacheImplProps {
+    queryExecutor: LimitingECSqlQueryExecutor;
+    hierarchyConfig: ClassificationsTreeHierarchyConfiguration;
+}
 /** @internal */
-export type ClassificationId = Id64String;
-/** @internal */
-export type ClassificationTableId = Id64String;
-/** @internal */
-export declare class ClassificationsTreeIdsCache implements Disposable {
+export declare class ClassificationsTreeIdsCache extends BaseIdsCacheImpl {
     #private;
-    constructor(queryExecutor: LimitingECSqlQueryExecutor, hierarchyConfig: ClassificationsTreeHierarchyConfiguration, componentId?: GuidString);
-    [Symbol.dispose](): void;
-    private querySubCategories;
-    private getSubCategoriesInfo;
-    getSubCategories(categoryId: Id64String): Observable<Array<SubCategoryId>>;
-    private queryElementModelCategories;
-    private getElementModelsCategories;
-    private queryModeledElements;
-    private getModelWithCategoryModeledElements;
-    getCategoriesModeledElements(modelId: Id64String, categoryIds: Id64Arg): Observable<Id64Array>;
-    getCategoriesElementModels(categoryIds: Id64Arg, includeSubModels?: boolean): Observable<{
-        id: CategoryId;
-        models: Array<ModelId> | undefined;
-    }>;
-    getModelCategoryIds(modelId: Id64String): Observable<{
-        drawing: Id64Array;
-        spatial: Id64Array;
-    }>;
-    getAllCategories(): Observable<{
-        drawing: Id64Set;
-        spatial: Id64Set;
-    }>;
-    hasSubModel(elementId: Id64String): Observable<boolean>;
-    getCategoryElementsCount(modelId: Id64String, categoryId: Id64String): Observable<number>;
+    constructor(props: ClassificationsTreeIdsCacheProps);
     private queryClassifications;
     private getClassificationsInfo;
-    getAllContainedCategories(classificationOrTableIds: Id64Arg): Observable<{
-        drawing: Id64Array;
-        spatial: Id64Array;
-    }>;
+    getAllContainedCategories(classificationOrTableIds: Id64Arg): Observable<Id64Array>;
     getDirectChildClassifications(classificationOrTableIds: Id64Arg): Observable<ClassificationId[]>;
     getClassificationsPathObs(classificationIds: Id64Arg): Observable<HierarchyNodeIdentifiersPath>;
     getAllClassifications(): Observable<ClassificationId[]>;
     private queryFilteredElementsData;
-    getFilteredElementsData({ element2dIds, element3dIds, }: {
-        element2dIds: Id64Arg;
-        element3dIds: Id64Arg;
+    getFilteredElementsData({ elementIds, }: {
+        elementIds: Id64Arg;
     }): Observable<Map<ElementId, {
         categoryId: Id64String;
         modelId: Id64String;
+        categoryOfTopMostParentElement: CategoryId;
     }>>;
     clearFilteredElementsData(): void;
 }
+export {};
 //# sourceMappingURL=ClassificationsTreeIdsCache.d.ts.map