@itwin/presentation-common 5.0.0-dev.11 → 5.0.0-dev.110

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

@@ -1,8 +1,8 @@
 /** @packageDocumentation
  * @module PresentationRules
  */
-import { RelationshipPathSpecification } from "../../RelationshipPathSpecification";
-import { PropertySpecification } from "../PropertySpecification";
+import { RelationshipPathSpecification } from "../../RelationshipPathSpecification.js";
+import { PropertySpecification } from "../PropertySpecification.js";
 /**
  * Meaning of the relationship.
  * @public

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

@@ -1 +1 @@
-{"version":3,"file":"RelatedPropertiesSpecification.d.ts","sourceRoot":"","sources":["../../../../../../src/presentation-common/rules/content/modifiers/RelatedPropertiesSpecification.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,6BAA6B,EAAE,MAAM,qCAAqC,CAAC;AACpF,OAAO,EAAE,qBAAqB,EAAE,MAAM,0BAA0B,CAAC;AAEjE;;;GAGG;AACH,oBAAY,mBAAmB;IAC7B;;;OAGG;IACH,YAAY,iBAAiB;IAE7B;;;OAGG;IACH,eAAe,oBAAoB;CACpC;AAED;;;GAGG;AACH,oBAAY,8BAA8B;IACxC;;;OAGG;IACH,IAAI,WAAW;IAEf;;OAEG;IACH,GAAG,MAAM;CACV;AAED;;;;;GAKG;AACH,MAAM,WAAW,8BAA8B;IAC7C;;;OAGG;IACH,gBAAgB,EAAE,6BAA6B,CAAC;IAEhD;;;;OAIG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB;;;;;;;OAOG;IACH,gCAAgC,CAAC,EAAE,OAAO,CAAC;IAE3C;;;OAGG;IACH,UAAU,CAAC,EAAE,OAAO,CAAC;IAErB;;OAEG;IACH,eAAe,CAAC,EAAE,OAAO,CAAC;IAE1B;;;;OAIG;IACH,mBAAmB,CAAC,EAAE,GAAG,mBAAmB,EAAE,CAAC;IAE/C,gIAAgI;IAChI,uBAAuB,CAAC,EAAE,8BAA8B,EAAE,CAAC;IAE3D;;;OAGG;IACH,UAAU,CAAC,EAAE,KAAK,CAAC,MAAM,GAAG,qBAAqB,CAAC,GAAG,GAAG,8BAA8B,EAAE,CAAC;IAEzF;;;OAGG;IACH,sBAAsB,CAAC,EAAE,KAAK,CAAC,MAAM,GAAG,qBAAqB,CAAC,GAAG,GAAG,8BAA8B,EAAE,CAAC;IAErG;;OAEG;IACH,+BAA+B,CAAC,EAAE,OAAO,CAAC;CAC3C"}
+{"version":3,"file":"RelatedPropertiesSpecification.d.ts","sourceRoot":"","sources":["../../../../../../src/presentation-common/rules/content/modifiers/RelatedPropertiesSpecification.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,6BAA6B,EAAE,MAAM,wCAAwC,CAAC;AACvF,OAAO,EAAE,qBAAqB,EAAE,MAAM,6BAA6B,CAAC;AAEpE;;;GAGG;AACH,oBAAY,mBAAmB;IAC7B;;;OAGG;IACH,YAAY,iBAAiB;IAE7B;;;OAGG;IACH,eAAe,oBAAoB;CACpC;AAED;;;GAGG;AACH,oBAAY,8BAA8B;IACxC;;;OAGG;IACH,IAAI,WAAW;IAEf;;OAEG;IACH,GAAG,MAAM;CACV;AAED;;;;;GAKG;AACH,MAAM,WAAW,8BAA8B;IAC7C;;;OAGG;IACH,gBAAgB,EAAE,6BAA6B,CAAC;IAEhD;;;;OAIG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB;;;;;;;OAOG;IACH,gCAAgC,CAAC,EAAE,OAAO,CAAC;IAE3C;;;OAGG;IACH,UAAU,CAAC,EAAE,OAAO,CAAC;IAErB;;OAEG;IACH,eAAe,CAAC,EAAE,OAAO,CAAC;IAE1B;;;;OAIG;IACH,mBAAmB,CAAC,EAAE,GAAG,mBAAmB,EAAE,CAAC;IAE/C,gIAAgI;IAChI,uBAAuB,CAAC,EAAE,8BAA8B,EAAE,CAAC;IAE3D;;;OAGG;IACH,UAAU,CAAC,EAAE,KAAK,CAAC,MAAM,GAAG,qBAAqB,CAAC,GAAG,GAAG,8BAA8B,EAAE,CAAC;IAEzF;;;OAGG;IACH,sBAAsB,CAAC,EAAE,KAAK,CAAC,MAAM,GAAG,qBAAqB,CAAC,GAAG,GAAG,8BAA8B,EAAE,CAAC;IAErG;;OAEG;IACH,+BAA+B,CAAC,EAAE,OAAO,CAAC;CAC3C"}

package/lib/cjs/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;;;gGAGgG;AAChG;;GAEG;;;AAKH;;;GAGG;AACH,IAAY,mBAYX;AAZD,WAAY,mBAAmB;IAC7B;;;OAGG;IACH,oDAA6B,CAAA;IAE7B;;;OAGG;IACH,0DAAmC,CAAA;AACrC,CAAC,EAZW,mBAAmB,mCAAnB,mBAAmB,QAY9B;AAED;;;GAGG;AACH,IAAY,8BAWX;AAXD,WAAY,8BAA8B;IACxC;;;OAGG;IACH,iDAAe,CAAA;IAEf;;OAEG;IACH,2CAAS,CAAA;AACX,CAAC,EAXW,8BAA8B,8CAA9B,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   * The properties should be displayed as if they belonged to the [primary instance]($docs/presentation/content/Terminology.md#primary-instance).\r\n   * Generally that means they assigned a category, that's nested under the default category.\r\n   */\r\n  SameInstance = \"SameInstance\",\r\n\r\n  /**\r\n   * The properties should be distinguished from properties of the [primary instance]($docs/presentation/content/Terminology.md#primary-instance)\r\n   * and shown separately to make it clear they belong to another instance. Generally that means they're assigned a separate root category.\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 * This specification allows including related instance properties into the content.\r\n *\r\n * @see [Related properties specification specification reference documentation page]($docs/presentation/content/RelatedPropertiesSpecification.md)\r\n * @public\r\n */\r\nexport interface RelatedPropertiesSpecification {\r\n  /**\r\n   * Specifies a chain of [relationship path specifications]($docs/presentation/RelationshipPathSpecification.md) that\r\n   * forms a path from the content instance to the related instance(s) whose properties should additionally be loaded.\r\n   */\r\n  propertiesSource: RelationshipPathSpecification;\r\n\r\n  /**\r\n   * Condition for filtering instances targeted by the [[propertiesSource]] attribute.\r\n   *\r\n   * **See:** [ECExpressions available in instance filter]($docs/presentation/Content/ECExpressions.md#instance-filter)\r\n   */\r\n  instanceFilter?: string;\r\n\r\n  /**\r\n   * The attribute tells whether the target class specified through [[propertiesSource]] should be handled\r\n   * polymorphically. This means properties of the concrete class are loaded in addition to properties of the\r\n   * target class itself.\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 the field containing related properties be assigned the [[NestedContentField.autoExpand]]\r\n   * attribute. The attribute tells UI components showing the properties that they should be initially displayed in the expanded state.\r\n   */\r\n  autoExpand?: boolean;\r\n\r\n  /**\r\n   * Specifies whether the specification should be ignored if another higher priority specification for the same relationship already exists.\r\n   */\r\n  skipIfDuplicate?: boolean;\r\n\r\n  /**\r\n   * The attribute describes what the related properties mean to the [primary instance]($docs/presentation/content/Terminology.md#primary-instance)\r\n   * whose properties are displayed.\r\n   * @see RelationshipMeaning\r\n   */\r\n  relationshipMeaning?: `${RelationshipMeaning}`;\r\n\r\n  /** The attribute allows loading additional related properties that are related to the target instance of this specification. */\r\n  nestedRelatedProperties?: RelatedPropertiesSpecification[];\r\n\r\n  /**\r\n   * List of names or definitions of related class properties that should be included in the content.\r\n   * @see RelatedPropertiesSpecialValues\r\n   */\r\n  properties?: Array<string | PropertySpecification> | `${RelatedPropertiesSpecialValues}`;\r\n\r\n  /**\r\n   * List of names or definitions of relationship class properties that should be included in the content.\r\n   * @see RelatedPropertiesSpecialValues\r\n   */\r\n  relationshipProperties?: Array<string | PropertySpecification> | `${RelatedPropertiesSpecialValues}`;\r\n\r\n  /**\r\n   * Specifies whether a relationship category should be created regardless of whether any relationship properties were included.\r\n   */\r\n  forceCreateRelationshipCategory?: boolean;\r\n}\r\n"]}
+{"version":3,"file":"RelatedPropertiesSpecification.js","sourceRoot":"","sources":["../../../../../../src/presentation-common/rules/content/modifiers/RelatedPropertiesSpecification.ts"],"names":[],"mappings":";AAAA;;;gGAGgG;AAChG;;GAEG;;;AAKH;;;GAGG;AACH,IAAY,mBAYX;AAZD,WAAY,mBAAmB;IAC7B;;;OAGG;IACH,oDAA6B,CAAA;IAE7B;;;OAGG;IACH,0DAAmC,CAAA;AACrC,CAAC,EAZW,mBAAmB,mCAAnB,mBAAmB,QAY9B;AAED;;;GAGG;AACH,IAAY,8BAWX;AAXD,WAAY,8BAA8B;IACxC;;;OAGG;IACH,iDAAe,CAAA;IAEf;;OAEG;IACH,2CAAS,CAAA;AACX,CAAC,EAXW,8BAA8B,8CAA9B,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.js\";\r\nimport { PropertySpecification } from \"../PropertySpecification.js\";\r\n\r\n/**\r\n * Meaning of the relationship.\r\n * @public\r\n */\r\nexport enum RelationshipMeaning {\r\n  /**\r\n   * The properties should be displayed as if they belonged to the [primary instance]($docs/presentation/content/Terminology.md#primary-instance).\r\n   * Generally that means they assigned a category, that's nested under the default category.\r\n   */\r\n  SameInstance = \"SameInstance\",\r\n\r\n  /**\r\n   * The properties should be distinguished from properties of the [primary instance]($docs/presentation/content/Terminology.md#primary-instance)\r\n   * and shown separately to make it clear they belong to another instance. Generally that means they're assigned a separate root category.\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 * This specification allows including related instance properties into the content.\r\n *\r\n * @see [Related properties specification specification reference documentation page]($docs/presentation/content/RelatedPropertiesSpecification.md)\r\n * @public\r\n */\r\nexport interface RelatedPropertiesSpecification {\r\n  /**\r\n   * Specifies a chain of [relationship path specifications]($docs/presentation/RelationshipPathSpecification.md) that\r\n   * forms a path from the content instance to the related instance(s) whose properties should additionally be loaded.\r\n   */\r\n  propertiesSource: RelationshipPathSpecification;\r\n\r\n  /**\r\n   * Condition for filtering instances targeted by the [[propertiesSource]] attribute.\r\n   *\r\n   * **See:** [ECExpressions available in instance filter]($docs/presentation/Content/ECExpressions.md#instance-filter)\r\n   */\r\n  instanceFilter?: string;\r\n\r\n  /**\r\n   * The attribute tells whether the target class specified through [[propertiesSource]] should be handled\r\n   * polymorphically. This means properties of the concrete class are loaded in addition to properties of the\r\n   * target class itself.\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 the field containing related properties be assigned the [[NestedContentField.autoExpand]]\r\n   * attribute. The attribute tells UI components showing the properties that they should be initially displayed in the expanded state.\r\n   */\r\n  autoExpand?: boolean;\r\n\r\n  /**\r\n   * Specifies whether the specification should be ignored if another higher priority specification for the same relationship already exists.\r\n   */\r\n  skipIfDuplicate?: boolean;\r\n\r\n  /**\r\n   * The attribute describes what the related properties mean to the [primary instance]($docs/presentation/content/Terminology.md#primary-instance)\r\n   * whose properties are displayed.\r\n   * @see RelationshipMeaning\r\n   */\r\n  relationshipMeaning?: `${RelationshipMeaning}`;\r\n\r\n  /** The attribute allows loading additional related properties that are related to the target instance of this specification. */\r\n  nestedRelatedProperties?: RelatedPropertiesSpecification[];\r\n\r\n  /**\r\n   * List of names or definitions of related class properties that should be included in the content.\r\n   * @see RelatedPropertiesSpecialValues\r\n   */\r\n  properties?: Array<string | PropertySpecification> | `${RelatedPropertiesSpecialValues}`;\r\n\r\n  /**\r\n   * List of names or definitions of relationship class properties that should be included in the content.\r\n   * @see RelatedPropertiesSpecialValues\r\n   */\r\n  relationshipProperties?: Array<string | PropertySpecification> | `${RelatedPropertiesSpecialValues}`;\r\n\r\n  /**\r\n   * Specifies whether a relationship category should be created regardless of whether any relationship properties were included.\r\n   */\r\n  forceCreateRelationshipCategory?: boolean;\r\n}\r\n"]}

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

