@itwin/presentation-common 3.6.0-dev.11 → 3.6.0-dev.21

package/lib/cjs/presentation-common/rules/hierarchy/ChildNodeSpecification.js.map

@@ -1 +1 @@
-{"version":3,"file":"ChildNodeSpecification.js","sourceRoot":"","sources":["../../../../../src/presentation-common/rules/hierarchy/ChildNodeSpecification.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AASH;;;GAGG;AACH,IAAY,2BAMX;AAND,WAAY,2BAA2B;IACrC,2BAA2B;IAC3B,4EAA6C,CAAA;IAC7C,gGAAiE,CAAA;IACjE,oFAAqD,CAAA;IACrD,wDAAyB,CAAA;AAC3B,CAAC,EANW,2BAA2B,GAA3B,mCAA2B,KAA3B,mCAA2B,QAMtC","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\n/** @packageDocumentation\r\n * @module PresentationRules\r\n */\r\n\r\nimport { RelatedInstanceSpecification } from \"../RelatedInstanceSpecification\";\r\nimport { ChildNodeRule } from \"./ChildNodeRule\";\r\nimport { CustomNodeSpecification } from \"./CustomNodeSpecification\";\r\nimport { CustomQueryInstanceNodesSpecification } from \"./CustomQueryInstanceNodesSpecification\";\r\nimport { InstanceNodesOfSpecificClassesSpecification } from \"./InstanceNodesOfSpecificClassesSpecification\";\r\nimport { RelatedInstanceNodesSpecification } from \"./RelatedInstanceNodesSpecification\";\r\n\r\n/**\r\n * Used for serializing array of [[ChildNodeSpecification]]\r\n * @public\r\n */\r\nexport enum ChildNodeSpecificationTypes {\r\n  // hierarchy specifications\r\n  RelatedInstanceNodes = \"RelatedInstanceNodes\",\r\n  InstanceNodesOfSpecificClasses = \"InstanceNodesOfSpecificClasses\",\r\n  CustomQueryInstanceNodes = \"CustomQueryInstanceNodes\",\r\n  CustomNode = \"CustomNode\",\r\n}\r\n\r\n/**\r\n * Base interface for all [[ChildNodeSpecification]] implementations.\r\n *\r\n * @see [Child node specifications reference documentation section]($docs/presentation/hierarchies/ChildNodeRule.md#attribute-specifications)\r\n * @public\r\n */\r\nexport interface ChildNodeSpecificationBase {\r\n  /** Used for serializing to JSON. */\r\n  specType: ChildNodeSpecificationTypes;\r\n\r\n  /**\r\n   * Controls the order in which specifications are handled — specification with higher priority value is\r\n   * handled first. If priorities are equal, the specifications are handled in the order they appear in the\r\n   * ruleset.\r\n   *\r\n   * @type integer\r\n   */\r\n  priority?: number;\r\n\r\n  /**\r\n   * This attribute allows telling the engine that nodes created by this specification always or never have children.\r\n   */\r\n  hasChildren?: \"Always\" | \"Never\" | \"Unknown\";\r\n\r\n  /**\r\n   * When `true`, instances nodes produced by this specification are omitted and their children appear one\r\n   * hierarchy level higher.\r\n   */\r\n  hideNodesInHierarchy?: boolean;\r\n\r\n  /**\r\n   * Specifies whether nodes created through this specification should be hidden if they have no child nodes.\r\n   */\r\n  hideIfNoChildren?: boolean;\r\n\r\n  /**\r\n   * When specified [ECExpression]($docs/presentation/hierarchies/ECExpressions.md#specification) evaluates\r\n   * to `true`, nodes produced by this specification are omitted and their children appear one hierarchy level\r\n   * higher.\r\n   */\r\n  hideExpression?: string;\r\n\r\n  /**\r\n   * Suppress sorting of nodes returned by this specification. With this attribute set to `true`, the order\r\n   * of returned nodes is undefined.\r\n   */\r\n  doNotSort?: boolean;\r\n\r\n  /**\r\n   * Specifies whether similar ancestor nodes' checking should be suppressed when creating nodes based on this\r\n   * specification. See more in [infinite hierarchies prevention page]($docs/presentation/hierarchies/InfiniteHierarchiesPrevention.md).\r\n   *\r\n   * @beta\r\n   */\r\n  suppressSimilarAncestorsCheck?: boolean;\r\n\r\n  /**\r\n   * Specifications of [related instances]($docs/presentation/RelatedInstanceSpecification.md) that can be used\r\n   * when creating the nodes.\r\n   */\r\n  relatedInstances?: RelatedInstanceSpecification[];\r\n\r\n  /**\r\n   * Specifications of [nested child node rules]($docs/presentation/hierarchies/Terminology.md#nested-rule) that\r\n   * allow creating child nodes without the need of supplying a condition to match the parent node.\r\n   */\r\n  nestedRules?: ChildNodeRule[];\r\n}\r\n\r\n/**\r\n * A container of default grouping properties. Used for specifications that support\r\n * default grouping. Not meant to be used directly, see [[ChildNodeSpecification]].\r\n *\r\n * @public\r\n */\r\nexport interface DefaultGroupingPropertiesContainer {\r\n  /** Controls whether returned instances should be grouped by ECClass. Defaults to `true`. */\r\n  groupByClass?: boolean;\r\n\r\n  /** Controls whether returned instances should be grouped by label. Defaults to `true`. */\r\n  groupByLabel?: boolean;\r\n}\r\n\r\n/**\r\n * Hierarchy rule specifications that define what nodes are going to be returned by the rule.\r\n *\r\n * @see [Child node specifications reference documentation section]($docs/presentation/hierarchies/ChildNodeRule.md#attribute-specifications)\r\n * @public\r\n */\r\nexport type ChildNodeSpecification =\r\n  CustomNodeSpecification | InstanceNodesOfSpecificClassesSpecification |\r\n  RelatedInstanceNodesSpecification | CustomQueryInstanceNodesSpecification;\r\n"]}
+{"version":3,"file":"ChildNodeSpecification.js","sourceRoot":"","sources":["../../../../../src/presentation-common/rules/hierarchy/ChildNodeSpecification.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AASH;;;GAGG;AACH,IAAY,2BAMX;AAND,WAAY,2BAA2B;IACrC,2BAA2B;IAC3B,4EAA6C,CAAA;IAC7C,gGAAiE,CAAA;IACjE,oFAAqD,CAAA;IACrD,wDAAyB,CAAA;AAC3B,CAAC,EANW,2BAA2B,GAA3B,mCAA2B,KAA3B,mCAA2B,QAMtC","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/** @packageDocumentation\n * @module PresentationRules\n */\n\nimport { RelatedInstanceSpecification } from \"../RelatedInstanceSpecification\";\nimport { ChildNodeRule } from \"./ChildNodeRule\";\nimport { CustomNodeSpecification } from \"./CustomNodeSpecification\";\nimport { CustomQueryInstanceNodesSpecification } from \"./CustomQueryInstanceNodesSpecification\";\nimport { InstanceNodesOfSpecificClassesSpecification } from \"./InstanceNodesOfSpecificClassesSpecification\";\nimport { RelatedInstanceNodesSpecification } from \"./RelatedInstanceNodesSpecification\";\n\n/**\n * Used for serializing array of [[ChildNodeSpecification]]\n * @public\n */\nexport enum ChildNodeSpecificationTypes {\n  // hierarchy specifications\n  RelatedInstanceNodes = \"RelatedInstanceNodes\",\n  InstanceNodesOfSpecificClasses = \"InstanceNodesOfSpecificClasses\",\n  CustomQueryInstanceNodes = \"CustomQueryInstanceNodes\",\n  CustomNode = \"CustomNode\",\n}\n\n/**\n * Base interface for all [[ChildNodeSpecification]] implementations.\n *\n * @see [Child node specifications reference documentation section]($docs/presentation/hierarchies/ChildNodeRule.md#attribute-specifications)\n * @public\n */\nexport interface ChildNodeSpecificationBase {\n  /** Used for serializing to JSON. */\n  specType: ChildNodeSpecificationTypes;\n\n  /**\n   * Controls the order in which specifications are handled — specification with higher priority value is\n   * handled first. If priorities are equal, the specifications are handled in the order they appear in the\n   * ruleset.\n   *\n   * @type integer\n   */\n  priority?: number;\n\n  /**\n   * This attribute allows telling the engine that nodes created by this specification always or never have children.\n   */\n  hasChildren?: \"Always\" | \"Never\" | \"Unknown\";\n\n  /**\n   * When `true`, instances nodes produced by this specification are omitted and their children appear one\n   * hierarchy level higher.\n   */\n  hideNodesInHierarchy?: boolean;\n\n  /**\n   * Specifies whether nodes created through this specification should be hidden if they have no child nodes.\n   */\n  hideIfNoChildren?: boolean;\n\n  /**\n   * When specified [ECExpression]($docs/presentation/hierarchies/ECExpressions.md#specification) evaluates\n   * to `true`, nodes produced by this specification are omitted and their children appear one hierarchy level\n   * higher.\n   */\n  hideExpression?: string;\n\n  /**\n   * Suppress sorting of nodes returned by this specification. With this attribute set to `true`, the order\n   * of returned nodes is undefined.\n   */\n  doNotSort?: boolean;\n\n  /**\n   * Specifies whether similar ancestor nodes' checking should be suppressed when creating nodes based on this\n   * specification. See more in [infinite hierarchies prevention page]($docs/presentation/hierarchies/InfiniteHierarchiesPrevention.md).\n   *\n   * @beta\n   */\n  suppressSimilarAncestorsCheck?: boolean;\n\n  /**\n   * Specifications of [related instances]($docs/presentation/RelatedInstanceSpecification.md) that can be used\n   * when creating the nodes.\n   */\n  relatedInstances?: RelatedInstanceSpecification[];\n\n  /**\n   * Specifications of [nested child node rules]($docs/presentation/hierarchies/Terminology.md#nested-rule) that\n   * allow creating child nodes without the need of supplying a condition to match the parent node.\n   */\n  nestedRules?: ChildNodeRule[];\n}\n\n/**\n * A container of default grouping properties. Used for specifications that support\n * default grouping. Not meant to be used directly, see [[ChildNodeSpecification]].\n *\n * @public\n */\nexport interface DefaultGroupingPropertiesContainer {\n  /** Controls whether returned instances should be grouped by ECClass. Defaults to `true`. */\n  groupByClass?: boolean;\n\n  /** Controls whether returned instances should be grouped by label. Defaults to `true`. */\n  groupByLabel?: boolean;\n}\n\n/**\n * Hierarchy rule specifications that define what nodes are going to be returned by the rule.\n *\n * @see [Child node specifications reference documentation section]($docs/presentation/hierarchies/ChildNodeRule.md#attribute-specifications)\n * @public\n */\nexport type ChildNodeSpecification =\n  CustomNodeSpecification | InstanceNodesOfSpecificClassesSpecification |\n  RelatedInstanceNodesSpecification | CustomQueryInstanceNodesSpecification;\n"]}

