@itwin/presentation-hierarchies 2.0.0-alpha.2 → 2.0.0-alpha.20

package/lib/cjs/hierarchies/HierarchyNodeKey.js

@@ -1,166 +0,0 @@
-"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.HierarchyNodeKey = void 0;
-const core_bentley_1 = require("@itwin/core-bentley");
-const presentation_shared_1 = require("@itwin/presentation-shared");
-/** @public */
-// eslint-disable-next-line @typescript-eslint/no-redeclare
-var HierarchyNodeKey;
-(function (HierarchyNodeKey) {
-    /** Checks whether the given node key is a generic node key. */
-    function isGeneric(key) {
-        return key.type === "generic";
-    }
-    HierarchyNodeKey.isGeneric = isGeneric;
-    /** Checks whether the given node key is a `StandardHierarchyNodeKey`. */
-    function isIModelNodeKey(key) {
-        return !isGeneric(key);
-    }
-    HierarchyNodeKey.isIModelNodeKey = isIModelNodeKey;
-    /** Checks whether the given node key is an `InstancesNodeKey`. */
-    function isInstances(key) {
-        return key.type === "instances";
-    }
-    HierarchyNodeKey.isInstances = isInstances;
-    /** Checks whether the given node key is a `GroupingNodeKey`. */
-    function isGrouping(key) {
-        return !isGeneric(key) && !isInstances(key);
-    }
-    HierarchyNodeKey.isGrouping = isGrouping;
-    /** Checks whether the given node key is a `ClassGroupingNodeKey`. */
-    function isClassGrouping(key) {
-        return key.type === "class-grouping";
-    }
-    HierarchyNodeKey.isClassGrouping = isClassGrouping;
-    /** Checks whether the given node key is a `LabelGroupingNodeKey`. */
-    function isLabelGrouping(key) {
-        return key.type === "label-grouping";
-    }
-    HierarchyNodeKey.isLabelGrouping = isLabelGrouping;
-    /** Checks whether the given node key is a `PropertyOtherValuesGroupingNodeKey`. */
-    function isPropertyOtherValuesGrouping(key) {
-        return key.type === "property-grouping:other";
-    }
-    HierarchyNodeKey.isPropertyOtherValuesGrouping = isPropertyOtherValuesGrouping;
-    /** Checks whether the given node key is a `PropertyValueRangeGroupingNodeKey`. */
-    function isPropertyValueRangeGrouping(key) {
-        return key.type === "property-grouping:range";
-    }
-    HierarchyNodeKey.isPropertyValueRangeGrouping = isPropertyValueRangeGrouping;
-    /** Checks whether the given node key is a `PropertyValueGroupingNodeKey`. */
-    function isPropertyValueGrouping(key) {
-        return key.type === "property-grouping:value";
-    }
-    HierarchyNodeKey.isPropertyValueGrouping = isPropertyValueGrouping;
-    /** Checks whether the given node key is a `PropertyGroupingNodeKey`. */
-    function isPropertyGrouping(key) {
-        return isPropertyOtherValuesGrouping(key) || isPropertyValueRangeGrouping(key) || isPropertyValueGrouping(key);
-    }
-    HierarchyNodeKey.isPropertyGrouping = isPropertyGrouping;
-    /**
-     * Compares two given keys. Returns:
-     * - `0` if they are equal,
-     * - `negative value` if lhs key is less than rhs key,
-     * - `positive value` if lhs key is more than rhs key.
-     */
-    function compare(lhs, rhs) {
-        const typeCompareResult = (0, core_bentley_1.compareStrings)(lhs.type, rhs.type);
-        if (typeCompareResult !== 0) {
-            return typeCompareResult;
-        }
-        switch (lhs.type) {
-            case "generic": {
-                (0, core_bentley_1.assert)(rhs.type === "generic");
-                const idCompareResult = (0, core_bentley_1.compareStrings)(lhs.id, rhs.id);
-                if (idCompareResult !== 0) {
-                    return idCompareResult;
-                }
-                return (0, core_bentley_1.compareStringsOrUndefined)(lhs.source, rhs.source);
-            }
-            case "instances": {
-                (0, core_bentley_1.assert)(rhs.type === "instances");
-                if (lhs.instanceKeys.length !== rhs.instanceKeys.length) {
-                    return lhs.instanceKeys.length > rhs.instanceKeys.length ? 1 : -1;
-                }
-                for (let i = 0; i < lhs.instanceKeys.length; ++i) {
-                    const instanceKeyCompareResult = presentation_shared_1.InstanceKey.compare(lhs.instanceKeys[i], rhs.instanceKeys[i]);
-                    if (instanceKeyCompareResult !== 0) {
-                        return instanceKeyCompareResult;
-                    }
-                    const imodelKeyCompareResult = (0, core_bentley_1.compareStringsOrUndefined)(lhs.instanceKeys[0].imodelKey, rhs.instanceKeys[0].imodelKey);
-                    if (imodelKeyCompareResult !== 0) {
-                        return imodelKeyCompareResult;
-                    }
-                }
-                return 0;
-            }
-            case "class-grouping": {
-                (0, core_bentley_1.assert)(rhs.type === "class-grouping");
-                return (0, core_bentley_1.compareStrings)(lhs.className, rhs.className);
-            }
-            case "label-grouping": {
-                (0, core_bentley_1.assert)(rhs.type === "label-grouping");
-                const labelCompareResult = (0, core_bentley_1.compareStrings)(lhs.label, rhs.label);
-                if (labelCompareResult !== 0) {
-                    return labelCompareResult;
-                }
-                return (0, core_bentley_1.compareStringsOrUndefined)(lhs.groupId, rhs.groupId);
-            }
-            case "property-grouping:other": {
-                (0, core_bentley_1.assert)(rhs.type === "property-grouping:other");
-                if (lhs.properties.length !== rhs.properties.length) {
-                    return lhs.properties.length - rhs.properties.length;
-                }
-                for (let i = 0; i < lhs.properties.length; ++i) {
-                    const classCompareResult = (0, core_bentley_1.compareStrings)(lhs.properties[i].className, rhs.properties[i].className);
-                    if (classCompareResult !== 0) {
-                        return classCompareResult;
-                    }
-                    const nameCompareResult = (0, core_bentley_1.compareStrings)(lhs.properties[i].propertyName, rhs.properties[i].propertyName);
-                    if (nameCompareResult !== 0) {
-                        return nameCompareResult;
-                    }
-                }
-                return 0;
-            }
-            case "property-grouping:value": {
-                (0, core_bentley_1.assert)(rhs.type === "property-grouping:value");
-                const propertyClassNameCompareResult = (0, core_bentley_1.compareStrings)(lhs.propertyClassName, rhs.propertyClassName);
-                if (propertyClassNameCompareResult !== 0) {
-                    return propertyClassNameCompareResult;
-                }
-                const propertyNameCompareResult = (0, core_bentley_1.compareStrings)(lhs.propertyName, rhs.propertyName);
-                if (propertyNameCompareResult !== 0) {
-                    return propertyNameCompareResult;
-                }
-                return (0, core_bentley_1.compareStrings)(lhs.formattedPropertyValue, rhs.formattedPropertyValue);
-            }
-            case "property-grouping:range": {
-                (0, core_bentley_1.assert)(rhs.type === "property-grouping:range");
-                const propertyClassNameCompareResult = (0, core_bentley_1.compareStrings)(lhs.propertyClassName, rhs.propertyClassName);
-                if (propertyClassNameCompareResult !== 0) {
-                    return propertyClassNameCompareResult;
-                }
-                const propertyNameCompareResult = (0, core_bentley_1.compareStrings)(lhs.propertyName, rhs.propertyName);
-                if (propertyNameCompareResult !== 0) {
-                    return propertyNameCompareResult;
-                }
-                if (lhs.fromValue !== rhs.fromValue) {
-                    return lhs.fromValue > rhs.fromValue ? 1 : -1;
-                }
-                return lhs.toValue > rhs.toValue ? 1 : lhs.toValue < rhs.toValue ? -1 : 0;
-            }
-        }
-    }
-    HierarchyNodeKey.compare = compare;
-    /** Checks whether the two given keys are equal. */
-    function equals(lhs, rhs) {
-        return compare(lhs, rhs) === 0;
-    }
-    HierarchyNodeKey.equals = equals;
-})(HierarchyNodeKey || (exports.HierarchyNodeKey = HierarchyNodeKey = {}));
-//# sourceMappingURL=HierarchyNodeKey.js.map

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