@@ -1,15 +1,11 @@
 /** @packageDocumentation
  * @module PresentationRules
  */
-import { NodeArtifactsRule } from "../hierarchy/NodeArtifactsRule";
-import { CheckBoxRule } from "./CheckBoxRule";
-import { ExtendedDataRule } from "./ExtendedDataRule";
-import { GroupingRule } from "./GroupingRule";
-import { ImageIdOverride } from "./ImageIdOverride";
-import { InstanceLabelOverride } from "./InstanceLabelOverride";
-import { LabelOverride } from "./LabelOverride";
-import { SortingRule } from "./SortingRule";
-import { StyleOverride } from "./StyleOverride";
+import { NodeArtifactsRule } from "../hierarchy/NodeArtifactsRule.js";
+import { ExtendedDataRule } from "./ExtendedDataRule.js";
+import { GroupingRule } from "./GroupingRule.js";
+import { InstanceLabelOverride } from "./InstanceLabelOverride.js";
+import { SortingRule } from "./SortingRule.js";
 /**
  * Customization rules allow customizing each node or content item separately.
  * Most of the rules have a `condition` property which uses [ECExpressions]($docs/presentation/customization/ECExpressions.md)
@@ -29,5 +25,5 @@ import { StyleOverride } from "./StyleOverride";
  *
  * @public
  */
-export declare type CustomizationRule = InstanceLabelOverride | CheckBoxRule | GroupingRule | ImageIdOverride | LabelOverride | SortingRule | StyleOverride | ExtendedDataRule | NodeArtifactsRule;
+export declare type CustomizationRule = InstanceLabelOverride | GroupingRule | SortingRule | ExtendedDataRule | NodeArtifactsRule;
 //# sourceMappingURL=CustomizationRule.d.ts.map

package/lib/cjs/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,GACjC,qBAAqB,GACrB,YAAY,GACZ,YAAY,GACZ,eAAe,GACf,aAAa,GACb,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,mCAAmC,CAAC;AACtE,OAAO,EAAE,gBAAgB,EAAE,MAAM,uBAAuB,CAAC;AACzD,OAAO,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAC;AACjD,OAAO,EAAE,qBAAqB,EAAE,MAAM,4BAA4B,CAAC;AACnE,OAAO,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAC;AAE/C;;;;;;;;;;;;;;;;;;GAkBG;AACH,MAAM,CAAC,OAAO,MAAM,iBAAiB,GAAG,qBAAqB,GAAG,YAAY,GAAG,WAAW,GAAG,gBAAgB,GAAG,iBAAiB,CAAC"}

package/lib/cjs/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;;;gGAGgG;AAChG;;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 @typescript-eslint/no-deprecated\r\n  | GroupingRule\r\n  | ImageIdOverride // eslint-disable-line @typescript-eslint/no-deprecated\r\n  | LabelOverride // eslint-disable-line @typescript-eslint/no-deprecated\r\n  | SortingRule\r\n  | StyleOverride // eslint-disable-line @typescript-eslint/no-deprecated\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;;;gGAGgG;AAChG;;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.js\";\r\nimport { ExtendedDataRule } from \"./ExtendedDataRule.js\";\r\nimport { GroupingRule } from \"./GroupingRule.js\";\r\nimport { InstanceLabelOverride } from \"./InstanceLabelOverride.js\";\r\nimport { SortingRule } from \"./SortingRule.js\";\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 = InstanceLabelOverride | GroupingRule | SortingRule | ExtendedDataRule | NodeArtifactsRule;\r\n"]}

package/lib/cjs/presentation-common/rules/customization/ExtendedDataRule.d.ts

@@ -1,7 +1,7 @@
 /** @packageDocumentation
  * @module PresentationRules
  */