package/lib/cjs/presentation-common/rules/hierarchy/CustomNodeSpecification.d.ts

@@ -1,32 +1,32 @@
-/** @packageDocumentation
- * @module PresentationRules
- */
-import { ChildNodeSpecificationBase, ChildNodeSpecificationTypes } from "./ChildNodeSpecification";
-/**
- * Returns a static custom-defined node that's not based on an ECInstance.
- *
- * @see [Custom node specification reference documentation page]($docs/presentation/hierarchies/CustomNode.md)
- * @public
- */
-export interface CustomNodeSpecification extends ChildNodeSpecificationBase {
-    /** Used for serializing to JSON. */
-    specType: ChildNodeSpecificationTypes.CustomNode;
-    /** Specifies node type, which is assigned to node's key. */
-    type: string;
-    /**
-     * Specifies node label. This is a string value that may be [localized]($docs/presentation/advanced/Localization.md).
-     */
-    label: string;
-    /**
-     * Specifies the value of [[Node.description]] property, which is a string that may
-     * be [localized]($docs/presentation/advanced/Localization.md). UI component displaying the node may choose
-     * whether and how to surface this information to users.
-     */
-    description?: string;
-    /**
-     * Specifies node's image ID. If set, the ID is assigned to [[Node.imageId]] and it's
-     * up to the UI component to decide what to do with it.
-     */
-    imageId?: string;
-}
+/** @packageDocumentation
+ * @module PresentationRules
+ */
+import { ChildNodeSpecificationBase, ChildNodeSpecificationTypes } from "./ChildNodeSpecification";
+/**
+ * Returns a static custom-defined node that's not based on an ECInstance.
+ *
+ * @see [Custom node specification reference documentation page]($docs/presentation/hierarchies/CustomNode.md)
+ * @public
+ */
+export interface CustomNodeSpecification extends ChildNodeSpecificationBase {
+    /** Used for serializing to JSON. */
+    specType: ChildNodeSpecificationTypes.CustomNode;
+    /** Specifies node type, which is assigned to node's key. */
+    type: string;
+    /**
+     * Specifies node label. This is a string value that may be [localized]($docs/presentation/advanced/Localization.md).
+     */
+    label: string;
+    /**
+     * Specifies the value of [[Node.description]] property, which is a string that may
+     * be [localized]($docs/presentation/advanced/Localization.md). UI component displaying the node may choose
+     * whether and how to surface this information to users.
+     */
+    description?: string;
+    /**
+     * Specifies node's image ID. If set, the ID is assigned to [[Node.imageId]] and it's
+     * up to the UI component to decide what to do with it.
+     */
+    imageId?: string;
+}
 //# sourceMappingURL=CustomNodeSpecification.d.ts.map

