@itwin/presentation-hierarchies 0.1.0

package/lib/cjs/hierarchies/internal/ChildNodeObservablesCache.js

@@ -0,0 +1,84 @@
+"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.ChildNodeObservablesCache = void 0;
+const core_bentley_1 = require("@itwin/core-bentley");
+const HierarchyNodeKey_1 = require("../HierarchyNodeKey");
+/** @internal */
+class ChildNodeObservablesCache {
+    _map;
+    _props;
+    constructor(props) {
+        this._props = props;
+        this._map = new core_bentley_1.LRUDictionary(props.size, compareHierarchyNodeKeys);
+    }
+    createCacheKeys(props) {
+        function createVariationKey() {
+            const { instanceFilter, hierarchyLevelSizeLimit } = props;
+            if (instanceFilter === undefined && hierarchyLevelSizeLimit === undefined) {
+                return undefined;
+            }
+            return JSON.stringify({ instanceFilter, hierarchyLevelSizeLimit });
+        }
+        if (!props.parentNode) {
+            return { primaryKey: [], variationKey: createVariationKey() };
+        }
+        const parentKeys = props.parentNode.parentKeys;
+        return {
+            primaryKey: [...parentKeys, props.parentNode.key],
+            variationKey: createVariationKey(),
+        };
+    }
+    getCacheAccessors(primaryKey, variationKey) {
+        const getMapEntry = (create) => {
+            let entry = this._map.get(primaryKey);
+            if (!entry && create) {
+                entry = { primary: undefined, variations: new core_bentley_1.LRUMap(this._props.variationsCount ?? 1) };
+                this._map.set(primaryKey, entry);
+            }
+            return entry;
+        };
+        if (variationKey) {
+            return {
+                get: () => getMapEntry(false)?.variations.get(variationKey),
+                set: (value) => {
+                    getMapEntry(true).variations.set(variationKey, value);
+                },
+            };
+        }
+        return {
+            get: () => getMapEntry(false)?.primary,
+            set: (value) => {
+                getMapEntry(true).primary = value;
+            },
+        };
+    }
+    set(requestProps, value) {
+        const { primaryKey, variationKey } = this.createCacheKeys(requestProps);
+        this.getCacheAccessors(primaryKey, variationKey).set(value);
+    }
+    get(requestProps) {
+        const { primaryKey, variationKey } = this.createCacheKeys(requestProps);
+        return this.getCacheAccessors(primaryKey, variationKey).get();
+    }
+    clear() {
+        this._map.clear();
+    }
+}
+exports.ChildNodeObservablesCache = ChildNodeObservablesCache;
+function compareHierarchyNodeKeys(lhs, rhs) {
+    if (lhs.length !== rhs.length) {
+        return lhs.length - rhs.length;
+    }
+    for (let i = 0; i < lhs.length; ++i) {
+        const keysCompareResult = HierarchyNodeKey_1.HierarchyNodeKey.compare(lhs[i], rhs[i]);
+        if (keysCompareResult !== 0) {
+            return keysCompareResult;
+        }
+    }
+    return 0;
+}
+//# sourceMappingURL=ChildNodeObservablesCache.js.map

