@itwin/presentation-hierarchies 0.6.0 → 0.7.1

package/lib/esm/hierarchies/internal/Common.js

@@ -3,8 +3,6 @@
  * See LICENSE.md in the project root for license terms and full copyright notice.
  *--------------------------------------------------------------------------------------------*/
 import naturalCompare from "natural-compare-lite";
-import { assert } from "@itwin/core-bentley";
-import { HierarchyNodeKey } from "../HierarchyNodeKey";
 /**
  * This is a logging namespace for public log messages that may be interesting to consumers.
  * @internal
@@ -28,7 +26,7 @@ export const LOGGING_NAMESPACE_INTERNAL = "Presentation.HierarchiesInternal";
  */
 export const LOGGING_NAMESPACE_PERFORMANCE_INTERNAL = `${LOGGING_NAMESPACE_INTERNAL}.Performance`;
 /** @internal */
-export function createOperatorLoggingNamespace(operatorName, baseCategory = LOGGING_NAMESPACE) {
+export function createOperatorLoggingNamespace(operatorName, baseCategory) {
     return `${baseCategory}.Operators.${operatorName}`;
 }
 /** @internal */
@@ -41,69 +39,6 @@ export function createNodeIdentifierForLogging(node) {
     const parentKeys = "parentKeys" in node ? node.parentKeys : "<unknown>";
     return JSON.stringify({ label, key, parentKeys });
 }
-function mergeNodeHandlingParams(lhs, rhs) {
-    if (!lhs && !rhs) {
-        return undefined;
-    }
-    const params = {
-        ...(lhs?.hideIfNoChildren || rhs?.hideIfNoChildren ? { hideIfNoChildren: true } : undefined),
-        ...(lhs?.hideInHierarchy || rhs?.hideInHierarchy ? { hideInHierarchy: true } : undefined),
-        ...mergeByLabelParams(lhs?.grouping?.byLabel, rhs?.grouping?.byLabel),
-    };
-    return Object.keys(params).length > 0 ? params : undefined;
-}
-function mergeByLabelParams(lhs, rhs) {
-    if (lhs && typeof lhs === "object" && lhs.action === "merge" && rhs && typeof rhs === "object" && rhs.action === "merge" && lhs.groupId === rhs.groupId) {
-        return {
-            grouping: { byLabel: lhs },
-        };
-    }
-    return undefined;
-}
-function mergeNodeKeys(lhs, rhs) {
-    if (HierarchyNodeKey.isCustom(lhs)) {
-        assert(HierarchyNodeKey.isCustom(rhs));
-        return lhs === rhs ? lhs : `${lhs}+${rhs}`;
-    }
-    // istanbul ignore else
-    if (HierarchyNodeKey.isInstances(lhs)) {
-        assert(HierarchyNodeKey.isInstances(rhs));
-        return { type: "instances", instanceKeys: [...lhs.instanceKeys, ...rhs.instanceKeys] };
-    }
-    // https://github.com/microsoft/TypeScript/issues/21985
-    // istanbul ignore next
-    return ((x) => x)(lhs);
-}
-function mergeParentNodeKeys(lhsKeys, rhsKeys) {
-    const res = new Array();
-    for (let i = 0; i < lhsKeys.length && i < rhsKeys.length; ++i) {
-        if (!HierarchyNodeKey.equals(lhsKeys[i], rhsKeys[i])) {
-            break;
-        }
-        res.push(lhsKeys[i]);
-    }
-    return res;
-}
-/** @internal */
-export function mergeNodes(lhs, rhs) {
-    assert(typeof lhs.key === typeof rhs.key);
-    const mergedProcessingParams = mergeNodeHandlingParams(lhs.processingParams, rhs.processingParams);
-    const mergedChildren = lhs.children === true || rhs.children === true ? true : lhs.children === false && rhs.children === false ? false : undefined;
-    const mergedNode = {
-        ...lhs,
-        ...rhs,
-        label: lhs.label,
-        key: mergeNodeKeys(lhs.key, rhs.key),
-        parentKeys: mergeParentNodeKeys(lhs.parentKeys, rhs.parentKeys),
-    };
-    // Remove specific properties or change their values based on lhs and rhs nodes
-    mergedChildren !== undefined ? (mergedNode.children = mergedChildren) : delete mergedNode.children;
-    mergedProcessingParams ? (mergedNode.processingParams = mergedProcessingParams) : delete mergedNode.processingParams;
-    lhs.autoExpand || rhs.autoExpand ? (mergedNode.autoExpand = true) : delete mergedNode.autoExpand;
-    lhs.extendedData || rhs.extendedData ? (mergedNode.extendedData = { ...lhs.extendedData, ...rhs.extendedData }) : delete mergedNode.extendedData;
-    lhs.supportsFiltering && rhs.supportsFiltering ? (mergedNode.supportsFiltering = true) : delete mergedNode.supportsFiltering;
-    return mergedNode;
-}
 /** @internal */
 export function hasChildren(node) {
     return node.children === true || (Array.isArray(node.children) && node.children.length > 0);

package/lib/esm/hierarchies/internal/Common.js.map

@@ -1 +1 @@
-{"version":3,"file":"Common.js","sourceRoot":"","sources":["../../../../src/hierarchies/internal/Common.ts"],"names":[],"mappings":"AAAA;;;gGAGgG;AAEhG,OAAO,cAAc,MAAM,sBAAsB,CAAC;AAClD,OAAO,EAAE,MAAM,EAAE,MAAM,qBAAqB,CAAC;AAU7C,OAAO,EAAE,gBAAgB,EAAoB,MAAM,qBAAqB,CAAC;AAEzE;;;GAGG;AACH,MAAM,CAAC,MAAM,iBAAiB,GAAG,0BAA0B,CAAC;AAE5D;;;GAGG;AACH,MAAM,CAAC,MAAM,6BAA6B,GAAG,GAAG,iBAAiB,cAAc,CAAC;AAEhF;;;;GAIG;AACH,MAAM,CAAC,MAAM,0BAA0B,GAAG,kCAAkC,CAAC;AAE7E;;;;GAIG;AACH,MAAM,CAAC,MAAM,sCAAsC,GAAG,GAAG,0BAA0B,cAAc,CAAC;AAElG,gBAAgB;AAChB,MAAM,UAAU,8BAA8B,CAC5C,YAAoB,EACpB,eAIoD,iBAAiB;IAErE,OAAO,GAAG,YAAY,cAAc,YAAY,EAAE,CAAC;AACrD,CAAC;AAED,gBAAgB;AAChB,uBAAuB;AACvB,MAAM,UAAU,8BAA8B,CAAC,IAA2E;IACxH,IAAI,CAAC,IAAI,EAAE,CAAC;QACV,OAAO,QAAQ,CAAC;IAClB,CAAC;IACD,MAAM,EAAE,KAAK,EAAE,GAAG,EAAE,GAAG,IAAI,CAAC;IAC5B,MAAM,UAAU,GAAG,YAAY,IAAI,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC,WAAW,CAAC;IACxE,OAAO,IAAI,CAAC,SAAS,CAAC,EAAE,KAAK,EAAE,GAAG,EAAE,UAAU,EAAE,CAAC,CAAC;AACpD,CAAC;AAED,SAAS,uBAAuB,CAC9B,GAAsD,EACtD,GAAsD;IAEtD,IAAI,CAAC,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;QACjB,OAAO,SAAS,CAAC;IACnB,CAAC;IACD,MAAM,MAAM,GAAG;QACb,GAAG,CAAC,GAAG,EAAE,gBAAgB,IAAI,GAAG,EAAE,gBAAgB,CAAC,CAAC,CAAC,EAAE,gBAAgB,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC;QAC5F,GAAG,CAAC,GAAG,EAAE,eAAe,IAAI,GAAG,EAAE,eAAe,CAAC,CAAC,CAAC,EAAE,eAAe,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC;QACzF,GAAG,kBAAkB,CAAC,GAAG,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,EAAE,QAAQ,EAAE,OAAO,CAAC;KACtE,CAAC;IACF,OAAO,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,SAAS,CAAC;AAC7D,CAAC;AAED,SAAS,kBAAkB,CACzB,GAAiD,EACjD,GAAiD;IAEjD,IAAI,GAAG,IAAI,OAAO,GAAG,KAAK,QAAQ,IAAI,GAAG,CAAC,MAAM,KAAK,OAAO,IAAI,GAAG,IAAI,OAAO,GAAG,KAAK,QAAQ,IAAI,GAAG,CAAC,MAAM,KAAK,OAAO,IAAI,GAAG,CAAC,OAAO,KAAK,GAAG,CAAC,OAAO,EAAE,CAAC;QACxJ,OAAO;YACL,QAAQ,EAAE,EAAE,OAAO,EAAE,GAAG,EAAE;SAC3B,CAAC;IACJ,CAAC;IACD,OAAO,SAAS,CAAC;AACnB,CAAC;AAED,SAAS,aAAa,CAAyC,GAAS,EAAE,GAAS;IACjF,IAAI,gBAAgB,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE,CAAC;QACnC,MAAM,CAAC,gBAAgB,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC;QACvC,OAAO,GAAG,KAAK,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAE,GAAG,GAAG,IAAI,GAAG,EAAW,CAAC;IACvD,CAAC;IACD,uBAAuB;IACvB,IAAI,gBAAgB,CAAC,WAAW,CAAC,GAAG,CAAC,EAAE,CAAC;QACtC,MAAM,CAAC,gBAAgB,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC,CAAC;QAC1C,OAAO,EAAE,IAAI,EAAE,WAAW,EAAE,YAAY,EAAE,CAAC,GAAG,GAAG,CAAC,YAAY,EAAE,GAAG,GAAG,CAAC,YAAY,CAAC,EAAU,CAAC;IACjG,CAAC;IACD,uDAAuD;IACvD,uBAAuB;IACvB,OAAO,CAAC,CAAC,CAAQ,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC;AAChC,CAAC;AAED,SAAS,mBAAmB,CAAC,OAA2B,EAAE,OAA2B;IACnF,MAAM,GAAG,GAAG,IAAI,KAAK,EAAoB,CAAC;IAC1C,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,OAAO,CAAC,MAAM,IAAI,CAAC,GAAG,OAAO,CAAC,MAAM,EAAE,EAAE,CAAC,EAAE,CAAC;QAC9D,IAAI,CAAC,gBAAgB,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,OAAO,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;YACrD,MAAM;QACR,CAAC;QACD,GAAG,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC;IACvB,CAAC;IACD,OAAO,GAAG,CAAC;AACb,CAAC;AAED,gBAAgB;AAChB,MAAM,UAAU,UAAU,CAA8E,GAAU,EAAE,GAAU;IAC5H,MAAM,CAAC,OAAO,GAAG,CAAC,GAAG,KAAK,OAAO,GAAG,CAAC,GAAG,CAAC,CAAC;IAC1C,MAAM,sBAAsB,GAAG,uBAAuB,CAAC,GAAG,CAAC,gBAAgB,EAAE,GAAG,CAAC,gBAAgB,CAAC,CAAC;IACnG,MAAM,cAAc,GAAG,GAAG,CAAC,QAAQ,KAAK,IAAI,IAAI,GAAG,CAAC,QAAQ,KAAK,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,GAAG,CAAC,QAAQ,KAAK,KAAK,IAAI,GAAG,CAAC,QAAQ,KAAK,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,SAAS,CAAC;IACpJ,MAAM,UAAU,GAAG;QACjB,GAAG,GAAG;QACN,GAAG,GAAG;QACN,KAAK,EAAE,GAAG,CAAC,KAAK;QAChB,GAAG,EAAE,aAAa,CAAC,GAAG,CAAC,GAAG,EAAE,GAAG,CAAC,GAAG,CAAC;QACpC,UAAU,EAAE,mBAAmB,CAAC,GAAG,CAAC,UAAU,EAAE,GAAG,CAAC,UAAU,CAAC;KACvD,CAAC;IACX,+EAA+E;IAC/E,cAAc,KAAK,SAAS,CAAC,CAAC,CAAC,CAAC,UAAU,CAAC,QAAQ,GAAG,cAAc,CAAC,CAAC,CAAC,CAAC,OAAO,UAAU,CAAC,QAAQ,CAAC;IACnG,sBAAsB,CAAC,CAAC,CAAC,CAAC,UAAU,CAAC,gBAAgB,GAAG,sBAAsB,CAAC,CAAC,CAAC,CAAC,OAAO,UAAU,CAAC,gBAAgB,CAAC;IACrH,GAAG,CAAC,UAAU,IAAI,GAAG,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,UAAU,CAAC,UAAU,GAAG,IAAI,CAAC,CAAC,CAAC,CAAC,OAAO,UAAU,CAAC,UAAU,CAAC;IACjG,GAAG,CAAC,YAAY,IAAI,GAAG,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,UAAU,CAAC,YAAY,GAAG,EAAE,GAAG,GAAG,CAAC,YAAY,EAAE,GAAG,GAAG,CAAC,YAAY,EAAE,CAAC,CAAC,CAAC,CAAC,OAAO,UAAU,CAAC,YAAY,CAAC;IACjJ,GAAG,CAAC,iBAAiB,IAAI,GAAG,CAAC,iBAAiB,CAAC,CAAC,CAAC,CAAC,UAAU,CAAC,iBAAiB,GAAG,IAAI,CAAC,CAAC,CAAC,CAAC,OAAO,UAAU,CAAC,iBAAiB,CAAC;IAC7H,OAAO,UAAU,CAAC;AACpB,CAAC;AAED,gBAAgB;AAChB,MAAM,UAAU,WAAW,CAAwD,IAAW;IAC5F,OAAO,IAAI,CAAC,QAAQ,KAAK,IAAI,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,QAAQ,CAAC,IAAI,IAAI,CAAC,QAAQ,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;AAC9F,CAAC;AAED,gBAAgB;AAChB,MAAM,UAAU,mBAAmB,CAAyE,GAAa,EAAE,GAAa;IACtI,OAAO,cAAc,CAAC,GAAG,CAAC,KAAK,CAAC,iBAAiB,EAAE,EAAE,GAAG,CAAC,KAAK,CAAC,iBAAiB,EAAE,CAAC,CAAC;AACtF,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 naturalCompare from \"natural-compare-lite\";\nimport { assert } from \"@itwin/core-bentley\";\nimport {\n  HierarchyNode,\n  HierarchyNodeLabelGroupingParams,\n  InstanceHierarchyNodeProcessingParams,\n  ParentHierarchyNode,\n  ParsedHierarchyNode,\n  ProcessedCustomHierarchyNode,\n  ProcessedInstanceHierarchyNode,\n} from \"../HierarchyNode\";\nimport { HierarchyNodeKey, InstancesNodeKey } from \"../HierarchyNodeKey\";\n\n/**\n * This is a logging namespace for public log messages that may be interesting to consumers.\n * @internal\n */\nexport const LOGGING_NAMESPACE = \"Presentation.Hierarchies\";\n\n/**\n * This is a logging namespace for public performance-related log messages that may be interesting to consumers.\n * @internal\n */\nexport const LOGGING_NAMESPACE_PERFORMANCE = `${LOGGING_NAMESPACE}.Performance`;\n\n/**\n * This is a logging namespace for internal log messages that are only interesting to package contributors,\n * but not the consumers.\n * @internal\n */\nexport const LOGGING_NAMESPACE_INTERNAL = \"Presentation.HierarchiesInternal\";\n\n/**\n * This is a logging namespace for internal performance-related log messages that are only interesting\n * to package contributors, but not the consumers.\n * @internal\n */\nexport const LOGGING_NAMESPACE_PERFORMANCE_INTERNAL = `${LOGGING_NAMESPACE_INTERNAL}.Performance`;\n\n/** @internal */\nexport function createOperatorLoggingNamespace(\n  operatorName: string,\n  baseCategory:\n    | typeof LOGGING_NAMESPACE\n    | typeof LOGGING_NAMESPACE_PERFORMANCE\n    | typeof LOGGING_NAMESPACE_INTERNAL\n    | typeof LOGGING_NAMESPACE_PERFORMANCE_INTERNAL = LOGGING_NAMESPACE,\n) {\n  return `${baseCategory}.Operators.${operatorName}`;\n}\n\n/** @internal */\n// istanbul ignore next\nexport function createNodeIdentifierForLogging(node: ParentHierarchyNode | HierarchyNode | ParsedHierarchyNode | undefined) {\n  if (!node) {\n    return \"<root>\";\n  }\n  const { label, key } = node;\n  const parentKeys = \"parentKeys\" in node ? node.parentKeys : \"<unknown>\";\n  return JSON.stringify({ label, key, parentKeys });\n}\n\nfunction mergeNodeHandlingParams(\n  lhs: InstanceHierarchyNodeProcessingParams | undefined,\n  rhs: InstanceHierarchyNodeProcessingParams | undefined,\n): InstanceHierarchyNodeProcessingParams | undefined {\n  if (!lhs && !rhs) {\n    return undefined;\n  }\n  const params = {\n    ...(lhs?.hideIfNoChildren || rhs?.hideIfNoChildren ? { hideIfNoChildren: true } : undefined),\n    ...(lhs?.hideInHierarchy || rhs?.hideInHierarchy ? { hideInHierarchy: true } : undefined),\n    ...mergeByLabelParams(lhs?.grouping?.byLabel, rhs?.grouping?.byLabel),\n  };\n  return Object.keys(params).length > 0 ? params : undefined;\n}\n\nfunction mergeByLabelParams(\n  lhs: HierarchyNodeLabelGroupingParams | undefined,\n  rhs: HierarchyNodeLabelGroupingParams | undefined,\n): InstanceHierarchyNodeProcessingParams | undefined {\n  if (lhs && typeof lhs === \"object\" && lhs.action === \"merge\" && rhs && typeof rhs === \"object\" && rhs.action === \"merge\" && lhs.groupId === rhs.groupId) {\n    return {\n      grouping: { byLabel: lhs },\n    };\n  }\n  return undefined;\n}\n\nfunction mergeNodeKeys<TKey extends string | InstancesNodeKey>(lhs: TKey, rhs: TKey): TKey {\n  if (HierarchyNodeKey.isCustom(lhs)) {\n    assert(HierarchyNodeKey.isCustom(rhs));\n    return lhs === rhs ? lhs : (`${lhs}+${rhs}` as TKey);\n  }\n  // istanbul ignore else\n  if (HierarchyNodeKey.isInstances(lhs)) {\n    assert(HierarchyNodeKey.isInstances(rhs));\n    return { type: \"instances\", instanceKeys: [...lhs.instanceKeys, ...rhs.instanceKeys] } as TKey;\n  }\n  // https://github.com/microsoft/TypeScript/issues/21985\n  // istanbul ignore next\n  return ((x: never) => x)(lhs);\n}\n\nfunction mergeParentNodeKeys(lhsKeys: HierarchyNodeKey[], rhsKeys: HierarchyNodeKey[]): HierarchyNodeKey[] {\n  const res = new Array<HierarchyNodeKey>();\n  for (let i = 0; i < lhsKeys.length && i < rhsKeys.length; ++i) {\n    if (!HierarchyNodeKey.equals(lhsKeys[i], rhsKeys[i])) {\n      break;\n    }\n    res.push(lhsKeys[i]);\n  }\n  return res;\n}\n\n/** @internal */\nexport function mergeNodes<TNode extends ProcessedCustomHierarchyNode | ProcessedInstanceHierarchyNode>(lhs: TNode, rhs: TNode): TNode {\n  assert(typeof lhs.key === typeof rhs.key);\n  const mergedProcessingParams = mergeNodeHandlingParams(lhs.processingParams, rhs.processingParams);\n  const mergedChildren = lhs.children === true || rhs.children === true ? true : lhs.children === false && rhs.children === false ? false : undefined;\n  const mergedNode = {\n    ...lhs,\n    ...rhs,\n    label: lhs.label,\n    key: mergeNodeKeys(lhs.key, rhs.key),\n    parentKeys: mergeParentNodeKeys(lhs.parentKeys, rhs.parentKeys),\n  } as TNode;\n  // Remove specific properties or change their values based on lhs and rhs nodes\n  mergedChildren !== undefined ? (mergedNode.children = mergedChildren) : delete mergedNode.children;\n  mergedProcessingParams ? (mergedNode.processingParams = mergedProcessingParams) : delete mergedNode.processingParams;\n  lhs.autoExpand || rhs.autoExpand ? (mergedNode.autoExpand = true) : delete mergedNode.autoExpand;\n  lhs.extendedData || rhs.extendedData ? (mergedNode.extendedData = { ...lhs.extendedData, ...rhs.extendedData }) : delete mergedNode.extendedData;\n  lhs.supportsFiltering && rhs.supportsFiltering ? (mergedNode.supportsFiltering = true) : delete mergedNode.supportsFiltering;\n  return mergedNode;\n}\n\n/** @internal */\nexport function hasChildren<TNode extends { children?: boolean | Array<unknown> }>(node: TNode) {\n  return node.children === true || (Array.isArray(node.children) && node.children.length > 0);\n}\n\n/** @internal */\nexport function compareNodesByLabel<TLhsNode extends { label: string }, TRhsNode extends { label: string }>(lhs: TLhsNode, rhs: TRhsNode): number {\n  return naturalCompare(lhs.label.toLocaleLowerCase(), rhs.label.toLocaleLowerCase());\n}\n"]}
+{"version":3,"file":"Common.js","sourceRoot":"","sources":["../../../../src/hierarchies/internal/Common.ts"],"names":[],"mappings":"AAAA;;;gGAGgG;AAEhG,OAAO,cAAc,MAAM,sBAAsB,CAAC;AAIlD;;;GAGG;AACH,MAAM,CAAC,MAAM,iBAAiB,GAAG,0BAA0B,CAAC;AAE5D;;;GAGG;AACH,MAAM,CAAC,MAAM,6BAA6B,GAAG,GAAG,iBAAiB,cAAc,CAAC;AAEhF;;;;GAIG;AACH,MAAM,CAAC,MAAM,0BAA0B,GAAG,kCAAkC,CAAC;AAE7E;;;;GAIG;AACH,MAAM,CAAC,MAAM,sCAAsC,GAAG,GAAG,0BAA0B,cAAc,CAAC;AAElG,gBAAgB;AAChB,MAAM,UAAU,8BAA8B,CAC5C,YAAoB,EACpB,YAIiD;IAEjD,OAAO,GAAG,YAAY,cAAc,YAAY,EAAE,CAAC;AACrD,CAAC;AAED,gBAAgB;AAChB,uBAAuB;AACvB,MAAM,UAAU,8BAA8B,CAC5C,IAA+G;IAE/G,IAAI,CAAC,IAAI,EAAE,CAAC;QACV,OAAO,QAAQ,CAAC;IAClB,CAAC;IACD,MAAM,EAAE,KAAK,EAAE,GAAG,EAAE,GAAG,IAAI,CAAC;IAC5B,MAAM,UAAU,GAAG,YAAY,IAAI,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC,WAAW,CAAC;IACxE,OAAO,IAAI,CAAC,SAAS,CAAC,EAAE,KAAK,EAAE,GAAG,EAAE,UAAU,EAAE,CAAC,CAAC;AACpD,CAAC;AAED,gBAAgB;AAChB,MAAM,UAAU,WAAW,CAAwD,IAAW;IAC5F,OAAO,IAAI,CAAC,QAAQ,KAAK,IAAI,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,QAAQ,CAAC,IAAI,IAAI,CAAC,QAAQ,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;AAC9F,CAAC;AAED,gBAAgB;AAChB,MAAM,UAAU,mBAAmB,CAAyE,GAAa,EAAE,GAAa;IACtI,OAAO,cAAc,CAAC,GAAG,CAAC,KAAK,CAAC,iBAAiB,EAAE,EAAE,GAAG,CAAC,KAAK,CAAC,iBAAiB,EAAE,CAAC,CAAC;AACtF,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 naturalCompare from \"natural-compare-lite\";\nimport { ConcatenatedValue } from \"@itwin/presentation-shared\";\nimport { HierarchyNodeKey } from \"../HierarchyNodeKey\";\n\n/**\n * This is a logging namespace for public log messages that may be interesting to consumers.\n * @internal\n */\nexport const LOGGING_NAMESPACE = \"Presentation.Hierarchies\";\n\n/**\n * This is a logging namespace for public performance-related log messages that may be interesting to consumers.\n * @internal\n */\nexport const LOGGING_NAMESPACE_PERFORMANCE = `${LOGGING_NAMESPACE}.Performance`;\n\n/**\n * This is a logging namespace for internal log messages that are only interesting to package contributors,\n * but not the consumers.\n * @internal\n */\nexport const LOGGING_NAMESPACE_INTERNAL = \"Presentation.HierarchiesInternal\";\n\n/**\n * This is a logging namespace for internal performance-related log messages that are only interesting\n * to package contributors, but not the consumers.\n * @internal\n */\nexport const LOGGING_NAMESPACE_PERFORMANCE_INTERNAL = `${LOGGING_NAMESPACE_INTERNAL}.Performance`;\n\n/** @internal */\nexport function createOperatorLoggingNamespace(\n  operatorName: string,\n  baseCategory:\n    | typeof LOGGING_NAMESPACE\n    | typeof LOGGING_NAMESPACE_PERFORMANCE\n    | typeof LOGGING_NAMESPACE_INTERNAL\n    | typeof LOGGING_NAMESPACE_PERFORMANCE_INTERNAL,\n) {\n  return `${baseCategory}.Operators.${operatorName}`;\n}\n\n/** @internal */\n// istanbul ignore next\nexport function createNodeIdentifierForLogging(\n  node: { label: string | ConcatenatedValue; key: HierarchyNodeKey; parentKeys?: HierarchyNodeKey[] } | undefined,\n) {\n  if (!node) {\n    return \"<root>\";\n  }\n  const { label, key } = node;\n  const parentKeys = \"parentKeys\" in node ? node.parentKeys : \"<unknown>\";\n  return JSON.stringify({ label, key, parentKeys });\n}\n\n/** @internal */\nexport function hasChildren<TNode extends { children?: boolean | Array<unknown> }>(node: TNode) {\n  return node.children === true || (Array.isArray(node.children) && node.children.length > 0);\n}\n\n/** @internal */\nexport function compareNodesByLabel<TLhsNode extends { label: string }, TRhsNode extends { label: string }>(lhs: TLhsNode, rhs: TRhsNode): number {\n  return naturalCompare(lhs.label.toLocaleLowerCase(), rhs.label.toLocaleLowerCase());\n}\n"]}