-import { RuleBase } from "../Rule";
+import { RuleBase } from "../Rule.js";
 /**
  * Extended data rule is used to inject some arbitrary data into presentation data objects (nodes, content records).
  *

package/lib/cjs/presentation-common/rules/customization/ExtendedDataRule.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"ExtendedDataRule.d.ts","sourceRoot":"","sources":["../../../../../src/presentation-common/rules/customization/ExtendedDataRule.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,QAAQ,EAAE,MAAM,SAAS,CAAC;AAEnC;;;;;GAKG;AACH,MAAM,WAAW,gBAAiB,SAAQ,QAAQ;IAChD,oCAAoC;IACpC,QAAQ,EAAE,cAAc,CAAC;IAEzB;;;;OAIG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;;OAGG;IACH,KAAK,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,CAAC;CAClC"}
+{"version":3,"file":"ExtendedDataRule.d.ts","sourceRoot":"","sources":["../../../../../src/presentation-common/rules/customization/ExtendedDataRule.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AAEtC;;;;;GAKG;AACH,MAAM,WAAW,gBAAiB,SAAQ,QAAQ;IAChD,oCAAoC;IACpC,QAAQ,EAAE,cAAc,CAAC;IAEzB;;;;OAIG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;;OAGG;IACH,KAAK,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,CAAC;CAClC"}

package/lib/cjs/presentation-common/rules/customization/ExtendedDataRule.js.map

@@ -1 +1 @@
-{"version":3,"file":"ExtendedDataRule.js","sourceRoot":"","sources":["../../../../../src/presentation-common/rules/customization/ExtendedDataRule.ts"],"names":[],"mappings":";AAAA;;;gGAGgG;AAChG;;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 } from \"../Rule\";\r\n\r\n/**\r\n * Extended data rule is used to inject some arbitrary data into presentation data objects (nodes, content records).\r\n *\r\n * @see [Extended data rule reference documentation page]($docs/presentation/customization/ExtendedDataRule.md)\r\n * @public\r\n */\r\nexport interface ExtendedDataRule extends RuleBase {\r\n  /** Used for serializing to JSON. */\r\n  ruleType: \"ExtendedData\";\r\n\r\n  /**\r\n   * Defines a condition which needs to be met in order for the rule to be used. The condition\r\n   * is an [ECExpression]($docs/presentation/customization/ECExpressions.md#rule-condition) which has\r\n   * to evaluate to a boolean value.\r\n   */\r\n  condition?: string;\r\n\r\n  /**\r\n   * A map of [ECExpressions]($docs/presentation/customization/ECExpressions.md#rule-condition) whose\r\n   * evaluation results are used as extended data values.\r\n   */\r\n  items: { [key: string]: string };\r\n}\r\n"]}
+{"version":3,"file":"ExtendedDataRule.js","sourceRoot":"","sources":["../../../../../src/presentation-common/rules/customization/ExtendedDataRule.ts"],"names":[],"mappings":";AAAA;;;gGAGgG;AAChG;;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 } from \"../Rule.js\";\r\n\r\n/**\r\n * Extended data rule is used to inject some arbitrary data into presentation data objects (nodes, content records).\r\n *\r\n * @see [Extended data rule reference documentation page]($docs/presentation/customization/ExtendedDataRule.md)\r\n * @public\r\n */\r\nexport interface ExtendedDataRule extends RuleBase {\r\n  /** Used for serializing to JSON. */\r\n  ruleType: \"ExtendedData\";\r\n\r\n  /**\r\n   * Defines a condition which needs to be met in order for the rule to be used. The condition\r\n   * is an [ECExpression]($docs/presentation/customization/ECExpressions.md#rule-condition) which has\r\n   * to evaluate to a boolean value.\r\n   */\r\n  condition?: string;\r\n\r\n  /**\r\n   * A map of [ECExpressions]($docs/presentation/customization/ECExpressions.md#rule-condition) whose\r\n   * evaluation results are used as extended data values.\r\n   */\r\n  items: { [key: string]: string };\r\n}\r\n"]}

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

@@ -1,8 +1,8 @@
 /** @packageDocumentation
  * @module PresentationRules
  */
-import { SingleSchemaClassSpecification } from "../ClassSpecifications";
-import { RuleBase } from "../Rule";
+import { SingleSchemaClassSpecification } from "../ClassSpecifications.js";
+import { RuleBase } from "../Rule.js";
 /**
  * Grouping rules provide advanced ways to group instances when creating hierarchies.
  *
@@ -133,6 +133,7 @@ export interface PropertyGroup extends GroupingSpecificationBase {
      * it's up to the UI component to decide what to do with it.
      *
      * @minLength 1
+     * @deprecated in 5.x. Use [[ExtendedDataRule]] instead. See [extended data usage page]($docs/presentation/customization/ExtendedDataUsage.md) for more details.
      */
     imageId?: string;
     /** Specifies whether a grouping node should be created if there is only one item in that group. */
@@ -141,37 +142,9 @@ export interface PropertyGroup extends GroupingSpecificationBase {
      * Should a separate grouping node be created for nodes whose grouping value is not set or is set to an empty string.
      */
     createGroupForUnspecifiedValues?: boolean;
-    /**
-     * Specifies whether instances should be grouped using property's display or raw value.
-     *
-     * @see PropertyGroupingValue
-     * @deprecated in 3.x. Display value should always be used for grouping.
-     */
-    groupingValue?: `${PropertyGroupingValue}`;
-    /**
-     * Specifies whether nodes should be sorted by their display label or the grouping property's value. In most cases the result
-     * is the same, unless a [label override rule]($docs/presentation/customization/LabelOverride.md) is used to change node's display label.
-     *
-     * @see PropertyGroupingValue
-     * @deprecated in 3.x. Property grouping nodes should always be sorted by display label.
-     */
-    sortingValue?: `${PropertyGroupingValue}`;
     /** Ranges into which the grouping values are divided. Instances are grouped by value if no ranges are specified. */
     ranges?: PropertyRangeGroupSpecification[];
 }
-/**
- * Used in [[PropertyGroup]] to specify the type of value to use
- * for grouping and sorting
- *
- * @public
- * @deprecated in 3.x. The attributes using this enum are deprecated.
- */
-export declare enum PropertyGroupingValue {
-    /** By property value */
-    PropertyValue = "PropertyValue",
-    /** By display label */
-    DisplayLabel = "DisplayLabel"
-}
 /**
  * Describes a grouping range.
  *
@@ -183,6 +156,7 @@ export interface PropertyRangeGroupSpecification {
      * ID of an image to use for the grouping node. Defaults to [[PropertyGroup.imageId]] specified in [[PropertyGroup]].
      *
      * @minLength 1
+     * @deprecated in 5.x. Use [[ExtendedDataRule]] instead. See [extended data usage page]($docs/presentation/customization/ExtendedDataUsage.md) for more details.
      */
     imageId?: string;
     /**

package/lib/cjs/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,QAAQ,EAAE,MAAM,SAAS,CAAC;AAEnC;;;;;GAKG;AACH,MAAM,WAAW,YAAa,SAAQ,QAAQ;IAC5C,oCAAoC;IACpC,QAAQ,EAAE,UAAU,CAAC;IAErB;;;;OAIG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB,wEAAwE;IACxE,KAAK,EAAE,8BAA8B,CAAC;IAEtC;;;OAGG;IACH,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;;;OAGG;IACH,QAAQ,EAAE,GAAG,0BAA0B,EAAE,CAAC;CAC3C;AAED;;;;;;GAMG;AACH,MAAM,WAAW,UAAW,SAAQ,yBAAyB;IAC3D,oCAAoC;IACpC,QAAQ,EAAE,OAAO,CAAC;IAElB,mGAAmG;IACnG,wBAAwB,CAAC,EAAE,OAAO,CAAC;IAEnC;;;OAGG;IACH,SAAS,CAAC,EAAE,8BAA8B,CAAC;CAC5C;AAED;;;;;;;GAOG;AACH,MAAM,WAAW,sBAAuB,SAAQ,yBAAyB;IACvE,oCAAoC;IACpC,QAAQ,EAAE,mBAAmB,CAAC;IAE9B;;;;;;;;;;;OAWG;IACH,gBAAgB,CAAC,EAAE,GAAG,sCAAsC,EAAE,CAAC;CAChE;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,UAAU,CAAC;IAErB;;;;;OAKG;IACH,YAAY,EAAE,MAAM,CAAC;IAErB;;;;;OAKG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB,mGAAmG;IACnG,wBAAwB,CAAC,EAAE,OAAO,CAAC;IAEnC;;OAEG;IACH,+BAA+B,CAAC,EAAE,OAAO,CAAC;IAE1C;;;;;OAKG;IACH,aAAa,CAAC,EAAE,GAAG,qBAAqB,EAAE,CAAC;IAE3C;;;;;;OAMG;IACH,YAAY,CAAC,EAAE,GAAG,qBAAqB,EAAE,CAAC;IAE1C,oHAAoH;IACpH,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;;;;;GAKG;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,2BAA2B,CAAC;AAC3E,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AAEtC;;;;;GAKG;AACH,MAAM,WAAW,YAAa,SAAQ,QAAQ;IAC5C,oCAAoC;IACpC,QAAQ,EAAE,UAAU,CAAC;IAErB;;;;OAIG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB,wEAAwE;IACxE,KAAK,EAAE,8BAA8B,CAAC;IAEtC;;;OAGG;IACH,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;;;OAGG;IACH,QAAQ,EAAE,GAAG,0BAA0B,EAAE,CAAC;CAC3C;AAED;;;;;;GAMG;AACH,MAAM,WAAW,UAAW,SAAQ,yBAAyB;IAC3D,oCAAoC;IACpC,QAAQ,EAAE,OAAO,CAAC;IAElB,mGAAmG;IACnG,wBAAwB,CAAC,EAAE,OAAO,CAAC;IAEnC;;;OAGG;IACH,SAAS,CAAC,EAAE,8BAA8B,CAAC;CAC5C;AAED;;;;;;;GAOG;AACH,MAAM,WAAW,sBAAuB,SAAQ,yBAAyB;IACvE,oCAAoC;IACpC,QAAQ,EAAE,mBAAmB,CAAC;IAE9B;;;;;;;;;;;OAWG;IACH,gBAAgB,CAAC,EAAE,GAAG,sCAAsC,EAAE,CAAC;CAChE;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,UAAU,CAAC;IAErB;;;;;OAKG;IACH,YAAY,EAAE,MAAM,CAAC;IAErB;;;;;;OAMG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB,mGAAmG;IACnG,wBAAwB,CAAC,EAAE,OAAO,CAAC;IAEnC;;OAEG;IACH,+BAA+B,CAAC,EAAE,OAAO,CAAC;IAE1C,oHAAoH;IACpH,MAAM,CAAC,EAAE,+BAA+B,EAAE,CAAC;CAC5C;AAED;;;;;GAKG;AACH,MAAM,WAAW,+BAA+B;IAC9C;;;;;OAKG;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/cjs/presentation-common/rules/customization/GroupingRule.js

@@ -7,7 +7,7 @@
  * @module PresentationRules
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.PropertyGroupingValue = exports.SameLabelInstanceGroupApplicationStage = exports.GroupingSpecificationTypes = void 0;
+exports.SameLabelInstanceGroupApplicationStage = exports.GroupingSpecificationTypes = void 0;
 /**
  * Available types of [[GroupingSpecification]].
  * @public
@@ -35,18 +35,4 @@ var SameLabelInstanceGroupApplicationStage;
      */
     SameLabelInstanceGroupApplicationStage["PostProcess"] = "PostProcess";
 })(SameLabelInstanceGroupApplicationStage || (exports.SameLabelInstanceGroupApplicationStage = SameLabelInstanceGroupApplicationStage = {}));