package/lib/cjs/hierarchies/internal/ChildNodeObservablesCache.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ChildNodeObservablesCache.js","sourceRoot":"","sources":["../../../../src/hierarchies/internal/ChildNodeObservablesCache.ts"],"names":[],"mappings":";AAAA;;;gGAGgG;;;AAGhG,sDAAsE;AAEtE,0DAAuD;AA4BvD,gBAAgB;AAChB,MAAa,yBAAyB;IAC5B,IAAI,CAA0D;IAC9D,MAAM,CAAiC;IAE/C,YAAmB,KAAqC;QACtD,IAAI,CAAC,MAAM,GAAG,KAAK,CAAC;QACpB,IAAI,CAAC,IAAI,GAAG,IAAI,4BAAa,CAA2C,KAAK,CAAC,IAAI,EAAE,wBAAwB,CAAC,CAAC;IAChH,CAAC;IAEO,eAAe,CACrB,KAAyI;QAEzI,SAAS,kBAAkB;YACzB,MAAM,EAAE,cAAc,EAAE,uBAAuB,EAAE,GAAG,KAAK,CAAC;YAC1D,IAAI,cAAc,KAAK,SAAS,IAAI,uBAAuB,KAAK,SAAS,EAAE,CAAC;gBAC1E,OAAO,SAAS,CAAC;YACnB,CAAC;YACD,OAAO,IAAI,CAAC,SAAS,CAAC,EAAE,cAAc,EAAE,uBAAuB,EAAE,CAAC,CAAC;QACrE,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,KAAiC,EAAE,EAAE;oBACzC,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,KAAiC,EAAE,EAAE;gBACzC,WAAW,CAAC,IAAI,CAAE,CAAC,OAAO,GAAG,KAAK,CAAC;YACrC,CAAC;SACF,CAAC;IACJ,CAAC;IAEM,GAAG,CAAC,YAAoC,EAAE,KAAiC;QAChF,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;AAtED,8DAsEC;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 { Observable } from \"rxjs\";\nimport { LRUCache, LRUDictionary, LRUMap } from \"@itwin/core-bentley\";\nimport { ParsedHierarchyNode, ProcessedHierarchyNode } from \"../HierarchyNode\";\nimport { HierarchyNodeKey } from \"../HierarchyNodeKey\";\nimport { GetHierarchyNodesProps } from \"../HierarchyProvider\";\n\n/** @internal */\nexport type ParsedQueryNodesObservable = Observable<ParsedHierarchyNode>;\n\n/** @internal */\nexport type ProcessedNodesObservable = Observable<ProcessedHierarchyNode>;\n\n/** @internal */\nexport type CachedNodesObservableEntry =\n  | { observable: ParsedQueryNodesObservable; processingStatus: \"none\" }\n  | { observable: ProcessedNodesObservable; processingStatus: \"pre-processed\" };\n\n/** @internal */\nexport interface ChildNodesCacheEntry {\n  /** Stores observables for the default case - no instance filter or custom limit for the hierarchy level. */\n  primary: CachedNodesObservableEntry | undefined;\n  /** Stores a limited number of variations with custom instance filter and/or custom limit for the hierarchy level. */\n  variations: LRUCache<string, CachedNodesObservableEntry>;\n}\n\n/** @internal */\nexport interface ChildNodeObservablesCacheProps {\n  size: number;\n  variationsCount?: number;\n}\n\n/** @internal */\nexport class ChildNodeObservablesCache {\n  private _map: LRUDictionary<HierarchyNodeKey[], ChildNodesCacheEntry>;\n  private _props: ChildNodeObservablesCacheProps;\n\n  public constructor(props: ChildNodeObservablesCacheProps) {\n    this._props = props;\n    this._map = new LRUDictionary<HierarchyNodeKey[], ChildNodesCacheEntry>(props.size, compareHierarchyNodeKeys);\n  }\n\n  private createCacheKeys(\n    props: Omit<GetHierarchyNodesProps, \"parentNode\"> & { parentNode: { key: HierarchyNodeKey; parentKeys: HierarchyNodeKey[] } | undefined },\n  ) {\n    function createVariationKey() {\n      const { instanceFilter, hierarchyLevelSizeLimit } = props;\n      if (instanceFilter === undefined && hierarchyLevelSizeLimit === undefined) {\n        return undefined;\n      }\n      return JSON.stringify({ instanceFilter, hierarchyLevelSizeLimit });\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: CachedNodesObservableEntry) => {\n          getMapEntry(true)!.variations.set(variationKey, value);\n        },\n      };\n    }\n    return {\n      get: () => getMapEntry(false)?.primary,\n      set: (value: CachedNodesObservableEntry) => {\n        getMapEntry(true)!.primary = value;\n      },\n    };\n  }\n\n  public set(requestProps: GetHierarchyNodesProps, value: CachedNodesObservableEntry) {\n    const { primaryKey, variationKey } = this.createCacheKeys(requestProps);\n    this.getCacheAccessors(primaryKey, variationKey).set(value);\n  }\n\n  public get(requestProps: GetHierarchyNodesProps): CachedNodesObservableEntry | 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/internal/Common.d.ts

@@ -0,0 +1,20 @@
+import { HierarchyNode, ParentHierarchyNode, ParsedHierarchyNode, ProcessedCustomHierarchyNode, ProcessedInstanceHierarchyNode } from "../HierarchyNode";
+/** @internal */
+export declare const LOGGING_NAMESPACE = "Presentation.Hierarchies";
+/** @internal */
+export declare function mergeNodes<TNode extends ProcessedCustomHierarchyNode | ProcessedInstanceHierarchyNode>(lhs: TNode, rhs: TNode): TNode;
+/** @internal */
+export declare function hasChildren<TNode extends {
+    children?: boolean | Array<unknown>;
+}>(node: TNode): boolean;
+/** @internal */
+export declare function createOperatorLoggingNamespace(operatorName: string): string;
+/** @internal */
+export declare function compareNodesByLabel<TLhsNode extends {
+    label: string;
+}, TRhsNode extends {
+    label: string;
+}>(lhs: TLhsNode, rhs: TRhsNode): number;
+/** @internal */
+export declare function createNodeIdentifierForLogging(node: ParentHierarchyNode | HierarchyNode | ParsedHierarchyNode | undefined): string;
+//# sourceMappingURL=Common.d.ts.map

package/lib/cjs/hierarchies/internal/Common.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Common.d.ts","sourceRoot":"","sources":["../../../../src/hierarchies/internal/Common.ts"],"names":[],"mappings":"AAOA,OAAO,EACL,aAAa,EAGb,mBAAmB,EACnB,mBAAmB,EACnB,4BAA4B,EAC5B,8BAA8B,EAC/B,MAAM,kBAAkB,CAAC;AAG1B,gBAAgB;AAChB,eAAO,MAAM,iBAAiB,6BAA6B,CAAC;AAuD5D,gBAAgB;AAChB,wBAAgB,UAAU,CAAC,KAAK,SAAS,4BAA4B,GAAG,8BAA8B,EAAE,GAAG,EAAE,KAAK,EAAE,GAAG,EAAE,KAAK,GAAG,KAAK,CAkBrI;AAED,gBAAgB;AAChB,wBAAgB,WAAW,CAAC,KAAK,SAAS;IAAE,QAAQ,CAAC,EAAE,OAAO,GAAG,KAAK,CAAC,OAAO,CAAC,CAAA;CAAE,EAAE,IAAI,EAAE,KAAK,WAE7F;AAED,gBAAgB;AAChB,wBAAgB,8BAA8B,CAAC,YAAY,EAAE,MAAM,UAElE;AAED,gBAAgB;AAChB,wBAAgB,mBAAmB,CAAC,QAAQ,SAAS;IAAE,KAAK,EAAE,MAAM,CAAA;CAAE,EAAE,QAAQ,SAAS;IAAE,KAAK,EAAE,MAAM,CAAA;CAAE,EAAE,GAAG,EAAE,QAAQ,EAAE,GAAG,EAAE,QAAQ,GAAG,MAAM,CAEhJ;AAED,gBAAgB;AAEhB,wBAAgB,8BAA8B,CAAC,IAAI,EAAE,mBAAmB,GAAG,aAAa,GAAG,mBAAmB,GAAG,SAAS,UAOzH"}

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