package/lib/esm/hierarchies/internal/operators/Sorting.d.ts

@@ -1,5 +1,4 @@
 import { Observable } from "rxjs";
-import { ProcessedHierarchyNode } from "../../HierarchyNode";
 /**
  * This should accept sorting params in some form:
  * - is sorting disabled?
@@ -8,5 +7,7 @@ import { ProcessedHierarchyNode } from "../../HierarchyNode";
  * @note Nodes with same labels are returned in undefined order.
  * @internal
  */
-export declare function sortNodesByLabelOperator(nodes: Observable<ProcessedHierarchyNode>): Observable<ProcessedHierarchyNode>;
+export declare function sortNodesByLabelOperator<TNode extends {
+    label: string;
+}>(nodes: Observable<TNode>): Observable<TNode>;
 //# sourceMappingURL=Sorting.d.ts.map

package/lib/esm/hierarchies/internal/operators/Sorting.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"Sorting.d.ts","sourceRoot":"","sources":["../../../../../src/hierarchies/internal/operators/Sorting.ts"],"names":[],"mappings":"AAKA,OAAO,EAAkB,UAAU,EAAU,MAAM,MAAM,CAAC;AAE1D,OAAO,EAAE,sBAAsB,EAAE,MAAM,qBAAqB,CAAC;AAG7D;;;;;;;GAOG;AACH,wBAAgB,wBAAwB,CAAC,KAAK,EAAE,UAAU,CAAC,sBAAsB,CAAC,GAAG,UAAU,CAAC,sBAAsB,CAAC,CAYtH"}
+{"version":3,"file":"Sorting.d.ts","sourceRoot":"","sources":["../../../../../src/hierarchies/internal/operators/Sorting.ts"],"names":[],"mappings":"AAKA,OAAO,EAAkB,UAAU,EAAU,MAAM,MAAM,CAAC;AAI1D;;;;;;;GAOG;AACH,wBAAgB,wBAAwB,CAAC,KAAK,SAAS;IAAE,KAAK,EAAE,MAAM,CAAA;CAAE,EAAE,KAAK,EAAE,UAAU,CAAC,KAAK,CAAC,GAAG,UAAU,CAAC,KAAK,CAAC,CAYrH"}

