@itwin/presentation-common 4.0.0-dev.48 → 4.0.0-dev.51

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

@@ -1,57 +1,57 @@
-/** @packageDocumentation
- * @module PresentationRules
- */
-import { SingleSchemaClassSpecification } from "./ClassSpecifications";
-import { RelationshipDirection } from "./RelationshipDirection";
-/**
- * Specification of a single step in [[RelationshipPathSpecification]].
- *
- * @see [Relationship path specification reference documentation page]($docs/presentation/RelationshipPathSpecification.md)
- * @public
- */
-export interface RelationshipStepSpecification {
-    /** This attribute specifies the ECRelationship that should be used to traverse to target class. */
-    relationship: SingleSchemaClassSpecification;
-    /**
-     * This attribute specifies the direction in which the [[relationship]] should be followed.
-     * @see RelationshipDirection
-     */
-    direction: `${RelationshipDirection}`;
-    /**
-     * This attribute may be used to specialize the target of the relationship.
-     */
-    targetClass?: SingleSchemaClassSpecification;
-}
-/**
- * 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 {
-    /**
-     * 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 | "*";
-}
-/**
- * Relationship path specification is used to define a relationship path to an ECClass.
- *
- * @see [Relationship path specification reference documentation page]($docs/presentation/RelationshipPathSpecification.md)
- * @public
- */
-export declare type RelationshipPathSpecification = RelationshipStepSpecification | RelationshipStepSpecification[];
-/**
- * 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 [Repeatable relationship path specification reference documentation page]($docs/presentation/RepeatableRelationshipPathSpecification.md)
- * @public
- */
-export declare type RepeatableRelationshipPathSpecification = RepeatableRelationshipStepSpecification | RepeatableRelationshipStepSpecification[];
+/** @packageDocumentation
+ * @module PresentationRules
+ */
+import { SingleSchemaClassSpecification } from "./ClassSpecifications";
+import { RelationshipDirection } from "./RelationshipDirection";
+/**
+ * Specification of a single step in [[RelationshipPathSpecification]].
+ *
+ * @see [Relationship path specification reference documentation page]($docs/presentation/RelationshipPathSpecification.md)
+ * @public
+ */
+export interface RelationshipStepSpecification {
+    /** This attribute specifies the ECRelationship that should be used to traverse to target class. */
+    relationship: SingleSchemaClassSpecification;
+    /**
+     * This attribute specifies the direction in which the [[relationship]] should be followed.
+     * @see RelationshipDirection
+     */
+    direction: `${RelationshipDirection}`;
+    /**
+     * This attribute may be used to specialize the target of the relationship.
+     */
+    targetClass?: SingleSchemaClassSpecification;
+}
+/**
+ * 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 {
+    /**
+     * 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 | "*";
+}
+/**
+ * Relationship path specification is used to define a relationship path to an ECClass.
+ *
+ * @see [Relationship path specification reference documentation page]($docs/presentation/RelationshipPathSpecification.md)
+ * @public
+ */
+export declare type RelationshipPathSpecification = RelationshipStepSpecification | RelationshipStepSpecification[];
+/**
+ * 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 [Repeatable relationship path specification reference documentation page]($docs/presentation/RepeatableRelationshipPathSpecification.md)
+ * @public
+ */
+export declare type RepeatableRelationshipPathSpecification = RepeatableRelationshipStepSpecification | RepeatableRelationshipStepSpecification[];
 //# sourceMappingURL=RelationshipPathSpecification.d.ts.map

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

@@ -1,9 +1,9 @@
-/*---------------------------------------------------------------------------------------------
-* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
-* See LICENSE.md in the project root for license terms and full copyright notice.
-*--------------------------------------------------------------------------------------------*/
-/** @packageDocumentation
- * @module PresentationRules
- */
-export {};
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+/** @packageDocumentation
+ * @module PresentationRules
+ */
+export {};
 //# sourceMappingURL=RelationshipPathSpecification.js.map

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

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

