@itwin/presentation-common 3.1.0-dev.8 → 3.2.0-dev.12

package/lib/esm/presentation-common/rules/RelatedInstanceSpecification.js.map

@@ -1 +1 @@
-{"version":3,"file":"RelatedInstanceSpecification.js","sourceRoot":"","sources":["../../../../src/presentation-common/rules/RelatedInstanceSpecification.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 { RelationshipPathSpecification } from \"./RelationshipPathSpecification\";\r\n\r\n/**\r\n * This sub-specification allows joining the primary node instance with any number of related instances and creating\r\n * hierarchies based on a mix of those related instances.\r\n *\r\n * The related instance property values can be accessed from multiple different places:\r\n * - Instance filter\r\n * - Customization rule value\r\n * - Grouping rule\r\n *\r\n * **Example:**\r\n * ```JSON\r\n * {\r\n *   \"id\": \"related_instance_example\",\r\n *   \"rules\": [{\r\n *     \"ruleType\": \"LabelOverride\",\r\n *     \"condition\": \"ThisNode.IsInstanceNode ANDALSO this.IsOfClass(\\\"Model\\\", \\\"BisCore\\\")\",\r\n *     \"label\": \"modeledElement.UserLabel\"\r\n *   }, {\r\n *     \"ruleType\": \"Grouping\",\r\n *     \"condition\": \"ParentNode.IsNull\",\r\n *     \"class\": {\r\n *       \"schemaName\": \"BisCore\",\r\n *       \"className\": \"Element\"\r\n *     },\r\n *     \"groups\": [{\r\n *       \"specType\": \"Property\",\r\n *       \"propertyName\": \"CodeValue\",\r\n *       \"createGroupForSingleItem\": true\r\n *     }]\r\n *   }, {\r\n *     \"ruleType\": \"RootNodes\",\r\n *     \"specifications\": [{\r\n *       \"specType\": \"InstanceNodesOfSpecificClasses\",\r\n *       \"classes\": { \"schemaName\": \"BisCore\", \"classNames\": [\"GeometricModel\"] },\r\n *       \"arePolymorphic\": true,\r\n *       \"instanceFilter\": \"modeledElement.CodeNamespace = 1\",\r\n *       \"relatedInstances\": [{\r\n *         \"relationshipPath\": [{\r\n *           \"relationship\": { \"schemaName\": \"BisCore\", \"className\": \"ModelModelsElement\" },\r\n *           \"direction\": \"Forward\",\r\n *         }],\r\n *         \"class\": { \"schemaName\": \"BisCore\", \"className\": \"Element\" },\r\n *         \"alias\": \"modeledElement\"\r\n *       }]\r\n *     }]\r\n *   }]\r\n * }\r\n * ```\r\n * Here `BisCore:GeometricModel` instances are joined with `BisCore:Element` instances to create the hierarchy. This allows:\r\n * - Related `BisCore:Element` properties to be accessed in `InstanceFilter` using `modeledElement` alias.\r\n * - The `LabelOverride` rule to use `modeledElement` alias to access properties of the joined related instance.\r\n * - The `GroupingRule` to be applied because it's grouping `BisCore:Element` which is now part of the generated nodes.\r\n *\r\n * @see [More details]($docs/presentation/Common-Rules/RelatedInstanceSpecification.md)\r\n * @public\r\n */\r\nexport interface RelatedInstanceSpecification {\r\n  /**\r\n   * Relationship path to find the related instance.\r\n   */\r\n  relationshipPath: RelationshipPathSpecification;\r\n\r\n  /**\r\n   * The alias to give for the joined related instance. Used to reference the related instance in\r\n   * instance filter and customization rules.\r\n   *\r\n   * **The value must be unique per-specification!**\r\n   *\r\n   * @pattern ^\\w[\\w\\d]*$\r\n   */\r\n  alias: string;\r\n\r\n  /**\r\n   * Is the related instance required to exist. If yes, primary instance won't be returned\r\n   * if the related instance doesn't exist. If not, primary instance will be returned, but related\r\n   * instance will be null.\r\n   *\r\n   * In SQL terms in can be compared to INNER JOIN vs OUTER JOIN.\r\n   */\r\n  isRequired?: boolean;\r\n}\r\n"]}
+{"version":3,"file":"RelatedInstanceSpecification.js","sourceRoot":"","sources":["../../../../src/presentation-common/rules/RelatedInstanceSpecification.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 { RelationshipPathSpecification } from \"./RelationshipPathSpecification\";\r\n\r\n/**\r\n * This sub-specification allows joining the primary node instance with any number of related instances and creating\r\n * hierarchies based on a mix of those related instances.\r\n *\r\n * The related instance property values can be accessed from multiple different places:\r\n * - Instance filter\r\n * - Customization rule value\r\n * - Grouping rule\r\n *\r\n * **Example:**\r\n * ```JSON\r\n * {\r\n *   \"id\": \"related_instance_example\",\r\n *   \"rules\": [{\r\n *     \"ruleType\": \"LabelOverride\",\r\n *     \"condition\": \"ThisNode.IsInstanceNode ANDALSO this.IsOfClass(\\\"Model\\\", \\\"BisCore\\\")\",\r\n *     \"label\": \"modeledElement.UserLabel\"\r\n *   }, {\r\n *     \"ruleType\": \"Grouping\",\r\n *     \"condition\": \"ParentNode.IsNull\",\r\n *     \"class\": {\r\n *       \"schemaName\": \"BisCore\",\r\n *       \"className\": \"Element\"\r\n *     },\r\n *     \"groups\": [{\r\n *       \"specType\": \"Property\",\r\n *       \"propertyName\": \"CodeValue\",\r\n *       \"createGroupForSingleItem\": true\r\n *     }]\r\n *   }, {\r\n *     \"ruleType\": \"RootNodes\",\r\n *     \"specifications\": [{\r\n *       \"specType\": \"InstanceNodesOfSpecificClasses\",\r\n *       \"classes\": { \"schemaName\": \"BisCore\", \"classNames\": [\"GeometricModel\"] },\r\n *       \"arePolymorphic\": true,\r\n *       \"instanceFilter\": \"modeledElement.CodeNamespace = 1\",\r\n *       \"relatedInstances\": [{\r\n *         \"relationshipPath\": [{\r\n *           \"relationship\": { \"schemaName\": \"BisCore\", \"className\": \"ModelModelsElement\" },\r\n *           \"direction\": \"Forward\",\r\n *         }],\r\n *         \"class\": { \"schemaName\": \"BisCore\", \"className\": \"Element\" },\r\n *         \"alias\": \"modeledElement\"\r\n *       }]\r\n *     }]\r\n *   }]\r\n * }\r\n * ```\r\n * Here `BisCore:GeometricModel` instances are joined with `BisCore:Element` instances to create the hierarchy. This allows:\r\n * - Related `BisCore:Element` properties to be accessed in `InstanceFilter` using `modeledElement` alias.\r\n * - The `LabelOverride` rule to use `modeledElement` alias to access properties of the joined related instance.\r\n * - The `GroupingRule` to be applied because it's grouping `BisCore:Element` which is now part of the generated nodes.\r\n *\r\n * @see [More details]($docs/presentation/RelatedInstanceSpecification.md)\r\n * @public\r\n */\r\nexport interface RelatedInstanceSpecification {\r\n  /**\r\n   * Relationship path to find the related instance.\r\n   */\r\n  relationshipPath: RelationshipPathSpecification;\r\n\r\n  /**\r\n   * The alias to give for the joined related instance. Used to reference the related instance in\r\n   * instance filter and customization rules.\r\n   *\r\n   * **The value must be unique per-specification!**\r\n   *\r\n   * @pattern ^\\w[\\w\\d]*$\r\n   */\r\n  alias: string;\r\n\r\n  /**\r\n   * Is the related instance required to exist. If yes, primary instance won't be returned\r\n   * if the related instance doesn't exist. If not, primary instance will be returned, but related\r\n   * instance will be null.\r\n   *\r\n   * In SQL terms in can be compared to INNER JOIN vs OUTER JOIN.\r\n   */\r\n  isRequired?: boolean;\r\n}\r\n"]}

package/lib/esm/presentation-common/rules/RelationshipPathSpecification.d.ts

@@ -33,14 +33,14 @@ export interface RepeatableRelationshipStepSpecification extends RelationshipSte
 /**
  * Specification of a relationship path.
  *
- * @see [More details]($docs/presentation/Common-Rules/RelationshipPathSpecification.md)
+ * @see [More details]($docs/presentation/RelationshipPathSpecification.md)
  * @public
  */
 export declare type RelationshipPathSpecification = RelationshipStepSpecification | RelationshipStepSpecification[];
 /**
  * Specification of a repeatable relationship path.
  *
- * @see [More details]($docs/presentation/Common-Rules/RelationshipPathSpecification.md)
+ * @see [More details]($docs/presentation/RepeatableRelationshipPathSpecification.md)
  * @public
  */
 export declare type RepeatableRelationshipPathSpecification = RepeatableRelationshipStepSpecification | RepeatableRelationshipStepSpecification[];

package/lib/esm/presentation-common/rules/RelationshipPathSpecification.js.map

