@itwin/presentation-common 3.2.0-dev.8 → 3.3.0-dev.1

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

@@ -4,43 +4,50 @@
 import { SingleSchemaClassSpecification } from "./ClassSpecifications";
 import { RelationshipDirection } from "./RelationshipDirection";
 /**
- * Specification of a single relationship path step.
+ * Specification of a single step in [[RelationshipPathSpecification]].
+ *
+ * @see [Relationship path specification reference documentation page]($docs/presentation/RelationshipPathSpecification.md)
  * @public
  */
 export interface RelationshipStepSpecification {
-    /** Specification of the relationship to use for joining the related instance. */
+    /** This attribute specifies the ECRelationship that should be used to traverse to target class. */
     relationship: SingleSchemaClassSpecification;
-    /** Relationship direction that should be followed to find the target class. */
+    /** This attribute specifies the direction in which the [[relationship]] should be followed. */
     direction: RelationshipDirection.Forward | RelationshipDirection.Backward;
     /**
-     * Specification of the target class. Either relationship's source or target class is used (based
-     * on specified direction) if more specific target class is not specified by this attribute.
+     * This attribute may be used to specialize the target of the relationship.
      */
     targetClass?: SingleSchemaClassSpecification;
 }
 /**
- * Specification of a single relationship path step.
+ * Specification of a single step in [[RepeatableRelationshipPathSpecification]].
+ *
+ * @see [Repeatable relationship path specification reference documentation page]($docs/presentation/RepeatableRelationshipPathSpecification.md)
  * @public
  */
 export interface RepeatableRelationshipStepSpecification extends RelationshipStepSpecification {
     /**
-     * Number of relationship steps that should be taken. Special `*` value means that
-     * relationship is traversed recursively and all matching instances are accumulated.
-     * Defaults to `1`.
+     * When a number is specified, the relationship is traversed recursively the specified number of times.
+     *
+     * When it is set to a special value `"*"`, the same relationship is traversed recursively unbounded number
+     * of times, starting from zero (the relationship is not followed). On each traversal iteration, Presentation
+     * rules engine accumulates all indirectly related ECInstances as defined by the remaining relationship path.
      */
     count?: number | "*";
 }
 /**
- * Specification of a relationship path.
+ * Relationship path specification is used to define a relationship path to an ECClass.
  *
- * @see [More details]($docs/presentation/RelationshipPathSpecification.md)
+ * @see [Relationship path specification reference documentation page]($docs/presentation/RelationshipPathSpecification.md)
  * @public
  */
 export declare type RelationshipPathSpecification = RelationshipStepSpecification | RelationshipStepSpecification[];
 /**
- * Specification of a repeatable relationship path.
+ * This specification declares a step in a relationship path between a source and target ECInstances. A step
+ * can optionally be repeated a number of times to traverse the same relationship recursively. Multiple
+ * specifications of this type can be chained together to express complex indirect relationships.
  *
- * @see [More details]($docs/presentation/RepeatableRelationshipPathSpecification.md)
+ * @see [Repeatable relationship path specification reference documentation page]($docs/presentation/RepeatableRelationshipPathSpecification.md)
  * @public
  */
 export declare type RepeatableRelationshipPathSpecification = RepeatableRelationshipStepSpecification | RepeatableRelationshipStepSpecification[];

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