package/lib/esm/hierarchies/internal/operators/Sorting.js.map

@@ -1 +1 @@
-{"version":3,"file":"Sorting.js","sourceRoot":"","sources":["../../../../../src/hierarchies/internal/operators/Sorting.ts"],"names":[],"mappings":"AAAA;;;gGAGgG;AAEhG,OAAO,EAAE,SAAS,EAAE,GAAG,EAAc,MAAM,EAAE,MAAM,MAAM,CAAC;AAC1D,OAAO,EAAE,eAAe,EAAE,WAAW,EAAE,MAAM,qBAAqB,CAAC;AAEnE,OAAO,EAAE,mBAAmB,EAAE,MAAM,WAAW,CAAC;AAEhD;;;;;;;GAOG;AACH,MAAM,UAAU,wBAAwB,CAAC,KAAyC;IAChF,OAAO,KAAK,CAAC,IAAI,CACf,MAAM,CACJ,CAAC,MAAM,EAAE,IAAI,EAAE,EAAE;QACf,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;QACpB,OAAO,MAAM,CAAC;IAChB,CAAC,EACD,IAAI,WAAW,CAAyB,mBAAmB,EAAE,eAAe,CAAC,KAAK,CAAC,CACpF,EACD,GAAG,CAAC,CAAC,WAAW,EAAE,EAAE,CAAC,WAAW,CAAC,YAAY,EAAE,CAAC,EAChD,SAAS,EAAE,CACZ,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 { concatAll, map, Observable, reduce } from \"rxjs\";\nimport { DuplicatePolicy, SortedArray } from \"@itwin/core-bentley\";\nimport { ProcessedHierarchyNode } from \"../../HierarchyNode\";\nimport { compareNodesByLabel } from \"../Common\";\n\n/**\n * This should accept sorting params in some form:\n * - is sorting disabled?\n * - are we sorting by label or some property value, in case of the latter - how do we get the value?\n *\n * @note Nodes with same labels are returned in undefined order.\n * @internal\n */\nexport function sortNodesByLabelOperator(nodes: Observable<ProcessedHierarchyNode>): Observable<ProcessedHierarchyNode> {\n  return nodes.pipe(\n    reduce(\n      (sorted, node) => {\n        sorted.insert(node);\n        return sorted;\n      },\n      new SortedArray<ProcessedHierarchyNode>(compareNodesByLabel, DuplicatePolicy.Allow),\n    ),\n    map((sortedArray) => sortedArray.extractArray()),\n    concatAll(),\n  );\n}\n"]}
+{"version":3,"file":"Sorting.js","sourceRoot":"","sources":["../../../../../src/hierarchies/internal/operators/Sorting.ts"],"names":[],"mappings":"AAAA;;;gGAGgG;AAEhG,OAAO,EAAE,SAAS,EAAE,GAAG,EAAc,MAAM,EAAE,MAAM,MAAM,CAAC;AAC1D,OAAO,EAAE,eAAe,EAAE,WAAW,EAAE,MAAM,qBAAqB,CAAC;AACnE,OAAO,EAAE,mBAAmB,EAAE,MAAM,WAAW,CAAC;AAEhD;;;;;;;GAOG;AACH,MAAM,UAAU,wBAAwB,CAAkC,KAAwB;IAChG,OAAO,KAAK,CAAC,IAAI,CACf,MAAM,CACJ,CAAC,MAAM,EAAE,IAAI,EAAE,EAAE;QACf,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;QACpB,OAAO,MAAM,CAAC;IAChB,CAAC,EACD,IAAI,WAAW,CAAQ,mBAAmB,EAAE,eAAe,CAAC,KAAK,CAAC,CACnE,EACD,GAAG,CAAC,CAAC,WAAW,EAAE,EAAE,CAAC,WAAW,CAAC,YAAY,EAAE,CAAC,EAChD,SAAS,EAAE,CACZ,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 { concatAll, map, Observable, reduce } from \"rxjs\";\nimport { DuplicatePolicy, SortedArray } from \"@itwin/core-bentley\";\nimport { compareNodesByLabel } from \"../Common\";\n\n/**\n * This should accept sorting params in some form:\n * - is sorting disabled?\n * - are we sorting by label or some property value, in case of the latter - how do we get the value?\n *\n * @note Nodes with same labels are returned in undefined order.\n * @internal\n */\nexport function sortNodesByLabelOperator<TNode extends { label: string }>(nodes: Observable<TNode>): Observable<TNode> {\n  return nodes.pipe(\n    reduce(\n      (sorted, node) => {\n        sorted.insert(node);\n        return sorted;\n      },\n      new SortedArray<TNode>(compareNodesByLabel, DuplicatePolicy.Allow),\n    ),\n    map((sortedArray) => sortedArray.extractArray()),\n    concatAll(),\n  );\n}\n"]}

package/lib/esm/presentation-hierarchies.d.ts

@@ -1,11 +1,15 @@
 export { GenericInstanceFilter } from "@itwin/core-common";
-export { DefineCustomNodeChildHierarchyLevelProps, DefineHierarchyLevelProps, DefineInstanceNodeChildHierarchyLevelProps, DefineRootHierarchyLevelProps, HierarchyLevelDefinition, HierarchyDefinition, HierarchyNodesDefinition, NodeParser, NodePostProcessor, NodePreProcessor, createClassBasedHierarchyDefinition, } from "./hierarchies/HierarchyDefinition";
+export { DefineHierarchyLevelProps, HierarchyLevelDefinition, HierarchyDefinition, HierarchyNodesDefinition, NodeParser, NodePostProcessor, NodePreProcessor, } from "./hierarchies/imodel/IModelHierarchyDefinition";
+export { DefineGenericNodeChildHierarchyLevelProps, DefineInstanceNodeChildHierarchyLevelProps, DefineRootHierarchyLevelProps, createPredicateBasedHierarchyDefinition, } from "./hierarchies/imodel/PredicateBasedHierarchyDefinition";
+export { LimitingECSqlQueryExecutor, createLimitingECSqlQueryExecutor } from "./hierarchies/imodel/LimitingECSqlQueryExecutor";
+export { NodeSelectClauseColumnNames, NodesQueryClauseFactory, createNodesQueryClauseFactory } from "./hierarchies/imodel/NodeSelectQueryFactory";
+export { createIModelHierarchyProvider } from "./hierarchies/imodel/IModelHierarchyProvider";
+export { SourceHierarchyNode, ProcessedHierarchyNode } from "./hierarchies/imodel/IModelHierarchyNode";
 export { RowsLimitExceededError } from "./hierarchies/HierarchyErrors";
-export { GroupingHierarchyNode, HierarchyNode, NonGroupingHierarchyNode, ParsedHierarchyNode, ProcessedHierarchyNode } from "./hierarchies/HierarchyNode";
+export { GroupingHierarchyNode, HierarchyNode, NonGroupingHierarchyNode } from "./hierarchies/HierarchyNode";
 export { HierarchyNodeIdentifier, HierarchyNodeIdentifiersPath } from "./hierarchies/HierarchyNodeIdentifier";
-export { GroupingNodeKey, HierarchyNodeKey, InstancesNodeKey, ClassGroupingNodeKey, LabelGroupingNodeKey, PropertyGroupingNodeKey, PropertyOtherValuesGroupingNodeKey, PropertyValueGroupingNodeKey, PropertyValueRangeGroupingNodeKey, StandardHierarchyNodeKey, } from "./hierarchies/HierarchyNodeKey";
-export { GetHierarchyNodesProps, HierarchyProvider, createHierarchyProvider } from "./hierarchies/HierarchyProvider";
-export { LimitingECSqlQueryExecutor, createLimitingECSqlQueryExecutor } from "./hierarchies/LimitingECSqlQueryExecutor";
+export { GenericNodeKey, GroupingNodeKey, HierarchyNodeKey, InstancesNodeKey, ClassGroupingNodeKey, LabelGroupingNodeKey, PropertyGroupingNodeKey, PropertyOtherValuesGroupingNodeKey, PropertyValueGroupingNodeKey, PropertyValueRangeGroupingNodeKey, IModelHierarchyNodeKey, } from "./hierarchies/HierarchyNodeKey";
+export { GetHierarchyNodesProps, HierarchyProvider, mergeProviders } from "./hierarchies/HierarchyProvider";
+export { HierarchyFilteringPath, extractFilteringProps } from "./hierarchies/HierarchyFiltering";
 export { getLogger, setLogger } from "./hierarchies/Logging";
-export { NodeSelectClauseColumnNames, NodesQueryClauseFactory, createNodesQueryClauseFactory } from "./hierarchies/NodeSelectQueryFactory";
 //# sourceMappingURL=presentation-hierarchies.d.ts.map