-/**
- * Used in [[PropertyGroup]] to specify the type of value to use
- * for grouping and sorting
- *
- * @public
- * @deprecated in 3.x. The attributes using this enum are deprecated.
- */
-var PropertyGroupingValue;
-(function (PropertyGroupingValue) {
-    /** By property value */
-    PropertyGroupingValue["PropertyValue"] = "PropertyValue";
-    /** By display label */
-    PropertyGroupingValue["DisplayLabel"] = "DisplayLabel";
-})(PropertyGroupingValue || (exports.PropertyGroupingValue = PropertyGroupingValue = {}));
 //# sourceMappingURL=GroupingRule.js.map

package/lib/cjs/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;;;gGAGgG;AAChG;;GAEG;;;AAsCH;;;GAGG;AACH,IAAY,0BAIX;AAJD,WAAY,0BAA0B;IACpC,6CAAe,CAAA;IACf,mDAAqB,CAAA;IACrB,qEAAuC,CAAA;AACzC,CAAC,EAJW,0BAA0B,0CAA1B,0BAA0B,QAIrC;AAgED;;;GAGG;AACH,IAAY,sCAYX;AAZD,WAAY,sCAAsC;IAChD,qCAAqC;IACrC,yDAAe,CAAA;IAEf;;;;;;OAMG;IACH,qEAA2B,CAAA;AAC7B,CAAC,EAZW,sCAAsC,sDAAtC,sCAAsC,QAYjD;AAyDD;;;;;;GAMG;AACH,IAAY,qBAMX;AAND,WAAY,qBAAqB;IAC/B,wBAAwB;IACxB,wDAA+B,CAAA;IAE/B,uBAAuB;IACvB,sDAA6B,CAAA;AAC/B,CAAC,EANW,qBAAqB,qCAArB,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 { RuleBase } from \"../Rule\";\r\n\r\n/**\r\n * Grouping rules provide advanced ways to group instances when creating hierarchies.\r\n *\r\n * @see [Grouping rule reference documentation page]($docs/presentation/hierarchies/GroupingRule.md)\r\n * @public\r\n */\r\nexport interface GroupingRule extends RuleBase {\r\n  /** Used for serializing to JSON. */\r\n  ruleType: \"Grouping\";\r\n\r\n  /**\r\n   * An [ECExpression]($docs/presentation/hierarchies/ECExpressions.md#rule-condition) that results in\r\n   * a boolean value. If specified,  the grouping rule applies only to instance nodes that cause the condition\r\n   * to evaluate to `true`.\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  /**\r\n   * Specifies a list of [grouping specifications]($docs/presentation/hierarchies/GroupingRule.md#grouping-specifications)\r\n   * which describe the kind of grouping that should be applied.\r\n   */\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  /**\r\n   * Type of the subclass\r\n   * @see GroupingSpecificationTypes\r\n   */\r\n  specType: `${GroupingSpecificationTypes}`;\r\n}\r\n\r\n/**\r\n * Base class grouping allows grouping ECInstance nodes by their base class (as opposed to the hierarchy\r\n * specifications' `groupByClass` attribute, which always groups by direct class).\r\n *\r\n * @see [Base class grouping documentation section]($docs/presentation/hierarchies/GroupingRule.md#base-class-grouping)\r\n * @public\r\n */\r\nexport interface ClassGroup extends GroupingSpecificationBase {\r\n  /** Used for serializing to JSON. */\r\n  specType: \"Class\";\r\n\r\n  /** Specifies whether a grouping node should be created if there is only one item in that group. */\r\n  createGroupForSingleItem?: boolean;\r\n\r\n  /**\r\n   * Specification of the base ECClass to group by. If specified, allows grouping by a subclass of the class\r\n   * specified by rule's `class` attribute.\r\n   */\r\n  baseClass?: SingleSchemaClassSpecification;\r\n}\r\n\r\n/**\r\n * Allows grouping multiple instances with the same label into one ECInstances type of node. Similar to display label grouping,\r\n * but instead of showing a grouping node with multiple grouped ECInstance nodes, it shows a single ECInstances node which represents\r\n * multiple ECInstances.\r\n *\r\n * @see [Same label instance grouping documentation section]($docs/presentation/hierarchies/GroupingRule.md#same-label-instance-grouping)\r\n * @public\r\n */\r\nexport interface SameLabelInstanceGroup extends GroupingSpecificationBase {\r\n  /** Used for serializing to JSON. */\r\n  specType: \"SameLabelInstance\";\r\n\r\n  /**\r\n   * Grouping nodes by label is an expensive operation because it requires the whole hierarchy level to be created before even the first\r\n   * grouped node can be produced. To alleviate the performance impact when this specification is used, two `applicationStage` settings have been introduced:\r\n   *\r\n   * - `\"Query\"` groups instances during ECSql query, which can often make use of database indices and is generally fairly quick. It is chosen\r\n   *   as the default option, however, it fails to produce grouping nodes when certain ruleset specifications are involved.\r\n   *\r\n   * - `\"PostProcess\"` groups instances after the whole hierarchy level is built. It incurs a large performance penalty, but it will\r\n   *   produce the expected result in all cases.\r\n   *\r\n   * @see SameLabelInstanceGroupApplicationStage\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 * Property grouping allows grouping by a property of the instance by value or by given ranges of values.\r\n *\r\n * @see [Property grouping documentation section]($docs/presentation/hierarchies/GroupingRule.md#property-grouping)\r\n * @public\r\n */\r\nexport interface PropertyGroup extends GroupingSpecificationBase {\r\n  /** Used for serializing to JSON. */\r\n  specType: \"Property\";\r\n\r\n  /**\r\n   * Name of the ECProperty which is used for grouping. The property must exist on the ECClass specified by the\r\n   * rule's `class` attribute and it must be of either a primitive or a navigation type.\r\n   *\r\n   * @minLength 1\r\n   */\r\n  propertyName: string;\r\n\r\n  /**\r\n   * Specifies grouping node's image ID. If set, the ID is assigned to [[Node.imageId]] and\r\n   * it's up to the UI component to decide what to do with it.\r\n   *\r\n   * @minLength 1\r\n   */\r\n  imageId?: string;\r\n\r\n  /** Specifies whether a grouping node should 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 set or is set to an empty string.\r\n   */\r\n  createGroupForUnspecifiedValues?: boolean;\r\n\r\n  /**\r\n   * Specifies whether instances should be grouped using property's display or raw value.\r\n   *\r\n   * @see PropertyGroupingValue\r\n   * @deprecated in 3.x. Display value should always be used for grouping.\r\n   */\r\n  groupingValue?: `${PropertyGroupingValue}`; // eslint-disable-line @typescript-eslint/no-deprecated\r\n\r\n  /**\r\n   * Specifies whether nodes should be sorted by their display label or the grouping property's value. In most cases the result\r\n   * is the same, unless a [label override rule]($docs/presentation/customization/LabelOverride.md) is used to change node's display label.\r\n   *\r\n   * @see PropertyGroupingValue\r\n   * @deprecated in 3.x. Property grouping nodes should always be sorted by display label.\r\n   */\r\n  sortingValue?: `${PropertyGroupingValue}`; // eslint-disable-line @typescript-eslint/no-deprecated\r\n\r\n  /** Ranges into which the grouping values are divided. Instances are grouped by value if no ranges are specified. */\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 in 3.x. 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 *\r\n * @see [Property range group specification documentation section]($docs/presentation/hierarchies/GroupingRule.md#attribute-ranges)\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;;;gGAGgG;AAChG;;GAEG;;;AAsCH;;;GAGG;AACH,IAAY,0BAIX;AAJD,WAAY,0BAA0B;IACpC,6CAAe,CAAA;IACf,mDAAqB,CAAA;IACrB,qEAAuC,CAAA;AACzC,CAAC,EAJW,0BAA0B,0CAA1B,0BAA0B,QAIrC;AAgED;;;GAGG;AACH,IAAY,sCAYX;AAZD,WAAY,sCAAsC;IAChD,qCAAqC;IACrC,yDAAe,CAAA;IAEf;;;;;;OAMG;IACH,qEAA2B,CAAA;AAC7B,CAAC,EAZW,sCAAsC,sDAAtC,sCAAsC,QAYjD","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.js\";\r\nimport { RuleBase } from \"../Rule.js\";\r\n\r\n/**\r\n * Grouping rules provide advanced ways to group instances when creating hierarchies.\r\n *\r\n * @see [Grouping rule reference documentation page]($docs/presentation/hierarchies/GroupingRule.md)\r\n * @public\r\n */\r\nexport interface GroupingRule extends RuleBase {\r\n  /** Used for serializing to JSON. */\r\n  ruleType: \"Grouping\";\r\n\r\n  /**\r\n   * An [ECExpression]($docs/presentation/hierarchies/ECExpressions.md#rule-condition) that results in\r\n   * a boolean value. If specified,  the grouping rule applies only to instance nodes that cause the condition\r\n   * to evaluate to `true`.\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  /**\r\n   * Specifies a list of [grouping specifications]($docs/presentation/hierarchies/GroupingRule.md#grouping-specifications)\r\n   * which describe the kind of grouping that should be applied.\r\n   */\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  /**\r\n   * Type of the subclass\r\n   * @see GroupingSpecificationTypes\r\n   */\r\n  specType: `${GroupingSpecificationTypes}`;\r\n}\r\n\r\n/**\r\n * Base class grouping allows grouping ECInstance nodes by their base class (as opposed to the hierarchy\r\n * specifications' `groupByClass` attribute, which always groups by direct class).\r\n *\r\n * @see [Base class grouping documentation section]($docs/presentation/hierarchies/GroupingRule.md#base-class-grouping)\r\n * @public\r\n */\r\nexport interface ClassGroup extends GroupingSpecificationBase {\r\n  /** Used for serializing to JSON. */\r\n  specType: \"Class\";\r\n\r\n  /** Specifies whether a grouping node should be created if there is only one item in that group. */\r\n  createGroupForSingleItem?: boolean;\r\n\r\n  /**\r\n   * Specification of the base ECClass to group by. If specified, allows grouping by a subclass of the class\r\n   * specified by rule's `class` attribute.\r\n   */\r\n  baseClass?: SingleSchemaClassSpecification;\r\n}\r\n\r\n/**\r\n * Allows grouping multiple instances with the same label into one ECInstances type of node. Similar to display label grouping,\r\n * but instead of showing a grouping node with multiple grouped ECInstance nodes, it shows a single ECInstances node which represents\r\n * multiple ECInstances.\r\n *\r\n * @see [Same label instance grouping documentation section]($docs/presentation/hierarchies/GroupingRule.md#same-label-instance-grouping)\r\n * @public\r\n */\r\nexport interface SameLabelInstanceGroup extends GroupingSpecificationBase {\r\n  /** Used for serializing to JSON. */\r\n  specType: \"SameLabelInstance\";\r\n\r\n  /**\r\n   * Grouping nodes by label is an expensive operation because it requires the whole hierarchy level to be created before even the first\r\n   * grouped node can be produced. To alleviate the performance impact when this specification is used, two `applicationStage` settings have been introduced:\r\n   *\r\n   * - `\"Query\"` groups instances during ECSql query, which can often make use of database indices and is generally fairly quick. It is chosen\r\n   *   as the default option, however, it fails to produce grouping nodes when certain ruleset specifications are involved.\r\n   *\r\n   * - `\"PostProcess\"` groups instances after the whole hierarchy level is built. It incurs a large performance penalty, but it will\r\n   *   produce the expected result in all cases.\r\n   *\r\n   * @see SameLabelInstanceGroupApplicationStage\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 * Property grouping allows grouping by a property of the instance by value or by given ranges of values.\r\n *\r\n * @see [Property grouping documentation section]($docs/presentation/hierarchies/GroupingRule.md#property-grouping)\r\n * @public\r\n */\r\nexport interface PropertyGroup extends GroupingSpecificationBase {\r\n  /** Used for serializing to JSON. */\r\n  specType: \"Property\";\r\n\r\n  /**\r\n   * Name of the ECProperty which is used for grouping. The property must exist on the ECClass specified by the\r\n   * rule's `class` attribute and it must be of either a primitive or a navigation type.\r\n   *\r\n   * @minLength 1\r\n   */\r\n  propertyName: string;\r\n\r\n  /**\r\n   * Specifies grouping node's image ID. If set, the ID is assigned to [[Node.imageId]] and\r\n   * it's up to the UI component to decide what to do with it.\r\n   *\r\n   * @minLength 1\r\n   * @deprecated in 5.x. Use [[ExtendedDataRule]] instead. See [extended data usage page]($docs/presentation/customization/ExtendedDataUsage.md) for more details.\r\n   */\r\n  imageId?: string;\r\n\r\n  /** Specifies whether a grouping node should 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 set or is set to an empty string.\r\n   */\r\n  createGroupForUnspecifiedValues?: boolean;\r\n\r\n  /** Ranges into which the grouping values are divided. Instances are grouped by value if no ranges are specified. */\r\n  ranges?: PropertyRangeGroupSpecification[];\r\n}\r\n\r\n/**\r\n * Describes a grouping range.\r\n *\r\n * @see [Property range group specification documentation section]($docs/presentation/hierarchies/GroupingRule.md#attribute-ranges)\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   * @deprecated in 5.x. Use [[ExtendedDataRule]] instead. See [extended data usage page]($docs/presentation/customization/ExtendedDataUsage.md) for more details.\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/cjs/presentation-common/rules/customization/InstanceLabelOverride.d.ts