@@ -1,77 +1,77 @@
-/** @packageDocumentation
- * @module PresentationRules
- */
-import { ContentRule } from "./content/ContentRule";
-import { DefaultPropertyCategoryOverride } from "./content/DefaultPropertyCategoryOverride";
-import { ContentModifier } from "./content/modifiers/ContentModifier";
-import { CustomizationRule } from "./customization/CustomizationRule";
-import { NavigationRule } from "./hierarchy/NavigationRule";
-import { RequiredSchemaSpecification } from "./SchemasSpecification";
-/**
- * Base interface for all [[Rule]] implementations.
- * @public
- */
-export interface RuleBase {
-    /**
-     * Used for serializing to JSON.
-     * @see RuleTypes
-     */
-    ruleType: `${RuleTypes}`;
-    /**
-     * 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;
-    /**
-     * 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;
-    /**
-     * A list of [ECSchema requirements]($docs/presentation/RequiredSchemaSpecification.md) that need to be met for the rule to be used.
-     */
-    requiredSchemas?: RequiredSchemaSpecification[];
-}
-/**
- * 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]].
- *
- * @deprecated in 3.x. 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?: string;
-}
-/**
- * Used for serializing [[Rule]] objects to JSON.
- * @public
- */
-export declare enum RuleTypes {
-    RootNodes = "RootNodes",
-    ChildNodes = "ChildNodes",
-    Content = "Content",
-    ContentModifier = "ContentModifier",
-    DefaultPropertyCategoryOverride = "DefaultPropertyCategoryOverride",
-    Grouping = "Grouping",
-    PropertySorting = "PropertySorting",
-    DisabledSorting = "DisabledSorting",
-    NodeArtifacts = "NodeArtifacts",
-    InstanceLabelOverride = "InstanceLabelOverride",
-    LabelOverride = "LabelOverride",
-    CheckBox = "CheckBox",
-    ImageIdOverride = "ImageIdOverride",
-    StyleOverride = "StyleOverride",
-    ExtendedData = "ExtendedData"
-}
+/** @packageDocumentation
+ * @module PresentationRules
+ */
+import { ContentRule } from "./content/ContentRule";
+import { DefaultPropertyCategoryOverride } from "./content/DefaultPropertyCategoryOverride";
+import { ContentModifier } from "./content/modifiers/ContentModifier";
+import { CustomizationRule } from "./customization/CustomizationRule";
+import { NavigationRule } from "./hierarchy/NavigationRule";
+import { RequiredSchemaSpecification } from "./SchemasSpecification";
+/**
+ * Base interface for all [[Rule]] implementations.
+ * @public
+ */
+export interface RuleBase {
+    /**
+     * Used for serializing to JSON.
+     * @see RuleTypes
+     */
+    ruleType: `${RuleTypes}`;
+    /**
+     * 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;
+    /**
+     * 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;
+    /**
+     * A list of [ECSchema requirements]($docs/presentation/RequiredSchemaSpecification.md) that need to be met for the rule to be used.
+     */
+    requiredSchemas?: RequiredSchemaSpecification[];
+}
+/**
+ * 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]].
+ *
+ * @deprecated in 3.x. 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?: string;
+}
+/**
+ * Used for serializing [[Rule]] objects to JSON.
+ * @public
+ */
+export declare enum RuleTypes {
+    RootNodes = "RootNodes",
+    ChildNodes = "ChildNodes",
+    Content = "Content",
+    ContentModifier = "ContentModifier",
+    DefaultPropertyCategoryOverride = "DefaultPropertyCategoryOverride",
+    Grouping = "Grouping",
+    PropertySorting = "PropertySorting",
+    DisabledSorting = "DisabledSorting",
+    NodeArtifacts = "NodeArtifacts",
+    InstanceLabelOverride = "InstanceLabelOverride",
+    LabelOverride = "LabelOverride",
+    CheckBox = "CheckBox",
+    ImageIdOverride = "ImageIdOverride",
+    StyleOverride = "StyleOverride",
+    ExtendedData = "ExtendedData"
+}
 //# sourceMappingURL=Rule.d.ts.map

package/lib/esm/presentation-common/rules/Rule.js