package/lib/esm/presentation-hierarchies.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"presentation-hierarchies.d.ts","sourceRoot":"","sources":["../../src/presentation-hierarchies.ts"],"names":[],"mappings":"AAKA,OAAO,EAAE,qBAAqB,EAAE,MAAM,oBAAoB,CAAC;AAE3D,OAAO,EACL,wCAAwC,EACxC,yBAAyB,EACzB,0CAA0C,EAC1C,6BAA6B,EAC7B,wBAAwB,EACxB,mBAAmB,EACnB,wBAAwB,EACxB,UAAU,EACV,iBAAiB,EACjB,gBAAgB,EAChB,mCAAmC,GACpC,MAAM,mCAAmC,CAAC;AAC3C,OAAO,EAAE,sBAAsB,EAAE,MAAM,+BAA+B,CAAC;AACvE,OAAO,EAAE,qBAAqB,EAAE,aAAa,EAAE,wBAAwB,EAAE,mBAAmB,EAAE,sBAAsB,EAAE,MAAM,6BAA6B,CAAC;AAC1J,OAAO,EAAE,uBAAuB,EAAE,4BAA4B,EAAE,MAAM,uCAAuC,CAAC;AAC9G,OAAO,EACL,eAAe,EACf,gBAAgB,EAChB,gBAAgB,EAChB,oBAAoB,EACpB,oBAAoB,EACpB,uBAAuB,EACvB,kCAAkC,EAClC,4BAA4B,EAC5B,iCAAiC,EACjC,wBAAwB,GACzB,MAAM,gCAAgC,CAAC;AACxC,OAAO,EAAE,sBAAsB,EAAE,iBAAiB,EAAE,uBAAuB,EAAE,MAAM,iCAAiC,CAAC;AACrH,OAAO,EAAE,0BAA0B,EAAE,gCAAgC,EAAE,MAAM,0CAA0C,CAAC;AACxH,OAAO,EAAE,SAAS,EAAE,SAAS,EAAE,MAAM,uBAAuB,CAAC;AAC7D,OAAO,EAAE,2BAA2B,EAAE,uBAAuB,EAAE,6BAA6B,EAAE,MAAM,sCAAsC,CAAC"}
+{"version":3,"file":"presentation-hierarchies.d.ts","sourceRoot":"","sources":["../../src/presentation-hierarchies.ts"],"names":[],"mappings":"AAKA,OAAO,EAAE,qBAAqB,EAAE,MAAM,oBAAoB,CAAC;AAE3D,OAAO,EACL,yBAAyB,EACzB,wBAAwB,EACxB,mBAAmB,EACnB,wBAAwB,EACxB,UAAU,EACV,iBAAiB,EACjB,gBAAgB,GACjB,MAAM,gDAAgD,CAAC;AACxD,OAAO,EACL,yCAAyC,EACzC,0CAA0C,EAC1C,6BAA6B,EAC7B,uCAAuC,GACxC,MAAM,wDAAwD,CAAC;AAChE,OAAO,EAAE,0BAA0B,EAAE,gCAAgC,EAAE,MAAM,iDAAiD,CAAC;AAC/H,OAAO,EAAE,2BAA2B,EAAE,uBAAuB,EAAE,6BAA6B,EAAE,MAAM,6CAA6C,CAAC;AAClJ,OAAO,EAAE,6BAA6B,EAAE,MAAM,8CAA8C,CAAC;AAC7F,OAAO,EAAE,mBAAmB,EAAE,sBAAsB,EAAE,MAAM,0CAA0C,CAAC;AAEvG,OAAO,EAAE,sBAAsB,EAAE,MAAM,+BAA+B,CAAC;AACvE,OAAO,EAAE,qBAAqB,EAAE,aAAa,EAAE,wBAAwB,EAAE,MAAM,6BAA6B,CAAC;AAC7G,OAAO,EAAE,uBAAuB,EAAE,4BAA4B,EAAE,MAAM,uCAAuC,CAAC;AAC9G,OAAO,EACL,cAAc,EACd,eAAe,EACf,gBAAgB,EAChB,gBAAgB,EAChB,oBAAoB,EACpB,oBAAoB,EACpB,uBAAuB,EACvB,kCAAkC,EAClC,4BAA4B,EAC5B,iCAAiC,EACjC,sBAAsB,GACvB,MAAM,gCAAgC,CAAC;AACxC,OAAO,EAAE,sBAAsB,EAAE,iBAAiB,EAAE,cAAc,EAAE,MAAM,iCAAiC,CAAC;AAC5G,OAAO,EAAE,sBAAsB,EAAE,qBAAqB,EAAE,MAAM,kCAAkC,CAAC;AACjG,OAAO,EAAE,SAAS,EAAE,SAAS,EAAE,MAAM,uBAAuB,CAAC"}

package/lib/esm/presentation-hierarchies.js

@@ -3,13 +3,17 @@
  * See LICENSE.md in the project root for license terms and full copyright notice.
  *--------------------------------------------------------------------------------------------*/
 export { GenericInstanceFilter } from "@itwin/core-common";
-export { HierarchyNodesDefinition, createClassBasedHierarchyDefinition, } from "./hierarchies/HierarchyDefinition";
+export { HierarchyNodesDefinition, } from "./hierarchies/imodel/IModelHierarchyDefinition";
+export { createPredicateBasedHierarchyDefinition, } from "./hierarchies/imodel/PredicateBasedHierarchyDefinition";
+export { createLimitingECSqlQueryExecutor } from "./hierarchies/imodel/LimitingECSqlQueryExecutor";
+export { NodeSelectClauseColumnNames, createNodesQueryClauseFactory } from "./hierarchies/imodel/NodeSelectQueryFactory";
+export { createIModelHierarchyProvider } from "./hierarchies/imodel/IModelHierarchyProvider";
+export { ProcessedHierarchyNode } from "./hierarchies/imodel/IModelHierarchyNode";
 export { RowsLimitExceededError } from "./hierarchies/HierarchyErrors";
 export { HierarchyNode } from "./hierarchies/HierarchyNode";
 export { HierarchyNodeIdentifier } from "./hierarchies/HierarchyNodeIdentifier";
 export { HierarchyNodeKey, } from "./hierarchies/HierarchyNodeKey";
-export { createHierarchyProvider } from "./hierarchies/HierarchyProvider";
-export { createLimitingECSqlQueryExecutor } from "./hierarchies/LimitingECSqlQueryExecutor";
+export { mergeProviders } from "./hierarchies/HierarchyProvider";
+export { HierarchyFilteringPath, extractFilteringProps } from "./hierarchies/HierarchyFiltering";
 export { getLogger, setLogger } from "./hierarchies/Logging";
-export { NodeSelectClauseColumnNames, createNodesQueryClauseFactory } from "./hierarchies/NodeSelectQueryFactory";
 //# sourceMappingURL=presentation-hierarchies.js.map

package/lib/esm/presentation-hierarchies.js.map

@@ -1 +1 @@
-{"version":3,"file":"presentation-hierarchies.js","sourceRoot":"","sources":["../../src/presentation-hierarchies.ts"],"names":[],"mappings":"AAAA;;;gGAGgG;AAEhG,OAAO,EAAE,qBAAqB,EAAE,MAAM,oBAAoB,CAAC;AAE3D,OAAO,EAOL,wBAAwB,EAIxB,mCAAmC,GACpC,MAAM,mCAAmC,CAAC;AAC3C,OAAO,EAAE,sBAAsB,EAAE,MAAM,+BAA+B,CAAC;AACvE,OAAO,EAAyB,aAAa,EAAyE,MAAM,6BAA6B,CAAC;AAC1J,OAAO,EAAE,uBAAuB,EAAgC,MAAM,uCAAuC,CAAC;AAC9G,OAAO,EAEL,gBAAgB,GASjB,MAAM,gCAAgC,CAAC;AACxC,OAAO,EAA6C,uBAAuB,EAAE,MAAM,iCAAiC,CAAC;AACrH,OAAO,EAA8B,gCAAgC,EAAE,MAAM,0CAA0C,CAAC;AACxH,OAAO,EAAE,SAAS,EAAE,SAAS,EAAE,MAAM,uBAAuB,CAAC;AAC7D,OAAO,EAAE,2BAA2B,EAA2B,6BAA6B,EAAE,MAAM,sCAAsC,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\nexport { GenericInstanceFilter } from \"@itwin/core-common\";\n\nexport {\n  DefineCustomNodeChildHierarchyLevelProps,\n  DefineHierarchyLevelProps,\n  DefineInstanceNodeChildHierarchyLevelProps,\n  DefineRootHierarchyLevelProps,\n  HierarchyLevelDefinition,\n  HierarchyDefinition,\n  HierarchyNodesDefinition,\n  NodeParser,\n  NodePostProcessor,\n  NodePreProcessor,\n  createClassBasedHierarchyDefinition,\n} from \"./hierarchies/HierarchyDefinition\";\nexport { RowsLimitExceededError } from \"./hierarchies/HierarchyErrors\";\nexport { GroupingHierarchyNode, HierarchyNode, NonGroupingHierarchyNode, ParsedHierarchyNode, ProcessedHierarchyNode } from \"./hierarchies/HierarchyNode\";\nexport { HierarchyNodeIdentifier, HierarchyNodeIdentifiersPath } from \"./hierarchies/HierarchyNodeIdentifier\";\nexport {\n  GroupingNodeKey,\n  HierarchyNodeKey,\n  InstancesNodeKey,\n  ClassGroupingNodeKey,\n  LabelGroupingNodeKey,\n  PropertyGroupingNodeKey,\n  PropertyOtherValuesGroupingNodeKey,\n  PropertyValueGroupingNodeKey,\n  PropertyValueRangeGroupingNodeKey,\n  StandardHierarchyNodeKey,\n} from \"./hierarchies/HierarchyNodeKey\";\nexport { GetHierarchyNodesProps, HierarchyProvider, createHierarchyProvider } from \"./hierarchies/HierarchyProvider\";\nexport { LimitingECSqlQueryExecutor, createLimitingECSqlQueryExecutor } from \"./hierarchies/LimitingECSqlQueryExecutor\";\nexport { getLogger, setLogger } from \"./hierarchies/Logging\";\nexport { NodeSelectClauseColumnNames, NodesQueryClauseFactory, createNodesQueryClauseFactory } from \"./hierarchies/NodeSelectQueryFactory\";\n"]}
+{"version":3,"file":"presentation-hierarchies.js","sourceRoot":"","sources":["../../src/presentation-hierarchies.ts"],"names":[],"mappings":"AAAA;;;gGAGgG;AAEhG,OAAO,EAAE,qBAAqB,EAAE,MAAM,oBAAoB,CAAC;AAE3D,OAAO,EAIL,wBAAwB,GAIzB,MAAM,gDAAgD,CAAC;AACxD,OAAO,EAIL,uCAAuC,GACxC,MAAM,wDAAwD,CAAC;AAChE,OAAO,EAA8B,gCAAgC,EAAE,MAAM,iDAAiD,CAAC;AAC/H,OAAO,EAAE,2BAA2B,EAA2B,6BAA6B,EAAE,MAAM,6CAA6C,CAAC;AAClJ,OAAO,EAAE,6BAA6B,EAAE,MAAM,8CAA8C,CAAC;AAC7F,OAAO,EAAuB,sBAAsB,EAAE,MAAM,0CAA0C,CAAC;AAEvG,OAAO,EAAE,sBAAsB,EAAE,MAAM,+BAA+B,CAAC;AACvE,OAAO,EAAyB,aAAa,EAA4B,MAAM,6BAA6B,CAAC;AAC7G,OAAO,EAAE,uBAAuB,EAAgC,MAAM,uCAAuC,CAAC;AAC9G,OAAO,EAGL,gBAAgB,GASjB,MAAM,gCAAgC,CAAC;AACxC,OAAO,EAA6C,cAAc,EAAE,MAAM,iCAAiC,CAAC;AAC5G,OAAO,EAAE,sBAAsB,EAAE,qBAAqB,EAAE,MAAM,kCAAkC,CAAC;AACjG,OAAO,EAAE,SAAS,EAAE,SAAS,EAAE,MAAM,uBAAuB,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\nexport { GenericInstanceFilter } from \"@itwin/core-common\";\n\nexport {\n  DefineHierarchyLevelProps,\n  HierarchyLevelDefinition,\n  HierarchyDefinition,\n  HierarchyNodesDefinition,\n  NodeParser,\n  NodePostProcessor,\n  NodePreProcessor,\n} from \"./hierarchies/imodel/IModelHierarchyDefinition\";\nexport {\n  DefineGenericNodeChildHierarchyLevelProps,\n  DefineInstanceNodeChildHierarchyLevelProps,\n  DefineRootHierarchyLevelProps,\n  createPredicateBasedHierarchyDefinition,\n} from \"./hierarchies/imodel/PredicateBasedHierarchyDefinition\";\nexport { LimitingECSqlQueryExecutor, createLimitingECSqlQueryExecutor } from \"./hierarchies/imodel/LimitingECSqlQueryExecutor\";\nexport { NodeSelectClauseColumnNames, NodesQueryClauseFactory, createNodesQueryClauseFactory } from \"./hierarchies/imodel/NodeSelectQueryFactory\";\nexport { createIModelHierarchyProvider } from \"./hierarchies/imodel/IModelHierarchyProvider\";\nexport { SourceHierarchyNode, ProcessedHierarchyNode } from \"./hierarchies/imodel/IModelHierarchyNode\";\n\nexport { RowsLimitExceededError } from \"./hierarchies/HierarchyErrors\";\nexport { GroupingHierarchyNode, HierarchyNode, NonGroupingHierarchyNode } from \"./hierarchies/HierarchyNode\";\nexport { HierarchyNodeIdentifier, HierarchyNodeIdentifiersPath } from \"./hierarchies/HierarchyNodeIdentifier\";\nexport {\n  GenericNodeKey,\n  GroupingNodeKey,\n  HierarchyNodeKey,\n  InstancesNodeKey,\n  ClassGroupingNodeKey,\n  LabelGroupingNodeKey,\n  PropertyGroupingNodeKey,\n  PropertyOtherValuesGroupingNodeKey,\n  PropertyValueGroupingNodeKey,\n  PropertyValueRangeGroupingNodeKey,\n  IModelHierarchyNodeKey,\n} from \"./hierarchies/HierarchyNodeKey\";\nexport { GetHierarchyNodesProps, HierarchyProvider, mergeProviders } from \"./hierarchies/HierarchyProvider\";\nexport { HierarchyFilteringPath, extractFilteringProps } from \"./hierarchies/HierarchyFiltering\";\nexport { getLogger, setLogger } from \"./hierarchies/Logging\";\n"]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@itwin/presentation-hierarchies",
-  "version": "0.6.0",
+  "version": "0.7.1",
   "description": "A package for creating hierarchies based on data in iTwin.js iModels.",
   "license": "MIT",
   "author": {
@@ -69,6 +69,7 @@
     "extract-api": "extract-api --entry=presentation-hierarchies --apiReportFolder=./api --apiReportTempFolder=./api/temp --apiSummaryFolder=./api",
     "check-internal": "node ../../scripts/checkInternal.js --apiSummary ./api/presentation-hierarchies.api.md",
     "update-extractions": "node ../../scripts/updateExtractions.js --targets=./README.md,./learning",
-    "check-extractions": "node ../../scripts/updateExtractions.js --targets=./README.md,./learning --check"
+    "check-extractions": "node ../../scripts/updateExtractions.js --targets=./README.md,./learning --check",
+    "validate-markdowns": "node ../../scripts/validateMarkdowns.js README.md ./learning/**/*.md"
   }
 }