package/lib/cjs/presentation-common/rules/hierarchy/CustomNodeSpecification.js

@@ -1,10 +1,10 @@
-"use strict";
-/*---------------------------------------------------------------------------------------------
-* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
-* See LICENSE.md in the project root for license terms and full copyright notice.
-*--------------------------------------------------------------------------------------------*/
-/** @packageDocumentation
- * @module PresentationRules
- */
-Object.defineProperty(exports, "__esModule", { value: true });
+"use strict";
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+/** @packageDocumentation
+ * @module PresentationRules
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
 //# sourceMappingURL=CustomNodeSpecification.js.map

package/lib/cjs/presentation-common/rules/hierarchy/CustomNodeSpecification.js.map

@@ -1 +1 @@
-{"version":3,"file":"CustomNodeSpecification.js","sourceRoot":"","sources":["../../../../../src/presentation-common/rules/hierarchy/CustomNodeSpecification.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\n/** @packageDocumentation\r\n * @module PresentationRules\r\n */\r\n\r\nimport { ChildNodeSpecificationBase, ChildNodeSpecificationTypes } from \"./ChildNodeSpecification\";\r\n\r\n/**\r\n * Returns a static custom-defined node that's not based on an ECInstance.\r\n *\r\n * @see [Custom node specification reference documentation page]($docs/presentation/hierarchies/CustomNode.md)\r\n * @public\r\n */\r\nexport interface CustomNodeSpecification extends ChildNodeSpecificationBase {\r\n  /** Used for serializing to JSON. */\r\n  specType: ChildNodeSpecificationTypes.CustomNode;\r\n\r\n  /** Specifies node type, which is assigned to node's key. */\r\n  type: string;\r\n\r\n  /**\r\n   * Specifies node label. This is a string value that may be [localized]($docs/presentation/advanced/Localization.md).\r\n   */\r\n  label: string;\r\n\r\n  /**\r\n   * Specifies the value of [[Node.description]] property, which is a string that may\r\n   * be [localized]($docs/presentation/advanced/Localization.md). UI component displaying the node may choose\r\n   * whether and how to surface this information to users.\r\n   */\r\n  description?: string;\r\n\r\n  /**\r\n   * Specifies node's image ID. If set, the ID is assigned to [[Node.imageId]] and it's\r\n   * up to the UI component to decide what to do with it.\r\n   */\r\n  imageId?: string;\r\n}\r\n"]}
+{"version":3,"file":"CustomNodeSpecification.js","sourceRoot":"","sources":["../../../../../src/presentation-common/rules/hierarchy/CustomNodeSpecification.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG","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/** @packageDocumentation\n * @module PresentationRules\n */\n\nimport { ChildNodeSpecificationBase, ChildNodeSpecificationTypes } from \"./ChildNodeSpecification\";\n\n/**\n * Returns a static custom-defined node that's not based on an ECInstance.\n *\n * @see [Custom node specification reference documentation page]($docs/presentation/hierarchies/CustomNode.md)\n * @public\n */\nexport interface CustomNodeSpecification extends ChildNodeSpecificationBase {\n  /** Used for serializing to JSON. */\n  specType: ChildNodeSpecificationTypes.CustomNode;\n\n  /** Specifies node type, which is assigned to node's key. */\n  type: string;\n\n  /**\n   * Specifies node label. This is a string value that may be [localized]($docs/presentation/advanced/Localization.md).\n   */\n  label: string;\n\n  /**\n   * Specifies the value of [[Node.description]] property, which is a string that may\n   * be [localized]($docs/presentation/advanced/Localization.md). UI component displaying the node may choose\n   * whether and how to surface this information to users.\n   */\n  description?: string;\n\n  /**\n   * Specifies node's image ID. If set, the ID is assigned to [[Node.imageId]] and it's\n   * up to the UI component to decide what to do with it.\n   */\n  imageId?: string;\n}\n"]}

package/lib/cjs/presentation-common/rules/hierarchy/CustomQueryInstanceNodesSpecification.d.ts