@@ -1,9 +1,9 @@
 /** @packageDocumentation
  * @module PresentationRules
  */
-import { SingleSchemaClassSpecification } from "../ClassSpecifications";
-import { RelationshipPathSpecification } from "../RelationshipPathSpecification";
-import { RuleBase } from "../Rule";
+import { SingleSchemaClassSpecification } from "../ClassSpecifications.js";
+import { RelationshipPathSpecification } from "../RelationshipPathSpecification.js";
+import { RuleBase } from "../Rule.js";
 /**
  * Instance label override rule provides a way to set instance label to one of its property values,
  * other attributes and/or combination of them.

package/lib/cjs/presentation-common/rules/customization/InstanceLabelOverride.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"InstanceLabelOverride.d.ts","sourceRoot":"","sources":["../../../../../src/presentation-common/rules/customization/InstanceLabelOverride.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,8BAA8B,EAAE,MAAM,wBAAwB,CAAC;AACxE,OAAO,EAAE,6BAA6B,EAAE,MAAM,kCAAkC,CAAC;AACjF,OAAO,EAAE,QAAQ,EAAE,MAAM,SAAS,CAAC;AAEnC;;;;;;GAMG;AACH,MAAM,WAAW,qBAAsB,SAAQ,QAAQ;IACrD,oCAAoC;IACpC,QAAQ,EAAE,uBAAuB,CAAC;IAElC;;OAEG;IACH,KAAK,EAAE,8BAA8B,CAAC;IAEtC;;OAEG;IACH,MAAM,EAAE,uCAAuC,EAAE,CAAC;CACnD;AAED;;;GAGG;AACH,oBAAY,2CAA2C;IACrD,SAAS,cAAc;IACvB,QAAQ,aAAa;IACrB,SAAS,cAAc;IACvB,UAAU,eAAe;IACzB,WAAW,gBAAgB;IAC3B,OAAO,YAAY;IACnB,MAAM,WAAW;IACjB,oBAAoB,yBAAyB;CAC9C;AAED;;;GAGG;AACH,MAAM,WAAW,2CAA2C;IAC1D;;;OAGG;IACH,QAAQ,EAAE,GAAG,2CAA2C,EAAE,CAAC;CAC5D;AAED;;;;;GAKG;AACH,MAAM,WAAW,gDAAiD,SAAQ,2CAA2C;IACnH,QAAQ,EAAE,WAAW,CAAC;IAEtB;;;;;OAKG;IACH,KAAK,EAAE,KAAK,CAAC;QAAE,IAAI,EAAE,uCAAuC,CAAC;QAAC,UAAU,CAAC,EAAE,OAAO,CAAA;KAAE,CAAC,CAAC;IAEtF,8EAA8E;IAC9E,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED;;;;;GAKG;AACH,MAAM,WAAW,+CAAgD,SAAQ,2CAA2C;IAClH,QAAQ,EAAE,UAAU,CAAC;IAErB;;;OAGG;IACH,YAAY,EAAE,MAAM,CAAC;IAErB;;;OAGG;IACH,cAAc,CAAC,EAAE,6BAA6B,CAAC;CAChD;AAED;;;;;GAKG;AACH,MAAM,WAAW,2CAA4C,SAAQ,2CAA2C;IAC9G,QAAQ,EAAE,WAAW,CAAC;IAEtB,kEAAkE;IAClE,IAAI,CAAC,EAAE,OAAO,CAAC;CAChB;AAED;;;;;GAKG;AACH,MAAM,WAAW,4CAA6C,SAAQ,2CAA2C;IAC/G,QAAQ,EAAE,YAAY,CAAC;CACxB;AAED;;;;;GAKG;AACH,MAAM,WAAW,6CAA8C,SAAQ,2CAA2C;IAChH,QAAQ,EAAE,aAAa,CAAC;CACzB;AAED;;;;;GAKG;AACH,MAAM,WAAW,yCAA0C,SAAQ,2CAA2C;IAC5G,QAAQ,EAAE,SAAS,CAAC;CACrB;AAED;;;;;GAKG;AACH,MAAM,WAAW,6CAA8C,SAAQ,2CAA2C;IAChH,QAAQ,EAAE,QAAQ,CAAC;IAEnB,6CAA6C;IAC7C,KAAK,EAAE,MAAM,CAAC;CACf;AAED;;;;;GAKG;AACH,MAAM,WAAW,sDAAuD,SAAQ,2CAA2C;IACzH,QAAQ,EAAE,sBAAsB,CAAC;IAEjC;;;OAGG;IACH,qBAAqB,EAAE,6BAA6B,CAAC;CACtD;AAED;;;GAGG;AACH,MAAM,MAAM,uCAAuC,GAC/C,gDAAgD,GAChD,+CAA+C,GAC/C,6CAA6C,GAC7C,2CAA2C,GAC3C,4CAA4C,GAC5C,6CAA6C,GAC7C,yCAAyC,GACzC,sDAAsD,CAAC"}
+{"version":3,"file":"InstanceLabelOverride.d.ts","sourceRoot":"","sources":["../../../../../src/presentation-common/rules/customization/InstanceLabelOverride.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,8BAA8B,EAAE,MAAM,2BAA2B,CAAC;AAC3E,OAAO,EAAE,6BAA6B,EAAE,MAAM,qCAAqC,CAAC;AACpF,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AAEtC;;;;;;GAMG;AACH,MAAM,WAAW,qBAAsB,SAAQ,QAAQ;IACrD,oCAAoC;IACpC,QAAQ,EAAE,uBAAuB,CAAC;IAElC;;OAEG;IACH,KAAK,EAAE,8BAA8B,CAAC;IAEtC;;OAEG;IACH,MAAM,EAAE,uCAAuC,EAAE,CAAC;CACnD;AAED;;;GAGG;AACH,oBAAY,2CAA2C;IACrD,SAAS,cAAc;IACvB,QAAQ,aAAa;IACrB,SAAS,cAAc;IACvB,UAAU,eAAe;IACzB,WAAW,gBAAgB;IAC3B,OAAO,YAAY;IACnB,MAAM,WAAW;IACjB,oBAAoB,yBAAyB;CAC9C;AAED;;;GAGG;AACH,MAAM,WAAW,2CAA2C;IAC1D;;;OAGG;IACH,QAAQ,EAAE,GAAG,2CAA2C,EAAE,CAAC;CAC5D;AAED;;;;;GAKG;AACH,MAAM,WAAW,gDAAiD,SAAQ,2CAA2C;IACnH,QAAQ,EAAE,WAAW,CAAC;IAEtB;;;;;OAKG;IACH,KAAK,EAAE,KAAK,CAAC;QAAE,IAAI,EAAE,uCAAuC,CAAC;QAAC,UAAU,CAAC,EAAE,OAAO,CAAA;KAAE,CAAC,CAAC;IAEtF,8EAA8E;IAC9E,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED;;;;;GAKG;AACH,MAAM,WAAW,+CAAgD,SAAQ,2CAA2C;IAClH,QAAQ,EAAE,UAAU,CAAC;IAErB;;;OAGG;IACH,YAAY,EAAE,MAAM,CAAC;IAErB;;;OAGG;IACH,cAAc,CAAC,EAAE,6BAA6B,CAAC;CAChD;AAED;;;;;GAKG;AACH,MAAM,WAAW,2CAA4C,SAAQ,2CAA2C;IAC9G,QAAQ,EAAE,WAAW,CAAC;IAEtB,kEAAkE;IAClE,IAAI,CAAC,EAAE,OAAO,CAAC;CAChB;AAED;;;;;GAKG;AACH,MAAM,WAAW,4CAA6C,SAAQ,2CAA2C;IAC/G,QAAQ,EAAE,YAAY,CAAC;CACxB;AAED;;;;;GAKG;AACH,MAAM,WAAW,6CAA8C,SAAQ,2CAA2C;IAChH,QAAQ,EAAE,aAAa,CAAC;CACzB;AAED;;;;;GAKG;AACH,MAAM,WAAW,yCAA0C,SAAQ,2CAA2C;IAC5G,QAAQ,EAAE,SAAS,CAAC;CACrB;AAED;;;;;GAKG;AACH,MAAM,WAAW,6CAA8C,SAAQ,2CAA2C;IAChH,QAAQ,EAAE,QAAQ,CAAC;IAEnB,6CAA6C;IAC7C,KAAK,EAAE,MAAM,CAAC;CACf;AAED;;;;;GAKG;AACH,MAAM,WAAW,sDAAuD,SAAQ,2CAA2C;IACzH,QAAQ,EAAE,sBAAsB,CAAC;IAEjC;;;OAGG;IACH,qBAAqB,EAAE,6BAA6B,CAAC;CACtD;AAED;;;GAGG;AACH,MAAM,MAAM,uCAAuC,GAC/C,gDAAgD,GAChD,+CAA+C,GAC/C,6CAA6C,GAC7C,2CAA2C,GAC3C,4CAA4C,GAC5C,6CAA6C,GAC7C,yCAAyC,GACzC,sDAAsD,CAAC"}

package/lib/cjs/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;;;gGAGgG;AAChG;;GAEG;;;AA4BH;;;GAGG;AACH,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,2DAA3C,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 } 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: \"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  /**\r\n   * Type of the specification\r\n   * @see InstanceLabelOverrideValueSpecificationType\r\n   */\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: \"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: \"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   */\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: \"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: \"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: \"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: \"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: \"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: \"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\r\n  | InstanceLabelOverridePropertyValueSpecification\r\n  | InstanceLabelOverrideStringValueSpecification\r\n  | InstanceLabelOverrideClassNameSpecification\r\n  | InstanceLabelOverrideClassLabelSpecification\r\n  | InstanceLabelOverrideBriefcaseIdSpecification\r\n  | InstanceLabelOverrideLocalIdSpecification\r\n  | InstanceLabelOverrideRelatedInstanceLabelSpecification;\r\n"]}
+{"version":3,"file":"InstanceLabelOverride.js","sourceRoot":"","sources":["../../../../../src/presentation-common/rules/customization/InstanceLabelOverride.ts"],"names":[],"mappings":";AAAA;;;gGAGgG;AAChG;;GAEG;;;AA4BH;;;GAGG;AACH,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,2DAA3C,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.js\";\r\nimport { RelationshipPathSpecification } from \"../RelationshipPathSpecification.js\";\r\nimport { RuleBase } from \"../Rule.js\";\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: \"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  /**\r\n   * Type of the specification\r\n   * @see InstanceLabelOverrideValueSpecificationType\r\n   */\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: \"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: \"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   */\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: \"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: \"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: \"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: \"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: \"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: \"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\r\n  | InstanceLabelOverridePropertyValueSpecification\r\n  | InstanceLabelOverrideStringValueSpecification\r\n  | InstanceLabelOverrideClassNameSpecification\r\n  | InstanceLabelOverrideClassLabelSpecification\r\n  | InstanceLabelOverrideBriefcaseIdSpecification\r\n  | InstanceLabelOverrideLocalIdSpecification\r\n  | InstanceLabelOverrideRelatedInstanceLabelSpecification;\r\n"]}

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