package/lib/cjs/hierarchies/HierarchyDefinition.d.ts

@@ -1,251 +0,0 @@
-import { Id64String } from "@itwin/core-bentley";
-import { GenericInstanceFilter } from "@itwin/core-common";
-import { ECClassHierarchyInspector, ECSqlQueryDef } from "@itwin/presentation-shared";
-import { NonGroupingHierarchyNode, ParsedCustomHierarchyNode, ParsedInstanceHierarchyNode, ProcessedCustomHierarchyNode, ProcessedHierarchyNode, ProcessedInstanceHierarchyNode } from "./HierarchyNode";
-import { InstancesNodeKey } from "./HierarchyNodeKey";
-/**
- * A nodes definition that returns a single custom defined node.
- * @beta
- */
-export interface CustomHierarchyNodeDefinition {
-    /** The node to be created in the hierarchy level */
-    node: ParsedCustomHierarchyNode;
-}
-/**
- * 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 = CustomHierarchyNodeDefinition | InstanceNodesQueryDefinition;
-/** @beta */
-export declare namespace HierarchyNodesDefinition {
-    function isCustomNode(def: HierarchyNodesDefinition): def is CustomHierarchyNodeDefinition;
-    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 `ParsedInstanceHierarchyNode` from provided ECSQL `row` object.
- * @beta
- */
-export type NodeParser = (row: {
-    [columnName: string]: any;
-}) => ParsedInstanceHierarchyNode;
-/**
- * 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 ProcessedCustomHierarchyNode | 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 custom node (key is of `string` type).
- * @beta
- */
-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>;
-}
-/**
- * Props for defining child hierarchy level for specific parent instance node.
- * @see `createClassBasedHierarchyDefinition`
- * @beta
- */
-export type DefineInstanceNodeChildHierarchyLevelProps = Omit<DefineHierarchyLevelProps, "parentNode"> & {
-    /** The parent instance node. */
-    parentNode: Omit<HierarchyDefinitionParentNode, "key"> & {
-        key: InstancesNodeKey;
-    };
-    /**
-     * Full name of the parent instance node class.
-     *
-     * The `parentNode.key` also contains information about the instances the parent node is based on. However,
-     * an instance node may be based on instances of multiple classes. In case that happens, parent node's instance
-     * keys are grouped by class and a hierarchy level definition is requested for each combination of class and
-     * instance IDs (with the same `parentNode`).
-     */
-    parentNodeClassName: string;
-    /**
-     * ECInstanceIds of the parent instance node.
-     *
-     * The `parentNode.key` also contains information about the instances the parent node is based on. However,
-     * an instance node may be based on instances of multiple classes. In case that happens, parent node's instance
-     * keys are grouped by class and a hierarchy level definition is requested for each combination of class and
-     * instance IDs (with the same `parentNode`).
-     */
-    parentNodeInstanceIds: Id64String[];
-};
-/**
- * A definition of a hierarchy level that should be used for specific class of parent instance nodes.
- * @beta
- */
-interface InstancesNodeChildHierarchyLevelDefinition {
-    /**
-     * Full name of the parent instance node's class to match against when checking if this hierarchy
-     * level should be used for specific parent instance node.
-     *
-     * The check is polymorphic, so `BisCore.Element` class would match `BisCore.GeometricElement`, `BisCore.Category` and
-     * all other element classes.
-     */
-    parentNodeClassName: string;
-    /**
-     * Called to create a hierarchy level definition when the class check passes (see `parentNodeClassName`).
-     */
-    definitions: (requestProps: DefineInstanceNodeChildHierarchyLevelProps) => Promise<HierarchyLevelDefinition>;
-    /**
-     * If set to true, and node matches at least one of the previous definitions, this definition will not be applied.
-     *
-     * For example:
-     * ```ts
-     * {
-     *   parentNodeClassName: "BisCore.GeometricElement3d",
-     *   definitions: () => ...,
-     * },
-     * // This will apply to all elements, that are not BisCore.GeometricElement3d
-     * {
-     *   parentNodeClassName: "BisCore.Element",
-     *   onlyIfNotHandled: true,
-     *   definitions: () => ...,
-     * }
-     * ```
-     */
-    onlyIfNotHandled?: boolean;
-}
-/**
- * Props for defining child hierarchy level for specific parent custom node.
- * @see `createClassBasedHierarchyDefinition`
- * @beta
- */
-export type DefineCustomNodeChildHierarchyLevelProps = Omit<DefineHierarchyLevelProps, "parentNode"> & {
-    /** The parent custom node. */
-    parentNode: Omit<HierarchyDefinitionParentNode, "key"> & {
-        key: string;
-    };
-};
-/**
- * A definition of a hierarchy level for that should be used for specific custom parent nodes.
- * @beta
- */
-interface CustomNodeChildHierarchyLevelDefinition {
-    /**
-     * `HierarchyNode.key` of the custom node that this child hierarchy level definition should be used for.
-     */
-    customParentNodeKey: string;
-    /**
-     * Called to create a hierarchy level definition when the node key check passes (see `customParentNodeKey`).
-     */
-    definitions: (requestProps: DefineCustomNodeChildHierarchyLevelProps) => Promise<HierarchyLevelDefinition>;
-}
-/**
- * A hierarchy level definition associated with either parent instance node's class or custom
- * node's key.
- * @beta
- */
-type ClassBasedHierarchyLevelDefinition = InstancesNodeChildHierarchyLevelDefinition | CustomNodeChildHierarchyLevelDefinition;
-/**
- * Props for defining root hierarchy level.
- * @see `createClassBasedHierarchyDefinition`
- * @beta
- */
-export type DefineRootHierarchyLevelProps = Omit<DefineHierarchyLevelProps, "parentNode">;
-/**
- * Props for `createClassBasedHierarchyDefinition`.
- * @beta
- */
-interface ClassBasedHierarchyDefinitionProps {
-    /** Access to ECClass hierarchy in the iModel */
-    classHierarchyInspector: ECClassHierarchyInspector;
-    /** Hierarchy level definitions based on parent instance node's class or custom node's key. */
-    hierarchy: {
-        /** Called to create the root hierarchy level definition. */
-        rootNodes: (props: DefineRootHierarchyLevelProps) => Promise<HierarchyLevelDefinition>;
-        /**
-         * Called to get child hierarchy level definitions based on parent instance node's class
-         * or custom node's key.
-         */
-        childNodes: ClassBasedHierarchyLevelDefinition[];
-    };
-}
-/**
- * Creates an instance of `HierarchyDefinition` that uses a somewhat declarative approach to define the
- * hierarchy - each hierarchy level is assigned either an instance node's class or custom node's
- * key and they're used to assign hierarchy level definitions based on parent node.
- *
- * @beta
- */
-export declare function createClassBasedHierarchyDefinition(props: ClassBasedHierarchyDefinitionProps): HierarchyDefinition;
-export {};
-//# sourceMappingURL=HierarchyDefinition.d.ts.map

package/lib/cjs/hierarchies/HierarchyDefinition.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"HierarchyDefinition.d.ts","sourceRoot":"","sources":["../../../src/hierarchies/HierarchyDefinition.ts"],"names":[],"mappings":"AAKA,OAAO,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAC;AACjD,OAAO,EAAE,qBAAqB,EAAE,MAAM,oBAAoB,CAAC;AAC3D,OAAO,EAAE,yBAAyB,EAAE,aAAa,EAAe,MAAM,4BAA4B,CAAC;AACnG,OAAO,EAEL,wBAAwB,EACxB,yBAAyB,EACzB,2BAA2B,EAC3B,4BAA4B,EAC5B,sBAAsB,EACtB,8BAA8B,EAC/B,MAAM,iBAAiB,CAAC;AACzB,OAAO,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AAGtD;;;GAGG;AACH,MAAM,WAAW,6BAA6B;IAC5C,oDAAoD;IACpD,IAAI,EAAE,yBAAyB,CAAC;CACjC;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,6BAA6B,GAAG,4BAA4B,CAAC;AACpG,YAAY;AAEZ,yBAAiB,wBAAwB,CAAC;IACxC,SAAgB,YAAY,CAAC,GAAG,EAAE,wBAAwB,GAAG,GAAG,IAAI,6BAA6B,CAEhG;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,4BAA4B,GAAG,8BAA8B,EAAE,IAAI,EAAE,KAAK,KAAK,OAAO,CAAC,KAAK,GAAG,SAAS,CAAC,CAAC;AAExJ;;;;;GAKG;AACH,MAAM,MAAM,iBAAiB,GAAG,CAAC,IAAI,EAAE,sBAAsB,KAAK,OAAO,CAAC,sBAAsB,CAAC,CAAC;AAElG;;;;;;GAMG;AACH,KAAK,6BAA6B,GAAG,IAAI,CAAC,wBAAwB,EAAE,UAAU,CAAC,CAAC;AAEhF;;;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;AAED;;;;GAIG;AACH,MAAM,MAAM,0CAA0C,GAAG,IAAI,CAAC,yBAAyB,EAAE,YAAY,CAAC,GAAG;IACvG,gCAAgC;IAChC,UAAU,EAAE,IAAI,CAAC,6BAA6B,EAAE,KAAK,CAAC,GAAG;QAAE,GAAG,EAAE,gBAAgB,CAAA;KAAE,CAAC;IAEnF;;;;;;;OAOG;IACH,mBAAmB,EAAE,MAAM,CAAC;IAE5B;;;;;;;OAOG;IACH,qBAAqB,EAAE,UAAU,EAAE,CAAC;CACrC,CAAC;AAEF;;;GAGG;AACH,UAAU,0CAA0C;IAClD;;;;;;OAMG;IACH,mBAAmB,EAAE,MAAM,CAAC;IAE5B;;OAEG;IACH,WAAW,EAAE,CAAC,YAAY,EAAE,0CAA0C,KAAK,OAAO,CAAC,wBAAwB,CAAC,CAAC;IAE7G;;;;;;;;;;;;;;;;OAgBG;IACH,gBAAgB,CAAC,EAAE,OAAO,CAAC;CAC5B;AAED;;;;GAIG;AACH,MAAM,MAAM,wCAAwC,GAAG,IAAI,CAAC,yBAAyB,EAAE,YAAY,CAAC,GAAG;IACrG,8BAA8B;IAC9B,UAAU,EAAE,IAAI,CAAC,6BAA6B,EAAE,KAAK,CAAC,GAAG;QAAE,GAAG,EAAE,MAAM,CAAA;KAAE,CAAC;CAC1E,CAAC;AAEF;;;GAGG;AACH,UAAU,uCAAuC;IAC/C;;OAEG;IACH,mBAAmB,EAAE,MAAM,CAAC;IAE5B;;OAEG;IACH,WAAW,EAAE,CAAC,YAAY,EAAE,wCAAwC,KAAK,OAAO,CAAC,wBAAwB,CAAC,CAAC;CAC5G;AAED;;;;GAIG;AACH,KAAK,kCAAkC,GAAG,0CAA0C,GAAG,uCAAuC,CAAC;AAE/H;;;;GAIG;AACH,MAAM,MAAM,6BAA6B,GAAG,IAAI,CAAC,yBAAyB,EAAE,YAAY,CAAC,CAAC;AAE1F;;;GAGG;AACH,UAAU,kCAAkC;IAC1C,gDAAgD;IAChD,uBAAuB,EAAE,yBAAyB,CAAC;IAEnD,8FAA8F;IAC9F,SAAS,EAAE;QACT,4DAA4D;QAC5D,SAAS,EAAE,CAAC,KAAK,EAAE,6BAA6B,KAAK,OAAO,CAAC,wBAAwB,CAAC,CAAC;QAEvF;;;WAGG;QACH,UAAU,EAAE,kCAAkC,EAAE,CAAC;KAClD,CAAC;CACH;AAED;;;;;;GAMG;AACH,wBAAgB,mCAAmC,CAAC,KAAK,EAAE,kCAAkC,GAAG,mBAAmB,CAElH"}