@@ -1 +0,0 @@
-{"version":3,"file":"HierarchyNodeKey.js","sourceRoot":"","sources":["../../../src/hierarchies/HierarchyNodeKey.ts"],"names":[],"mappings":";AAAA;;;gGAGgG;;;AAEhG,sDAAwF;AACxF,oEAAyD;AA0JzD,cAAc;AACd,2DAA2D;AAC3D,IAAiB,gBAAgB,CAuJhC;AAvJD,WAAiB,gBAAgB;IAC/B,+DAA+D;IAC/D,SAAgB,SAAS,CAAC,GAAqB;QAC7C,OAAO,GAAG,CAAC,IAAI,KAAK,SAAS,CAAC;IAChC,CAAC;IAFe,0BAAS,YAExB,CAAA;IAED,yEAAyE;IACzE,SAAgB,eAAe,CAAC,GAAqB;QACnD,OAAO,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC;IACzB,CAAC;IAFe,gCAAe,kBAE9B,CAAA;IAED,kEAAkE;IAClE,SAAgB,WAAW,CAAC,GAAqB;QAC/C,OAAO,GAAG,CAAC,IAAI,KAAK,WAAW,CAAC;IAClC,CAAC;IAFe,4BAAW,cAE1B,CAAA;IAED,gEAAgE;IAChE,SAAgB,UAAU,CAAC,GAAqB;QAC9C,OAAO,CAAC,SAAS,CAAC,GAAG,CAAC,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC;IAC9C,CAAC;IAFe,2BAAU,aAEzB,CAAA;IAED,qEAAqE;IACrE,SAAgB,eAAe,CAAC,GAAqB;QACnD,OAAO,GAAG,CAAC,IAAI,KAAK,gBAAgB,CAAC;IACvC,CAAC;IAFe,gCAAe,kBAE9B,CAAA;IAED,qEAAqE;IACrE,SAAgB,eAAe,CAAC,GAAqB;QACnD,OAAO,GAAG,CAAC,IAAI,KAAK,gBAAgB,CAAC;IACvC,CAAC;IAFe,gCAAe,kBAE9B,CAAA;IAED,mFAAmF;IACnF,SAAgB,6BAA6B,CAAC,GAAqB;QACjE,OAAO,GAAG,CAAC,IAAI,KAAK,yBAAyB,CAAC;IAChD,CAAC;IAFe,8CAA6B,gCAE5C,CAAA;IAED,kFAAkF;IAClF,SAAgB,4BAA4B,CAAC,GAAqB;QAChE,OAAO,GAAG,CAAC,IAAI,KAAK,yBAAyB,CAAC;IAChD,CAAC;IAFe,6CAA4B,+BAE3C,CAAA;IAED,6EAA6E;IAC7E,SAAgB,uBAAuB,CAAC,GAAqB;QAC3D,OAAO,GAAG,CAAC,IAAI,KAAK,yBAAyB,CAAC;IAChD,CAAC;IAFe,wCAAuB,0BAEtC,CAAA;IAED,wEAAwE;IACxE,SAAgB,kBAAkB,CAAC,GAAqB;QACtD,OAAO,6BAA6B,CAAC,GAAG,CAAC,IAAI,4BAA4B,CAAC,GAAG,CAAC,IAAI,uBAAuB,CAAC,GAAG,CAAC,CAAC;IACjH,CAAC;IAFe,mCAAkB,qBAEjC,CAAA;IAED;;;;;OAKG;IACH,SAAgB,OAAO,CAAC,GAAqB,EAAE,GAAqB;QAClE,MAAM,iBAAiB,GAAG,IAAA,6BAAc,EAAC,GAAG,CAAC,IAAI,EAAE,GAAG,CAAC,IAAI,CAAC,CAAC;QAC7D,IAAI,iBAAiB,KAAK,CAAC,EAAE,CAAC;YAC5B,OAAO,iBAAiB,CAAC;QAC3B,CAAC;QACD,QAAQ,GAAG,CAAC,IAAI,EAAE,CAAC;YACjB,KAAK,SAAS,CAAC,CAAC,CAAC;gBACf,IAAA,qBAAM,EAAC,GAAG,CAAC,IAAI,KAAK,SAAS,CAAC,CAAC;gBAC/B,MAAM,eAAe,GAAG,IAAA,6BAAc,EAAC,GAAG,CAAC,EAAE,EAAE,GAAG,CAAC,EAAE,CAAC,CAAC;gBACvD,IAAI,eAAe,KAAK,CAAC,EAAE,CAAC;oBAC1B,OAAO,eAAe,CAAC;gBACzB,CAAC;gBACD,OAAO,IAAA,wCAAyB,EAAC,GAAG,CAAC,MAAM,EAAE,GAAG,CAAC,MAAM,CAAC,CAAC;YAC3D,CAAC;YACD,KAAK,WAAW,CAAC,CAAC,CAAC;gBACjB,IAAA,qBAAM,EAAC,GAAG,CAAC,IAAI,KAAK,WAAW,CAAC,CAAC;gBACjC,IAAI,GAAG,CAAC,YAAY,CAAC,MAAM,KAAK,GAAG,CAAC,YAAY,CAAC,MAAM,EAAE,CAAC;oBACxD,OAAO,GAAG,CAAC,YAAY,CAAC,MAAM,GAAG,GAAG,CAAC,YAAY,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;gBACpE,CAAC;gBACD,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,GAAG,CAAC,YAAY,CAAC,MAAM,EAAE,EAAE,CAAC,EAAE,CAAC;oBACjD,MAAM,wBAAwB,GAAG,iCAAW,CAAC,OAAO,CAAC,GAAG,CAAC,YAAY,CAAC,CAAC,CAAC,EAAE,GAAG,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,CAAC;oBAC/F,IAAI,wBAAwB,KAAK,CAAC,EAAE,CAAC;wBACnC,OAAO,wBAAwB,CAAC;oBAClC,CAAC;oBACD,MAAM,sBAAsB,GAAG,IAAA,wCAAyB,EAAC,GAAG,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,SAAS,EAAE,GAAG,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC;oBACvH,IAAI,sBAAsB,KAAK,CAAC,EAAE,CAAC;wBACjC,OAAO,sBAAsB,CAAC;oBAChC,CAAC;gBACH,CAAC;gBACD,OAAO,CAAC,CAAC;YACX,CAAC;YACD,KAAK,gBAAgB,CAAC,CAAC,CAAC;gBACtB,IAAA,qBAAM,EAAC,GAAG,CAAC,IAAI,KAAK,gBAAgB,CAAC,CAAC;gBACtC,OAAO,IAAA,6BAAc,EAAC,GAAG,CAAC,SAAS,EAAE,GAAG,CAAC,SAAS,CAAC,CAAC;YACtD,CAAC;YACD,KAAK,gBAAgB,CAAC,CAAC,CAAC;gBACtB,IAAA,qBAAM,EAAC,GAAG,CAAC,IAAI,KAAK,gBAAgB,CAAC,CAAC;gBACtC,MAAM,kBAAkB,GAAG,IAAA,6BAAc,EAAC,GAAG,CAAC,KAAK,EAAE,GAAG,CAAC,KAAK,CAAC,CAAC;gBAChE,IAAI,kBAAkB,KAAK,CAAC,EAAE,CAAC;oBAC7B,OAAO,kBAAkB,CAAC;gBAC5B,CAAC;gBACD,OAAO,IAAA,wCAAyB,EAAC,GAAG,CAAC,OAAO,EAAE,GAAG,CAAC,OAAO,CAAC,CAAC;YAC7D,CAAC;YACD,KAAK,yBAAyB,CAAC,CAAC,CAAC;gBAC/B,IAAA,qBAAM,EAAC,GAAG,CAAC,IAAI,KAAK,yBAAyB,CAAC,CAAC;gBAC/C,IAAI,GAAG,CAAC,UAAU,CAAC,MAAM,KAAK,GAAG,CAAC,UAAU,CAAC,MAAM,EAAE,CAAC;oBACpD,OAAO,GAAG,CAAC,UAAU,CAAC,MAAM,GAAG,GAAG,CAAC,UAAU,CAAC,MAAM,CAAC;gBACvD,CAAC;gBACD,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,GAAG,CAAC,UAAU,CAAC,MAAM,EAAE,EAAE,CAAC,EAAE,CAAC;oBAC/C,MAAM,kBAAkB,GAAG,IAAA,6BAAc,EAAC,GAAG,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,SAAS,EAAE,GAAG,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC;oBACpG,IAAI,kBAAkB,KAAK,CAAC,EAAE,CAAC;wBAC7B,OAAO,kBAAkB,CAAC;oBAC5B,CAAC;oBACD,MAAM,iBAAiB,GAAG,IAAA,6BAAc,EAAC,GAAG,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,YAAY,EAAE,GAAG,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,YAAY,CAAC,CAAC;oBACzG,IAAI,iBAAiB,KAAK,CAAC,EAAE,CAAC;wBAC5B,OAAO,iBAAiB,CAAC;oBAC3B,CAAC;gBACH,CAAC;gBACD,OAAO,CAAC,CAAC;YACX,CAAC;YACD,KAAK,yBAAyB,CAAC,CAAC,CAAC;gBAC/B,IAAA,qBAAM,EAAC,GAAG,CAAC,IAAI,KAAK,yBAAyB,CAAC,CAAC;gBAC/C,MAAM,8BAA8B,GAAG,IAAA,6BAAc,EAAC,GAAG,CAAC,iBAAiB,EAAE,GAAG,CAAC,iBAAiB,CAAC,CAAC;gBACpG,IAAI,8BAA8B,KAAK,CAAC,EAAE,CAAC;oBACzC,OAAO,8BAA8B,CAAC;gBACxC,CAAC;gBACD,MAAM,yBAAyB,GAAG,IAAA,6BAAc,EAAC,GAAG,CAAC,YAAY,EAAE,GAAG,CAAC,YAAY,CAAC,CAAC;gBACrF,IAAI,yBAAyB,KAAK,CAAC,EAAE,CAAC;oBACpC,OAAO,yBAAyB,CAAC;gBACnC,CAAC;gBACD,OAAO,IAAA,6BAAc,EAAC,GAAG,CAAC,sBAAsB,EAAE,GAAG,CAAC,sBAAsB,CAAC,CAAC;YAChF,CAAC;YACD,KAAK,yBAAyB,CAAC,CAAC,CAAC;gBAC/B,IAAA,qBAAM,EAAC,GAAG,CAAC,IAAI,KAAK,yBAAyB,CAAC,CAAC;gBAC/C,MAAM,8BAA8B,GAAG,IAAA,6BAAc,EAAC,GAAG,CAAC,iBAAiB,EAAE,GAAG,CAAC,iBAAiB,CAAC,CAAC;gBACpG,IAAI,8BAA8B,KAAK,CAAC,EAAE,CAAC;oBACzC,OAAO,8BAA8B,CAAC;gBACxC,CAAC;gBACD,MAAM,yBAAyB,GAAG,IAAA,6BAAc,EAAC,GAAG,CAAC,YAAY,EAAE,GAAG,CAAC,YAAY,CAAC,CAAC;gBACrF,IAAI,yBAAyB,KAAK,CAAC,EAAE,CAAC;oBACpC,OAAO,yBAAyB,CAAC;gBACnC,CAAC;gBACD,IAAI,GAAG,CAAC,SAAS,KAAK,GAAG,CAAC,SAAS,EAAE,CAAC;oBACpC,OAAO,GAAG,CAAC,SAAS,GAAG,GAAG,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;gBAChD,CAAC;gBACD,OAAO,GAAG,CAAC,OAAO,GAAG,GAAG,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,OAAO,GAAG,GAAG,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;YAC5E,CAAC;QACH,CAAC;IACH,CAAC;IAxFe,wBAAO,UAwFtB,CAAA;IAED,mDAAmD;IACnD,SAAgB,MAAM,CAAC,GAAqB,EAAE,GAAqB;QACjE,OAAO,OAAO,CAAC,GAAG,EAAE,GAAG,CAAC,KAAK,CAAC,CAAC;IACjC,CAAC;IAFe,uBAAM,SAErB,CAAA;AACH,CAAC,EAvJgB,gBAAgB,gCAAhB,gBAAgB,QAuJhC","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 { assert, compareStrings, compareStringsOrUndefined } from \"@itwin/core-bentley\";\nimport { InstanceKey } from \"@itwin/presentation-shared\";\n\n/**\n * An instance key that may be associated with specific iModel.\n * @public\n */\nexport interface IModelInstanceKey extends InstanceKey {\n  imodelKey?: string;\n}\n\n/**\n * A key for a generic node.\n * @public\n */\nexport interface GenericNodeKey {\n  /** Type of the node */\n  type: \"generic\";\n\n  /**\n   * Node key identifier, which uniquely identifies the node within the hierarchy level the node is used.\n   * The format of the identifier is not specified and is up to the data source.\n   */\n  id: string;\n\n  /**\n   * Optional data source identifier. Useful when a hierarchy is built using multiple hierarchy providers - in that\n   * case each provider can assign a unique source identifier to its nodes.\n   */\n  source?: string;\n}\n\n/**\n * A key for a node that represents one or more ECInstances.\n * @public\n */\nexport interface InstancesNodeKey {\n  /** Type of the node */\n  type: \"instances\";\n\n  /**\n   * Keys of ECInstances that are represented by the node. Generally, one node represents a single\n   * ECInstance, but in some cases (e.g. node merging) there could be more.\n   */\n  instanceKeys: IModelInstanceKey[];\n}\n\n/**\n * A key for a class-grouping node.\n * @public\n */\nexport interface ClassGroupingNodeKey {\n  /** Type of the node */\n  type: \"class-grouping\";\n\n  /** Full name of the ECClass that this grouping node is grouping by. */\n  className: string;\n}\n\n/**\n * A key for a label-grouping node.\n * @public\n */\nexport interface LabelGroupingNodeKey {\n  /** Type of the node */\n  type: \"label-grouping\";\n\n  /** Node label that this grouping node is grouping by. */\n  label: string;\n\n  /**\n   * Optional group identifier that is assigned to the node key when multiple nodes\n   * with the same label shouldn't be grouped together.\n   */\n  groupId?: string;\n}\n\n/**\n * A key property grouping node that groups nodes whose values don't fall into any other\n * property group in the hierarchy level.\n * @public\n */\nexport interface PropertyOtherValuesGroupingNodeKey {\n  /** Type of the node */\n  type: \"property-grouping:other\";\n  /** Identifiers of properties whose values are grouped under this node. */\n  properties: Array<{\n    className: string;\n    propertyName: string;\n  }>;\n}\n\n/**\n * A key for a property grouping node that groups nodes by formatted property value.\n * @public\n */\nexport interface PropertyValueGroupingNodeKey {\n  /** Type of the node */\n  type: \"property-grouping:value\";\n\n  /** Name of the property that is used for grouping nodes. */\n  propertyName: string;\n\n  /** Full name of the ECClass containing the property. */\n  propertyClassName: string;\n\n  /** Formatted property value that this node is grouping by. */\n  formattedPropertyValue: string;\n}\n\n/**\n * A key for a property grouping node that groups nodes by a range of property values.\n * @public\n */\nexport interface PropertyValueRangeGroupingNodeKey {\n  /** Type of the node */\n  type: \"property-grouping:range\";\n\n  /** Name of the property that is used for grouping nodes. */\n  propertyName: string;\n\n  /** Full name of the ECClass containing the property. */\n  propertyClassName: string;\n\n  /** Defines the start of the values' range that this node is grouping by. */\n  fromValue: number;\n\n  /** Defines the end of the values' range that this node is grouping by. */\n  toValue: number;\n}\n\n/**\n * A key for a property grouping node.\n * @public\n */\nexport type PropertyGroupingNodeKey = PropertyValueRangeGroupingNodeKey | PropertyValueGroupingNodeKey | PropertyOtherValuesGroupingNodeKey;\n\n/**\n * A key for one of the instance grouping nodes.\n * @public\n */\nexport type GroupingNodeKey = ClassGroupingNodeKey | LabelGroupingNodeKey | PropertyGroupingNodeKey;\n\n/**\n * A key for either an instance node or one of the instance grouping nodes.\n * @public\n */\nexport type IModelHierarchyNodeKey = InstancesNodeKey | GroupingNodeKey;\n\n/**\n * A key that uniquely identifies a node in a hierarchy level.\n * @public\n */\nexport type HierarchyNodeKey = IModelHierarchyNodeKey | GenericNodeKey;\n\n/** @public */\n// eslint-disable-next-line @typescript-eslint/no-redeclare\nexport namespace HierarchyNodeKey {\n  /** Checks whether the given node key is a generic node key. */\n  export function isGeneric(key: HierarchyNodeKey): key is GenericNodeKey {\n    return key.type === \"generic\";\n  }\n\n  /** Checks whether the given node key is a `StandardHierarchyNodeKey`. */\n  export function isIModelNodeKey(key: HierarchyNodeKey): key is IModelHierarchyNodeKey {\n    return !isGeneric(key);\n  }\n\n  /** Checks whether the given node key is an `InstancesNodeKey`. */\n  export function isInstances(key: HierarchyNodeKey): key is InstancesNodeKey {\n    return key.type === \"instances\";\n  }\n\n  /** Checks whether the given node key is a `GroupingNodeKey`. */\n  export function isGrouping(key: HierarchyNodeKey): key is GroupingNodeKey {\n    return !isGeneric(key) && !isInstances(key);\n  }\n\n  /** Checks whether the given node key is a `ClassGroupingNodeKey`. */\n  export function isClassGrouping(key: HierarchyNodeKey): key is ClassGroupingNodeKey {\n    return key.type === \"class-grouping\";\n  }\n\n  /** Checks whether the given node key is a `LabelGroupingNodeKey`. */\n  export function isLabelGrouping(key: HierarchyNodeKey): key is LabelGroupingNodeKey {\n    return key.type === \"label-grouping\";\n  }\n\n  /** Checks whether the given node key is a `PropertyOtherValuesGroupingNodeKey`. */\n  export function isPropertyOtherValuesGrouping(key: HierarchyNodeKey): key is PropertyOtherValuesGroupingNodeKey {\n    return key.type === \"property-grouping:other\";\n  }\n\n  /** Checks whether the given node key is a `PropertyValueRangeGroupingNodeKey`. */\n  export function isPropertyValueRangeGrouping(key: HierarchyNodeKey): key is PropertyValueRangeGroupingNodeKey {\n    return key.type === \"property-grouping:range\";\n  }\n\n  /** Checks whether the given node key is a `PropertyValueGroupingNodeKey`. */\n  export function isPropertyValueGrouping(key: HierarchyNodeKey): key is PropertyValueGroupingNodeKey {\n    return key.type === \"property-grouping:value\";\n  }\n\n  /** Checks whether the given node key is a `PropertyGroupingNodeKey`. */\n  export function isPropertyGrouping(key: HierarchyNodeKey): key is PropertyGroupingNodeKey {\n    return isPropertyOtherValuesGrouping(key) || isPropertyValueRangeGrouping(key) || isPropertyValueGrouping(key);\n  }\n\n  /**\n   * Compares two given keys. Returns:\n   * - `0` if they are equal,\n   * - `negative value` if lhs key is less than rhs key,\n   * - `positive value` if lhs key is more than rhs key.\n   */\n  export function compare(lhs: HierarchyNodeKey, rhs: HierarchyNodeKey): number {\n    const typeCompareResult = compareStrings(lhs.type, rhs.type);\n    if (typeCompareResult !== 0) {\n      return typeCompareResult;\n    }\n    switch (lhs.type) {\n      case \"generic\": {\n        assert(rhs.type === \"generic\");\n        const idCompareResult = compareStrings(lhs.id, rhs.id);\n        if (idCompareResult !== 0) {\n          return idCompareResult;\n        }\n        return compareStringsOrUndefined(lhs.source, rhs.source);\n      }\n      case \"instances\": {\n        assert(rhs.type === \"instances\");\n        if (lhs.instanceKeys.length !== rhs.instanceKeys.length) {\n          return lhs.instanceKeys.length > rhs.instanceKeys.length ? 1 : -1;\n        }\n        for (let i = 0; i < lhs.instanceKeys.length; ++i) {\n          const instanceKeyCompareResult = InstanceKey.compare(lhs.instanceKeys[i], rhs.instanceKeys[i]);\n          if (instanceKeyCompareResult !== 0) {\n            return instanceKeyCompareResult;\n          }\n          const imodelKeyCompareResult = compareStringsOrUndefined(lhs.instanceKeys[0].imodelKey, rhs.instanceKeys[0].imodelKey);\n          if (imodelKeyCompareResult !== 0) {\n            return imodelKeyCompareResult;\n          }\n        }\n        return 0;\n      }\n      case \"class-grouping\": {\n        assert(rhs.type === \"class-grouping\");\n        return compareStrings(lhs.className, rhs.className);\n      }\n      case \"label-grouping\": {\n        assert(rhs.type === \"label-grouping\");\n        const labelCompareResult = compareStrings(lhs.label, rhs.label);\n        if (labelCompareResult !== 0) {\n          return labelCompareResult;\n        }\n        return compareStringsOrUndefined(lhs.groupId, rhs.groupId);\n      }\n      case \"property-grouping:other\": {\n        assert(rhs.type === \"property-grouping:other\");\n        if (lhs.properties.length !== rhs.properties.length) {\n          return lhs.properties.length - rhs.properties.length;\n        }\n        for (let i = 0; i < lhs.properties.length; ++i) {\n          const classCompareResult = compareStrings(lhs.properties[i].className, rhs.properties[i].className);\n          if (classCompareResult !== 0) {\n            return classCompareResult;\n          }\n          const nameCompareResult = compareStrings(lhs.properties[i].propertyName, rhs.properties[i].propertyName);\n          if (nameCompareResult !== 0) {\n            return nameCompareResult;\n          }\n        }\n        return 0;\n      }\n      case \"property-grouping:value\": {\n        assert(rhs.type === \"property-grouping:value\");\n        const propertyClassNameCompareResult = compareStrings(lhs.propertyClassName, rhs.propertyClassName);\n        if (propertyClassNameCompareResult !== 0) {\n          return propertyClassNameCompareResult;\n        }\n        const propertyNameCompareResult = compareStrings(lhs.propertyName, rhs.propertyName);\n        if (propertyNameCompareResult !== 0) {\n          return propertyNameCompareResult;\n        }\n        return compareStrings(lhs.formattedPropertyValue, rhs.formattedPropertyValue);\n      }\n      case \"property-grouping:range\": {\n        assert(rhs.type === \"property-grouping:range\");\n        const propertyClassNameCompareResult = compareStrings(lhs.propertyClassName, rhs.propertyClassName);\n        if (propertyClassNameCompareResult !== 0) {\n          return propertyClassNameCompareResult;\n        }\n        const propertyNameCompareResult = compareStrings(lhs.propertyName, rhs.propertyName);\n        if (propertyNameCompareResult !== 0) {\n          return propertyNameCompareResult;\n        }\n        if (lhs.fromValue !== rhs.fromValue) {\n          return lhs.fromValue > rhs.fromValue ? 1 : -1;\n        }\n        return lhs.toValue > rhs.toValue ? 1 : lhs.toValue < rhs.toValue ? -1 : 0;\n      }\n    }\n  }\n\n  /** Checks whether the two given keys are equal. */\n  export function equals(lhs: HierarchyNodeKey, rhs: HierarchyNodeKey): boolean {\n    return compare(lhs, rhs) === 0;\n  }\n}\n"]}

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