@@ -0,0 +1,106 @@
+"use strict";
+/*---------------------------------------------------------------------------------------------
+ * Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+ * See LICENSE.md in the project root for license terms and full copyright notice.
+ *--------------------------------------------------------------------------------------------*/
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createNodeIdentifierForLogging = exports.compareNodesByLabel = exports.createOperatorLoggingNamespace = exports.hasChildren = exports.mergeNodes = exports.LOGGING_NAMESPACE = void 0;
+const natural_compare_lite_1 = __importDefault(require("natural-compare-lite"));
+const core_bentley_1 = require("@itwin/core-bentley");
+const HierarchyNodeKey_1 = require("../HierarchyNodeKey");
+/** @internal */
+exports.LOGGING_NAMESPACE = "Presentation.Hierarchies";
+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_1.HierarchyNodeKey.isCustom(lhs)) {
+        (0, core_bentley_1.assert)(HierarchyNodeKey_1.HierarchyNodeKey.isCustom(rhs));
+        return lhs === rhs ? lhs : `${lhs}+${rhs}`;
+    }
+    // istanbul ignore else
+    if (HierarchyNodeKey_1.HierarchyNodeKey.isInstances(lhs)) {
+        (0, core_bentley_1.assert)(HierarchyNodeKey_1.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_1.HierarchyNodeKey.equals(lhsKeys[i], rhsKeys[i])) {
+            break;
+        }
+        res.push(lhsKeys[i]);
+    }
+    return res;
+}
+/** @internal */
+function mergeNodes(lhs, rhs) {
+    (0, core_bentley_1.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;
+}
+exports.mergeNodes = mergeNodes;
+/** @internal */
+function hasChildren(node) {
+    return node.children === true || (Array.isArray(node.children) && node.children.length > 0);
+}
+exports.hasChildren = hasChildren;
+/** @internal */
+function createOperatorLoggingNamespace(operatorName) {
+    return `${exports.LOGGING_NAMESPACE}.Operators.${operatorName}`;
+}
+exports.createOperatorLoggingNamespace = createOperatorLoggingNamespace;
+/** @internal */
+function compareNodesByLabel(lhs, rhs) {
+    return (0, natural_compare_lite_1.default)(lhs.label.toLocaleLowerCase(), rhs.label.toLocaleLowerCase());
+}
+exports.compareNodesByLabel = compareNodesByLabel;
+/** @internal */
+// istanbul ignore next
+function createNodeIdentifierForLogging(node) {
+    if (!node) {
+        return "<root>";
+    }
+    const { label, key } = node;
+    const parentKeys = "parentKeys" in node ? node.parentKeys : "<unknown>";
+    return JSON.stringify({ label, key, parentKeys });
+}
+exports.createNodeIdentifierForLogging = createNodeIdentifierForLogging;
+//# sourceMappingURL=Common.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"Common.js","sourceRoot":"","sources":["../../../../src/hierarchies/internal/Common.ts"],"names":[],"mappings":";AAAA;;;gGAGgG;;;;;;AAEhG,gFAAkD;AAClD,sDAA6C;AAU7C,0DAAyE;AAEzE,gBAAgB;AACH,QAAA,iBAAiB,GAAG,0BAA0B,CAAC;AAE5D,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,mCAAgB,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE,CAAC;QACnC,IAAA,qBAAM,EAAC,mCAAgB,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,mCAAgB,CAAC,WAAW,CAAC,GAAG,CAAC,EAAE,CAAC;QACtC,IAAA,qBAAM,EAAC,mCAAgB,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,mCAAgB,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,SAAgB,UAAU,CAA8E,GAAU,EAAE,GAAU;IAC5H,IAAA,qBAAM,EAAC,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;AAlBD,gCAkBC;AAED,gBAAgB;AAChB,SAAgB,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;AAFD,kCAEC;AAED,gBAAgB;AAChB,SAAgB,8BAA8B,CAAC,YAAoB;IACjE,OAAO,GAAG,yBAAiB,cAAc,YAAY,EAAE,CAAC;AAC1D,CAAC;AAFD,wEAEC;AAED,gBAAgB;AAChB,SAAgB,mBAAmB,CAAyE,GAAa,EAAE,GAAa;IACtI,OAAO,IAAA,8BAAc,EAAC,GAAG,CAAC,KAAK,CAAC,iBAAiB,EAAE,EAAE,GAAG,CAAC,KAAK,CAAC,iBAAiB,EAAE,CAAC,CAAC;AACtF,CAAC;AAFD,kDAEC;AAED,gBAAgB;AAChB,uBAAuB;AACvB,SAAgB,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;AAPD,wEAOC","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/** @internal */\nexport const LOGGING_NAMESPACE = \"Presentation.Hierarchies\";\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 createOperatorLoggingNamespace(operatorName: string) {\n  return `${LOGGING_NAMESPACE}.Operators.${operatorName}`;\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\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"]}

package/lib/cjs/hierarchies/internal/EachValueFrom.d.ts

@@ -0,0 +1,12 @@
+import { Observable } from "rxjs";
+/**
+ * This is pretty much a combination of:
+ * - https://github.com/benlesh/rxjs-for-await/blob/94f9cf9cb015ac3700dfd1850eb81d36962eb70f/src/index.ts#L33,
+ * - https://github.com/ReactiveX/rxjs/blob/2587ee852eb43eeb0883a7787bac2944d823392b/packages/observable/src/observable.ts#L922.
+ *
+ * Our implementation uses a linked list rather than an array to store values, which is more efficient.
+ *
+ * @internal
+ */
+export declare function eachValueFrom<T>(source: Observable<T>): AsyncIterableIterator<T>;
+//# sourceMappingURL=EachValueFrom.d.ts.map

package/lib/cjs/hierarchies/internal/EachValueFrom.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"EachValueFrom.d.ts","sourceRoot":"","sources":["../../../../src/hierarchies/internal/EachValueFrom.ts"],"names":[],"mappings":"AAKA,OAAO,EAAE,UAAU,EAAE,MAAM,MAAM,CAAC;AAElC;;;;;;;;GAQG;AACH,wBAAuB,aAAa,CAAC,CAAC,EAAE,MAAM,EAAE,UAAU,CAAC,CAAC,CAAC,GAAG,qBAAqB,CAAC,CAAC,CAAC,CAqDvF"}