@@ -1 +1 @@
-{"version":3,"file":"RelationshipPathSpecification.d.ts","sourceRoot":"","sources":["../../../../src/presentation-common/rules/RelationshipPathSpecification.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,8BAA8B,EAAE,MAAM,uBAAuB,CAAC;AACvE,OAAO,EAAE,qBAAqB,EAAE,MAAM,yBAAyB,CAAC;AAEhE;;;GAGG;AACH,MAAM,WAAW,6BAA6B;IAC5C,iFAAiF;IACjF,YAAY,EAAE,8BAA8B,CAAC;IAE7C,+EAA+E;IAC/E,SAAS,EAAE,qBAAqB,CAAC,OAAO,GAAG,qBAAqB,CAAC,QAAQ,CAAC;IAE1E;;;OAGG;IACH,WAAW,CAAC,EAAE,8BAA8B,CAAC;CAC9C;AAED;;;GAGG;AACH,MAAM,WAAW,uCAAwC,SAAQ,6BAA6B;IAC5F;;;;OAIG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,GAAG,CAAC;CACtB;AAED;;;;;GAKG;AACH,oBAAY,6BAA6B,GAAG,6BAA6B,GAAG,6BAA6B,EAAE,CAAC;AAE5G;;;;;GAKG;AACH,oBAAY,uCAAuC,GAAG,uCAAuC,GAAG,uCAAuC,EAAE,CAAC"}
+{"version":3,"file":"RelationshipPathSpecification.d.ts","sourceRoot":"","sources":["../../../../src/presentation-common/rules/RelationshipPathSpecification.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,8BAA8B,EAAE,MAAM,uBAAuB,CAAC;AACvE,OAAO,EAAE,qBAAqB,EAAE,MAAM,yBAAyB,CAAC;AAEhE;;;;;GAKG;AACH,MAAM,WAAW,6BAA6B;IAC5C,mGAAmG;IACnG,YAAY,EAAE,8BAA8B,CAAC;IAE7C,+FAA+F;IAC/F,SAAS,EAAE,qBAAqB,CAAC,OAAO,GAAG,qBAAqB,CAAC,QAAQ,CAAC;IAE1E;;OAEG;IACH,WAAW,CAAC,EAAE,8BAA8B,CAAC;CAC9C;AAED;;;;;GAKG;AACH,MAAM,WAAW,uCAAwC,SAAQ,6BAA6B;IAC5F;;;;;;OAMG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,GAAG,CAAC;CACtB;AAED;;;;;GAKG;AACH,oBAAY,6BAA6B,GAAG,6BAA6B,GAAG,6BAA6B,EAAE,CAAC;AAE5G;;;;;;;GAOG;AACH,oBAAY,uCAAuC,GAAG,uCAAuC,GAAG,uCAAuC,EAAE,CAAC"}

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

@@ -1 +1 @@
-{"version":3,"file":"RelationshipPathSpecification.js","sourceRoot":"","sources":["../../../../src/presentation-common/rules/RelationshipPathSpecification.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\n/** @packageDocumentation\r\n * @module PresentationRules\r\n */\r\n\r\nimport { SingleSchemaClassSpecification } from \"./ClassSpecifications\";\r\nimport { RelationshipDirection } from \"./RelationshipDirection\";\r\n\r\n/**\r\n * Specification of a single relationship path step.\r\n * @public\r\n */\r\nexport interface RelationshipStepSpecification {\r\n  /** Specification of the relationship to use for joining the related instance. */\r\n  relationship: SingleSchemaClassSpecification;\r\n\r\n  /** Relationship direction that should be followed to find the target class. */\r\n  direction: RelationshipDirection.Forward | RelationshipDirection.Backward;\r\n\r\n  /**\r\n   * Specification of the target class. Either relationship's source or target class is used (based\r\n   * on specified direction) if more specific target class is not specified by this attribute.\r\n   */\r\n  targetClass?: SingleSchemaClassSpecification;\r\n}\r\n\r\n/**\r\n * Specification of a single relationship path step.\r\n * @public\r\n */\r\nexport interface RepeatableRelationshipStepSpecification extends RelationshipStepSpecification {\r\n  /**\r\n   * Number of relationship steps that should be taken. Special `*` value means that\r\n   * relationship is traversed recursively and all matching instances are accumulated.\r\n   * Defaults to `1`.\r\n   */\r\n  count?: number | \"*\";\r\n}\r\n\r\n/**\r\n * Specification of a relationship path.\r\n *\r\n * @see [More details]($docs/presentation/RelationshipPathSpecification.md)\r\n * @public\r\n */\r\nexport type RelationshipPathSpecification = RelationshipStepSpecification | RelationshipStepSpecification[];\r\n\r\n/**\r\n * Specification of a repeatable relationship path.\r\n *\r\n * @see [More details]($docs/presentation/RepeatableRelationshipPathSpecification.md)\r\n * @public\r\n */\r\nexport type RepeatableRelationshipPathSpecification = RepeatableRelationshipStepSpecification | RepeatableRelationshipStepSpecification[];\r\n"]}
+{"version":3,"file":"RelationshipPathSpecification.js","sourceRoot":"","sources":["../../../../src/presentation-common/rules/RelationshipPathSpecification.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\n/** @packageDocumentation\r\n * @module PresentationRules\r\n */\r\n\r\nimport { SingleSchemaClassSpecification } from \"./ClassSpecifications\";\r\nimport { RelationshipDirection } from \"./RelationshipDirection\";\r\n\r\n/**\r\n * Specification of a single step in [[RelationshipPathSpecification]].\r\n *\r\n * @see [Relationship path specification reference documentation page]($docs/presentation/RelationshipPathSpecification.md)\r\n * @public\r\n */\r\nexport interface RelationshipStepSpecification {\r\n  /** This attribute specifies the ECRelationship that should be used to traverse to target class. */\r\n  relationship: SingleSchemaClassSpecification;\r\n\r\n  /** This attribute specifies the direction in which the [[relationship]] should be followed. */\r\n  direction: RelationshipDirection.Forward | RelationshipDirection.Backward;\r\n\r\n  /**\r\n   * This attribute may be used to specialize the target of the relationship.\r\n   */\r\n  targetClass?: SingleSchemaClassSpecification;\r\n}\r\n\r\n/**\r\n * Specification of a single step in [[RepeatableRelationshipPathSpecification]].\r\n *\r\n * @see [Repeatable relationship path specification reference documentation page]($docs/presentation/RepeatableRelationshipPathSpecification.md)\r\n * @public\r\n */\r\nexport interface RepeatableRelationshipStepSpecification extends RelationshipStepSpecification {\r\n  /**\r\n   * When a number is specified, the relationship is traversed recursively the specified number of times.\r\n   *\r\n   * When it is set to a special value `\"*\"`, the same relationship is traversed recursively unbounded number\r\n   * of times, starting from zero (the relationship is not followed). On each traversal iteration, Presentation\r\n   * rules engine accumulates all indirectly related ECInstances as defined by the remaining relationship path.\r\n   */\r\n  count?: number | \"*\";\r\n}\r\n\r\n/**\r\n * Relationship path specification is used to define a relationship path to an ECClass.\r\n *\r\n * @see [Relationship path specification reference documentation page]($docs/presentation/RelationshipPathSpecification.md)\r\n * @public\r\n */\r\nexport type RelationshipPathSpecification = RelationshipStepSpecification | RelationshipStepSpecification[];\r\n\r\n/**\r\n * This specification declares a step in a relationship path between a source and target ECInstances. A step\r\n * can optionally be repeated a number of times to traverse the same relationship recursively. Multiple\r\n * specifications of this type can be chained together to express complex indirect relationships.\r\n *\r\n * @see [Repeatable relationship path specification reference documentation page]($docs/presentation/RepeatableRelationshipPathSpecification.md)\r\n * @public\r\n */\r\nexport type RepeatableRelationshipPathSpecification = RepeatableRelationshipStepSpecification | RepeatableRelationshipStepSpecification[];\r\n"]}

package/lib/cjs/presentation-common/rules/Rule.d.ts

@@ -8,47 +8,46 @@ import { CustomizationRule } from "./customization/CustomizationRule";
 import { NavigationRule } from "./hierarchy/NavigationRule";
 import { RequiredSchemaSpecification } from "./SchemasSpecification";
 /**
- * Base interface for all [[Rule]] implementations. Not meant
- * to be used directly, see `Rule`.
- *
+ * Base interface for all [[Rule]] implementations.
  * @public
  */
 export interface RuleBase {
     /** Used for serializing to JSON. */
     ruleType: RuleTypes;
     /**
-     * Defines the order in which presentation rules will be evaluated and executed. Defaults to `1000`.
+     * Defines the order in which rules are handled, higher number means the rule is handled first. If priorities are
+     * equal, the rules are handled in the order they're defined.
      *
      * @type integer
      */
     priority?: number;
     /**
-     * Should this rule should be ignored if there is already an existing
-     * rule with a higher priority.
+     * Tells the library that the rule should only be handled if no other rule of the same type was handled previously (based on rule
+     * priorities and definition order). This allows adding fallback rules which can be overriden by higher-priority rules.
      */
     onlyIfNotHandled?: boolean;
     /**
-     * Schema requirements for this rule. The rule is not used if the requirements are not met.
+     * A list of [ECSchema requirements]($docs/presentation/RequiredSchemaSpecification.md) that need to be met for the rule to be used.
      * @beta
      */
     requiredSchemas?: RequiredSchemaSpecification[];
 }
 /**
- * Presentation rules allow configuring the hierarchy and content.
+ * A union of all presentation rule types.
  * @public
  */
 export declare type Rule = CustomizationRule | NavigationRule | ContentRule | ContentModifier | DefaultPropertyCategoryOverride;
 /**
  * Container of a [[condition]] property. Used for rules that support conditions. Not
- * meant to be used directly, see `Rule`.
+ * meant to be used directly, see [[Rule]].
  *
+ * @deprecated This interface is not used anymore. All interfaces that used to extend it, have the [[condition]]
+ * attribute of their own.
  * @public
  */
 export interface ConditionContainer {
     /**
-     * Defines a condition for the rule, which needs to be met in order to execute it. Condition
-     * is an [ECExpression]($docs/presentation/Advanced/ECExpressions.md), which can use
-     * a limited set of symbols (depends on specific `ConditionContainer`).
+     * Defines a condition for the rule, which needs to be met in order to execute it.
      */
     condition?: string;
 }

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

@@ -1 +1 @@
-{"version":3,"file":"Rule.d.ts","sourceRoot":"","sources":["../../../../src/presentation-common/rules/Rule.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,WAAW,EAAE,MAAM,uBAAuB,CAAC;AACpD,OAAO,EAAE,+BAA+B,EAAE,MAAM,2CAA2C,CAAC;AAC5F,OAAO,EAAE,eAAe,EAAE,MAAM,qCAAqC,CAAC;AACtE,OAAO,EAAE,iBAAiB,EAAE,MAAM,mCAAmC,CAAC;AACtE,OAAO,EAAE,cAAc,EAAE,MAAM,4BAA4B,CAAC;AAC5D,OAAO,EAAE,2BAA2B,EAAE,MAAM,wBAAwB,CAAC;AAErE;;;;;GAKG;AACH,MAAM,WAAW,QAAQ;IACvB,oCAAoC;IACpC,QAAQ,EAAE,SAAS,CAAC;IAEpB;;;;OAIG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;;OAGG;IACH,gBAAgB,CAAC,EAAE,OAAO,CAAC;IAE3B;;;OAGG;IACH,eAAe,CAAC,EAAE,2BAA2B,EAAE,CAAC;CACjD;AAED;;;GAGG;AACH,MAAM,CAAC,OAAO,MAAM,IAAI,GAAG,iBAAiB,GAAG,cAAc,GAAG,WAAW,GAAG,eAAe,GAAG,+BAA+B,CAAC;AAEhI;;;;;GAKG;AACH,MAAM,WAAW,kBAAkB;IACjC;;;;OAIG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED;;;GAGG;AACH,oBAAY,SAAS;IAEnB,SAAS,cAAc;IACvB,UAAU,eAAe;IAGzB,OAAO,YAAY;IACnB,eAAe,oBAAoB;IACnC,+BAA+B,oCAAoC;IAGnE,QAAQ,aAAa;IACrB,eAAe,oBAAoB;IACnC,eAAe,oBAAoB;IACnC,aAAa,kBAAkB;IAC/B,qBAAqB,0BAA0B;IAC/C,aAAa,kBAAkB;IAC/B,QAAQ,aAAa;IACrB,eAAe,oBAAoB;IACnC,aAAa,kBAAkB;IAC/B,YAAY,iBAAiB;CAC9B"}
+{"version":3,"file":"Rule.d.ts","sourceRoot":"","sources":["../../../../src/presentation-common/rules/Rule.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,WAAW,EAAE,MAAM,uBAAuB,CAAC;AACpD,OAAO,EAAE,+BAA+B,EAAE,MAAM,2CAA2C,CAAC;AAC5F,OAAO,EAAE,eAAe,EAAE,MAAM,qCAAqC,CAAC;AACtE,OAAO,EAAE,iBAAiB,EAAE,MAAM,mCAAmC,CAAC;AACtE,OAAO,EAAE,cAAc,EAAE,MAAM,4BAA4B,CAAC;AAC5D,OAAO,EAAE,2BAA2B,EAAE,MAAM,wBAAwB,CAAC;AAErE;;;GAGG;AACH,MAAM,WAAW,QAAQ;IACvB,oCAAoC;IACpC,QAAQ,EAAE,SAAS,CAAC;IAEpB;;;;;OAKG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;;OAGG;IACH,gBAAgB,CAAC,EAAE,OAAO,CAAC;IAE3B;;;OAGG;IACH,eAAe,CAAC,EAAE,2BAA2B,EAAE,CAAC;CACjD;AAED;;;GAGG;AACH,MAAM,CAAC,OAAO,MAAM,IAAI,GAAG,iBAAiB,GAAG,cAAc,GAAG,WAAW,GAAG,eAAe,GAAG,+BAA+B,CAAC;AAEhI;;;;;;;GAOG;AACH,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED;;;GAGG;AACH,oBAAY,SAAS;IAEnB,SAAS,cAAc;IACvB,UAAU,eAAe;IAGzB,OAAO,YAAY;IACnB,eAAe,oBAAoB;IACnC,+BAA+B,oCAAoC;IAGnE,QAAQ,aAAa;IACrB,eAAe,oBAAoB;IACnC,eAAe,oBAAoB;IACnC,aAAa,kBAAkB;IAC/B,qBAAqB,0BAA0B;IAC/C,aAAa,kBAAkB;IAC/B,QAAQ,aAAa;IACrB,eAAe,oBAAoB;IACnC,aAAa,kBAAkB;IAC/B,YAAY,iBAAiB;CAC9B"}

package/lib/cjs/presentation-common/rules/Rule.js.map

@@ -1 +1 @@
-{"version":3,"file":"Rule.js","sourceRoot":"","sources":["../../../../src/presentation-common/rules/Rule.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AA4DH;;;GAGG;AACH,IAAY,SAqBX;AArBD,WAAY,SAAS;IACnB,kBAAkB;IAClB,oCAAuB,CAAA;IACvB,sCAAyB,CAAA;IAEzB,gBAAgB;IAChB,gCAAmB,CAAA;IACnB,gDAAmC,CAAA;IACnC,gFAAmE,CAAA;IAEnE,sBAAsB;IACtB,kCAAqB,CAAA;IACrB,gDAAmC,CAAA;IACnC,gDAAmC,CAAA;IACnC,4CAA+B,CAAA;IAC/B,4DAA+C,CAAA;IAC/C,4CAA+B,CAAA;IAC/B,kCAAqB,CAAA;IACrB,gDAAmC,CAAA;IACnC,4CAA+B,CAAA;IAC/B,0CAA6B,CAAA;AAC/B,CAAC,EArBW,SAAS,GAAT,iBAAS,KAAT,iBAAS,QAqBpB","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 { ContentRule } from \"./content/ContentRule\";\r\nimport { DefaultPropertyCategoryOverride } from \"./content/DefaultPropertyCategoryOverride\";\r\nimport { ContentModifier } from \"./content/modifiers/ContentModifier\";\r\nimport { CustomizationRule } from \"./customization/CustomizationRule\";\r\nimport { NavigationRule } from \"./hierarchy/NavigationRule\";\r\nimport { RequiredSchemaSpecification } from \"./SchemasSpecification\";\r\n\r\n/**\r\n * Base interface for all [[Rule]] implementations. Not meant\r\n * to be used directly, see `Rule`.\r\n *\r\n * @public\r\n */\r\nexport interface RuleBase {\r\n  /** Used for serializing to JSON. */\r\n  ruleType: RuleTypes;\r\n\r\n  /**\r\n   * Defines the order in which presentation rules will be evaluated and executed. Defaults to `1000`.\r\n   *\r\n   * @type integer\r\n   */\r\n  priority?: number;\r\n\r\n  /**\r\n   * Should this rule should be ignored if there is already an existing\r\n   * rule with a higher priority.\r\n   */\r\n  onlyIfNotHandled?: boolean;\r\n\r\n  /**\r\n   * Schema requirements for this rule. The rule is not used if the requirements are not met.\r\n   * @beta\r\n   */\r\n  requiredSchemas?: RequiredSchemaSpecification[];\r\n}\r\n\r\n/**\r\n * Presentation rules allow configuring the hierarchy and content.\r\n * @public\r\n */\r\nexport declare type Rule = CustomizationRule | NavigationRule | ContentRule | ContentModifier | DefaultPropertyCategoryOverride;\r\n\r\n/**\r\n * Container of a [[condition]] property. Used for rules that support conditions. Not\r\n * meant to be used directly, see `Rule`.\r\n *\r\n * @public\r\n */\r\nexport interface ConditionContainer {\r\n  /**\r\n   * Defines a condition for the rule, which needs to be met in order to execute it. Condition\r\n   * is an [ECExpression]($docs/presentation/Advanced/ECExpressions.md), which can use\r\n   * a limited set of symbols (depends on specific `ConditionContainer`).\r\n   */\r\n  condition?: string;\r\n}\r\n\r\n/**\r\n * Used for serializing [[Rule]] objects to JSON.\r\n * @public\r\n */\r\nexport enum RuleTypes {\r\n  // hierarchy rules\r\n  RootNodes = \"RootNodes\",\r\n  ChildNodes = \"ChildNodes\",\r\n\r\n  // content rules\r\n  Content = \"Content\",\r\n  ContentModifier = \"ContentModifier\", // eslint-disable-line @typescript-eslint/no-shadow\r\n  DefaultPropertyCategoryOverride = \"DefaultPropertyCategoryOverride\", // eslint-disable-line @typescript-eslint/no-shadow\r\n\r\n  // customization rules\r\n  Grouping = \"Grouping\",\r\n  PropertySorting = \"PropertySorting\",\r\n  DisabledSorting = \"DisabledSorting\",\r\n  NodeArtifacts = \"NodeArtifacts\",\r\n  InstanceLabelOverride = \"InstanceLabelOverride\",\r\n  LabelOverride = \"LabelOverride\",\r\n  CheckBox = \"CheckBox\",\r\n  ImageIdOverride = \"ImageIdOverride\",\r\n  StyleOverride = \"StyleOverride\",\r\n  ExtendedData = \"ExtendedData\",\r\n}\r\n"]}
+{"version":3,"file":"Rule.js","sourceRoot":"","sources":["../../../../src/presentation-common/rules/Rule.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AA2DH;;;GAGG;AACH,IAAY,SAqBX;AArBD,WAAY,SAAS;IACnB,kBAAkB;IAClB,oCAAuB,CAAA;IACvB,sCAAyB,CAAA;IAEzB,gBAAgB;IAChB,gCAAmB,CAAA;IACnB,gDAAmC,CAAA;IACnC,gFAAmE,CAAA;IAEnE,sBAAsB;IACtB,kCAAqB,CAAA;IACrB,gDAAmC,CAAA;IACnC,gDAAmC,CAAA;IACnC,4CAA+B,CAAA;IAC/B,4DAA+C,CAAA;IAC/C,4CAA+B,CAAA;IAC/B,kCAAqB,CAAA;IACrB,gDAAmC,CAAA;IACnC,4CAA+B,CAAA;IAC/B,0CAA6B,CAAA;AAC/B,CAAC,EArBW,SAAS,GAAT,iBAAS,KAAT,iBAAS,QAqBpB","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 { ContentRule } from \"./content/ContentRule\";\r\nimport { DefaultPropertyCategoryOverride } from \"./content/DefaultPropertyCategoryOverride\";\r\nimport { ContentModifier } from \"./content/modifiers/ContentModifier\";\r\nimport { CustomizationRule } from \"./customization/CustomizationRule\";\r\nimport { NavigationRule } from \"./hierarchy/NavigationRule\";\r\nimport { RequiredSchemaSpecification } from \"./SchemasSpecification\";\r\n\r\n/**\r\n * Base interface for all [[Rule]] implementations.\r\n * @public\r\n */\r\nexport interface RuleBase {\r\n  /** Used for serializing to JSON. */\r\n  ruleType: RuleTypes;\r\n\r\n  /**\r\n   * Defines the order in which rules are handled, higher number means the rule is handled first. If priorities are\r\n   * equal, the rules are handled in the order they're defined.\r\n   *\r\n   * @type integer\r\n   */\r\n  priority?: number;\r\n\r\n  /**\r\n   * Tells the library that the rule should only be handled if no other rule of the same type was handled previously (based on rule\r\n   * priorities and definition order). This allows adding fallback rules which can be overriden by higher-priority rules.\r\n   */\r\n  onlyIfNotHandled?: boolean;\r\n\r\n  /**\r\n   * A list of [ECSchema requirements]($docs/presentation/RequiredSchemaSpecification.md) that need to be met for the rule to be used.\r\n   * @beta\r\n   */\r\n  requiredSchemas?: RequiredSchemaSpecification[];\r\n}\r\n\r\n/**\r\n * A union of all presentation rule types.\r\n * @public\r\n */\r\nexport declare type Rule = CustomizationRule | NavigationRule | ContentRule | ContentModifier | DefaultPropertyCategoryOverride;\r\n\r\n/**\r\n * Container of a [[condition]] property. Used for rules that support conditions. Not\r\n * meant to be used directly, see [[Rule]].\r\n *\r\n * @deprecated This interface is not used anymore. All interfaces that used to extend it, have the [[condition]]\r\n * attribute of their own.\r\n * @public\r\n */\r\nexport interface ConditionContainer {\r\n  /**\r\n   * Defines a condition for the rule, which needs to be met in order to execute it.\r\n   */\r\n  condition?: string;\r\n}\r\n\r\n/**\r\n * Used for serializing [[Rule]] objects to JSON.\r\n * @public\r\n */\r\nexport enum RuleTypes {\r\n  // hierarchy rules\r\n  RootNodes = \"RootNodes\",\r\n  ChildNodes = \"ChildNodes\",\r\n\r\n  // content rules\r\n  Content = \"Content\",\r\n  ContentModifier = \"ContentModifier\", // eslint-disable-line @typescript-eslint/no-shadow\r\n  DefaultPropertyCategoryOverride = \"DefaultPropertyCategoryOverride\", // eslint-disable-line @typescript-eslint/no-shadow\r\n\r\n  // customization rules\r\n  Grouping = \"Grouping\",\r\n  PropertySorting = \"PropertySorting\",\r\n  DisabledSorting = \"DisabledSorting\",\r\n  NodeArtifacts = \"NodeArtifacts\",\r\n  InstanceLabelOverride = \"InstanceLabelOverride\",\r\n  LabelOverride = \"LabelOverride\",\r\n  CheckBox = \"CheckBox\",\r\n  ImageIdOverride = \"ImageIdOverride\",\r\n  StyleOverride = \"StyleOverride\",\r\n  ExtendedData = \"ExtendedData\",\r\n}\r\n"]}

package/lib/cjs/presentation-common/rules/Ruleset.d.ts

@@ -6,15 +6,16 @@ import { RequiredSchemaSpecification } from "./SchemasSpecification";
 import { VariablesGroup } from "./Variables";
 /**
  * Presentation ruleset is a list of rules that define tree hierarchy and content provided by
- * the presentation manager. The ruleset consists of:
+ * the presentation library. The ruleset consists of:
  * - Ruleset options
- * - Navigation rules:
+ * - Hierarchy rules:
  *   - Root node rules
  *   - Child node rules
- * - Content rules for content you see in content controls
+ * - Content rules for content you see in content controls like property grid and table.
  * - Customization rules used for additional customizations such as styling, labeling, checkboxes, etc.
  * - User-controllable variables.
  *
+ * @see [Presentation library documentation page]($docs/presentation/index.md)
  * @public
  */
 export interface Ruleset {
@@ -30,7 +31,7 @@ export interface Ruleset {
      * Setting the version is optional, but might be useful when ruleset is persisted
      * somewhere and evolves over time. Having a version helps choose persisting
      * strategy (keep all versions or only latest) and find the latest ruleset from a list
-     * of ruleset with the same id.
+     * of rulesets with the same id.
      *
      * Defaults to `0.0.0`.
      *
@@ -52,7 +53,7 @@ export interface Ruleset {
 }
 /**
  * Contains supplementation-related information for
- * [supplemental rulesets]($docs/presentation/Advanced/RulesetSupplementation.md).
+ * [supplemental rulesets]($docs/presentation/advanced/RulesetSupplementation.md).
  *
  * @public
  */

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

@@ -1 +1 @@
-{"version":3,"file":"Ruleset.d.ts","sourceRoot":"","sources":["../../../../src/presentation-common/rules/Ruleset.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,IAAI,EAAE,MAAM,QAAQ,CAAC;AAC9B,OAAO,EAAE,2BAA2B,EAAE,MAAM,wBAAwB,CAAC;AACrE,OAAO,EAAE,cAAc,EAAE,MAAM,aAAa,CAAC;AAE7C;;;;;;;;;;;;GAYG;AACH,MAAM,WAAW,OAAO;IACtB;;;;OAIG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;;;;;;;;;;;OAYG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;;OAGG;IACH,eAAe,CAAC,EAAE,2BAA2B,EAAE,CAAC;IAEhD,2DAA2D;IAC3D,mBAAmB,CAAC,EAAE,mBAAmB,CAAC;IAE1C,6CAA6C;IAC7C,IAAI,CAAC,EAAE,cAAc,EAAE,CAAC;IAExB,gEAAgE;IAChE,KAAK,EAAE,IAAI,EAAE,CAAC;CACf;AAED;;;;;GAKG;AACH,MAAM,WAAW,mBAAmB;IAClC;;;OAGG;IACH,sBAAsB,EAAE,MAAM,CAAC;CAChC"}
+{"version":3,"file":"Ruleset.d.ts","sourceRoot":"","sources":["../../../../src/presentation-common/rules/Ruleset.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,IAAI,EAAE,MAAM,QAAQ,CAAC;AAC9B,OAAO,EAAE,2BAA2B,EAAE,MAAM,wBAAwB,CAAC;AACrE,OAAO,EAAE,cAAc,EAAE,MAAM,aAAa,CAAC;AAE7C;;;;;;;;;;;;;GAaG;AACH,MAAM,WAAW,OAAO;IACtB;;;;OAIG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;;;;;;;;;;;OAYG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;;OAGG;IACH,eAAe,CAAC,EAAE,2BAA2B,EAAE,CAAC;IAEhD,2DAA2D;IAC3D,mBAAmB,CAAC,EAAE,mBAAmB,CAAC;IAE1C,6CAA6C;IAC7C,IAAI,CAAC,EAAE,cAAc,EAAE,CAAC;IAExB,gEAAgE;IAChE,KAAK,EAAE,IAAI,EAAE,CAAC;CACf;AAED;;;;;GAKG;AACH,MAAM,WAAW,mBAAmB;IAClC;;;OAGG;IACH,sBAAsB,EAAE,MAAM,CAAC;CAChC"}

package/lib/cjs/presentation-common/rules/Ruleset.js.map

@@ -1 +1 @@
-{"version":3,"file":"Ruleset.js","sourceRoot":"","sources":["../../../../src/presentation-common/rules/Ruleset.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\n/** @packageDocumentation\r\n * @module PresentationRules\r\n */\r\n\r\nimport { Rule } from \"./Rule\";\r\nimport { RequiredSchemaSpecification } from \"./SchemasSpecification\";\r\nimport { VariablesGroup } from \"./Variables\";\r\n\r\n/**\r\n * Presentation ruleset is a list of rules that define tree hierarchy and content provided by\r\n * the presentation manager. The ruleset consists of:\r\n * - Ruleset options\r\n * - Navigation rules:\r\n *   - Root node rules\r\n *   - Child node rules\r\n * - Content rules for content you see in content controls\r\n * - Customization rules used for additional customizations such as styling, labeling, checkboxes, etc.\r\n * - User-controllable variables.\r\n *\r\n * @public\r\n */\r\nexport interface Ruleset {\r\n  /**\r\n   * Ruleset identifier. This ID is used to bind UI components with the specific rule set.\r\n   *\r\n   * @minLength 1\r\n   */\r\n  id: string;\r\n\r\n  /**\r\n   * Version of the presentation ruleset in SemVer format: `{major}.{minor}.{patch}`.\r\n   *\r\n   * Setting the version is optional, but might be useful when ruleset is persisted\r\n   * somewhere and evolves over time. Having a version helps choose persisting\r\n   * strategy (keep all versions or only latest) and find the latest ruleset from a list\r\n   * of ruleset with the same id.\r\n   *\r\n   * Defaults to `0.0.0`.\r\n   *\r\n   * @pattern ^[\\d]+\\.[\\d]+\\.[\\d]+$\r\n   * @beta\r\n   */\r\n  version?: string;\r\n\r\n  /**\r\n   * Schema requirements for this ruleset. The ruleset is not used if the requirements are not met.\r\n   * @beta\r\n   */\r\n  requiredSchemas?: RequiredSchemaSpecification[];\r\n\r\n  /** Supplementation-related information for this ruleset */\r\n  supplementationInfo?: SupplementationInfo;\r\n\r\n  /** User-controllable variable definitions */\r\n  vars?: VariablesGroup[];\r\n\r\n  /** Presentation rules used to create hierarchies and content */\r\n  rules: Rule[];\r\n}\r\n\r\n/**\r\n * Contains supplementation-related information for\r\n * [supplemental rulesets]($docs/presentation/Advanced/RulesetSupplementation.md).\r\n *\r\n * @public\r\n */\r\nexport interface SupplementationInfo {\r\n  /**\r\n   * Identifies why supplementation is done and uniquely identifies particular supplemental ruleset.\r\n   * There can be only one supplemental rule set with the same [[Ruleset.id]] and [[supplementationPurpose]].\r\n   */\r\n  supplementationPurpose: string;\r\n}\r\n"]}
+{"version":3,"file":"Ruleset.js","sourceRoot":"","sources":["../../../../src/presentation-common/rules/Ruleset.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\n/** @packageDocumentation\r\n * @module PresentationRules\r\n */\r\n\r\nimport { Rule } from \"./Rule\";\r\nimport { RequiredSchemaSpecification } from \"./SchemasSpecification\";\r\nimport { VariablesGroup } from \"./Variables\";\r\n\r\n/**\r\n * Presentation ruleset is a list of rules that define tree hierarchy and content provided by\r\n * the presentation library. The ruleset consists of:\r\n * - Ruleset options\r\n * - Hierarchy rules:\r\n *   - Root node rules\r\n *   - Child node rules\r\n * - Content rules for content you see in content controls like property grid and table.\r\n * - Customization rules used for additional customizations such as styling, labeling, checkboxes, etc.\r\n * - User-controllable variables.\r\n *\r\n * @see [Presentation library documentation page]($docs/presentation/index.md)\r\n * @public\r\n */\r\nexport interface Ruleset {\r\n  /**\r\n   * Ruleset identifier. This ID is used to bind UI components with the specific rule set.\r\n   *\r\n   * @minLength 1\r\n   */\r\n  id: string;\r\n\r\n  /**\r\n   * Version of the presentation ruleset in SemVer format: `{major}.{minor}.{patch}`.\r\n   *\r\n   * Setting the version is optional, but might be useful when ruleset is persisted\r\n   * somewhere and evolves over time. Having a version helps choose persisting\r\n   * strategy (keep all versions or only latest) and find the latest ruleset from a list\r\n   * of rulesets with the same id.\r\n   *\r\n   * Defaults to `0.0.0`.\r\n   *\r\n   * @pattern ^[\\d]+\\.[\\d]+\\.[\\d]+$\r\n   * @beta\r\n   */\r\n  version?: string;\r\n\r\n  /**\r\n   * Schema requirements for this ruleset. The ruleset is not used if the requirements are not met.\r\n   * @beta\r\n   */\r\n  requiredSchemas?: RequiredSchemaSpecification[];\r\n\r\n  /** Supplementation-related information for this ruleset */\r\n  supplementationInfo?: SupplementationInfo;\r\n\r\n  /** User-controllable variable definitions */\r\n  vars?: VariablesGroup[];\r\n\r\n  /** Presentation rules used to create hierarchies and content */\r\n  rules: Rule[];\r\n}\r\n\r\n/**\r\n * Contains supplementation-related information for\r\n * [supplemental rulesets]($docs/presentation/advanced/RulesetSupplementation.md).\r\n *\r\n * @public\r\n */\r\nexport interface SupplementationInfo {\r\n  /**\r\n   * Identifies why supplementation is done and uniquely identifies particular supplemental ruleset.\r\n   * There can be only one supplemental rule set with the same [[Ruleset.id]] and [[supplementationPurpose]].\r\n   */\r\n  supplementationPurpose: string;\r\n}\r\n"]}

package/lib/cjs/presentation-common/rules/SchemasSpecification.d.ts

@@ -15,11 +15,14 @@ export interface SchemasSpecification {
     isExclude?: boolean;
 }
 /**
- * A specification for a schema requirement.
+ * This specification is designed for specifying schema requirements for the [[Ruleset]] or specific
+ * presentation rules.
+ *
+ * @see [Required schema specification reference documentation page]($docs/presentation/RequiredSchemaSpecification.md)
  * @beta
  */
 export interface RequiredSchemaSpecification {
-    /** ECSchema name */
+    /** Specifies the schema to whom the requirement is being set. */
     name: string;
     /**
      * Minimum required schema version (inclusive).

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

@@ -1 +1 @@
-{"version":3,"file":"SchemasSpecification.d.ts","sourceRoot":"","sources":["../../../../src/presentation-common/rules/SchemasSpecification.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH;;;GAGG;AACH,MAAM,WAAW,oBAAoB;IACnC,qBAAqB;IACrB,WAAW,EAAE,MAAM,EAAE,CAAC;IAEtB;;;OAGG;IACH,SAAS,CAAC,EAAE,OAAO,CAAC;CACrB;AAED;;;GAGG;AACH,MAAM,WAAW,2BAA2B;IAC1C,oBAAoB;IACpB,IAAI,EAAE,MAAM,CAAC;IAEb;;;;;OAKG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;;;;OAKG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB"}
+{"version":3,"file":"SchemasSpecification.d.ts","sourceRoot":"","sources":["../../../../src/presentation-common/rules/SchemasSpecification.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH;;;GAGG;AACH,MAAM,WAAW,oBAAoB;IACnC,qBAAqB;IACrB,WAAW,EAAE,MAAM,EAAE,CAAC;IAEtB;;;OAGG;IACH,SAAS,CAAC,EAAE,OAAO,CAAC;CACrB;AAED;;;;;;GAMG;AACH,MAAM,WAAW,2BAA2B;IAC1C,iEAAiE;IACjE,IAAI,EAAE,MAAM,CAAC;IAEb;;;;;OAKG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;;;;OAKG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB"}

package/lib/cjs/presentation-common/rules/SchemasSpecification.js.map

@@ -1 +1 @@
-{"version":3,"file":"SchemasSpecification.js","sourceRoot":"","sources":["../../../../src/presentation-common/rules/SchemasSpecification.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\n/** @packageDocumentation\r\n * @module PresentationRules\r\n */\r\n\r\n/**\r\n * Specification for a list of ECSchemas\r\n * @public\r\n */\r\nexport interface SchemasSpecification {\r\n  /** ECSchema names */\r\n  schemaNames: string[];\r\n\r\n  /**\r\n   * Should schemas specified in [[schemaNames]] be excluded rather than included.\r\n   * Exclusion works by including everything except what's specified in [[schemaNames]].\r\n   */\r\n  isExclude?: boolean;\r\n}\r\n\r\n/**\r\n * A specification for a schema requirement.\r\n * @beta\r\n */\r\nexport interface RequiredSchemaSpecification {\r\n  /** ECSchema name */\r\n  name: string;\r\n\r\n  /**\r\n   * Minimum required schema version (inclusive).\r\n   * Format: `{read version}.{write version}.{minor version}`, e.g. `2.1.15`.\r\n   *\r\n   * @pattern ^[\\d]+\\.[\\d]+\\.[\\d]+$\r\n   */\r\n  minVersion?: string;\r\n\r\n  /**\r\n   * Maximum allowed schema version (exclusive).\r\n   * Format: `{read version}.{write version}.{minor version}`, e.g. `2.1.15`.\r\n   *\r\n   * @pattern ^[\\d]+\\.[\\d]+\\.[\\d]+$\r\n   */\r\n  maxVersion?: string;\r\n}\r\n"]}
+{"version":3,"file":"SchemasSpecification.js","sourceRoot":"","sources":["../../../../src/presentation-common/rules/SchemasSpecification.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\n/** @packageDocumentation\r\n * @module PresentationRules\r\n */\r\n\r\n/**\r\n * Specification for a list of ECSchemas\r\n * @public\r\n */\r\nexport interface SchemasSpecification {\r\n  /** ECSchema names */\r\n  schemaNames: string[];\r\n\r\n  /**\r\n   * Should schemas specified in [[schemaNames]] be excluded rather than included.\r\n   * Exclusion works by including everything except what's specified in [[schemaNames]].\r\n   */\r\n  isExclude?: boolean;\r\n}\r\n\r\n/**\r\n * This specification is designed for specifying schema requirements for the [[Ruleset]] or specific\r\n * presentation rules.\r\n *\r\n * @see [Required schema specification reference documentation page]($docs/presentation/RequiredSchemaSpecification.md)\r\n * @beta\r\n */\r\nexport interface RequiredSchemaSpecification {\r\n  /** Specifies the schema to whom the requirement is being set. */\r\n  name: string;\r\n\r\n  /**\r\n   * Minimum required schema version (inclusive).\r\n   * Format: `{read version}.{write version}.{minor version}`, e.g. `2.1.15`.\r\n   *\r\n   * @pattern ^[\\d]+\\.[\\d]+\\.[\\d]+$\r\n   */\r\n  minVersion?: string;\r\n\r\n  /**\r\n   * Maximum allowed schema version (exclusive).\r\n   * Format: `{read version}.{write version}.{minor version}`, e.g. `2.1.15`.\r\n   *\r\n   * @pattern ^[\\d]+\\.[\\d]+\\.[\\d]+$\r\n   */\r\n  maxVersion?: string;\r\n}\r\n"]}

package/lib/cjs/presentation-common/rules/Variables.d.ts

@@ -5,7 +5,7 @@
  * Presentation rules support variables that allow having additional customization of the hierarchy
  * and content based on variables whose values can change during application session.
  *
- * There are [special ECExpression symbols]($docs/presentation/Advanced/ECExpressions.md#ruleset-variables-user-settings)
+ * There are [special ECExpression symbols]($docs/presentation/advanced/ECExpressions.md#ruleset-variables-user-settings)
  * that can be used to access variables by their ID, so rule conditions can check for a value and change
  * the behavior. It allows showing / hiding some nodes in the hierarchy, change the grouping, etc.
  *
@@ -14,7 +14,7 @@
 export interface VariablesGroup {
     /**
      * Group label to display in the UI.
-     * May be [localized]($docs/presentation/Advanced/Localization.md).
+     * May be [localized]($docs/presentation/advanced/Localization.md).
      */
     label: string;
     /** Grouped variables */
@@ -45,7 +45,7 @@ export interface Variable {
     id: string;
     /**
      * Label of the variable that is shown in the UI.
-     * May be [localized]($docs/presentation/Advanced/Localization.md).
+     * May be [localized]($docs/presentation/advanced/Localization.md).
      */
     label: string;
     /** Defines value type. Defaults to [[VariableValueType.YesNo]]. */

package/lib/cjs/presentation-common/rules/Variables.js.map

@@ -1 +1 @@
-{"version":3,"file":"Variables.js","sourceRoot":"","sources":["../../../../src/presentation-common/rules/Variables.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AA0BH;;;GAGG;AACH,IAAY,iBAYX;AAZD,WAAY,iBAAiB;IAC3B,uDAAuD;IACvD,oCAAe,CAAA;IAEf,0DAA0D;IAC1D,0CAAqB,CAAA;IAErB,uBAAuB;IACvB,2CAAsB,CAAA;IAEtB,wBAAwB;IACxB,qCAAgB,CAAA;AAClB,CAAC,EAZW,iBAAiB,GAAjB,yBAAiB,KAAjB,yBAAiB,QAY5B","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\n/**\r\n * Presentation rules support variables that allow having additional customization of the hierarchy\r\n * and content based on variables whose values can change during application session.\r\n *\r\n * There are [special ECExpression symbols]($docs/presentation/Advanced/ECExpressions.md#ruleset-variables-user-settings)\r\n * that can be used to access variables by their ID, so rule conditions can check for a value and change\r\n * the behavior. It allows showing / hiding some nodes in the hierarchy, change the grouping, etc.\r\n *\r\n * @public\r\n */\r\nexport interface VariablesGroup {\r\n  /**\r\n   * Group label to display in the UI.\r\n   * May be [localized]($docs/presentation/Advanced/Localization.md).\r\n   */\r\n  label: string;\r\n\r\n  /** Grouped variables */\r\n  vars: Variable[];\r\n\r\n  /** Nested variable groups. */\r\n  nestedGroups?: VariablesGroup[];\r\n}\r\n\r\n/**\r\n * Available value types of user-controllable variables\r\n * @public\r\n */\r\nexport enum VariableValueType {\r\n  /** Bool value, that uses Yes / No strings in the UI */\r\n  YesNo = \"YesNo\",\r\n\r\n  /** Bool value, that uses Show / Hide strings in the UI */\r\n  ShowHide = \"ShowHide\",\r\n\r\n  /** Any string value */\r\n  String = \"StringValue\",\r\n\r\n  /** Any integer value */\r\n  Int = \"IntValue\",\r\n}\r\n\r\n/**\r\n * Definition for single user-controllable variable\r\n * @public\r\n */\r\nexport interface Variable {\r\n  /** Id of the variable */\r\n  id: string;\r\n\r\n  /**\r\n   * Label of the variable that is shown in the UI.\r\n   * May be [localized]($docs/presentation/Advanced/Localization.md).\r\n   */\r\n  label: string;\r\n\r\n  /** Defines value type. Defaults to [[VariableValueType.YesNo]]. */\r\n  type?: VariableValueType;\r\n\r\n  /** Default value. */\r\n  defaultValue?: string;\r\n}\r\n"]}
+{"version":3,"file":"Variables.js","sourceRoot":"","sources":["../../../../src/presentation-common/rules/Variables.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AA0BH;;;GAGG;AACH,IAAY,iBAYX;AAZD,WAAY,iBAAiB;IAC3B,uDAAuD;IACvD,oCAAe,CAAA;IAEf,0DAA0D;IAC1D,0CAAqB,CAAA;IAErB,uBAAuB;IACvB,2CAAsB,CAAA;IAEtB,wBAAwB;IACxB,qCAAgB,CAAA;AAClB,CAAC,EAZW,iBAAiB,GAAjB,yBAAiB,KAAjB,yBAAiB,QAY5B","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\n/**\r\n * Presentation rules support variables that allow having additional customization of the hierarchy\r\n * and content based on variables whose values can change during application session.\r\n *\r\n * There are [special ECExpression symbols]($docs/presentation/advanced/ECExpressions.md#ruleset-variables-user-settings)\r\n * that can be used to access variables by their ID, so rule conditions can check for a value and change\r\n * the behavior. It allows showing / hiding some nodes in the hierarchy, change the grouping, etc.\r\n *\r\n * @public\r\n */\r\nexport interface VariablesGroup {\r\n  /**\r\n   * Group label to display in the UI.\r\n   * May be [localized]($docs/presentation/advanced/Localization.md).\r\n   */\r\n  label: string;\r\n\r\n  /** Grouped variables */\r\n  vars: Variable[];\r\n\r\n  /** Nested variable groups. */\r\n  nestedGroups?: VariablesGroup[];\r\n}\r\n\r\n/**\r\n * Available value types of user-controllable variables\r\n * @public\r\n */\r\nexport enum VariableValueType {\r\n  /** Bool value, that uses Yes / No strings in the UI */\r\n  YesNo = \"YesNo\",\r\n\r\n  /** Bool value, that uses Show / Hide strings in the UI */\r\n  ShowHide = \"ShowHide\",\r\n\r\n  /** Any string value */\r\n  String = \"StringValue\",\r\n\r\n  /** Any integer value */\r\n  Int = \"IntValue\",\r\n}\r\n\r\n/**\r\n * Definition for single user-controllable variable\r\n * @public\r\n */\r\nexport interface Variable {\r\n  /** Id of the variable */\r\n  id: string;\r\n\r\n  /**\r\n   * Label of the variable that is shown in the UI.\r\n   * May be [localized]($docs/presentation/advanced/Localization.md).\r\n   */\r\n  label: string;\r\n\r\n  /** Defines value type. Defaults to [[VariableValueType.YesNo]]. */\r\n  type?: VariableValueType;\r\n\r\n  /** Default value. */\r\n  defaultValue?: string;\r\n}\r\n"]}

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

@@ -4,40 +4,38 @@
 import { MultiSchemaClassesSpecification } from "../ClassSpecifications";
 import { ContentSpecificationBase, ContentSpecificationTypes } from "./ContentSpecification";
 /**
- * Creates content for ECInstance(s) of specified classes.
+ * This specification creates content for all instances of specific ECClasses.
  *
- * **Note**: this specification doesn't rely on selection. It always returns instances no matter
- * what the selection is, so pre-filtering should be done in [[ContentRule]] condition and [[instanceFilter]].
- *
- * @see [More details]($docs/presentation/Content/ContentInstancesOfSpecificClasses.md)
+ * @see [Content instances of specific classes specification reference documentation page]($docs/presentation/content/ContentInstancesOfSpecificClasses.md)
  * @public
  */
 export interface ContentInstancesOfSpecificClassesSpecification extends ContentSpecificationBase {
     /** Used for serializing to JSON. */
     specType: ContentSpecificationTypes.ContentInstancesOfSpecificClasses;
     /**
-     * List of ECClass specifications whose ECInstances should be selected.
+     * Defines a set of [multi schema classes]($docs/presentation/MultiSchemaClassesSpecification.md) that specify which
+     * ECClasses need to be selected to form the result.
      */
     classes: MultiSchemaClassesSpecification | MultiSchemaClassesSpecification[];
     /**
-     * List of ECClass specifications whose ECInstances should be excluded.
+     * Defines a set of [multi schema classes]($docs/presentation/MultiSchemaClassesSpecification.md) that prevents specified
+     * ECClasses and subclasses from being selected by [[classes]] attribute.
      */
     excludedClasses?: MultiSchemaClassesSpecification | MultiSchemaClassesSpecification[];
     /**
-     * Whether to get content from instances of derived `classes`.
-     * Acts as default value for [[classes.arePolymorphic]] and [[excludedClasses.arePolymorphic]].
+     * Tells whether selecting instances from ECClasses specified in [[classes]] and [[excludedClasses]]
+     * attributes should be polymorphic or not.
+     *
      * @deprecated Specify polymorphism value inside [[classes.arePolymorphic]] or [[excludedClasses.arePolymorphic]].
      */
     handleInstancesPolymorphically?: boolean;
     /**
-     * Whether to get content from properties of derived `classes`. If `true`, properties from `classes` with no instances
-     * do not appear in the result set.
+     * Specifies whether properties of derived [[classes]] should be included in the content.
      */
     handlePropertiesPolymorphically?: boolean;
     /**
-     * Condition for filtering instances of defined classes.
-     *
-     * **See:** [ECExpressions available in instance filter]($docs/presentation/Content/ECExpressions.md#instance-filter)
+     * Specifies an [ECExpression]($docs/presentation/content/ECExpressions.md#instance-filter) for filtering instances
+     * of ECClasses specified through the [[classes]] attribute.
      */
     instanceFilter?: string;
 }

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

@@ -1 +1 @@
-{"version":3,"file":"ContentInstancesOfSpecificClassesSpecification.d.ts","sourceRoot":"","sources":["../../../../../src/presentation-common/rules/content/ContentInstancesOfSpecificClassesSpecification.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,+BAA+B,EAAE,MAAM,wBAAwB,CAAC;AACzE,OAAO,EAAE,wBAAwB,EAAE,yBAAyB,EAAE,MAAM,wBAAwB,CAAC;AAE7F;;;;;;;;GAQG;AACH,MAAM,WAAW,8CAA+C,SAAQ,wBAAwB;IAC9F,oCAAoC;IACpC,QAAQ,EAAE,yBAAyB,CAAC,iCAAiC,CAAC;IAEtE;;OAEG;IACH,OAAO,EAAE,+BAA+B,GAAG,+BAA+B,EAAE,CAAC;IAE7E;;OAEG;IACH,eAAe,CAAC,EAAE,+BAA+B,GAAG,+BAA+B,EAAE,CAAC;IAEtF;;;;OAIG;IACH,8BAA8B,CAAC,EAAE,OAAO,CAAC;IAEzC;;;OAGG;IACH,+BAA+B,CAAC,EAAE,OAAO,CAAC;IAE1C;;;;OAIG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;CACzB"}
+{"version":3,"file":"ContentInstancesOfSpecificClassesSpecification.d.ts","sourceRoot":"","sources":["../../../../../src/presentation-common/rules/content/ContentInstancesOfSpecificClassesSpecification.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,+BAA+B,EAAE,MAAM,wBAAwB,CAAC;AACzE,OAAO,EAAE,wBAAwB,EAAE,yBAAyB,EAAE,MAAM,wBAAwB,CAAC;AAE7F;;;;;GAKG;AACH,MAAM,WAAW,8CAA+C,SAAQ,wBAAwB;IAC9F,oCAAoC;IACpC,QAAQ,EAAE,yBAAyB,CAAC,iCAAiC,CAAC;IAEtE;;;OAGG;IACH,OAAO,EAAE,+BAA+B,GAAG,+BAA+B,EAAE,CAAC;IAE7E;;;OAGG;IACH,eAAe,CAAC,EAAE,+BAA+B,GAAG,+BAA+B,EAAE,CAAC;IAEtF;;;;;OAKG;IACH,8BAA8B,CAAC,EAAE,OAAO,CAAC;IAEzC;;OAEG;IACH,+BAA+B,CAAC,EAAE,OAAO,CAAC;IAE1C;;;OAGG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;CACzB"}

package/lib/cjs/presentation-common/rules/content/ContentInstancesOfSpecificClassesSpecification.js.map

@@ -1 +1 @@
-{"version":3,"file":"ContentInstancesOfSpecificClassesSpecification.js","sourceRoot":"","sources":["../../../../../src/presentation-common/rules/content/ContentInstancesOfSpecificClassesSpecification.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\n/** @packageDocumentation\r\n * @module PresentationRules\r\n */\r\n\r\nimport { MultiSchemaClassesSpecification } from \"../ClassSpecifications\";\r\nimport { ContentSpecificationBase, ContentSpecificationTypes } from \"./ContentSpecification\";\r\n\r\n/**\r\n * Creates content for ECInstance(s) of specified classes.\r\n *\r\n * **Note**: this specification doesn't rely on selection. It always returns instances no matter\r\n * what the selection is, so pre-filtering should be done in [[ContentRule]] condition and [[instanceFilter]].\r\n *\r\n * @see [More details]($docs/presentation/Content/ContentInstancesOfSpecificClasses.md)\r\n * @public\r\n */\r\nexport interface ContentInstancesOfSpecificClassesSpecification extends ContentSpecificationBase {\r\n  /** Used for serializing to JSON. */\r\n  specType: ContentSpecificationTypes.ContentInstancesOfSpecificClasses;\r\n\r\n  /**\r\n   * List of ECClass specifications whose ECInstances should be selected.\r\n   */\r\n  classes: MultiSchemaClassesSpecification | MultiSchemaClassesSpecification[];\r\n\r\n  /**\r\n   * List of ECClass specifications whose ECInstances should be excluded.\r\n   */\r\n  excludedClasses?: MultiSchemaClassesSpecification | MultiSchemaClassesSpecification[];\r\n\r\n  /**\r\n   * Whether to get content from instances of derived `classes`.\r\n   * Acts as default value for [[classes.arePolymorphic]] and [[excludedClasses.arePolymorphic]].\r\n   * @deprecated Specify polymorphism value inside [[classes.arePolymorphic]] or [[excludedClasses.arePolymorphic]].\r\n   */\r\n  handleInstancesPolymorphically?: boolean;\r\n\r\n  /**\r\n   * Whether to get content from properties of derived `classes`. If `true`, properties from `classes` with no instances\r\n   * do not appear in the result set.\r\n   */\r\n  handlePropertiesPolymorphically?: boolean;\r\n\r\n  /**\r\n   * Condition for filtering instances of defined classes.\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"]}
+{"version":3,"file":"ContentInstancesOfSpecificClassesSpecification.js","sourceRoot":"","sources":["../../../../../src/presentation-common/rules/content/ContentInstancesOfSpecificClassesSpecification.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\n/** @packageDocumentation\r\n * @module PresentationRules\r\n */\r\n\r\nimport { MultiSchemaClassesSpecification } from \"../ClassSpecifications\";\r\nimport { ContentSpecificationBase, ContentSpecificationTypes } from \"./ContentSpecification\";\r\n\r\n/**\r\n * This specification creates content for all instances of specific ECClasses.\r\n *\r\n * @see [Content instances of specific classes specification reference documentation page]($docs/presentation/content/ContentInstancesOfSpecificClasses.md)\r\n * @public\r\n */\r\nexport interface ContentInstancesOfSpecificClassesSpecification extends ContentSpecificationBase {\r\n  /** Used for serializing to JSON. */\r\n  specType: ContentSpecificationTypes.ContentInstancesOfSpecificClasses;\r\n\r\n  /**\r\n   * Defines a set of [multi schema classes]($docs/presentation/MultiSchemaClassesSpecification.md) that specify which\r\n   * ECClasses need to be selected to form the result.\r\n   */\r\n  classes: MultiSchemaClassesSpecification | MultiSchemaClassesSpecification[];\r\n\r\n  /**\r\n   * Defines a set of [multi schema classes]($docs/presentation/MultiSchemaClassesSpecification.md) that prevents specified\r\n   * ECClasses and subclasses from being selected by [[classes]] attribute.\r\n   */\r\n  excludedClasses?: MultiSchemaClassesSpecification | MultiSchemaClassesSpecification[];\r\n\r\n  /**\r\n   * Tells whether selecting instances from ECClasses specified in [[classes]] and [[excludedClasses]]\r\n   * attributes should be polymorphic or not.\r\n   *\r\n   * @deprecated Specify polymorphism value inside [[classes.arePolymorphic]] or [[excludedClasses.arePolymorphic]].\r\n   */\r\n  handleInstancesPolymorphically?: boolean;\r\n\r\n  /**\r\n   * Specifies whether properties of derived [[classes]] should be included in the content.\r\n   */\r\n  handlePropertiesPolymorphically?: boolean;\r\n\r\n  /**\r\n   * Specifies an [ECExpression]($docs/presentation/content/ECExpressions.md#instance-filter) for filtering instances\r\n   * of ECClasses specified through the [[classes]] attribute.\r\n   */\r\n  instanceFilter?: string;\r\n}\r\n"]}

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

@@ -4,24 +4,22 @@
 import { RepeatableRelationshipPathSpecification } from "../RelationshipPathSpecification";
 import { ContentSpecificationBase, ContentSpecificationTypes } from "./ContentSpecification";
 /**
- * Creates content for ECInstance(s) related to current selection.
+ * Returns content for instances related to the selected (input) instances.
  *
- * **Note:** Use [[ContentRule.condition]] to apply specification on correct selection.
- *
- * @see [More details]($docs/presentation/Content/ContentRelatedInstances.md)
+ * @see [Content related instances specification reference documentation page]($docs/presentation/content/ContentRelatedInstances.md)
  * @public
  */
 export interface ContentRelatedInstancesSpecification extends ContentSpecificationBase {
     /** Used for serializing to JSON. */
     specType: ContentSpecificationTypes.ContentRelatedInstances;
     /**
-     * Relationship paths from input (selected) instance class to content class.
+     * Specifies a chain of [relationship path specifications]($docs/presentation/RepeatableRelationshipPathSpecification.md) that
+     * forms a path from an input instance to the output instances. When this array is empty, the specification produces no results.
      */
     relationshipPaths: RepeatableRelationshipPathSpecification[];
     /**
-     * Condition for filtering instances targeted by specified relationship paths.
-     *
-     * **See:** [ECExpressions available in instance filter]($docs/presentation/Content/ECExpressions.md#instance-filter)
+     * Specifies an [ECExpression]($docs/presentation/content/ECExpressions.md#instance-filter) for filtering instances
+     * of ECClasses targeted through the [[relationshipPaths]] attribute.
      */
     instanceFilter?: string;
 }

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

@@ -1 +1 @@
-{"version":3,"file":"ContentRelatedInstancesSpecification.d.ts","sourceRoot":"","sources":["../../../../../src/presentation-common/rules/content/ContentRelatedInstancesSpecification.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,uCAAuC,EAAE,MAAM,kCAAkC,CAAC;AAC3F,OAAO,EAAE,wBAAwB,EAAE,yBAAyB,EAAE,MAAM,wBAAwB,CAAC;AAE7F;;;;;;;GAOG;AACH,MAAM,WAAW,oCAAqC,SAAQ,wBAAwB;IACpF,oCAAoC;IACpC,QAAQ,EAAE,yBAAyB,CAAC,uBAAuB,CAAC;IAE5D;;OAEG;IACH,iBAAiB,EAAE,uCAAuC,EAAE,CAAC;IAE7D;;;;OAIG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;CACzB"}
+{"version":3,"file":"ContentRelatedInstancesSpecification.d.ts","sourceRoot":"","sources":["../../../../../src/presentation-common/rules/content/ContentRelatedInstancesSpecification.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,uCAAuC,EAAE,MAAM,kCAAkC,CAAC;AAC3F,OAAO,EAAE,wBAAwB,EAAE,yBAAyB,EAAE,MAAM,wBAAwB,CAAC;AAE7F;;;;;GAKG;AACH,MAAM,WAAW,oCAAqC,SAAQ,wBAAwB;IACpF,oCAAoC;IACpC,QAAQ,EAAE,yBAAyB,CAAC,uBAAuB,CAAC;IAE5D;;;OAGG;IACH,iBAAiB,EAAE,uCAAuC,EAAE,CAAC;IAE7D;;;OAGG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;CACzB"}

package/lib/cjs/presentation-common/rules/content/ContentRelatedInstancesSpecification.js.map

@@ -1 +1 @@
-{"version":3,"file":"ContentRelatedInstancesSpecification.js","sourceRoot":"","sources":["../../../../../src/presentation-common/rules/content/ContentRelatedInstancesSpecification.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\n/** @packageDocumentation\r\n * @module PresentationRules\r\n */\r\n\r\nimport { RepeatableRelationshipPathSpecification } from \"../RelationshipPathSpecification\";\r\nimport { ContentSpecificationBase, ContentSpecificationTypes } from \"./ContentSpecification\";\r\n\r\n/**\r\n * Creates content for ECInstance(s) related to current selection.\r\n *\r\n * **Note:** Use [[ContentRule.condition]] to apply specification on correct selection.\r\n *\r\n * @see [More details]($docs/presentation/Content/ContentRelatedInstances.md)\r\n * @public\r\n */\r\nexport interface ContentRelatedInstancesSpecification extends ContentSpecificationBase {\r\n  /** Used for serializing to JSON. */\r\n  specType: ContentSpecificationTypes.ContentRelatedInstances;\r\n\r\n  /**\r\n   * Relationship paths from input (selected) instance class to content class.\r\n   */\r\n  relationshipPaths: RepeatableRelationshipPathSpecification[];\r\n\r\n  /**\r\n   * Condition for filtering instances targeted by specified relationship paths.\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"]}
+{"version":3,"file":"ContentRelatedInstancesSpecification.js","sourceRoot":"","sources":["../../../../../src/presentation-common/rules/content/ContentRelatedInstancesSpecification.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\n/** @packageDocumentation\r\n * @module PresentationRules\r\n */\r\n\r\nimport { RepeatableRelationshipPathSpecification } from \"../RelationshipPathSpecification\";\r\nimport { ContentSpecificationBase, ContentSpecificationTypes } from \"./ContentSpecification\";\r\n\r\n/**\r\n * Returns content for instances related to the selected (input) instances.\r\n *\r\n * @see [Content related instances specification reference documentation page]($docs/presentation/content/ContentRelatedInstances.md)\r\n * @public\r\n */\r\nexport interface ContentRelatedInstancesSpecification extends ContentSpecificationBase {\r\n  /** Used for serializing to JSON. */\r\n  specType: ContentSpecificationTypes.ContentRelatedInstances;\r\n\r\n  /**\r\n   * Specifies a chain of [relationship path specifications]($docs/presentation/RepeatableRelationshipPathSpecification.md) that\r\n   * forms a path from an input instance to the output instances. When this array is empty, the specification produces no results.\r\n   */\r\n  relationshipPaths: RepeatableRelationshipPathSpecification[];\r\n\r\n  /**\r\n   * Specifies an [ECExpression]($docs/presentation/content/ECExpressions.md#instance-filter) for filtering instances\r\n   * of ECClasses targeted through the [[relationshipPaths]] attribute.\r\n   */\r\n  instanceFilter?: string;\r\n}\r\n"]}

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

@@ -1,26 +1,31 @@
 /** @packageDocumentation
  * @module PresentationRules
  */
-import { ConditionContainer, RuleBase, RuleTypes } from "../Rule";
+import { RuleBase, RuleTypes } from "../Rule";
 import { ContentSpecification } from "./ContentSpecification";
 /**
- * Defines content that's displayed in content controls (table view,
- * property pane, etc.) and the content that's selected in
- * [unified selection]($docs/presentation/unified-selection/index.md) controls
+ * Content rules are used to define content that is displayed for specific type of [input]($docs/presentation/content/Terminology.md#input-instance).
+ * Input consists of either ECInstances or [nodes]($docs/presentation/hierarchies/Terminology.md#node) and to make things
+ * simpler everything is considered a [node]($docs/presentation/hierarchies/Terminology.md#node) - instances get converted to
+ * *ECInstance nodes* (thus the `SelectedNode` symbol in [`condition` ECExpression]($docs/presentation/content/ECExpressions.md#rule-condition)).
  *
- * @see [More details]($docs/presentation/Content/ContentRule.md)
+ * @see [Content rule reference documentation page]($docs/presentation/content/ContentRule.md)
  * @public
  */
-export interface ContentRule extends RuleBase, ConditionContainer {
+export interface ContentRule extends RuleBase {
     /** Used for serializing to JSON. */
     ruleType: RuleTypes.Content;
     /**
-     * Defines a condition for the rule, which needs to be met in order to execute it. Condition
-     * is an [ECExpression]($docs/presentation/Advanced/ECExpressions.md), which can use
-     * a [limited set of symbols]($docs/presentation/Content/ECExpressions.md#rule-condition).
+     * Defines a condition which needs to be met in order for the rule to be used. The condition is an
+     * [ECExpression]($docs/presentation/content/ECExpressions.md#rule-condition) which has to evaluate to
+     * a boolean value.
      */
     condition?: string;
-    /** Specifications that define content returned by the rule */
+    /**
+     * A list of content specifications that define what content is going to be returned. This is the most
+     * important attribute which is responsible for defining what instances' properties are included in the
+     * returned content.
+     */
     specifications: ContentSpecification[];
 }
 //# sourceMappingURL=ContentRule.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"ContentRule.d.ts","sourceRoot":"","sources":["../../../../../src/presentation-common/rules/content/ContentRule.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,kBAAkB,EAAE,QAAQ,EAAE,SAAS,EAAE,MAAM,SAAS,CAAC;AAClE,OAAO,EAAE,oBAAoB,EAAE,MAAM,wBAAwB,CAAC;AAE9D;;;;;;;GAOG;AACH,MAAM,WAAW,WAAY,SAAQ,QAAQ,EAAE,kBAAkB;IAC/D,oCAAoC;IACpC,QAAQ,EAAE,SAAS,CAAC,OAAO,CAAC;IAE5B;;;;OAIG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB,8DAA8D;IAC9D,cAAc,EAAE,oBAAoB,EAAE,CAAC;CACxC"}
+{"version":3,"file":"ContentRule.d.ts","sourceRoot":"","sources":["../../../../../src/presentation-common/rules/content/ContentRule.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,QAAQ,EAAE,SAAS,EAAE,MAAM,SAAS,CAAC;AAC9C,OAAO,EAAE,oBAAoB,EAAE,MAAM,wBAAwB,CAAC;AAE9D;;;;;;;;GAQG;AACH,MAAM,WAAW,WAAY,SAAQ,QAAQ;IAC3C,oCAAoC;IACpC,QAAQ,EAAE,SAAS,CAAC,OAAO,CAAC;IAE5B;;;;OAIG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;;;OAIG;IACH,cAAc,EAAE,oBAAoB,EAAE,CAAC;CACxC"}

package/lib/cjs/presentation-common/rules/content/ContentRule.js.map

@@ -1 +1 @@
-{"version":3,"file":"ContentRule.js","sourceRoot":"","sources":["../../../../../src/presentation-common/rules/content/ContentRule.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\n/** @packageDocumentation\r\n * @module PresentationRules\r\n */\r\n\r\nimport { ConditionContainer, RuleBase, RuleTypes } from \"../Rule\";\r\nimport { ContentSpecification } from \"./ContentSpecification\";\r\n\r\n/**\r\n * Defines content that's displayed in content controls (table view,\r\n * property pane, etc.) and the content that's selected in\r\n * [unified selection]($docs/presentation/unified-selection/index.md) controls\r\n *\r\n * @see [More details]($docs/presentation/Content/ContentRule.md)\r\n * @public\r\n */\r\nexport interface ContentRule extends RuleBase, ConditionContainer {\r\n  /** Used for serializing to JSON. */\r\n  ruleType: RuleTypes.Content;\r\n\r\n  /**\r\n   * Defines a condition for the rule, which needs to be met in order to execute it. Condition\r\n   * is an [ECExpression]($docs/presentation/Advanced/ECExpressions.md), which can use\r\n   * a [limited set of symbols]($docs/presentation/Content/ECExpressions.md#rule-condition).\r\n   */\r\n  condition?: string;\r\n\r\n  /** Specifications that define content returned by the rule */\r\n  specifications: ContentSpecification[];\r\n}\r\n"]}
+{"version":3,"file":"ContentRule.js","sourceRoot":"","sources":["../../../../../src/presentation-common/rules/content/ContentRule.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\n/** @packageDocumentation\r\n * @module PresentationRules\r\n */\r\n\r\nimport { RuleBase, RuleTypes } from \"../Rule\";\r\nimport { ContentSpecification } from \"./ContentSpecification\";\r\n\r\n/**\r\n * Content rules are used to define content that is displayed for specific type of [input]($docs/presentation/content/Terminology.md#input-instance).\r\n * Input consists of either ECInstances or [nodes]($docs/presentation/hierarchies/Terminology.md#node) and to make things\r\n * simpler everything is considered a [node]($docs/presentation/hierarchies/Terminology.md#node) - instances get converted to\r\n * *ECInstance nodes* (thus the `SelectedNode` symbol in [`condition` ECExpression]($docs/presentation/content/ECExpressions.md#rule-condition)).\r\n *\r\n * @see [Content rule reference documentation page]($docs/presentation/content/ContentRule.md)\r\n * @public\r\n */\r\nexport interface ContentRule extends RuleBase {\r\n  /** Used for serializing to JSON. */\r\n  ruleType: RuleTypes.Content;\r\n\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/content/ECExpressions.md#rule-condition) which has to evaluate to\r\n   * a boolean value.\r\n   */\r\n  condition?: string;\r\n\r\n  /**\r\n   * A list of content specifications that define what content is going to be returned. This is the most\r\n   * important attribute which is responsible for defining what instances' properties are included in the\r\n   * returned content.\r\n   */\r\n  specifications: ContentSpecification[];\r\n}\r\n"]}

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

@@ -25,18 +25,24 @@ export interface ContentSpecificationBase extends ContentModifiersList {
     /** Used for serializing to JSON. */
     specType: ContentSpecificationTypes;
     /**
-     * Defines the order in which specifications are evaluated and executed. Defaults to `1000`.
+     * Controls the order in which specifications are handled — specification with higher priority value is handled
+     * first. If priorities are equal, the specifications are handled in the order they appear in the ruleset.
      *
      * @type integer
      */
     priority?: number;
-    /** Should each content record be assigned an image id */
+    /**
+     * Should image IDs be calculated for the returned instances. When `true`, [[ImageIdOverride]] rules get applied when
+     * creating the content.
+     *
+     * @deprecated Use [[ExtendedDataRule]] instead. See [extended data usage page]($docs/presentation/customization/ExtendedDataUsage.md) for more details.
+     */
     showImages?: boolean;
-    /** Specifications for joining related instances */
+    /** Specifications of [related instances]($docs/presentation/RelatedInstanceSpecification.md) that can be used when creating the content. */
     relatedInstances?: RelatedInstanceSpecification[];
     /**
-     * Identifies whether we should ignore this specification if there is already an existing specification
-     * with higher `priority` that already provides content.
+     * Specifies whether this specification should be ignored if another specification was handled before as
+     * determined by rule and specification priorities. This provides a mechanism for defining a fallback specification.
      */
     onlyIfNotHandled?: boolean;
 }

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

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