@@ -1,109 +0,0 @@
-import "./internal/DisposePolyfill.js";
-import { GenericInstanceFilter } from "@itwin/core-common";
-import { Event, InstanceKey, IPrimitiveValueFormatter, Props } from "@itwin/presentation-shared";
-import { HierarchyFilteringPath } from "./HierarchyFiltering.js";
-import { HierarchyNode, ParentHierarchyNode } from "./HierarchyNode.js";
-/**
- * Props for the `HierarchyProvider.getNodes` call.
- * @public
- */
-export interface GetHierarchyNodesProps {
-    /** Parent node to get children for. Pass `undefined` to get root nodes. */
-    parentNode: ParentHierarchyNode | undefined;
-    /** Optional hierarchy level filter. Has no effect if `parentNode` is a `GroupingNode`. */
-    instanceFilter?: GenericInstanceFilter;
-    /**
-     * Optional hierarchy level size limit override. This value is passed to `LimitingECSqlQueryExecutor` used
-     * by this provider to override query rows limit per hierarchy level. If not provided, defaults to whatever
-     * is used by the limiting query executor.
-     *
-     * Has no effect if `parentNode` is a `GroupingNode`.
-     */
-    hierarchyLevelSizeLimit?: number | "unbounded";
-    /** When set to `true` ignores the cache and fetches the nodes again. */
-    ignoreCache?: boolean;
-}
-/**
- * Event arguments for `HierarchyProvider.hierarchyChanged` event.
- * @public
- */
-interface HierarchyChangedEventArgs {
-    /** Set when the hierarchy change was caused by a formatter change. */
-    formatterChange?: {
-        newFormatter: IPrimitiveValueFormatter | undefined;
-    };
-    /** Set when the hierarchy change was caused by a hierarchy filter change. */
-    filterChange?: {
-        newFilter: Props<HierarchyProvider["setHierarchyFilter"]>;
-    };
-}
-/**
- * An interface for a hierarchy provider that knows how to create child nodes for a given parent node.
- * @public
- */
-export interface HierarchyProvider {
-    /**
-     * An event that provider raises due to a hierarchy change, that requires a reload. Provider may
-     * set additional event arguments to provide extra information about what caused the change.
-     *
-     * Consumers are expected to subscribe to this event and reload the hierarchy when it's raised.
-     * Implementations may provide additional details on what caused the change through the optional
-     * event arguments.
-     */
-    readonly hierarchyChanged: Event<(args?: HierarchyChangedEventArgs) => void>;
-    /**
-     * Gets nodes for the specified parent node. This is **the method to implement**, otherwise
-     * the provider doesn't return any nodes.
-     */
-    getNodes(props: GetHierarchyNodesProps): AsyncIterableIterator<HierarchyNode>;
-    /**
-     * Gets instance keys for the specified parent node.
-     *
-     * The result of this method may be used to determine instances whose nodes would be displayed as children
-     * of the specified parent node. For such use cases calling this method should be more efficient compared
-     * to calling `getNodes`.
-     */
-    getNodeInstanceKeys(props: Omit<GetHierarchyNodesProps, "ignoreCache">): AsyncIterableIterator<InstanceKey>;
-    /**
-     * Overrides the property value formatter used by the hierarchy provider. Setting to `undefined`
-     * resets the formatter, but what that means depends on the provider implementation - it could just
-     * use unformatted values, or use some default formatter, e.g. the on created by `createDefaultValueFormatter`
-     * from `@itwin/presentation-shared` package.
-     *
-     * @note Changing formatter is expected to trigger the `hierarchyChanged` event with `formatterChange` arg.
-     */
-    setFormatter(formatter: IPrimitiveValueFormatter | undefined): void;
-    /**
-     * Sets the hierarchy filter used by this hierarchy provider. Setting to `undefined`
-     * removes the filter.
-     *
-     * @note There's a difference between `undefined` filter and filter with empty paths list. The
-     * former means no filter is applied, while the latter means the filter is applied and it filters-out
-     * all hierarchy.
-     *
-     * @note Changing filter is expected to trigger the `hierarchyChanged` event with `filterChange` arg.
-     */
-    setHierarchyFilter(props: {
-        /** A list of node identifiers from root to target node. */
-        paths: HierarchyFilteringPath[];
-    } | undefined): void;
-}
-/**
- * Props for `mergeProviders` function.
- * @public
- */
-interface MergeHierarchyProvidersProps {
-    /** List of providers to merge. */
-    providers: HierarchyProvider[];
-}
-/**
- * Creates a single, merged, hierarchy provider from multiple given providers.
- * @public
- */
-export declare function mergeProviders({ providers }: MergeHierarchyProvidersProps): HierarchyProvider & {
-    /** @deprecated in 1.4. Use `[Symbol.dispose]` instead. */
-    dispose: () => void;
-    [Symbol.dispose]: () => void;
-};
-export {};
-//# sourceMappingURL=HierarchyProvider.d.ts.map

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