package/lib/cjs/hierarchies/internal/EachValueFrom.js

@@ -0,0 +1,108 @@
+"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.eachValueFrom = void 0;
+/**
+ * This is pretty much a combination of:
+ * - https://github.com/benlesh/rxjs-for-await/blob/94f9cf9cb015ac3700dfd1850eb81d36962eb70f/src/index.ts#L33,
+ * - https://github.com/ReactiveX/rxjs/blob/2587ee852eb43eeb0883a7787bac2944d823392b/packages/observable/src/observable.ts#L922.
+ *
+ * Our implementation uses a linked list rather than an array to store values, which is more efficient.
+ *
+ * @internal
+ */
+async function* eachValueFrom(source) {
+    const deferreds = new Queue();
+    const values = new Queue();
+    let error;
+    let completed = false;
+    const subs = source.subscribe({
+        next: (value) => {
+            const deferred = deferreds.pop();
+            if (deferred) {
+                deferred.resolve({ value, done: false });
+            }
+            else {
+                values.push(value);
+            }
+        },
+        error: (err) => {
+            error = err;
+            for (let deferred = deferreds.pop(); deferred !== undefined; deferred = deferreds.pop()) {
+                deferred.reject(err);
+            }
+        },
+        complete: () => {
+            completed = true;
+            for (let deferred = deferreds.pop(); deferred !== undefined; deferred = deferreds.pop()) {
+                deferred.resolve({ value: undefined, done: true });
+            }
+        },
+    });
+    try {
+        while (true) {
+            const value = values.pop();
+            if (value !== undefined) {
+                yield value;
+                continue;
+            }
+            if (completed) {
+                return;
+            }
+            if (error) {
+                throw error;
+            }
+            const result = await new Promise((resolve, reject) => {
+                deferreds.push({ resolve, reject });
+            });
+            if (result.done) {
+                return;
+            }
+            yield result.value;
+        }
+    }
+    catch (err) {
+        throw err;
+    }
+    finally {
+        subs.unsubscribe();
+    }
+}
+exports.eachValueFrom = eachValueFrom;
+class QueueEntry {
+    value;
+    next;
+    constructor(value, next) {
+        this.value = value;
+        this.next = next;
+    }
+}
+class Queue {
+    _front;
+    _back;
+    push(item) {
+        const entry = new QueueEntry(item);
+        if (this._back) {
+            this._back.next = entry;
+        }
+        this._back = entry;
+        if (!this._front) {
+            this._front = entry;
+        }
+    }
+    pop() {
+        if (!this._front) {
+            return undefined;
+        }
+        const value = this._front.value;
+        this._front = this._front.next;
+        if (!this._front) {
+            this._back = undefined;
+        }
+        return value;
+    }
+}
+//# sourceMappingURL=EachValueFrom.js.map