@@ -1,8 +1,8 @@
 /** @packageDocumentation
  * @module PresentationRules
  */
-import { SingleSchemaClassSpecification } from "../ClassSpecifications";
-import { RuleBase } from "../Rule";
+import { SingleSchemaClassSpecification } from "../ClassSpecifications.js";
+import { RuleBase } from "../Rule.js";
 /**
  * Sorting rules provide a way to either disable sorting or sort instances by specific properties.
  *

package/lib/cjs/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,QAAQ,EAAE,MAAM,SAAS,CAAC;AAEnC;;;;;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,MAAM,MAAM,WAAW,GAAG,mBAAmB,GAAG,mBAAmB,CAAC;AAEpE;;;;;GAKG;AACH,MAAM,WAAW,mBAAoB,SAAQ,eAAe;IAC1D,oCAAoC;IACpC,QAAQ,EAAE,iBAAiB,CAAC;IAE5B;;;;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,iBAAiB,CAAC;CAC7B"}
+{"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,2BAA2B,CAAC;AAC3E,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AAEtC;;;;;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,MAAM,MAAM,WAAW,GAAG,mBAAmB,GAAG,mBAAmB,CAAC;AAEpE;;;;;GAKG;AACH,MAAM,WAAW,mBAAoB,SAAQ,eAAe;IAC1D,oCAAoC;IACpC,QAAQ,EAAE,iBAAiB,CAAC;IAE5B;;;;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,iBAAiB,CAAC;CAC7B"}

package/lib/cjs/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;;;gGAGgG;AAChG;;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 } 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: \"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: \"DisabledSorting\";\r\n}\r\n"]}
+{"version":3,"file":"SortingRule.js","sourceRoot":"","sources":["../../../../../src/presentation-common/rules/customization/SortingRule.ts"],"names":[],"mappings":";AAAA;;;gGAGgG;AAChG;;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.js\";\r\nimport { RuleBase } from \"../Rule.js\";\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: \"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: \"DisabledSorting\";\r\n}\r\n"]}

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

@@ -1,7 +1,7 @@
 /** @packageDocumentation
  * @module PresentationRules
  */