@@ -1 +0,0 @@
-{"version":3,"file":"HierarchyProvider.d.ts","sourceRoot":"","sources":["../../../src/hierarchies/HierarchyProvider.ts"],"names":[],"mappings":"AAKA,OAAO,+BAA+B,CAAC;AAGvC,OAAO,EAAE,qBAAqB,EAAE,MAAM,oBAAoB,CAAC;AAC3D,OAAO,EAAE,KAAK,EAAE,WAAW,EAAE,wBAAwB,EAAE,KAAK,EAAE,MAAM,4BAA4B,CAAC;AACjG,OAAO,EAAE,sBAAsB,EAAE,MAAM,yBAAyB,CAAC;AACjE,OAAO,EAAE,aAAa,EAAE,mBAAmB,EAAE,MAAM,oBAAoB,CAAC;AAKxE;;;GAGG;AACH,MAAM,WAAW,sBAAsB;IACrC,2EAA2E;IAC3E,UAAU,EAAE,mBAAmB,GAAG,SAAS,CAAC;IAE5C,0FAA0F;IAC1F,cAAc,CAAC,EAAE,qBAAqB,CAAC;IAEvC;;;;;;OAMG;IACH,uBAAuB,CAAC,EAAE,MAAM,GAAG,WAAW,CAAC;IAE/C,wEAAwE;IACxE,WAAW,CAAC,EAAE,OAAO,CAAC;CACvB;AAED;;;GAGG;AACH,UAAU,yBAAyB;IACjC,sEAAsE;IACtE,eAAe,CAAC,EAAE;QAChB,YAAY,EAAE,wBAAwB,GAAG,SAAS,CAAC;KACpD,CAAC;IAEF,6EAA6E;IAC7E,YAAY,CAAC,EAAE;QACb,SAAS,EAAE,KAAK,CAAC,iBAAiB,CAAC,oBAAoB,CAAC,CAAC,CAAC;KAC3D,CAAC;CACH;AAED;;;GAGG;AACH,MAAM,WAAW,iBAAiB;IAChC;;;;;;;OAOG;IACH,QAAQ,CAAC,gBAAgB,EAAE,KAAK,CAAC,CAAC,IAAI,CAAC,EAAE,yBAAyB,KAAK,IAAI,CAAC,CAAC;IAE7E;;;OAGG;IACH,QAAQ,CAAC,KAAK,EAAE,sBAAsB,GAAG,qBAAqB,CAAC,aAAa,CAAC,CAAC;IAE9E;;;;;;OAMG;IACH,mBAAmB,CAAC,KAAK,EAAE,IAAI,CAAC,sBAAsB,EAAE,aAAa,CAAC,GAAG,qBAAqB,CAAC,WAAW,CAAC,CAAC;IAE5G;;;;;;;OAOG;IACH,YAAY,CAAC,SAAS,EAAE,wBAAwB,GAAG,SAAS,GAAG,IAAI,CAAC;IAEpE;;;;;;;;;OASG;IACH,kBAAkB,CAChB,KAAK,EACD;QACE,2DAA2D;QAC3D,KAAK,EAAE,sBAAsB,EAAE,CAAC;KACjC,GACD,SAAS,GACZ,IAAI,CAAC;CACT;AAED;;;GAGG;AACH,UAAU,4BAA4B;IACpC,kCAAkC;IAClC,SAAS,EAAE,iBAAiB,EAAE,CAAC;CAChC;AAED;;;GAGG;AACH,wBAAgB,cAAc,CAAC,EAAE,SAAS,EAAE,EAAE,4BAA4B,GAAG,iBAAiB,GAAG;IAC/F,0DAA0D;IAC1D,OAAO,EAAE,MAAM,IAAI,CAAC;IACpB,CAAC,MAAM,CAAC,OAAO,CAAC,EAAE,MAAM,IAAI,CAAC;CAC9B,CA2CA"}