package/lib/cjs/hierarchies/internal/EachValueFrom.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"EachValueFrom.js","sourceRoot":"","sources":["../../../../src/hierarchies/internal/EachValueFrom.ts"],"names":[],"mappings":";AAAA;;;gGAGgG;;;AAIhG;;;;;;;;GAQG;AACI,KAAK,SAAS,CAAC,CAAC,aAAa,CAAI,MAAqB;IAC3D,MAAM,SAAS,GAAG,IAAI,KAAK,EAAsF,CAAC;IAClH,MAAM,MAAM,GAAG,IAAI,KAAK,EAAK,CAAC;IAC9B,IAAI,KAAK,CAAC;IACV,IAAI,SAAS,GAAG,KAAK,CAAC;IACtB,MAAM,IAAI,GAAG,MAAM,CAAC,SAAS,CAAC;QAC5B,IAAI,EAAE,CAAC,KAAK,EAAE,EAAE;YACd,MAAM,QAAQ,GAAG,SAAS,CAAC,GAAG,EAAE,CAAC;YACjC,IAAI,QAAQ,EAAE,CAAC;gBACb,QAAQ,CAAC,OAAO,CAAC,EAAE,KAAK,EAAE,IAAI,EAAE,KAAK,EAAE,CAAC,CAAC;YAC3C,CAAC;iBAAM,CAAC;gBACN,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;YACrB,CAAC;QACH,CAAC;QACD,KAAK,EAAE,CAAC,GAAG,EAAE,EAAE;YACb,KAAK,GAAG,GAAG,CAAC;YACZ,KAAK,IAAI,QAAQ,GAAG,SAAS,CAAC,GAAG,EAAE,EAAE,QAAQ,KAAK,SAAS,EAAE,QAAQ,GAAG,SAAS,CAAC,GAAG,EAAE,EAAE,CAAC;gBACxF,QAAQ,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;YACvB,CAAC;QACH,CAAC;QACD,QAAQ,EAAE,GAAG,EAAE;YACb,SAAS,GAAG,IAAI,CAAC;YACjB,KAAK,IAAI,QAAQ,GAAG,SAAS,CAAC,GAAG,EAAE,EAAE,QAAQ,KAAK,SAAS,EAAE,QAAQ,GAAG,SAAS,CAAC,GAAG,EAAE,EAAE,CAAC;gBACxF,QAAQ,CAAC,OAAO,CAAC,EAAE,KAAK,EAAE,SAAS,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC,CAAC;YACrD,CAAC;QACH,CAAC;KACF,CAAC,CAAC;IACH,IAAI,CAAC;QACH,OAAO,IAAI,EAAE,CAAC;YACZ,MAAM,KAAK,GAAG,MAAM,CAAC,GAAG,EAAE,CAAC;YAC3B,IAAI,KAAK,KAAK,SAAS,EAAE,CAAC;gBACxB,MAAM,KAAK,CAAC;gBACZ,SAAS;YACX,CAAC;YACD,IAAI,SAAS,EAAE,CAAC;gBACd,OAAO;YACT,CAAC;YACD,IAAI,KAAK,EAAE,CAAC;gBACV,MAAM,KAAK,CAAC;YACd,CAAC;YACD,MAAM,MAAM,GAAG,MAAM,IAAI,OAAO,CAAoB,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;gBACtE,SAAS,CAAC,IAAI,CAAC,EAAE,OAAO,EAAE,MAAM,EAAE,CAAC,CAAC;YACtC,CAAC,CAAC,CAAC;YACH,IAAI,MAAM,CAAC,IAAI,EAAE,CAAC;gBAChB,OAAO;YACT,CAAC;YACD,MAAM,MAAM,CAAC,KAAK,CAAC;QACrB,CAAC;IACH,CAAC;IAAC,OAAO,GAAG,EAAE,CAAC;QACb,MAAM,GAAG,CAAC;IACZ,CAAC;YAAS,CAAC;QACT,IAAI,CAAC,WAAW,EAAE,CAAC;IACrB,CAAC;AACH,CAAC;AArDD,sCAqDC;AAED,MAAM,UAAU;IAEI;IACT;IAFT,YACkB,KAAQ,EACjB,IAAoB;QADX,UAAK,GAAL,KAAK,CAAG;QACjB,SAAI,GAAJ,IAAI,CAAgB;IAC1B,CAAC;CACL;AAED,MAAM,KAAK;IACD,MAAM,CAAiB;IACvB,KAAK,CAAiB;IAEvB,IAAI,CAAC,IAAO;QACjB,MAAM,KAAK,GAAG,IAAI,UAAU,CAAI,IAAI,CAAC,CAAC;QACtC,IAAI,IAAI,CAAC,KAAK,EAAE,CAAC;YACf,IAAI,CAAC,KAAK,CAAC,IAAI,GAAG,KAAK,CAAC;QAC1B,CAAC;QACD,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC;QACnB,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC;YACjB,IAAI,CAAC,MAAM,GAAG,KAAK,CAAC;QACtB,CAAC;IACH,CAAC;IAEM,GAAG;QACR,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC;YACjB,OAAO,SAAS,CAAC;QACnB,CAAC;QACD,MAAM,KAAK,GAAG,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC;QAChC,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC;QAC/B,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC;YACjB,IAAI,CAAC,KAAK,GAAG,SAAS,CAAC;QACzB,CAAC;QACD,OAAO,KAAK,CAAC;IACf,CAAC;CACF","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 { Observable } from \"rxjs\";\n\n/**\n * This is pretty much a combination of:\n * - https://github.com/benlesh/rxjs-for-await/blob/94f9cf9cb015ac3700dfd1850eb81d36962eb70f/src/index.ts#L33,\n * - https://github.com/ReactiveX/rxjs/blob/2587ee852eb43eeb0883a7787bac2944d823392b/packages/observable/src/observable.ts#L922.\n *\n * Our implementation uses a linked list rather than an array to store values, which is more efficient.\n *\n * @internal\n */\nexport async function* eachValueFrom<T>(source: Observable<T>): AsyncIterableIterator<T> {\n  const deferreds = new Queue<{ resolve: (value: IteratorResult<T>) => void; reject: (reason: unknown) => void }>();\n  const values = new Queue<T>();\n  let error;\n  let completed = false;\n  const subs = source.subscribe({\n    next: (value) => {\n      const deferred = deferreds.pop();\n      if (deferred) {\n        deferred.resolve({ value, done: false });\n      } else {\n        values.push(value);\n      }\n    },\n    error: (err) => {\n      error = err;\n      for (let deferred = deferreds.pop(); deferred !== undefined; deferred = deferreds.pop()) {\n        deferred.reject(err);\n      }\n    },\n    complete: () => {\n      completed = true;\n      for (let deferred = deferreds.pop(); deferred !== undefined; deferred = deferreds.pop()) {\n        deferred.resolve({ value: undefined, done: true });\n      }\n    },\n  });\n  try {\n    while (true) {\n      const value = values.pop();\n      if (value !== undefined) {\n        yield value;\n        continue;\n      }\n      if (completed) {\n        return;\n      }\n      if (error) {\n        throw error;\n      }\n      const result = await new Promise<IteratorResult<T>>((resolve, reject) => {\n        deferreds.push({ resolve, reject });\n      });\n      if (result.done) {\n        return;\n      }\n      yield result.value;\n    }\n  } catch (err) {\n    throw err;\n  } finally {\n    subs.unsubscribe();\n  }\n}\n\nclass QueueEntry<T> {\n  constructor(\n    public readonly value: T,\n    public next?: QueueEntry<T>,\n  ) {}\n}\n\nclass Queue<T> {\n  private _front?: QueueEntry<T>;\n  private _back?: QueueEntry<T>;\n\n  public push(item: T) {\n    const entry = new QueueEntry<T>(item);\n    if (this._back) {\n      this._back.next = entry;\n    }\n    this._back = entry;\n    if (!this._front) {\n      this._front = entry;\n    }\n  }\n\n  public pop(): T | undefined {\n    if (!this._front) {\n      return undefined;\n    }\n    const value = this._front.value;\n    this._front = this._front.next;\n    if (!this._front) {\n      this._back = undefined;\n    }\n    return value;\n  }\n}\n"]}