@@ -1,77 +1,77 @@
-/** @packageDocumentation
- * @module PresentationRules
- */
-import { SingleSchemaClassSpecification } from "../ClassSpecifications";
-import { ChildNodeSpecificationBase, ChildNodeSpecificationTypes, DefaultGroupingPropertiesContainer } from "./ChildNodeSpecification";
-/**
- * Returns nodes for instances returned by a provided ECSQL query.
- *
- * @see [Custom query instance nodes specification reference documentation page]($docs/presentation/hierarchies/CustomQueryInstanceNodes.md)
- * @public
- */
-export interface CustomQueryInstanceNodesSpecification extends ChildNodeSpecificationBase, DefaultGroupingPropertiesContainer {
-    /** Used for serializing to JSON. */
-    specType: ChildNodeSpecificationTypes.CustomQueryInstanceNodes;
-    /**
-     * Specifications of queries used to create the content. Query specifications define the actual
-     * results of the specification.
-     */
-    queries?: QuerySpecification[];
-}
-/**
- * Query specifications used in [[CustomQueryInstanceNodesSpecification]].
- *
- * @see [Custom query specifications reference documentation section]($docs/presentation/hierarchies/CustomQueryInstanceNodes.md#attribute-queries)
- * @public
- */
-export declare type QuerySpecification = StringQuerySpecification | ECPropertyValueQuerySpecification;
-/**
- * Used for serializing array of [[QuerySpecification]] to JSON.
- * @public
- */
-export declare enum QuerySpecificationTypes {
-    String = "String",
-    ECPropertyValue = "ECPropertyValue"
-}
-/**
- * Base interface for all [[QuerySpecification]] implementations.
- * @public
- */
-export interface QuerySpecificationBase {
-    /** Used for serializing to JSON. */
-    specType: QuerySpecificationTypes;
-    /**
-     * Specification of ECClass whose instances the query returns. The specification may also point to a
-     * base class of instances returned by the query. If the query returns instances that are not of this
-     * class, they aren't included in the result set.
-     */
-    class: SingleSchemaClassSpecification;
-}
-/**
- * The specification contains an ECSQL query which is used to query for instances.
- *
- * @see [String query specification reference documentation section]($docs/presentation/hierarchies/CustomQueryInstanceNodes.md#string-query-specification)
- * @public
- */
-export interface StringQuerySpecification extends QuerySpecificationBase {
-    /** Used for serializing to JSON. */
-    specType: QuerySpecificationTypes.String;
-    /** Specifies the search ECSQL query. */
-    query: string;
-}
-/**
- * The specification specifies the name of the parent node instance property whose value is the ECSQL
- * used to query for instances.
- *
- * @see [ECProperty value query specification reference documentation section]($docs/presentation/hierarchies/CustomQueryInstanceNodes.md#ecproperty-value-query-specification)
- * @public
- */
-export interface ECPropertyValueQuerySpecification extends QuerySpecificationBase {
-    /** Used for serializing to JSON. */
-    specType: QuerySpecificationTypes.ECPropertyValue;
-    /**
-     * Specifies name of the parent instance property whose value contains the ECSQL query.
-     */
-    parentPropertyName: string;
-}
+/** @packageDocumentation
+ * @module PresentationRules
+ */
+import { SingleSchemaClassSpecification } from "../ClassSpecifications";
+import { ChildNodeSpecificationBase, ChildNodeSpecificationTypes, DefaultGroupingPropertiesContainer } from "./ChildNodeSpecification";
+/**
+ * Returns nodes for instances returned by a provided ECSQL query.
+ *
+ * @see [Custom query instance nodes specification reference documentation page]($docs/presentation/hierarchies/CustomQueryInstanceNodes.md)
+ * @public
+ */
+export interface CustomQueryInstanceNodesSpecification extends ChildNodeSpecificationBase, DefaultGroupingPropertiesContainer {
+    /** Used for serializing to JSON. */
+    specType: ChildNodeSpecificationTypes.CustomQueryInstanceNodes;
+    /**
+     * Specifications of queries used to create the content. Query specifications define the actual
+     * results of the specification.
+     */
+    queries?: QuerySpecification[];
+}
+/**
+ * Query specifications used in [[CustomQueryInstanceNodesSpecification]].
+ *
+ * @see [Custom query specifications reference documentation section]($docs/presentation/hierarchies/CustomQueryInstanceNodes.md#attribute-queries)
+ * @public
+ */
+export declare type QuerySpecification = StringQuerySpecification | ECPropertyValueQuerySpecification;
+/**
+ * Used for serializing array of [[QuerySpecification]] to JSON.
+ * @public
+ */
+export declare enum QuerySpecificationTypes {
+    String = "String",
+    ECPropertyValue = "ECPropertyValue"
+}
+/**
+ * Base interface for all [[QuerySpecification]] implementations.
+ * @public
+ */
+export interface QuerySpecificationBase {
+    /** Used for serializing to JSON. */
+    specType: QuerySpecificationTypes;
+    /**
+     * Specification of ECClass whose instances the query returns. The specification may also point to a
+     * base class of instances returned by the query. If the query returns instances that are not of this
+     * class, they aren't included in the result set.
+     */
+    class: SingleSchemaClassSpecification;
+}
+/**
+ * The specification contains an ECSQL query which is used to query for instances.
+ *
+ * @see [String query specification reference documentation section]($docs/presentation/hierarchies/CustomQueryInstanceNodes.md#string-query-specification)
+ * @public
+ */
+export interface StringQuerySpecification extends QuerySpecificationBase {
+    /** Used for serializing to JSON. */
+    specType: QuerySpecificationTypes.String;
+    /** Specifies the search ECSQL query. */
+    query: string;
+}
+/**
+ * The specification specifies the name of the parent node instance property whose value is the ECSQL
+ * used to query for instances.
+ *
+ * @see [ECProperty value query specification reference documentation section]($docs/presentation/hierarchies/CustomQueryInstanceNodes.md#ecproperty-value-query-specification)
+ * @public
+ */
+export interface ECPropertyValueQuerySpecification extends QuerySpecificationBase {
+    /** Used for serializing to JSON. */
+    specType: QuerySpecificationTypes.ECPropertyValue;
+    /**
+     * Specifies name of the parent instance property whose value contains the ECSQL query.
+     */
+    parentPropertyName: string;
+}
 //# sourceMappingURL=CustomQueryInstanceNodesSpecification.d.ts.map

package/lib/cjs/presentation-common/rules/hierarchy/CustomQueryInstanceNodesSpecification.js

@@ -1,20 +1,20 @@
-"use strict";
-/*---------------------------------------------------------------------------------------------
-* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
-* See LICENSE.md in the project root for license terms and full copyright notice.
-*--------------------------------------------------------------------------------------------*/
-/** @packageDocumentation
- * @module PresentationRules
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.QuerySpecificationTypes = void 0;
-/**
- * Used for serializing array of [[QuerySpecification]] to JSON.
- * @public
- */
-var QuerySpecificationTypes;
-(function (QuerySpecificationTypes) {
-    QuerySpecificationTypes["String"] = "String";
-    QuerySpecificationTypes["ECPropertyValue"] = "ECPropertyValue";
-})(QuerySpecificationTypes = exports.QuerySpecificationTypes || (exports.QuerySpecificationTypes = {}));
+"use strict";
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+/** @packageDocumentation
+ * @module PresentationRules
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.QuerySpecificationTypes = void 0;
+/**
+ * Used for serializing array of [[QuerySpecification]] to JSON.
+ * @public
+ */
+var QuerySpecificationTypes;
+(function (QuerySpecificationTypes) {
+    QuerySpecificationTypes["String"] = "String";
+    QuerySpecificationTypes["ECPropertyValue"] = "ECPropertyValue";
+})(QuerySpecificationTypes = exports.QuerySpecificationTypes || (exports.QuerySpecificationTypes = {}));
 //# sourceMappingURL=CustomQueryInstanceNodesSpecification.js.map

package/lib/cjs/presentation-common/rules/hierarchy/CustomQueryInstanceNodesSpecification.js.map