package/lib/cjs/hierarchies/HierarchyProvider.js

@@ -1,44 +0,0 @@
-"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.mergeProviders = mergeProviders;
-require("./internal/DisposePolyfill.js");
-const rxjs_1 = require("rxjs");
-const core_bentley_1 = require("@itwin/core-bentley");
-const Common_js_1 = require("./internal/Common.js");
-const EachValueFrom_js_1 = require("./internal/EachValueFrom.js");
-const Sorting_js_1 = require("./internal/operators/Sorting.js");
-/**
- * Creates a single, merged, hierarchy provider from multiple given providers.
- * @public
- */
-function mergeProviders({ providers }) {
-    const hierarchyChanged = new core_bentley_1.BeEvent();
-    providers.forEach((p) => {
-        p.hierarchyChanged.addListener(() => hierarchyChanged.raiseEvent());
-    });
-    const dispose = () => {
-        hierarchyChanged.clear();
-        providers.forEach((p) => (0, Common_js_1.safeDispose)(p));
-    };
-    return {
-        hierarchyChanged,
-        getNodes: (props) => (0, EachValueFrom_js_1.eachValueFrom)((0, rxjs_1.from)(providers).pipe((0, rxjs_1.mergeMap)((provider) => (0, rxjs_1.from)(provider.getNodes(props)).pipe((0, rxjs_1.mergeMap)((node) => {
-            if (node.children) {
-                return (0, rxjs_1.of)(node);
-            }
-            // each provider only considers its own data when determining node's children - in case it says
-            // the node has no children, we have to check against the other providers too
-            return (0, rxjs_1.from)(providers).pipe((0, rxjs_1.filter)((p) => p !== provider), (0, rxjs_1.mergeMap)((p) => p.getNodes({ parentNode: node })), (0, rxjs_1.map)(() => true), (0, rxjs_1.first)(undefined, false), (0, rxjs_1.map)((hasChildren) => ({ ...node, children: hasChildren })));
-        }))), Sorting_js_1.sortNodesByLabelOperator)),
-        getNodeInstanceKeys: (props) => (0, EachValueFrom_js_1.eachValueFrom)((0, rxjs_1.from)(providers).pipe((0, rxjs_1.mergeMap)((p) => p.getNodeInstanceKeys(props)))),
-        setFormatter: (formatter) => providers.forEach((p) => p.setFormatter(formatter)),
-        setHierarchyFilter: (props) => providers.forEach((p) => p.setHierarchyFilter(props)),
-        [Symbol.dispose]: dispose,
-        dispose,
-    };
-}
-//# sourceMappingURL=HierarchyProvider.js.map

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