@@ -1 +1 @@
-{"version":3,"file":"RelationshipPathSpecification.js","sourceRoot":"","sources":["../../../../src/presentation-common/rules/RelationshipPathSpecification.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 { RelationshipDirection } from \"./RelationshipDirection\";\r\n\r\n/**\r\n * Specification of a single relationship path step.\r\n * @public\r\n */\r\nexport interface RelationshipStepSpecification {\r\n  /** Specification of the relationship to use for joining the related instance. */\r\n  relationship: SingleSchemaClassSpecification;\r\n\r\n  /** Relationship direction that should be followed to find the target class. */\r\n  direction: RelationshipDirection.Forward | RelationshipDirection.Backward;\r\n\r\n  /**\r\n   * Specification of the target class. Either relationship's source or target class is used (based\r\n   * on specified direction) if more specific target class is not specified by this attribute.\r\n   */\r\n  targetClass?: SingleSchemaClassSpecification;\r\n}\r\n\r\n/**\r\n * Specification of a single relationship path step.\r\n * @public\r\n */\r\nexport interface RepeatableRelationshipStepSpecification extends RelationshipStepSpecification {\r\n  /**\r\n   * Number of relationship steps that should be taken. Special `*` value means that\r\n   * relationship is traversed recursively and all matching instances are accumulated.\r\n   * Defaults to `1`.\r\n   */\r\n  count?: number | \"*\";\r\n}\r\n\r\n/**\r\n * Specification of a relationship path.\r\n *\r\n * @see [More details]($docs/presentation/Common-Rules/RelationshipPathSpecification.md)\r\n * @public\r\n */\r\nexport type RelationshipPathSpecification = RelationshipStepSpecification | RelationshipStepSpecification[];\r\n\r\n/**\r\n * Specification of a repeatable relationship path.\r\n *\r\n * @see [More details]($docs/presentation/Common-Rules/RelationshipPathSpecification.md)\r\n * @public\r\n */\r\nexport type RepeatableRelationshipPathSpecification = RepeatableRelationshipStepSpecification | RepeatableRelationshipStepSpecification[];\r\n"]}
+{"version":3,"file":"RelationshipPathSpecification.js","sourceRoot":"","sources":["../../../../src/presentation-common/rules/RelationshipPathSpecification.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 { RelationshipDirection } from \"./RelationshipDirection\";\r\n\r\n/**\r\n * Specification of a single relationship path step.\r\n * @public\r\n */\r\nexport interface RelationshipStepSpecification {\r\n  /** Specification of the relationship to use for joining the related instance. */\r\n  relationship: SingleSchemaClassSpecification;\r\n\r\n  /** Relationship direction that should be followed to find the target class. */\r\n  direction: RelationshipDirection.Forward | RelationshipDirection.Backward;\r\n\r\n  /**\r\n   * Specification of the target class. Either relationship's source or target class is used (based\r\n   * on specified direction) if more specific target class is not specified by this attribute.\r\n   */\r\n  targetClass?: SingleSchemaClassSpecification;\r\n}\r\n\r\n/**\r\n * Specification of a single relationship path step.\r\n * @public\r\n */\r\nexport interface RepeatableRelationshipStepSpecification extends RelationshipStepSpecification {\r\n  /**\r\n   * Number of relationship steps that should be taken. Special `*` value means that\r\n   * relationship is traversed recursively and all matching instances are accumulated.\r\n   * Defaults to `1`.\r\n   */\r\n  count?: number | \"*\";\r\n}\r\n\r\n/**\r\n * Specification of a relationship path.\r\n *\r\n * @see [More details]($docs/presentation/RelationshipPathSpecification.md)\r\n * @public\r\n */\r\nexport type RelationshipPathSpecification = RelationshipStepSpecification | RelationshipStepSpecification[];\r\n\r\n/**\r\n * Specification of a repeatable relationship path.\r\n *\r\n * @see [More details]($docs/presentation/RepeatableRelationshipPathSpecification.md)\r\n * @public\r\n */\r\nexport type RepeatableRelationshipPathSpecification = RepeatableRelationshipStepSpecification | RepeatableRelationshipStepSpecification[];\r\n"]}

package/lib/esm/presentation-common/rules/content/ContentSpecification.d.ts