package/lib/cjs/hierarchies/internal/FilteringHierarchyDefinition.d.ts

@@ -0,0 +1,39 @@
+import { ECClassHierarchyInspector, InstanceKey } from "@itwin/presentation-shared";
+import { DefineHierarchyLevelProps, HierarchyDefinition, HierarchyLevelDefinition, InstanceNodesQueryDefinition, NodeParser, NodePostProcessor, NodePreProcessor } from "../HierarchyDefinition";
+import { ProcessedHierarchyNode } from "../HierarchyNode";
+import { HierarchyNodeIdentifiersPath } from "../HierarchyNodeIdentifier";
+/** @internal */
+export interface FilteringQueryBuilderProps {
+    classHierarchy: ECClassHierarchyInspector;
+    source: HierarchyDefinition;
+    nodeIdentifierPaths: HierarchyNodeIdentifiersPath[];
+}
+/** @internal */
+export type FilteredHierarchyNode<TNode = ProcessedHierarchyNode> = TNode & {
+    isFilterTarget?: boolean;
+    filteredChildrenIdentifierPaths?: HierarchyNodeIdentifiersPath[];
+};
+/** @internal */
+export declare class FilteringHierarchyDefinition implements HierarchyDefinition {
+    private _classHierarchy;
+    private _source;
+    private _nodeIdentifierPaths;
+    constructor(props: FilteringQueryBuilderProps);
+    get preProcessNode(): NodePreProcessor;
+    get postProcessNode(): NodePostProcessor;
+    get parseNode(): NodeParser;
+    defineHierarchyLevel(props: DefineHierarchyLevelProps & {
+        parentNode: FilteredHierarchyNode<DefineHierarchyLevelProps["parentNode"]> | undefined;
+    }): Promise<HierarchyLevelDefinition>;
+    private getFilteringProps;
+}
+/** @internal */
+export declare const ECSQL_COLUMN_NAME_FilteredChildrenPaths = "FilteredChildrenPaths";
+/** @internal */
+export declare const ECSQL_COLUMN_NAME_IsFilterTarget = "IsFilterTarget";
+/** @internal */
+export declare function applyECInstanceIdsFilter(def: InstanceNodesQueryDefinition, matchingFilters: Array<{
+    id: InstanceKey;
+    childrenIdentifierPaths: HierarchyNodeIdentifiersPath[];
+}>, isFilterTarget: boolean, isParentFilterTarget: boolean): InstanceNodesQueryDefinition;
+//# sourceMappingURL=FilteringHierarchyDefinition.d.ts.map