@@ -1 +1 @@
-{"version":3,"file":"CustomQueryInstanceNodesSpecification.js","sourceRoot":"","sources":["../../../../../src/presentation-common/rules/hierarchy/CustomQueryInstanceNodesSpecification.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AA8BH;;;GAGG;AACH,IAAY,uBAGX;AAHD,WAAY,uBAAuB;IACjC,4CAAiB,CAAA;IACjB,8DAAmC,CAAA;AACrC,CAAC,EAHW,uBAAuB,GAAvB,+BAAuB,KAAvB,+BAAuB,QAGlC","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\n/** @packageDocumentation\r\n * @module PresentationRules\r\n */\r\n\r\nimport { SingleSchemaClassSpecification } from \"../ClassSpecifications\";\r\nimport { ChildNodeSpecificationBase, ChildNodeSpecificationTypes, DefaultGroupingPropertiesContainer } from \"./ChildNodeSpecification\";\r\n\r\n/**\r\n * Returns nodes for instances returned by a provided ECSQL query.\r\n *\r\n * @see [Custom query instance nodes specification reference documentation page]($docs/presentation/hierarchies/CustomQueryInstanceNodes.md)\r\n * @public\r\n */\r\nexport interface CustomQueryInstanceNodesSpecification extends ChildNodeSpecificationBase, DefaultGroupingPropertiesContainer {\r\n  /** Used for serializing to JSON. */\r\n  specType: ChildNodeSpecificationTypes.CustomQueryInstanceNodes;\r\n\r\n  /**\r\n   * Specifications of queries used to create the content. Query specifications define the actual\r\n   * results of the specification.\r\n   */\r\n  queries?: QuerySpecification[];\r\n}\r\n\r\n/**\r\n * Query specifications used in [[CustomQueryInstanceNodesSpecification]].\r\n *\r\n * @see [Custom query specifications reference documentation section]($docs/presentation/hierarchies/CustomQueryInstanceNodes.md#attribute-queries)\r\n * @public\r\n */\r\nexport declare type QuerySpecification = StringQuerySpecification | ECPropertyValueQuerySpecification;\r\n\r\n/**\r\n * Used for serializing array of [[QuerySpecification]] to JSON.\r\n * @public\r\n */\r\nexport enum QuerySpecificationTypes {\r\n  String = \"String\",\r\n  ECPropertyValue = \"ECPropertyValue\",\r\n}\r\n\r\n/**\r\n * Base interface for all [[QuerySpecification]] implementations.\r\n * @public\r\n */\r\nexport interface QuerySpecificationBase {\r\n  /** Used for serializing to JSON. */\r\n  specType: QuerySpecificationTypes;\r\n\r\n  /**\r\n   * Specification of ECClass whose instances the query returns. The specification may also point to a\r\n   * base class of instances returned by the query. If the query returns instances that are not of this\r\n   * class, they aren't included in the result set.\r\n   */\r\n  class: SingleSchemaClassSpecification;\r\n}\r\n\r\n/**\r\n * The specification contains an ECSQL query which is used to query for instances.\r\n *\r\n * @see [String query specification reference documentation section]($docs/presentation/hierarchies/CustomQueryInstanceNodes.md#string-query-specification)\r\n * @public\r\n */\r\nexport interface StringQuerySpecification extends QuerySpecificationBase {\r\n  /** Used for serializing to JSON. */\r\n  specType: QuerySpecificationTypes.String;\r\n\r\n  /** Specifies the search ECSQL query. */\r\n  query: string;\r\n}\r\n\r\n/**\r\n * The specification specifies the name of the parent node instance property whose value is the ECSQL\r\n * used to query for instances.\r\n *\r\n * @see [ECProperty value query specification reference documentation section]($docs/presentation/hierarchies/CustomQueryInstanceNodes.md#ecproperty-value-query-specification)\r\n * @public\r\n */\r\nexport interface ECPropertyValueQuerySpecification extends QuerySpecificationBase {\r\n  /** Used for serializing to JSON. */\r\n  specType: QuerySpecificationTypes.ECPropertyValue;\r\n\r\n  /**\r\n   * Specifies name of the parent instance property whose value contains the ECSQL query.\r\n   */\r\n  parentPropertyName: string;\r\n}\r\n"]}
+{"version":3,"file":"CustomQueryInstanceNodesSpecification.js","sourceRoot":"","sources":["../../../../../src/presentation-common/rules/hierarchy/CustomQueryInstanceNodesSpecification.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AA8BH;;;GAGG;AACH,IAAY,uBAGX;AAHD,WAAY,uBAAuB;IACjC,4CAAiB,CAAA;IACjB,8DAAmC,CAAA;AACrC,CAAC,EAHW,uBAAuB,GAAvB,+BAAuB,KAAvB,+BAAuB,QAGlC","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/** @packageDocumentation\n * @module PresentationRules\n */\n\nimport { SingleSchemaClassSpecification } from \"../ClassSpecifications\";\nimport { ChildNodeSpecificationBase, ChildNodeSpecificationTypes, DefaultGroupingPropertiesContainer } from \"./ChildNodeSpecification\";\n\n/**\n * Returns nodes for instances returned by a provided ECSQL query.\n *\n * @see [Custom query instance nodes specification reference documentation page]($docs/presentation/hierarchies/CustomQueryInstanceNodes.md)\n * @public\n */\nexport interface CustomQueryInstanceNodesSpecification extends ChildNodeSpecificationBase, DefaultGroupingPropertiesContainer {\n  /** Used for serializing to JSON. */\n  specType: ChildNodeSpecificationTypes.CustomQueryInstanceNodes;\n\n  /**\n   * Specifications of queries used to create the content. Query specifications define the actual\n   * results of the specification.\n   */\n  queries?: QuerySpecification[];\n}\n\n/**\n * Query specifications used in [[CustomQueryInstanceNodesSpecification]].\n *\n * @see [Custom query specifications reference documentation section]($docs/presentation/hierarchies/CustomQueryInstanceNodes.md#attribute-queries)\n * @public\n */\nexport declare type QuerySpecification = StringQuerySpecification | ECPropertyValueQuerySpecification;\n\n/**\n * Used for serializing array of [[QuerySpecification]] to JSON.\n * @public\n */\nexport enum QuerySpecificationTypes {\n  String = \"String\",\n  ECPropertyValue = \"ECPropertyValue\",\n}\n\n/**\n * Base interface for all [[QuerySpecification]] implementations.\n * @public\n */\nexport interface QuerySpecificationBase {\n  /** Used for serializing to JSON. */\n  specType: QuerySpecificationTypes;\n\n  /**\n   * Specification of ECClass whose instances the query returns. The specification may also point to a\n   * base class of instances returned by the query. If the query returns instances that are not of this\n   * class, they aren't included in the result set.\n   */\n  class: SingleSchemaClassSpecification;\n}\n\n/**\n * The specification contains an ECSQL query which is used to query for instances.\n *\n * @see [String query specification reference documentation section]($docs/presentation/hierarchies/CustomQueryInstanceNodes.md#string-query-specification)\n * @public\n */\nexport interface StringQuerySpecification extends QuerySpecificationBase {\n  /** Used for serializing to JSON. */\n  specType: QuerySpecificationTypes.String;\n\n  /** Specifies the search ECSQL query. */\n  query: string;\n}\n\n/**\n * The specification specifies the name of the parent node instance property whose value is the ECSQL\n * used to query for instances.\n *\n * @see [ECProperty value query specification reference documentation section]($docs/presentation/hierarchies/CustomQueryInstanceNodes.md#ecproperty-value-query-specification)\n * @public\n */\nexport interface ECPropertyValueQuerySpecification extends QuerySpecificationBase {\n  /** Used for serializing to JSON. */\n  specType: QuerySpecificationTypes.ECPropertyValue;\n\n  /**\n   * Specifies name of the parent instance property whose value contains the ECSQL query.\n   */\n  parentPropertyName: string;\n}\n"]}

package/lib/cjs/presentation-common/rules/hierarchy/InstanceNodesOfSpecificClassesSpecification.d.ts