@@ -1 +0,0 @@
-{"version":3,"file":"HierarchyProvider.js","sourceRoot":"","sources":["../../../src/hierarchies/HierarchyProvider.ts"],"names":[],"mappings":";AAAA;;;gGAGgG;;AA8HhG,wCA+CC;AA3KD,yCAAuC;AACvC,+BAA8D;AAC9D,sDAA8C;AAK9C,oDAAmD;AACnD,kEAA4D;AAC5D,gEAA2E;AA+G3E;;;GAGG;AACH,SAAgB,cAAc,CAAC,EAAE,SAAS,EAAgC;IAKxE,MAAM,gBAAgB,GAAG,IAAI,sBAAO,EAAc,CAAC;IACnD,SAAS,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,EAAE;QACtB,CAAC,CAAC,gBAAgB,CAAC,WAAW,CAAC,GAAG,EAAE,CAAC,gBAAgB,CAAC,UAAU,EAAE,CAAC,CAAC;IACtE,CAAC,CAAC,CAAC;IACH,MAAM,OAAO,GAAG,GAAG,EAAE;QACnB,gBAAgB,CAAC,KAAK,EAAE,CAAC;QACzB,SAAS,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,IAAA,uBAAW,EAAC,CAAC,CAAC,CAAC,CAAC;IAC3C,CAAC,CAAC;IAEF,OAAO;QACL,gBAAgB;QAChB,QAAQ,EAAE,CAAC,KAAK,EAAE,EAAE,CAClB,IAAA,gCAAa,EACX,IAAA,WAAI,EAAC,SAAS,CAAC,CAAC,IAAI,CAClB,IAAA,eAAQ,EAAC,CAAC,QAAQ,EAAE,EAAE,CACpB,IAAA,WAAI,EAAC,QAAQ,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,CACjC,IAAA,eAAQ,EAAC,CAAC,IAAI,EAAE,EAAE;YAChB,IAAI,IAAI,CAAC,QAAQ,EAAE,CAAC;gBAClB,OAAO,IAAA,SAAE,EAAC,IAAI,CAAC,CAAC;YAClB,CAAC;YACD,+FAA+F;YAC/F,6EAA6E;YAC7E,OAAO,IAAA,WAAI,EAAC,SAAS,CAAC,CAAC,IAAI,CACzB,IAAA,aAAM,EAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,KAAK,QAAQ,CAAC,EAC7B,IAAA,eAAQ,EAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,QAAQ,CAAC,EAAE,UAAU,EAAE,IAAI,EAAE,CAAC,CAAC,EACjD,IAAA,UAAG,EAAC,GAAG,EAAE,CAAC,IAAI,CAAC,EACf,IAAA,YAAK,EAAC,SAAS,EAAE,KAAK,CAAC,EACvB,IAAA,UAAG,EAAC,CAAC,WAAW,EAAE,EAAE,CAAC,CAAC,EAAE,GAAG,IAAI,EAAE,QAAQ,EAAE,WAAW,EAAE,CAAC,CAAC,CAC3D,CAAC;QACJ,CAAC,CAAC,CACH,CACF,EACD,qCAAwB,CAEzB,CACF;QACH,mBAAmB,EAAE,CAAC,KAAK,EAAE,EAAE,CAAC,IAAA,gCAAa,EAAC,IAAA,WAAI,EAAC,SAAS,CAAC,CAAC,IAAI,CAAC,IAAA,eAAQ,EAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,mBAAmB,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;QAClH,YAAY,EAAE,CAAC,SAAS,EAAE,EAAE,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,YAAY,CAAC,SAAS,CAAC,CAAC;QAChF,kBAAkB,EAAE,CAAC,KAAK,EAAE,EAAE,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,kBAAkB,CAAC,KAAK,CAAC,CAAC;QACpF,CAAC,MAAM,CAAC,OAAO,CAAC,EAAE,OAAO;QACzB,OAAO;KACR,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 \"./internal/DisposePolyfill.js\";\nimport { filter, first, from, map, mergeMap, of } from \"rxjs\";\nimport { BeEvent } from \"@itwin/core-bentley\";\nimport { GenericInstanceFilter } from \"@itwin/core-common\";\nimport { Event, InstanceKey, IPrimitiveValueFormatter, Props } from \"@itwin/presentation-shared\";\nimport { HierarchyFilteringPath } from \"./HierarchyFiltering.js\";\nimport { HierarchyNode, ParentHierarchyNode } from \"./HierarchyNode.js\";\nimport { safeDispose } from \"./internal/Common.js\";\nimport { eachValueFrom } from \"./internal/EachValueFrom.js\";\nimport { sortNodesByLabelOperator } from \"./internal/operators/Sorting.js\";\n\n/**\n * Props for the `HierarchyProvider.getNodes` call.\n * @public\n */\nexport interface GetHierarchyNodesProps {\n  /** Parent node to get children for. Pass `undefined` to get root nodes. */\n  parentNode: ParentHierarchyNode | undefined;\n\n  /** Optional hierarchy level filter. Has no effect if `parentNode` is a `GroupingNode`. */\n  instanceFilter?: GenericInstanceFilter;\n\n  /**\n   * Optional hierarchy level size limit override. This value is passed to `LimitingECSqlQueryExecutor` used\n   * by this provider to override query rows limit per hierarchy level. If not provided, defaults to whatever\n   * is used by the limiting query executor.\n   *\n   * Has no effect if `parentNode` is a `GroupingNode`.\n   */\n  hierarchyLevelSizeLimit?: number | \"unbounded\";\n\n  /** When set to `true` ignores the cache and fetches the nodes again. */\n  ignoreCache?: boolean;\n}\n\n/**\n * Event arguments for `HierarchyProvider.hierarchyChanged` event.\n * @public\n */\ninterface HierarchyChangedEventArgs {\n  /** Set when the hierarchy change was caused by a formatter change. */\n  formatterChange?: {\n    newFormatter: IPrimitiveValueFormatter | undefined;\n  };\n\n  /** Set when the hierarchy change was caused by a hierarchy filter change. */\n  filterChange?: {\n    newFilter: Props<HierarchyProvider[\"setHierarchyFilter\"]>;\n  };\n}\n\n/**\n * An interface for a hierarchy provider that knows how to create child nodes for a given parent node.\n * @public\n */\nexport interface HierarchyProvider {\n  /**\n   * An event that provider raises due to a hierarchy change, that requires a reload. Provider may\n   * set additional event arguments to provide extra information about what caused the change.\n   *\n   * Consumers are expected to subscribe to this event and reload the hierarchy when it's raised.\n   * Implementations may provide additional details on what caused the change through the optional\n   * event arguments.\n   */\n  readonly hierarchyChanged: Event<(args?: HierarchyChangedEventArgs) => void>;\n\n  /**\n   * Gets nodes for the specified parent node. This is **the method to implement**, otherwise\n   * the provider doesn't return any nodes.\n   */\n  getNodes(props: GetHierarchyNodesProps): AsyncIterableIterator<HierarchyNode>;\n\n  /**\n   * Gets instance keys for the specified parent node.\n   *\n   * The result of this method may be used to determine instances whose nodes would be displayed as children\n   * of the specified parent node. For such use cases calling this method should be more efficient compared\n   * to calling `getNodes`.\n   */\n  getNodeInstanceKeys(props: Omit<GetHierarchyNodesProps, \"ignoreCache\">): AsyncIterableIterator<InstanceKey>;\n\n  /**\n   * Overrides the property value formatter used by the hierarchy provider. Setting to `undefined`\n   * resets the formatter, but what that means depends on the provider implementation - it could just\n   * use unformatted values, or use some default formatter, e.g. the on created by `createDefaultValueFormatter`\n   * from `@itwin/presentation-shared` package.\n   *\n   * @note Changing formatter is expected to trigger the `hierarchyChanged` event with `formatterChange` arg.\n   */\n  setFormatter(formatter: IPrimitiveValueFormatter | undefined): void;\n\n  /**\n   * Sets the hierarchy filter used by this hierarchy provider. Setting to `undefined`\n   * removes the filter.\n   *\n   * @note There's a difference between `undefined` filter and filter with empty paths list. The\n   * former means no filter is applied, while the latter means the filter is applied and it filters-out\n   * all hierarchy.\n   *\n   * @note Changing filter is expected to trigger the `hierarchyChanged` event with `filterChange` arg.\n   */\n  setHierarchyFilter(\n    props:\n      | {\n          /** A list of node identifiers from root to target node. */\n          paths: HierarchyFilteringPath[];\n        }\n      | undefined,\n  ): void;\n}\n\n/**\n * Props for `mergeProviders` function.\n * @public\n */\ninterface MergeHierarchyProvidersProps {\n  /** List of providers to merge. */\n  providers: HierarchyProvider[];\n}\n\n/**\n * Creates a single, merged, hierarchy provider from multiple given providers.\n * @public\n */\nexport function mergeProviders({ providers }: MergeHierarchyProvidersProps): HierarchyProvider & {\n  /** @deprecated in 1.4. Use `[Symbol.dispose]` instead. */\n  dispose: () => void;\n  [Symbol.dispose]: () => void;\n} {\n  const hierarchyChanged = new BeEvent<() => void>();\n  providers.forEach((p) => {\n    p.hierarchyChanged.addListener(() => hierarchyChanged.raiseEvent());\n  });\n  const dispose = () => {\n    hierarchyChanged.clear();\n    providers.forEach((p) => safeDispose(p));\n  };\n\n  return {\n    hierarchyChanged,\n    getNodes: (props) =>\n      eachValueFrom(\n        from(providers).pipe(\n          mergeMap((provider) =>\n            from(provider.getNodes(props)).pipe(\n              mergeMap((node) => {\n                if (node.children) {\n                  return of(node);\n                }\n                // each provider only considers its own data when determining node's children - in case it says\n                // the node has no children, we have to check against the other providers too\n                return from(providers).pipe(\n                  filter((p) => p !== provider),\n                  mergeMap((p) => p.getNodes({ parentNode: node })),\n                  map(() => true),\n                  first(undefined, false),\n                  map((hasChildren) => ({ ...node, children: hasChildren })),\n                );\n              }),\n            ),\n          ),\n          sortNodesByLabelOperator,\n          // TODO: consider merging similar nodes\n        ),\n      ),\n    getNodeInstanceKeys: (props) => eachValueFrom(from(providers).pipe(mergeMap((p) => p.getNodeInstanceKeys(props)))),\n    setFormatter: (formatter) => providers.forEach((p) => p.setFormatter(formatter)),\n    setHierarchyFilter: (props) => providers.forEach((p) => p.setHierarchyFilter(props)),\n    [Symbol.dispose]: dispose,\n    dispose,\n  };\n}\n"]}

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