@@ -1,33 +1,33 @@
-/*---------------------------------------------------------------------------------------------
-* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
-* See LICENSE.md in the project root for license terms and full copyright notice.
-*--------------------------------------------------------------------------------------------*/
-/** @packageDocumentation
- * @module PresentationRules
- */
-/**
- * Used for serializing [[Rule]] objects to JSON.
- * @public
- */
-export var RuleTypes;
-(function (RuleTypes) {
-    // hierarchy rules
-    RuleTypes["RootNodes"] = "RootNodes";
-    RuleTypes["ChildNodes"] = "ChildNodes";
-    // content rules
-    RuleTypes["Content"] = "Content";
-    RuleTypes["ContentModifier"] = "ContentModifier";
-    RuleTypes["DefaultPropertyCategoryOverride"] = "DefaultPropertyCategoryOverride";
-    // customization rules
-    RuleTypes["Grouping"] = "Grouping";
-    RuleTypes["PropertySorting"] = "PropertySorting";
-    RuleTypes["DisabledSorting"] = "DisabledSorting";
-    RuleTypes["NodeArtifacts"] = "NodeArtifacts";
-    RuleTypes["InstanceLabelOverride"] = "InstanceLabelOverride";
-    RuleTypes["LabelOverride"] = "LabelOverride";
-    RuleTypes["CheckBox"] = "CheckBox";
-    RuleTypes["ImageIdOverride"] = "ImageIdOverride";
-    RuleTypes["StyleOverride"] = "StyleOverride";
-    RuleTypes["ExtendedData"] = "ExtendedData";
-})(RuleTypes || (RuleTypes = {}));
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+/** @packageDocumentation
+ * @module PresentationRules
+ */
+/**
+ * Used for serializing [[Rule]] objects to JSON.
+ * @public
+ */
+export var RuleTypes;
+(function (RuleTypes) {
+    // hierarchy rules
+    RuleTypes["RootNodes"] = "RootNodes";
+    RuleTypes["ChildNodes"] = "ChildNodes";
+    // content rules
+    RuleTypes["Content"] = "Content";
+    RuleTypes["ContentModifier"] = "ContentModifier";
+    RuleTypes["DefaultPropertyCategoryOverride"] = "DefaultPropertyCategoryOverride";
+    // customization rules
+    RuleTypes["Grouping"] = "Grouping";
+    RuleTypes["PropertySorting"] = "PropertySorting";
+    RuleTypes["DisabledSorting"] = "DisabledSorting";
+    RuleTypes["NodeArtifacts"] = "NodeArtifacts";
+    RuleTypes["InstanceLabelOverride"] = "InstanceLabelOverride";
+    RuleTypes["LabelOverride"] = "LabelOverride";
+    RuleTypes["CheckBox"] = "CheckBox";
+    RuleTypes["ImageIdOverride"] = "ImageIdOverride";
+    RuleTypes["StyleOverride"] = "StyleOverride";
+    RuleTypes["ExtendedData"] = "ExtendedData";
+})(RuleTypes || (RuleTypes = {}));
 //# sourceMappingURL=Rule.js.map