@@ -1,40 +1,40 @@
-/** @packageDocumentation
- * @module PresentationRules
- */
-import { MultiSchemaClassesSpecification } from "../ClassSpecifications";
-import { ChildNodeSpecificationBase, ChildNodeSpecificationTypes, DefaultGroupingPropertiesContainer } from "./ChildNodeSpecification";
-/**
- * Returns nodes for instances of specific ECClasses.
- *
- * @see [Instance nodes of specific classes specification reference documentation page]($docs/presentation/hierarchies/InstanceNodesOfSpecificClasses.md)
- * @public
- */
-export interface InstanceNodesOfSpecificClassesSpecification extends ChildNodeSpecificationBase, DefaultGroupingPropertiesContainer {
-    /** Used for serializing to JSON. */
-    specType: ChildNodeSpecificationTypes.InstanceNodesOfSpecificClasses;
-    /**
-     * Defines a set of [multi schema classes]($docs/presentation/MultiSchemaClassesSpecification.md) that
-     * specify which ECClasses need to be selected to form the result.
-     */
-    classes: MultiSchemaClassesSpecification | MultiSchemaClassesSpecification[];
-    /**
-     * Defines a set of [multi schema classes]($docs/presentation/MultiSchemaClassesSpecification.md) that
-     * prevents specified ECClasses and subclasses from being selected by [[classes]] attribute.
-     */
-    excludedClasses?: MultiSchemaClassesSpecification | MultiSchemaClassesSpecification[];
-    /**
-     * Tells whether selecting instances from ECClasses specified in [[classes]] and [[excludedClasses]]
-     * attributes should be polymorphic or not.
-     *
-     * @deprecated The attribute was replaced by `arePolymorphic` attribute specified individually for each class definition
-     * under [[classes]] and [[excludedClasses]] attributes. At the moment, to keep backwards compatibility, this attribute acts
-     * as a fallback value in case the flag is not specified individually for a class definition.
-     */
-    arePolymorphic?: boolean;
-    /**
-     * Specifies an [ECExpression]($docs/presentation/hierarchies/ECExpressions.md#instance-filter) for filtering
-     * instances of ECClasses specified through the [[classes]] attribute.
-     */
-    instanceFilter?: string;
-}
+/** @packageDocumentation
+ * @module PresentationRules
+ */
+import { MultiSchemaClassesSpecification } from "../ClassSpecifications";
+import { ChildNodeSpecificationBase, ChildNodeSpecificationTypes, DefaultGroupingPropertiesContainer } from "./ChildNodeSpecification";
+/**
+ * Returns nodes for instances of specific ECClasses.
+ *
+ * @see [Instance nodes of specific classes specification reference documentation page]($docs/presentation/hierarchies/InstanceNodesOfSpecificClasses.md)
+ * @public
+ */
+export interface InstanceNodesOfSpecificClassesSpecification extends ChildNodeSpecificationBase, DefaultGroupingPropertiesContainer {
+    /** Used for serializing to JSON. */
+    specType: ChildNodeSpecificationTypes.InstanceNodesOfSpecificClasses;
+    /**
+     * Defines a set of [multi schema classes]($docs/presentation/MultiSchemaClassesSpecification.md) that
+     * specify which ECClasses need to be selected to form the result.
+     */
+    classes: MultiSchemaClassesSpecification | MultiSchemaClassesSpecification[];
+    /**
+     * Defines a set of [multi schema classes]($docs/presentation/MultiSchemaClassesSpecification.md) that
+     * prevents specified ECClasses and subclasses from being selected by [[classes]] attribute.
+     */
+    excludedClasses?: MultiSchemaClassesSpecification | MultiSchemaClassesSpecification[];
+    /**
+     * Tells whether selecting instances from ECClasses specified in [[classes]] and [[excludedClasses]]
+     * attributes should be polymorphic or not.
+     *
+     * @deprecated The attribute was replaced by `arePolymorphic` attribute specified individually for each class definition
+     * under [[classes]] and [[excludedClasses]] attributes. At the moment, to keep backwards compatibility, this attribute acts
+     * as a fallback value in case the flag is not specified individually for a class definition.
+     */
+    arePolymorphic?: boolean;
+    /**
+     * Specifies an [ECExpression]($docs/presentation/hierarchies/ECExpressions.md#instance-filter) for filtering
+     * instances of ECClasses specified through the [[classes]] attribute.
+     */
+    instanceFilter?: string;
+}
 //# sourceMappingURL=InstanceNodesOfSpecificClassesSpecification.d.ts.map

package/lib/cjs/presentation-common/rules/hierarchy/InstanceNodesOfSpecificClassesSpecification.js

