@itwin/presentation-common 3.2.0-dev.7 → 3.2.0-dev.72

package/lib/esm/presentation-common/rules/customization/InstanceLabelOverride.js.map

@@ -1 +1 @@
-{"version":3,"file":"InstanceLabelOverride.js","sourceRoot":"","sources":["../../../../../src/presentation-common/rules/customization/InstanceLabelOverride.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AA+BH;;;GAGG;AACH,MAAM,CAAN,IAAY,2CASX;AATD,WAAY,2CAA2C;IACrD,sEAAuB,CAAA;IACvB,oEAAqB,CAAA;IACrB,sEAAuB,CAAA;IACvB,wEAAyB,CAAA;IACzB,0EAA2B,CAAA;IAC3B,kEAAmB,CAAA;IACnB,gEAAiB,CAAA;IACjB,4FAA6C,CAAA;AAC/C,CAAC,EATW,2CAA2C,KAA3C,2CAA2C,QAStD","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 { RelationshipPathSpecification } from \"../RelationshipPathSpecification\";\r\nimport { RuleBase, RuleTypes } from \"../Rule\";\r\n\r\n/**\r\n * Rule to override labels for instances of specific ECClasses.\r\n *\r\n * **Important:** Prefer this rule over [[LabelOverride]] when possible as it\r\n * has better performance.\r\n *\r\n * @see [More details]($docs/presentation/Customization/InstanceLabelOverride.md)\r\n * @public\r\n */\r\nexport interface InstanceLabelOverride extends RuleBase {\r\n  /** Used for serializing to JSON. */\r\n  ruleType: RuleTypes.InstanceLabelOverride;\r\n\r\n  /**\r\n   * Specification of the ECClass to apply this rule to.\r\n   */\r\n  class: SingleSchemaClassSpecification;\r\n\r\n  /**\r\n   * Specifications for the label value. The first non-empty value\r\n   * is used as the actual label.\r\n   */\r\n  values: InstanceLabelOverrideValueSpecification[];\r\n}\r\n\r\n/**\r\n * Types of possible [[InstanceLabelOverride]] label value.\r\n * @public\r\n */\r\nexport enum InstanceLabelOverrideValueSpecificationType {\r\n  Composite = \"Composite\",\r\n  Property = \"Property\",\r\n  ClassName = \"ClassName\",\r\n  ClassLabel = \"ClassLabel\",\r\n  BriefcaseId = \"BriefcaseId\",\r\n  LocalId = \"LocalId\",\r\n  String = \"String\",\r\n  RelatedInstanceLabel = \"RelatedInstanceLabel\",\r\n}\r\n\r\n/**\r\n * Base interface for all [[InstanceLabelOverrideValueSpecification]] implementations.\r\n * @public\r\n */\r\nexport interface InstanceLabelOverrideValueSpecificationBase {\r\n  /** Type of the specification */\r\n  specType: InstanceLabelOverrideValueSpecificationType;\r\n}\r\n\r\n/**\r\n * Specification that allows creating a label value composited using\r\n * multiple other specifications.\r\n *\r\n * @public\r\n */\r\nexport interface InstanceLabelOverrideCompositeValueSpecification extends InstanceLabelOverrideValueSpecificationBase {\r\n  specType: InstanceLabelOverrideValueSpecificationType.Composite;\r\n\r\n  /**\r\n   * Parts of the value.\r\n   *\r\n   * If any of the parts with `isRequired` flag evaluate to an empty string, the\r\n   * result of this specification is also an empty string.\r\n   */\r\n  parts: Array<{ spec: InstanceLabelOverrideValueSpecification, isRequired?: boolean }>;\r\n\r\n  /** Separator to use when joining the parts. Defaults to a space character. */\r\n  separator?: string;\r\n}\r\n\r\n/**\r\n * Specification that uses property value as the label content.\r\n * @public\r\n */\r\nexport interface InstanceLabelOverridePropertyValueSpecification extends InstanceLabelOverrideValueSpecificationBase {\r\n  specType: InstanceLabelOverrideValueSpecificationType.Property;\r\n\r\n  /**\r\n   * Name of the property whose value should be used.\r\n   * @note A property with this name must exist on the property class (see [[propertySource]]).\r\n   */\r\n  propertyName: string;\r\n\r\n  /**\r\n   * Path from `InstanceLabelOverride.class` to the property class. If omitted,\r\n   * `InstanceLabelOverride.class` is used as property class.\r\n   * @beta\r\n   */\r\n  propertySource?: RelationshipPathSpecification;\r\n}\r\n\r\n/**\r\n * Specification that uses ECClass name as the label content.\r\n * @public\r\n */\r\nexport interface InstanceLabelOverrideClassNameSpecification extends InstanceLabelOverrideValueSpecificationBase {\r\n  specType: InstanceLabelOverrideValueSpecificationType.ClassName;\r\n\r\n  /** Should full (`{schemaName}.{className}`) class name be used */\r\n  full?: boolean;\r\n}\r\n\r\n/**\r\n * Specification that uses ECClass display label as the label content.\r\n * @public\r\n */\r\nexport interface InstanceLabelOverrideClassLabelSpecification extends InstanceLabelOverrideValueSpecificationBase {\r\n  specType: InstanceLabelOverrideValueSpecificationType.ClassLabel;\r\n}\r\n\r\n/**\r\n * Specification that returns ECInstance's briefcase ID in base36 format.\r\n * @public\r\n */\r\nexport interface InstanceLabelOverrideBriefcaseIdSpecification extends InstanceLabelOverrideValueSpecificationBase {\r\n  specType: InstanceLabelOverrideValueSpecificationType.BriefcaseId;\r\n}\r\n\r\n/**\r\n * Specification that returns ECInstance's local ID in base36 format.\r\n * @public\r\n */\r\nexport interface InstanceLabelOverrideLocalIdSpecification extends InstanceLabelOverrideValueSpecificationBase {\r\n  specType: InstanceLabelOverrideValueSpecificationType.LocalId;\r\n}\r\n\r\n/**\r\n * Specification that uses the specified value as the label content.\r\n * @public\r\n */\r\nexport interface InstanceLabelOverrideStringValueSpecification extends InstanceLabelOverrideValueSpecificationBase {\r\n  specType: InstanceLabelOverrideValueSpecificationType.String;\r\n\r\n  /** The value to use as the label content. */\r\n  value: string;\r\n}\r\n\r\n/**\r\n * Specification that uses label of a related instance as the label content.\r\n * @public\r\n */\r\nexport interface InstanceLabelOverrideRelatedInstanceLabelSpecification extends InstanceLabelOverrideValueSpecificationBase {\r\n  specType: InstanceLabelOverrideValueSpecificationType.RelatedInstanceLabel;\r\n\r\n  /**\r\n   * Path from `InstanceLabelOverride.class` to the class of related instance whose label\r\n   * should be returned.\r\n   */\r\n  pathToRelatedInstance: RelationshipPathSpecification;\r\n}\r\n\r\n/**\r\n * Specification to define how the label for [[InstanceLabelOverride]] should be created.\r\n * @public\r\n */\r\nexport type InstanceLabelOverrideValueSpecification =\r\n  InstanceLabelOverrideCompositeValueSpecification | InstanceLabelOverridePropertyValueSpecification |\r\n  InstanceLabelOverrideStringValueSpecification | InstanceLabelOverrideClassNameSpecification |\r\n  InstanceLabelOverrideClassLabelSpecification | InstanceLabelOverrideBriefcaseIdSpecification |\r\n  InstanceLabelOverrideLocalIdSpecification | InstanceLabelOverrideRelatedInstanceLabelSpecification;\r\n"]}
+{"version":3,"file":"InstanceLabelOverride.js","sourceRoot":"","sources":["../../../../../src/presentation-common/rules/customization/InstanceLabelOverride.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AA4BH;;;GAGG;AACH,MAAM,CAAN,IAAY,2CASX;AATD,WAAY,2CAA2C;IACrD,sEAAuB,CAAA;IACvB,oEAAqB,CAAA;IACrB,sEAAuB,CAAA;IACvB,wEAAyB,CAAA;IACzB,0EAA2B,CAAA;IAC3B,kEAAmB,CAAA;IACnB,gEAAiB,CAAA;IACjB,4FAA6C,CAAA;AAC/C,CAAC,EATW,2CAA2C,KAA3C,2CAA2C,QAStD","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 { RelationshipPathSpecification } from \"../RelationshipPathSpecification\";\r\nimport { RuleBase, RuleTypes } from \"../Rule\";\r\n\r\n/**\r\n * Instance label override rule provides a way to set instance label to one of its property values,\r\n * other attributes and/or combination of them.\r\n *\r\n * @see [Instance label override reference documentation page]($docs/presentation/customization/InstanceLabelOverride.md)\r\n * @public\r\n */\r\nexport interface InstanceLabelOverride extends RuleBase {\r\n  /** Used for serializing to JSON. */\r\n  ruleType: RuleTypes.InstanceLabelOverride;\r\n\r\n  /**\r\n   * Specifies the ECClass to apply this rule to.\r\n   */\r\n  class: SingleSchemaClassSpecification;\r\n\r\n  /**\r\n   * Specifications of values used to override label. The first non-empty value is used as the actual label.\r\n   */\r\n  values: InstanceLabelOverrideValueSpecification[];\r\n}\r\n\r\n/**\r\n * Types of possible [[InstanceLabelOverride]] label values.\r\n * @public\r\n */\r\nexport enum InstanceLabelOverrideValueSpecificationType {\r\n  Composite = \"Composite\",\r\n  Property = \"Property\",\r\n  ClassName = \"ClassName\",\r\n  ClassLabel = \"ClassLabel\",\r\n  BriefcaseId = \"BriefcaseId\",\r\n  LocalId = \"LocalId\",\r\n  String = \"String\",\r\n  RelatedInstanceLabel = \"RelatedInstanceLabel\",\r\n}\r\n\r\n/**\r\n * Base interface for all [[InstanceLabelOverrideValueSpecification]] implementations.\r\n * @public\r\n */\r\nexport interface InstanceLabelOverrideValueSpecificationBase {\r\n  /** Type of the specification */\r\n  specType: InstanceLabelOverrideValueSpecificationType;\r\n}\r\n\r\n/**\r\n * Specification allows creating a label value composited using multiple other specifications.\r\n *\r\n * @see [Composite value specification reference documentation page]($docs/presentation/customization/InstanceLabelOverride.md#composite-value-specification)\r\n * @public\r\n */\r\nexport interface InstanceLabelOverrideCompositeValueSpecification extends InstanceLabelOverrideValueSpecificationBase {\r\n  specType: InstanceLabelOverrideValueSpecificationType.Composite;\r\n\r\n  /**\r\n   * Parts of the value.\r\n   *\r\n   * If any of the parts with `isRequired` flag evaluate to an empty string, the\r\n   * result of this specification is also an empty string.\r\n   */\r\n  parts: Array<{ spec: InstanceLabelOverrideValueSpecification, isRequired?: boolean }>;\r\n\r\n  /** Separator to use when joining the parts. Defaults to a space character. */\r\n  separator?: string;\r\n}\r\n\r\n/**\r\n * Specification uses property value as the label content.\r\n *\r\n * @see [Property value specification reference documentation page]($docs/presentation/customization/InstanceLabelOverride.md#property-value-specification)\r\n * @public\r\n */\r\nexport interface InstanceLabelOverridePropertyValueSpecification extends InstanceLabelOverrideValueSpecificationBase {\r\n  specType: InstanceLabelOverrideValueSpecificationType.Property;\r\n\r\n  /**\r\n   * Name of the property whose value should be used.\r\n   * @note A property with this name must exist on the property class (see [[propertySource]]).\r\n   */\r\n  propertyName: string;\r\n\r\n  /**\r\n   * [Specification of the relationship path]($docs/presentation/RelationshipPathSpecification.md) from `InstanceLabelOverride.class`\r\n   * to class of the property. If omitted, `InstanceLabelOverride.class` is used as property class.\r\n   * @beta\r\n   */\r\n  propertySource?: RelationshipPathSpecification;\r\n}\r\n\r\n/**\r\n * Specification uses ECClass name as the label content.\r\n *\r\n * @see [Class name value specification reference documentation page]($docs/presentation/customization/InstanceLabelOverride.md#class-name-value-specification)\r\n * @public\r\n */\r\nexport interface InstanceLabelOverrideClassNameSpecification extends InstanceLabelOverrideValueSpecificationBase {\r\n  specType: InstanceLabelOverrideValueSpecificationType.ClassName;\r\n\r\n  /** Should full (`{schemaName}.{className}`) class name be used */\r\n  full?: boolean;\r\n}\r\n\r\n/**\r\n * Specification uses ECClass display label as the label content.\r\n *\r\n * @see [Class label value specification reference documentation page]($docs/presentation/customization/InstanceLabelOverride.md#class-label-value-specification)\r\n * @public\r\n */\r\nexport interface InstanceLabelOverrideClassLabelSpecification extends InstanceLabelOverrideValueSpecificationBase {\r\n  specType: InstanceLabelOverrideValueSpecificationType.ClassLabel;\r\n}\r\n\r\n/**\r\n * Specification returns ECInstance's briefcase ID in base36 format.\r\n *\r\n * @see [BriefcaseId value specification reference documentation page]($docs/presentation/customization/InstanceLabelOverride.md#briefcaseid-value-specification)\r\n * @public\r\n */\r\nexport interface InstanceLabelOverrideBriefcaseIdSpecification extends InstanceLabelOverrideValueSpecificationBase {\r\n  specType: InstanceLabelOverrideValueSpecificationType.BriefcaseId;\r\n}\r\n\r\n/**\r\n * Specification returns ECInstance's local ID in base36 format.\r\n *\r\n * @see [LocalId value specification reference documentation page]($docs/presentation/customization/InstanceLabelOverride.md#localid-value-specification)\r\n * @public\r\n */\r\nexport interface InstanceLabelOverrideLocalIdSpecification extends InstanceLabelOverrideValueSpecificationBase {\r\n  specType: InstanceLabelOverrideValueSpecificationType.LocalId;\r\n}\r\n\r\n/**\r\n * Specification uses the specified value as the label content.\r\n *\r\n * @see [String value specification reference documentation page]($docs/presentation/customization/InstanceLabelOverride.md#string-value-specification)\r\n * @public\r\n */\r\nexport interface InstanceLabelOverrideStringValueSpecification extends InstanceLabelOverrideValueSpecificationBase {\r\n  specType: InstanceLabelOverrideValueSpecificationType.String;\r\n\r\n  /** The value to use as the label content. */\r\n  value: string;\r\n}\r\n\r\n/**\r\n * Specification uses label of another related instance as the label content.\r\n *\r\n * @see [Related instance label value specification reference documentation page]($docs/presentation/customization/InstanceLabelOverride.md#related-instance-label-value-specification)\r\n * @public\r\n */\r\nexport interface InstanceLabelOverrideRelatedInstanceLabelSpecification extends InstanceLabelOverrideValueSpecificationBase {\r\n  specType: InstanceLabelOverrideValueSpecificationType.RelatedInstanceLabel;\r\n\r\n  /**\r\n   * [Specification of the relationship path]($docs/presentation/RelationshipPathSpecification.md) from `InstanceLabelOverride.class`\r\n   * to class of the related instance.\r\n   */\r\n  pathToRelatedInstance: RelationshipPathSpecification;\r\n}\r\n\r\n/**\r\n * Specification to define how the label for [[InstanceLabelOverride]] should be created.\r\n * @public\r\n */\r\nexport type InstanceLabelOverrideValueSpecification =\r\n  InstanceLabelOverrideCompositeValueSpecification | InstanceLabelOverridePropertyValueSpecification |\r\n  InstanceLabelOverrideStringValueSpecification | InstanceLabelOverrideClassNameSpecification |\r\n  InstanceLabelOverrideClassLabelSpecification | InstanceLabelOverrideBriefcaseIdSpecification |\r\n  InstanceLabelOverrideLocalIdSpecification | InstanceLabelOverrideRelatedInstanceLabelSpecification;\r\n"]}