package/lib/cjs/hierarchies/internal/FilteringHierarchyDefinition.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"FilteringHierarchyDefinition.d.ts","sourceRoot":"","sources":["../../../../src/hierarchies/internal/FilteringHierarchyDefinition.ts"],"names":[],"mappings":"AAKA,OAAO,EAAE,yBAAyB,EAAE,WAAW,EAAE,MAAM,4BAA4B,CAAC;AACpF,OAAO,EAEL,yBAAyB,EACzB,mBAAmB,EACnB,wBAAwB,EAExB,4BAA4B,EAC5B,UAAU,EACV,iBAAiB,EACjB,gBAAgB,EACjB,MAAM,wBAAwB,CAAC;AAChC,OAAO,EAAmE,sBAAsB,EAAE,MAAM,kBAAkB,CAAC;AAC3H,OAAO,EAA2B,4BAA4B,EAAE,MAAM,4BAA4B,CAAC;AAGnG,gBAAgB;AAChB,MAAM,WAAW,0BAA0B;IACzC,cAAc,EAAE,yBAAyB,CAAC;IAC1C,MAAM,EAAE,mBAAmB,CAAC;IAC5B,mBAAmB,EAAE,4BAA4B,EAAE,CAAC;CACrD;AAED,gBAAgB;AAChB,MAAM,MAAM,qBAAqB,CAAC,KAAK,GAAG,sBAAsB,IAAI,KAAK,GAAG;IAC1E,cAAc,CAAC,EAAE,OAAO,CAAC;IACzB,+BAA+B,CAAC,EAAE,4BAA4B,EAAE,CAAC;CAClE,CAAC;AAEF,gBAAgB;AAChB,qBAAa,4BAA6B,YAAW,mBAAmB;IACtE,OAAO,CAAC,eAAe,CAA4B;IACnD,OAAO,CAAC,OAAO,CAAsB;IACrC,OAAO,CAAC,oBAAoB,CAAiC;gBAE1C,KAAK,EAAE,0BAA0B;IAMpD,IAAW,cAAc,IAAI,gBAAgB,CAS5C;IAED,IAAW,eAAe,IAAI,iBAAiB,CAY9C;IAED,IAAW,SAAS,IAAI,UAAU,CASjC;IAEY,oBAAoB,CAC/B,KAAK,EAAE,yBAAyB,GAAG;QAAE,UAAU,EAAE,qBAAqB,CAAC,yBAAyB,CAAC,YAAY,CAAC,CAAC,GAAG,SAAS,CAAA;KAAE,GAC5H,OAAO,CAAC,wBAAwB,CAAC;IAqDpC,OAAO,CAAC,iBAAiB;CAM1B;AA8DD,gBAAgB;AAEhB,eAAO,MAAM,uCAAuC,0BAA0B,CAAC;AAE/E,gBAAgB;AAEhB,eAAO,MAAM,gCAAgC,mBAAmB,CAAC;AAEjE,gBAAgB;AAChB,wBAAgB,wBAAwB,CACtC,GAAG,EAAE,4BAA4B,EACjC,eAAe,EAAE,KAAK,CAAC;IAAE,EAAE,EAAE,WAAW,CAAC;IAAC,uBAAuB,EAAE,4BAA4B,EAAE,CAAA;CAAE,CAAC,EACpG,cAAc,EAAE,OAAO,EACvB,oBAAoB,EAAE,OAAO,GAC5B,4BAA4B,CA8B9B"}

package/lib/cjs/hierarchies/internal/FilteringHierarchyDefinition.js