@@ -30,7 +30,10 @@ export interface ContentSpecificationBase extends ContentModifiersList {
      * @type integer
      */
     priority?: number;
-    /** Should each content record be assigned an image id */
+    /**
+     * Should each content record be assigned an image id
+     * @deprecated Use [[ExtendedDataRule]] instead. See [extended data usage page]($docs/presentation/Customization/ExtendedDataUsage.md) for more details.
+     */
     showImages?: boolean;
     /** Specifications for joining related instances */
     relatedInstances?: RelatedInstanceSpecification[];

package/lib/esm/presentation-common/rules/content/ContentSpecification.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"ContentSpecification.d.ts","sourceRoot":"","sources":["../../../../../src/presentation-common/rules/content/ContentSpecification.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,4BAA4B,EAAE,MAAM,iCAAiC,CAAC;AAC/E,OAAO,EAAE,8CAA8C,EAAE,MAAM,kDAAkD,CAAC;AAClH,OAAO,EAAE,oCAAoC,EAAE,MAAM,wCAAwC,CAAC;AAC9F,OAAO,EAAE,oBAAoB,EAAE,MAAM,6BAA6B,CAAC;AACnE,OAAO,EAAE,kCAAkC,EAAE,MAAM,sCAAsC,CAAC;AAE1F;;;GAGG;AACH,oBAAY,yBAAyB;IACnC,iCAAiC,sCAAsC;IACvE,uBAAuB,4BAA4B;IACnD,qBAAqB,0BAA0B;CAChD;AAED;;;;;GAKG;AACH,MAAM,WAAW,wBAAyB,SAAQ,oBAAoB;IACpE,oCAAoC;IACpC,QAAQ,EAAE,yBAAyB,CAAC;IAEpC;;;;OAIG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB,yDAAyD;IACzD,UAAU,CAAC,EAAE,OAAO,CAAC;IAErB,mDAAmD;IACnD,gBAAgB,CAAC,EAAE,4BAA4B,EAAE,CAAC;IAElD;;;OAGG;IACH,gBAAgB,CAAC,EAAE,OAAO,CAAC;CAC5B;AAED;;;;;GAKG;AACH,MAAM,CAAC,OAAO,MAAM,oBAAoB,GAAG,8CAA8C,GAAG,oCAAoC,GAAG,kCAAkC,CAAC"}
+{"version":3,"file":"ContentSpecification.d.ts","sourceRoot":"","sources":["../../../../../src/presentation-common/rules/content/ContentSpecification.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,4BAA4B,EAAE,MAAM,iCAAiC,CAAC;AAC/E,OAAO,EAAE,8CAA8C,EAAE,MAAM,kDAAkD,CAAC;AAClH,OAAO,EAAE,oCAAoC,EAAE,MAAM,wCAAwC,CAAC;AAC9F,OAAO,EAAE,oBAAoB,EAAE,MAAM,6BAA6B,CAAC;AACnE,OAAO,EAAE,kCAAkC,EAAE,MAAM,sCAAsC,CAAC;AAE1F;;;GAGG;AACH,oBAAY,yBAAyB;IACnC,iCAAiC,sCAAsC;IACvE,uBAAuB,4BAA4B;IACnD,qBAAqB,0BAA0B;CAChD;AAED;;;;;GAKG;AACH,MAAM,WAAW,wBAAyB,SAAQ,oBAAoB;IACpE,oCAAoC;IACpC,QAAQ,EAAE,yBAAyB,CAAC;IAEpC;;;;OAIG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;;OAGG;IACH,UAAU,CAAC,EAAE,OAAO,CAAC;IAErB,mDAAmD;IACnD,gBAAgB,CAAC,EAAE,4BAA4B,EAAE,CAAC;IAElD;;;OAGG;IACH,gBAAgB,CAAC,EAAE,OAAO,CAAC;CAC5B;AAED;;;;;GAKG;AACH,MAAM,CAAC,OAAO,MAAM,oBAAoB,GAAG,8CAA8C,GAAG,oCAAoC,GAAG,kCAAkC,CAAC"}

package/lib/esm/presentation-common/rules/content/ContentSpecification.js.map

@@ -1 +1 @@
-{"version":3,"file":"ContentSpecification.js","sourceRoot":"","sources":["../../../../../src/presentation-common/rules/content/ContentSpecification.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAQH;;;GAGG;AACH,MAAM,CAAN,IAAY,yBAIX;AAJD,WAAY,yBAAyB;IACnC,oGAAuE,CAAA;IACvE,gFAAmD,CAAA;IACnD,4EAA+C,CAAA;AACjD,CAAC,EAJW,yBAAyB,KAAzB,yBAAyB,QAIpC","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 { ContentInstancesOfSpecificClassesSpecification } from \"./ContentInstancesOfSpecificClassesSpecification\";\r\nimport { ContentRelatedInstancesSpecification } from \"./ContentRelatedInstancesSpecification\";\r\nimport { ContentModifiersList } from \"./modifiers/ContentModifier\";\r\nimport { SelectedNodeInstancesSpecification } from \"./SelectedNodeInstancesSpecification\";\r\n\r\n/**\r\n * Used for serializing array of [[ContentSpecification]]\r\n * @public\r\n */\r\nexport enum ContentSpecificationTypes {\r\n  ContentInstancesOfSpecificClasses = \"ContentInstancesOfSpecificClasses\",\r\n  ContentRelatedInstances = \"ContentRelatedInstances\",\r\n  SelectedNodeInstances = \"SelectedNodeInstances\",\r\n}\r\n\r\n/**\r\n * Base interface for all [[ContentSpecification]] implementations. Not\r\n * meant to be used directly, see `ContentSpecification`.\r\n *\r\n * @public\r\n */\r\nexport interface ContentSpecificationBase extends ContentModifiersList {\r\n  /** Used for serializing to JSON. */\r\n  specType: ContentSpecificationTypes;\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  /** Should each content record be assigned an image id */\r\n  showImages?: boolean;\r\n\r\n  /** Specifications for joining related instances */\r\n  relatedInstances?: RelatedInstanceSpecification[];\r\n\r\n  /**\r\n   * Identifies whether we should ignore this specification if there is already an existing specification\r\n   * with higher `priority` that already provides content.\r\n   */\r\n  onlyIfNotHandled?: boolean;\r\n}\r\n\r\n/**\r\n * Content rule specifications which define what content is returned\r\n * when rule is used.\r\n *\r\n * @public\r\n */\r\nexport declare type ContentSpecification = ContentInstancesOfSpecificClassesSpecification | ContentRelatedInstancesSpecification | SelectedNodeInstancesSpecification;\r\n"]}
+{"version":3,"file":"ContentSpecification.js","sourceRoot":"","sources":["../../../../../src/presentation-common/rules/content/ContentSpecification.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAQH;;;GAGG;AACH,MAAM,CAAN,IAAY,yBAIX;AAJD,WAAY,yBAAyB;IACnC,oGAAuE,CAAA;IACvE,gFAAmD,CAAA;IACnD,4EAA+C,CAAA;AACjD,CAAC,EAJW,yBAAyB,KAAzB,yBAAyB,QAIpC","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 { ContentInstancesOfSpecificClassesSpecification } from \"./ContentInstancesOfSpecificClassesSpecification\";\r\nimport { ContentRelatedInstancesSpecification } from \"./ContentRelatedInstancesSpecification\";\r\nimport { ContentModifiersList } from \"./modifiers/ContentModifier\";\r\nimport { SelectedNodeInstancesSpecification } from \"./SelectedNodeInstancesSpecification\";\r\n\r\n/**\r\n * Used for serializing array of [[ContentSpecification]]\r\n * @public\r\n */\r\nexport enum ContentSpecificationTypes {\r\n  ContentInstancesOfSpecificClasses = \"ContentInstancesOfSpecificClasses\",\r\n  ContentRelatedInstances = \"ContentRelatedInstances\",\r\n  SelectedNodeInstances = \"SelectedNodeInstances\",\r\n}\r\n\r\n/**\r\n * Base interface for all [[ContentSpecification]] implementations. Not\r\n * meant to be used directly, see `ContentSpecification`.\r\n *\r\n * @public\r\n */\r\nexport interface ContentSpecificationBase extends ContentModifiersList {\r\n  /** Used for serializing to JSON. */\r\n  specType: ContentSpecificationTypes;\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   * Should each content record be assigned an image id\r\n   * @deprecated Use [[ExtendedDataRule]] instead. See [extended data usage page]($docs/presentation/Customization/ExtendedDataUsage.md) for more details.\r\n   */\r\n  showImages?: boolean;\r\n\r\n  /** Specifications for joining related instances */\r\n  relatedInstances?: RelatedInstanceSpecification[];\r\n\r\n  /**\r\n   * Identifies whether we should ignore this specification if there is already an existing specification\r\n   * with higher `priority` that already provides content.\r\n   */\r\n  onlyIfNotHandled?: boolean;\r\n}\r\n\r\n/**\r\n * Content rule specifications which define what content is returned\r\n * when rule is used.\r\n *\r\n * @public\r\n */\r\nexport declare type ContentSpecification = ContentInstancesOfSpecificClassesSpecification | ContentRelatedInstancesSpecification | SelectedNodeInstancesSpecification;\r\n"]}

package/lib/esm/presentation-common/rules/content/modifiers/RelatedPropertiesSpecification.d.ts

@@ -68,7 +68,7 @@ export interface RelatedPropertiesSpecification {
     skipIfDuplicate?: boolean;
     /**
      * Meaning of the relationship which tells how to categorize the related properties. Defaults to [[RelationshipMeaning.RelatedInstance]].
-     * @see [More details]($docs/presentation/Content/RelatedPropertiesSpecification.md#relationship-meaning-attribute)
+     * @see [More details]($docs/presentation/Content/RelatedPropertiesSpecification.md#attribute-relationshipmeaning)
      */
     relationshipMeaning?: RelationshipMeaning;
     /** Specifications for nested related properties */

package/lib/esm/presentation-common/rules/content/modifiers/RelatedPropertiesSpecification.js.map

@@ -1 +1 @@
-{"version":3,"file":"RelatedPropertiesSpecification.js","sourceRoot":"","sources":["../../../../../../src/presentation-common/rules/content/modifiers/RelatedPropertiesSpecification.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAKH;;;GAGG;AACH,MAAM,CAAN,IAAY,mBAcX;AAdD,WAAY,mBAAmB;IAC7B;;;;OAIG;IACH,oDAA6B,CAAA;IAE7B;;;;OAIG;IACH,0DAAmC,CAAA;AACrC,CAAC,EAdW,mBAAmB,KAAnB,mBAAmB,QAc9B;AAED;;;GAGG;AACH,MAAM,CAAN,IAAY,8BAWX;AAXD,WAAY,8BAA8B;IACxC;;;OAGG;IACH,iDAAe,CAAA;IAEf;;OAEG;IACH,2CAAS,CAAA;AACX,CAAC,EAXW,8BAA8B,KAA9B,8BAA8B,QAWzC","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 { RelationshipPathSpecification } from \"../../RelationshipPathSpecification\";\r\nimport { PropertySpecification } from \"../PropertySpecification\";\r\n\r\n/**\r\n * Meaning of the relationship\r\n * @public\r\n */\r\nexport enum RelationshipMeaning {\r\n  /**\r\n   * Related instance is part of the primary instance. Related properties\r\n   * with this meaning are displayed in UI as if they belonged to the\r\n   * primary instance.\r\n   */\r\n  SameInstance = \"SameInstance\",\r\n\r\n  /**\r\n   * Related instance if not part of the primary instance - it should\r\n   * appear as related. UI components may display related instance properties\r\n   * differently, e.g. put them under a different category, etc.\r\n   */\r\n  RelatedInstance = \"RelatedInstance\",\r\n}\r\n\r\n/**\r\n * Special values that can be used in [[RelatedPropertiesSpecification.propertyNames]]\r\n * @public\r\n */\r\nexport enum RelatedPropertiesSpecialValues {\r\n  /**\r\n   * Used to specify that no properties should be included. Usually\r\n   * used together with [[RelatedPropertiesSpecification.nestedRelatedProperties]]\r\n   */\r\n  None = \"_none_\",\r\n\r\n  /**\r\n   * Used to specify that all properties should be included.\r\n   */\r\n  All = \"*\",\r\n}\r\n\r\n/**\r\n * Sub-specification to include additional related instance properties.\r\n *\r\n * @see [More details]($docs/presentation/Content/RelatedPropertiesSpecification.md)\r\n * @public\r\n */\r\nexport interface RelatedPropertiesSpecification {\r\n  /**\r\n   * Relationship path from content class to properties' class.\r\n   */\r\n  propertiesSource: RelationshipPathSpecification;\r\n\r\n  /**\r\n   * Should the target class specified in [[propertiesSource]] be handled\r\n   * polymorphically. This means properties of not only the target class, but also all its subclasses\r\n   * are loaded.\r\n   *\r\n   * @note There's a difference between loading properties and instances polymorphically. This attribute\r\n   * only controls polymorphism of properties, while instances are always looked up in a polymorphic fashion.\r\n   */\r\n  handleTargetClassPolymorphically?: boolean;\r\n\r\n  /**\r\n   * Should field containing related properties be automatically expanded. This only takes effect when\r\n   * content class is related to properties source class through a one-to-many or many-to-many relationship.\r\n   */\r\n  autoExpand?: boolean;\r\n\r\n  /**\r\n   * Should this related properties specification be ignored if it duplicates another higher priority specification for the same relationship.\r\n   * @beta\r\n   */\r\n  skipIfDuplicate?: boolean;\r\n\r\n  /**\r\n   * Meaning of the relationship which tells how to categorize the related properties. Defaults to [[RelationshipMeaning.RelatedInstance]].\r\n   * @see [More details]($docs/presentation/Content/RelatedPropertiesSpecification.md#relationship-meaning-attribute)\r\n   */\r\n  relationshipMeaning?: RelationshipMeaning;\r\n\r\n  /** Specifications for nested related properties */\r\n  nestedRelatedProperties?: RelatedPropertiesSpecification[];\r\n\r\n  /**\r\n   * A list of property names or specifications that should be included in the content. All\r\n   * properties are included if this attribute is not specified.\r\n   */\r\n  properties?: Array<string | PropertySpecification> | RelatedPropertiesSpecialValues;\r\n}\r\n"]}
+{"version":3,"file":"RelatedPropertiesSpecification.js","sourceRoot":"","sources":["../../../../../../src/presentation-common/rules/content/modifiers/RelatedPropertiesSpecification.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAKH;;;GAGG;AACH,MAAM,CAAN,IAAY,mBAcX;AAdD,WAAY,mBAAmB;IAC7B;;;;OAIG;IACH,oDAA6B,CAAA;IAE7B;;;;OAIG;IACH,0DAAmC,CAAA;AACrC,CAAC,EAdW,mBAAmB,KAAnB,mBAAmB,QAc9B;AAED;;;GAGG;AACH,MAAM,CAAN,IAAY,8BAWX;AAXD,WAAY,8BAA8B;IACxC;;;OAGG;IACH,iDAAe,CAAA;IAEf;;OAEG;IACH,2CAAS,CAAA;AACX,CAAC,EAXW,8BAA8B,KAA9B,8BAA8B,QAWzC","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 { RelationshipPathSpecification } from \"../../RelationshipPathSpecification\";\r\nimport { PropertySpecification } from \"../PropertySpecification\";\r\n\r\n/**\r\n * Meaning of the relationship\r\n * @public\r\n */\r\nexport enum RelationshipMeaning {\r\n  /**\r\n   * Related instance is part of the primary instance. Related properties\r\n   * with this meaning are displayed in UI as if they belonged to the\r\n   * primary instance.\r\n   */\r\n  SameInstance = \"SameInstance\",\r\n\r\n  /**\r\n   * Related instance if not part of the primary instance - it should\r\n   * appear as related. UI components may display related instance properties\r\n   * differently, e.g. put them under a different category, etc.\r\n   */\r\n  RelatedInstance = \"RelatedInstance\",\r\n}\r\n\r\n/**\r\n * Special values that can be used in [[RelatedPropertiesSpecification.propertyNames]]\r\n * @public\r\n */\r\nexport enum RelatedPropertiesSpecialValues {\r\n  /**\r\n   * Used to specify that no properties should be included. Usually\r\n   * used together with [[RelatedPropertiesSpecification.nestedRelatedProperties]]\r\n   */\r\n  None = \"_none_\",\r\n\r\n  /**\r\n   * Used to specify that all properties should be included.\r\n   */\r\n  All = \"*\",\r\n}\r\n\r\n/**\r\n * Sub-specification to include additional related instance properties.\r\n *\r\n * @see [More details]($docs/presentation/Content/RelatedPropertiesSpecification.md)\r\n * @public\r\n */\r\nexport interface RelatedPropertiesSpecification {\r\n  /**\r\n   * Relationship path from content class to properties' class.\r\n   */\r\n  propertiesSource: RelationshipPathSpecification;\r\n\r\n  /**\r\n   * Should the target class specified in [[propertiesSource]] be handled\r\n   * polymorphically. This means properties of not only the target class, but also all its subclasses\r\n   * are loaded.\r\n   *\r\n   * @note There's a difference between loading properties and instances polymorphically. This attribute\r\n   * only controls polymorphism of properties, while instances are always looked up in a polymorphic fashion.\r\n   */\r\n  handleTargetClassPolymorphically?: boolean;\r\n\r\n  /**\r\n   * Should field containing related properties be automatically expanded. This only takes effect when\r\n   * content class is related to properties source class through a one-to-many or many-to-many relationship.\r\n   */\r\n  autoExpand?: boolean;\r\n\r\n  /**\r\n   * Should this related properties specification be ignored if it duplicates another higher priority specification for the same relationship.\r\n   * @beta\r\n   */\r\n  skipIfDuplicate?: boolean;\r\n\r\n  /**\r\n   * Meaning of the relationship which tells how to categorize the related properties. Defaults to [[RelationshipMeaning.RelatedInstance]].\r\n   * @see [More details]($docs/presentation/Content/RelatedPropertiesSpecification.md#attribute-relationshipmeaning)\r\n   */\r\n  relationshipMeaning?: RelationshipMeaning;\r\n\r\n  /** Specifications for nested related properties */\r\n  nestedRelatedProperties?: RelatedPropertiesSpecification[];\r\n\r\n  /**\r\n   * A list of property names or specifications that should be included in the content. All\r\n   * properties are included if this attribute is not specified.\r\n   */\r\n  properties?: Array<string | PropertySpecification> | RelatedPropertiesSpecialValues;\r\n}\r\n"]}

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

@@ -10,6 +10,7 @@ import { ConditionContainer, RuleBase, RuleTypes } from "../Rule";
  *
  * @see [More details]($docs/presentation/Customization/CheckBoxRule.md)
  * @public
+ * @deprecated Use [[ExtendedDataRule]] instead. See [extended data usage page]($docs/presentation/Customization/ExtendedDataUsage.md) for more details.
  */
 export interface CheckBoxRule extends RuleBase, ConditionContainer {
     /** Used for serializing to JSON. */

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

@@ -1 +1 @@
-{"version":3,"file":"CheckBoxRule.d.ts","sourceRoot":"","sources":["../../../../../src/presentation-common/rules/customization/CheckBoxRule.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,kBAAkB,EAAE,QAAQ,EAAE,SAAS,EAAE,MAAM,SAAS,CAAC;AAElE;;;;;;;;GAQG;AACH,MAAM,WAAW,YAAa,SAAQ,QAAQ,EAAE,kBAAkB;IAChE,oCAAoC;IACpC,QAAQ,EAAE,SAAS,CAAC,QAAQ,CAAC;IAE7B;;;;OAIG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;;;;OAKG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;;;OAIG;IACH,wBAAwB,CAAC,EAAE,OAAO,CAAC;IAEnC;;;;OAIG;IACH,YAAY,CAAC,EAAE,OAAO,CAAC;IAEvB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;CAC9B"}
+{"version":3,"file":"CheckBoxRule.d.ts","sourceRoot":"","sources":["../../../../../src/presentation-common/rules/customization/CheckBoxRule.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,kBAAkB,EAAE,QAAQ,EAAE,SAAS,EAAE,MAAM,SAAS,CAAC;AAElE;;;;;;;;;GASG;AACH,MAAM,WAAW,YAAa,SAAQ,QAAQ,EAAE,kBAAkB;IAChE,oCAAoC;IACpC,QAAQ,EAAE,SAAS,CAAC,QAAQ,CAAC;IAE7B;;;;OAIG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;;;;OAKG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;;;OAIG;IACH,wBAAwB,CAAC,EAAE,OAAO,CAAC;IAEnC;;;;OAIG;IACH,YAAY,CAAC,EAAE,OAAO,CAAC;IAEvB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;CAC9B"}

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

@@ -1 +1 @@
-{"version":3,"file":"CheckBoxRule.js","sourceRoot":"","sources":["../../../../../src/presentation-common/rules/customization/CheckBoxRule.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 that allows configuring check boxes for certain nodes.\r\n *\r\n * Is also allows binding check box state with boolean properties by setting [[propertyName]] parameter.\r\n * If [[propertyName]] is not set, then [[defaultValue]] is used for default check box state.\r\n *\r\n * @see [More details]($docs/presentation/Customization/CheckBoxRule.md)\r\n * @public\r\n */\r\nexport interface CheckBoxRule extends RuleBase, ConditionContainer {\r\n  /** Used for serializing to JSON. */\r\n  ruleType: RuleTypes.CheckBox;\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   * Name of boolean type ECProperty which is bound with the check box state. When set,\r\n   * property value gets bound to checkbox state.\r\n   *\r\n   * @minLength 1\r\n   */\r\n  propertyName?: string;\r\n\r\n  /**\r\n   * Should property value be inversed for the check box state.\r\n   *\r\n   * **Note:** Only makes sense when bound to an ECProperty.\r\n   */\r\n  useInversedPropertyValue?: boolean;\r\n\r\n  /**\r\n   * Default value to use for the check box state\r\n   *\r\n   * **Note:** Only makes sense when *not* bound to an ECProperty.\r\n   */\r\n  defaultValue?: boolean;\r\n\r\n  /**\r\n   * Indicates whether check box is enabled or disabled.\r\n   */\r\n  isEnabled?: string | boolean;\r\n}\r\n"]}
+{"version":3,"file":"CheckBoxRule.js","sourceRoot":"","sources":["../../../../../src/presentation-common/rules/customization/CheckBoxRule.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 that allows configuring check boxes for certain nodes.\r\n *\r\n * Is also allows binding check box state with boolean properties by setting [[propertyName]] parameter.\r\n * If [[propertyName]] is not set, then [[defaultValue]] is used for default check box state.\r\n *\r\n * @see [More details]($docs/presentation/Customization/CheckBoxRule.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 CheckBoxRule extends RuleBase, ConditionContainer {\r\n  /** Used for serializing to JSON. */\r\n  ruleType: RuleTypes.CheckBox;\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   * Name of boolean type ECProperty which is bound with the check box state. When set,\r\n   * property value gets bound to checkbox state.\r\n   *\r\n   * @minLength 1\r\n   */\r\n  propertyName?: string;\r\n\r\n  /**\r\n   * Should property value be inversed for the check box state.\r\n   *\r\n   * **Note:** Only makes sense when bound to an ECProperty.\r\n   */\r\n  useInversedPropertyValue?: boolean;\r\n\r\n  /**\r\n   * Default value to use for the check box state\r\n   *\r\n   * **Note:** Only makes sense when *not* bound to an ECProperty.\r\n   */\r\n  defaultValue?: boolean;\r\n\r\n  /**\r\n   * Indicates whether check box is enabled or disabled.\r\n   */\r\n  isEnabled?: string | boolean;\r\n}\r\n"]}

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

@@ -29,6 +29,9 @@ import { StyleOverride } from "./StyleOverride";
  *
  * @public
  */
-export declare type CustomizationRule = InstanceLabelOverride | CheckBoxRule | GroupingRule | ImageIdOverride | LabelOverride | // eslint-disable-line deprecation/deprecation
-SortingRule | StyleOverride | ExtendedDataRule | NodeArtifactsRule;
+export declare type CustomizationRule = InstanceLabelOverride | CheckBoxRule | // eslint-disable-line deprecation/deprecation
+GroupingRule | ImageIdOverride | // eslint-disable-line deprecation/deprecation
+LabelOverride | // eslint-disable-line deprecation/deprecation
+SortingRule | StyleOverride | // eslint-disable-line deprecation/deprecation
+ExtendedDataRule | NodeArtifactsRule;
 //# sourceMappingURL=CustomizationRule.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"CustomizationRule.d.ts","sourceRoot":"","sources":["../../../../../src/presentation-common/rules/customization/CustomizationRule.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,iBAAiB,EAAE,MAAM,gCAAgC,CAAC;AACnE,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAC9C,OAAO,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AACtD,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAC9C,OAAO,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AACpD,OAAO,EAAE,qBAAqB,EAAE,MAAM,yBAAyB,CAAC;AAChE,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAChD,OAAO,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AAC5C,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAEhD;;;;;;;;;;;;;;;;;;GAkBG;AACH,MAAM,CAAC,OAAO,MAAM,iBAAiB,GACnC,qBAAqB,GACrB,YAAY,GACZ,YAAY,GACZ,eAAe,GACf,aAAa,GAAG,8CAA8C;AAC9D,WAAW,GACX,aAAa,GACb,gBAAgB,GAChB,iBAAiB,CAAC"}
+{"version":3,"file":"CustomizationRule.d.ts","sourceRoot":"","sources":["../../../../../src/presentation-common/rules/customization/CustomizationRule.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,iBAAiB,EAAE,MAAM,gCAAgC,CAAC;AACnE,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAC9C,OAAO,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AACtD,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAC9C,OAAO,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AACpD,OAAO,EAAE,qBAAqB,EAAE,MAAM,yBAAyB,CAAC;AAChE,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAChD,OAAO,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AAC5C,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAEhD;;;;;;;;;;;;;;;;;;GAkBG;AACH,MAAM,CAAC,OAAO,MAAM,iBAAiB,GACnC,qBAAqB,GACrB,YAAY,GAAG,8CAA8C;AAC7D,YAAY,GACZ,eAAe,GAAG,8CAA8C;AAChE,aAAa,GAAG,8CAA8C;AAC9D,WAAW,GACX,aAAa,GAAG,8CAA8C;AAC9D,gBAAgB,GAChB,iBAAiB,CAAC"}

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

@@ -1 +1 @@
-{"version":3,"file":"CustomizationRule.js","sourceRoot":"","sources":["../../../../../src/presentation-common/rules/customization/CustomizationRule.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 { NodeArtifactsRule } from \"../hierarchy/NodeArtifactsRule\";\r\nimport { CheckBoxRule } from \"./CheckBoxRule\";\r\nimport { ExtendedDataRule } from \"./ExtendedDataRule\";\r\nimport { GroupingRule } from \"./GroupingRule\";\r\nimport { ImageIdOverride } from \"./ImageIdOverride\";\r\nimport { InstanceLabelOverride } from \"./InstanceLabelOverride\";\r\nimport { LabelOverride } from \"./LabelOverride\";\r\nimport { SortingRule } from \"./SortingRule\";\r\nimport { StyleOverride } from \"./StyleOverride\";\r\n\r\n/**\r\n * Customization rules allow customizing each node or content item separately.\r\n * Most of the rules have a `condition` property which uses [ECExpressions]($docs/presentation/Customization/ECExpressions.md)\r\n * for conditional rule filtering.\r\n *\r\n * **Nested customization rules:**\r\n *\r\n * Customization rules may be specified at ruleset level, in which case they're\r\n * applied to all content produced by the ruleset, or nested under navigation rules,\r\n * in which case they're applied only for nodes created by those rules.\r\n *\r\n * **Customization rule priorities:**\r\n *\r\n * Customization rules have a `priority` attribute which defines the order in which they're applied. If priorities match,\r\n * rules engine looks at the nesting level - the deeper the rule is nested, the higher is its `priority`.\r\n * If the nesting levels also match, the rule defined first wins.\r\n *\r\n * @public\r\n */\r\nexport declare type CustomizationRule =\r\n  InstanceLabelOverride |\r\n  CheckBoxRule |\r\n  GroupingRule |\r\n  ImageIdOverride |\r\n  LabelOverride | // eslint-disable-line deprecation/deprecation\r\n  SortingRule |\r\n  StyleOverride |\r\n  ExtendedDataRule |\r\n  NodeArtifactsRule;\r\n"]}
+{"version":3,"file":"CustomizationRule.js","sourceRoot":"","sources":["../../../../../src/presentation-common/rules/customization/CustomizationRule.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 { NodeArtifactsRule } from \"../hierarchy/NodeArtifactsRule\";\r\nimport { CheckBoxRule } from \"./CheckBoxRule\";\r\nimport { ExtendedDataRule } from \"./ExtendedDataRule\";\r\nimport { GroupingRule } from \"./GroupingRule\";\r\nimport { ImageIdOverride } from \"./ImageIdOverride\";\r\nimport { InstanceLabelOverride } from \"./InstanceLabelOverride\";\r\nimport { LabelOverride } from \"./LabelOverride\";\r\nimport { SortingRule } from \"./SortingRule\";\r\nimport { StyleOverride } from \"./StyleOverride\";\r\n\r\n/**\r\n * Customization rules allow customizing each node or content item separately.\r\n * Most of the rules have a `condition` property which uses [ECExpressions]($docs/presentation/Customization/ECExpressions.md)\r\n * for conditional rule filtering.\r\n *\r\n * **Nested customization rules:**\r\n *\r\n * Customization rules may be specified at ruleset level, in which case they're\r\n * applied to all content produced by the ruleset, or nested under navigation rules,\r\n * in which case they're applied only for nodes created by those rules.\r\n *\r\n * **Customization rule priorities:**\r\n *\r\n * Customization rules have a `priority` attribute which defines the order in which they're applied. If priorities match,\r\n * rules engine looks at the nesting level - the deeper the rule is nested, the higher is its `priority`.\r\n * If the nesting levels also match, the rule defined first wins.\r\n *\r\n * @public\r\n */\r\nexport declare type CustomizationRule =\r\n  InstanceLabelOverride |\r\n  CheckBoxRule | // eslint-disable-line deprecation/deprecation\r\n  GroupingRule |\r\n  ImageIdOverride | // eslint-disable-line deprecation/deprecation\r\n  LabelOverride | // eslint-disable-line deprecation/deprecation\r\n  SortingRule |\r\n  StyleOverride | // eslint-disable-line deprecation/deprecation\r\n  ExtendedDataRule |\r\n  NodeArtifactsRule;\r\n"]}

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

@@ -148,6 +148,11 @@ export interface PropertyGroup extends GroupingSpecificationBase {
      * overridden to display grouped instances count.
      *
      * **Warning:** Grouping by label and sorting by property value is not possible.
+     *
+     * @deprecated Display value should always be used for grouping. In cases when there's a
+     * need to show grouped instances count suffix, that can be achieved at the UI component
+     * layer by composing UI node's label from node's display label and
+     * [GroupingNodeKey.groupedInstancesCount]($presentation-common).
      */
     groupingValue?: PropertyGroupingValue;
     /**
@@ -159,6 +164,8 @@ export interface PropertyGroup extends GroupingSpecificationBase {
      * property value as well.
      *
      * **Warning:** Grouping by label and sorting by property value is not possible.
+     *
+     * @deprecated Property grouping nodes should always be sorted by display label.
      */
     sortingValue?: PropertyGroupingValue;
     /** Ranges into which the grouping values are divided */
@@ -169,6 +176,7 @@ export interface PropertyGroup extends GroupingSpecificationBase {
  * for grouping and sorting
  *
  * @public
+ * @deprecated The attributes using this enum are deprecated.
  */
 export declare enum PropertyGroupingValue {
     /** By property value */

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

@@ -1 +1 @@
-{"version":3,"file":"GroupingRule.d.ts","sourceRoot":"","sources":["../../../../../src/presentation-common/rules/customization/GroupingRule.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;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,MAAM,WAAW,YAAa,SAAQ,QAAQ,EAAE,kBAAkB;IAChE,oCAAoC;IACpC,QAAQ,EAAE,SAAS,CAAC,QAAQ,CAAC;IAE7B;;;;OAIG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB,uEAAuE;IACvE,KAAK,EAAE,8BAA8B,CAAC;IAEtC,iFAAiF;IACjF,MAAM,EAAE,qBAAqB,EAAE,CAAC;CACjC;AAED;;;GAGG;AACH,MAAM,CAAC,OAAO,MAAM,qBAAqB,GAAG,UAAU,GAAG,aAAa,GAAG,sBAAsB,CAAC;AAEhG;;;GAGG;AACH,oBAAY,0BAA0B;IACpC,KAAK,UAAU;IACf,QAAQ,aAAa;IACrB,iBAAiB,sBAAsB;CACxC;AAED;;;;;GAKG;AACH,MAAM,WAAW,yBAAyB;IACxC,2BAA2B;IAC3B,QAAQ,EAAE,0BAA0B,CAAC;CACtC;AAED;;;GAGG;AACH,MAAM,WAAW,UAAW,SAAQ,yBAAyB;IAC3D,oCAAoC;IACpC,QAAQ,EAAE,0BAA0B,CAAC,KAAK,CAAC;IAE3C,mFAAmF;IACnF,wBAAwB,CAAC,EAAE,OAAO,CAAC;IAEnC,+EAA+E;IAC/E,SAAS,CAAC,EAAE,8BAA8B,CAAC;CAC5C;AAED;;;;;;;;;GASG;AACH,MAAM,WAAW,sBAAuB,SAAQ,yBAAyB;IACvE,oCAAoC;IACpC,QAAQ,EAAE,0BAA0B,CAAC,iBAAiB,CAAC;IACvD;;;OAGG;IACH,gBAAgB,CAAC,EAAE,sCAAsC,CAAC;CAC3D;AAED;;;GAGG;AACH,oBAAY,sCAAsC;IAChD,qCAAqC;IACrC,KAAK,UAAU;IAEf;;;;;;OAMG;IACH,WAAW,gBAAgB;CAC5B;AAED;;;;;GAKG;AACH,MAAM,WAAW,aAAc,SAAQ,yBAAyB;IAC9D,oCAAoC;IACpC,QAAQ,EAAE,0BAA0B,CAAC,QAAQ,CAAC;IAE9C;;;;OAIG;IACH,YAAY,EAAE,MAAM,CAAC;IAErB;;;;OAIG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB,kFAAkF;IAClF,wBAAwB,CAAC,EAAE,OAAO,CAAC;IAEnC;;;;;OAKG;IACH,+BAA+B,CAAC,EAAE,OAAO,CAAC;IAE1C;;;;;;;;OAQG;IACH,aAAa,CAAC,EAAE,qBAAqB,CAAC;IAEtC;;;;;;;;;OASG;IACH,YAAY,CAAC,EAAE,qBAAqB,CAAC;IAErC,wDAAwD;IACxD,MAAM,CAAC,EAAE,+BAA+B,EAAE,CAAC;CAC5C;AAED;;;;;GAKG;AACH,oBAAY,qBAAqB;IAC/B,wBAAwB;IACxB,aAAa,kBAAkB;IAE/B,uBAAuB;IACvB,YAAY,iBAAiB;CAC9B;AAED;;;GAGG;AACH,MAAM,WAAW,+BAA+B;IAC9C;;;;OAIG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;;;;OAKG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;;;OAIG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;;;OAIG;IACH,OAAO,EAAE,MAAM,CAAC;CACjB"}
+{"version":3,"file":"GroupingRule.d.ts","sourceRoot":"","sources":["../../../../../src/presentation-common/rules/customization/GroupingRule.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;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,MAAM,WAAW,YAAa,SAAQ,QAAQ,EAAE,kBAAkB;IAChE,oCAAoC;IACpC,QAAQ,EAAE,SAAS,CAAC,QAAQ,CAAC;IAE7B;;;;OAIG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB,uEAAuE;IACvE,KAAK,EAAE,8BAA8B,CAAC;IAEtC,iFAAiF;IACjF,MAAM,EAAE,qBAAqB,EAAE,CAAC;CACjC;AAED;;;GAGG;AACH,MAAM,CAAC,OAAO,MAAM,qBAAqB,GAAG,UAAU,GAAG,aAAa,GAAG,sBAAsB,CAAC;AAEhG;;;GAGG;AACH,oBAAY,0BAA0B;IACpC,KAAK,UAAU;IACf,QAAQ,aAAa;IACrB,iBAAiB,sBAAsB;CACxC;AAED;;;;;GAKG;AACH,MAAM,WAAW,yBAAyB;IACxC,2BAA2B;IAC3B,QAAQ,EAAE,0BAA0B,CAAC;CACtC;AAED;;;GAGG;AACH,MAAM,WAAW,UAAW,SAAQ,yBAAyB;IAC3D,oCAAoC;IACpC,QAAQ,EAAE,0BAA0B,CAAC,KAAK,CAAC;IAE3C,mFAAmF;IACnF,wBAAwB,CAAC,EAAE,OAAO,CAAC;IAEnC,+EAA+E;IAC/E,SAAS,CAAC,EAAE,8BAA8B,CAAC;CAC5C;AAED;;;;;;;;;GASG;AACH,MAAM,WAAW,sBAAuB,SAAQ,yBAAyB;IACvE,oCAAoC;IACpC,QAAQ,EAAE,0BAA0B,CAAC,iBAAiB,CAAC;IACvD;;;OAGG;IACH,gBAAgB,CAAC,EAAE,sCAAsC,CAAC;CAC3D;AAED;;;GAGG;AACH,oBAAY,sCAAsC;IAChD,qCAAqC;IACrC,KAAK,UAAU;IAEf;;;;;;OAMG;IACH,WAAW,gBAAgB;CAC5B;AAED;;;;;GAKG;AACH,MAAM,WAAW,aAAc,SAAQ,yBAAyB;IAC9D,oCAAoC;IACpC,QAAQ,EAAE,0BAA0B,CAAC,QAAQ,CAAC;IAE9C;;;;OAIG;IACH,YAAY,EAAE,MAAM,CAAC;IAErB;;;;OAIG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB,kFAAkF;IAClF,wBAAwB,CAAC,EAAE,OAAO,CAAC;IAEnC;;;;;OAKG;IACH,+BAA+B,CAAC,EAAE,OAAO,CAAC;IAE1C;;;;;;;;;;;;;OAaG;IACH,aAAa,CAAC,EAAE,qBAAqB,CAAC;IAEtC;;;;;;;;;;;OAWG;IACH,YAAY,CAAC,EAAE,qBAAqB,CAAC;IAErC,wDAAwD;IACxD,MAAM,CAAC,EAAE,+BAA+B,EAAE,CAAC;CAC5C;AAED;;;;;;GAMG;AACH,oBAAY,qBAAqB;IAC/B,wBAAwB;IACxB,aAAa,kBAAkB;IAE/B,uBAAuB;IACvB,YAAY,iBAAiB;CAC9B;AAED;;;GAGG;AACH,MAAM,WAAW,+BAA+B;IAC9C;;;;OAIG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;;;;OAKG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;;;OAIG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;;;OAIG;IACH,OAAO,EAAE,MAAM,CAAC;CACjB"}

package/lib/esm/presentation-common/rules/customization/GroupingRule.js

@@ -37,6 +37,7 @@ export var SameLabelInstanceGroupApplicationStage;
  * for grouping and sorting
  *
  * @public
+ * @deprecated The attributes using this enum are deprecated.
  */
 export var PropertyGroupingValue;
 (function (PropertyGroupingValue) {

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

@@ -1 +1 @@
-{"version":3,"file":"GroupingRule.js","sourceRoot":"","sources":["../../../../../src/presentation-common/rules/customization/GroupingRule.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAmDH;;;GAGG;AACH,MAAM,CAAN,IAAY,0BAIX;AAJD,WAAY,0BAA0B;IACpC,6CAAe,CAAA;IACf,mDAAqB,CAAA;IACrB,qEAAuC,CAAA;AACzC,CAAC,EAJW,0BAA0B,KAA1B,0BAA0B,QAIrC;AAgDD;;;GAGG;AACH,MAAM,CAAN,IAAY,sCAYX;AAZD,WAAY,sCAAsC;IAChD,qCAAqC;IACrC,yDAAe,CAAA;IAEf;;;;;;OAMG;IACH,qEAA2B,CAAA;AAC7B,CAAC,EAZW,sCAAsC,KAAtC,sCAAsC,QAYjD;AAgED;;;;;GAKG;AACH,MAAM,CAAN,IAAY,qBAMX;AAND,WAAY,qBAAqB;IAC/B,wBAAwB;IACxB,wDAA+B,CAAA;IAE/B,uBAAuB;IACvB,sDAA6B,CAAA;AAC/B,CAAC,EANW,qBAAqB,KAArB,qBAAqB,QAMhC","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 * Grouping rule is an advanced way to configure node grouping.\r\n *\r\n * It allows to define these types of groupings:\r\n * - Group by base class.\r\n * - Group by any property of the instance by a common value or a range of values.\r\n * - Group multiple instances with the same label in to one ECInstance node. This can be used in cases when these\r\n * instances represent the same object for the user.\r\n *\r\n * The rule works in conjunction with other grouping options available in navigation specifications [[ChildNodeSpecification]]:\r\n * `groupByClass` and `groupByLabel`. The grouping hierarchy looks like this:\r\n * - Base ECClass grouping node (specified by base class grouping specification [[ClassGroup]])\r\n *   - ECClass grouping node (specified by `groupByClass` property)\r\n *     - ECProperty grouping node 1 (specified by 1st [[PropertyGroup]])\r\n *       - ECProperty grouping node 2 (specified by 2nd [[PropertyGroup]])\r\n *         - ECProperty grouping node n (specified by n-th [[PropertyGroup]])\r\n *           - Display label grouping node (specified by `groupByLabel` property)\r\n *             - ECInstance nodes (may be grouped under a single node by [[SameLabelInstanceGroup]])\r\n *\r\n * @see [More details]($docs/presentation/Hierarchies/GroupingRule.md)\r\n * @public\r\n */\r\nexport interface GroupingRule extends RuleBase, ConditionContainer {\r\n  /** Used for serializing to JSON. */\r\n  ruleType: RuleTypes.Grouping;\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/Hierarchies/ECExpressions.md#rule-condition).\r\n   */\r\n  condition?: string;\r\n\r\n  /** Specification of ECClass which should be grouped using this rule */\r\n  class: SingleSchemaClassSpecification;\r\n\r\n  /** Specifications of grouping which should be applied to matching ECInstances */\r\n  groups: GroupingSpecification[];\r\n}\r\n\r\n/**\r\n * Grouping rule specifications\r\n * @public\r\n */\r\nexport declare type GroupingSpecification = ClassGroup | PropertyGroup | SameLabelInstanceGroup;\r\n\r\n/**\r\n * Available types of [[GroupingSpecification]]\r\n * @public\r\n */\r\nexport enum GroupingSpecificationTypes {\r\n  Class = \"Class\",\r\n  Property = \"Property\",\r\n  SameLabelInstance = \"SameLabelInstance\",\r\n}\r\n\r\n/**\r\n * Base interface for all [[GroupingSpecification]] implementations. Not\r\n * meant to be used directly, see `GroupingSpecification`.\r\n *\r\n * @public\r\n */\r\nexport interface GroupingSpecificationBase {\r\n  /** Type of the subclass */\r\n  specType: GroupingSpecificationTypes;\r\n}\r\n\r\n/**\r\n * Allows grouping ECInstance nodes by their base class.\r\n * @public\r\n */\r\nexport interface ClassGroup extends GroupingSpecificationBase {\r\n  /** Used for serializing to JSON. */\r\n  specType: GroupingSpecificationTypes.Class;\r\n\r\n  /** Should the grouping node be created if there is only one item in that group. */\r\n  createGroupForSingleItem?: boolean;\r\n\r\n  /** Specification of the base ECClass to group by. Defaults to rule's class. */\r\n  baseClass?: SingleSchemaClassSpecification;\r\n}\r\n\r\n/**\r\n * Allows grouping multiple instances with the same label into one ECInstance node.\r\n * It can be used in cases when these instances represent the same object for the user.\r\n *\r\n * When multiple instances are grouped, an ECInstance node is created instead of a\r\n * grouping node and the ECInstance key for the node is assigned to key of one of grouped\r\n * instances.\r\n *\r\n * @public\r\n */\r\nexport interface SameLabelInstanceGroup extends GroupingSpecificationBase {\r\n  /** Used for serializing to JSON. */\r\n  specType: GroupingSpecificationTypes.SameLabelInstance;\r\n  /**\r\n   * Stage of hierarchy creation at which the rule is applied.\r\n   * Defaults to [[SameLabelInstanceGroupApplicationStage.Query]].\r\n   */\r\n  applicationStage?: SameLabelInstanceGroupApplicationStage;\r\n}\r\n\r\n/**\r\n * Specifies hierarchy creation stages used to apply [[SameLabelInstanceGroup]] grouping.\r\n * @public\r\n */\r\nexport enum SameLabelInstanceGroupApplicationStage {\r\n  /** Apply grouping at query stage. */\r\n  Query = \"Query\",\r\n\r\n  /**\r\n   * Apply grouping at post-processing stage.\r\n   *\r\n   * This allows grouping nodes created by different hierarchy specifications at\r\n   * a higher performance cost as it requires loading the whole hierarchy level before\r\n   * returning even the first node - avoid using with large numbers of nodes.\r\n   */\r\n  PostProcess = \"PostProcess\",\r\n}\r\n\r\n/**\r\n * Allows grouping by property of the instance\r\n * by a common value or by range of values.\r\n *\r\n * @public\r\n */\r\nexport interface PropertyGroup extends GroupingSpecificationBase {\r\n  /** Used for serializing to JSON. */\r\n  specType: GroupingSpecificationTypes.Property;\r\n\r\n  /**\r\n   * Name of the ECProperty which is used for grouping.\r\n   *\r\n   * @minLength 1\r\n   */\r\n  propertyName: string;\r\n\r\n  /**\r\n   * ID of an image to use for the grouping node\r\n   *\r\n   * @minLength 1\r\n   */\r\n  imageId?: string;\r\n\r\n  /** Should the grouping node be created if there is only one item in that group */\r\n  createGroupForSingleItem?: boolean;\r\n\r\n  /**\r\n   * Should a separate grouping node be created for nodes whose grouping value is not\r\n   * set or is an empty string.\r\n   *\r\n   * Defaults to `true`.\r\n   */\r\n  createGroupForUnspecifiedValues?: boolean;\r\n\r\n  /**\r\n   * Should the instances be grouped on display label or the grouping property value.\r\n   * Defaults to [[PropertyGroupingValue.DisplayLabel]].\r\n   *\r\n   * **Note:** Grouping by property value is required if the display label is\r\n   * overridden to display grouped instances count.\r\n   *\r\n   * **Warning:** Grouping by label and sorting by property value is not possible.\r\n   */\r\n  groupingValue?: PropertyGroupingValue;\r\n\r\n  /**\r\n   * Should the nodes be sorted by display label or the grouping property value. In most\r\n   * cases the result is the same, unless [[LabelOverride]] rule is used to change the display label.\r\n   * Defaults to [[PropertyGroupingValue.DisplayLabel]].\r\n   *\r\n   * **Note:** Sorting by property value only makes sense when instances are grouped by\r\n   * property value as well.\r\n   *\r\n   * **Warning:** Grouping by label and sorting by property value is not possible.\r\n   */\r\n  sortingValue?: PropertyGroupingValue;\r\n\r\n  /** Ranges into which the grouping values are divided */\r\n  ranges?: PropertyRangeGroupSpecification[];\r\n}\r\n\r\n/**\r\n * Used in [[PropertyGroup]] to specify the type of value to use\r\n * for grouping and sorting\r\n *\r\n * @public\r\n */\r\nexport enum PropertyGroupingValue {\r\n  /** By property value */\r\n  PropertyValue = \"PropertyValue\",\r\n\r\n  /** By display label */\r\n  DisplayLabel = \"DisplayLabel\",\r\n}\r\n\r\n/**\r\n * Describes a grouping range\r\n * @public\r\n */\r\nexport interface PropertyRangeGroupSpecification {\r\n  /**\r\n   * ID of an image to use for the grouping node. Defaults to [[PropertyGroup.imageId]] specified in [[PropertyGroup]].\r\n   *\r\n   * @minLength 1\r\n   */\r\n  imageId?: string;\r\n\r\n  /**\r\n   * Grouping node label. May be [localized]($docs/presentation/Advanced/Localization.md).\r\n   * Defaults to `{from value} - {to value}`\r\n   *\r\n   * @minLength 1\r\n   */\r\n  label?: string;\r\n\r\n  /**\r\n   * Value that defines the range start (inclusive)\r\n   *\r\n   * @minLength 1\r\n   */\r\n  fromValue: string;\r\n\r\n  /**\r\n   * Value that defines the range end (inclusive)\r\n   *\r\n   * @minLength 1\r\n   */\r\n  toValue: string;\r\n}\r\n"]}
+{"version":3,"file":"GroupingRule.js","sourceRoot":"","sources":["../../../../../src/presentation-common/rules/customization/GroupingRule.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAmDH;;;GAGG;AACH,MAAM,CAAN,IAAY,0BAIX;AAJD,WAAY,0BAA0B;IACpC,6CAAe,CAAA;IACf,mDAAqB,CAAA;IACrB,qEAAuC,CAAA;AACzC,CAAC,EAJW,0BAA0B,KAA1B,0BAA0B,QAIrC;AAgDD;;;GAGG;AACH,MAAM,CAAN,IAAY,sCAYX;AAZD,WAAY,sCAAsC;IAChD,qCAAqC;IACrC,yDAAe,CAAA;IAEf;;;;;;OAMG;IACH,qEAA2B,CAAA;AAC7B,CAAC,EAZW,sCAAsC,KAAtC,sCAAsC,QAYjD;AAuED;;;;;;GAMG;AACH,MAAM,CAAN,IAAY,qBAMX;AAND,WAAY,qBAAqB;IAC/B,wBAAwB;IACxB,wDAA+B,CAAA;IAE/B,uBAAuB;IACvB,sDAA6B,CAAA;AAC/B,CAAC,EANW,qBAAqB,KAArB,qBAAqB,QAMhC","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 * Grouping rule is an advanced way to configure node grouping.\r\n *\r\n * It allows to define these types of groupings:\r\n * - Group by base class.\r\n * - Group by any property of the instance by a common value or a range of values.\r\n * - Group multiple instances with the same label in to one ECInstance node. This can be used in cases when these\r\n * instances represent the same object for the user.\r\n *\r\n * The rule works in conjunction with other grouping options available in navigation specifications [[ChildNodeSpecification]]:\r\n * `groupByClass` and `groupByLabel`. The grouping hierarchy looks like this:\r\n * - Base ECClass grouping node (specified by base class grouping specification [[ClassGroup]])\r\n *   - ECClass grouping node (specified by `groupByClass` property)\r\n *     - ECProperty grouping node 1 (specified by 1st [[PropertyGroup]])\r\n *       - ECProperty grouping node 2 (specified by 2nd [[PropertyGroup]])\r\n *         - ECProperty grouping node n (specified by n-th [[PropertyGroup]])\r\n *           - Display label grouping node (specified by `groupByLabel` property)\r\n *             - ECInstance nodes (may be grouped under a single node by [[SameLabelInstanceGroup]])\r\n *\r\n * @see [More details]($docs/presentation/Hierarchies/GroupingRule.md)\r\n * @public\r\n */\r\nexport interface GroupingRule extends RuleBase, ConditionContainer {\r\n  /** Used for serializing to JSON. */\r\n  ruleType: RuleTypes.Grouping;\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/Hierarchies/ECExpressions.md#rule-condition).\r\n   */\r\n  condition?: string;\r\n\r\n  /** Specification of ECClass which should be grouped using this rule */\r\n  class: SingleSchemaClassSpecification;\r\n\r\n  /** Specifications of grouping which should be applied to matching ECInstances */\r\n  groups: GroupingSpecification[];\r\n}\r\n\r\n/**\r\n * Grouping rule specifications\r\n * @public\r\n */\r\nexport declare type GroupingSpecification = ClassGroup | PropertyGroup | SameLabelInstanceGroup;\r\n\r\n/**\r\n * Available types of [[GroupingSpecification]]\r\n * @public\r\n */\r\nexport enum GroupingSpecificationTypes {\r\n  Class = \"Class\",\r\n  Property = \"Property\",\r\n  SameLabelInstance = \"SameLabelInstance\",\r\n}\r\n\r\n/**\r\n * Base interface for all [[GroupingSpecification]] implementations. Not\r\n * meant to be used directly, see `GroupingSpecification`.\r\n *\r\n * @public\r\n */\r\nexport interface GroupingSpecificationBase {\r\n  /** Type of the subclass */\r\n  specType: GroupingSpecificationTypes;\r\n}\r\n\r\n/**\r\n * Allows grouping ECInstance nodes by their base class.\r\n * @public\r\n */\r\nexport interface ClassGroup extends GroupingSpecificationBase {\r\n  /** Used for serializing to JSON. */\r\n  specType: GroupingSpecificationTypes.Class;\r\n\r\n  /** Should the grouping node be created if there is only one item in that group. */\r\n  createGroupForSingleItem?: boolean;\r\n\r\n  /** Specification of the base ECClass to group by. Defaults to rule's class. */\r\n  baseClass?: SingleSchemaClassSpecification;\r\n}\r\n\r\n/**\r\n * Allows grouping multiple instances with the same label into one ECInstance node.\r\n * It can be used in cases when these instances represent the same object for the user.\r\n *\r\n * When multiple instances are grouped, an ECInstance node is created instead of a\r\n * grouping node and the ECInstance key for the node is assigned to key of one of grouped\r\n * instances.\r\n *\r\n * @public\r\n */\r\nexport interface SameLabelInstanceGroup extends GroupingSpecificationBase {\r\n  /** Used for serializing to JSON. */\r\n  specType: GroupingSpecificationTypes.SameLabelInstance;\r\n  /**\r\n   * Stage of hierarchy creation at which the rule is applied.\r\n   * Defaults to [[SameLabelInstanceGroupApplicationStage.Query]].\r\n   */\r\n  applicationStage?: SameLabelInstanceGroupApplicationStage;\r\n}\r\n\r\n/**\r\n * Specifies hierarchy creation stages used to apply [[SameLabelInstanceGroup]] grouping.\r\n * @public\r\n */\r\nexport enum SameLabelInstanceGroupApplicationStage {\r\n  /** Apply grouping at query stage. */\r\n  Query = \"Query\",\r\n\r\n  /**\r\n   * Apply grouping at post-processing stage.\r\n   *\r\n   * This allows grouping nodes created by different hierarchy specifications at\r\n   * a higher performance cost as it requires loading the whole hierarchy level before\r\n   * returning even the first node - avoid using with large numbers of nodes.\r\n   */\r\n  PostProcess = \"PostProcess\",\r\n}\r\n\r\n/**\r\n * Allows grouping by property of the instance\r\n * by a common value or by range of values.\r\n *\r\n * @public\r\n */\r\nexport interface PropertyGroup extends GroupingSpecificationBase {\r\n  /** Used for serializing to JSON. */\r\n  specType: GroupingSpecificationTypes.Property;\r\n\r\n  /**\r\n   * Name of the ECProperty which is used for grouping.\r\n   *\r\n   * @minLength 1\r\n   */\r\n  propertyName: string;\r\n\r\n  /**\r\n   * ID of an image to use for the grouping node\r\n   *\r\n   * @minLength 1\r\n   */\r\n  imageId?: string;\r\n\r\n  /** Should the grouping node be created if there is only one item in that group */\r\n  createGroupForSingleItem?: boolean;\r\n\r\n  /**\r\n   * Should a separate grouping node be created for nodes whose grouping value is not\r\n   * set or is an empty string.\r\n   *\r\n   * Defaults to `true`.\r\n   */\r\n  createGroupForUnspecifiedValues?: boolean;\r\n\r\n  /**\r\n   * Should the instances be grouped on display label or the grouping property value.\r\n   * Defaults to [[PropertyGroupingValue.DisplayLabel]].\r\n   *\r\n   * **Note:** Grouping by property value is required if the display label is\r\n   * overridden to display grouped instances count.\r\n   *\r\n   * **Warning:** Grouping by label and sorting by property value is not possible.\r\n   *\r\n   * @deprecated Display value should always be used for grouping. In cases when there's a\r\n   * need to show grouped instances count suffix, that can be achieved at the UI component\r\n   * layer by composing UI node's label from node's display label and\r\n   * [GroupingNodeKey.groupedInstancesCount]($presentation-common).\r\n   */\r\n  groupingValue?: PropertyGroupingValue; // eslint-disable-line deprecation/deprecation\r\n\r\n  /**\r\n   * Should the nodes be sorted by display label or the grouping property value. In most\r\n   * cases the result is the same, unless [[LabelOverride]] rule is used to change the display label.\r\n   * Defaults to [[PropertyGroupingValue.DisplayLabel]].\r\n   *\r\n   * **Note:** Sorting by property value only makes sense when instances are grouped by\r\n   * property value as well.\r\n   *\r\n   * **Warning:** Grouping by label and sorting by property value is not possible.\r\n   *\r\n   * @deprecated Property grouping nodes should always be sorted by display label.\r\n   */\r\n  sortingValue?: PropertyGroupingValue; // eslint-disable-line deprecation/deprecation\r\n\r\n  /** Ranges into which the grouping values are divided */\r\n  ranges?: PropertyRangeGroupSpecification[];\r\n}\r\n\r\n/**\r\n * Used in [[PropertyGroup]] to specify the type of value to use\r\n * for grouping and sorting\r\n *\r\n * @public\r\n * @deprecated The attributes using this enum are deprecated.\r\n */\r\nexport enum PropertyGroupingValue {\r\n  /** By property value */\r\n  PropertyValue = \"PropertyValue\",\r\n\r\n  /** By display label */\r\n  DisplayLabel = \"DisplayLabel\",\r\n}\r\n\r\n/**\r\n * Describes a grouping range\r\n * @public\r\n */\r\nexport interface PropertyRangeGroupSpecification {\r\n  /**\r\n   * ID of an image to use for the grouping node. Defaults to [[PropertyGroup.imageId]] specified in [[PropertyGroup]].\r\n   *\r\n   * @minLength 1\r\n   */\r\n  imageId?: string;\r\n\r\n  /**\r\n   * Grouping node label. May be [localized]($docs/presentation/Advanced/Localization.md).\r\n   * Defaults to `{from value} - {to value}`\r\n   *\r\n   * @minLength 1\r\n   */\r\n  label?: string;\r\n\r\n  /**\r\n   * Value that defines the range start (inclusive)\r\n   *\r\n   * @minLength 1\r\n   */\r\n  fromValue: string;\r\n\r\n  /**\r\n   * Value that defines the range end (inclusive)\r\n   *\r\n   * @minLength 1\r\n   */\r\n  toValue: string;\r\n}\r\n"]}

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

@@ -8,6 +8,7 @@ import { ConditionContainer, RuleBase, RuleTypes } from "../Rule";
  *
  * @see [More details]($docs/presentation/Customization/ImageIdOverride.md)
  * @public
+ * @deprecated Use [[ExtendedDataRule]] instead. See [extended data usage page]($docs/presentation/Customization/ExtendedDataUsage.md) for more details.
  */
 export interface ImageIdOverride extends RuleBase, ConditionContainer {
     /** Used for serializing to JSON. */

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

@@ -1 +1 @@
-{"version":3,"file":"ImageIdOverride.d.ts","sourceRoot":"","sources":["../../../../../src/presentation-common/rules/customization/ImageIdOverride.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,kBAAkB,EAAE,QAAQ,EAAE,SAAS,EAAE,MAAM,SAAS,CAAC;AAElE;;;;;;GAMG;AACH,MAAM,WAAW,eAAgB,SAAQ,QAAQ,EAAE,kBAAkB;IACnE,oCAAoC;IACpC,QAAQ,EAAE,SAAS,CAAC,eAAe,CAAC;IAEpC;;;;OAIG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;;;;;OAMG;IACH,iBAAiB,EAAE,MAAM,CAAC;CAC3B"}
+{"version":3,"file":"ImageIdOverride.d.ts","sourceRoot":"","sources":["../../../../../src/presentation-common/rules/customization/ImageIdOverride.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,kBAAkB,EAAE,QAAQ,EAAE,SAAS,EAAE,MAAM,SAAS,CAAC;AAElE;;;;;;;GAOG;AACH,MAAM,WAAW,eAAgB,SAAQ,QAAQ,EAAE,kBAAkB;IACnE,oCAAoC;IACpC,QAAQ,EAAE,SAAS,CAAC,eAAe,CAAC;IAEpC;;;;OAIG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;;;;;OAMG;IACH,iBAAiB,EAAE,MAAM,CAAC;CAC3B"}

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

@@ -1 +1 @@
-{"version":3,"file":"ImageIdOverride.js","sourceRoot":"","sources":["../../../../../src/presentation-common/rules/customization/ImageIdOverride.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 that allows overriding default icon and dynamically define an icon\r\n * for a particular node based on the context.\r\n *\r\n * @see [More details]($docs/presentation/Customization/ImageIdOverride.md)\r\n * @public\r\n */\r\nexport interface ImageIdOverride extends RuleBase, ConditionContainer {\r\n  /** Used for serializing to JSON. */\r\n  ruleType: RuleTypes.ImageIdOverride;\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 an image ID that should be used for nodes that meet rule condition. This is\r\n   * an [ECExpression]($docs/presentation/Customization/ECExpressions.md), so ID can be\r\n   * defined/formatted dynamically based on the context - for example ECInstance property value.\r\n   *\r\n   * @minLength 1\r\n   */\r\n  imageIdExpression: string;\r\n}\r\n"]}
+{"version":3,"file":"ImageIdOverride.js","sourceRoot":"","sources":["../../../../../src/presentation-common/rules/customization/ImageIdOverride.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 that allows overriding default icon and dynamically define an icon\r\n * for a particular node based on the context.\r\n *\r\n * @see [More details]($docs/presentation/Customization/ImageIdOverride.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 ImageIdOverride extends RuleBase, ConditionContainer {\r\n  /** Used for serializing to JSON. */\r\n  ruleType: RuleTypes.ImageIdOverride;\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 an image ID that should be used for nodes that meet rule condition. This is\r\n   * an [ECExpression]($docs/presentation/Customization/ECExpressions.md), so ID can be\r\n   * defined/formatted dynamically based on the context - for example ECInstance property value.\r\n   *\r\n   * @minLength 1\r\n   */\r\n  imageIdExpression: string;\r\n}\r\n"]}

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

@@ -11,6 +11,7 @@ import { ConditionContainer, RuleBase, RuleTypes } from "../Rule";
  *
  * @see [More details]($docs/presentation/Customization/LabelOverride.md)
  * @public
+ * @deprecated Use [[InstanceLabelOverride]] rule instead.
  */
 export interface LabelOverride extends RuleBase, ConditionContainer {
     /** Used for serializing to JSON. */

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,kBAAkB,EAAE,QAAQ,EAAE,SAAS,EAAE,MAAM,SAAS,CAAC;AAElE;;;;;;;;;;GAUG;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"}

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 { 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 * @deprecated Use [[InstanceLabelOverride]] rule instead.\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"]}

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

@@ -8,6 +8,7 @@ import { ConditionContainer, RuleBase, RuleTypes } from "../Rule";
  *
  * @see [More details]($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 {
     /** Used for serializing to JSON. */

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,kBAAkB,EAAE,QAAQ,EAAE,SAAS,EAAE,MAAM,SAAS,CAAC;AAElE;;;;;;;GAOG;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"}

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 { 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 * @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, 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"]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@itwin/presentation-common",
-  "version": "3.1.0-dev.8",
+  "version": "3.2.0-dev.12",
   "description": "Common pieces for iModel.js presentation packages",
   "imodeljsSharedLibrary": true,
   "license": "MIT",
@@ -22,16 +22,16 @@
   "module": "lib/esm/presentation-common.js",
   "typings": "lib/cjs/presentation-common",
   "peerDependencies": {
-    "@itwin/core-bentley": "^3.1.0-dev.8",
-    "@itwin/core-common": "^3.1.0-dev.8",
-    "@itwin/core-quantity": "^3.1.0-dev.8"
+    "@itwin/core-bentley": "^3.2.0-dev.12",
+    "@itwin/core-common": "^3.2.0-dev.12",
+    "@itwin/core-quantity": "^3.2.0-dev.12"
   },
   "devDependencies": {
-    "@itwin/build-tools": "3.1.0-dev.8",
-    "@itwin/core-bentley": "3.1.0-dev.8",
-    "@itwin/core-common": "3.1.0-dev.8",
-    "@itwin/core-quantity": "3.1.0-dev.8",
-    "@itwin/eslint-plugin": "3.1.0-dev.8",
+    "@itwin/build-tools": "3.2.0-dev.12",
+    "@itwin/core-bentley": "3.2.0-dev.12",
+    "@itwin/core-common": "3.2.0-dev.12",
+    "@itwin/core-quantity": "3.2.0-dev.12",
+    "@itwin/eslint-plugin": "3.2.0-dev.12",
     "@types/chai": "^4.1.4",
     "@types/chai-as-promised": "^7",
     "@types/chai-jest-snapshot": "^1.3.0",