package/lib/cjs/hierarchies/HierarchyDefinition.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"HierarchyDefinition.js","sourceRoot":"","sources":["../../../src/hierarchies/HierarchyDefinition.ts"],"names":[],"mappings":";AAAA;;;gGAGgG;;;AA+RhG,kFAEC;AA5RD,mDAQyB;AAEzB,+BAA4F;AAkC5F,YAAY;AACZ,2DAA2D;AAC3D,IAAiB,wBAAwB,CAOxC;AAPD,WAAiB,wBAAwB;IACvC,SAAgB,YAAY,CAAC,GAA6B;QACxD,OAAO,CAAC,CAAE,GAAqC,CAAC,IAAI,CAAC;IACvD,CAAC;IAFe,qCAAY,eAE3B,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;AA8ND;;;;;;GAMG;AACH,SAAgB,mCAAmC,CAAC,KAAyC;IAC3F,OAAO,IAAI,6BAA6B,CAAC,KAAK,CAAC,CAAC;AAClD,CAAC;AAED,MAAM,6BAA6B;IACN;IAA3B,YAA2B,MAA0C;QAA1C,WAAM,GAAN,MAAM,CAAoC;IAAG,CAAC;IAEzE;;;OAGG;IACI,KAAK,CAAC,oBAAoB,CAAC,KAAgC;QAChE,MAAM,EAAE,UAAU,EAAE,GAAG,KAAK,CAAC;QAC7B,IAAI,CAAC,UAAU,EAAE,CAAC;YAChB,OAAO,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC;QAChD,CAAC;QAED,IAAI,6BAAa,CAAC,QAAQ,CAAC,UAAU,CAAC,EAAE,CAAC;YACvC,MAAM,IAAI,GAAG,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,UAAU;iBAC1C,MAAM,CAAC,yCAAyC,CAAC;iBACjD,MAAM,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,mBAAmB,KAAK,UAAU,CAAC,GAAG,CAAC,CAAC;YAC/D,OAAO,CAAC,MAAM,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,KAAK,EAAE,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,WAAW,CAAC,EAAE,GAAG,KAAK,EAAE,UAAU,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC;QACxG,CAAC;QAED,uBAAuB;QACvB,IAAI,6BAAa,CAAC,eAAe,CAAC,UAAU,CAAC,EAAE,CAAC;YAC9C,MAAM,kBAAkB,GAAG,uBAAuB,CAAC,UAAU,CAAC,GAAG,CAAC,YAAY,CAAC,CAAC;YAChF,MAAM,uBAAuB,GAAG,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,UAAU,CAAC,MAAM,CAAC,4CAA4C,CAAC,CAAC;YACtH,OAAO,CACL,MAAM,OAAO,CAAC,GAAG,CACf,CAAC,GAAG,kBAAkB,CAAC,OAAO,EAAE,CAAC,CAAC,GAAG,CAAC,KAAK,EAAE,CAAC,mBAAmB,EAAE,qBAAqB,CAAC,EAAE,EAAE,CAC3F,+BAA+B,CAAC,IAAI,CAAC,MAAM,CAAC,uBAAuB,EAAE,uBAAuB,EAAE;gBAC5F,GAAG,KAAK;gBACR,mBAAmB;gBACnB,qBAAqB;gBACrB,UAAU;aACX,CAAC,CACH,CACF,CACF,CAAC,IAAI,EAAE,CAAC;QACX,CAAC;QAED,uBAAuB;QACvB,OAAO,EAAE,CAAC;IACZ,CAAC;CACF;AAED,KAAK,UAAU,+BAA+B,CAC5C,cAAyC,EACzC,IAAkD,EAClD,YAAwD;IAExD,MAAM,GAAG,GAAG,IAAA,WAAI,EAAC,IAAI,CAAC,CAAC,IAAI,CACzB,IAAA,eAAQ,EAAC,KAAK,EAAE,GAAG,EAAE,GAAG,EAAE,EAAE;QAC1B,IAAI,MAAM,cAAc,CAAC,gBAAgB,CAAC,YAAY,CAAC,mBAAmB,EAAE,GAAG,CAAC,mBAAmB,CAAC,EAAE,CAAC;YACrG,OAAO,EAAE,GAAG,EAAE,GAAG,EAAE,CAAC;QACtB,CAAC;QACD,OAAO,SAAS,CAAC;IACnB,CAAC,CAAC,EACF,IAAA,aAAM,EAAC,CAAC,CAAC,EAAqC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,EACrD,IAAA,cAAO,GAAE,EACT,IAAA,gBAAS,EAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,GAAG,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC,EAAE,GAAG,EAAE,EAAE,EAAE,CAAC,GAAG,CAAC,CAAC,EACvE,IAAA,aAAM,EAAC,CAAC,GAAG,EAAE,GAAG,EAAE,EAAE,CAAC,CAAC,GAAG,CAAC,gBAAgB,IAAI,GAAG,KAAK,CAAC,CAAC,EACxD,IAAA,eAAQ,EAAC,KAAK,EAAE,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,WAAW,CAAC,YAAY,CAAC,CAAC,EACtD,IAAA,eAAQ,GAAE,CACX,CAAC;IACF,OAAO,IAAA,qBAAc,EAAC,GAAG,CAAC,IAAI,CAAC,IAAA,cAAO,GAAE,CAAC,CAAC,CAAC;AAC7C,CAAC;AAED,SAAS,uBAAuB,CAAC,YAA2B;IAC1D,MAAM,kBAAkB,GAAG,IAAI,GAAG,EAAwB,CAAC;IAC3D,YAAY,CAAC,OAAO,CAAC,CAAC,GAAG,EAAE,EAAE;QAC3B,IAAI,WAAW,GAAG,kBAAkB,CAAC,GAAG,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC;QACxD,IAAI,CAAC,WAAW,EAAE,CAAC;YACjB,WAAW,GAAG,EAAE,CAAC;YACjB,kBAAkB,CAAC,GAAG,CAAC,GAAG,CAAC,SAAS,EAAE,WAAW,CAAC,CAAC;QACrD,CAAC;QACD,WAAW,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;IAC3B,CAAC,CAAC,CAAC;IACH,OAAO,kBAAkB,CAAC;AAC5B,CAAC;AAED,SAAS,yCAAyC,CAAC,GAAuC;IACxF,OAAO,CAAC,CAAE,GAA+C,CAAC,mBAAmB,CAAC;AAChF,CAAC;AAED,SAAS,4CAA4C,CAAC,GAAuC;IAC3F,OAAO,CAAC,CAAE,GAAkD,CAAC,mBAAmB,CAAC;AACnF,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 { Id64String } from \"@itwin/core-bentley\";\nimport { GenericInstanceFilter } from \"@itwin/core-common\";\nimport { ECClassHierarchyInspector, ECSqlQueryDef, InstanceKey } from \"@itwin/presentation-shared\";\nimport {\n  HierarchyNode,\n  NonGroupingHierarchyNode,\n  ParsedCustomHierarchyNode,\n  ParsedInstanceHierarchyNode,\n  ProcessedCustomHierarchyNode,\n  ProcessedHierarchyNode,\n  ProcessedInstanceHierarchyNode,\n} from \"./HierarchyNode\";\nimport { InstancesNodeKey } from \"./HierarchyNodeKey\";\nimport { concatMap, filter, firstValueFrom, from, mergeAll, mergeMap, toArray } from \"rxjs\";\n\n/**\n * A nodes definition that returns a single custom defined node.\n * @beta\n */\nexport interface CustomHierarchyNodeDefinition {\n  /** The node to be created in the hierarchy level */\n  node: ParsedCustomHierarchyNode;\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 = CustomHierarchyNodeDefinition | InstanceNodesQueryDefinition;\n/** @beta */\n// eslint-disable-next-line @typescript-eslint/no-redeclare\nexport namespace HierarchyNodesDefinition {\n  export function isCustomNode(def: HierarchyNodesDefinition): def is CustomHierarchyNodeDefinition {\n    return !!(def as CustomHierarchyNodeDefinition).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 `ParsedInstanceHierarchyNode` from provided ECSQL `row` object.\n * @beta\n */\nexport type NodeParser = (row: { [columnName: string]: any }) => ParsedInstanceHierarchyNode;\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 ProcessedCustomHierarchyNode | 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 custom node (key is of `string` type).\n * @beta\n */\ntype 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\n/**\n * Props for defining child hierarchy level for specific parent instance node.\n * @see `createClassBasedHierarchyDefinition`\n * @beta\n */\nexport type DefineInstanceNodeChildHierarchyLevelProps = Omit<DefineHierarchyLevelProps, \"parentNode\"> & {\n  /** The parent instance node. */\n  parentNode: Omit<HierarchyDefinitionParentNode, \"key\"> & { key: InstancesNodeKey };\n\n  /**\n   * Full name of the parent instance node class.\n   *\n   * The `parentNode.key` also contains information about the instances the parent node is based on. However,\n   * an instance node may be based on instances of multiple classes. In case that happens, parent node's instance\n   * keys are grouped by class and a hierarchy level definition is requested for each combination of class and\n   * instance IDs (with the same `parentNode`).\n   */\n  parentNodeClassName: string;\n\n  /**\n   * ECInstanceIds of the parent instance node.\n   *\n   * The `parentNode.key` also contains information about the instances the parent node is based on. However,\n   * an instance node may be based on instances of multiple classes. In case that happens, parent node's instance\n   * keys are grouped by class and a hierarchy level definition is requested for each combination of class and\n   * instance IDs (with the same `parentNode`).\n   */\n  parentNodeInstanceIds: Id64String[];\n};\n\n/**\n * A definition of a hierarchy level that should be used for specific class of parent instance nodes.\n * @beta\n */\ninterface InstancesNodeChildHierarchyLevelDefinition {\n  /**\n   * Full name of the parent instance node's class to match against when checking if this hierarchy\n   * level should be used for specific parent instance node.\n   *\n   * The check is polymorphic, so `BisCore.Element` class would match `BisCore.GeometricElement`, `BisCore.Category` and\n   * all other element classes.\n   */\n  parentNodeClassName: string;\n\n  /**\n   * Called to create a hierarchy level definition when the class check passes (see `parentNodeClassName`).\n   */\n  definitions: (requestProps: DefineInstanceNodeChildHierarchyLevelProps) => Promise<HierarchyLevelDefinition>;\n\n  /**\n   * If set to true, and node matches at least one of the previous definitions, this definition will not be applied.\n   *\n   * For example:\n   * ```ts\n   * {\n   *   parentNodeClassName: \"BisCore.GeometricElement3d\",\n   *   definitions: () => ...,\n   * },\n   * // This will apply to all elements, that are not BisCore.GeometricElement3d\n   * {\n   *   parentNodeClassName: \"BisCore.Element\",\n   *   onlyIfNotHandled: true,\n   *   definitions: () => ...,\n   * }\n   * ```\n   */\n  onlyIfNotHandled?: boolean;\n}\n\n/**\n * Props for defining child hierarchy level for specific parent custom node.\n * @see `createClassBasedHierarchyDefinition`\n * @beta\n */\nexport type DefineCustomNodeChildHierarchyLevelProps = Omit<DefineHierarchyLevelProps, \"parentNode\"> & {\n  /** The parent custom node. */\n  parentNode: Omit<HierarchyDefinitionParentNode, \"key\"> & { key: string };\n};\n\n/**\n * A definition of a hierarchy level for that should be used for specific custom parent nodes.\n * @beta\n */\ninterface CustomNodeChildHierarchyLevelDefinition {\n  /**\n   * `HierarchyNode.key` of the custom node that this child hierarchy level definition should be used for.\n   */\n  customParentNodeKey: string;\n\n  /**\n   * Called to create a hierarchy level definition when the node key check passes (see `customParentNodeKey`).\n   */\n  definitions: (requestProps: DefineCustomNodeChildHierarchyLevelProps) => Promise<HierarchyLevelDefinition>;\n}\n\n/**\n * A hierarchy level definition associated with either parent instance node's class or custom\n * node's key.\n * @beta\n */\ntype ClassBasedHierarchyLevelDefinition = InstancesNodeChildHierarchyLevelDefinition | CustomNodeChildHierarchyLevelDefinition;\n\n/**\n * Props for defining root hierarchy level.\n * @see `createClassBasedHierarchyDefinition`\n * @beta\n */\nexport type DefineRootHierarchyLevelProps = Omit<DefineHierarchyLevelProps, \"parentNode\">;\n\n/**\n * Props for `createClassBasedHierarchyDefinition`.\n * @beta\n */\ninterface ClassBasedHierarchyDefinitionProps {\n  /** Access to ECClass hierarchy in the iModel */\n  classHierarchyInspector: ECClassHierarchyInspector;\n\n  /** Hierarchy level definitions based on parent instance node's class or custom node's key. */\n  hierarchy: {\n    /** Called to create the root hierarchy level definition. */\n    rootNodes: (props: DefineRootHierarchyLevelProps) => Promise<HierarchyLevelDefinition>;\n\n    /**\n     * Called to get child hierarchy level definitions based on parent instance node's class\n     * or custom node's key.\n     */\n    childNodes: ClassBasedHierarchyLevelDefinition[];\n  };\n}\n\n/**\n * Creates an instance of `HierarchyDefinition` that uses a somewhat declarative approach to define the\n * hierarchy - each hierarchy level is assigned either an instance node's class or custom node's\n * key and they're used to assign hierarchy level definitions based on parent node.\n *\n * @beta\n */\nexport function createClassBasedHierarchyDefinition(props: ClassBasedHierarchyDefinitionProps): HierarchyDefinition {\n  return new ClassBasedHierarchyDefinition(props);\n}\n\nclass ClassBasedHierarchyDefinition implements HierarchyDefinition {\n  public constructor(private _props: ClassBasedHierarchyDefinitionProps) {}\n\n  /**\n   * Create hierarchy level definitions for specific hierarchy level.\n   * @param parentNode Parent node to create children definitions for.\n   */\n  public async defineHierarchyLevel(props: DefineHierarchyLevelProps): Promise<HierarchyLevelDefinition> {\n    const { parentNode } = props;\n    if (!parentNode) {\n      return this._props.hierarchy.rootNodes(props);\n    }\n\n    if (HierarchyNode.isCustom(parentNode)) {\n      const defs = this._props.hierarchy.childNodes\n        .filter(isCustomNodeChildHierarchyLevelDefinition)\n        .filter((def) => def.customParentNodeKey === parentNode.key);\n      return (await Promise.all(defs.map(async (def) => def.definitions({ ...props, parentNode })))).flat();\n    }\n\n    // istanbul ignore else\n    if (HierarchyNode.isInstancesNode(parentNode)) {\n      const instanceIdsByClass = groupInstanceIdsByClass(parentNode.key.instanceKeys);\n      const instancesParentNodeDefs = this._props.hierarchy.childNodes.filter(isInstancesNodeChildHierarchyLevelDefinition);\n      return (\n        await Promise.all(\n          [...instanceIdsByClass.entries()].map(async ([parentNodeClassName, parentNodeInstanceIds]) =>\n            createHierarchyLevelDefinitions(this._props.classHierarchyInspector, instancesParentNodeDefs, {\n              ...props,\n              parentNodeClassName,\n              parentNodeInstanceIds,\n              parentNode,\n            }),\n          ),\n        )\n      ).flat();\n    }\n\n    // istanbul ignore next\n    return [];\n  }\n}\n\nasync function createHierarchyLevelDefinitions(\n  classHierarchy: ECClassHierarchyInspector,\n  defs: InstancesNodeChildHierarchyLevelDefinition[],\n  requestProps: DefineInstanceNodeChildHierarchyLevelProps,\n) {\n  const obs = from(defs).pipe(\n    mergeMap(async (def, idx) => {\n      if (await classHierarchy.classDerivesFrom(requestProps.parentNodeClassName, def.parentNodeClassName)) {\n        return { def, idx };\n      }\n      return undefined;\n    }),\n    filter((x): x is Exclude<typeof x, undefined> => !!x),\n    toArray(),\n    concatMap((x) => x.sort((a, b) => a.idx - b.idx).map(({ def }) => def)),\n    filter((def, idx) => !def.onlyIfNotHandled || idx === 0),\n    mergeMap(async (def) => def.definitions(requestProps)),\n    mergeAll(),\n  );\n  return firstValueFrom(obs.pipe(toArray()));\n}\n\nfunction groupInstanceIdsByClass(instanceKeys: InstanceKey[]) {\n  const instanceIdsByClass = new Map<string, Id64String[]>();\n  instanceKeys.forEach((key) => {\n    let instanceIds = instanceIdsByClass.get(key.className);\n    if (!instanceIds) {\n      instanceIds = [];\n      instanceIdsByClass.set(key.className, instanceIds);\n    }\n    instanceIds.push(key.id);\n  });\n  return instanceIdsByClass;\n}\n\nfunction isCustomNodeChildHierarchyLevelDefinition(def: ClassBasedHierarchyLevelDefinition): def is CustomNodeChildHierarchyLevelDefinition {\n  return !!(def as CustomNodeChildHierarchyLevelDefinition).customParentNodeKey;\n}\n\nfunction isInstancesNodeChildHierarchyLevelDefinition(def: ClassBasedHierarchyLevelDefinition): def is InstancesNodeChildHierarchyLevelDefinition {\n  return !!(def as InstancesNodeChildHierarchyLevelDefinition).parentNodeClassName;\n}\n"]}