@@ -1 +0,0 @@
-{"version":3,"file":"Logging.d.ts","sourceRoot":"","sources":["../../../src/hierarchies/Logging.ts"],"names":[],"mappings":"AAKA,OAAO,EAAE,OAAO,EAAe,MAAM,4BAA4B,CAAC;AAKlE;;;GAGG;AACH,wBAAgB,SAAS,CAAC,MAAM,EAAE,OAAO,GAAG,SAAS,QAEpD;AAED;;;;GAIG;AACH,wBAAgB,SAAS,IAAI,OAAO,CAEnC"}

package/lib/cjs/hierarchies/Logging.js

@@ -1,27 +0,0 @@
-"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.setLogger = setLogger;
-exports.getLogger = getLogger;
-const presentation_shared_1 = require("@itwin/presentation-shared");
-// eslint-disable-next-line @typescript-eslint/naming-convention
-let g_logger = presentation_shared_1.NOOP_LOGGER;
-/**
- * Set logger to use by this package. By default the package uses a no-op logger.
- * @public
- */
-function setLogger(logger) {
-    g_logger = logger ?? /* c8 ignore next */ presentation_shared_1.NOOP_LOGGER;
-}
-/**
- * Get logger used by this package.
- * @see `setLogger`
- * @public
- */
-function getLogger() {
-    return g_logger;
-}
-//# sourceMappingURL=Logging.js.map

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