-import { NavigationRuleBase } from "./NavigationRule";
+import { NavigationRuleBase } from "./NavigationRule.js";
 /**
  * Child node rules are used to define child nodes in a hierarchy.
  *

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

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

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

@@ -1 +1 @@
-{"version":3,"file":"ChildNodeRule.js","sourceRoot":"","sources":["../../../../../src/presentation-common/rules/hierarchy/ChildNodeRule.ts"],"names":[],"mappings":";AAAA;;;gGAGgG;AAChG;;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 { 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: \"ChildNodes\";\r\n}\r\n"]}
+{"version":3,"file":"ChildNodeRule.js","sourceRoot":"","sources":["../../../../../src/presentation-common/rules/hierarchy/ChildNodeRule.ts"],"names":[],"mappings":";AAAA;;;gGAGgG;AAChG;;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 { NavigationRuleBase } from \"./NavigationRule.js\";\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: \"ChildNodes\";\r\n}\r\n"]}

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

@@ -1,12 +1,12 @@
 /** @packageDocumentation
  * @module PresentationRules
  */
-import { RelatedInstanceSpecification } from "../RelatedInstanceSpecification";
-import { ChildNodeRule } from "./ChildNodeRule";
-import { CustomNodeSpecification } from "./CustomNodeSpecification";
-import { CustomQueryInstanceNodesSpecification } from "./CustomQueryInstanceNodesSpecification";
-import { InstanceNodesOfSpecificClassesSpecification } from "./InstanceNodesOfSpecificClassesSpecification";
-import { RelatedInstanceNodesSpecification } from "./RelatedInstanceNodesSpecification";
+import { RelatedInstanceSpecification } from "../RelatedInstanceSpecification.js";
+import { ChildNodeRule } from "./ChildNodeRule.js";
+import { CustomNodeSpecification } from "./CustomNodeSpecification.js";
+import { CustomQueryInstanceNodesSpecification } from "./CustomQueryInstanceNodesSpecification.js";
+import { InstanceNodesOfSpecificClassesSpecification } from "./InstanceNodesOfSpecificClassesSpecification.js";
+import { RelatedInstanceNodesSpecification } from "./RelatedInstanceNodesSpecification.js";
 /**
  * Used for serializing array of [[ChildNodeSpecification]]
  * @public

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

@@ -1 +1 @@
-{"version":3,"file":"ChildNodeSpecification.d.ts","sourceRoot":"","sources":["../../../../../src/presentation-common/rules/hierarchy/ChildNodeSpecification.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,4BAA4B,EAAE,MAAM,iCAAiC,CAAC;AAC/E,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAChD,OAAO,EAAE,uBAAuB,EAAE,MAAM,2BAA2B,CAAC;AACpE,OAAO,EAAE,qCAAqC,EAAE,MAAM,yCAAyC,CAAC;AAChG,OAAO,EAAE,2CAA2C,EAAE,MAAM,+CAA+C,CAAC;AAC5G,OAAO,EAAE,iCAAiC,EAAE,MAAM,qCAAqC,CAAC;AAExF;;;GAGG;AACH,oBAAY,2BAA2B;IACrC,oBAAoB,yBAAyB;IAC7C,8BAA8B,mCAAmC;IACjE,wBAAwB,6BAA6B;IACrD,UAAU,eAAe;CAC1B;AAED;;;;;GAKG;AACH,MAAM,WAAW,0BAA0B;IACzC;;;OAGG;IACH,QAAQ,EAAE,GAAG,2BAA2B,EAAE,CAAC;IAE3C;;;;;;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;;;OAGG;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,MAAM,MAAM,sBAAsB,GAC9B,uBAAuB,GACvB,2CAA2C,GAC3C,iCAAiC,GACjC,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,oCAAoC,CAAC;AAClF,OAAO,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAC;AACnD,OAAO,EAAE,uBAAuB,EAAE,MAAM,8BAA8B,CAAC;AACvE,OAAO,EAAE,qCAAqC,EAAE,MAAM,4CAA4C,CAAC;AACnG,OAAO,EAAE,2CAA2C,EAAE,MAAM,kDAAkD,CAAC;AAC/G,OAAO,EAAE,iCAAiC,EAAE,MAAM,wCAAwC,CAAC;AAE3F;;;GAGG;AACH,oBAAY,2BAA2B;IACrC,oBAAoB,yBAAyB;IAC7C,8BAA8B,mCAAmC;IACjE,wBAAwB,6BAA6B;IACrD,UAAU,eAAe;CAC1B;AAED;;;;;GAKG;AACH,MAAM,WAAW,0BAA0B;IACzC;;;OAGG;IACH,QAAQ,EAAE,GAAG,2BAA2B,EAAE,CAAC;IAE3C;;;;;;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;;;OAGG;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,MAAM,MAAM,sBAAsB,GAC9B,uBAAuB,GACvB,2CAA2C,GAC3C,iCAAiC,GACjC,qCAAqC,CAAC"}

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

@@ -1 +1 @@
-{"version":3,"file":"ChildNodeSpecification.js","sourceRoot":"","sources":["../../../../../src/presentation-common/rules/hierarchy/ChildNodeSpecification.ts"],"names":[],"mappings":";AAAA;;;gGAGgG;AAChG;;GAEG;;;AASH;;;GAGG;AACH,IAAY,2BAKX;AALD,WAAY,2BAA2B;IACrC,4EAA6C,CAAA;IAC7C,gGAAiE,CAAA;IACjE,oFAAqD,CAAA;IACrD,wDAAyB,CAAA;AAC3B,CAAC,EALW,2BAA2B,2CAA3B,2BAA2B,QAKtC","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  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  /**\r\n   * Used for serializing to JSON.\r\n   * @see ChildNodeSpecificationTypes\r\n   */\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  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\r\n  | InstanceNodesOfSpecificClassesSpecification\r\n  | RelatedInstanceNodesSpecification\r\n  | CustomQueryInstanceNodesSpecification;\r\n"]}
+{"version":3,"file":"ChildNodeSpecification.js","sourceRoot":"","sources":["../../../../../src/presentation-common/rules/hierarchy/ChildNodeSpecification.ts"],"names":[],"mappings":";AAAA;;;gGAGgG;AAChG;;GAEG;;;AASH;;;GAGG;AACH,IAAY,2BAKX;AALD,WAAY,2BAA2B;IACrC,4EAA6C,CAAA;IAC7C,gGAAiE,CAAA;IACjE,oFAAqD,CAAA;IACrD,wDAAyB,CAAA;AAC3B,CAAC,EALW,2BAA2B,2CAA3B,2BAA2B,QAKtC","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.js\";\r\nimport { ChildNodeRule } from \"./ChildNodeRule.js\";\r\nimport { CustomNodeSpecification } from \"./CustomNodeSpecification.js\";\r\nimport { CustomQueryInstanceNodesSpecification } from \"./CustomQueryInstanceNodesSpecification.js\";\r\nimport { InstanceNodesOfSpecificClassesSpecification } from \"./InstanceNodesOfSpecificClassesSpecification.js\";\r\nimport { RelatedInstanceNodesSpecification } from \"./RelatedInstanceNodesSpecification.js\";\r\n\r\n/**\r\n * Used for serializing array of [[ChildNodeSpecification]]\r\n * @public\r\n */\r\nexport enum ChildNodeSpecificationTypes {\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  /**\r\n   * Used for serializing to JSON.\r\n   * @see ChildNodeSpecificationTypes\r\n   */\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  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\r\n  | InstanceNodesOfSpecificClassesSpecification\r\n  | RelatedInstanceNodesSpecification\r\n  | CustomQueryInstanceNodesSpecification;\r\n"]}

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

