@itwin/tree-widget-react 3.15.1 → 3.16.0

package/lib/esm/tree-widget-react/components/trees/models-tree/ModelsTreeDefinition.js

@@ -3,6 +3,7 @@
  * See LICENSE.md in the project root for license terms and full copyright notice.
  *--------------------------------------------------------------------------------------------*/
 import { bufferCount, defaultIfEmpty, defer, firstValueFrom, from, fromEvent, identity, lastValueFrom, map, merge, mergeAll, mergeMap, reduce, switchMap, takeUntil, toArray, } from "rxjs";
+import { Guid } from "@itwin/core-bentley";
 import { IModel } from "@itwin/core-common";
 import { createNodesQueryClauseFactory, createPredicateBasedHierarchyDefinition, HierarchyFilteringPath, NodeSelectClauseColumnNames, ProcessedHierarchyNode, } from "@itwin/presentation-hierarchies";
 import { createBisInstanceLabelSelectClauseFactory, ECSql } from "@itwin/presentation-shared";
@@ -28,18 +29,20 @@ export var ModelsTreeInstanceKeyPathsProps;
     ModelsTreeInstanceKeyPathsProps.isLabelProps = isLabelProps;
 })(ModelsTreeInstanceKeyPathsProps || (ModelsTreeInstanceKeyPathsProps = {}));
 export class ModelsTreeDefinition {
-    _impl;
-    _idsCache;
-    _hierarchyConfig;
-    _selectQueryFactory;
-    _nodeLabelSelectClauseFactory;
-    _queryExecutor;
-    _isSupported;
+    #impl;
+    #idsCache;
+    #hierarchyConfig;
+    #selectQueryFactory;
+    #nodeLabelSelectClauseFactory;
+    #queryExecutor;
+    #isSupported;
+    static #componentName = "ModelsTreeDefinition";
+    #componentId;
     constructor(props) {
-        this._impl = createPredicateBasedHierarchyDefinition({
+        this.#impl = createPredicateBasedHierarchyDefinition({
             classHierarchyInspector: props.imodelAccess,
             hierarchy: {
-                rootNodes: async (requestProps) => this.createSubjectChildrenQuery({ ...requestProps, parentNodeInstanceIds: this._hierarchyConfig.hideRootSubject ? [IModel.rootSubjectId] : [] }),
+                rootNodes: async (requestProps) => this.createSubjectChildrenQuery({ ...requestProps, parentNodeInstanceIds: this.#hierarchyConfig.hideRootSubject ? [IModel.rootSubjectId] : [] }),
                 childNodes: [
                     {
                         parentInstancesNodePredicate: "BisCore.Subject",
@@ -64,24 +67,48 @@ export class ModelsTreeDefinition {
                 ],
             },
         });
-        this._idsCache = props.idsCache;
-        this._queryExecutor = props.imodelAccess;
-        this._hierarchyConfig = props.hierarchyConfig;
-        this._nodeLabelSelectClauseFactory = createBisInstanceLabelSelectClauseFactory({ classHierarchyInspector: props.imodelAccess });
-        this._selectQueryFactory = createNodesQueryClauseFactory({
+        this.#componentId = props.componentId ?? Guid.createValue();
+        this.#idsCache = props.idsCache;
+        this.#queryExecutor = props.imodelAccess;
+        this.#hierarchyConfig = props.hierarchyConfig;
+        this.#nodeLabelSelectClauseFactory = createBisInstanceLabelSelectClauseFactory({ classHierarchyInspector: props.imodelAccess });
+        this.#selectQueryFactory = createNodesQueryClauseFactory({
             imodelAccess: props.imodelAccess,
-            instanceLabelSelectClauseFactory: this._nodeLabelSelectClauseFactory,
+            instanceLabelSelectClauseFactory: this.#nodeLabelSelectClauseFactory,
         });
     }
     async postProcessNode(node) {
         if (ProcessedHierarchyNode.isGroupingNode(node)) {
+            let hasDirectNonFilteredTargets = false;
+            let hasFilterTargetAncestor = false;
+            for (const child of node.children) {
+                if (child.filtering) {
+                    if (child.filtering.hasFilterTargetAncestor) {
+                        hasFilterTargetAncestor = true;
+                        break;
+                    }
+                    if (!child.filtering.isFilterTarget) {
+                        hasDirectNonFilteredTargets = true;
+                        break;
+                    }
+                }
+            }
             return {
                 ...node,
-                label: this._hierarchyConfig.elementClassGrouping === "enableWithCounts" ? `${node.label} (${node.children.length})` : node.label,
+                ...(hasFilterTargetAncestor
+                    ? {
+                        filtering: {
+                            ...(node.filtering ?? {}),
+                            hasFilterTargetAncestor,
+                        },
+                    }
+                    : {}),
+                label: this.#hierarchyConfig.elementClassGrouping === "enableWithCounts" ? `${node.label} (${node.children.length})` : node.label,
                 extendedData: {
                     ...node.extendedData,
                     // add `modelId` and `categoryId` from the first grouped element
                     ...node.children[0].extendedData,
+                    ...(hasDirectNonFilteredTargets ? { hasDirectNonFilteredTargets } : {}),
                     // `imageId` is assigned to instance nodes at query time, but grouping ones need to
                     // be handled during post-processing
                     imageId: "icon-ec-class",
@@ -91,27 +118,27 @@ export class ModelsTreeDefinition {
         return node;
     }
     async defineHierarchyLevel(props) {
-        if (this._isSupported === undefined) {
-            this._isSupported = this.isSupported();
+        if (this.#isSupported === undefined) {
+            this.#isSupported = this.isSupported();
         }
-        if ((await this._isSupported) === false) {
+        if ((await this.#isSupported) === false) {
             return [];
         }
-        return this._impl.defineHierarchyLevel(props);
+        return this.#impl.defineHierarchyLevel(props);
     }
     async createSubjectChildrenQuery({ parentNodeInstanceIds: parentSubjectIds, instanceFilter, }) {
         const [subjectFilterClauses, modelFilterClauses] = await Promise.all([
-            this._selectQueryFactory.createFilterClauses({
+            this.#selectQueryFactory.createFilterClauses({
                 filter: instanceFilter,
                 contentClass: { fullName: "BisCore.Subject", alias: "this" },
             }),
-            this._selectQueryFactory.createFilterClauses({
+            this.#selectQueryFactory.createFilterClauses({
                 filter: instanceFilter,
                 contentClass: { fullName: "BisCore.GeometricModel3d", alias: "this" },
             }),
         ]);
         const [childSubjectIds, childModelIds] = parentSubjectIds.length
-            ? await Promise.all([this._idsCache.getChildSubjectIds(parentSubjectIds), this._idsCache.getChildSubjectModelIds(parentSubjectIds)])
+            ? await Promise.all([this.#idsCache.getChildSubjectIds(parentSubjectIds), this.#idsCache.getChildSubjectModelIds(parentSubjectIds)])
             : [[IModel.rootSubjectId], []];
         const defs = new Array();
         childSubjectIds.length &&
@@ -120,11 +147,11 @@ export class ModelsTreeDefinition {
                 query: {
                     ecsql: `
             SELECT
-              ${await this._selectQueryFactory.createSelectClause({
+              ${await this.#selectQueryFactory.createSelectClause({
                         ecClassId: { selector: "this.ECClassId" },
                         ecInstanceId: { selector: "this.ECInstanceId" },
                         nodeLabel: {
-                            selector: await this._nodeLabelSelectClauseFactory.createSelectClause({
+                            selector: await this.#nodeLabelSelectClauseFactory.createSelectClause({
                                 classAlias: "this",
                                 className: "BisCore.Subject",
                             }),
@@ -146,7 +173,7 @@ export class ModelsTreeDefinition {
               ${subjectFilterClauses.where ? `AND ${subjectFilterClauses.where}` : ""}
           `,
                     bindings: [
-                        { type: "idset", value: await this._idsCache.getParentSubjectIds() },
+                        { type: "idset", value: await this.#idsCache.getParentSubjectIds() },
                         ...childSubjectIds.map((id) => ({ type: "id", value: id })),
                     ],
                 },
@@ -159,11 +186,11 @@ export class ModelsTreeDefinition {
             SELECT model.ECInstanceId AS ECInstanceId, model.*
             FROM (
               SELECT
-                ${await this._selectQueryFactory.createSelectClause({
+                ${await this.#selectQueryFactory.createSelectClause({
                         ecClassId: { selector: "m.ECClassId" },
                         ecInstanceId: { selector: "m.ECInstanceId" },
                         nodeLabel: {
-                            selector: await this._nodeLabelSelectClauseFactory.createSelectClause({
+                            selector: await this.#nodeLabelSelectClauseFactory.createSelectClause({
                                 classAlias: "partition",
                                 className: "BisCore.InformationPartitionElement",
                             }),
@@ -179,12 +206,12 @@ export class ModelsTreeDefinition {
                       END
                     `,
                         },
-                        hasChildren: this._hierarchyConfig.showEmptyModels
+                        hasChildren: this.#hierarchyConfig.showEmptyModels
                             ? {
                                 selector: `
                           IFNULL((
                             SELECT 1
-                            FROM ${this._hierarchyConfig.elementClassSpecification} e
+                            FROM ${this.#hierarchyConfig.elementClassSpecification} e
                             WHERE e.Model.Id = m.ECInstanceId
                             LIMIT 1
                           ), 0)
@@ -220,7 +247,7 @@ export class ModelsTreeDefinition {
                 query: {
                     ecsql: `
             SELECT
-              ${await this._selectQueryFactory.createSelectClause({
+              ${await this.#selectQueryFactory.createSelectClause({
                         ecClassId: { selector: "this.ECClassId" },
                         ecInstanceId: { selector: "this.ECInstanceId" },
                         nodeLabel: "", // doesn't matter - the node is always hidden
@@ -230,7 +257,7 @@ export class ModelsTreeDefinition {
             WHERE
               this.ModeledElement.Id IN (${elementIds.map(() => "?").join(",")})
               AND NOT this.IsPrivate
-              AND this.ECInstanceId IN (SELECT Model.Id FROM ${this._hierarchyConfig.elementClassSpecification})
+              AND this.ECInstanceId IN (SELECT Model.Id FROM ${this.#hierarchyConfig.elementClassSpecification})
           `,
                     bindings: [...elementIds.map((id) => ({ type: "id", value: id }))],
                 },
@@ -238,7 +265,7 @@ export class ModelsTreeDefinition {
         ];
     }
     async createGeometricModel3dChildrenQuery({ parentNodeInstanceIds: modelIds, instanceFilter, }) {
-        const instanceFilterClauses = await this._selectQueryFactory.createFilterClauses({
+        const instanceFilterClauses = await this.#selectQueryFactory.createFilterClauses({
             filter: instanceFilter,
             contentClass: { fullName: "BisCore.SpatialCategory", alias: "this" },
         });
@@ -248,11 +275,11 @@ export class ModelsTreeDefinition {
                 query: {
                     ecsql: `
             SELECT
-              ${await this._selectQueryFactory.createSelectClause({
+              ${await this.#selectQueryFactory.createSelectClause({
                         ecClassId: { selector: "this.ECClassId" },
                         ecInstanceId: { selector: "this.ECInstanceId" },
                         nodeLabel: {
-                            selector: await this._nodeLabelSelectClauseFactory.createSelectClause({
+                            selector: await this.#nodeLabelSelectClauseFactory.createSelectClause({
                                 classAlias: "this",
                                 className: "BisCore.SpatialCategory",
                             }),
@@ -271,7 +298,7 @@ export class ModelsTreeDefinition {
             WHERE
               EXISTS (
                 SELECT 1
-                FROM ${this._hierarchyConfig.elementClassSpecification} element
+                FROM ${this.#hierarchyConfig.elementClassSpecification} element
                 WHERE
                   element.Model.Id IN (${modelIds.map(() => "?").join(",")})
                   AND element.Category.Id = +this.ECInstanceId
@@ -289,30 +316,30 @@ export class ModelsTreeDefinition {
         if (modelIds.length === 0) {
             throw new Error(`Invalid category node "${parentNode.label}" - missing model information.`);
         }
-        const instanceFilterClauses = await this._selectQueryFactory.createFilterClauses({
+        const instanceFilterClauses = await this.#selectQueryFactory.createFilterClauses({
             filter: instanceFilter,
-            contentClass: { fullName: this._hierarchyConfig.elementClassSpecification, alias: "this" },
+            contentClass: { fullName: this.#hierarchyConfig.elementClassSpecification, alias: "this" },
         });
-        const modeledElements = await firstValueFrom(from(modelIds).pipe(mergeMap(async (modelId) => this._idsCache.getCategoriesModeledElements(modelId, categoryIds)), reduce((acc, foundModeledElements) => {
+        const modeledElements = await firstValueFrom(from(modelIds).pipe(mergeMap(async (modelId) => this.#idsCache.getCategoriesModeledElements(modelId, categoryIds)), reduce((acc, foundModeledElements) => {
             return acc.concat(foundModeledElements);
         }, new Array())));
         return [
             {
-                fullClassName: this._hierarchyConfig.elementClassSpecification,
+                fullClassName: this.#hierarchyConfig.elementClassSpecification,
                 query: {
                     ecsql: `
             SELECT
-              ${await this._selectQueryFactory.createSelectClause({
+              ${await this.#selectQueryFactory.createSelectClause({
                         ecClassId: { selector: "this.ECClassId" },
                         ecInstanceId: { selector: "this.ECInstanceId" },
                         nodeLabel: {
-                            selector: await this._nodeLabelSelectClauseFactory.createSelectClause({
+                            selector: await this.#nodeLabelSelectClauseFactory.createSelectClause({
                                 classAlias: "this",
-                                className: this._hierarchyConfig.elementClassSpecification,
+                                className: this.#hierarchyConfig.elementClassSpecification,
                             }),
                         },
                         grouping: {
-                            byClass: this._hierarchyConfig.elementClassGrouping !== "disable",
+                            byClass: this.#hierarchyConfig.elementClassGrouping !== "disable",
                         },
                         hasChildren: {
                             selector: `
@@ -321,7 +348,7 @@ export class ModelsTreeDefinition {
                       1,
                       IFNULL((
                         SELECT 1
-                        FROM ${this._hierarchyConfig.elementClassSpecification} ce
+                        FROM ${this.#hierarchyConfig.elementClassSpecification} ce
                         WHERE ce.Parent.Id = this.ECInstanceId
                         LIMIT 1
                       ), 0)
@@ -349,33 +376,33 @@ export class ModelsTreeDefinition {
         ];
     }
     async createGeometricElement3dChildrenQuery({ parentNodeInstanceIds: elementIds, instanceFilter, }) {
-        const instanceFilterClauses = await this._selectQueryFactory.createFilterClauses({
+        const instanceFilterClauses = await this.#selectQueryFactory.createFilterClauses({
             filter: instanceFilter,
-            contentClass: { fullName: this._hierarchyConfig.elementClassSpecification, alias: "this" },
+            contentClass: { fullName: this.#hierarchyConfig.elementClassSpecification, alias: "this" },
         });
         return [
             {
-                fullClassName: this._hierarchyConfig.elementClassSpecification,
+                fullClassName: this.#hierarchyConfig.elementClassSpecification,
                 query: {
                     ecsql: `
             SELECT
-              ${await this._selectQueryFactory.createSelectClause({
+              ${await this.#selectQueryFactory.createSelectClause({
                         ecClassId: { selector: "this.ECClassId" },
                         ecInstanceId: { selector: "this.ECInstanceId" },
                         nodeLabel: {
-                            selector: await this._nodeLabelSelectClauseFactory.createSelectClause({
+                            selector: await this.#nodeLabelSelectClauseFactory.createSelectClause({
                                 classAlias: "this",
-                                className: this._hierarchyConfig.elementClassSpecification,
+                                className: this.#hierarchyConfig.elementClassSpecification,
                             }),
                         },
                         grouping: {
-                            byClass: this._hierarchyConfig.elementClassGrouping !== "disable",
+                            byClass: this.#hierarchyConfig.elementClassGrouping !== "disable",
                         },
                         hasChildren: {
                             selector: `
                     IFNULL((
                       SELECT 1
-                      FROM ${this._hierarchyConfig.elementClassSpecification} ce
+                      FROM ${this.#hierarchyConfig.elementClassSpecification} ce
                       JOIN BisCore.Model m ON ce.Model.Id = m.ECInstanceId
                       WHERE ce.Parent.Id = this.ECInstanceId OR (ce.Model.Id = this.ECInstanceId AND m.IsPrivate = false)
                       LIMIT 1
@@ -402,20 +429,25 @@ export class ModelsTreeDefinition {
     }
     static async createInstanceKeyPaths(props) {
         return lastValueFrom(defer(() => {
+            const componentInfo = { componentId: props.componentId ?? Guid.createValue(), componentName: this.#componentName };
             if (ModelsTreeInstanceKeyPathsProps.isLabelProps(props)) {
                 const labelsFactory = createBisInstanceLabelSelectClauseFactory({ classHierarchyInspector: props.imodelAccess });
-                return createInstanceKeyPathsFromInstanceLabelObs({ ...props, labelsFactory });
+                return createInstanceKeyPathsFromInstanceLabelObs({
+                    ...props,
+                    ...componentInfo,
+                    labelsFactory,
+                });
             }
-            return createInstanceKeyPathsFromTargetItemsObs(props);
+            return createInstanceKeyPathsFromTargetItemsObs({ ...props, ...componentInfo });
         }).pipe(props.abortSignal ? takeUntil(fromEvent(props.abortSignal, "abort")) : identity, defaultIfEmpty([])));
     }
     supportsFiltering() {
-        return this._hierarchyConfig.hierarchyLevelFiltering === "enable";
+        return this.#hierarchyConfig.hierarchyLevelFiltering === "enable";
     }
     async isSupported() {
-        const [schemaName, className] = this._hierarchyConfig.elementClassSpecification.split(/[\.:]/);
+        const [schemaName, className] = this.#hierarchyConfig.elementClassSpecification.split(/[\.:]/);
         if (!schemaName || !className) {
-            throw new Error(`Provided class specification ${this._hierarchyConfig.elementClassSpecification} should be in format {SchemaName}:{ClassName} or {SchemaName}.{ClassName}`);
+            throw new Error(`Provided class specification ${this.#hierarchyConfig.elementClassSpecification} should be in format {SchemaName}:{ClassName} or {SchemaName}.{ClassName}`);
         }
         const query = {
             ecsql: `
@@ -429,13 +461,16 @@ export class ModelsTreeDefinition {
                 { type: "string", value: className },
             ],
         };
-        for await (const _row of this._queryExecutor.createQueryReader(query)) {
+        for await (const _row of this.#queryExecutor.createQueryReader(query, {
+            restartToken: `${ModelsTreeDefinition.#componentName}/${this.#componentId}/is-class-supported`,
+        })) {
             return true;
         }
         return false;
     }
 }
-function createGeometricElementInstanceKeyPaths(imodelAccess, idsCache, hierarchyConfig, targetItems) {
+function createGeometricElementInstanceKeyPaths(props) {
+    const { targetItems, chunkIndex, componentId, componentName, hierarchyConfig, idsCache, imodelAccess } = props;
     const elementIds = targetItems.filter((info) => typeof info === "string");
     const groupInfos = targetItems.filter((info) => typeof info !== "string");
     const separator = ";";
@@ -495,7 +530,7 @@ function createGeometricElementInstanceKeyPaths(imodelAccess, idsCache, hierarch
       FROM ModelsCategoriesElementsHierarchy mce
       WHERE mce.ParentId IS NULL
     `;
-        return imodelAccess.createQueryReader({ ctes, ecsql }, { rowFormat: "Indexes", limit: "unbounded" });
+        return imodelAccess.createQueryReader({ ctes, ecsql }, { rowFormat: "Indexes", limit: "unbounded", restartToken: `${componentName}/${componentId}/geometric-element-paths/${chunkIndex}` });
     }).pipe(releaseMainThreadOnItemsCount(300), map((row) => parseQueryRow(row, groupInfos, separator, hierarchyConfig.elementClassSpecification)), mergeMap(({ modelId, elementHierarchyPath, groupingNode }) => from(idsCache.createModelInstanceKeyPaths(modelId)).pipe(mergeAll(), map((modelPath) => {
         // We don't want to modify the original path, we create a copy that we can modify
         const newModelPath = [...modelPath];
@@ -537,7 +572,7 @@ function parseQueryRow(row, groupInfos, separator, elementClassName) {
         groupingNode: row[2] === -1 ? undefined : groupInfos[row[2]].groupingNode,
     };
 }
-function createInstanceKeyPathsFromTargetItemsObs({ targetItems, imodelAccess, hierarchyConfig, idsCache, limit, }) {
+function createInstanceKeyPathsFromTargetItemsObs({ targetItems, imodelAccess, hierarchyConfig, idsCache, limit, componentId, componentName, }) {
     if (limit !== "unbounded" && targetItems.length > (limit ?? MAX_FILTERING_INSTANCE_KEY_COUNT)) {
         throw new FilterLimitExceededError(limit ?? MAX_FILTERING_INSTANCE_KEY_COUNT);
     }
@@ -577,7 +612,15 @@ function createInstanceKeyPathsFromTargetItemsObs({ targetItems, imodelAccess, h
         elements: new Array(),
     }), switchMap(async (ids) => {
         const elementsLength = ids.elements.length;
-        return collect(merge(from(ids.subjects).pipe(mergeMap((id) => from(idsCache.createSubjectInstanceKeysPath(id)).pipe(map(HierarchyFilteringPath.normalize)))), from(ids.models).pipe(mergeMap((id) => from(idsCache.createModelInstanceKeyPaths(id)).pipe(mergeAll(), map(HierarchyFilteringPath.normalize)))), from(ids.categories).pipe(mergeMap((id) => from(idsCache.createCategoryInstanceKeyPaths(id)).pipe(mergeAll(), map(HierarchyFilteringPath.normalize)))), from(ids.elements).pipe(bufferCount(Math.ceil(elementsLength / Math.ceil(elementsLength / 5000))), releaseMainThreadOnItemsCount(1), mergeMap((block) => createGeometricElementInstanceKeyPaths(imodelAccess, idsCache, hierarchyConfig, block), 10))));
+        return collect(merge(from(ids.subjects).pipe(mergeMap((id) => from(idsCache.createSubjectInstanceKeysPath(id)).pipe(map(HierarchyFilteringPath.normalize)))), from(ids.models).pipe(mergeMap((id) => from(idsCache.createModelInstanceKeyPaths(id)).pipe(mergeAll(), map(HierarchyFilteringPath.normalize)))), from(ids.categories).pipe(mergeMap((id) => from(idsCache.createCategoryInstanceKeyPaths(id)).pipe(mergeAll(), map(HierarchyFilteringPath.normalize)))), from(ids.elements).pipe(bufferCount(Math.ceil(elementsLength / Math.ceil(elementsLength / 5000))), releaseMainThreadOnItemsCount(1), mergeMap((block, chunkIndex) => createGeometricElementInstanceKeyPaths({
+            imodelAccess,
+            idsCache,
+            hierarchyConfig,
+            targetItems: block,
+            componentId,
+            componentName,
+            chunkIndex,
+        }), 10))));
     }));
 }
 function createInstanceKeyPathsFromInstanceLabelObs(props) {
@@ -620,7 +663,7 @@ function createInstanceKeyPathsFromInstanceLabelObs(props) {
     }).pipe(mergeMap((queryProps) => {
         return imodelAccess.createQueryReader(queryProps, {
             rowFormat: "Indexes",
-            restartToken: "tree-widget/models-tree/filter-by-label-query",
+            restartToken: `${props.componentName}/${props.componentId}/filter-by-label`,
             limit,
         });
     }), map((row) => ({ className: row[0], id: row[1] })), toArray(), mergeMap((targetKeys) => createInstanceKeyPathsFromTargetItemsObs({ ...props, targetItems: targetKeys })));