@@ -0,0 +1,181 @@
+"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.applyECInstanceIdsFilter = exports.ECSQL_COLUMN_NAME_IsFilterTarget = exports.ECSQL_COLUMN_NAME_FilteredChildrenPaths = exports.FilteringHierarchyDefinition = void 0;
+const HierarchyDefinition_1 = require("../HierarchyDefinition");
+const HierarchyNode_1 = require("../HierarchyNode");
+const HierarchyNodeIdentifier_1 = require("../HierarchyNodeIdentifier");
+const TreeNodesReader_1 = require("./TreeNodesReader");
+/** @internal */
+class FilteringHierarchyDefinition {
+    _classHierarchy;
+    _source;
+    _nodeIdentifierPaths;
+    constructor(props) {
+        this._classHierarchy = props.classHierarchy;
+        this._source = props.source;
+        this._nodeIdentifierPaths = props.nodeIdentifierPaths;
+    }
+    get preProcessNode() {
+        return async (node) => {
+            const processedNode = this._source.preProcessNode ? await this._source.preProcessNode(node) : node;
+            if (processedNode?.processingParams?.hideInHierarchy && node.isFilterTarget) {
+                // we want to hide target nodes if they have `hideInHierarchy` param
+                return undefined;
+            }
+            return processedNode;
+        };
+    }
+    get postProcessNode() {
+        return async (node) => {
+            const processedNode = this._source.postProcessNode ? await this._source.postProcessNode(node) : node;
+            if (
+            // instance nodes get the auto-expand flag in `parseNode`, but grouping ones need to be handled during post-processing
+            HierarchyNode_1.HierarchyNode.isClassGroupingNode(node) &&
+                node.children.some((child) => child.isFilterTarget || child.filteredChildrenIdentifierPaths)) {
+                return Object.assign(processedNode, { autoExpand: true });
+            }
+            return processedNode;
+        };
+    }
+    get parseNode() {
+        return (row) => {
+            const isFilterTarget = !!row[exports.ECSQL_COLUMN_NAME_IsFilterTarget];
+            const parsedFilteredChildrenIdentifierPaths = row[exports.ECSQL_COLUMN_NAME_FilteredChildrenPaths]
+                ? JSON.parse(row[exports.ECSQL_COLUMN_NAME_FilteredChildrenPaths])
+                : undefined;
+            const defaultNode = (this._source.parseNode ?? TreeNodesReader_1.defaultNodesParser)(row);
+            return applyFilterAttributes(defaultNode, parsedFilteredChildrenIdentifierPaths, isFilterTarget);
+        };
+    }
+    async defineHierarchyLevel(props) {
+        const sourceDefinitions = await this._source.defineHierarchyLevel(props);
+        const { filteredNodePaths, isParentFilterTarget } = this.getFilteringProps(props.parentNode);
+        if (!filteredNodePaths) {
+            return sourceDefinitions;
+        }
+        const filteredDefinitions = [];
+        await Promise.all(sourceDefinitions.map(async (definition) => {
+            let matchedDefinition;
+            if (HierarchyDefinition_1.HierarchyNodesDefinition.isCustomNode(definition)) {
+                matchedDefinition = await matchFilters(definition, { filteredNodePaths, isParentFilterTarget }, async (id) => {
+                    if (!HierarchyNodeIdentifier_1.HierarchyNodeIdentifier.isCustomNodeIdentifier(id)) {
+                        return false;
+                    }
+                    return id.key === definition.node.key;
+                }, (def, matchingFilters, isFilterTarget) => {
+                    const filteredChildrenIdentifierPaths = matchingFilters.reduce((r, c) => [...r, ...c.childrenIdentifierPaths], new Array());
+                    return {
+                        ...def,
+                        node: applyFilterAttributes(def.node, filteredChildrenIdentifierPaths, isFilterTarget),
+                    };
+                });
+            }
+            else {
+                matchedDefinition = await matchFilters(definition, { filteredNodePaths, isParentFilterTarget }, async (id) => {
+                    if (!HierarchyNodeIdentifier_1.HierarchyNodeIdentifier.isInstanceNodeIdentifier(id)) {
+                        return false;
+                    }
+                    return this._classHierarchy.classDerivesFrom(id.className, definition.fullClassName);
+                }, (def, matchingFilters, isFilterTarget) => applyECInstanceIdsFilter(def, matchingFilters, isFilterTarget, !!isParentFilterTarget));
+            }
+            if (matchedDefinition) {
+                filteredDefinitions.push(matchedDefinition);
+            }
+        }));
+        return filteredDefinitions;
+    }
+    getFilteringProps(parentNode) {
+        if (!parentNode) {
+            return { filteredNodePaths: this._nodeIdentifierPaths, isParentFilterTarget: false };
+        }
+        return { filteredNodePaths: parentNode.filteredChildrenIdentifierPaths, isParentFilterTarget: parentNode.isFilterTarget };
+    }
+}
+exports.FilteringHierarchyDefinition = FilteringHierarchyDefinition;
+async function matchFilters(definition, filteringProps, predicate, matchedDefinitionProcessor) {
+    const { filteredNodePaths, isParentFilterTarget } = filteringProps;
+    let isFilterTarget = false;
+    const matchingFilters = [];
+    for (const path of filteredNodePaths) {
+        if (path.length === 0) {
+            continue;
+        }
+        const nodeId = path[0];
+        if (await predicate(nodeId)) {
+            let childrenIdentifierPaths = matchingFilters.find(({ id }) => HierarchyNodeIdentifier_1.HierarchyNodeIdentifier.equal(id, nodeId))?.childrenIdentifierPaths;
+            if (!childrenIdentifierPaths) {
+                childrenIdentifierPaths = [];
+                matchingFilters.push({
+                    // ideally, `predicate` would act as a type guard to guarantee that `id` is `TIdentifier`, but at the moment
+                    // async type guards aren't supported
+                    id: nodeId,
+                    childrenIdentifierPaths,
+                });
+            }
+            const remainingPath = path.slice(1);
+            if (remainingPath.length > 0) {
+                childrenIdentifierPaths.push(remainingPath);
+            }
+            else {
+                isFilterTarget = true;
+            }
+        }
+    }
+    if (isParentFilterTarget || matchingFilters.length > 0) {
+        return matchedDefinitionProcessor(definition, matchingFilters, isFilterTarget);
+    }
+    return undefined;
+}
+function applyFilterAttributes(node, filteredChildrenIdentifierPaths, isFilterTarget) {
+    const shouldAutoExpand = !!filteredChildrenIdentifierPaths?.some((path) => !!path.length);
+    return {
+        ...node,
+        ...(isFilterTarget ? { isFilterTarget } : undefined),
+        ...(shouldAutoExpand ? { autoExpand: true } : undefined),
+        ...(!!filteredChildrenIdentifierPaths?.length ? { filteredChildrenIdentifierPaths } : undefined),
+    };
+}
+/** @internal */
+// eslint-disable-next-line @typescript-eslint/naming-convention
+exports.ECSQL_COLUMN_NAME_FilteredChildrenPaths = "FilteredChildrenPaths";
+/** @internal */
+// eslint-disable-next-line @typescript-eslint/naming-convention
+exports.ECSQL_COLUMN_NAME_IsFilterTarget = "IsFilterTarget";
+/** @internal */
+function applyECInstanceIdsFilter(def, matchingFilters, isFilterTarget, isParentFilterTarget) {
+    if (matchingFilters.length === 0) {
+        return def;
+    }
+    return {
+        ...def,
+        query: {
+            ...def.query,
+            ctes: [
+                ...(def.query.ctes ?? []),
+                // 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),
+                // so using UNION as a workaround
+                `FilteringInfo(ECInstanceId, FilteredChildrenPaths) AS (
+          ${matchingFilters
+                    .map(({ id: key, childrenIdentifierPaths }) => `VALUES (${key.id}, '${JSON.stringify(childrenIdentifierPaths)}')`)
+                    .join(" UNION ALL ")}
+        )`,
+            ],
+            ecsql: `
+        SELECT
+          [q].*,
+          ${isFilterTarget ? "1" : "0"} AS [${exports.ECSQL_COLUMN_NAME_IsFilterTarget}],
+          [f].[FilteredChildrenPaths] AS [${exports.ECSQL_COLUMN_NAME_FilteredChildrenPaths}]
+        FROM (
+          ${def.query.ecsql}
+        ) [q]
+        ${isParentFilterTarget ? "LEFT " : ""} JOIN FilteringInfo [f] ON [f].[ECInstanceId] = [q].[ECInstanceId]
+      `,
+        },
+    };
+}
+exports.applyECInstanceIdsFilter = applyECInstanceIdsFilter;
+//# sourceMappingURL=FilteringHierarchyDefinition.js.map