package/lib/esm/presentation-common/rules/customization/LabelOverride.d.ts

@@ -1,40 +1,38 @@
 /** @packageDocumentation
  * @module PresentationRules
  */
-import { ConditionContainer, RuleBase, RuleTypes } from "../Rule";
+import { RuleBase, RuleTypes } from "../Rule";
 /**
- * Rule to override labels and descriptions of nodes which pass rule's
- * condition.
+ * Label override rules provide advanced ways to override instance labels and descriptions in
+ * exchange of some performance penalty.
  *
- * **Important:** Prefer [[InstanceLabelOverride]] over this rule when possible as it
- * has better performance.
- *
- * @see [More details]($docs/presentation/Customization/LabelOverride.md)
+ * @see [Label override reference documentation page]($docs/presentation/customization/LabelOverride.md)
  * @public
+ * @deprecated Use [[InstanceLabelOverride]] rule instead.
  */
-export interface LabelOverride extends RuleBase, ConditionContainer {
+export interface LabelOverride extends RuleBase {
     /** Used for serializing to JSON. */
     ruleType: RuleTypes.LabelOverride;
     /**
      * 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/Customization/ECExpressions.md#rule-condition).
+     * is an [ECExpression]($docs/presentation/advanced/ECExpressions.md), which can use
+     * a [limited set of symbols]($docs/presentation/customization/ECExpressions.md#rule-condition).
      */
     condition?: string;
     /**
-     * Defines the label that should be used for node. This is
-     * an [ECExpression]($docs/presentation/Customization/ECExpressions.md), so label
+     * An expression whose result becomes the label. This is
+     * an [ECExpression]($docs/presentation/customization/ECExpressions.md), so label
      * can be defined/formatted dynamically based on the context - for example
-     * ECInstance property value. May be [localized]($docs/presentation/Advanced/Localization.md).
+     * ECInstance property value. May be [localized]($docs/presentation/advanced/Localization.md).
      *
      * @minLength 1
      */
     label?: string;
     /**
-     * Defines the description that should be used for node. This is
-     * an [ECExpression]($docs/presentation/Customization/ECExpressions.md), so
+     * An expression whose result becomes the description. This is
+     * an [ECExpression]($docs/presentation/customization/ECExpressions.md), so
      * description can be defined/formatted dynamically based on the context - for example
-     * ECInstance property value. May be [localized]($docs/presentation/Advanced/Localization.md).
+     * ECInstance property value. May be [localized]($docs/presentation/advanced/Localization.md).
      *
      * @minLength 1
      */

package/lib/esm/presentation-common/rules/customization/LabelOverride.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"LabelOverride.d.ts","sourceRoot":"","sources":["../../../../../src/presentation-common/rules/customization/LabelOverride.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,kBAAkB,EAAE,QAAQ,EAAE,SAAS,EAAE,MAAM,SAAS,CAAC;AAElE;;;;;;;;;GASG;AACH,MAAM,WAAW,aAAc,SAAQ,QAAQ,EAAE,kBAAkB;IACjE,oCAAoC;IACpC,QAAQ,EAAE,SAAS,CAAC,aAAa,CAAC;IAElC;;;;OAIG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;;;;;;OAOG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;;;;;;OAOG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB"}
+{"version":3,"file":"LabelOverride.d.ts","sourceRoot":"","sources":["../../../../../src/presentation-common/rules/customization/LabelOverride.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,QAAQ,EAAE,SAAS,EAAE,MAAM,SAAS,CAAC;AAE9C;;;;;;;GAOG;AACH,MAAM,WAAW,aAAc,SAAQ,QAAQ;IAC7C,oCAAoC;IACpC,QAAQ,EAAE,SAAS,CAAC,aAAa,CAAC;IAElC;;;;OAIG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;;;;;;OAOG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;;;;;;OAOG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB"}

package/lib/esm/presentation-common/rules/customization/LabelOverride.js.map

@@ -1 +1 @@
-{"version":3,"file":"LabelOverride.js","sourceRoot":"","sources":["../../../../../src/presentation-common/rules/customization/LabelOverride.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, RuleBase, RuleTypes } from \"../Rule\";\r\n\r\n/**\r\n * Rule to override labels and descriptions of nodes which pass rule's\r\n * condition.\r\n *\r\n * **Important:** Prefer [[InstanceLabelOverride]] over this rule when possible as it\r\n * has better performance.\r\n *\r\n * @see [More details]($docs/presentation/Customization/LabelOverride.md)\r\n * @public\r\n */\r\nexport interface LabelOverride extends RuleBase, ConditionContainer {\r\n  /** Used for serializing to JSON. */\r\n  ruleType: RuleTypes.LabelOverride;\r\n\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/Customization/ECExpressions.md#rule-condition).\r\n   */\r\n  condition?: string;\r\n\r\n  /**\r\n   * Defines the label that should be used for node. This is\r\n   * an [ECExpression]($docs/presentation/Customization/ECExpressions.md), so label\r\n   * can be defined/formatted dynamically based on the context - for example\r\n   * ECInstance property value. May be [localized]($docs/presentation/Advanced/Localization.md).\r\n   *\r\n   * @minLength 1\r\n   */\r\n  label?: string;\r\n\r\n  /**\r\n   * Defines the description that should be used for node. This is\r\n   * an [ECExpression]($docs/presentation/Customization/ECExpressions.md), so\r\n   * description can be defined/formatted dynamically based on the context - for example\r\n   * ECInstance property value. May be [localized]($docs/presentation/Advanced/Localization.md).\r\n   *\r\n   * @minLength 1\r\n   */\r\n  description?: string;\r\n}\r\n"]}
+{"version":3,"file":"LabelOverride.js","sourceRoot":"","sources":["../../../../../src/presentation-common/rules/customization/LabelOverride.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 { RuleBase, RuleTypes } from \"../Rule\";\r\n\r\n/**\r\n * Label override rules provide advanced ways to override instance labels and descriptions in\r\n * exchange of some performance penalty.\r\n *\r\n * @see [Label override reference documentation page]($docs/presentation/customization/LabelOverride.md)\r\n * @public\r\n * @deprecated Use [[InstanceLabelOverride]] rule instead.\r\n */\r\nexport interface LabelOverride extends RuleBase {\r\n  /** Used for serializing to JSON. */\r\n  ruleType: RuleTypes.LabelOverride;\r\n\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/customization/ECExpressions.md#rule-condition).\r\n   */\r\n  condition?: string;\r\n\r\n  /**\r\n   * An expression whose result becomes the label. This is\r\n   * an [ECExpression]($docs/presentation/customization/ECExpressions.md), so label\r\n   * can be defined/formatted dynamically based on the context - for example\r\n   * ECInstance property value. May be [localized]($docs/presentation/advanced/Localization.md).\r\n   *\r\n   * @minLength 1\r\n   */\r\n  label?: string;\r\n\r\n  /**\r\n   * An expression whose result becomes the description. This is\r\n   * an [ECExpression]($docs/presentation/customization/ECExpressions.md), so\r\n   * description can be defined/formatted dynamically based on the context - for example\r\n   * ECInstance property value. May be [localized]($docs/presentation/advanced/Localization.md).\r\n   *\r\n   * @minLength 1\r\n   */\r\n  description?: string;\r\n}\r\n"]}

package/lib/esm/presentation-common/rules/customization/SortingRule.d.ts

@@ -2,67 +2,54 @@
  * @module PresentationRules
  */
 import { SingleSchemaClassSpecification } from "../ClassSpecifications";
-import { ConditionContainer, RuleBase, RuleTypes } from "../Rule";
+import { RuleBase, RuleTypes } from "../Rule";
 /**
- * Base class for all [[SortingRule]] implementations. Not
- * meant to be used directly, see `SortingRule`.
+ * Sorting rules provide a way to either disable sorting or sort instances by specific properties.
  *
+ * @see [Sorting rule reference documentation page]($docs/presentation/customization/SortingRule.md)
  * @public
  */
-export interface SortingRuleBase extends RuleBase, ConditionContainer {
+export interface SortingRuleBase 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/customization/ECExpressions.md#rule-condition) which has to
+     * evaluate to a boolean value.
      */
     condition?: string;
-    /**
-     * Specification of ECClass whose ECInstances should be sorted by this rule.
-     * Defaults to all classes in current context if not specified.
-     */
+    /** Specifies ECClass whose ECInstances should be sorted. */
     class?: SingleSchemaClassSpecification;
-    /** Should [[class]] defined in this rule be handled polymorphically. */
+    /** Specifies that [[class]] attribute defined in this rule should be handled polymorphically. */
     isPolymorphic?: boolean;
 }
 /**
- * Sorting rule implementations
+ * Sorting rules provide a way to either disable sorting or sort instances by specific properties.
  *
- * @see [More details]($docs/presentation/Customization/SortingRule.md)
+ * @see [Sorting rule reference documentation page]($docs/presentation/customization/SortingRule.md)
  * @public
  */
 export declare type SortingRule = PropertySortingRule | DisabledSortingRule;
 /**
- * Rule to configure sorting for certain ECInstances in the hierarchy and/or content.
- * It is possible to configure different sorting for different types of ECInstances.
- *
- * Multiple sorting rules may be applied for the same instances - in this case the
- * instances are first sorted by the highest priority rule and then the lower priority ones.
- *
- * **Note:** This rule is not meant to be used to sort grouping nodes, custom nodes or
- * other non ECInstance type of nodes.
+ * Rule to configure sorting for certain ECInstances in the hierarchy and/or content. It is possible to configure different sorting for different types of ECInstances.
  *
+ * @see [Property sorting rule reference documentation section]($docs/presentation/customization/SortingRule.md#property-sorting-rule)
  * @public
  */
 export interface PropertySortingRule extends SortingRuleBase {
     /** Used for serializing to JSON. */
     ruleType: RuleTypes.PropertySorting;
     /**
-     * Name of the property which should be used for sorting
+     * Specifies name of the property which should be used for sorting.
      *
      * @minLength 1
      */
     propertyName: string;
-    /** Will sort in ascending order if set to true, otherwise descending. Defaults to `true`. */
+    /** Specifies whether instances should be sorted in ascending order or descending. */
     sortAscending?: boolean;
 }
 /**
  * Rule to disable sorting for certain ECInstances in the hierarchy and/or content.
  *
- * **Note:** Disabling sorting increases performance
- *
- * **Note:** This rule is not meant to be used to sort grouping nodes, custom nodes or
- * other non ECInstance type of nodes.
- *
+ * @see [Disabled sorting rule reference documentation section]($docs/presentation/customization/SortingRule.md#disabled-sorting-rule)
  * @public
  */
 export interface DisabledSortingRule extends SortingRuleBase {

package/lib/esm/presentation-common/rules/customization/SortingRule.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"SortingRule.d.ts","sourceRoot":"","sources":["../../../../../src/presentation-common/rules/customization/SortingRule.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,8BAA8B,EAAE,MAAM,wBAAwB,CAAC;AACxE,OAAO,EAAE,kBAAkB,EAAE,QAAQ,EAAE,SAAS,EAAE,MAAM,SAAS,CAAC;AAElE;;;;;GAKG;AACH,MAAM,WAAW,eAAgB,SAAQ,QAAQ,EAAE,kBAAkB;IACnE;;;;OAIG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;;OAGG;IACH,KAAK,CAAC,EAAE,8BAA8B,CAAC;IAEvC,wEAAwE;IACxE,aAAa,CAAC,EAAE,OAAO,CAAC;CACzB;AAED;;;;;GAKG;AACH,oBAAY,WAAW,GAAG,mBAAmB,GAAG,mBAAmB,CAAC;AAEpE;;;;;;;;;;;GAWG;AACH,MAAM,WAAW,mBAAoB,SAAQ,eAAe;IAC1D,oCAAoC;IACpC,QAAQ,EAAE,SAAS,CAAC,eAAe,CAAC;IAEpC;;;;OAIG;IACH,YAAY,EAAE,MAAM,CAAC;IAErB,6FAA6F;IAC7F,aAAa,CAAC,EAAE,OAAO,CAAC;CACzB;AAED;;;;;;;;;GASG;AACH,MAAM,WAAW,mBAAoB,SAAQ,eAAe;IAC1D,oCAAoC;IACpC,QAAQ,EAAE,SAAS,CAAC,eAAe,CAAC;CACrC"}
+{"version":3,"file":"SortingRule.d.ts","sourceRoot":"","sources":["../../../../../src/presentation-common/rules/customization/SortingRule.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,8BAA8B,EAAE,MAAM,wBAAwB,CAAC;AACxE,OAAO,EAAE,QAAQ,EAAE,SAAS,EAAE,MAAM,SAAS,CAAC;AAE9C;;;;;GAKG;AACH,MAAM,WAAW,eAAgB,SAAQ,QAAQ;IAC/C;;;;OAIG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB,4DAA4D;IAC5D,KAAK,CAAC,EAAE,8BAA8B,CAAC;IAEvC,iGAAiG;IACjG,aAAa,CAAC,EAAE,OAAO,CAAC;CACzB;AAED;;;;;GAKG;AACH,oBAAY,WAAW,GAAG,mBAAmB,GAAG,mBAAmB,CAAC;AAEpE;;;;;GAKG;AACH,MAAM,WAAW,mBAAoB,SAAQ,eAAe;IAC1D,oCAAoC;IACpC,QAAQ,EAAE,SAAS,CAAC,eAAe,CAAC;IAEpC;;;;OAIG;IACH,YAAY,EAAE,MAAM,CAAC;IAErB,qFAAqF;IACrF,aAAa,CAAC,EAAE,OAAO,CAAC;CACzB;AAED;;;;;GAKG;AACH,MAAM,WAAW,mBAAoB,SAAQ,eAAe;IAC1D,oCAAoC;IACpC,QAAQ,EAAE,SAAS,CAAC,eAAe,CAAC;CACrC"}

package/lib/esm/presentation-common/rules/customization/SortingRule.js.map

@@ -1 +1 @@
-{"version":3,"file":"SortingRule.js","sourceRoot":"","sources":["../../../../../src/presentation-common/rules/customization/SortingRule.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 { SingleSchemaClassSpecification } from \"../ClassSpecifications\";\r\nimport { ConditionContainer, RuleBase, RuleTypes } from \"../Rule\";\r\n\r\n/**\r\n * Base class for all [[SortingRule]] implementations. Not\r\n * meant to be used directly, see `SortingRule`.\r\n *\r\n * @public\r\n */\r\nexport interface SortingRuleBase extends RuleBase, ConditionContainer {\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   * Specification of ECClass whose ECInstances should be sorted by this rule.\r\n   * Defaults to all classes in current context if not specified.\r\n   */\r\n  class?: SingleSchemaClassSpecification;\r\n\r\n  /** Should [[class]] defined in this rule be handled polymorphically. */\r\n  isPolymorphic?: boolean;\r\n}\r\n\r\n/**\r\n * Sorting rule implementations\r\n *\r\n * @see [More details]($docs/presentation/Customization/SortingRule.md)\r\n * @public\r\n */\r\nexport type SortingRule = PropertySortingRule | DisabledSortingRule;\r\n\r\n/**\r\n * Rule to configure sorting for certain ECInstances in the hierarchy and/or content.\r\n * It is possible to configure different sorting for different types of ECInstances.\r\n *\r\n * Multiple sorting rules may be applied for the same instances - in this case the\r\n * instances are first sorted by the highest priority rule and then the lower priority ones.\r\n *\r\n * **Note:** This rule is not meant to be used to sort grouping nodes, custom nodes or\r\n * other non ECInstance type of nodes.\r\n *\r\n * @public\r\n */\r\nexport interface PropertySortingRule extends SortingRuleBase {\r\n  /** Used for serializing to JSON. */\r\n  ruleType: RuleTypes.PropertySorting;\r\n\r\n  /**\r\n   * Name of the property which should be used for sorting\r\n   *\r\n   * @minLength 1\r\n   */\r\n  propertyName: string;\r\n\r\n  /** Will sort in ascending order if set to true, otherwise descending. Defaults to `true`. */\r\n  sortAscending?: boolean;\r\n}\r\n\r\n/**\r\n * Rule to disable sorting for certain ECInstances in the hierarchy and/or content.\r\n *\r\n * **Note:** Disabling sorting increases performance\r\n *\r\n * **Note:** This rule is not meant to be used to sort grouping nodes, custom nodes or\r\n * other non ECInstance type of nodes.\r\n *\r\n * @public\r\n */\r\nexport interface DisabledSortingRule extends SortingRuleBase {\r\n  /** Used for serializing to JSON. */\r\n  ruleType: RuleTypes.DisabledSorting;\r\n}\r\n"]}
+{"version":3,"file":"SortingRule.js","sourceRoot":"","sources":["../../../../../src/presentation-common/rules/customization/SortingRule.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 { SingleSchemaClassSpecification } from \"../ClassSpecifications\";\r\nimport { RuleBase, RuleTypes } from \"../Rule\";\r\n\r\n/**\r\n * Sorting rules provide a way to either disable sorting or sort instances by specific properties.\r\n *\r\n * @see [Sorting rule reference documentation page]($docs/presentation/customization/SortingRule.md)\r\n * @public\r\n */\r\nexport interface SortingRuleBase 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/customization/ECExpressions.md#rule-condition) which has to\r\n   * evaluate to a boolean value.\r\n   */\r\n  condition?: string;\r\n\r\n  /** Specifies ECClass whose ECInstances should be sorted. */\r\n  class?: SingleSchemaClassSpecification;\r\n\r\n  /** Specifies that [[class]] attribute defined in this rule should be handled polymorphically. */\r\n  isPolymorphic?: boolean;\r\n}\r\n\r\n/**\r\n * Sorting rules provide a way to either disable sorting or sort instances by specific properties.\r\n *\r\n * @see [Sorting rule reference documentation page]($docs/presentation/customization/SortingRule.md)\r\n * @public\r\n */\r\nexport type SortingRule = PropertySortingRule | DisabledSortingRule;\r\n\r\n/**\r\n * Rule to configure sorting for certain ECInstances in the hierarchy and/or content. It is possible to configure different sorting for different types of ECInstances.\r\n *\r\n * @see [Property sorting rule reference documentation section]($docs/presentation/customization/SortingRule.md#property-sorting-rule)\r\n * @public\r\n */\r\nexport interface PropertySortingRule extends SortingRuleBase {\r\n  /** Used for serializing to JSON. */\r\n  ruleType: RuleTypes.PropertySorting;\r\n\r\n  /**\r\n   * Specifies name of the property which should be used for sorting.\r\n   *\r\n   * @minLength 1\r\n   */\r\n  propertyName: string;\r\n\r\n  /** Specifies whether instances should be sorted in ascending order or descending. */\r\n  sortAscending?: boolean;\r\n}\r\n\r\n/**\r\n * Rule to disable sorting for certain ECInstances in the hierarchy and/or content.\r\n *\r\n * @see [Disabled sorting rule reference documentation section]($docs/presentation/customization/SortingRule.md#disabled-sorting-rule)\r\n * @public\r\n */\r\nexport interface DisabledSortingRule extends SortingRuleBase {\r\n  /** Used for serializing to JSON. */\r\n  ruleType: RuleTypes.DisabledSorting;\r\n}\r\n"]}

package/lib/esm/presentation-common/rules/customization/StyleOverride.d.ts

@@ -1,25 +1,25 @@
 /** @packageDocumentation
  * @module PresentationRules
  */
-import { ConditionContainer, RuleBase, RuleTypes } from "../Rule";
+import { RuleBase, RuleTypes } from "../Rule";
 /**
- * Rule to override default node style and dynamically define a foreground/background
- * colors and a font style for a particular nodes.
+ * Style override rules allow customizing display style of specific types of ECInstances.
  *
- * @see [More details]($docs/presentation/Customization/StyleOverride.md)
+ * @see [Style override reference documentation page]($docs/presentation/customization/StyleOverride.md)
  * @public
+ * @deprecated Use [[ExtendedDataRule]] instead. See [extended data usage page]($docs/presentation/customization/ExtendedDataUsage.md) for more details.
  */
-export interface StyleOverride extends RuleBase, ConditionContainer {
+export interface StyleOverride extends RuleBase {
     /** Used for serializing to JSON. */
     ruleType: RuleTypes.StyleOverride;
     /**
      * 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/Customization/ECExpressions.md#rule-condition).
+     * is an [ECExpression]($docs/presentation/advanced/ECExpressions.md), which can use
+     * a [limited set of symbols]($docs/presentation/customization/ECExpressions.md#rule-condition).
      */
     condition?: string;
     /**
-     * Foreground color that should be used for node. The value should be an [ECExpression]($docs/presentation/Advanced/ECExpressions.md)
+     * Foreground color that should be used for node. The value should be an [ECExpression]($docs/presentation/advanced/ECExpressions.md)
      * whose result would evaluate to one the following formats:
      * - color name (`Red`, `Blue`, etc.)
      * - `rgb(255, 255, 255)`
@@ -27,7 +27,7 @@ export interface StyleOverride extends RuleBase, ConditionContainer {
      */
     foreColor?: string;
     /**
-     * Background color that should be used for node. The value should be an [ECExpression]($docs/presentation/Advanced/ECExpressions.md)
+     * Background color that should be used for node. The value should be an [ECExpression]($docs/presentation/advanced/ECExpressions.md)
      * whose result would evaluate to one the following formats:
      * - color name (`Red`, `Blue`, etc.)
      * - `rgb(255, 255, 255)`
@@ -35,14 +35,14 @@ export interface StyleOverride extends RuleBase, ConditionContainer {
      */
     backColor?: string;
     /**
-     * Font style that should be used for node. The value should be an [ECExpression]($docs/presentation/Advanced/ECExpressions.md)
+     * Font style that should be used for node. The value should be an [ECExpression]($docs/presentation/advanced/ECExpressions.md)
      * whose result would evaluate to one the following values:
      * - `"Bold"`
      * - `"Italic"`
      * - `"Italic,Bold"`
      * - `"Regular"`
      *
-     * Defaults to `"FontStyle.Regular"`.
+     * Defaults to `"Regular"`.
      */
     fontStyle?: string;
 }

package/lib/esm/presentation-common/rules/customization/StyleOverride.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"StyleOverride.d.ts","sourceRoot":"","sources":["../../../../../src/presentation-common/rules/customization/StyleOverride.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,kBAAkB,EAAE,QAAQ,EAAE,SAAS,EAAE,MAAM,SAAS,CAAC;AAElE;;;;;;GAMG;AACH,MAAM,WAAW,aAAc,SAAQ,QAAQ,EAAE,kBAAkB;IACjE,oCAAoC;IACpC,QAAQ,EAAE,SAAS,CAAC,aAAa,CAAC;IAElC;;;;OAIG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;;;;;OAMG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;;;;;OAMG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;;;;;;;;OASG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB"}
+{"version":3,"file":"StyleOverride.d.ts","sourceRoot":"","sources":["../../../../../src/presentation-common/rules/customization/StyleOverride.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,QAAQ,EAAE,SAAS,EAAE,MAAM,SAAS,CAAC;AAE9C;;;;;;GAMG;AACH,MAAM,WAAW,aAAc,SAAQ,QAAQ;IAC7C,oCAAoC;IACpC,QAAQ,EAAE,SAAS,CAAC,aAAa,CAAC;IAElC;;;;OAIG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;;;;;OAMG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;;;;;OAMG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;;;;;;;;OASG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB"}

package/lib/esm/presentation-common/rules/customization/StyleOverride.js.map

@@ -1 +1 @@
-{"version":3,"file":"StyleOverride.js","sourceRoot":"","sources":["../../../../../src/presentation-common/rules/customization/StyleOverride.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, RuleBase, RuleTypes } from \"../Rule\";\r\n\r\n/**\r\n * Rule to override default node style and dynamically define a foreground/background\r\n * colors and a font style for a particular nodes.\r\n *\r\n * @see [More details]($docs/presentation/Customization/StyleOverride.md)\r\n * @public\r\n */\r\nexport interface StyleOverride extends RuleBase, ConditionContainer {\r\n  /** Used for serializing to JSON. */\r\n  ruleType: RuleTypes.StyleOverride;\r\n\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/Customization/ECExpressions.md#rule-condition).\r\n   */\r\n  condition?: string;\r\n\r\n  /**\r\n   * Foreground color that should be used for node. The value should be an [ECExpression]($docs/presentation/Advanced/ECExpressions.md)\r\n   * whose result would evaluate to one the following formats:\r\n   * - color name (`Red`, `Blue`, etc.)\r\n   * - `rgb(255, 255, 255)`\r\n   * - `#0F0F0F`\r\n   */\r\n  foreColor?: string;\r\n\r\n  /**\r\n   * Background color that should be used for node. The value should be an [ECExpression]($docs/presentation/Advanced/ECExpressions.md)\r\n   * whose result would evaluate to one the following formats:\r\n   * - color name (`Red`, `Blue`, etc.)\r\n   * - `rgb(255, 255, 255)`\r\n   * - `#0F0F0F`\r\n   */\r\n  backColor?: string;\r\n\r\n  /**\r\n   * Font style that should be used for node. The value should be an [ECExpression]($docs/presentation/Advanced/ECExpressions.md)\r\n   * whose result would evaluate to one the following values:\r\n   * - `\"Bold\"`\r\n   * - `\"Italic\"`\r\n   * - `\"Italic,Bold\"`\r\n   * - `\"Regular\"`\r\n   *\r\n   * Defaults to `\"FontStyle.Regular\"`.\r\n   */\r\n  fontStyle?: string;\r\n}\r\n"]}
+{"version":3,"file":"StyleOverride.js","sourceRoot":"","sources":["../../../../../src/presentation-common/rules/customization/StyleOverride.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 { RuleBase, RuleTypes } from \"../Rule\";\r\n\r\n/**\r\n * Style override rules allow customizing display style of specific types of ECInstances.\r\n *\r\n * @see [Style override reference documentation page]($docs/presentation/customization/StyleOverride.md)\r\n * @public\r\n * @deprecated Use [[ExtendedDataRule]] instead. See [extended data usage page]($docs/presentation/customization/ExtendedDataUsage.md) for more details.\r\n */\r\nexport interface StyleOverride extends RuleBase {\r\n  /** Used for serializing to JSON. */\r\n  ruleType: RuleTypes.StyleOverride;\r\n\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/customization/ECExpressions.md#rule-condition).\r\n   */\r\n  condition?: string;\r\n\r\n  /**\r\n   * Foreground color that should be used for node. The value should be an [ECExpression]($docs/presentation/advanced/ECExpressions.md)\r\n   * whose result would evaluate to one the following formats:\r\n   * - color name (`Red`, `Blue`, etc.)\r\n   * - `rgb(255, 255, 255)`\r\n   * - `#0F0F0F`\r\n   */\r\n  foreColor?: string;\r\n\r\n  /**\r\n   * Background color that should be used for node. The value should be an [ECExpression]($docs/presentation/advanced/ECExpressions.md)\r\n   * whose result would evaluate to one the following formats:\r\n   * - color name (`Red`, `Blue`, etc.)\r\n   * - `rgb(255, 255, 255)`\r\n   * - `#0F0F0F`\r\n   */\r\n  backColor?: string;\r\n\r\n  /**\r\n   * Font style that should be used for node. The value should be an [ECExpression]($docs/presentation/advanced/ECExpressions.md)\r\n   * whose result would evaluate to one the following values:\r\n   * - `\"Bold\"`\r\n   * - `\"Italic\"`\r\n   * - `\"Italic,Bold\"`\r\n   * - `\"Regular\"`\r\n   *\r\n   * Defaults to `\"Regular\"`.\r\n   */\r\n  fontStyle?: string;\r\n}\r\n"]}

package/lib/esm/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/esm/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/esm/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/esm/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/esm/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/esm/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,MAAM,CAAN,IAAY,2BAMX;AAND,WAAY,2BAA2B;IACrC,2BAA2B;IAC3B,4EAA6C,CAAA;IAC7C,gGAAiE,CAAA;IACjE,oFAAqD,CAAA;IACrD,wDAAyB,CAAA;AAC3B,CAAC,EANW,2BAA2B,KAA3B,2BAA2B,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,MAAM,CAAN,IAAY,2BAMX;AAND,WAAY,2BAA2B;IACrC,2BAA2B;IAC3B,4EAA6C,CAAA;IAC7C,gGAAiE,CAAA;IACjE,oFAAqD,CAAA;IACrD,wDAAyB,CAAA;AAC3B,CAAC,EANW,2BAA2B,KAA3B,2BAA2B,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/esm/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/esm/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/esm/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"]}