@@ -1,7 +1,7 @@
 /** @packageDocumentation
  * @module PresentationRules
  */
-import { ChildNodeSpecificationBase } from "./ChildNodeSpecification";
+import { ChildNodeSpecificationBase } from "./ChildNodeSpecification.js";
 /**
  * Returns a static custom-defined node that's not based on an ECInstance.
  *
@@ -26,6 +26,8 @@ export interface CustomNodeSpecification extends ChildNodeSpecificationBase {
     /**
      * 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.
+     *
+     * @deprecated in 5.x. Use [[ExtendedDataRule]] instead. See [extended data usage page]($docs/presentation/customization/ExtendedDataUsage.md) for more details.
      */
     imageId?: string;
 }

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

@@ -1 +1 @@
-{"version":3,"file":"CustomNodeSpecification.d.ts","sourceRoot":"","sources":["../../../../../src/presentation-common/rules/hierarchy/CustomNodeSpecification.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,0BAA0B,EAAE,MAAM,0BAA0B,CAAC;AAEtE;;;;;GAKG;AACH,MAAM,WAAW,uBAAwB,SAAQ,0BAA0B;IACzE,oCAAoC;IACpC,QAAQ,EAAE,YAAY,CAAC;IAEvB,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"}
+{"version":3,"file":"CustomNodeSpecification.d.ts","sourceRoot":"","sources":["../../../../../src/presentation-common/rules/hierarchy/CustomNodeSpecification.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,0BAA0B,EAAE,MAAM,6BAA6B,CAAC;AAEzE;;;;;GAKG;AACH,MAAM,WAAW,uBAAwB,SAAQ,0BAA0B;IACzE,oCAAoC;IACpC,QAAQ,EAAE,YAAY,CAAC;IAEvB,4DAA4D;IAC5D,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;;;OAIG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;;;;OAKG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB"}

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

@@ -1 +1 @@
-{"version":3,"file":"CustomNodeSpecification.js","sourceRoot":"","sources":["../../../../../src/presentation-common/rules/hierarchy/CustomNodeSpecification.ts"],"names":[],"mappings":";AAAA;;;gGAGgG;AAChG;;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 } 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: \"CustomNode\";\r\n\r\n  /** Specifies node type, which is assigned to node's key. */\r\n  type: string;\r\n\r\n  /**\r\n   * Specifies node label. This is a string value that may be [localized]($docs/presentation/advanced/Localization.md).\r\n   */\r\n  label: string;\r\n\r\n  /**\r\n   * Specifies the value of [[Node.description]] property, which is a string that may\r\n   * be [localized]($docs/presentation/advanced/Localization.md). UI component displaying the node may choose\r\n   * whether and how to surface this information to users.\r\n   */\r\n  description?: string;\r\n\r\n  /**\r\n   * Specifies node's image ID. If set, the ID is assigned to [[Node.imageId]] and it's\r\n   * up to the UI component to decide what to do with it.\r\n   */\r\n  imageId?: string;\r\n}\r\n"]}
+{"version":3,"file":"CustomNodeSpecification.js","sourceRoot":"","sources":["../../../../../src/presentation-common/rules/hierarchy/CustomNodeSpecification.ts"],"names":[],"mappings":";AAAA;;;gGAGgG;AAChG;;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 } from \"./ChildNodeSpecification.js\";\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: \"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   * @deprecated in 5.x. Use [[ExtendedDataRule]] instead. See [extended data usage page]($docs/presentation/customization/ExtendedDataUsage.md) for more details.\r\n   */\r\n  imageId?: string;\r\n}\r\n"]}

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

@@ -1,8 +1,8 @@
 /** @packageDocumentation
  * @module PresentationRules
  */
-import { SingleSchemaClassSpecification } from "../ClassSpecifications";
-import { ChildNodeSpecificationBase, DefaultGroupingPropertiesContainer } from "./ChildNodeSpecification";
+import { SingleSchemaClassSpecification } from "../ClassSpecifications.js";
+import { ChildNodeSpecificationBase, DefaultGroupingPropertiesContainer } from "./ChildNodeSpecification.js";
 /**
  * Returns nodes for instances returned by a provided ECSQL query.
  *

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

@@ -1 +1 @@
-{"version":3,"file":"CustomQueryInstanceNodesSpecification.d.ts","sourceRoot":"","sources":["../../../../../src/presentation-common/rules/hierarchy/CustomQueryInstanceNodesSpecification.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,8BAA8B,EAAE,MAAM,wBAAwB,CAAC;AACxE,OAAO,EAAE,0BAA0B,EAAE,kCAAkC,EAAE,MAAM,0BAA0B,CAAC;AAE1G;;;;;GAKG;AACH,MAAM,WAAW,qCAAsC,SAAQ,0BAA0B,EAAE,kCAAkC;IAC3H,oCAAoC;IACpC,QAAQ,EAAE,0BAA0B,CAAC;IAErC;;;OAGG;IACH,OAAO,CAAC,EAAE,kBAAkB,EAAE,CAAC;CAChC;AAED;;;;;GAKG;AACH,MAAM,CAAC,OAAO,MAAM,kBAAkB,GAAG,wBAAwB,GAAG,iCAAiC,CAAC;AAEtG;;;GAGG;AACH,oBAAY,uBAAuB;IACjC,MAAM,WAAW;IACjB,eAAe,oBAAoB;CACpC;AAED;;;GAGG;AACH,MAAM,WAAW,sBAAsB;IACrC;;;OAGG;IACH,QAAQ,EAAE,GAAG,uBAAuB,EAAE,CAAC;IAEvC;;;;OAIG;IACH,KAAK,EAAE,8BAA8B,CAAC;CACvC;AAED;;;;;GAKG;AACH,MAAM,WAAW,wBAAyB,SAAQ,sBAAsB;IACtE,oCAAoC;IACpC,QAAQ,EAAE,QAAQ,CAAC;IAEnB,wCAAwC;IACxC,KAAK,EAAE,MAAM,CAAC;CACf;AAED;;;;;;GAMG;AACH,MAAM,WAAW,iCAAkC,SAAQ,sBAAsB;IAC/E,oCAAoC;IACpC,QAAQ,EAAE,iBAAiB,CAAC;IAE5B;;OAEG;IACH,kBAAkB,EAAE,MAAM,CAAC;CAC5B"}
+{"version":3,"file":"CustomQueryInstanceNodesSpecification.d.ts","sourceRoot":"","sources":["../../../../../src/presentation-common/rules/hierarchy/CustomQueryInstanceNodesSpecification.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,8BAA8B,EAAE,MAAM,2BAA2B,CAAC;AAC3E,OAAO,EAAE,0BAA0B,EAAE,kCAAkC,EAAE,MAAM,6BAA6B,CAAC;AAE7G;;;;;GAKG;AACH,MAAM,WAAW,qCAAsC,SAAQ,0BAA0B,EAAE,kCAAkC;IAC3H,oCAAoC;IACpC,QAAQ,EAAE,0BAA0B,CAAC;IAErC;;;OAGG;IACH,OAAO,CAAC,EAAE,kBAAkB,EAAE,CAAC;CAChC;AAED;;;;;GAKG;AACH,MAAM,CAAC,OAAO,MAAM,kBAAkB,GAAG,wBAAwB,GAAG,iCAAiC,CAAC;AAEtG;;;GAGG;AACH,oBAAY,uBAAuB;IACjC,MAAM,WAAW;IACjB,eAAe,oBAAoB;CACpC;AAED;;;GAGG;AACH,MAAM,WAAW,sBAAsB;IACrC;;;OAGG;IACH,QAAQ,EAAE,GAAG,uBAAuB,EAAE,CAAC;IAEvC;;;;OAIG;IACH,KAAK,EAAE,8BAA8B,CAAC;CACvC;AAED;;;;;GAKG;AACH,MAAM,WAAW,wBAAyB,SAAQ,sBAAsB;IACtE,oCAAoC;IACpC,QAAQ,EAAE,QAAQ,CAAC;IAEnB,wCAAwC;IACxC,KAAK,EAAE,MAAM,CAAC;CACf;AAED;;;;;;GAMG;AACH,MAAM,WAAW,iCAAkC,SAAQ,sBAAsB;IAC/E,oCAAoC;IACpC,QAAQ,EAAE,iBAAiB,CAAC;IAE5B;;OAEG;IACH,kBAAkB,EAAE,MAAM,CAAC;CAC5B"}

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

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