@@ -1,10 +1,10 @@
-"use strict";
-/*---------------------------------------------------------------------------------------------
-* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
-* See LICENSE.md in the project root for license terms and full copyright notice.
-*--------------------------------------------------------------------------------------------*/
-/** @packageDocumentation
- * @module PresentationRules
- */
-Object.defineProperty(exports, "__esModule", { value: true });
+"use strict";
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+/** @packageDocumentation
+ * @module PresentationRules
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
 //# sourceMappingURL=InstanceNodesOfSpecificClassesSpecification.js.map

package/lib/cjs/presentation-common/rules/hierarchy/InstanceNodesOfSpecificClassesSpecification.js.map

@@ -1 +1 @@
-{"version":3,"file":"InstanceNodesOfSpecificClassesSpecification.js","sourceRoot":"","sources":["../../../../../src/presentation-common/rules/hierarchy/InstanceNodesOfSpecificClassesSpecification.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\n/** @packageDocumentation\r\n * @module PresentationRules\r\n */\r\n\r\nimport { MultiSchemaClassesSpecification } from \"../ClassSpecifications\";\r\nimport { ChildNodeSpecificationBase, ChildNodeSpecificationTypes, DefaultGroupingPropertiesContainer } from \"./ChildNodeSpecification\";\r\n\r\n/**\r\n * Returns nodes for instances of specific ECClasses.\r\n *\r\n * @see [Instance nodes of specific classes specification reference documentation page]($docs/presentation/hierarchies/InstanceNodesOfSpecificClasses.md)\r\n * @public\r\n */\r\nexport interface InstanceNodesOfSpecificClassesSpecification extends ChildNodeSpecificationBase, DefaultGroupingPropertiesContainer {\r\n  /** Used for serializing to JSON. */\r\n  specType: ChildNodeSpecificationTypes.InstanceNodesOfSpecificClasses;\r\n\r\n  /**\r\n   * Defines a set of [multi schema classes]($docs/presentation/MultiSchemaClassesSpecification.md) that\r\n   * specify which ECClasses need to be selected to form the result.\r\n   */\r\n  classes: MultiSchemaClassesSpecification | MultiSchemaClassesSpecification[];\r\n\r\n  /**\r\n   * Defines a set of [multi schema classes]($docs/presentation/MultiSchemaClassesSpecification.md) that\r\n   * prevents specified ECClasses and subclasses from being selected by [[classes]] attribute.\r\n   */\r\n  excludedClasses?: MultiSchemaClassesSpecification | MultiSchemaClassesSpecification[];\r\n\r\n  /**\r\n   * Tells whether selecting instances from ECClasses specified in [[classes]] and [[excludedClasses]]\r\n   * attributes should be polymorphic or not.\r\n   *\r\n   * @deprecated The attribute was replaced by `arePolymorphic` attribute specified individually for each class definition\r\n   * under [[classes]] and [[excludedClasses]] attributes. At the moment, to keep backwards compatibility, this attribute acts\r\n   * as a fallback value in case the flag is not specified individually for a class definition.\r\n   */\r\n  arePolymorphic?: boolean;\r\n\r\n  /**\r\n   * Specifies an [ECExpression]($docs/presentation/hierarchies/ECExpressions.md#instance-filter) for filtering\r\n   * instances of ECClasses specified through the [[classes]] attribute.\r\n   */\r\n  instanceFilter?: string;\r\n}\r\n"]}
+{"version":3,"file":"InstanceNodesOfSpecificClassesSpecification.js","sourceRoot":"","sources":["../../../../../src/presentation-common/rules/hierarchy/InstanceNodesOfSpecificClassesSpecification.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG","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/** @packageDocumentation\n * @module PresentationRules\n */\n\nimport { MultiSchemaClassesSpecification } from \"../ClassSpecifications\";\nimport { ChildNodeSpecificationBase, ChildNodeSpecificationTypes, DefaultGroupingPropertiesContainer } from \"./ChildNodeSpecification\";\n\n/**\n * Returns nodes for instances of specific ECClasses.\n *\n * @see [Instance nodes of specific classes specification reference documentation page]($docs/presentation/hierarchies/InstanceNodesOfSpecificClasses.md)\n * @public\n */\nexport interface InstanceNodesOfSpecificClassesSpecification extends ChildNodeSpecificationBase, DefaultGroupingPropertiesContainer {\n  /** Used for serializing to JSON. */\n  specType: ChildNodeSpecificationTypes.InstanceNodesOfSpecificClasses;\n\n  /**\n   * Defines a set of [multi schema classes]($docs/presentation/MultiSchemaClassesSpecification.md) that\n   * specify which ECClasses need to be selected to form the result.\n   */\n  classes: MultiSchemaClassesSpecification | MultiSchemaClassesSpecification[];\n\n  /**\n   * Defines a set of [multi schema classes]($docs/presentation/MultiSchemaClassesSpecification.md) that\n   * prevents specified ECClasses and subclasses from being selected by [[classes]] attribute.\n   */\n  excludedClasses?: MultiSchemaClassesSpecification | MultiSchemaClassesSpecification[];\n\n  /**\n   * Tells whether selecting instances from ECClasses specified in [[classes]] and [[excludedClasses]]\n   * attributes should be polymorphic or not.\n   *\n   * @deprecated The attribute was replaced by `arePolymorphic` attribute specified individually for each class definition\n   * under [[classes]] and [[excludedClasses]] attributes. At the moment, to keep backwards compatibility, this attribute acts\n   * as a fallback value in case the flag is not specified individually for a class definition.\n   */\n  arePolymorphic?: boolean;\n\n  /**\n   * Specifies an [ECExpression]($docs/presentation/hierarchies/ECExpressions.md#instance-filter) for filtering\n   * instances of ECClasses specified through the [[classes]] attribute.\n   */\n  instanceFilter?: string;\n}\n"]}

package/lib/cjs/presentation-common/rules/hierarchy/NavigationRule.d.ts

@@ -1,51 +1,51 @@
-/** @packageDocumentation
- * @module PresentationRules
- */
-import { CustomizationRule } from "../customization/CustomizationRule";
-import { RuleBase } from "../Rule";
-import { ChildNodeRule } from "./ChildNodeRule";
-import { ChildNodeSpecification } from "./ChildNodeSpecification";
-import { RootNodeRule } from "./RootNodeRule";
-import { SubCondition } from "./SubCondition";
-/**
- * Base class for all [[NavigationRule]] implementations.
- *
- * @see [Hierarchies reference documentation page]($docs/presentation/hierarchies/index.md)
- * @public
- */
-export interface NavigationRuleBase extends RuleBase {
-    /**
-     * Defines a condition which needs to be met in order for the rule to be used. The condition is an
-     * [ECExpression]($docs/presentation/hierarchies/ECExpressions.md#rule-condition) which has to evaluate
-     * to a boolean value.
-     */
-    condition?: string;
-    /**
-     * A list of hierarchy specifications that define what nodes are going to be returned.
-     */
-    specifications?: ChildNodeSpecification[];
-    /**
-     * A list of [customization rules]($docs/presentation/hierarchies/index.md#hierarchy-customization) that
-     * apply only to nodes produced by this rule.
-     */
-    customizationRules?: CustomizationRule[];
-    /**
-     * A list of sub-rules which share *placement attributes* and
-     * [nested customization rules]($docs/presentation/hierarchies/ChildNodeRule.md#attribute-customizationrules)
-     * of the hierarchy rule. This means the attributes of hierarchy rule are still in effect and the sub-rules
-     * can add additional condition of their own.
-     */
-    subConditions?: SubCondition[];
-    /**
-     * Stop processing rules that have lower priority. Used in cases when recursion suppression is needed.
-     */
-    stopFurtherProcessing?: boolean;
-}
-/**
- * Navigation rules are used to define hierarchies displayed in tree components.
- *
- * @see [Hierarchies reference documentation page]($docs/presentation/hierarchies/index.md)
- * @public
- */
-export declare type NavigationRule = RootNodeRule | ChildNodeRule;
+/** @packageDocumentation
+ * @module PresentationRules
+ */
+import { CustomizationRule } from "../customization/CustomizationRule";
+import { RuleBase } from "../Rule";
+import { ChildNodeRule } from "./ChildNodeRule";
+import { ChildNodeSpecification } from "./ChildNodeSpecification";
+import { RootNodeRule } from "./RootNodeRule";
+import { SubCondition } from "./SubCondition";
+/**
+ * Base class for all [[NavigationRule]] implementations.
+ *
+ * @see [Hierarchies reference documentation page]($docs/presentation/hierarchies/index.md)
+ * @public
+ */
+export interface NavigationRuleBase extends RuleBase {
+    /**
+     * Defines a condition which needs to be met in order for the rule to be used. The condition is an
+     * [ECExpression]($docs/presentation/hierarchies/ECExpressions.md#rule-condition) which has to evaluate
+     * to a boolean value.
+     */
+    condition?: string;
+    /**
+     * A list of hierarchy specifications that define what nodes are going to be returned.
+     */
+    specifications?: ChildNodeSpecification[];
+    /**
+     * A list of [customization rules]($docs/presentation/hierarchies/index.md#hierarchy-customization) that
+     * apply only to nodes produced by this rule.
+     */
+    customizationRules?: CustomizationRule[];
+    /**
+     * A list of sub-rules which share *placement attributes* and
+     * [nested customization rules]($docs/presentation/hierarchies/ChildNodeRule.md#attribute-customizationrules)
+     * of the hierarchy rule. This means the attributes of hierarchy rule are still in effect and the sub-rules
+     * can add additional condition of their own.
+     */
+    subConditions?: SubCondition[];
+    /**
+     * Stop processing rules that have lower priority. Used in cases when recursion suppression is needed.
+     */
+    stopFurtherProcessing?: boolean;
+}
+/**
+ * Navigation rules are used to define hierarchies displayed in tree components.
+ *
+ * @see [Hierarchies reference documentation page]($docs/presentation/hierarchies/index.md)
+ * @public
+ */
+export declare type NavigationRule = RootNodeRule | ChildNodeRule;
 //# sourceMappingURL=NavigationRule.d.ts.map