package/lib/cjs/hierarchies/LimitingECSqlQueryExecutor.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"LimitingECSqlQueryExecutor.d.ts","sourceRoot":"","sources":["../../../src/hierarchies/LimitingECSqlQueryExecutor.ts"],"names":[],"mappings":"AAMA,OAAO,EAEL,aAAa,EACb,kBAAkB,EAClB,uBAAuB,EAGxB,MAAM,4BAA4B,CAAC;AAKpC;;;GAGG;AACH,MAAM,WAAW,0BAA0B;IACzC;;;;OAIG;IACH,iBAAiB,CACf,KAAK,EAAE,aAAa,EACpB,MAAM,CAAC,EAAE,uBAAuB,GAAG;QAAE,KAAK,CAAC,EAAE,MAAM,GAAG,WAAW,CAAA;KAAE,GAClE,UAAU,CAAC,kBAAkB,CAAC,mBAAmB,CAAC,CAAC,CAAC;CACxD;AAED;;;GAGG;AACH,wBAAgB,gCAAgC,CAAC,YAAY,EAAE,kBAAkB,EAAE,YAAY,EAAE,MAAM,GAAG,WAAW,GAAG,0BAA0B,CA4CjJ"}

package/lib/cjs/hierarchies/LimitingECSqlQueryExecutor.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"LimitingECSqlQueryExecutor.js","sourceRoot":"","sources":["../../../src/hierarchies/LimitingECSqlQueryExecutor.ts"],"names":[],"mappings":";AAAA;;;gGAGgG;;AAmChG,4EA4CC;AA7ED,sDAAsD;AACtD,oEAOoC;AACpC,uDAA2D;AAC3D,8CAAqJ;AACrJ,0DAAgD;AAkBhD;;;GAGG;AACH,SAAgB,gCAAgC,CAAC,YAAgC,EAAE,YAAkC;IACnH,OAAO;QACL,KAAK,CAAC,CAAC,iBAAiB,CAAC,KAAoB,EAAE,MAAmE;YAChH,MAAM,EAAE,KAAK,EAAE,WAAW,EAAE,GAAG,UAAU,EAAE,GAAG,MAAM,IAAI,EAAE,CAAC;YAC3D,MAAM,KAAK,GAAG,WAAW,IAAI,YAAY,CAAC;YAC1C,MAAM,WAAW,GAAG,iBAAiB,CAAC,KAAK,CAAC,CAAC;YAC7C,MAAM,iBAAiB,GAAG,IAAA,gEAA0C,GAAE,CAAC;YAEvE,2CAA2C;YAC3C,MAAM,MAAM,GAAG,YAAY,CAAC,iBAAiB,CAAC,EAAE,GAAG,KAAK,EAAE,KAAK,EAAE,QAAQ,CAAC,KAAK,CAAC,KAAK,EAAE,KAAK,CAAC,EAAE,EAAE,UAAU,CAAC,CAAC;YAC7G,IAAI,KAAK,KAAK,WAAW,EAAE,CAAC;gBAC1B,IAAI,CAAC;oBACH,IAAI,KAAK,EAAE,MAAM,GAAG,IAAI,MAAM,EAAE,CAAC;wBAC/B,MAAM,iBAAiB,EAAE,CAAC;wBAC1B,WAAW,CAAC,MAAM,EAAE,CAAC;wBACrB,MAAM,GAAG,CAAC;oBACZ,CAAC;gBACH,CAAC;wBAAS,CAAC;oBACT,WAAW,CAAC,UAAU,EAAE,CAAC;gBAC3B,CAAC;gBACD,OAAO;YACT,CAAC;YAED,2DAA2D;YAC3D,MAAM,MAAM,GAAoB,EAAE,CAAC;YACnC,IAAI,CAAC;gBACH,IAAI,KAAK,EAAE,MAAM,GAAG,IAAI,MAAM,EAAE,CAAC;oBAC/B,MAAM,iBAAiB,EAAE,CAAC;oBAC1B,WAAW,CAAC,MAAM,EAAE,CAAC;oBACrB,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;oBACjB,IAAI,MAAM,CAAC,MAAM,GAAG,KAAK,EAAE,CAAC;wBAC1B,MAAM,IAAI,wCAAsB,CAAC,KAAK,CAAC,CAAC;oBAC1C,CAAC;gBACH,CAAC;YACH,CAAC;oBAAS,CAAC;gBACT,WAAW,CAAC,UAAU,EAAE,CAAC;YAC3B,CAAC;YAED,KAAK,MAAM,GAAG,IAAI,MAAM,EAAE,CAAC;gBACzB,MAAM,iBAAiB,EAAE,CAAC;gBAC1B,MAAM,GAAG,CAAC;YACZ,CAAC;QACH,CAAC;KACF,CAAC;AACJ,CAAC;AAED,SAAS,QAAQ,CAAC,KAAa,EAAE,KAA2B;IAC1D,IAAI,KAAK,KAAK,WAAW,EAAE,CAAC;QAC1B,OAAO,KAAK,CAAC;IACf,CAAC;IACD,OAAO;;YAEG,KAAK;YACL,KAAK,GAAG,CAAC;GAClB,CAAC;AACJ,CAAC;AAED,MAAM,iBAAiB,GAAG,GAAG,0BAAsB,UAAU,CAAC;AAC9D,MAAM,6BAA6B,GAAG,GAAG,sCAAkC,UAAU,CAAC;AACtF,SAAS,iBAAiB,CAAC,KAAoB,EAAE,yBAAyB,GAAG,IAAI,EAAE,uBAAuB,GAAG,IAAI;IAC/G,MAAM,OAAO,GAAG,mBAAI,CAAC,WAAW,EAAE,CAAC;IACnC,IAAA,oBAAK,EAAC;QACJ,QAAQ,EAAE,iBAAiB;QAC3B,OAAO,EAAE,0BAA0B,CAAC,GAAG,EAAE,CAAC,oBAAoB,OAAO,MAAM,qBAAqB,CAAC,KAAK,CAAC,EAAE;KAC1G,CAAC,CAAC;IAEH,IAAI,SAAS,GAAG,IAAI,CAAC;IACrB,IAAI,SAAS,GAAG,CAAC,CAAC;IAClB,MAAM,KAAK,GAAG,IAAI,wBAAS,CAAC,SAAS,EAAE,IAAI,CAAC,CAAC;IAC7C,OAAO;QACL,MAAM;YACJ,IAAI,SAAS,EAAE,CAAC;gBACd,uBAAuB;gBACvB,IAAA,oBAAK,EAAC;oBACJ,QAAQ,EAAE,6BAA6B;oBACvC,QAAQ,EAAE,KAAK,CAAC,OAAO,CAAC,YAAY,IAAI,yBAAyB,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,OAAO;oBACvF,OAAO,EAAE,GAAG,EAAE,CAAC,IAAI,OAAO,qBAAqB,KAAK,CAAC,cAAc,KAAK;iBACzE,CAAC,CAAC;gBACH,SAAS,GAAG,KAAK,CAAC;YACpB,CAAC;YACD,EAAE,SAAS,CAAC;QACd,CAAC;QACD,UAAU;YACR,uBAAuB;YACvB,IAAA,oBAAK,EAAC;gBACJ,QAAQ,EAAE,6BAA6B;gBACvC,QAAQ,EAAE,KAAK,CAAC,OAAO,CAAC,YAAY,IAAI,uBAAuB,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,OAAO;gBACrF,OAAO,EAAE,GAAG,EAAE,CAAC,IAAI,OAAO,gBAAgB,KAAK,CAAC,cAAc,WAAW,SAAS,QAAQ;aAC3F,CAAC,CAAC;QACL,CAAC;KACF,CAAC;AACJ,CAAC;AAED,uBAAuB;AACvB,SAAS,qBAAqB,CAAC,KAAoB;IACjD,MAAM,IAAI,GAAG,KAAK,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,OAAO,IAAA,oCAAc,EAAC,GAAG,CAAC,EAAE,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;IACjF,MAAM,QAAQ,GAAG,KAAK,CAAC,QAAQ,EAAE,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAChF,IAAI,MAAM,GAAG,KAAK,CAAC;IACnB,IAAI,IAAI,EAAE,CAAC;QACT,MAAM,IAAI,eAAe,IAAI,UAAU,CAAC;IAC1C,CAAC;IACD,MAAM,IAAI,YAAY,IAAA,oCAAc,EAAC,KAAK,CAAC,KAAK,CAAC,MAAM,CAAC;IACxD,IAAI,QAAQ,EAAE,CAAC;QACb,MAAM,IAAI,gBAAgB,QAAQ,OAAO,CAAC;IAC5C,CAAC;IACD,MAAM,IAAI,GAAG,CAAC;IACd,OAAO,MAAM,CAAC;AAChB,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 { Guid, StopWatch } from \"@itwin/core-bentley\";\nimport {\n  createMainThreadReleaseOnTimePassedHandler,\n  ECSqlQueryDef,\n  ECSqlQueryExecutor,\n  ECSqlQueryReaderOptions,\n  ECSqlQueryRow,\n  trimWhitespace,\n} from \"@itwin/presentation-shared\";\nimport { RowsLimitExceededError } from \"./HierarchyErrors\";\nimport { LOGGING_NAMESPACE as BASE_LOGGING_NAMESPACE, LOGGING_NAMESPACE_PERFORMANCE as BASE_LOGGING_NAMESPACE_PERFORMANCE } from \"./internal/Common\";\nimport { doLog } from \"./internal/LoggingUtils\";\n\n/**\n * An interface for something that knows how to create a limiting ECSQL query reader.\n * @beta\n */\nexport interface LimitingECSqlQueryExecutor {\n  /**\n   * Creates a query reader for given query, but makes sure it doesn't return more than the configured\n   * limit of rows.\n   * @throws `RowsLimitExceededError` when the query returns more than configured limit of rows.\n   */\n  createQueryReader(\n    query: ECSqlQueryDef,\n    config?: ECSqlQueryReaderOptions & { limit?: number | \"unbounded\" },\n  ): ReturnType<ECSqlQueryExecutor[\"createQueryReader\"]>;\n}\n\n/**\n * Creates an `LimitingECSqlQueryExecutor` that throws `RowsLimitExceededError` if the query exceeds given amount of rows.\n * @beta\n */\nexport function createLimitingECSqlQueryExecutor(baseExecutor: ECSqlQueryExecutor, defaultLimit: number | \"unbounded\"): LimitingECSqlQueryExecutor {\n  return {\n    async *createQueryReader(query: ECSqlQueryDef, config?: ECSqlQueryReaderOptions & { limit?: number | \"unbounded\" }) {\n      const { limit: configLimit, ...restConfig } = config ?? {};\n      const limit = configLimit ?? defaultLimit;\n      const queryLogger = createQueryLogger(query);\n      const releaseMainThread = createMainThreadReleaseOnTimePassedHandler();\n\n      // handle \"unbounded\" case without a buffer\n      const reader = baseExecutor.createQueryReader({ ...query, ecsql: addLimit(query.ecsql, limit) }, restConfig);\n      if (limit === \"unbounded\") {\n        try {\n          for await (const row of reader) {\n            await releaseMainThread();\n            queryLogger.onStep();\n            yield row;\n          }\n        } finally {\n          queryLogger.onComplete();\n        }\n        return;\n      }\n\n      // avoid streaming until we know the number of rows is okay\n      const buffer: ECSqlQueryRow[] = [];\n      try {\n        for await (const row of reader) {\n          await releaseMainThread();\n          queryLogger.onStep();\n          buffer.push(row);\n          if (buffer.length > limit) {\n            throw new RowsLimitExceededError(limit);\n          }\n        }\n      } finally {\n        queryLogger.onComplete();\n      }\n\n      for (const row of buffer) {\n        await releaseMainThread();\n        yield row;\n      }\n    },\n  };\n}\n\nfunction addLimit(ecsql: string, limit: number | \"unbounded\") {\n  if (limit === \"unbounded\") {\n    return ecsql;\n  }\n  return `\n    SELECT *\n    FROM (${ecsql})\n    LIMIT ${limit + 1}\n  `;\n}\n\nconst LOGGING_NAMESPACE = `${BASE_LOGGING_NAMESPACE}.Queries`;\nconst LOGGING_NAMESPACE_PERFORMANCE = `${BASE_LOGGING_NAMESPACE_PERFORMANCE}.Queries`;\nfunction createQueryLogger(query: ECSqlQueryDef, firstStepWarningThreshold = 3000, allRowsWarningThreshold = 5000) {\n  const queryId = Guid.createValue();\n  doLog({\n    category: LOGGING_NAMESPACE,\n    message: /* istanbul ignore next */ () => `Executing query [${queryId}]: ${createQueryLogMessage(query)}`,\n  });\n\n  let firstStep = true;\n  let rowsCount = 0;\n  const timer = new StopWatch(undefined, true);\n  return {\n    onStep() {\n      if (firstStep) {\n        // istanbul ignore next\n        doLog({\n          category: LOGGING_NAMESPACE_PERFORMANCE,\n          severity: timer.current.milliseconds >= firstStepWarningThreshold ? \"warning\" : \"trace\",\n          message: () => `[${queryId}] First step took ${timer.currentSeconds} s.`,\n        });\n        firstStep = false;\n      }\n      ++rowsCount;\n    },\n    onComplete() {\n      // istanbul ignore next\n      doLog({\n        category: LOGGING_NAMESPACE_PERFORMANCE,\n        severity: timer.current.milliseconds >= allRowsWarningThreshold ? \"warning\" : \"trace\",\n        message: () => `[${queryId}] Query took ${timer.currentSeconds} s. for ${rowsCount} rows.`,\n      });\n    },\n  };\n}\n\n// istanbul ignore next\nfunction createQueryLogMessage(query: ECSqlQueryDef): string {\n  const ctes = query.ctes?.map((cte) => `    ${trimWhitespace(cte)}`).join(\", \\n\");\n  const bindings = query.bindings?.map((b) => JSON.stringify(b.value)).join(\", \");\n  let output = \"{\\n\";\n  if (ctes) {\n    output += `  ctes: [ \\n${ctes} \\n], \\n`;\n  }\n  output += `  ecsql: ${trimWhitespace(query.ecsql)}, \\n`;\n  if (bindings) {\n    output += `  bindings: [${bindings}], \\n`;\n  }\n  output += \"}\";\n  return output;\n}\n"]}