@@ -1 +0,0 @@
-{"version":3,"file":"Logging.js","sourceRoot":"","sources":["../../../src/hierarchies/Logging.ts"],"names":[],"mappings":";AAAA;;;gGAGgG;;AAWhG,8BAEC;AAOD,8BAEC;AApBD,oEAAkE;AAElE,gEAAgE;AAChE,IAAI,QAAQ,GAAY,iCAAW,CAAC;AAEpC;;;GAGG;AACH,SAAgB,SAAS,CAAC,MAA2B;IACnD,QAAQ,GAAG,MAAM,IAAI,oBAAoB,CAAC,iCAAW,CAAC;AACxD,CAAC;AAED;;;;GAIG;AACH,SAAgB,SAAS;IACvB,OAAO,QAAQ,CAAC;AAClB,CAAC","sourcesContent":["/*---------------------------------------------------------------------------------------------\n * Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n * See LICENSE.md in the project root for license terms and full copyright notice.\n *--------------------------------------------------------------------------------------------*/\n\nimport { ILogger, NOOP_LOGGER } from \"@itwin/presentation-shared\";\n\n// eslint-disable-next-line @typescript-eslint/naming-convention\nlet g_logger: ILogger = NOOP_LOGGER;\n\n/**\n * Set logger to use by this package. By default the package uses a no-op logger.\n * @public\n */\nexport function setLogger(logger: ILogger | undefined) {\n  g_logger = logger ?? /* c8 ignore next */ NOOP_LOGGER;\n}\n\n/**\n * Get logger used by this package.\n * @see `setLogger`\n * @public\n */\nexport function getLogger(): ILogger {\n  return g_logger;\n}\n"]}

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

@@ -1,36 +0,0 @@
-import { Observable } from "rxjs";
-import { ECClassHierarchyInspector, InstanceKey } from "@itwin/presentation-shared";
-import { HierarchyFilteringPath } from "../HierarchyFiltering.js";
-import { DefineHierarchyLevelProps, HierarchyLevelDefinition, InstanceNodesQueryDefinition } from "../imodel/IModelHierarchyDefinition.js";
-import { RxjsHierarchyDefinition, RxjsNodeParser, RxjsNodePostProcessor, RxjsNodePreProcessor } from "../internal/RxjsHierarchyDefinition.js";
-interface FilteringHierarchyDefinitionProps {
-    imodelAccess: ECClassHierarchyInspector & {
-        imodelKey: string;
-    };
-    source: RxjsHierarchyDefinition;
-    nodeIdentifierPaths: HierarchyFilteringPath[];
-    nodesParser?: RxjsNodeParser;
-}
-/** @internal */
-export declare class FilteringHierarchyDefinition implements RxjsHierarchyDefinition {
-    private _imodelAccess;
-    private _source;
-    private _nodeIdentifierPaths;
-    private _nodesParser;
-    constructor(props: FilteringHierarchyDefinitionProps);
-    get preProcessNode(): RxjsNodePreProcessor;
-    private shouldExpandGroupingNode;
-    get postProcessNode(): RxjsNodePostProcessor;
-    get parseNode(): RxjsNodeParser;
-    defineHierarchyLevel(props: DefineHierarchyLevelProps): Observable<HierarchyLevelDefinition>;
-}
-/** @internal */
-export declare const ECSQL_COLUMN_NAME_FilterECInstanceId = "FilterECInstanceId";
-/** @internal */
-export declare const ECSQL_COLUMN_NAME_FilterClassName = "FilterClassName";
-/** @internal */
-export declare function applyECInstanceIdsFilter(def: InstanceNodesQueryDefinition, filteredInstanceKeys: InstanceKey[]): InstanceNodesQueryDefinition;
-/** @internal */
-export declare function applyECInstanceIdsSelector(def: InstanceNodesQueryDefinition): InstanceNodesQueryDefinition;
-export {};
-//# sourceMappingURL=FilteringHierarchyDefinition.d.ts.map

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

@@ -1 +0,0 @@
-{"version":3,"file":"FilteringHierarchyDefinition.d.ts","sourceRoot":"","sources":["../../../../src/hierarchies/imodel/FilteringHierarchyDefinition.ts"],"names":[],"mappings":"AAKA,OAAO,EAAuD,UAAU,EAAe,MAAM,MAAM,CAAC;AAEpG,OAAO,EAAE,yBAAyB,EAAE,WAAW,EAAE,MAAM,4BAA4B,CAAC;AACpF,OAAO,EAAkC,sBAAsB,EAAE,MAAM,0BAA0B,CAAC;AAGlG,OAAO,EACL,yBAAyB,EAEzB,wBAAwB,EAExB,4BAA4B,EAC7B,MAAM,wCAAwC,CAAC;AAKhD,OAAO,EAAE,uBAAuB,EAAE,cAAc,EAAE,qBAAqB,EAAE,oBAAoB,EAAE,MAAM,wCAAwC,CAAC;AAE9I,UAAU,iCAAiC;IACzC,YAAY,EAAE,yBAAyB,GAAG;QAAE,SAAS,EAAE,MAAM,CAAA;KAAE,CAAC;IAChE,MAAM,EAAE,uBAAuB,CAAC;IAChC,mBAAmB,EAAE,sBAAsB,EAAE,CAAC;IAC9C,WAAW,CAAC,EAAE,cAAc,CAAC;CAC9B;AAED,gBAAgB;AAChB,qBAAa,4BAA6B,YAAW,uBAAuB;IAC1E,OAAO,CAAC,aAAa,CAAoD;IACzE,OAAO,CAAC,OAAO,CAA0B;IACzC,OAAO,CAAC,oBAAoB,CAA2B;IACvD,OAAO,CAAC,YAAY,CAAiB;gBAElB,KAAK,EAAE,iCAAiC;IAO3D,IAAW,cAAc,IAAI,oBAAoB,CAYhD;IAED,OAAO,CAAC,wBAAwB;IA6ChC,IAAW,eAAe,IAAI,qBAAqB,CAYlD;IAED,IAAW,SAAS,IAAI,cAAc,CAiDrC;IAEM,oBAAoB,CAAC,KAAK,EAAE,yBAAyB,GAAG,UAAU,CAAC,wBAAwB,CAAC;CAoGpG;AAED,gBAAgB;AAEhB,eAAO,MAAM,oCAAoC,uBAAuB,CAAC;AAEzE,gBAAgB;AAEhB,eAAO,MAAM,iCAAiC,oBAAoB,CAAC;AAenE,gBAAgB;AAChB,wBAAgB,wBAAwB,CAAC,GAAG,EAAE,4BAA4B,EAAE,oBAAoB,EAAE,WAAW,EAAE,GAAG,4BAA4B,CAgC7I;AAED,gBAAgB;AAChB,wBAAgB,0BAA0B,CAAC,GAAG,EAAE,4BAA4B,GAAG,4BAA4B,CAc1G"}