package/lib/esm/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;AA6DH;;;GAGG;AACH,MAAM,CAAN,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,KAAT,SAAS,QAqBpB","sourcesContent":["/*---------------------------------------------------------------------------------------------\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n* See LICENSE.md in the project root for license terms and full copyright notice.\n*--------------------------------------------------------------------------------------------*/\n/** @packageDocumentation\n * @module PresentationRules\n */\n\nimport { ContentRule } from \"./content/ContentRule\";\nimport { DefaultPropertyCategoryOverride } from \"./content/DefaultPropertyCategoryOverride\";\nimport { ContentModifier } from \"./content/modifiers/ContentModifier\";\nimport { CustomizationRule } from \"./customization/CustomizationRule\";\nimport { NavigationRule } from \"./hierarchy/NavigationRule\";\nimport { RequiredSchemaSpecification } from \"./SchemasSpecification\";\n\n/**\n * Base interface for all [[Rule]] implementations.\n * @public\n */\nexport interface RuleBase {\n  /**\n   * Used for serializing to JSON.\n   * @see RuleTypes\n   */\n  ruleType: `${RuleTypes}`;\n\n  /**\n   * Defines the order in which rules are handled, higher number means the rule is handled first. If priorities are\n   * equal, the rules are handled in the order they're defined.\n   *\n   * @type integer\n   */\n  priority?: number;\n\n  /**\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\n   * priorities and definition order). This allows adding fallback rules which can be overriden by higher-priority rules.\n   */\n  onlyIfNotHandled?: boolean;\n\n  /**\n   * A list of [ECSchema requirements]($docs/presentation/RequiredSchemaSpecification.md) that need to be met for the rule to be used.\n   */\n  requiredSchemas?: RequiredSchemaSpecification[];\n}\n\n/**\n * A union of all presentation rule types.\n * @public\n */\nexport declare type Rule = CustomizationRule | NavigationRule | ContentRule | ContentModifier | DefaultPropertyCategoryOverride;\n\n/**\n * Container of a [[condition]] property. Used for rules that support conditions. Not\n * meant to be used directly, see [[Rule]].\n *\n * @deprecated in 3.x. This interface is not used anymore. All interfaces that used to extend it, have the [[condition]]\n * attribute of their own.\n * @public\n */\nexport interface ConditionContainer {\n  /**\n   * Defines a condition for the rule, which needs to be met in order to execute it.\n   */\n  condition?: string;\n}\n\n/**\n * Used for serializing [[Rule]] objects to JSON.\n * @public\n */\nexport enum RuleTypes {\n  // hierarchy rules\n  RootNodes = \"RootNodes\",\n  ChildNodes = \"ChildNodes\",\n\n  // content rules\n  Content = \"Content\",\n  ContentModifier = \"ContentModifier\", // eslint-disable-line @typescript-eslint/no-shadow\n  DefaultPropertyCategoryOverride = \"DefaultPropertyCategoryOverride\", // eslint-disable-line @typescript-eslint/no-shadow\n\n  // customization rules\n  Grouping = \"Grouping\",\n  PropertySorting = \"PropertySorting\",\n  DisabledSorting = \"DisabledSorting\",\n  NodeArtifacts = \"NodeArtifacts\",\n  InstanceLabelOverride = \"InstanceLabelOverride\",\n  LabelOverride = \"LabelOverride\",\n  CheckBox = \"CheckBox\",\n  ImageIdOverride = \"ImageIdOverride\",\n  StyleOverride = \"StyleOverride\",\n  ExtendedData = \"ExtendedData\",\n}\n"]}
+{"version":3,"file":"Rule.js","sourceRoot":"","sources":["../../../../src/presentation-common/rules/Rule.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AA6DH;;;GAGG;AACH,MAAM,CAAN,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,KAAT,SAAS,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  /**\r\n   * Used for serializing to JSON.\r\n   * @see RuleTypes\r\n   */\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   */\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 in 3.x. 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/esm/presentation-common/rules/Ruleset.d.ts

@@ -1,66 +1,66 @@
-/** @packageDocumentation
- * @module PresentationRules
- */
-import { Rule } from "./Rule";
-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 library. The ruleset consists of:
- * - Ruleset options
- * - Hierarchy rules:
- *   - Root node rules
- *   - Child node rules
- * - 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 {
-    /**
-     * Ruleset identifier. This ID is used to bind UI components with the specific rule set.
-     *
-     * @minLength 1
-     */
-    id: string;
-    /**
-     * Version of the presentation ruleset in SemVer format: `{major}.{minor}.{patch}`.
-     *
-     * 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 rulesets with the same id.
-     *
-     * Defaults to `0.0.0`.
-     *
-     * @pattern ^[\d]+\.[\d]+\.[\d]+$
-     * @beta
-     */
-    version?: string;
-    /**
-     * Schema requirements for this ruleset. The ruleset is not used if the requirements are not met.
-     */
-    requiredSchemas?: RequiredSchemaSpecification[];
-    /** Supplementation-related information for this ruleset */
-    supplementationInfo?: SupplementationInfo;
-    /** User-controllable variable definitions */
-    vars?: VariablesGroup[];
-    /** Presentation rules used to create hierarchies and content */
-    rules: Rule[];
-}
-/**
- * Contains supplementation-related information for
- * [supplemental rulesets]($docs/presentation/advanced/RulesetSupplementation.md).
- *
- * @public
- */
-export interface SupplementationInfo {
-    /**
-     * Identifies why supplementation is done and uniquely identifies particular supplemental ruleset.
-     * There can be only one supplemental rule set with the same [[Ruleset.id]] and [[supplementationPurpose]].
-     */
-    supplementationPurpose: string;
-}
+/** @packageDocumentation
+ * @module PresentationRules
+ */
+import { Rule } from "./Rule";
+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 library. The ruleset consists of:
+ * - Ruleset options
+ * - Hierarchy rules:
+ *   - Root node rules
+ *   - Child node rules
+ * - 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 {
+    /**
+     * Ruleset identifier. This ID is used to bind UI components with the specific rule set.
+     *
+     * @minLength 1
+     */
+    id: string;
+    /**
+     * Version of the presentation ruleset in SemVer format: `{major}.{minor}.{patch}`.
+     *
+     * 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 rulesets with the same id.
+     *
+     * Defaults to `0.0.0`.
+     *
+     * @pattern ^[\d]+\.[\d]+\.[\d]+$
+     * @beta
+     */
+    version?: string;
+    /**
+     * Schema requirements for this ruleset. The ruleset is not used if the requirements are not met.
+     */
+    requiredSchemas?: RequiredSchemaSpecification[];
+    /** Supplementation-related information for this ruleset */
+    supplementationInfo?: SupplementationInfo;
+    /** User-controllable variable definitions */
+    vars?: VariablesGroup[];
+    /** Presentation rules used to create hierarchies and content */
+    rules: Rule[];
+}
+/**
+ * Contains supplementation-related information for
+ * [supplemental rulesets]($docs/presentation/advanced/RulesetSupplementation.md).
+ *
+ * @public
+ */
+export interface SupplementationInfo {
+    /**
+     * Identifies why supplementation is done and uniquely identifies particular supplemental ruleset.
+     * There can be only one supplemental rule set with the same [[Ruleset.id]] and [[supplementationPurpose]].
+     */
+    supplementationPurpose: string;
+}
 //# sourceMappingURL=Ruleset.d.ts.map

package/lib/esm/presentation-common/rules/Ruleset.js

@@ -1,9 +1,9 @@
-/*---------------------------------------------------------------------------------------------
-* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
-* See LICENSE.md in the project root for license terms and full copyright notice.
-*--------------------------------------------------------------------------------------------*/
-/** @packageDocumentation
- * @module PresentationRules
- */
-export {};
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+/** @packageDocumentation
+ * @module PresentationRules
+ */
+export {};
 //# sourceMappingURL=Ruleset.js.map

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