@itwin/presentation-hierarchies 0.6.0 → 0.7.0

package/lib/cjs/hierarchies/{internal → imodel}/FilteringHierarchyDefinition.js

@@ -6,17 +6,19 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ECSQL_COLUMN_NAME_HasFilterTargetAncestor = exports.ECSQL_COLUMN_NAME_FilterTargetOptions = exports.ECSQL_COLUMN_NAME_IsFilterTarget = exports.ECSQL_COLUMN_NAME_FilteredChildrenPaths = exports.FilteringHierarchyDefinition = void 0;
 exports.applyECInstanceIdsFilter = applyECInstanceIdsFilter;
-const HierarchyDefinition_1 = require("../HierarchyDefinition");
+const HierarchyFiltering_1 = require("../HierarchyFiltering");
 const HierarchyNode_1 = require("../HierarchyNode");
 const HierarchyNodeIdentifier_1 = require("../HierarchyNodeIdentifier");
+const IModelHierarchyDefinition_1 = require("./IModelHierarchyDefinition");
+const IModelHierarchyNode_1 = require("./IModelHierarchyNode");
 const TreeNodesReader_1 = require("./TreeNodesReader");
 /** @internal */
 class FilteringHierarchyDefinition {
-    _classHierarchy;
+    _imodelAccess;
     _source;
     _nodeIdentifierPaths;
     constructor(props) {
-        this._classHierarchy = props.classHierarchy;
+        this._imodelAccess = props.imodelAccess;
         this._source = props.source;
         this._nodeIdentifierPaths = props.nodeIdentifierPaths;
     }
@@ -70,7 +72,7 @@ class FilteringHierarchyDefinition {
         return async (node) => {
             const processedNode = this._source.postProcessNode ? await this._source.postProcessNode(node) : node;
             // instance nodes get the auto-expand flag in `parseNode`, but grouping ones need to be handled during post-processing
-            if (HierarchyNode_1.HierarchyNode.isGroupingNode(node) && this.shouldExpandGroupingNode(node)) {
+            if (IModelHierarchyNode_1.ProcessedHierarchyNode.isGroupingNode(node) && this.shouldExpandGroupingNode(node)) {
                 Object.assign(processedNode, { autoExpand: true });
             }
             return processedNode;
@@ -98,20 +100,19 @@ class FilteringHierarchyDefinition {
     }
     async defineHierarchyLevel(props) {
         const sourceDefinitions = await this._source.defineHierarchyLevel(props);
-        const { filteredNodePaths, isDirectParentFilterTarget, hasFilterTargetAncestor } = this.getFilteringProps(props.parentNode);
-        if (!filteredNodePaths) {
+        const filteringProps = (0, HierarchyFiltering_1.extractFilteringProps)(this._nodeIdentifierPaths, props.parentNode);
+        if (!filteringProps) {
             return sourceDefinitions;
         }
         const filteredDefinitions = [];
         await Promise.all(sourceDefinitions.map(async (definition) => {
             let matchedDefinition;
-            if (HierarchyDefinition_1.HierarchyNodesDefinition.isCustomNode(definition)) {
-                matchedDefinition = await matchFilters(definition, { filteredNodePaths, isDirectParentFilterTarget }, async (id) => {
-                    if (!HierarchyNodeIdentifier_1.HierarchyNodeIdentifier.isCustomNodeIdentifier(id)) {
-                        return false;
-                    }
-                    return id.key === definition.node.key;
-                }, this._classHierarchy, (def, matchingFilters) => {
+            if (IModelHierarchyDefinition_1.HierarchyNodesDefinition.isGenericNode(definition)) {
+                matchedDefinition = await matchFilters(definition, filteringProps, async (id) => {
+                    return (HierarchyNodeIdentifier_1.HierarchyNodeIdentifier.isGenericNodeIdentifier(id) &&
+                        (!id.source || id.source === this._imodelAccess.imodelKey) &&
+                        id.id === definition.node.key);
+                }, this._imodelAccess, (def, matchingFilters) => {
                     const filteredChildrenIdentifierPaths = matchingFilters.reduce((r, c) => [...r, ...c.childrenIdentifierPaths], new Array());
                     return {
                         ...def,
@@ -119,18 +120,17 @@ class FilteringHierarchyDefinition {
                             node: def.node,
                             filteredChildrenIdentifierPaths,
                             isFilterTarget: matchingFilters.some((mc) => mc.isFilterTarget),
-                            hasFilterTargetAncestor,
+                            hasFilterTargetAncestor: filteringProps.hasFilterTargetAncestor,
                         }),
                     };
                 });
             }
             else {
-                matchedDefinition = await matchFilters(definition, { filteredNodePaths, isDirectParentFilterTarget }, async (id) => {
-                    if (!HierarchyNodeIdentifier_1.HierarchyNodeIdentifier.isInstanceNodeIdentifier(id)) {
-                        return false;
-                    }
-                    return this._classHierarchy.classDerivesFrom(id.className, definition.fullClassName);
-                }, this._classHierarchy, (def, matchingFilters) => applyECInstanceIdsFilter(def, matchingFilters, !!isDirectParentFilterTarget, !!hasFilterTargetAncestor));
+                matchedDefinition = await matchFilters(definition, filteringProps, async (id) => {
+                    return (HierarchyNodeIdentifier_1.HierarchyNodeIdentifier.isInstanceNodeIdentifier(id) &&
+                        (!id.imodelKey || id.imodelKey === this._imodelAccess.imodelKey) &&
+                        (await this._imodelAccess.classDerivesFrom(id.className, definition.fullClassName)));
+                }, this._imodelAccess, (def, matchingFilters) => applyECInstanceIdsFilter(def, matchingFilters, !!filteringProps.hasFilterTargetAncestor));
             }
             if (matchedDefinition) {
                 filteredDefinitions.push(matchedDefinition);
@@ -138,23 +138,13 @@ class FilteringHierarchyDefinition {
         }));
         return filteredDefinitions;
     }
-    getFilteringProps(parentNode) {
-        if (!parentNode) {
-            return { filteredNodePaths: this._nodeIdentifierPaths, isDirectParentFilterTarget: false, hasFilterTargetAncestor: false };
-        }
-        return {
-            filteredNodePaths: parentNode.filtering?.filteredChildrenIdentifierPaths,
-            isDirectParentFilterTarget: parentNode.filtering?.isFilterTarget,
-            hasFilterTargetAncestor: !!parentNode.filtering?.hasFilterTargetAncestor,
-        };
-    }
 }
 exports.FilteringHierarchyDefinition = FilteringHierarchyDefinition;
 async function matchFilters(definition, filteringProps, predicate, classHierarchy, matchedDefinitionProcessor) {
-    const { filteredNodePaths, isDirectParentFilterTarget } = filteringProps;
+    const { filteredNodePaths, hasFilterTargetAncestor } = filteringProps;
     const matchingFilters = [];
     for (const filteredNodePath of filteredNodePaths) {
-        const { path, options } = "path" in filteredNodePath ? filteredNodePath : { path: filteredNodePath, options: undefined };
+        const { path, options } = HierarchyFiltering_1.HierarchyFilteringPath.normalize(filteredNodePath);
         if (path.length === 0) {
             continue;
         }
@@ -173,47 +163,21 @@ async function matchFilters(definition, filteringProps, predicate, classHierarch
             }
             const remainingPath = path.slice(1);
             if (remainingPath.length > 0) {
-                const remainingPathWithOptions = options ? { path: remainingPath, options } : remainingPath;
-                entry.childrenIdentifierPaths.push(remainingPathWithOptions);
+                entry.childrenIdentifierPaths.push(options ? { path: remainingPath, options } : remainingPath);
             }
             else if (entry.isFilterTarget) {
-                entry.filterTargetOptions = mergeFilterTargetOptions(entry.filterTargetOptions, options);
+                entry.filterTargetOptions = HierarchyFiltering_1.HierarchyFilteringPath.mergeOptions(entry.filterTargetOptions, options);
             }
             else {
                 Object.assign(entry, { isFilterTarget: true, filterTargetOptions: options });
             }
         }
     }
-    if (isDirectParentFilterTarget || matchingFilters.length > 0) {
+    if (hasFilterTargetAncestor || matchingFilters.length > 0) {
         return matchedDefinitionProcessor(definition, matchingFilters);
     }
     return undefined;
 }
-function mergeFilterTargetOptions(target, source) {
-    // istanbul ignore next
-    if (!target && !source) {
-        return undefined;
-    }
-    // istanbul ignore next
-    if (!target) {
-        return source;
-    }
-    // istanbul ignore next
-    if (!source) {
-        return target;
-    }
-    return {
-        autoExpand: (() => {
-            if (source.autoExpand === true) {
-                return source.autoExpand;
-            }
-            if (typeof target.autoExpand === "object" && typeof source.autoExpand === "object" && source.autoExpand.depth > target.autoExpand.depth) {
-                return source.autoExpand;
-            }
-            return target.autoExpand;
-        })(),
-    };
-}
 async function findMatchingFilterEntry(filters, nodeId, classHierarchy) {
     for (const filter of filters) {
         if (await identifiersEqual(filter.id, nodeId, classHierarchy)) {
@@ -231,20 +195,18 @@ async function identifiersEqual(lhs, rhs, classHierarchy) {
     }
     return HierarchyNodeIdentifier_1.HierarchyNodeIdentifier.equal(lhs, rhs);
 }
-function applyFilterAttributes({ node, filteredChildrenIdentifierPaths, isFilterTarget, filterTargetOptions, hasFilterTargetAncestor, }) {
+function applyFilterAttributes(props) {
+    const { node, filteredChildrenIdentifierPaths } = props;
+    const result = { ...node };
     const shouldAutoExpand = !!filteredChildrenIdentifierPaths?.some((childPath) => {
-        return "path" in childPath && childPath.path.length && childPath.options?.autoExpand;
+        return !!HierarchyFiltering_1.HierarchyFilteringPath.normalize(childPath).options?.autoExpand;
     });
-    const result = { ...node };
     if (shouldAutoExpand) {
         result.autoExpand = true;
     }
-    if (isFilterTarget || hasFilterTargetAncestor || filteredChildrenIdentifierPaths?.length) {
-        result.filtering = {
-            ...(isFilterTarget ? { isFilterTarget, filterTargetOptions } : undefined),
-            ...(hasFilterTargetAncestor ? { hasFilterTargetAncestor } : undefined),
-            ...(!!filteredChildrenIdentifierPaths?.length ? { filteredChildrenIdentifierPaths } : undefined),
-        };
+    const filteringProps = HierarchyNode_1.HierarchyNodeFilteringProps.create(props);
+    if (filteringProps) {
+        result.filtering = filteringProps;
     }
     return result;
 }
@@ -261,7 +223,7 @@ exports.ECSQL_COLUMN_NAME_FilterTargetOptions = "FilterTargetOptions";
 // eslint-disable-next-line @typescript-eslint/naming-convention
 exports.ECSQL_COLUMN_NAME_HasFilterTargetAncestor = "HasFilterTargetAncestor";
 /** @internal */
-function applyECInstanceIdsFilter(def, matchingFilters, isParentFilterTarget, hasFilterTargetAncestor) {
+function applyECInstanceIdsFilter(def, matchingFilters, hasFilterTargetAncestor) {
     if (matchingFilters.length === 0) {
         return def;
     }
@@ -286,12 +248,12 @@ function applyECInstanceIdsFilter(def, matchingFilters, isParentFilterTarget, ha
           [q].*,
           [f].[IsFilterTarget] AS [${exports.ECSQL_COLUMN_NAME_IsFilterTarget}],
           [f].[FilterTargetOptions] AS [${exports.ECSQL_COLUMN_NAME_FilterTargetOptions}],
-          ${hasFilterTargetAncestor || isParentFilterTarget ? "1" : "0"} AS [${exports.ECSQL_COLUMN_NAME_HasFilterTargetAncestor}],
+          ${hasFilterTargetAncestor ? "1" : "0"} AS [${exports.ECSQL_COLUMN_NAME_HasFilterTargetAncestor}],
           [f].[FilteredChildrenPaths] AS [${exports.ECSQL_COLUMN_NAME_FilteredChildrenPaths}]
         FROM (
           ${def.query.ecsql}
         ) [q]
-        ${isParentFilterTarget ? "LEFT " : ""} JOIN FilteringInfo [f] ON [f].[ECInstanceId] = [q].[ECInstanceId]
+        ${hasFilterTargetAncestor ? "LEFT " : ""} JOIN FilteringInfo [f] ON [f].[ECInstanceId] = [q].[ECInstanceId]
       `,
         },
     };

package/lib/cjs/hierarchies/imodel/FilteringHierarchyDefinition.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"FilteringHierarchyDefinition.js","sourceRoot":"","sources":["../../../../src/hierarchies/imodel/FilteringHierarchyDefinition.ts"],"names":[],"mappings":";AAAA;;;gGAGgG;;;AAkThG,4DAwCC;AAvVD,8DAAqH;AACrH,oDAA+D;AAC/D,wEAAqE;AAErE,2EAUqC;AACrC,+DAAiJ;AACjJ,uDAAuD;AAQvD,gBAAgB;AAChB,MAAa,4BAA4B;IAC/B,aAAa,CAAoD;IACjE,OAAO,CAAsB;IAC7B,oBAAoB,CAA2B;IAEvD,YAAmB,KAAwC;QACzD,IAAI,CAAC,aAAa,GAAG,KAAK,CAAC,YAAY,CAAC;QACxC,IAAI,CAAC,OAAO,GAAG,KAAK,CAAC,MAAM,CAAC;QAC5B,IAAI,CAAC,oBAAoB,GAAG,KAAK,CAAC,mBAAmB,CAAC;IACxD,CAAC;IAED,IAAW,cAAc;QACvB,OAAO,KAAK,EAAE,IAAI,EAAE,EAAE;YACpB,MAAM,aAAa,GAAG,IAAI,CAAC,OAAO,CAAC,cAAc,CAAC,CAAC,CAAC,MAAM,IAAI,CAAC,OAAO,CAAC,cAAc,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;YACnG,IAAI,aAAa,EAAE,gBAAgB,EAAE,eAAe,IAAI,aAAa,CAAC,SAAS,EAAE,cAAc,IAAI,CAAC,aAAa,CAAC,SAAS,CAAC,uBAAuB,EAAE,CAAC;gBACpJ,yHAAyH;gBACzH,OAAO,SAAS,CAAC;YACnB,CAAC;YACD,OAAO,aAAa,CAAC;QACvB,CAAC,CAAC;IACJ,CAAC;IAEO,wBAAwB,CAAC,IAAoC;QACnE,KAAK,MAAM,KAAK,IAAI,IAAI,CAAC,QAAQ,EAAE,CAAC;YAClC,uBAAuB;YACvB,IAAI,CAAC,KAAK,CAAC,SAAS,EAAE,CAAC;gBACrB,SAAS;YACX,CAAC;YAED,IAAI,KAAK,CAAC,SAAS,CAAC,cAAc,EAAE,CAAC;gBACnC,MAAM,eAAe,GAAG,KAAK,CAAC,SAAS,CAAC,mBAAmB,EAAE,UAAU,CAAC;gBAExE,gGAAgG;gBAChG,IAAI,eAAe,KAAK,IAAI,EAAE,CAAC;oBAC7B,OAAO,IAAI,CAAC;gBACd,CAAC;gBAED,2EAA2E;gBAC3E,IAAI,OAAO,eAAe,KAAK,QAAQ,EAAE,CAAC;oBACxC,SAAS;gBACX,CAAC;gBAED,uDAAuD;gBACvD,0HAA0H;gBAC1H,MAAM,SAAS,GAAG,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC;gBACzC,MAAM,iBAAiB,GAAG,eAAe,CAAC,KAAK,CAAC;gBAChD,IAAI,SAAS,GAAG,iBAAiB,EAAE,CAAC;oBAClC,OAAO,IAAI,CAAC;gBACd,CAAC;YACH,CAAC;YAED,IAAI,CAAC,KAAK,CAAC,SAAS,CAAC,+BAA+B,EAAE,CAAC;gBACrD,uBAAuB;gBACvB,SAAS;YACX,CAAC;YAED,KAAK,MAAM,IAAI,IAAI,KAAK,CAAC,SAAS,CAAC,+BAA+B,EAAE,CAAC;gBACnE,IAAI,MAAM,IAAI,IAAI,IAAI,IAAI,CAAC,OAAO,EAAE,UAAU,EAAE,CAAC;oBAC/C,OAAO,IAAI,CAAC;gBACd,CAAC;YACH,CAAC;QACH,CAAC;QACD,OAAO,KAAK,CAAC;IACf,CAAC;IAED,IAAW,eAAe;QACxB,OAAO,KAAK,EAAE,IAA4B,EAAE,EAAE;YAC5C,MAAM,aAAa,GAAG,IAAI,CAAC,OAAO,CAAC,eAAe,CAAC,CAAC,CAAC,MAAM,IAAI,CAAC,OAAO,CAAC,eAAe,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;YACrG,sHAAsH;YACtH,IAAI,4CAAsB,CAAC,cAAc,CAAC,IAAI,CAAC,IAAI,IAAI,CAAC,wBAAwB,CAAC,IAAI,CAAC,EAAE,CAAC;gBACvF,MAAM,CAAC,MAAM,CAAC,aAAa,EAAE,EAAE,UAAU,EAAE,IAAI,EAAE,CAAC,CAAC;YACrD,CAAC;YACD,OAAO,aAAa,CAAC;QACvB,CAAC,CAAC;IACJ,CAAC;IAED,IAAW,SAAS;QAClB,OAAO,CAAC,GAAkC,EAA+B,EAAE;YACzE,MAAM,uBAAuB,GAAY,CAAC,CAAC,GAAG,CAAC,iDAAyC,CAAC,CAAC;YAC1F,MAAM,cAAc,GAAY,CAAC,CAAC,GAAG,CAAC,wCAAgC,CAAC,CAAC;YACxE,MAAM,mBAAmB,GAA8C,GAAG,CAAC,6CAAqC,CAAC;gBAC/G,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,6CAAqC,CAAC,CAAC;gBACxD,CAAC,CAAC,SAAS,CAAC;YACd,MAAM,+BAA+B,GAAyC,GAAG,CAAC,+CAAuC,CAAC;gBACxH,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,+CAAuC,CAAC,CAAC;gBAC1D,CAAC,CAAC,SAAS,CAAC;YACd,MAAM,WAAW,GAAG,CAAC,IAAI,CAAC,OAAO,CAAC,SAAS,IAAI,oCAAkB,CAAC,CAAC,GAAG,CAAC,CAAC;YACxE,OAAO,qBAAqB,CAAC;gBAC3B,IAAI,EAAE,WAAW;gBACjB,+BAA+B;gBAC/B,cAAc;gBACd,mBAAmB;gBACnB,uBAAuB;aACxB,CAAC,CAAC;QACL,CAAC,CAAC;IACJ,CAAC;IAEM,KAAK,CAAC,oBAAoB,CAAC,KAAgC;QAChE,MAAM,iBAAiB,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,oBAAoB,CAAC,KAAK,CAAC,CAAC;QACzE,MAAM,cAAc,GAAG,IAAA,0CAAqB,EAAC,IAAI,CAAC,oBAAoB,EAAE,KAAK,CAAC,UAAU,CAAC,CAAC;QAC1F,IAAI,CAAC,cAAc,EAAE,CAAC;YACpB,OAAO,iBAAiB,CAAC;QAC3B,CAAC;QAED,MAAM,mBAAmB,GAA6B,EAAE,CAAC;QACzD,MAAM,OAAO,CAAC,GAAG,CACf,iBAAiB,CAAC,GAAG,CAAC,KAAK,EAAE,UAAU,EAAE,EAAE;YACzC,IAAI,iBAAuD,CAAC;YAC5D,IAAI,oDAAwB,CAAC,aAAa,CAAC,UAAU,CAAC,EAAE,CAAC;gBACvD,iBAAiB,GAAG,MAAM,YAAY,CACpC,UAAU,EACV,cAAc,EACd,KAAK,EAAE,EAAE,EAAE,EAAE;oBACX,OAAO,CACL,iDAAuB,CAAC,uBAAuB,CAAC,EAAE,CAAC;wBACnD,CAAC,CAAC,EAAE,CAAC,MAAM,IAAI,EAAE,CAAC,MAAM,KAAK,IAAI,CAAC,aAAa,CAAC,SAAS,CAAC;wBAC1D,EAAE,CAAC,EAAE,KAAK,UAAU,CAAC,IAAI,CAAC,GAAG,CAC9B,CAAC;gBACJ,CAAC,EACD,IAAI,CAAC,aAAa,EAClB,CAAC,GAAG,EAAE,eAAe,EAAE,EAAE;oBACvB,MAAM,+BAA+B,GAAG,eAAe,CAAC,MAAM,CAC5D,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,GAAG,CAAC,EAAE,GAAG,CAAC,CAAC,uBAAuB,CAAC,EAC9C,IAAI,KAAK,EAA0B,CACpC,CAAC;oBACF,OAAO;wBACL,GAAG,GAAG;wBACN,IAAI,EAAE,qBAAqB,CAAC;4BAC1B,IAAI,EAAE,GAAG,CAAC,IAAI;4BACd,+BAA+B;4BAC/B,cAAc,EAAE,eAAe,CAAC,IAAI,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE,CAAC,cAAc,CAAC;4BAC/D,uBAAuB,EAAE,cAAc,CAAC,uBAAuB;yBAChE,CAAC;qBACH,CAAC;gBACJ,CAAC,CACF,CAAC;YACJ,CAAC;iBAAM,CAAC;gBACN,iBAAiB,GAAG,MAAM,YAAY,CACpC,UAAU,EACV,cAAc,EACd,KAAK,EAAE,EAAE,EAAE,EAAE;oBACX,OAAO,CACL,iDAAuB,CAAC,wBAAwB,CAAC,EAAE,CAAC;wBACpD,CAAC,CAAC,EAAE,CAAC,SAAS,IAAI,EAAE,CAAC,SAAS,KAAK,IAAI,CAAC,aAAa,CAAC,SAAS,CAAC;wBAChE,CAAC,MAAM,IAAI,CAAC,aAAa,CAAC,gBAAgB,CAAC,EAAE,CAAC,SAAS,EAAE,UAAU,CAAC,aAAa,CAAC,CAAC,CACpF,CAAC;gBACJ,CAAC,EACD,IAAI,CAAC,aAAa,EAClB,CAAC,GAAG,EAAE,eAAe,EAAE,EAAE,CAAC,wBAAwB,CAAC,GAAG,EAAE,eAAe,EAAE,CAAC,CAAC,cAAc,CAAC,uBAAuB,CAAC,CACnH,CAAC;YACJ,CAAC;YACD,IAAI,iBAAiB,EAAE,CAAC;gBACtB,mBAAmB,CAAC,IAAI,CAAC,iBAAiB,CAAC,CAAC;YAC9C,CAAC;QACH,CAAC,CAAC,CACH,CAAC;QACF,OAAO,mBAAmB,CAAC;IAC7B,CAAC;CACF;AA9JD,oEA8JC;AAOD,KAAK,UAAU,YAAY,CAIzB,UAAuB,EACvB,cAAkG,EAClG,SAA4D,EAC5D,cAAyC,EACzC,0BAAiH;IAEjH,MAAM,EAAE,iBAAiB,EAAE,uBAAuB,EAAE,GAAG,cAAc,CAAC;IACtE,MAAM,eAAe,GAAsC,EAAE,CAAC;IAC9D,KAAK,MAAM,gBAAgB,IAAI,iBAAiB,EAAE,CAAC;QACjD,MAAM,EAAE,IAAI,EAAE,OAAO,EAAE,GAAG,2CAAsB,CAAC,SAAS,CAAC,gBAAgB,CAAC,CAAC;QAC7E,IAAI,IAAI,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YACtB,SAAS;QACX,CAAC;QACD,MAAM,MAAM,GAAG,IAAI,CAAC,CAAC,CAAC,CAAC;QACvB,IAAI,MAAM,SAAS,CAAC,MAAM,CAAC,EAAE,CAAC;YAC5B,IAAI,KAAK,GAAG,MAAM,uBAAuB,CAAC,eAAe,EAAE,MAAM,EAAE,cAAc,CAAC,CAAC;YACnF,IAAI,CAAC,KAAK,EAAE,CAAC;gBACX,KAAK,GAAG;oBACN,4GAA4G;oBAC5G,qCAAqC;oBACrC,EAAE,EAAE,MAAqB;oBACzB,uBAAuB,EAAE,EAAE;oBAC3B,cAAc,EAAE,KAAK;iBACtB,CAAC;gBACF,eAAe,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;YAC9B,CAAC;YACD,MAAM,aAAa,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;YACpC,IAAI,aAAa,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;gBAC7B,KAAK,CAAC,uBAAuB,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,aAAa,EAAE,OAAO,EAAE,CAAC,CAAC,CAAC,aAAa,CAAC,CAAC;YACjG,CAAC;iBAAM,IAAI,KAAK,CAAC,cAAc,EAAE,CAAC;gBAChC,KAAK,CAAC,mBAAmB,GAAG,2CAAsB,CAAC,YAAY,CAAC,KAAK,CAAC,mBAAmB,EAAE,OAAO,CAAC,CAAC;YACtG,CAAC;iBAAM,CAAC;gBACN,MAAM,CAAC,MAAM,CAAC,KAAK,EAAE,EAAE,cAAc,EAAE,IAAI,EAAE,mBAAmB,EAAE,OAAO,EAAE,CAAC,CAAC;YAC/E,CAAC;QACH,CAAC;IACH,CAAC;IACD,IAAI,uBAAuB,IAAI,eAAe,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QAC1D,OAAO,0BAA0B,CAAC,UAAU,EAAE,eAAe,CAAC,CAAC;IACjE,CAAC;IACD,OAAO,SAAS,CAAC;AACnB,CAAC;AAED,KAAK,UAAU,uBAAuB,CACpC,OAAiB,EACjB,MAAmB,EACnB,cAAyC;IAEzC,KAAK,MAAM,MAAM,IAAI,OAAO,EAAE,CAAC;QAC7B,IAAI,MAAM,gBAAgB,CAAC,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,cAAc,CAAC,EAAE,CAAC;YAC9D,OAAO,MAAM,CAAC;QAChB,CAAC;IACH,CAAC;IACD,OAAO,SAAS,CAAC;AACnB,CAAC;AAED,KAAK,UAAU,gBAAgB,CAA8C,GAAgB,EAAE,GAAgB,EAAE,cAAyC;IACxJ,IAAI,iDAAuB,CAAC,wBAAwB,CAAC,GAAG,CAAC,IAAI,iDAAuB,CAAC,wBAAwB,CAAC,GAAG,CAAC,EAAE,CAAC;QACnH,OAAO,CACL,GAAG,CAAC,EAAE,KAAK,GAAG,CAAC,EAAE;YACjB,CAAC,GAAG,CAAC,SAAS,KAAK,GAAG,CAAC,SAAS;gBAC9B,CAAC,MAAM,cAAc,CAAC,gBAAgB,CAAC,GAAG,CAAC,SAAS,EAAE,GAAG,CAAC,SAAS,CAAC,CAAC;gBACrE,CAAC,MAAM,cAAc,CAAC,gBAAgB,CAAC,GAAG,CAAC,SAAS,EAAE,GAAG,CAAC,SAAS,CAAC,CAAC,CAAC,CACzE,CAAC;IACJ,CAAC;IACD,OAAO,iDAAuB,CAAC,KAAK,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC;AACjD,CAAC;AAED,SAAS,qBAAqB,CAAoC,KAMjE;IACC,MAAM,EAAE,IAAI,EAAE,+BAA+B,EAAE,GAAG,KAAK,CAAC;IACxD,MAAM,MAAM,GAAG,EAAE,GAAG,IAAI,EAAE,CAAC;IAE3B,MAAM,gBAAgB,GAAG,CAAC,CAAC,+BAA+B,EAAE,IAAI,CAAC,CAAC,SAAS,EAAE,EAAE;QAC7E,OAAO,CAAC,CAAC,2CAAsB,CAAC,SAAS,CAAC,SAAS,CAAC,CAAC,OAAO,EAAE,UAAU,CAAC;IAC3E,CAAC,CAAC,CAAC;IACH,IAAI,gBAAgB,EAAE,CAAC;QACrB,MAAM,CAAC,UAAU,GAAG,IAAI,CAAC;IAC3B,CAAC;IAED,MAAM,cAAc,GAAG,2CAA2B,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;IACjE,IAAI,cAAc,EAAE,CAAC;QACnB,MAAM,CAAC,SAAS,GAAG,cAAc,CAAC;IACpC,CAAC;IAED,OAAO,MAAM,CAAC;AAChB,CAAC;AAED,gBAAgB;AAChB,gEAAgE;AACnD,QAAA,uCAAuC,GAAG,uBAAuB,CAAC;AAE/E,gBAAgB;AAChB,gEAAgE;AACnD,QAAA,gCAAgC,GAAG,gBAAgB,CAAC;AAEjE,gBAAgB;AAChB,gEAAgE;AACnD,QAAA,qCAAqC,GAAG,qBAAqB,CAAC;AAE3E,gBAAgB;AAChB,gEAAgE;AACnD,QAAA,yCAAyC,GAAG,yBAAyB,CAAC;AAEnF,gBAAgB;AAChB,SAAgB,wBAAwB,CACtC,GAAiC,EACjC,eAAkD,EAClD,uBAAgC;IAEhC,IAAI,eAAe,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QACjC,OAAO,GAAG,CAAC;IACb,CAAC;IACD,OAAO;QACL,GAAG,GAAG;QACN,KAAK,EAAE;YACL,GAAG,GAAG,CAAC,KAAK;YACZ,IAAI,EAAE;gBACJ,GAAG,CAAC,GAAG,CAAC,KAAK,CAAC,IAAI,IAAI,EAAE,CAAC;gBACzB,uIAAuI;gBACvI,iCAAiC;gBACjC;YACI,eAAe;qBACd,GAAG,CAAC,CAAC,EAAE,EAAE,EAAE,CACV,EAAE,CAAC,cAAc;oBACf,CAAC,CAAC,WAAW,EAAE,CAAC,EAAE,CAAC,EAAE,QAAQ,EAAE,CAAC,mBAAmB,CAAC,CAAC,CAAC,IAAI,IAAI,CAAC,SAAS,CAAC,EAAE,CAAC,mBAAmB,CAAC,GAAG,CAAC,CAAC,CAAC,oBAAoB,MAAM,IAAI,CAAC,SAAS,CAAC,EAAE,CAAC,uBAAuB,CAAC,IAAI;oBAC9K,CAAC,CAAC,WAAW,EAAE,CAAC,EAAE,CAAC,EAAE,6BAA6B,IAAI,CAAC,SAAS,CAAC,EAAE,CAAC,uBAAuB,CAAC,IAAI,CACnG;qBACA,IAAI,CAAC,aAAa,CAAC;UACtB;aACH;YACD,KAAK,EAAE;;;qCAGwB,wCAAgC;0CAC3B,6CAAqC;YACnE,uBAAuB,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,QAAQ,iDAAyC;4CACpD,+CAAuC;;YAEvE,GAAG,CAAC,KAAK,CAAC,KAAK;;UAEjB,uBAAuB,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE;OACzC;SACF;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 { ECClassHierarchyInspector, InstanceKey } from \"@itwin/presentation-shared\";\nimport { extractFilteringProps, HierarchyFilteringPath, HierarchyFilteringPathOptions } from \"../HierarchyFiltering\";\nimport { HierarchyNodeFilteringProps } from \"../HierarchyNode\";\nimport { HierarchyNodeIdentifier } from \"../HierarchyNodeIdentifier\";\nimport { GenericNodeKey } from \"../HierarchyNodeKey\";\nimport {\n  DefineHierarchyLevelProps,\n  GenericHierarchyNodeDefinition,\n  HierarchyDefinition,\n  HierarchyLevelDefinition,\n  HierarchyNodesDefinition,\n  InstanceNodesQueryDefinition,\n  NodeParser,\n  NodePostProcessor,\n  NodePreProcessor,\n} from \"./IModelHierarchyDefinition\";\nimport { ProcessedGroupingHierarchyNode, ProcessedHierarchyNode, SourceHierarchyNode, SourceInstanceHierarchyNode } from \"./IModelHierarchyNode\";\nimport { defaultNodesParser } from \"./TreeNodesReader\";\n\ninterface FilteringHierarchyDefinitionProps {\n  imodelAccess: ECClassHierarchyInspector & { imodelKey: string };\n  source: HierarchyDefinition;\n  nodeIdentifierPaths: HierarchyFilteringPath[];\n}\n\n/** @internal */\nexport class FilteringHierarchyDefinition implements HierarchyDefinition {\n  private _imodelAccess: ECClassHierarchyInspector & { imodelKey: string };\n  private _source: HierarchyDefinition;\n  private _nodeIdentifierPaths: HierarchyFilteringPath[];\n\n  public constructor(props: FilteringHierarchyDefinitionProps) {\n    this._imodelAccess = props.imodelAccess;\n    this._source = props.source;\n    this._nodeIdentifierPaths = props.nodeIdentifierPaths;\n  }\n\n  public get preProcessNode(): NodePreProcessor {\n    return async (node) => {\n      const processedNode = this._source.preProcessNode ? await this._source.preProcessNode(node) : node;\n      if (processedNode?.processingParams?.hideInHierarchy && processedNode.filtering?.isFilterTarget && !processedNode.filtering.hasFilterTargetAncestor) {\n        // we want to hide target nodes if they have `hideInHierarchy` param, but only if they're not under another filter target\n        return undefined;\n      }\n      return processedNode;\n    };\n  }\n\n  private shouldExpandGroupingNode(node: ProcessedGroupingHierarchyNode) {\n    for (const child of node.children) {\n      // istanbul ignore next\n      if (!child.filtering) {\n        continue;\n      }\n\n      if (child.filtering.isFilterTarget) {\n        const childAutoExpand = child.filtering.filterTargetOptions?.autoExpand;\n\n        // If child is a filter target and is has no `autoExpand` flag, then it's always to be expanded.\n        if (childAutoExpand === true) {\n          return true;\n        }\n\n        // If it's not an object and not `true`, then it's falsy - continue looking\n        if (typeof childAutoExpand !== \"object\") {\n          continue;\n        }\n\n        // If grouping node's child has `autoExpandUntil` flag,\n        // auto-expand the grouping node only if it's depth is lower than that of the grouping node in associated with the target.\n        const nodeDepth = node.parentKeys.length;\n        const filterTargetDepth = childAutoExpand.depth;\n        if (nodeDepth < filterTargetDepth) {\n          return true;\n        }\n      }\n\n      if (!child.filtering.filteredChildrenIdentifierPaths) {\n        // istanbul ignore next\n        continue;\n      }\n\n      for (const path of child.filtering.filteredChildrenIdentifierPaths) {\n        if (\"path\" in path && path.options?.autoExpand) {\n          return true;\n        }\n      }\n    }\n    return false;\n  }\n\n  public get postProcessNode(): NodePostProcessor {\n    return async (node: ProcessedHierarchyNode) => {\n      const processedNode = this._source.postProcessNode ? await this._source.postProcessNode(node) : node;\n      // instance nodes get the auto-expand flag in `parseNode`, but grouping ones need to be handled during post-processing\n      if (ProcessedHierarchyNode.isGroupingNode(node) && this.shouldExpandGroupingNode(node)) {\n        Object.assign(processedNode, { autoExpand: true });\n      }\n      return processedNode;\n    };\n  }\n\n  public get parseNode(): NodeParser {\n    return (row: { [columnName: string]: any }): SourceInstanceHierarchyNode => {\n      const hasFilterTargetAncestor: boolean = !!row[ECSQL_COLUMN_NAME_HasFilterTargetAncestor];\n      const isFilterTarget: boolean = !!row[ECSQL_COLUMN_NAME_IsFilterTarget];\n      const filterTargetOptions: HierarchyFilteringPathOptions | undefined = row[ECSQL_COLUMN_NAME_FilterTargetOptions]\n        ? JSON.parse(row[ECSQL_COLUMN_NAME_FilterTargetOptions])\n        : undefined;\n      const filteredChildrenIdentifierPaths: HierarchyFilteringPath[] | undefined = row[ECSQL_COLUMN_NAME_FilteredChildrenPaths]\n        ? JSON.parse(row[ECSQL_COLUMN_NAME_FilteredChildrenPaths])\n        : undefined;\n      const defaultNode = (this._source.parseNode ?? defaultNodesParser)(row);\n      return applyFilterAttributes({\n        node: defaultNode,\n        filteredChildrenIdentifierPaths,\n        isFilterTarget,\n        filterTargetOptions,\n        hasFilterTargetAncestor,\n      });\n    };\n  }\n\n  public async defineHierarchyLevel(props: DefineHierarchyLevelProps): Promise<HierarchyLevelDefinition> {\n    const sourceDefinitions = await this._source.defineHierarchyLevel(props);\n    const filteringProps = extractFilteringProps(this._nodeIdentifierPaths, props.parentNode);\n    if (!filteringProps) {\n      return sourceDefinitions;\n    }\n\n    const filteredDefinitions: HierarchyLevelDefinition = [];\n    await Promise.all(\n      sourceDefinitions.map(async (definition) => {\n        let matchedDefinition: HierarchyNodesDefinition | undefined;\n        if (HierarchyNodesDefinition.isGenericNode(definition)) {\n          matchedDefinition = await matchFilters<GenericNodeKey>(\n            definition,\n            filteringProps,\n            async (id) => {\n              return (\n                HierarchyNodeIdentifier.isGenericNodeIdentifier(id) &&\n                (!id.source || id.source === this._imodelAccess.imodelKey) &&\n                id.id === definition.node.key\n              );\n            },\n            this._imodelAccess,\n            (def, matchingFilters) => {\n              const filteredChildrenIdentifierPaths = matchingFilters.reduce(\n                (r, c) => [...r, ...c.childrenIdentifierPaths],\n                new Array<HierarchyFilteringPath>(),\n              );\n              return {\n                ...def,\n                node: applyFilterAttributes({\n                  node: def.node,\n                  filteredChildrenIdentifierPaths,\n                  isFilterTarget: matchingFilters.some((mc) => mc.isFilterTarget),\n                  hasFilterTargetAncestor: filteringProps.hasFilterTargetAncestor,\n                }),\n              };\n            },\n          );\n        } else {\n          matchedDefinition = await matchFilters<InstanceKey>(\n            definition,\n            filteringProps,\n            async (id) => {\n              return (\n                HierarchyNodeIdentifier.isInstanceNodeIdentifier(id) &&\n                (!id.imodelKey || id.imodelKey === this._imodelAccess.imodelKey) &&\n                (await this._imodelAccess.classDerivesFrom(id.className, definition.fullClassName))\n              );\n            },\n            this._imodelAccess,\n            (def, matchingFilters) => applyECInstanceIdsFilter(def, matchingFilters, !!filteringProps.hasFilterTargetAncestor),\n          );\n        }\n        if (matchedDefinition) {\n          filteredDefinitions.push(matchedDefinition);\n        }\n      }),\n    );\n    return filteredDefinitions;\n  }\n}\n\ntype MatchedFilter<TIdentifier extends HierarchyNodeIdentifier> = {\n  id: TIdentifier;\n  childrenIdentifierPaths: HierarchyFilteringPath[];\n} & ({ isFilterTarget: false } | { isFilterTarget: true; filterTargetOptions?: HierarchyFilteringPathOptions });\n\nasync function matchFilters<\n  TIdentifier extends HierarchyNodeIdentifier,\n  TDefinition = TIdentifier extends InstanceKey ? InstanceNodesQueryDefinition : GenericHierarchyNodeDefinition,\n>(\n  definition: TDefinition,\n  filteringProps: { filteredNodePaths: HierarchyFilteringPath[]; hasFilterTargetAncestor?: boolean },\n  predicate: (id: HierarchyNodeIdentifier) => Promise<boolean>,\n  classHierarchy: ECClassHierarchyInspector,\n  matchedDefinitionProcessor: (def: TDefinition, matchingFilters: Array<MatchedFilter<TIdentifier>>) => TDefinition,\n): Promise<TDefinition | undefined> {\n  const { filteredNodePaths, hasFilterTargetAncestor } = filteringProps;\n  const matchingFilters: Array<MatchedFilter<TIdentifier>> = [];\n  for (const filteredNodePath of filteredNodePaths) {\n    const { path, options } = HierarchyFilteringPath.normalize(filteredNodePath);\n    if (path.length === 0) {\n      continue;\n    }\n    const nodeId = path[0];\n    if (await predicate(nodeId)) {\n      let entry = await findMatchingFilterEntry(matchingFilters, nodeId, classHierarchy);\n      if (!entry) {\n        entry = {\n          // ideally, `predicate` would act as a type guard to guarantee that `id` is `TIdentifier`, but at the moment\n          // async type guards aren't supported\n          id: nodeId as TIdentifier,\n          childrenIdentifierPaths: [],\n          isFilterTarget: false,\n        };\n        matchingFilters.push(entry);\n      }\n      const remainingPath = path.slice(1);\n      if (remainingPath.length > 0) {\n        entry.childrenIdentifierPaths.push(options ? { path: remainingPath, options } : remainingPath);\n      } else if (entry.isFilterTarget) {\n        entry.filterTargetOptions = HierarchyFilteringPath.mergeOptions(entry.filterTargetOptions, options);\n      } else {\n        Object.assign(entry, { isFilterTarget: true, filterTargetOptions: options });\n      }\n    }\n  }\n  if (hasFilterTargetAncestor || matchingFilters.length > 0) {\n    return matchedDefinitionProcessor(definition, matchingFilters);\n  }\n  return undefined;\n}\n\nasync function findMatchingFilterEntry<TEntry extends { id: TIdentifier }, TIdentifier extends HierarchyNodeIdentifier>(\n  filters: TEntry[],\n  nodeId: TIdentifier,\n  classHierarchy: ECClassHierarchyInspector,\n): Promise<TEntry | undefined> {\n  for (const filter of filters) {\n    if (await identifiersEqual(filter.id, nodeId, classHierarchy)) {\n      return filter;\n    }\n  }\n  return undefined;\n}\n\nasync function identifiersEqual<TIdentifier extends HierarchyNodeIdentifier>(lhs: TIdentifier, rhs: TIdentifier, classHierarchy: ECClassHierarchyInspector) {\n  if (HierarchyNodeIdentifier.isInstanceNodeIdentifier(lhs) && HierarchyNodeIdentifier.isInstanceNodeIdentifier(rhs)) {\n    return (\n      lhs.id === rhs.id &&\n      (lhs.className === rhs.className ||\n        (await classHierarchy.classDerivesFrom(lhs.className, rhs.className)) ||\n        (await classHierarchy.classDerivesFrom(rhs.className, lhs.className)))\n    );\n  }\n  return HierarchyNodeIdentifier.equal(lhs, rhs);\n}\n\nfunction applyFilterAttributes<TNode extends SourceHierarchyNode>(props: {\n  node: TNode;\n  filteredChildrenIdentifierPaths: HierarchyFilteringPath[] | undefined;\n  isFilterTarget?: boolean;\n  filterTargetOptions?: HierarchyFilteringPathOptions;\n  hasFilterTargetAncestor: boolean;\n}): TNode {\n  const { node, filteredChildrenIdentifierPaths } = props;\n  const result = { ...node };\n\n  const shouldAutoExpand = !!filteredChildrenIdentifierPaths?.some((childPath) => {\n    return !!HierarchyFilteringPath.normalize(childPath).options?.autoExpand;\n  });\n  if (shouldAutoExpand) {\n    result.autoExpand = true;\n  }\n\n  const filteringProps = HierarchyNodeFilteringProps.create(props);\n  if (filteringProps) {\n    result.filtering = filteringProps;\n  }\n\n  return result;\n}\n\n/** @internal */\n// eslint-disable-next-line @typescript-eslint/naming-convention\nexport const ECSQL_COLUMN_NAME_FilteredChildrenPaths = \"FilteredChildrenPaths\";\n\n/** @internal */\n// eslint-disable-next-line @typescript-eslint/naming-convention\nexport const ECSQL_COLUMN_NAME_IsFilterTarget = \"IsFilterTarget\";\n\n/** @internal */\n// eslint-disable-next-line @typescript-eslint/naming-convention\nexport const ECSQL_COLUMN_NAME_FilterTargetOptions = \"FilterTargetOptions\";\n\n/** @internal */\n// eslint-disable-next-line @typescript-eslint/naming-convention\nexport const ECSQL_COLUMN_NAME_HasFilterTargetAncestor = \"HasFilterTargetAncestor\";\n\n/** @internal */\nexport function applyECInstanceIdsFilter(\n  def: InstanceNodesQueryDefinition,\n  matchingFilters: Array<MatchedFilter<InstanceKey>>,\n  hasFilterTargetAncestor: boolean,\n): InstanceNodesQueryDefinition {\n  if (matchingFilters.length === 0) {\n    return def;\n  }\n  return {\n    ...def,\n    query: {\n      ...def.query,\n      ctes: [\n        ...(def.query.ctes ?? []),\n        // note: generally we'd use `VALUES (1,1),(2,2)`, but that doesn't work in ECSQL (https://github.com/iTwin/itwinjs-backlog/issues/865),\n        // so using UNION as a workaround\n        `FilteringInfo(ECInstanceId, IsFilterTarget, FilterTargetOptions, FilteredChildrenPaths) AS (\n          ${matchingFilters\n            .map((mc) =>\n              mc.isFilterTarget\n                ? `VALUES (${mc.id.id}, 1, ${mc.filterTargetOptions ? `'${JSON.stringify(mc.filterTargetOptions)}'` : \"CAST(NULL AS TEXT)\"}, '${JSON.stringify(mc.childrenIdentifierPaths)}')`\n                : `VALUES (${mc.id.id}, 0, CAST(NULL AS TEXT), '${JSON.stringify(mc.childrenIdentifierPaths)}')`,\n            )\n            .join(\" UNION ALL \")}\n        )`,\n      ],\n      ecsql: `\n        SELECT\n          [q].*,\n          [f].[IsFilterTarget] AS [${ECSQL_COLUMN_NAME_IsFilterTarget}],\n          [f].[FilterTargetOptions] AS [${ECSQL_COLUMN_NAME_FilterTargetOptions}],\n          ${hasFilterTargetAncestor ? \"1\" : \"0\"} AS [${ECSQL_COLUMN_NAME_HasFilterTargetAncestor}],\n          [f].[FilteredChildrenPaths] AS [${ECSQL_COLUMN_NAME_FilteredChildrenPaths}]\n        FROM (\n          ${def.query.ecsql}\n        ) [q]\n        ${hasFilterTargetAncestor ? \"LEFT \" : \"\"} JOIN FilteringInfo [f] ON [f].[ECInstanceId] = [q].[ECInstanceId]\n      `,\n    },\n  };\n}\n"]}

package/lib/cjs/hierarchies/imodel/HierarchyCache.d.ts

@@ -0,0 +1,18 @@
+import { GetHierarchyNodesProps } from "../HierarchyProvider";
+interface ChildNodeObservablesCacheProps {
+    size: number;
+    variationsCount?: number;
+}
+/** @internal */
+export declare class HierarchyCache<T> {
+    private _map;
+    private _props;
+    constructor(props: ChildNodeObservablesCacheProps);
+    private createCacheKeys;
+    private getCacheAccessors;
+    set(requestProps: GetHierarchyNodesProps, value: T): void;
+    get(requestProps: GetHierarchyNodesProps): T | undefined;
+    clear(): void;
+}
+export {};
+//# sourceMappingURL=HierarchyCache.d.ts.map

package/lib/cjs/hierarchies/imodel/HierarchyCache.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"HierarchyCache.d.ts","sourceRoot":"","sources":["../../../../src/hierarchies/imodel/HierarchyCache.ts"],"names":[],"mappings":"AAQA,OAAO,EAAE,sBAAsB,EAAE,MAAM,sBAAsB,CAAC;AAS9D,UAAU,8BAA8B;IACtC,IAAI,EAAE,MAAM,CAAC;IACb,eAAe,CAAC,EAAE,MAAM,CAAC;CAC1B;AAED,gBAAgB;AAChB,qBAAa,cAAc,CAAC,CAAC;IAC3B,OAAO,CAAC,IAAI,CAA4D;IACxE,OAAO,CAAC,MAAM,CAAiC;gBAE5B,KAAK,EAAE,8BAA8B;IAKxD,OAAO,CAAC,eAAe;IA0BvB,OAAO,CAAC,iBAAiB;IAyBlB,GAAG,CAAC,YAAY,EAAE,sBAAsB,EAAE,KAAK,EAAE,CAAC;IAKlD,GAAG,CAAC,YAAY,EAAE,sBAAsB,GAAG,CAAC,GAAG,SAAS;IAKxD,KAAK;CAGb"}

package/lib/cjs/hierarchies/{internal/ChildNodeObservablesCache.js → imodel/HierarchyCache.js}

@@ -4,11 +4,11 @@
  * See LICENSE.md in the project root for license terms and full copyright notice.
  *--------------------------------------------------------------------------------------------*/
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ChildNodeObservablesCache = void 0;
+exports.HierarchyCache = void 0;
 const core_bentley_1 = require("@itwin/core-bentley");
 const HierarchyNodeKey_1 = require("../HierarchyNodeKey");
 /** @internal */
-class ChildNodeObservablesCache {
+class HierarchyCache {
     _map;
     _props;
     constructor(props) {
@@ -68,7 +68,7 @@ class ChildNodeObservablesCache {
         this._map.clear();
     }
 }
-exports.ChildNodeObservablesCache = ChildNodeObservablesCache;
+exports.HierarchyCache = HierarchyCache;
 function compareHierarchyNodeKeys(lhs, rhs) {
     if (lhs.length !== rhs.length) {
         return lhs.length - rhs.length;
@@ -81,4 +81,4 @@ function compareHierarchyNodeKeys(lhs, rhs) {
     }
     return 0;
 }
-//# sourceMappingURL=ChildNodeObservablesCache.js.map
+//# sourceMappingURL=HierarchyCache.js.map

package/lib/cjs/hierarchies/imodel/HierarchyCache.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"HierarchyCache.js","sourceRoot":"","sources":["../../../../src/hierarchies/imodel/HierarchyCache.ts"],"names":[],"mappings":";AAAA;;;gGAGgG;;;AAEhG,sDAAsE;AAEtE,0DAAuD;AAevD,gBAAgB;AAChB,MAAa,cAAc;IACjB,IAAI,CAA4D;IAChE,MAAM,CAAiC;IAE/C,YAAmB,KAAqC;QACtD,IAAI,CAAC,MAAM,GAAG,KAAK,CAAC;QACpB,IAAI,CAAC,IAAI,GAAG,IAAI,4BAAa,CAA6C,KAAK,CAAC,IAAI,EAAE,wBAAwB,CAAC,CAAC;IAClH,CAAC;IAEO,eAAe,CACrB,KAGC;QAED,SAAS,kBAAkB;YACzB,MAAM,EAAE,cAAc,EAAE,uBAAuB,EAAE,oBAAoB,EAAE,GAAG,KAAK,CAAC;YAChF,IAAI,cAAc,KAAK,SAAS,IAAI,uBAAuB,KAAK,SAAS,IAAI,oBAAoB,KAAK,SAAS,EAAE,CAAC;gBAChH,OAAO,SAAS,CAAC;YACnB,CAAC;YACD,OAAO,IAAI,CAAC,SAAS,CAAC,EAAE,cAAc,EAAE,uBAAuB,EAAE,oBAAoB,EAAE,CAAC,CAAC;QAC3F,CAAC;QAED,IAAI,CAAC,KAAK,CAAC,UAAU,EAAE,CAAC;YACtB,OAAO,EAAE,UAAU,EAAE,EAAE,EAAE,YAAY,EAAE,kBAAkB,EAAE,EAAE,CAAC;QAChE,CAAC;QAED,MAAM,UAAU,GAAG,KAAK,CAAC,UAAU,CAAC,UAAU,CAAC;QAE/C,OAAO;YACL,UAAU,EAAE,CAAC,GAAG,UAAU,EAAE,KAAK,CAAC,UAAU,CAAC,GAAG,CAAC;YACjD,YAAY,EAAE,kBAAkB,EAAE;SACnC,CAAC;IACJ,CAAC;IAEO,iBAAiB,CAAC,UAA8B,EAAE,YAAqB;QAC7E,MAAM,WAAW,GAAG,CAAC,MAAe,EAAE,EAAE;YACtC,IAAI,KAAK,GAAG,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC;YACtC,IAAI,CAAC,KAAK,IAAI,MAAM,EAAE,CAAC;gBACrB,KAAK,GAAG,EAAE,OAAO,EAAE,SAAS,EAAE,UAAU,EAAE,IAAI,qBAAM,CAAC,IAAI,CAAC,MAAM,CAAC,eAAe,IAAI,CAAC,CAAC,EAAE,CAAC;gBACzF,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,UAAU,EAAE,KAAK,CAAC,CAAC;YACnC,CAAC;YACD,OAAO,KAAK,CAAC;QACf,CAAC,CAAC;QACF,IAAI,YAAY,EAAE,CAAC;YACjB,OAAO;gBACL,GAAG,EAAE,GAAG,EAAE,CAAC,WAAW,CAAC,KAAK,CAAC,EAAE,UAAU,CAAC,GAAG,CAAC,YAAY,CAAC;gBAC3D,GAAG,EAAE,CAAC,KAAQ,EAAE,EAAE;oBAChB,WAAW,CAAC,IAAI,CAAE,CAAC,UAAU,CAAC,GAAG,CAAC,YAAY,EAAE,KAAK,CAAC,CAAC;gBACzD,CAAC;aACF,CAAC;QACJ,CAAC;QACD,OAAO;YACL,GAAG,EAAE,GAAG,EAAE,CAAC,WAAW,CAAC,KAAK,CAAC,EAAE,OAAO;YACtC,GAAG,EAAE,CAAC,KAAQ,EAAE,EAAE;gBAChB,WAAW,CAAC,IAAI,CAAE,CAAC,OAAO,GAAG,KAAK,CAAC;YACrC,CAAC;SACF,CAAC;IACJ,CAAC;IAEM,GAAG,CAAC,YAAoC,EAAE,KAAQ;QACvD,MAAM,EAAE,UAAU,EAAE,YAAY,EAAE,GAAG,IAAI,CAAC,eAAe,CAAC,YAAY,CAAC,CAAC;QACxE,IAAI,CAAC,iBAAiB,CAAC,UAAU,EAAE,YAAY,CAAC,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;IAC9D,CAAC;IAEM,GAAG,CAAC,YAAoC;QAC7C,MAAM,EAAE,UAAU,EAAE,YAAY,EAAE,GAAG,IAAI,CAAC,eAAe,CAAC,YAAY,CAAC,CAAC;QACxE,OAAO,IAAI,CAAC,iBAAiB,CAAC,UAAU,EAAE,YAAY,CAAC,CAAC,GAAG,EAAE,CAAC;IAChE,CAAC;IAEM,KAAK;QACV,IAAI,CAAC,IAAI,CAAC,KAAK,EAAE,CAAC;IACpB,CAAC;CACF;AAzED,wCAyEC;AAED,SAAS,wBAAwB,CAAC,GAAuB,EAAE,GAAuB;IAChF,IAAI,GAAG,CAAC,MAAM,KAAK,GAAG,CAAC,MAAM,EAAE,CAAC;QAC9B,OAAO,GAAG,CAAC,MAAM,GAAG,GAAG,CAAC,MAAM,CAAC;IACjC,CAAC;IACD,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,GAAG,CAAC,MAAM,EAAE,EAAE,CAAC,EAAE,CAAC;QACpC,MAAM,iBAAiB,GAAG,mCAAgB,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC;QACnE,IAAI,iBAAiB,KAAK,CAAC,EAAE,CAAC;YAC5B,OAAO,iBAAiB,CAAC;QAC3B,CAAC;IACH,CAAC;IACD,OAAO,CAAC,CAAC;AACX,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 { LRUCache, LRUDictionary, LRUMap } from \"@itwin/core-bentley\";\nimport { InstanceKey } from \"@itwin/presentation-shared\";\nimport { HierarchyNodeKey } from \"../HierarchyNodeKey\";\nimport { GetHierarchyNodesProps } from \"../HierarchyProvider\";\n\ninterface HierarchyCacheEntry<T> {\n  /** Stores observables for the default case - no instance filter or custom limit for the hierarchy level. */\n  primary: T | undefined;\n  /** Stores a limited number of variations with custom instance filter and/or custom limit for the hierarchy level. */\n  variations: LRUCache<string, T>;\n}\n\ninterface ChildNodeObservablesCacheProps {\n  size: number;\n  variationsCount?: number;\n}\n\n/** @internal */\nexport class HierarchyCache<T> {\n  private _map: LRUDictionary<HierarchyNodeKey[], HierarchyCacheEntry<T>>;\n  private _props: ChildNodeObservablesCacheProps;\n\n  public constructor(props: ChildNodeObservablesCacheProps) {\n    this._props = props;\n    this._map = new LRUDictionary<HierarchyNodeKey[], HierarchyCacheEntry<T>>(props.size, compareHierarchyNodeKeys);\n  }\n\n  private createCacheKeys(\n    props: Omit<GetHierarchyNodesProps, \"parentNode\"> & {\n      parentNode: { key: HierarchyNodeKey; parentKeys: HierarchyNodeKey[] } | undefined;\n      filteredInstanceKeys?: InstanceKey[];\n    },\n  ) {\n    function createVariationKey() {\n      const { instanceFilter, hierarchyLevelSizeLimit, filteredInstanceKeys } = props;\n      if (instanceFilter === undefined && hierarchyLevelSizeLimit === undefined && filteredInstanceKeys === undefined) {\n        return undefined;\n      }\n      return JSON.stringify({ instanceFilter, hierarchyLevelSizeLimit, filteredInstanceKeys });\n    }\n\n    if (!props.parentNode) {\n      return { primaryKey: [], variationKey: createVariationKey() };\n    }\n\n    const parentKeys = props.parentNode.parentKeys;\n\n    return {\n      primaryKey: [...parentKeys, props.parentNode.key],\n      variationKey: createVariationKey(),\n    };\n  }\n\n  private getCacheAccessors(primaryKey: HierarchyNodeKey[], variationKey?: string) {\n    const getMapEntry = (create: boolean) => {\n      let entry = this._map.get(primaryKey);\n      if (!entry && create) {\n        entry = { primary: undefined, variations: new LRUMap(this._props.variationsCount ?? 1) };\n        this._map.set(primaryKey, entry);\n      }\n      return entry;\n    };\n    if (variationKey) {\n      return {\n        get: () => getMapEntry(false)?.variations.get(variationKey),\n        set: (value: T) => {\n          getMapEntry(true)!.variations.set(variationKey, value);\n        },\n      };\n    }\n    return {\n      get: () => getMapEntry(false)?.primary,\n      set: (value: T) => {\n        getMapEntry(true)!.primary = value;\n      },\n    };\n  }\n\n  public set(requestProps: GetHierarchyNodesProps, value: T) {\n    const { primaryKey, variationKey } = this.createCacheKeys(requestProps);\n    this.getCacheAccessors(primaryKey, variationKey).set(value);\n  }\n\n  public get(requestProps: GetHierarchyNodesProps): T | undefined {\n    const { primaryKey, variationKey } = this.createCacheKeys(requestProps);\n    return this.getCacheAccessors(primaryKey, variationKey).get();\n  }\n\n  public clear() {\n    this._map.clear();\n  }\n}\n\nfunction compareHierarchyNodeKeys(lhs: HierarchyNodeKey[], rhs: HierarchyNodeKey[]) {\n  if (lhs.length !== rhs.length) {\n    return lhs.length - rhs.length;\n  }\n  for (let i = 0; i < lhs.length; ++i) {\n    const keysCompareResult = HierarchyNodeKey.compare(lhs[i], rhs[i]);\n    if (keysCompareResult !== 0) {\n      return keysCompareResult;\n    }\n  }\n  return 0;\n}\n"]}

package/lib/cjs/hierarchies/imodel/IModelHierarchyDefinition.d.ts

@@ -0,0 +1,121 @@
+import { GenericInstanceFilter } from "@itwin/core-common";
+import { ECSqlQueryDef } from "@itwin/presentation-shared";
+import { NonGroupingHierarchyNode } from "../HierarchyNode";
+import { ProcessedGenericHierarchyNode, ProcessedHierarchyNode, ProcessedInstanceHierarchyNode, SourceGenericHierarchyNode, SourceInstanceHierarchyNode } from "./IModelHierarchyNode";
+/**
+ * A nodes definition that returns a single generic node.
+ * @beta
+ */
+export interface GenericHierarchyNodeDefinition {
+    /** The node to be created in the hierarchy level */
+    node: SourceGenericHierarchyNode;
+}
+/**
+ * A nodes definition that returns an ECSQL query for selecting nodes from an iModel.
+ * @beta
+ */
+export interface InstanceNodesQueryDefinition {
+    /**
+     * Full name of the class whose instances are going to be returned. It's okay if the attribute
+     * points to a base class of multiple different classes of instances returned by the query, however
+     * the more specific this class is, the more efficient hierarchy building process is.
+     */
+    fullClassName: string;
+    /**
+     * An ECSQL query that selects nodes from an iModel. `SELECT` clause of the query is expected
+     * to be built using `NodeSelectQueryFactory.createSelectClause`.
+     */
+    query: ECSqlQueryDef;
+}
+/**
+ * A definition of nodes included in a hierarchy level.
+ * @beta
+ */
+export type HierarchyNodesDefinition = GenericHierarchyNodeDefinition | InstanceNodesQueryDefinition;
+/** @beta */
+export declare namespace HierarchyNodesDefinition {
+    function isGenericNode(def: HierarchyNodesDefinition): def is GenericHierarchyNodeDefinition;
+    function isInstanceNodesQuery(def: HierarchyNodesDefinition): def is InstanceNodesQueryDefinition;
+}
+/**
+ * A definition of a hierarchy level, which may consist of multiple node definitions.
+ * @beta
+ */
+export type HierarchyLevelDefinition = HierarchyNodesDefinition[];
+/**
+ * A type for a function that parses a `SourceInstanceHierarchyNode` from provided ECSQL `row` object.
+ * @beta
+ */
+export type NodeParser = (row: {
+    [columnName: string]: any;
+}) => SourceInstanceHierarchyNode;
+/**
+ * A type for a function that pre-processes given node. Unless the function decides not to make any modifications,
+ * it should return a new - modified - node, rather than modifying the given one. Returning `undefined` omits the node
+ * from the hierarchy.
+ *
+ * @beta
+ */
+export type NodePreProcessor = <TNode extends ProcessedGenericHierarchyNode | ProcessedInstanceHierarchyNode>(node: TNode) => Promise<TNode | undefined>;
+/**
+ * A type for a function that post-processes given node. Unless the function decides not to make any modifications,
+ * it should return a new - modified - node, rather than modifying the given one.
+ *
+ * @beta
+ */
+export type NodePostProcessor = (node: ProcessedHierarchyNode) => Promise<ProcessedHierarchyNode>;
+/**
+ * A type of node that can be passed to `HierarchyDefinition.defineHierarchyLevel`. This basically means
+ * a `HierarchyNode` that:
+ * - knows nothing about its children,
+ * - is either an instances node (key is of `InstancesNodeKey` type) or a generic node (key is of `GenericNodeKey` type).
+ * @beta
+ */
+export type HierarchyDefinitionParentNode = Omit<NonGroupingHierarchyNode, "children">;
+/**
+ * Props for `HierarchyDefinition.defineHierarchyLevel`.
+ * @beta
+ */
+export interface DefineHierarchyLevelProps {
+    /** Parent node to get children for. Pass `undefined` to get root nodes. */
+    parentNode: HierarchyDefinitionParentNode | undefined;
+    /** Optional hierarchy level filter. */
+    instanceFilter?: GenericInstanceFilter;
+}
+/**
+ * An interface for a factory that knows how define a hierarchy based on a given parent node.
+ * @beta
+ */
+export interface HierarchyDefinition {
+    /**
+     * An optional function for parsing ECInstance node from ECSQL row.
+     *
+     * Should be used in situations when the `HierarchyDefinition` implementation
+     * introduces additional ECSQL columns into the select clause and wants to assign additional
+     * data to the nodes it produces.
+     *
+     * Defaults to a function that parses all `HierarchyNode` attributes from a query, whose SELECT
+     * clause is created using `NodeSelectQueryFactory.createSelectClause`.
+     */
+    parseNode?: NodeParser;
+    /**
+     * An optional function for pre-processing nodes.
+     *
+     * Pre-processing happens immediately after the nodes are loaded based on `HierarchyLevelDefinition`
+     * returned by this `HierarchyDefinition` and before their processing (hiding, grouping, sorting, etc.) starts.
+     * The step allows assigning nodes additional data or excluding them from the hierarchy based on some attributes.
+     */
+    preProcessNode?: NodePreProcessor;
+    /**
+     * An optional function for post-processing nodes.
+     *
+     * Post-processing happens after the loaded nodes go through all the merging, hiding and grouping
+     * steps, but before sorting them. This step allows `HierarchyDefinition` implementations to assign additional data
+     * to nodes after they're processed. This is especially true for grouping nodes as they're only created during
+     * processing.
+     */
+    postProcessNode?: NodePostProcessor;
+    /** A function to create a hierarchy level definition for given parent node. */
+    defineHierarchyLevel(props: DefineHierarchyLevelProps): Promise<HierarchyLevelDefinition>;
+}
+//# sourceMappingURL=IModelHierarchyDefinition.d.ts.map

package/lib/cjs/hierarchies/imodel/IModelHierarchyDefinition.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"IModelHierarchyDefinition.d.ts","sourceRoot":"","sources":["../../../../src/hierarchies/imodel/IModelHierarchyDefinition.ts"],"names":[],"mappings":"AAKA,OAAO,EAAE,qBAAqB,EAAE,MAAM,oBAAoB,CAAC;AAC3D,OAAO,EAAE,aAAa,EAAE,MAAM,4BAA4B,CAAC;AAC3D,OAAO,EAAE,wBAAwB,EAAE,MAAM,kBAAkB,CAAC;AAC5D,OAAO,EACL,6BAA6B,EAC7B,sBAAsB,EACtB,8BAA8B,EAC9B,0BAA0B,EAC1B,2BAA2B,EAC5B,MAAM,uBAAuB,CAAC;AAE/B;;;GAGG;AACH,MAAM,WAAW,8BAA8B;IAC7C,oDAAoD;IACpD,IAAI,EAAE,0BAA0B,CAAC;CAClC;AAED;;;GAGG;AACH,MAAM,WAAW,4BAA4B;IAC3C;;;;OAIG;IACH,aAAa,EAAE,MAAM,CAAC;IACtB;;;OAGG;IACH,KAAK,EAAE,aAAa,CAAC;CACtB;AAED;;;GAGG;AACH,MAAM,MAAM,wBAAwB,GAAG,8BAA8B,GAAG,4BAA4B,CAAC;AACrG,YAAY;AAEZ,yBAAiB,wBAAwB,CAAC;IACxC,SAAgB,aAAa,CAAC,GAAG,EAAE,wBAAwB,GAAG,GAAG,IAAI,8BAA8B,CAElG;IACD,SAAgB,oBAAoB,CAAC,GAAG,EAAE,wBAAwB,GAAG,GAAG,IAAI,4BAA4B,CAEvG;CACF;AAED;;;GAGG;AACH,MAAM,MAAM,wBAAwB,GAAG,wBAAwB,EAAE,CAAC;AAElE;;;GAGG;AACH,MAAM,MAAM,UAAU,GAAG,CAAC,GAAG,EAAE;IAAE,CAAC,UAAU,EAAE,MAAM,GAAG,GAAG,CAAA;CAAE,KAAK,2BAA2B,CAAC;AAE7F;;;;;;GAMG;AACH,MAAM,MAAM,gBAAgB,GAAG,CAAC,KAAK,SAAS,6BAA6B,GAAG,8BAA8B,EAAE,IAAI,EAAE,KAAK,KAAK,OAAO,CAAC,KAAK,GAAG,SAAS,CAAC,CAAC;AAEzJ;;;;;GAKG;AACH,MAAM,MAAM,iBAAiB,GAAG,CAAC,IAAI,EAAE,sBAAsB,KAAK,OAAO,CAAC,sBAAsB,CAAC,CAAC;AAElG;;;;;;GAMG;AACH,MAAM,MAAM,6BAA6B,GAAG,IAAI,CAAC,wBAAwB,EAAE,UAAU,CAAC,CAAC;AAEvF;;;GAGG;AACH,MAAM,WAAW,yBAAyB;IACxC,2EAA2E;IAC3E,UAAU,EAAE,6BAA6B,GAAG,SAAS,CAAC;IAEtD,uCAAuC;IACvC,cAAc,CAAC,EAAE,qBAAqB,CAAC;CACxC;AAED;;;GAGG;AACH,MAAM,WAAW,mBAAmB;IAClC;;;;;;;;;OASG;IACH,SAAS,CAAC,EAAE,UAAU,CAAC;IAEvB;;;;;;OAMG;IACH,cAAc,CAAC,EAAE,gBAAgB,CAAC;IAElC;;;;;;;OAOG;IACH,eAAe,CAAC,EAAE,iBAAiB,CAAC;IAEpC,+EAA+E;IAC/E,oBAAoB,CAAC,KAAK,EAAE,yBAAyB,GAAG,OAAO,CAAC,wBAAwB,CAAC,CAAC;CAC3F"}

package/lib/cjs/hierarchies/imodel/IModelHierarchyDefinition.js

@@ -0,0 +1,21 @@
+"use strict";
+/*---------------------------------------------------------------------------------------------
+ * Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+ * See LICENSE.md in the project root for license terms and full copyright notice.
+ *--------------------------------------------------------------------------------------------*/
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.HierarchyNodesDefinition = void 0;
+/** @beta */
+// eslint-disable-next-line @typescript-eslint/no-redeclare
+var HierarchyNodesDefinition;
+(function (HierarchyNodesDefinition) {
+    function isGenericNode(def) {
+        return !!def.node;
+    }
+    HierarchyNodesDefinition.isGenericNode = isGenericNode;
+    function isInstanceNodesQuery(def) {
+        return !!def.query;
+    }
+    HierarchyNodesDefinition.isInstanceNodesQuery = isInstanceNodesQuery;
+})(HierarchyNodesDefinition || (exports.HierarchyNodesDefinition = HierarchyNodesDefinition = {}));
+//# sourceMappingURL=IModelHierarchyDefinition.js.map

package/lib/cjs/hierarchies/imodel/IModelHierarchyDefinition.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"IModelHierarchyDefinition.js","sourceRoot":"","sources":["../../../../src/hierarchies/imodel/IModelHierarchyDefinition.ts"],"names":[],"mappings":";AAAA;;;gGAGgG;;;AA6ChG,YAAY;AACZ,2DAA2D;AAC3D,IAAiB,wBAAwB,CAOxC;AAPD,WAAiB,wBAAwB;IACvC,SAAgB,aAAa,CAAC,GAA6B;QACzD,OAAO,CAAC,CAAE,GAAsC,CAAC,IAAI,CAAC;IACxD,CAAC;IAFe,sCAAa,gBAE5B,CAAA;IACD,SAAgB,oBAAoB,CAAC,GAA6B;QAChE,OAAO,CAAC,CAAE,GAAoC,CAAC,KAAK,CAAC;IACvD,CAAC;IAFe,6CAAoB,uBAEnC,CAAA;AACH,CAAC,EAPgB,wBAAwB,wCAAxB,wBAAwB,QAOxC","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 { GenericInstanceFilter } from \"@itwin/core-common\";\nimport { ECSqlQueryDef } from \"@itwin/presentation-shared\";\nimport { NonGroupingHierarchyNode } from \"../HierarchyNode\";\nimport {\n  ProcessedGenericHierarchyNode,\n  ProcessedHierarchyNode,\n  ProcessedInstanceHierarchyNode,\n  SourceGenericHierarchyNode,\n  SourceInstanceHierarchyNode,\n} from \"./IModelHierarchyNode\";\n\n/**\n * A nodes definition that returns a single generic node.\n * @beta\n */\nexport interface GenericHierarchyNodeDefinition {\n  /** The node to be created in the hierarchy level */\n  node: SourceGenericHierarchyNode;\n}\n\n/**\n * A nodes definition that returns an ECSQL query for selecting nodes from an iModel.\n * @beta\n */\nexport interface InstanceNodesQueryDefinition {\n  /**\n   * Full name of the class whose instances are going to be returned. It's okay if the attribute\n   * points to a base class of multiple different classes of instances returned by the query, however\n   * the more specific this class is, the more efficient hierarchy building process is.\n   */\n  fullClassName: string;\n  /**\n   * An ECSQL query that selects nodes from an iModel. `SELECT` clause of the query is expected\n   * to be built using `NodeSelectQueryFactory.createSelectClause`.\n   */\n  query: ECSqlQueryDef;\n}\n\n/**\n * A definition of nodes included in a hierarchy level.\n * @beta\n */\nexport type HierarchyNodesDefinition = GenericHierarchyNodeDefinition | InstanceNodesQueryDefinition;\n/** @beta */\n// eslint-disable-next-line @typescript-eslint/no-redeclare\nexport namespace HierarchyNodesDefinition {\n  export function isGenericNode(def: HierarchyNodesDefinition): def is GenericHierarchyNodeDefinition {\n    return !!(def as GenericHierarchyNodeDefinition).node;\n  }\n  export function isInstanceNodesQuery(def: HierarchyNodesDefinition): def is InstanceNodesQueryDefinition {\n    return !!(def as InstanceNodesQueryDefinition).query;\n  }\n}\n\n/**\n * A definition of a hierarchy level, which may consist of multiple node definitions.\n * @beta\n */\nexport type HierarchyLevelDefinition = HierarchyNodesDefinition[];\n\n/**\n * A type for a function that parses a `SourceInstanceHierarchyNode` from provided ECSQL `row` object.\n * @beta\n */\nexport type NodeParser = (row: { [columnName: string]: any }) => SourceInstanceHierarchyNode;\n\n/**\n * A type for a function that pre-processes given node. Unless the function decides not to make any modifications,\n * it should return a new - modified - node, rather than modifying the given one. Returning `undefined` omits the node\n * from the hierarchy.\n *\n * @beta\n */\nexport type NodePreProcessor = <TNode extends ProcessedGenericHierarchyNode | ProcessedInstanceHierarchyNode>(node: TNode) => Promise<TNode | undefined>;\n\n/**\n * A type for a function that post-processes given node. Unless the function decides not to make any modifications,\n * it should return a new - modified - node, rather than modifying the given one.\n *\n * @beta\n */\nexport type NodePostProcessor = (node: ProcessedHierarchyNode) => Promise<ProcessedHierarchyNode>;\n\n/**\n * A type of node that can be passed to `HierarchyDefinition.defineHierarchyLevel`. This basically means\n * a `HierarchyNode` that:\n * - knows nothing about its children,\n * - is either an instances node (key is of `InstancesNodeKey` type) or a generic node (key is of `GenericNodeKey` type).\n * @beta\n */\nexport type HierarchyDefinitionParentNode = Omit<NonGroupingHierarchyNode, \"children\">;\n\n/**\n * Props for `HierarchyDefinition.defineHierarchyLevel`.\n * @beta\n */\nexport interface DefineHierarchyLevelProps {\n  /** Parent node to get children for. Pass `undefined` to get root nodes. */\n  parentNode: HierarchyDefinitionParentNode | undefined;\n\n  /** Optional hierarchy level filter. */\n  instanceFilter?: GenericInstanceFilter;\n}\n\n/**\n * An interface for a factory that knows how define a hierarchy based on a given parent node.\n * @beta\n */\nexport interface HierarchyDefinition {\n  /**\n   * An optional function for parsing ECInstance node from ECSQL row.\n   *\n   * Should be used in situations when the `HierarchyDefinition` implementation\n   * introduces additional ECSQL columns into the select clause and wants to assign additional\n   * data to the nodes it produces.\n   *\n   * Defaults to a function that parses all `HierarchyNode` attributes from a query, whose SELECT\n   * clause is created using `NodeSelectQueryFactory.createSelectClause`.\n   */\n  parseNode?: NodeParser;\n\n  /**\n   * An optional function for pre-processing nodes.\n   *\n   * Pre-processing happens immediately after the nodes are loaded based on `HierarchyLevelDefinition`\n   * returned by this `HierarchyDefinition` and before their processing (hiding, grouping, sorting, etc.) starts.\n   * The step allows assigning nodes additional data or excluding them from the hierarchy based on some attributes.\n   */\n  preProcessNode?: NodePreProcessor;\n\n  /**\n   * An optional function for post-processing nodes.\n   *\n   * Post-processing happens after the loaded nodes go through all the merging, hiding and grouping\n   * steps, but before sorting them. This step allows `HierarchyDefinition` implementations to assign additional data\n   * to nodes after they're processed. This is especially true for grouping nodes as they're only created during\n   * processing.\n   */\n  postProcessNode?: NodePostProcessor;\n\n  /** A function to create a hierarchy level definition for given parent node. */\n  defineHierarchyLevel(props: DefineHierarchyLevelProps): Promise<HierarchyLevelDefinition>;\n}\n"]}