package/lib/cjs/hierarchies/NodeSelectQueryFactory.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"NodeSelectQueryFactory.d.ts","sourceRoot":"","sources":["../../../src/hierarchies/NodeSelectQueryFactory.ts"],"names":[],"mappings":"AAKA,OAAO,EAAU,UAAU,EAAE,MAAM,qBAAqB,CAAC;AACzD,OAAO,EACL,qBAAqB,EAOtB,MAAM,oBAAoB,CAAC;AAC5B,OAAO,EAEL,yBAAyB,EACzB,gBAAgB,EAGhB,iCAAiC,EAGlC,MAAM,4BAA4B,CAAC;AACpC,OAAO,EAAE,2BAA2B,EAAE,MAAM,iBAAiB,CAAC;AAE9D;;;;;GAKG;AACH,oBAAY,2BAA2B;IACrC,kHAAkH;IAClH,aAAa,kBAAkB;IAC/B,6EAA6E;IAC7E,YAAY,iBAAiB;IAC7B,qCAAqC;IACrC,YAAY,iBAAiB;IAC7B;;;;;OAKG;IACH,WAAW,gBAAgB;IAC3B,6FAA6F;IAC7F,gBAAgB,qBAAqB;IACrC,oHAAoH;IACpH,mBAAmB,wBAAwB;IAC3C,mEAAmE;IACnE,QAAQ,aAAa;IACrB,4EAA4E;IAC5E,YAAY,iBAAiB;IAC7B,2EAA2E;IAC3E,UAAU,eAAe;IACzB,2EAA2E;IAC3E,iBAAiB,sBAAsB;CACxC;AAED;;;GAGG;AACH,UAAU,kBAAkB;IAC1B,QAAQ,EAAE,MAAM,CAAC;CAClB;AAED;;;GAGG;AACH,UAAU,qBAAqB;IAC7B,SAAS,EAAE,kBAAkB,CAAC;IAC9B,YAAY,EAAE,kBAAkB,CAAC;IACjC,SAAS,EAAE,MAAM,GAAG,kBAAkB,CAAC;IACvC,YAAY,CAAC,EAAE;QACb,CAAC,GAAG,EAAE,MAAM,GAAG,UAAU,GAAG,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG,kBAAkB,CAAC;KAC5E,CAAC;IACF,UAAU,CAAC,EAAE,OAAO,GAAG,kBAAkB,CAAC;IAC1C,iBAAiB,CAAC,EAAE,OAAO,GAAG,kBAAkB,CAAC;IACjD,WAAW,CAAC,EAAE,OAAO,GAAG,kBAAkB,CAAC;IAC3C,mBAAmB,CAAC,EAAE,OAAO,GAAG,kBAAkB,CAAC;IACnD,gBAAgB,CAAC,EAAE,OAAO,GAAG,kBAAkB,CAAC;IAChD,QAAQ,CAAC,EAAE,+BAA+B,CAAC;CAC5C;AAED;;;GAGG;AACH,UAAU,+BAA+B;IACvC,OAAO,CAAC,EAAE,oCAAoC,CAAC;IAC/C,OAAO,CAAC,EAAE,OAAO,GAAG,mCAAmC,GAAG,kBAAkB,CAAC;IAC7E,aAAa,CAAC,EAAE,wCAAwC,CAAC;IACzD,YAAY,CAAC,EAAE,yCAAyC,CAAC;CAC1D;AAED;;;GAGG;AACH,UAAU,wCAAwC;IAChD,yGAAyG;IACzG,MAAM,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC;IAC3B,+DAA+D;IAC/D,OAAO,CAAC,EAAE,MAAM,GAAG,kBAAkB,CAAC;CACvC;AAED;;;GAGG;AACH,UAAU,yCAA0C,SAAQ,wCAAwC;IAClG,MAAM,EAAE,OAAO,CAAC;CACjB;AAED;;;GAGG;AACH,UAAU,yCAA0C,SAAQ,wCAAwC,EAAE,mCAAmC;IACvI,MAAM,CAAC,EAAE,OAAO,CAAC;CAClB;AAED;;;GAGG;AACH,KAAK,oCAAoC,GACrC,OAAO,GACP,kBAAkB,GAClB,yCAAyC,GACzC,yCAAyC,CAAC;AAE9C;;;GAGG;AACH,UAAU,mCAAmC;IAC3C,gBAAgB,CAAC,EAAE,OAAO,GAAG,kBAAkB,CAAC;IAChD,oBAAoB,CAAC,EAAE,OAAO,GAAG,kBAAkB,CAAC;IACpD,UAAU,CAAC,EAAE,2BAA2B,GAAG,kBAAkB,CAAC;CAC/D;AAED;;;GAGG;AACH,UAAU,yCAA0C,SAAQ,mCAAmC;IAC7F;;;;;OAKG;IACH,mBAAmB,EAAE,MAAM,CAAC;IAC5B;;;;OAIG;IACH,+BAA+B,CAAC,EAAE,OAAO,GAAG,kBAAkB,CAAC;IAC/D;;;;;OAKG;IACH,8BAA8B,CAAC,EAAE,OAAO,GAAG,kBAAkB,CAAC;IAC9D;;;;;;;;;;;;;;;;;;;;OAoBG;IACH,cAAc,EAAE,8BAA8B,EAAE,CAAC;CAClD;AAED;;;GAGG;AACH,UAAU,8BAA8B;IACtC,gEAAgE;IAChE,YAAY,EAAE,MAAM,CAAC;IACrB,wFAAwF;IACxF,kBAAkB,EAAE,MAAM,CAAC;IAC3B,8FAA8F;IAC9F,MAAM,CAAC,EAAE,mCAAmC,EAAE,CAAC;CAChD;AAED;;;GAGG;AACH,UAAU,mCAAmC;IAC3C,4CAA4C;IAC5C,SAAS,EAAE,MAAM,GAAG,kBAAkB,CAAC;IACvC,4CAA4C;IAC5C,OAAO,EAAE,MAAM,GAAG,kBAAkB,CAAC;IACrC,8EAA8E;IAC9E,UAAU,CAAC,EAAE,MAAM,GAAG,kBAAkB,CAAC;CAC1C;AAED;;;GAGG;AACH,UAAU,wCAAyC,SAAQ,mCAAmC;IAC5F,cAAc,EAAE,MAAM,EAAE,GAAG,kBAAkB,EAAE,CAAC;CACjD;AAED;;;GAGG;AACH,MAAM,WAAW,uBAAuB;IACtC,uGAAuG;IACvG,kBAAkB,CAAC,KAAK,EAAE,qBAAqB,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC;IAElE;;;;;;;;;;;OAWG;IACH,mBAAmB,CAAC,KAAK,EAAE;QACzB,YAAY,EAAE;YAAE,QAAQ,EAAE,MAAM,CAAC;YAAC,KAAK,EAAE,MAAM,CAAA;SAAE,CAAC;QAClD,MAAM,EAAE,qBAAqB,GAAG,SAAS,CAAC;KAC3C,GAAG,OAAO,CAAC;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,KAAK,EAAE,MAAM,CAAC;QAAC,KAAK,EAAE,MAAM,CAAA;KAAE,CAAC,CAAC;CAC7D;AAED;;;GAGG;AACH,wBAAgB,6BAA6B,CAAC,KAAK,EAAE;IACnD,YAAY,EAAE,gBAAgB,GAAG,yBAAyB,CAAC;IAC3D,gCAAgC,EAAE,iCAAiC,CAAC;CACrE,GAAG,uBAAuB,CAE1B"}