package/lib/cjs/presentation-common/rules/hierarchy/NavigationRule.js

@@ -1,10 +1,10 @@
-"use strict";
-/*---------------------------------------------------------------------------------------------
-* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
-* See LICENSE.md in the project root for license terms and full copyright notice.
-*--------------------------------------------------------------------------------------------*/
-/** @packageDocumentation
- * @module PresentationRules
- */
-Object.defineProperty(exports, "__esModule", { value: true });
+"use strict";
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+/** @packageDocumentation
+ * @module PresentationRules
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
 //# sourceMappingURL=NavigationRule.js.map

package/lib/cjs/presentation-common/rules/hierarchy/NavigationRule.js.map

@@ -1 +1 @@
-{"version":3,"file":"NavigationRule.js","sourceRoot":"","sources":["../../../../../src/presentation-common/rules/hierarchy/NavigationRule.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\n/** @packageDocumentation\r\n * @module PresentationRules\r\n */\r\n\r\nimport { CustomizationRule } from \"../customization/CustomizationRule\";\r\nimport { RuleBase } from \"../Rule\";\r\nimport { ChildNodeRule } from \"./ChildNodeRule\";\r\nimport { ChildNodeSpecification } from \"./ChildNodeSpecification\";\r\nimport { RootNodeRule } from \"./RootNodeRule\";\r\nimport { SubCondition } from \"./SubCondition\";\r\n\r\n/**\r\n * Base class for all [[NavigationRule]] implementations.\r\n *\r\n * @see [Hierarchies reference documentation page]($docs/presentation/hierarchies/index.md)\r\n * @public\r\n */\r\nexport interface NavigationRuleBase extends RuleBase {\r\n  /**\r\n   * Defines a condition which needs to be met in order for the rule to be used. The condition is an\r\n   * [ECExpression]($docs/presentation/hierarchies/ECExpressions.md#rule-condition) which has to evaluate\r\n   * to a boolean value.\r\n   */\r\n  condition?: string;\r\n\r\n  /**\r\n   * A list of hierarchy specifications that define what nodes are going to be returned.\r\n   */\r\n  specifications?: ChildNodeSpecification[];\r\n\r\n  /**\r\n   * A list of [customization rules]($docs/presentation/hierarchies/index.md#hierarchy-customization) that\r\n   * apply only to nodes produced by this rule.\r\n   */\r\n  customizationRules?: CustomizationRule[];\r\n\r\n  /**\r\n   * A list of sub-rules which share *placement attributes* and\r\n   * [nested customization rules]($docs/presentation/hierarchies/ChildNodeRule.md#attribute-customizationrules)\r\n   * of the hierarchy rule. This means the attributes of hierarchy rule are still in effect and the sub-rules\r\n   * can add additional condition of their own.\r\n   */\r\n  subConditions?: SubCondition[];\r\n\r\n  /**\r\n   * Stop processing rules that have lower priority. Used in cases when recursion suppression is needed.\r\n   */\r\n  stopFurtherProcessing?: boolean;\r\n}\r\n\r\n/**\r\n * Navigation rules are used to define hierarchies displayed in tree components.\r\n *\r\n * @see [Hierarchies reference documentation page]($docs/presentation/hierarchies/index.md)\r\n * @public\r\n */\r\nexport type NavigationRule = RootNodeRule | ChildNodeRule;\r\n"]}
+{"version":3,"file":"NavigationRule.js","sourceRoot":"","sources":["../../../../../src/presentation-common/rules/hierarchy/NavigationRule.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG","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/** @packageDocumentation\n * @module PresentationRules\n */\n\nimport { CustomizationRule } from \"../customization/CustomizationRule\";\nimport { RuleBase } from \"../Rule\";\nimport { ChildNodeRule } from \"./ChildNodeRule\";\nimport { ChildNodeSpecification } from \"./ChildNodeSpecification\";\nimport { RootNodeRule } from \"./RootNodeRule\";\nimport { SubCondition } from \"./SubCondition\";\n\n/**\n * Base class for all [[NavigationRule]] implementations.\n *\n * @see [Hierarchies reference documentation page]($docs/presentation/hierarchies/index.md)\n * @public\n */\nexport interface NavigationRuleBase extends RuleBase {\n  /**\n   * Defines a condition which needs to be met in order for the rule to be used. The condition is an\n   * [ECExpression]($docs/presentation/hierarchies/ECExpressions.md#rule-condition) which has to evaluate\n   * to a boolean value.\n   */\n  condition?: string;\n\n  /**\n   * A list of hierarchy specifications that define what nodes are going to be returned.\n   */\n  specifications?: ChildNodeSpecification[];\n\n  /**\n   * A list of [customization rules]($docs/presentation/hierarchies/index.md#hierarchy-customization) that\n   * apply only to nodes produced by this rule.\n   */\n  customizationRules?: CustomizationRule[];\n\n  /**\n   * A list of sub-rules which share *placement attributes* and\n   * [nested customization rules]($docs/presentation/hierarchies/ChildNodeRule.md#attribute-customizationrules)\n   * of the hierarchy rule. This means the attributes of hierarchy rule are still in effect and the sub-rules\n   * can add additional condition of their own.\n   */\n  subConditions?: SubCondition[];\n\n  /**\n   * Stop processing rules that have lower priority. Used in cases when recursion suppression is needed.\n   */\n  stopFurtherProcessing?: boolean;\n}\n\n/**\n * Navigation rules are used to define hierarchies displayed in tree components.\n *\n * @see [Hierarchies reference documentation page]($docs/presentation/hierarchies/index.md)\n * @public\n */\nexport type NavigationRule = RootNodeRule | ChildNodeRule;\n"]}