@itwin/presentation-common 3.2.0-dev.6 → 3.2.0-dev.62

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

@@ -1,16 +1,15 @@
 /** @packageDocumentation
  * @module PresentationRules
  */
-import { ConditionContainer, RuleTypes } from "../Rule";
+import { RuleTypes } from "../Rule";
 import { NavigationRuleBase } from "./NavigationRule";
 /**
- * Child node rules define nodes that are displayed at
- * each child hierarchy level.
+ * Child node rules are used to define child nodes in a hierarchy.
  *
- * @see [More details]($docs/presentation/Hierarchies/ChildNodeRule.md)
+ * @see [Child node rule reference documentation page]($docs/presentation/hierarchies/ChildNodeRule.md)
  * @public
  */
-export interface ChildNodeRule extends NavigationRuleBase, ConditionContainer {
+export interface ChildNodeRule extends NavigationRuleBase {
     /** Used for serializing to JSON. */
     ruleType: RuleTypes.ChildNodes;
 }

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

@@ -1 +1 @@
-{"version":3,"file":"ChildNodeRule.d.ts","sourceRoot":"","sources":["../../../../../src/presentation-common/rules/hierarchy/ChildNodeRule.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,kBAAkB,EAAE,SAAS,EAAE,MAAM,SAAS,CAAC;AACxD,OAAO,EAAE,kBAAkB,EAAE,MAAM,kBAAkB,CAAC;AAEtD;;;;;;GAMG;AACH,MAAM,WAAW,aAAc,SAAQ,kBAAkB,EAAE,kBAAkB;IAC3E,oCAAoC;IACpC,QAAQ,EAAE,SAAS,CAAC,UAAU,CAAC;CAChC"}
+{"version":3,"file":"ChildNodeRule.d.ts","sourceRoot":"","sources":["../../../../../src/presentation-common/rules/hierarchy/ChildNodeRule.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,SAAS,EAAE,MAAM,SAAS,CAAC;AACpC,OAAO,EAAE,kBAAkB,EAAE,MAAM,kBAAkB,CAAC;AAEtD;;;;;GAKG;AACH,MAAM,WAAW,aAAc,SAAQ,kBAAkB;IACvD,oCAAoC;IACpC,QAAQ,EAAE,SAAS,CAAC,UAAU,CAAC;CAChC"}

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

@@ -1 +1 @@
-{"version":3,"file":"ChildNodeRule.js","sourceRoot":"","sources":["../../../../../src/presentation-common/rules/hierarchy/ChildNodeRule.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 { ConditionContainer, RuleTypes } from \"../Rule\";\r\nimport { NavigationRuleBase } from \"./NavigationRule\";\r\n\r\n/**\r\n * Child node rules define nodes that are displayed at\r\n * each child hierarchy level.\r\n *\r\n * @see [More details]($docs/presentation/Hierarchies/ChildNodeRule.md)\r\n * @public\r\n */\r\nexport interface ChildNodeRule extends NavigationRuleBase, ConditionContainer {\r\n  /** Used for serializing to JSON. */\r\n  ruleType: RuleTypes.ChildNodes;\r\n}\r\n"]}
+{"version":3,"file":"ChildNodeRule.js","sourceRoot":"","sources":["../../../../../src/presentation-common/rules/hierarchy/ChildNodeRule.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 { RuleTypes } from \"../Rule\";\r\nimport { NavigationRuleBase } from \"./NavigationRule\";\r\n\r\n/**\r\n * Child node rules are used to define child nodes in a hierarchy.\r\n *\r\n * @see [Child node rule reference documentation page]($docs/presentation/hierarchies/ChildNodeRule.md)\r\n * @public\r\n */\r\nexport interface ChildNodeRule extends NavigationRuleBase {\r\n  /** Used for serializing to JSON. */\r\n  ruleType: RuleTypes.ChildNodes;\r\n}\r\n"]}

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

@@ -18,82 +18,80 @@ export declare enum ChildNodeSpecificationTypes {
     CustomNode = "CustomNode"
 }
 /**
- * Base interface for all [[ChildNodeSpecification]] implementations. Not
- * meant to be used directly, see `ChildNodeSpecification`.
+ * Base interface for all [[ChildNodeSpecification]] implementations.
  *
+ * @see [Child node specifications reference documentation section]($docs/presentation/hierarchies/ChildNodeRule.md#attribute-specifications)
  * @public
  */
 export interface ChildNodeSpecificationBase {
     /** Used for serializing to JSON. */
     specType: ChildNodeSpecificationTypes;
     /**
-     * Defines the order in which specifications are evaluated and executed. Defaults to `1000`.
+     * Controls the order in which specifications are handled — specification with higher priority value is
+     * handled first. If priorities are equal, the specifications are handled in the order they appear in the
+     * ruleset.
      *
      * @type integer
      */
     priority?: number;
     /**
-     * This tells the rules engine that nodes produced using this
-     * specification always or never have children. Defaults to `Unknown`.
-     *
-     * **Note:** setting this flag to `Always` or `Never` improves performance.
+     * This attribute allows telling the engine that nodes created by this specification always or never have children.
      */
     hasChildren?: "Always" | "Never" | "Unknown";
     /**
-     * Hide instance nodes provided by this specification and directly show nodes of its children.
-     * This helps if you need to define related instance nodes of particular parent node that is not available in the
-     * hierarchy.
+     * When `true`, instances nodes produced by this specification are omitted and their children appear one
+     * hierarchy level higher.
      */
     hideNodesInHierarchy?: boolean;
     /**
-     * Hide nodes if they don't have children.
+     * Specifies whether nodes created through this specification should be hidden if they have no child nodes.
      */
     hideIfNoChildren?: boolean;
     /**
-     * An [ECExpression]($docs/presentation/Hierarchies/ECExpressions.md#specification) which
-     * indicates whether a node should be hidden or not.
-     *
-     * @note While the attribute provides much flexibility, it also has performance implications - it's
-     * strongly suggested to first consider using `instanceFilter`, `hideNodesInHierarchy` or `hideIfNoChildren`
-     * and only use `hideExpression` if none of them are sufficient.
+     * When specified [ECExpression]($docs/presentation/hierarchies/ECExpressions.md#specification) evaluates
+     * to `true`, nodes produced by this specification are omitted and their children appear one hierarchy level
+     * higher.
      */
     hideExpression?: string;
     /**
-     * Set this flag to `true` to suppress default sorting of ECInstances returned by this specification.
-     *
-     * **Note:** setting this flag to `true` improves performance.
+     * Suppress sorting of nodes returned by this specification. With this attribute set to `true`, the order
+     * of returned nodes is undefined.
      */
     doNotSort?: boolean;
     /**
-     * Suppress similar ancestor nodes' checking when creating nodes based on this specification.
-     *
-     * By default we stop creating hierarchy at the node that has a similar ancestor representing
-     * the same ECInstance and created using the same specification to prevent creating infinite
-     * hierarchies. With this flag enabled, we allow up to 10 similar ancestors before we consider
-     * the hierarchy infinite.
+     * Specifies whether similar ancestor nodes' checking should be suppressed when creating nodes based on this
+     * specification. See more in [infinite hierarchies prevention page]($docs/presentation/hierarchies/InfiniteHierarchiesPrevention.md).
      *
      * @beta
      */
     suppressSimilarAncestorsCheck?: boolean;
-    /** Specifications of related instances that can be used in nodes' creation. */
+    /**
+     * Specifications of [related instances]($docs/presentation/RelatedInstanceSpecification.md) that can be used
+     * when creating the nodes.
+     */
     relatedInstances?: RelatedInstanceSpecification[];
-    /** [Nested rule]($docs/presentation/Hierarchies/Terminology.md#nested-rule) specifications. */
+    /**
+     * Specifications of [nested child node rules]($docs/presentation/hierarchies/Terminology.md#nested-rule) that
+     * allow creating child nodes without the need of supplying a condition to match the parent node.
+     */
     nestedRules?: ChildNodeRule[];
 }
 /**
  * A container of default grouping properties. Used for specifications that support
- * default grouping. Not meant to be used directly, see `ChildNodeSpecification`.
+ * default grouping. Not meant to be used directly, see [[ChildNodeSpecification]].
  *
  * @public
  */
 export interface DefaultGroupingPropertiesContainer {
-    /** Group instances by ECClass. Defaults to `true`. */
+    /** Controls whether returned instances should be grouped by ECClass. Defaults to `true`. */
     groupByClass?: boolean;
-    /** Group instances by label. Defaults to `true`. */
+    /** Controls whether returned instances should be grouped by label. Defaults to `true`. */
     groupByLabel?: boolean;
 }
 /**
- * Navigation rule specifications that define what content the rule results in.
+ * Hierarchy rule specifications that define what nodes are going to be returned by the rule.
+ *
+ * @see [Child node specifications reference documentation section]($docs/presentation/hierarchies/ChildNodeRule.md#attribute-specifications)
  * @public
  */
 export declare type ChildNodeSpecification = CustomNodeSpecification | InstanceNodesOfSpecificClassesSpecification | RelatedInstanceNodesSpecification | CustomQueryInstanceNodesSpecification;

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

@@ -1 +1 @@
-{"version":3,"file":"ChildNodeSpecification.d.ts","sourceRoot":"","sources":["../../../../../src/presentation-common/rules/hierarchy/ChildNodeSpecification.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,4BAA4B,EAAE,MAAM,iCAAiC,CAAC;AAC/E,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAChD,OAAO,EAAE,uBAAuB,EAAE,MAAM,2BAA2B,CAAC;AACpE,OAAO,EAAE,qCAAqC,EAAE,MAAM,yCAAyC,CAAC;AAChG,OAAO,EAAE,2CAA2C,EAAE,MAAM,+CAA+C,CAAC;AAC5G,OAAO,EAAE,iCAAiC,EAAE,MAAM,qCAAqC,CAAC;AAExF;;;GAGG;AACH,oBAAY,2BAA2B;IAErC,oBAAoB,yBAAyB;IAC7C,8BAA8B,mCAAmC;IACjE,wBAAwB,6BAA6B;IACrD,UAAU,eAAe;CAC1B;AAED;;;;;GAKG;AACH,MAAM,WAAW,0BAA0B;IACzC,oCAAoC;IACpC,QAAQ,EAAE,2BAA2B,CAAC;IAEtC;;;;OAIG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;;;;OAKG;IACH,WAAW,CAAC,EAAE,QAAQ,GAAG,OAAO,GAAG,SAAS,CAAC;IAE7C;;;;OAIG;IACH,oBAAoB,CAAC,EAAE,OAAO,CAAC;IAE/B;;OAEG;IACH,gBAAgB,CAAC,EAAE,OAAO,CAAC;IAE3B;;;;;;;OAOG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB;;;;OAIG;IACH,SAAS,CAAC,EAAE,OAAO,CAAC;IAEpB;;;;;;;;;OASG;IACH,6BAA6B,CAAC,EAAE,OAAO,CAAC;IAExC,+EAA+E;IAC/E,gBAAgB,CAAC,EAAE,4BAA4B,EAAE,CAAC;IAElD,+FAA+F;IAC/F,WAAW,CAAC,EAAE,aAAa,EAAE,CAAC;CAC/B;AAED;;;;;GAKG;AACH,MAAM,WAAW,kCAAkC;IACjD,sDAAsD;IACtD,YAAY,CAAC,EAAE,OAAO,CAAC;IAEvB,oDAAoD;IACpD,YAAY,CAAC,EAAE,OAAO,CAAC;CACxB;AAED;;;GAGG;AACH,oBAAY,sBAAsB,GAChC,uBAAuB,GAAG,2CAA2C,GACrE,iCAAiC,GAAG,qCAAqC,CAAC"}
+{"version":3,"file":"ChildNodeSpecification.d.ts","sourceRoot":"","sources":["../../../../../src/presentation-common/rules/hierarchy/ChildNodeSpecification.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,4BAA4B,EAAE,MAAM,iCAAiC,CAAC;AAC/E,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAChD,OAAO,EAAE,uBAAuB,EAAE,MAAM,2BAA2B,CAAC;AACpE,OAAO,EAAE,qCAAqC,EAAE,MAAM,yCAAyC,CAAC;AAChG,OAAO,EAAE,2CAA2C,EAAE,MAAM,+CAA+C,CAAC;AAC5G,OAAO,EAAE,iCAAiC,EAAE,MAAM,qCAAqC,CAAC;AAExF;;;GAGG;AACH,oBAAY,2BAA2B;IAErC,oBAAoB,yBAAyB;IAC7C,8BAA8B,mCAAmC;IACjE,wBAAwB,6BAA6B;IACrD,UAAU,eAAe;CAC1B;AAED;;;;;GAKG;AACH,MAAM,WAAW,0BAA0B;IACzC,oCAAoC;IACpC,QAAQ,EAAE,2BAA2B,CAAC;IAEtC;;;;;;OAMG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,WAAW,CAAC,EAAE,QAAQ,GAAG,OAAO,GAAG,SAAS,CAAC;IAE7C;;;OAGG;IACH,oBAAoB,CAAC,EAAE,OAAO,CAAC;IAE/B;;OAEG;IACH,gBAAgB,CAAC,EAAE,OAAO,CAAC;IAE3B;;;;OAIG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB;;;OAGG;IACH,SAAS,CAAC,EAAE,OAAO,CAAC;IAEpB;;;;;OAKG;IACH,6BAA6B,CAAC,EAAE,OAAO,CAAC;IAExC;;;OAGG;IACH,gBAAgB,CAAC,EAAE,4BAA4B,EAAE,CAAC;IAElD;;;OAGG;IACH,WAAW,CAAC,EAAE,aAAa,EAAE,CAAC;CAC/B;AAED;;;;;GAKG;AACH,MAAM,WAAW,kCAAkC;IACjD,4FAA4F;IAC5F,YAAY,CAAC,EAAE,OAAO,CAAC;IAEvB,0FAA0F;IAC1F,YAAY,CAAC,EAAE,OAAO,CAAC;CACxB;AAED;;;;;GAKG;AACH,oBAAY,sBAAsB,GAChC,uBAAuB,GAAG,2CAA2C,GACrE,iCAAiC,GAAG,qCAAqC,CAAC"}

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. Not\r\n * meant to be used directly, see `ChildNodeSpecification`.\r\n *\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   * Defines the order in which specifications are evaluated and executed. Defaults to `1000`.\r\n   *\r\n   * @type integer\r\n   */\r\n  priority?: number;\r\n\r\n  /**\r\n   * This tells the rules engine that nodes produced using this\r\n   * specification always or never have children. Defaults to `Unknown`.\r\n   *\r\n   * **Note:** setting this flag to `Always` or `Never` improves performance.\r\n   */\r\n  hasChildren?: \"Always\" | \"Never\" | \"Unknown\";\r\n\r\n  /**\r\n   * Hide instance nodes provided by this specification and directly show nodes of its children.\r\n   * This helps if you need to define related instance nodes of particular parent node that is not available in the\r\n   * hierarchy.\r\n   */\r\n  hideNodesInHierarchy?: boolean;\r\n\r\n  /**\r\n   * Hide nodes if they don't have children.\r\n   */\r\n  hideIfNoChildren?: boolean;\r\n\r\n  /**\r\n   * An [ECExpression]($docs/presentation/Hierarchies/ECExpressions.md#specification) which\r\n   * indicates whether a node should be hidden or not.\r\n   *\r\n   * @note While the attribute provides much flexibility, it also has performance implications - it's\r\n   * strongly suggested to first consider using `instanceFilter`, `hideNodesInHierarchy` or `hideIfNoChildren`\r\n   * and only use `hideExpression` if none of them are sufficient.\r\n   */\r\n  hideExpression?: string;\r\n\r\n  /**\r\n   * Set this flag to `true` to suppress default sorting of ECInstances returned by this specification.\r\n   *\r\n   * **Note:** setting this flag to `true` improves performance.\r\n   */\r\n  doNotSort?: boolean;\r\n\r\n  /**\r\n   * Suppress similar ancestor nodes' checking when creating nodes based on this specification.\r\n   *\r\n   * By default we stop creating hierarchy at the node that has a similar ancestor representing\r\n   * the same ECInstance and created using the same specification to prevent creating infinite\r\n   * hierarchies. With this flag enabled, we allow up to 10 similar ancestors before we consider\r\n   * the hierarchy infinite.\r\n   *\r\n   * @beta\r\n   */\r\n  suppressSimilarAncestorsCheck?: boolean;\r\n\r\n  /** Specifications of related instances that can be used in nodes' creation. */\r\n  relatedInstances?: RelatedInstanceSpecification[];\r\n\r\n  /** [Nested rule]($docs/presentation/Hierarchies/Terminology.md#nested-rule) specifications. */\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  /** Group instances by ECClass. Defaults to `true`. */\r\n  groupByClass?: boolean;\r\n\r\n  /** Group instances by label. Defaults to `true`. */\r\n  groupByLabel?: boolean;\r\n}\r\n\r\n/**\r\n * Navigation rule specifications that define what content the rule results in.\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":["/*---------------------------------------------------------------------------------------------\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"]}

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

@@ -3,25 +3,30 @@
  */
 import { ChildNodeSpecificationBase, ChildNodeSpecificationTypes } from "./ChildNodeSpecification";
 /**
- * Creates a custom-defined node.
+ * Returns a static custom-defined node that's not based on an ECInstance.
  *
- * @see [More details]($docs/presentation/Hierarchies/CustomNode.md)
+ * @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;
-    /** Type of the node. */
+    /** Specifies node type, which is assigned to node's key. */
     type: string;
     /**
-     * Label of the node. May be [localized]($docs/presentation/Advanced/Localization.md).
+     * Specifies node label. This is a string value that may be [localized]($docs/presentation/advanced/Localization.md).
      */
     label: string;
     /**
-     * Description of the node. May be [localized]($docs/presentation/Advanced/Localization.md).
+     * 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;
-    /** Id of the image to use for this custom node. */
+    /**
+     * 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.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"CustomNodeSpecification.d.ts","sourceRoot":"","sources":["../../../../../src/presentation-common/rules/hierarchy/CustomNodeSpecification.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,0BAA0B,EAAE,2BAA2B,EAAE,MAAM,0BAA0B,CAAC;AAEnG;;;;;GAKG;AACH,MAAM,WAAW,uBAAwB,SAAQ,0BAA0B;IACzE,oCAAoC;IACpC,QAAQ,EAAE,2BAA2B,CAAC,UAAU,CAAC;IAEjD,wBAAwB;IACxB,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB,mDAAmD;IACnD,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB"}
+{"version":3,"file":"CustomNodeSpecification.d.ts","sourceRoot":"","sources":["../../../../../src/presentation-common/rules/hierarchy/CustomNodeSpecification.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,0BAA0B,EAAE,2BAA2B,EAAE,MAAM,0BAA0B,CAAC;AAEnG;;;;;GAKG;AACH,MAAM,WAAW,uBAAwB,SAAQ,0BAA0B;IACzE,oCAAoC;IACpC,QAAQ,EAAE,2BAA2B,CAAC,UAAU,CAAC;IAEjD,4DAA4D;IAC5D,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;;;OAIG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;;OAGG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB"}

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 * Creates a custom-defined node.\r\n *\r\n * @see [More details]($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  /** Type of the node. */\r\n  type: string;\r\n\r\n  /**\r\n   * Label of the node. May be [localized]($docs/presentation/Advanced/Localization.md).\r\n   */\r\n  label: string;\r\n\r\n  /**\r\n   * Description of the node. May be [localized]($docs/presentation/Advanced/Localization.md).\r\n   */\r\n  description?: string;\r\n\r\n  /** Id of the image to use for this custom node. */\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":["/*---------------------------------------------------------------------------------------------\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"]}

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

@@ -4,25 +4,24 @@
 import { SingleSchemaClassSpecification } from "../ClassSpecifications";
 import { ChildNodeSpecificationBase, ChildNodeSpecificationTypes, DefaultGroupingPropertiesContainer } from "./ChildNodeSpecification";
 /**
- * Creates nodes for instances which are returned by an ECSQL query.
+ * Returns nodes for instances returned by a provided ECSQL query.
  *
- * **Note:** this specification is formerly known as `SearchResultInstanceNodesSpecification`.
- *
- * @see [More details]($docs/presentation/Hierarchies/CustomQueryInstanceNodes.md)
+ * @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.
-     *
-     * **Note:** if more than one search query is specified, the results get merged.
+     * 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;
@@ -35,18 +34,23 @@ export declare enum QuerySpecificationTypes {
     ECPropertyValue = "ECPropertyValue"
 }
 /**
- * Base interface for all [[QuerySpecification]] implementations. Not meant
- * to be used directly, see `QuerySpecification`.
+ * 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. */
+    /**
+     * 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;
 }
 /**
- * Specification which contains an ECSQL query used to query for instances.
+ * 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 {
@@ -56,22 +60,17 @@ export interface StringQuerySpecification extends QuerySpecificationBase {
     query: string;
 }
 /**
- * Specification which specifies the name of the parent instance property whose
- * value is the ECSQL used to query for instances.
- *
- * **Precondition:** can be used only if parent node is ECInstance node.
- * If there is no immediate parent instance node it will go up until it finds one.
+ * 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.
-     *
-     * **Warning:** the property whose name is specified must be of string type.
+     * Specifies name of the parent instance property whose value contains the ECSQL query.
      */
     parentPropertyName: string;
 }

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

@@ -1 +1 @@
-{"version":3,"file":"CustomQueryInstanceNodesSpecification.d.ts","sourceRoot":"","sources":["../../../../../src/presentation-common/rules/hierarchy/CustomQueryInstanceNodesSpecification.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,8BAA8B,EAAE,MAAM,wBAAwB,CAAC;AACxE,OAAO,EAAE,0BAA0B,EAAE,2BAA2B,EAAE,kCAAkC,EAAE,MAAM,0BAA0B,CAAC;AAEvI;;;;;;;GAOG;AACH,MAAM,WAAW,qCAAsC,SAAQ,0BAA0B,EAAE,kCAAkC;IAC3H,oCAAoC;IACpC,QAAQ,EAAE,2BAA2B,CAAC,wBAAwB,CAAC;IAE/D;;;;OAIG;IACH,OAAO,CAAC,EAAE,kBAAkB,EAAE,CAAC;CAChC;AAED;;;GAGG;AACH,MAAM,CAAC,OAAO,MAAM,kBAAkB,GAAG,wBAAwB,GAAG,iCAAiC,CAAC;AAEtG;;;GAGG;AACH,oBAAY,uBAAuB;IACjC,MAAM,WAAW;IACjB,eAAe,oBAAoB;CACpC;AAED;;;;GAIG;AACH,MAAM,WAAW,sBAAsB;IACrC,oCAAoC;IACpC,QAAQ,EAAE,uBAAuB,CAAC;IAElC,kEAAkE;IAClE,KAAK,EAAE,8BAA8B,CAAC;CACvC;AAED;;;GAGG;AACH,MAAM,WAAW,wBAAyB,SAAQ,sBAAsB;IACtE,oCAAoC;IACpC,QAAQ,EAAE,uBAAuB,CAAC,MAAM,CAAC;IAEzC,wCAAwC;IACxC,KAAK,EAAE,MAAM,CAAC;CACf;AAED;;;;;;;;GAQG;AACH,MAAM,WAAW,iCAAkC,SAAQ,sBAAsB;IAC/E,oCAAoC;IACpC,QAAQ,EAAE,uBAAuB,CAAC,eAAe,CAAC;IAElD;;;;;OAKG;IACH,kBAAkB,EAAE,MAAM,CAAC;CAC5B"}
+{"version":3,"file":"CustomQueryInstanceNodesSpecification.d.ts","sourceRoot":"","sources":["../../../../../src/presentation-common/rules/hierarchy/CustomQueryInstanceNodesSpecification.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,8BAA8B,EAAE,MAAM,wBAAwB,CAAC;AACxE,OAAO,EAAE,0BAA0B,EAAE,2BAA2B,EAAE,kCAAkC,EAAE,MAAM,0BAA0B,CAAC;AAEvI;;;;;GAKG;AACH,MAAM,WAAW,qCAAsC,SAAQ,0BAA0B,EAAE,kCAAkC;IAC3H,oCAAoC;IACpC,QAAQ,EAAE,2BAA2B,CAAC,wBAAwB,CAAC;IAE/D;;;OAGG;IACH,OAAO,CAAC,EAAE,kBAAkB,EAAE,CAAC;CAChC;AAED;;;;;GAKG;AACH,MAAM,CAAC,OAAO,MAAM,kBAAkB,GAAG,wBAAwB,GAAG,iCAAiC,CAAC;AAEtG;;;GAGG;AACH,oBAAY,uBAAuB;IACjC,MAAM,WAAW;IACjB,eAAe,oBAAoB;CACpC;AAED;;;GAGG;AACH,MAAM,WAAW,sBAAsB;IACrC,oCAAoC;IACpC,QAAQ,EAAE,uBAAuB,CAAC;IAElC;;;;OAIG;IACH,KAAK,EAAE,8BAA8B,CAAC;CACvC;AAED;;;;;GAKG;AACH,MAAM,WAAW,wBAAyB,SAAQ,sBAAsB;IACtE,oCAAoC;IACpC,QAAQ,EAAE,uBAAuB,CAAC,MAAM,CAAC;IAEzC,wCAAwC;IACxC,KAAK,EAAE,MAAM,CAAC;CACf;AAED;;;;;;GAMG;AACH,MAAM,WAAW,iCAAkC,SAAQ,sBAAsB;IAC/E,oCAAoC;IACpC,QAAQ,EAAE,uBAAuB,CAAC,eAAe,CAAC;IAElD;;OAEG;IACH,kBAAkB,EAAE,MAAM,CAAC;CAC5B"}

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;;;AA+BH;;;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 * Creates nodes for instances which are returned by an ECSQL query.\r\n *\r\n * **Note:** this specification is formerly known as `SearchResultInstanceNodesSpecification`.\r\n *\r\n * @see [More details]($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.\r\n   *\r\n   * **Note:** if more than one search query is specified, the results get merged.\r\n   */\r\n  queries?: QuerySpecification[];\r\n}\r\n\r\n/**\r\n * Query specifications used in [[CustomQueryInstanceNodesSpecification]].\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. Not meant\r\n * to be used directly, see `QuerySpecification`.\r\n * @public\r\n */\r\nexport interface QuerySpecificationBase {\r\n  /** Used for serializing to JSON. */\r\n  specType: QuerySpecificationTypes;\r\n\r\n  /** Specification of ECClass whose instances the query returns. */\r\n  class: SingleSchemaClassSpecification;\r\n}\r\n\r\n/**\r\n * Specification which contains an ECSQL query used to query for instances.\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 * Specification which specifies the name of the parent instance property whose\r\n * value is the ECSQL used to query for instances.\r\n *\r\n * **Precondition:** can be used only if parent node is ECInstance node.\r\n * If there is no immediate parent instance node it will go up until it finds one.\r\n *\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\r\n   * contains the ECSQL query.\r\n   *\r\n   * **Warning:** the property whose name is specified must be of string type.\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":["/*---------------------------------------------------------------------------------------------\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"]}

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

@@ -4,32 +4,36 @@
 import { MultiSchemaClassesSpecification } from "../ClassSpecifications";
 import { ChildNodeSpecificationBase, ChildNodeSpecificationTypes, DefaultGroupingPropertiesContainer } from "./ChildNodeSpecification";
 /**
- * Creates nodes for all instances of specified ECClasses.
+ * Returns nodes for instances of specific ECClasses.
  *
- * @see [More details]($docs/presentation/Hierarchies/InstanceNodesOfSpecificClasses.md)
+ * @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;
     /**
-     * Specifications of ECClasses whose instances should be returned.
+     * 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[];
     /**
-     * Specifications of ECClasses whose instances should be excluded.
+     * 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[];
     /**
-     * Whether to get instances from derived `classes`.
-     * Acts as default value for [[classes.arePolymorphic]] and [[excludedClasses.arePolymorphic]].
-     * @deprecated Specify polymorphism value inside [[classes.arePolymorphic]] or [[excludedClasses.arePolymorphic]].
+     * 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;
     /**
-     * Condition for filtering instances of defined classes.
-     *
-     * **See:** [ECExpressions Available in InstanceFilter]($docs/presentation/Hierarchies/ECExpressions.md#instance-filter).
+     * Specifies an [ECExpression]($docs/presentation/hierarchies/ECExpressions.md#instance-filter) for filtering
+     * instances of ECClasses specified through the [[classes]] attribute.
      */
     instanceFilter?: string;
 }

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

@@ -1 +1 @@
-{"version":3,"file":"InstanceNodesOfSpecificClassesSpecification.d.ts","sourceRoot":"","sources":["../../../../../src/presentation-common/rules/hierarchy/InstanceNodesOfSpecificClassesSpecification.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,+BAA+B,EAAE,MAAM,wBAAwB,CAAC;AACzE,OAAO,EAAE,0BAA0B,EAAE,2BAA2B,EAAE,kCAAkC,EAAE,MAAM,0BAA0B,CAAC;AAEvI;;;;;GAKG;AACH,MAAM,WAAW,2CAA4C,SAAQ,0BAA0B,EAAE,kCAAkC;IACjI,oCAAoC;IACpC,QAAQ,EAAE,2BAA2B,CAAC,8BAA8B,CAAC;IAErE;;OAEG;IACH,OAAO,EAAE,+BAA+B,GAAG,+BAA+B,EAAE,CAAC;IAE7E;;OAEG;IACH,eAAe,CAAC,EAAE,+BAA+B,GAAG,+BAA+B,EAAE,CAAC;IAEtF;;;;OAIG;IACH,cAAc,CAAC,EAAE,OAAO,CAAC;IAEzB;;;;OAIG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;CACzB"}
+{"version":3,"file":"InstanceNodesOfSpecificClassesSpecification.d.ts","sourceRoot":"","sources":["../../../../../src/presentation-common/rules/hierarchy/InstanceNodesOfSpecificClassesSpecification.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,+BAA+B,EAAE,MAAM,wBAAwB,CAAC;AACzE,OAAO,EAAE,0BAA0B,EAAE,2BAA2B,EAAE,kCAAkC,EAAE,MAAM,0BAA0B,CAAC;AAEvI;;;;;GAKG;AACH,MAAM,WAAW,2CAA4C,SAAQ,0BAA0B,EAAE,kCAAkC;IACjI,oCAAoC;IACpC,QAAQ,EAAE,2BAA2B,CAAC,8BAA8B,CAAC;IAErE;;;OAGG;IACH,OAAO,EAAE,+BAA+B,GAAG,+BAA+B,EAAE,CAAC;IAE7E;;;OAGG;IACH,eAAe,CAAC,EAAE,+BAA+B,GAAG,+BAA+B,EAAE,CAAC;IAEtF;;;;;;;OAOG;IACH,cAAc,CAAC,EAAE,OAAO,CAAC;IAEzB;;;OAGG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;CACzB"}

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 * Creates nodes for all instances of specified ECClasses.\r\n *\r\n * @see [More details]($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   * Specifications of ECClasses whose instances should be returned.\r\n   */\r\n  classes: MultiSchemaClassesSpecification | MultiSchemaClassesSpecification[];\r\n\r\n  /**\r\n   * Specifications of ECClasses whose instances should be excluded.\r\n   */\r\n  excludedClasses?: MultiSchemaClassesSpecification | MultiSchemaClassesSpecification[];\r\n\r\n  /**\r\n   * Whether to get instances from derived `classes`.\r\n   * Acts as default value for [[classes.arePolymorphic]] and [[excludedClasses.arePolymorphic]].\r\n   * @deprecated Specify polymorphism value inside [[classes.arePolymorphic]] or [[excludedClasses.arePolymorphic]].\r\n   */\r\n  arePolymorphic?: boolean;\r\n\r\n  /**\r\n   * Condition for filtering instances of defined classes.\r\n   *\r\n   * **See:** [ECExpressions Available in InstanceFilter]($docs/presentation/Hierarchies/ECExpressions.md#instance-filter).\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":["/*---------------------------------------------------------------------------------------------\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"]}

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

@@ -8,42 +8,43 @@ import { ChildNodeSpecification } from "./ChildNodeSpecification";
 import { RootNodeRule } from "./RootNodeRule";
 import { SubCondition } from "./SubCondition";
 /**
- * Base class for all [[NavigationRule]] implementations. Not
- * meant to be used directly, see `NavigationRule`.
+ * 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 for the rule, which needs to be met in order to execute it. Condition
-     * is an [ECExpression]($docs/presentation/Advanced/ECExpressions.md), which can use
-     * a [limited set of symbols]($docs/presentation/Hierarchies/ECExpressions.md#rule-condition).
+     * 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;
     /**
-     * Specifications that define what content the rule returns.
+     * A list of hierarchy specifications that define what nodes are going to be returned.
      */
     specifications?: ChildNodeSpecification[];
     /**
-     * Customization rules that are applied for the content returned by
-     * this rule.
+     * A list of [customization rules]($docs/presentation/hierarchies/index.md#hierarchy-customization) that
+     * apply only to nodes produced by this rule.
      */
     customizationRules?: CustomizationRule[];
     /**
-     * Specifies child node rules which are only used when specific condition
-     * is satisfied.
+     * 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.
-     *
-     * **Note:** If this flag is set, [[specifications]] and [[subConditions]] are not processed.
+     * Stop processing rules that have lower priority. Used in cases when recursion suppression is needed.
      */
     stopFurtherProcessing?: boolean;
 }
 /**
- * Navigation rules define the hierarchy that's created for navigation controls.
+ * 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;

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

@@ -1 +1 @@
-{"version":3,"file":"NavigationRule.d.ts","sourceRoot":"","sources":["../../../../../src/presentation-common/rules/hierarchy/NavigationRule.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,iBAAiB,EAAE,MAAM,oCAAoC,CAAC;AACvE,OAAO,EAAE,QAAQ,EAAE,MAAM,SAAS,CAAC;AACnC,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAChD,OAAO,EAAE,sBAAsB,EAAE,MAAM,0BAA0B,CAAC;AAClE,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAC9C,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAE9C;;;;;GAKG;AACH,MAAM,WAAW,kBAAmB,SAAQ,QAAQ;IAClD;;;;OAIG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,cAAc,CAAC,EAAE,sBAAsB,EAAE,CAAC;IAE1C;;;OAGG;IACH,kBAAkB,CAAC,EAAE,iBAAiB,EAAE,CAAC;IAEzC;;;OAGG;IACH,aAAa,CAAC,EAAE,YAAY,EAAE,CAAC;IAE/B;;;;;OAKG;IACH,qBAAqB,CAAC,EAAE,OAAO,CAAC;CACjC;AAED;;;GAGG;AACH,oBAAY,cAAc,GAAG,YAAY,GAAG,aAAa,CAAC"}
+{"version":3,"file":"NavigationRule.d.ts","sourceRoot":"","sources":["../../../../../src/presentation-common/rules/hierarchy/NavigationRule.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,iBAAiB,EAAE,MAAM,oCAAoC,CAAC;AACvE,OAAO,EAAE,QAAQ,EAAE,MAAM,SAAS,CAAC;AACnC,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAChD,OAAO,EAAE,sBAAsB,EAAE,MAAM,0BAA0B,CAAC;AAClE,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAC9C,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAE9C;;;;;GAKG;AACH,MAAM,WAAW,kBAAmB,SAAQ,QAAQ;IAClD;;;;OAIG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,cAAc,CAAC,EAAE,sBAAsB,EAAE,CAAC;IAE1C;;;OAGG;IACH,kBAAkB,CAAC,EAAE,iBAAiB,EAAE,CAAC;IAEzC;;;;;OAKG;IACH,aAAa,CAAC,EAAE,YAAY,EAAE,CAAC;IAE/B;;OAEG;IACH,qBAAqB,CAAC,EAAE,OAAO,CAAC;CACjC;AAED;;;;;GAKG;AACH,oBAAY,cAAc,GAAG,YAAY,GAAG,aAAa,CAAC"}

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. Not\r\n * meant to be used directly, see `NavigationRule`.\r\n *\r\n * @public\r\n */\r\nexport interface NavigationRuleBase extends RuleBase {\r\n  /**\r\n   * Defines a condition for the rule, which needs to be met in order to execute it. Condition\r\n   * is an [ECExpression]($docs/presentation/Advanced/ECExpressions.md), which can use\r\n   * a [limited set of symbols]($docs/presentation/Hierarchies/ECExpressions.md#rule-condition).\r\n   */\r\n  condition?: string;\r\n\r\n  /**\r\n   * Specifications that define what content the rule returns.\r\n   */\r\n  specifications?: ChildNodeSpecification[];\r\n\r\n  /**\r\n   * Customization rules that are applied for the content returned by\r\n   * this rule.\r\n   */\r\n  customizationRules?: CustomizationRule[];\r\n\r\n  /**\r\n   * Specifies child node rules which are only used when specific condition\r\n   * is satisfied.\r\n   */\r\n  subConditions?: SubCondition[];\r\n\r\n  /**\r\n   * Stop processing rules that have lower priority. Used in cases when recursion\r\n   * suppression is needed.\r\n   *\r\n   * **Note:** If this flag is set, [[specifications]] and [[subConditions]] are not processed.\r\n   */\r\n  stopFurtherProcessing?: boolean;\r\n}\r\n\r\n/**\r\n * Navigation rules define the hierarchy that's created for navigation controls.\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":["/*---------------------------------------------------------------------------------------------\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"]}

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

@@ -1,44 +1,25 @@
 /** @packageDocumentation
  * @module PresentationRules
  */
-import { ConditionContainer, RuleBase, RuleTypes } from "../Rule";
+import { RuleBase, RuleTypes } from "../Rule";
 /**
- * Rule used to create and assign artifacts to specific nodes. The artifacts can be
- * accessed when evaluating parent node's `hideExpression` to decide whether it should
- * be hidden or not.
+ * Node artifacts rules are used to create and assign artifacts to specific nodes. The artifacts can be
+ * accessed when evaluating parent node's `hideExpression` to decide whether it should be hidden or not.
  *
- * A typical use case:
- * - The hierarchy consists of *Subject* nodes and each *Subject* may or may not have child *Model* nodes. There are 2 types
- * of *Models*: *A* & *B*, we want *ModelA* nodes to be visible and *ModelB* ones to be hidden. We want *Subject* node to be
- * visible only if it has a *Model* (either *A* or *B*). In this case we can't use `hideIfNoChildren` flag on *Subjects*, because
- * a *Subject* node may only have a related *ModelB* which means *Subject* doesn't have children and should be displayed as a leaf node.
- * The solution is to use `NodeArtifacts` on the *ModelB* nodes and a `hideExpression` on *Subject* nodes. The expression can access
- * artifacts created by child *ModelB* nodes: `NOT ThisNode.HasChildren AND NOT ThisNode.ChildrenArtifacts.AnyMatches(x => x.IsModelB)`
- *
- * @note The rule is costly performance-wise and should only be used in very limited amount of specific cases where
- * hidden child nodes need to be used to used to determine parent node's visibility.
- *
- * @see [More details]($docs/presentation/Hierarchies/NodeArtifactsRule.md)
+ * @see [Node artifacts rule reference documentation page]($docs/presentation/hierarchies/NodeArtifactsRule.md)
  * @public
  */
-export interface NodeArtifactsRule extends RuleBase, ConditionContainer {
+export interface NodeArtifactsRule extends RuleBase {
     /** Used for serializing to JSON. */
     ruleType: RuleTypes.NodeArtifacts;
     /**
-     * Defines a condition for the rule, which needs to be met in order for it to be used. Condition
-     * is an [ECExpression]($docs/presentation/Advanced/ECExpressions.md), which can use
-     * a [limited set of symbols]($docs/presentation/Customization/ECExpressions.md#rule-condition).
+     * Specifies an [ECExpression]($docs/presentation/customization/ECExpressions.md#rule-condition) that
+     * allows applying node artifacts based on evaluation result, e.g. by some property of the parent node.
      */
     condition?: string;
     /**
-     * A map of items that define the values stored in the artifacts data structure.
-     *
-     * The key part of the pair should be unique within all keys which are used for specific
-     * presentation object, even if they are applied using different `NodeArtifacts` definitions.
-     *
-     * The value part of the pair is an [ECExpression]($docs/presentation/Advanced/ECExpressions.md), which can use
-     * a [limited set of symbols]($docs/presentation/Customization/ECExpressions.md#override-value) and whose
-     * evaluated result is used as the artifact value.
+     * A map of [ECExpressions]($docs/presentation/hierarchies/ECExpressions.md#specification) whose evaluation results
+     * are used as artifact values.
      */
     items: {
         [key: string]: string;

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

@@ -1 +1 @@
-{"version":3,"file":"NodeArtifactsRule.d.ts","sourceRoot":"","sources":["../../../../../src/presentation-common/rules/hierarchy/NodeArtifactsRule.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,kBAAkB,EAAE,QAAQ,EAAE,SAAS,EAAE,MAAM,SAAS,CAAC;AAElE;;;;;;;;;;;;;;;;;;GAkBG;AACH,MAAM,WAAW,iBAAkB,SAAQ,QAAQ,EAAE,kBAAkB;IACrE,oCAAoC;IACpC,QAAQ,EAAE,SAAS,CAAC,aAAa,CAAC;IAElC;;;;OAIG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;;;;;;;;OASG;IACH,KAAK,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,CAAC;CAClC"}
+{"version":3,"file":"NodeArtifactsRule.d.ts","sourceRoot":"","sources":["../../../../../src/presentation-common/rules/hierarchy/NodeArtifactsRule.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,QAAQ,EAAE,SAAS,EAAE,MAAM,SAAS,CAAC;AAE9C;;;;;;GAMG;AACH,MAAM,WAAW,iBAAkB,SAAQ,QAAQ;IACjD,oCAAoC;IACpC,QAAQ,EAAE,SAAS,CAAC,aAAa,CAAC;IAElC;;;OAGG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;;OAGG;IACH,KAAK,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,CAAC;CAClC"}