@itwin/presentation-common 4.0.0-dev.17 → 4.0.0-dev.18

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

@@ -1,109 +1,109 @@
-/** @packageDocumentation
- * @module PresentationRules
- */
-/**
- * This specification allows assigning a custom property editor to specific properties.
- *
- * @see [Property editor specification specification reference documentation page]($docs/presentation/content/PropertyEditorSpecification.md)
- * @public
- */
-export interface PropertyEditorSpecification {
-    /**
-     * Name of the property editor that's going to be used in UI components. This name is carried over to
-     * [[Field.editor]] and it's up to the UI component to make sure appropriate editor
-     * is used to edit the property.
-     */
-    editorName: string;
-    /**
-     * Parameters for the editor.
-     * @note At this moment the attribute is not used.
-     * @public
-     */
-    parameters?: PropertyEditorParameters[];
-}
-/**
- * Parameters for [[PropertyEditorSpecification]]
- * @public
- */
-export declare type PropertyEditorParameters = PropertyEditorJsonParameters | PropertyEditorMultilineParameters | PropertyEditorRangeParameters | PropertyEditorSliderParameters;
-/**
- * Used for serializing array of [[PropertyEditorParameters]] to JSON
- * @public
- */
-export declare enum PropertyEditorParameterTypes {
-    Json = "Json",
-    Multiline = "Multiline",
-    Range = "Range",
-    Slider = "Slider"
-}
-/**
- * Base interface for [[PropertyEditorParameters]]. Not meant
- * to be used directly, see `PropertyEditorParameters`.
- * @public
- */
-export interface PropertyEditorParametersBase {
-    /**
-     * Used for serializing to JSON.
-     * @see PropertyEditorParameterTypes
-     */
-    paramsType: `${PropertyEditorParameterTypes}`;
-}
-/**
- * Arbitrary JSON parameters for custom property editors
- * @public
- */
-export interface PropertyEditorJsonParameters extends PropertyEditorParametersBase {
-    /** Used for serializing to JSON. */
-    paramsType: "Json";
-    /** Arbitrary JSON that can be handled by a property editor */
-    json: any;
-}
-/**
- * Multiline parameters for property editors that support multiline display
- * @public
- */
-export interface PropertyEditorMultilineParameters extends PropertyEditorParametersBase {
-    /** Used for serializing to JSON. */
-    paramsType: "Multiline";
-    /**
-     * Number of lines. Defaults to `1`.
-     *
-     * @type integer
-     * @minimum 1
-     */
-    height?: number;
-}
-/**
- * Range parameters for property editors that support ranges
- * @public
- */
-export interface PropertyEditorRangeParameters extends PropertyEditorParametersBase {
-    /** Used for serializing to JSON. */
-    paramsType: "Range";
-    /** Minimum value of the range. */
-    min?: number;
-    /** Maximum value of the range. */
-    max?: number;
-}
-/**
- * Slider parameters for property editors that support slider display
- * @public
- */
-export interface PropertyEditorSliderParameters extends PropertyEditorParametersBase {
-    /** Used for serializing to JSON. */
-    paramsType: "Slider";
-    /** Minimum value that can be set. */
-    min: number;
-    /** Maximum value that can be set. */
-    max: number;
-    /**
-     * Count of intervals. Defaults to `1`.
-     *
-     * @type integer
-     * @minimum 1
-     */
-    intervalsCount?: number;
-    /** Is slider vertical. */
-    isVertical?: boolean;
-}
+/** @packageDocumentation
+ * @module PresentationRules
+ */
+/**
+ * This specification allows assigning a custom property editor to specific properties.
+ *
+ * @see [Property editor specification specification reference documentation page]($docs/presentation/content/PropertyEditorSpecification.md)
+ * @public
+ */
+export interface PropertyEditorSpecification {
+    /**
+     * Name of the property editor that's going to be used in UI components. This name is carried over to
+     * [[Field.editor]] and it's up to the UI component to make sure appropriate editor
+     * is used to edit the property.
+     */
+    editorName: string;
+    /**
+     * Parameters for the editor.
+     * @note At this moment the attribute is not used.
+     * @public
+     */
+    parameters?: PropertyEditorParameters[];
+}
+/**
+ * Parameters for [[PropertyEditorSpecification]]
+ * @public
+ */
+export declare type PropertyEditorParameters = PropertyEditorJsonParameters | PropertyEditorMultilineParameters | PropertyEditorRangeParameters | PropertyEditorSliderParameters;
+/**
+ * Used for serializing array of [[PropertyEditorParameters]] to JSON
+ * @public
+ */
+export declare enum PropertyEditorParameterTypes {
+    Json = "Json",
+    Multiline = "Multiline",
+    Range = "Range",
+    Slider = "Slider"
+}
+/**
+ * Base interface for [[PropertyEditorParameters]]. Not meant
+ * to be used directly, see `PropertyEditorParameters`.
+ * @public
+ */
+export interface PropertyEditorParametersBase {
+    /**
+     * Used for serializing to JSON.
+     * @see PropertyEditorParameterTypes
+     */
+    paramsType: `${PropertyEditorParameterTypes}`;
+}
+/**
+ * Arbitrary JSON parameters for custom property editors
+ * @public
+ */
+export interface PropertyEditorJsonParameters extends PropertyEditorParametersBase {
+    /** Used for serializing to JSON. */
+    paramsType: "Json";
+    /** Arbitrary JSON that can be handled by a property editor */
+    json: any;
+}
+/**
+ * Multiline parameters for property editors that support multiline display
+ * @public
+ */
+export interface PropertyEditorMultilineParameters extends PropertyEditorParametersBase {
+    /** Used for serializing to JSON. */
+    paramsType: "Multiline";
+    /**
+     * Number of lines. Defaults to `1`.
+     *
+     * @type integer
+     * @minimum 1
+     */
+    height?: number;
+}
+/**
+ * Range parameters for property editors that support ranges
+ * @public
+ */
+export interface PropertyEditorRangeParameters extends PropertyEditorParametersBase {
+    /** Used for serializing to JSON. */
+    paramsType: "Range";
+    /** Minimum value of the range. */
+    min?: number;
+    /** Maximum value of the range. */
+    max?: number;
+}
+/**
+ * Slider parameters for property editors that support slider display
+ * @public
+ */
+export interface PropertyEditorSliderParameters extends PropertyEditorParametersBase {
+    /** Used for serializing to JSON. */
+    paramsType: "Slider";
+    /** Minimum value that can be set. */
+    min: number;
+    /** Maximum value that can be set. */
+    max: number;
+    /**
+     * Count of intervals. Defaults to `1`.
+     *
+     * @type integer
+     * @minimum 1
+     */
+    intervalsCount?: number;
+    /** Is slider vertical. */
+    isVertical?: boolean;
+}
 //# sourceMappingURL=PropertyEditorsSpecification.d.ts.map

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

@@ -1,19 +1,19 @@
-/*---------------------------------------------------------------------------------------------
-* 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 array of [[PropertyEditorParameters]] to JSON
- * @public
- */
-export var PropertyEditorParameterTypes;
-(function (PropertyEditorParameterTypes) {
-    PropertyEditorParameterTypes["Json"] = "Json";
-    PropertyEditorParameterTypes["Multiline"] = "Multiline";
-    PropertyEditorParameterTypes["Range"] = "Range";
-    PropertyEditorParameterTypes["Slider"] = "Slider";
-})(PropertyEditorParameterTypes || (PropertyEditorParameterTypes = {}));
+/*---------------------------------------------------------------------------------------------
+* 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 array of [[PropertyEditorParameters]] to JSON
+ * @public
+ */
+export var PropertyEditorParameterTypes;
+(function (PropertyEditorParameterTypes) {
+    PropertyEditorParameterTypes["Json"] = "Json";
+    PropertyEditorParameterTypes["Multiline"] = "Multiline";
+    PropertyEditorParameterTypes["Range"] = "Range";
+    PropertyEditorParameterTypes["Slider"] = "Slider";
+})(PropertyEditorParameterTypes || (PropertyEditorParameterTypes = {}));
 //# sourceMappingURL=PropertyEditorsSpecification.js.map

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

@@ -1 +1 @@
-{"version":3,"file":"PropertyEditorsSpecification.js","sourceRoot":"","sources":["../../../../../../src/presentation-common/rules/content/modifiers/PropertyEditorsSpecification.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AA8BH;;;GAGG;AACH,MAAM,CAAN,IAAY,4BAKX;AALD,WAAY,4BAA4B;IACtC,6CAAa,CAAA;IACb,uDAAuB,CAAA;IACvB,+CAAe,CAAA;IACf,iDAAiB,CAAA;AACnB,CAAC,EALW,4BAA4B,KAA5B,4BAA4B,QAKvC","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\n/**\n * This specification allows assigning a custom property editor to specific properties.\n *\n * @see [Property editor specification specification reference documentation page]($docs/presentation/content/PropertyEditorSpecification.md)\n * @public\n */\nexport interface PropertyEditorSpecification {\n  /**\n   * Name of the property editor that's going to be used in UI components. This name is carried over to\n   * [[Field.editor]] and it's up to the UI component to make sure appropriate editor\n   * is used to edit the property.\n   */\n  editorName: string;\n\n  /**\n   * Parameters for the editor.\n   * @note At this moment the attribute is not used.\n   * @public\n   */\n  parameters?: PropertyEditorParameters[];\n}\n\n/**\n * Parameters for [[PropertyEditorSpecification]]\n * @public\n */\nexport declare type PropertyEditorParameters = PropertyEditorJsonParameters | PropertyEditorMultilineParameters | PropertyEditorRangeParameters | PropertyEditorSliderParameters;\n\n/**\n * Used for serializing array of [[PropertyEditorParameters]] to JSON\n * @public\n */\nexport enum PropertyEditorParameterTypes {\n  Json = \"Json\",\n  Multiline = \"Multiline\",\n  Range = \"Range\",\n  Slider = \"Slider\",\n}\n\n/**\n * Base interface for [[PropertyEditorParameters]]. Not meant\n * to be used directly, see `PropertyEditorParameters`.\n * @public\n */\nexport interface PropertyEditorParametersBase {\n  /**\n   * Used for serializing to JSON.\n   * @see PropertyEditorParameterTypes\n   */\n  paramsType: `${PropertyEditorParameterTypes}`;\n}\n\n/**\n * Arbitrary JSON parameters for custom property editors\n * @public\n */\nexport interface PropertyEditorJsonParameters extends PropertyEditorParametersBase {\n  /** Used for serializing to JSON. */\n  paramsType: \"Json\";\n\n  /** Arbitrary JSON that can be handled by a property editor */\n  json: any;\n}\n\n/**\n * Multiline parameters for property editors that support multiline display\n * @public\n */\nexport interface PropertyEditorMultilineParameters extends PropertyEditorParametersBase {\n  /** Used for serializing to JSON. */\n  paramsType: \"Multiline\";\n\n  /**\n   * Number of lines. Defaults to `1`.\n   *\n   * @type integer\n   * @minimum 1\n   */\n  height?: number;\n}\n\n/**\n * Range parameters for property editors that support ranges\n * @public\n */\nexport interface PropertyEditorRangeParameters extends PropertyEditorParametersBase {\n  /** Used for serializing to JSON. */\n  paramsType: \"Range\";\n\n  /** Minimum value of the range. */\n  min?: number;\n\n  /** Maximum value of the range. */\n  max?: number;\n}\n\n/**\n * Slider parameters for property editors that support slider display\n * @public\n */\nexport interface PropertyEditorSliderParameters extends PropertyEditorParametersBase {\n  /** Used for serializing to JSON. */\n  paramsType: \"Slider\";\n\n  /** Minimum value that can be set. */\n  min: number;\n\n  /** Maximum value that can be set. */\n  max: number;\n\n  /**\n   * Count of intervals. Defaults to `1`.\n   *\n   * @type integer\n   * @minimum 1\n   */\n  intervalsCount?: number;\n\n  /** Is slider vertical. */\n  isVertical?: boolean;\n}\n"]}
+{"version":3,"file":"PropertyEditorsSpecification.js","sourceRoot":"","sources":["../../../../../../src/presentation-common/rules/content/modifiers/PropertyEditorsSpecification.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AA8BH;;;GAGG;AACH,MAAM,CAAN,IAAY,4BAKX;AALD,WAAY,4BAA4B;IACtC,6CAAa,CAAA;IACb,uDAAuB,CAAA;IACvB,+CAAe,CAAA;IACf,iDAAiB,CAAA;AACnB,CAAC,EALW,4BAA4B,KAA5B,4BAA4B,QAKvC","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 * This specification allows assigning a custom property editor to specific properties.\r\n *\r\n * @see [Property editor specification specification reference documentation page]($docs/presentation/content/PropertyEditorSpecification.md)\r\n * @public\r\n */\r\nexport interface PropertyEditorSpecification {\r\n  /**\r\n   * Name of the property editor that's going to be used in UI components. This name is carried over to\r\n   * [[Field.editor]] and it's up to the UI component to make sure appropriate editor\r\n   * is used to edit the property.\r\n   */\r\n  editorName: string;\r\n\r\n  /**\r\n   * Parameters for the editor.\r\n   * @note At this moment the attribute is not used.\r\n   * @public\r\n   */\r\n  parameters?: PropertyEditorParameters[];\r\n}\r\n\r\n/**\r\n * Parameters for [[PropertyEditorSpecification]]\r\n * @public\r\n */\r\nexport declare type PropertyEditorParameters = PropertyEditorJsonParameters | PropertyEditorMultilineParameters | PropertyEditorRangeParameters | PropertyEditorSliderParameters;\r\n\r\n/**\r\n * Used for serializing array of [[PropertyEditorParameters]] to JSON\r\n * @public\r\n */\r\nexport enum PropertyEditorParameterTypes {\r\n  Json = \"Json\",\r\n  Multiline = \"Multiline\",\r\n  Range = \"Range\",\r\n  Slider = \"Slider\",\r\n}\r\n\r\n/**\r\n * Base interface for [[PropertyEditorParameters]]. Not meant\r\n * to be used directly, see `PropertyEditorParameters`.\r\n * @public\r\n */\r\nexport interface PropertyEditorParametersBase {\r\n  /**\r\n   * Used for serializing to JSON.\r\n   * @see PropertyEditorParameterTypes\r\n   */\r\n  paramsType: `${PropertyEditorParameterTypes}`;\r\n}\r\n\r\n/**\r\n * Arbitrary JSON parameters for custom property editors\r\n * @public\r\n */\r\nexport interface PropertyEditorJsonParameters extends PropertyEditorParametersBase {\r\n  /** Used for serializing to JSON. */\r\n  paramsType: \"Json\";\r\n\r\n  /** Arbitrary JSON that can be handled by a property editor */\r\n  json: any;\r\n}\r\n\r\n/**\r\n * Multiline parameters for property editors that support multiline display\r\n * @public\r\n */\r\nexport interface PropertyEditorMultilineParameters extends PropertyEditorParametersBase {\r\n  /** Used for serializing to JSON. */\r\n  paramsType: \"Multiline\";\r\n\r\n  /**\r\n   * Number of lines. Defaults to `1`.\r\n   *\r\n   * @type integer\r\n   * @minimum 1\r\n   */\r\n  height?: number;\r\n}\r\n\r\n/**\r\n * Range parameters for property editors that support ranges\r\n * @public\r\n */\r\nexport interface PropertyEditorRangeParameters extends PropertyEditorParametersBase {\r\n  /** Used for serializing to JSON. */\r\n  paramsType: \"Range\";\r\n\r\n  /** Minimum value of the range. */\r\n  min?: number;\r\n\r\n  /** Maximum value of the range. */\r\n  max?: number;\r\n}\r\n\r\n/**\r\n * Slider parameters for property editors that support slider display\r\n * @public\r\n */\r\nexport interface PropertyEditorSliderParameters extends PropertyEditorParametersBase {\r\n  /** Used for serializing to JSON. */\r\n  paramsType: \"Slider\";\r\n\r\n  /** Minimum value that can be set. */\r\n  min: number;\r\n\r\n  /** Maximum value that can be set. */\r\n  max: number;\r\n\r\n  /**\r\n   * Count of intervals. Defaults to `1`.\r\n   *\r\n   * @type integer\r\n   * @minimum 1\r\n   */\r\n  intervalsCount?: number;\r\n\r\n  /** Is slider vertical. */\r\n  isVertical?: boolean;\r\n}\r\n"]}

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

@@ -1,97 +1,97 @@
-/** @packageDocumentation
- * @module PresentationRules
- */
-import { RelationshipPathSpecification } from "../../RelationshipPathSpecification";
-import { PropertySpecification } from "../PropertySpecification";
-/**
- * Meaning of the relationship.
- * @public
- */
-export declare enum RelationshipMeaning {
-    /**
-     * The properties should be displayed as if they belonged to the [primary instance]($docs/presentation/content/Terminology.md#primary-instance).
-     * Generally that means they assigned a category, that's nested under the default category.
-     */
-    SameInstance = "SameInstance",
-    /**
-     * The properties should be distinguished from properties of the [primary instance]($docs/presentation/content/Terminology.md#primary-instance)
-     * and shown separately to make it clear they belong to another instance. Generally that means they're assigned a separate root category.
-     */
-    RelatedInstance = "RelatedInstance"
-}
-/**
- * Special values that can be used in [[RelatedPropertiesSpecification.propertyNames]]
- * @public
- */
-export declare enum RelatedPropertiesSpecialValues {
-    /**
-     * Used to specify that no properties should be included. Usually
-     * used together with [[RelatedPropertiesSpecification.nestedRelatedProperties]]
-     */
-    None = "_none_",
-    /**
-     * Used to specify that all properties should be included.
-     */
-    All = "*"
-}
-/**
- * This specification allows including related instance properties into the content.
- *
- * @see [Related properties specification specification reference documentation page]($docs/presentation/content/RelatedPropertiesSpecification.md)
- * @public
- */
-export interface RelatedPropertiesSpecification {
-    /**
-     * Specifies a chain of [relationship path specifications]($docs/presentation/RelationshipPathSpecification.md) that
-     * forms a path from the content instance to the related instance(s) whose properties should additionally be loaded.
-     */
-    propertiesSource: RelationshipPathSpecification;
-    /**
-     * Condition for filtering instances targeted by the [[propertiesSource]] attribute.
-     *
-     * **See:** [ECExpressions available in instance filter]($docs/presentation/Content/ECExpressions.md#instance-filter)
-     */
-    instanceFilter?: string;
-    /**
-     * The attribute tells whether the target class specified through [[propertiesSource]] should be handled
-     * polymorphically. This means properties of the concrete class are loaded in addition to properties of the
-     * target class itself.
-     *
-     * @note There's a difference between loading properties and instances polymorphically. This attribute
-     * only controls polymorphism of properties, while instances are always looked up in a polymorphic fashion.
-     */
-    handleTargetClassPolymorphically?: boolean;
-    /**
-     * Should the field containing related properties be assigned the [[NestedContentField.autoExpand]]
-     * attribute. The attribute tells UI components showing the properties that they should be initially displayed in the expanded state.
-     */
-    autoExpand?: boolean;
-    /**
-     * Specifies whether the specification should be ignored if another higher priority specification for the same relationship already exists.
-     * @beta
-     */
-    skipIfDuplicate?: boolean;
-    /**
-     * The attribute describes what the related properties mean to the [primary instance]($docs/presentation/content/Terminology.md#primary-instance)
-     * whose properties are displayed.
-     * @see RelationshipMeaning
-     */
-    relationshipMeaning?: `${RelationshipMeaning}`;
-    /** The attribute allows loading additional related properties that are related to the target instance of this specification. */
-    nestedRelatedProperties?: RelatedPropertiesSpecification[];
-    /**
-     * List of names or definitions of related class properties that should be included in the content.
-     * @see RelatedPropertiesSpecialValues
-     */
-    properties?: Array<string | PropertySpecification> | `${RelatedPropertiesSpecialValues}`;
-    /**
-     * List of names or definitions of relationship class properties that should be included in the content.
-     * @see RelatedPropertiesSpecialValues
-     */
-    relationshipProperties?: Array<string | PropertySpecification> | `${RelatedPropertiesSpecialValues}`;
-    /**
-     * Specifies whether a relationship category should be created regardless of whether any relationship properties were included.
-     */
-    forceCreateRelationshipCategory?: boolean;
-}
+/** @packageDocumentation
+ * @module PresentationRules
+ */
+import { RelationshipPathSpecification } from "../../RelationshipPathSpecification";
+import { PropertySpecification } from "../PropertySpecification";
+/**
+ * Meaning of the relationship.
+ * @public
+ */
+export declare enum RelationshipMeaning {
+    /**
+     * The properties should be displayed as if they belonged to the [primary instance]($docs/presentation/content/Terminology.md#primary-instance).
+     * Generally that means they assigned a category, that's nested under the default category.
+     */
+    SameInstance = "SameInstance",
+    /**
+     * The properties should be distinguished from properties of the [primary instance]($docs/presentation/content/Terminology.md#primary-instance)
+     * and shown separately to make it clear they belong to another instance. Generally that means they're assigned a separate root category.
+     */
+    RelatedInstance = "RelatedInstance"
+}
+/**
+ * Special values that can be used in [[RelatedPropertiesSpecification.propertyNames]]
+ * @public
+ */
+export declare enum RelatedPropertiesSpecialValues {
+    /**
+     * Used to specify that no properties should be included. Usually
+     * used together with [[RelatedPropertiesSpecification.nestedRelatedProperties]]
+     */
+    None = "_none_",
+    /**
+     * Used to specify that all properties should be included.
+     */
+    All = "*"
+}
+/**
+ * This specification allows including related instance properties into the content.
+ *
+ * @see [Related properties specification specification reference documentation page]($docs/presentation/content/RelatedPropertiesSpecification.md)
+ * @public
+ */
+export interface RelatedPropertiesSpecification {
+    /**
+     * Specifies a chain of [relationship path specifications]($docs/presentation/RelationshipPathSpecification.md) that
+     * forms a path from the content instance to the related instance(s) whose properties should additionally be loaded.
+     */
+    propertiesSource: RelationshipPathSpecification;
+    /**
+     * Condition for filtering instances targeted by the [[propertiesSource]] attribute.
+     *
+     * **See:** [ECExpressions available in instance filter]($docs/presentation/Content/ECExpressions.md#instance-filter)
+     */
+    instanceFilter?: string;
+    /**
+     * The attribute tells whether the target class specified through [[propertiesSource]] should be handled
+     * polymorphically. This means properties of the concrete class are loaded in addition to properties of the
+     * target class itself.
+     *
+     * @note There's a difference between loading properties and instances polymorphically. This attribute
+     * only controls polymorphism of properties, while instances are always looked up in a polymorphic fashion.
+     */
+    handleTargetClassPolymorphically?: boolean;
+    /**
+     * Should the field containing related properties be assigned the [[NestedContentField.autoExpand]]
+     * attribute. The attribute tells UI components showing the properties that they should be initially displayed in the expanded state.
+     */
+    autoExpand?: boolean;
+    /**
+     * Specifies whether the specification should be ignored if another higher priority specification for the same relationship already exists.
+     * @beta
+     */
+    skipIfDuplicate?: boolean;
+    /**
+     * The attribute describes what the related properties mean to the [primary instance]($docs/presentation/content/Terminology.md#primary-instance)
+     * whose properties are displayed.
+     * @see RelationshipMeaning
+     */
+    relationshipMeaning?: `${RelationshipMeaning}`;
+    /** The attribute allows loading additional related properties that are related to the target instance of this specification. */
+    nestedRelatedProperties?: RelatedPropertiesSpecification[];
+    /**
+     * List of names or definitions of related class properties that should be included in the content.
+     * @see RelatedPropertiesSpecialValues
+     */
+    properties?: Array<string | PropertySpecification> | `${RelatedPropertiesSpecialValues}`;
+    /**
+     * List of names or definitions of relationship class properties that should be included in the content.
+     * @see RelatedPropertiesSpecialValues
+     */
+    relationshipProperties?: Array<string | PropertySpecification> | `${RelatedPropertiesSpecialValues}`;
+    /**
+     * Specifies whether a relationship category should be created regardless of whether any relationship properties were included.
+     */
+    forceCreateRelationshipCategory?: boolean;
+}
 //# sourceMappingURL=RelatedPropertiesSpecification.d.ts.map

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

@@ -1,41 +1,41 @@
-/*---------------------------------------------------------------------------------------------
-* 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
- */
-/**
- * Meaning of the relationship.
- * @public
- */
-export var RelationshipMeaning;
-(function (RelationshipMeaning) {
-    /**
-     * The properties should be displayed as if they belonged to the [primary instance]($docs/presentation/content/Terminology.md#primary-instance).
-     * Generally that means they assigned a category, that's nested under the default category.
-     */
-    RelationshipMeaning["SameInstance"] = "SameInstance";
-    /**
-     * The properties should be distinguished from properties of the [primary instance]($docs/presentation/content/Terminology.md#primary-instance)
-     * and shown separately to make it clear they belong to another instance. Generally that means they're assigned a separate root category.
-     */
-    RelationshipMeaning["RelatedInstance"] = "RelatedInstance";
-})(RelationshipMeaning || (RelationshipMeaning = {}));
-/**
- * Special values that can be used in [[RelatedPropertiesSpecification.propertyNames]]
- * @public
- */
-export var RelatedPropertiesSpecialValues;
-(function (RelatedPropertiesSpecialValues) {
-    /**
-     * Used to specify that no properties should be included. Usually
-     * used together with [[RelatedPropertiesSpecification.nestedRelatedProperties]]
-     */
-    RelatedPropertiesSpecialValues["None"] = "_none_";
-    /**
-     * Used to specify that all properties should be included.
-     */
-    RelatedPropertiesSpecialValues["All"] = "*";
-})(RelatedPropertiesSpecialValues || (RelatedPropertiesSpecialValues = {}));
+/*---------------------------------------------------------------------------------------------
+* 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
+ */
+/**
+ * Meaning of the relationship.
+ * @public
+ */
+export var RelationshipMeaning;
+(function (RelationshipMeaning) {
+    /**
+     * The properties should be displayed as if they belonged to the [primary instance]($docs/presentation/content/Terminology.md#primary-instance).
+     * Generally that means they assigned a category, that's nested under the default category.
+     */
+    RelationshipMeaning["SameInstance"] = "SameInstance";
+    /**
+     * The properties should be distinguished from properties of the [primary instance]($docs/presentation/content/Terminology.md#primary-instance)
+     * and shown separately to make it clear they belong to another instance. Generally that means they're assigned a separate root category.
+     */
+    RelationshipMeaning["RelatedInstance"] = "RelatedInstance";
+})(RelationshipMeaning || (RelationshipMeaning = {}));
+/**
+ * Special values that can be used in [[RelatedPropertiesSpecification.propertyNames]]
+ * @public
+ */
+export var RelatedPropertiesSpecialValues;
+(function (RelatedPropertiesSpecialValues) {
+    /**
+     * Used to specify that no properties should be included. Usually
+     * used together with [[RelatedPropertiesSpecification.nestedRelatedProperties]]
+     */
+    RelatedPropertiesSpecialValues["None"] = "_none_";
+    /**
+     * Used to specify that all properties should be included.
+     */
+    RelatedPropertiesSpecialValues["All"] = "*";
+})(RelatedPropertiesSpecialValues || (RelatedPropertiesSpecialValues = {}));
 //# sourceMappingURL=RelatedPropertiesSpecification.js.map

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

@@ -1 +1 @@
-{"version":3,"file":"RelatedPropertiesSpecification.js","sourceRoot":"","sources":["../../../../../../src/presentation-common/rules/content/modifiers/RelatedPropertiesSpecification.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAKH;;;GAGG;AACH,MAAM,CAAN,IAAY,mBAYX;AAZD,WAAY,mBAAmB;IAC7B;;;OAGG;IACH,oDAA6B,CAAA;IAE7B;;;OAGG;IACH,0DAAmC,CAAA;AACrC,CAAC,EAZW,mBAAmB,KAAnB,mBAAmB,QAY9B;AAED;;;GAGG;AACH,MAAM,CAAN,IAAY,8BAWX;AAXD,WAAY,8BAA8B;IACxC;;;OAGG;IACH,iDAAe,CAAA;IAEf;;OAEG;IACH,2CAAS,CAAA;AACX,CAAC,EAXW,8BAA8B,KAA9B,8BAA8B,QAWzC","sourcesContent":["/*---------------------------------------------------------------------------------------------\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 { RelationshipPathSpecification } from \"../../RelationshipPathSpecification\";\nimport { PropertySpecification } from \"../PropertySpecification\";\n\n/**\n * Meaning of the relationship.\n * @public\n */\nexport enum RelationshipMeaning {\n  /**\n   * The properties should be displayed as if they belonged to the [primary instance]($docs/presentation/content/Terminology.md#primary-instance).\n   * Generally that means they assigned a category, that's nested under the default category.\n   */\n  SameInstance = \"SameInstance\",\n\n  /**\n   * The properties should be distinguished from properties of the [primary instance]($docs/presentation/content/Terminology.md#primary-instance)\n   * and shown separately to make it clear they belong to another instance. Generally that means they're assigned a separate root category.\n   */\n  RelatedInstance = \"RelatedInstance\",\n}\n\n/**\n * Special values that can be used in [[RelatedPropertiesSpecification.propertyNames]]\n * @public\n */\nexport enum RelatedPropertiesSpecialValues {\n  /**\n   * Used to specify that no properties should be included. Usually\n   * used together with [[RelatedPropertiesSpecification.nestedRelatedProperties]]\n   */\n  None = \"_none_\",\n\n  /**\n   * Used to specify that all properties should be included.\n   */\n  All = \"*\",\n}\n\n/**\n * This specification allows including related instance properties into the content.\n *\n * @see [Related properties specification specification reference documentation page]($docs/presentation/content/RelatedPropertiesSpecification.md)\n * @public\n */\nexport interface RelatedPropertiesSpecification {\n  /**\n   * Specifies a chain of [relationship path specifications]($docs/presentation/RelationshipPathSpecification.md) that\n   * forms a path from the content instance to the related instance(s) whose properties should additionally be loaded.\n   */\n  propertiesSource: RelationshipPathSpecification;\n\n  /**\n   * Condition for filtering instances targeted by the [[propertiesSource]] attribute.\n   *\n   * **See:** [ECExpressions available in instance filter]($docs/presentation/Content/ECExpressions.md#instance-filter)\n   */\n  instanceFilter?: string;\n\n  /**\n   * The attribute tells whether the target class specified through [[propertiesSource]] should be handled\n   * polymorphically. This means properties of the concrete class are loaded in addition to properties of the\n   * target class itself.\n   *\n   * @note There's a difference between loading properties and instances polymorphically. This attribute\n   * only controls polymorphism of properties, while instances are always looked up in a polymorphic fashion.\n   */\n  handleTargetClassPolymorphically?: boolean;\n\n  /**\n   * Should the field containing related properties be assigned the [[NestedContentField.autoExpand]]\n   * attribute. The attribute tells UI components showing the properties that they should be initially displayed in the expanded state.\n   */\n  autoExpand?: boolean;\n\n  /**\n   * Specifies whether the specification should be ignored if another higher priority specification for the same relationship already exists.\n   * @beta\n   */\n  skipIfDuplicate?: boolean;\n\n  /**\n   * The attribute describes what the related properties mean to the [primary instance]($docs/presentation/content/Terminology.md#primary-instance)\n   * whose properties are displayed.\n   * @see RelationshipMeaning\n   */\n  relationshipMeaning?: `${RelationshipMeaning}`;\n\n  /** The attribute allows loading additional related properties that are related to the target instance of this specification. */\n  nestedRelatedProperties?: RelatedPropertiesSpecification[];\n\n  /**\n   * List of names or definitions of related class properties that should be included in the content.\n   * @see RelatedPropertiesSpecialValues\n   */\n  properties?: Array<string | PropertySpecification> | `${RelatedPropertiesSpecialValues}`;\n\n  /**\n   * List of names or definitions of relationship class properties that should be included in the content.\n   * @see RelatedPropertiesSpecialValues\n   */\n  relationshipProperties?: Array<string | PropertySpecification> | `${RelatedPropertiesSpecialValues}`;\n\n  /**\n   * Specifies whether a relationship category should be created regardless of whether any relationship properties were included.\n   */\n  forceCreateRelationshipCategory?: boolean;\n}\n"]}
+{"version":3,"file":"RelatedPropertiesSpecification.js","sourceRoot":"","sources":["../../../../../../src/presentation-common/rules/content/modifiers/RelatedPropertiesSpecification.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAKH;;;GAGG;AACH,MAAM,CAAN,IAAY,mBAYX;AAZD,WAAY,mBAAmB;IAC7B;;;OAGG;IACH,oDAA6B,CAAA;IAE7B;;;OAGG;IACH,0DAAmC,CAAA;AACrC,CAAC,EAZW,mBAAmB,KAAnB,mBAAmB,QAY9B;AAED;;;GAGG;AACH,MAAM,CAAN,IAAY,8BAWX;AAXD,WAAY,8BAA8B;IACxC;;;OAGG;IACH,iDAAe,CAAA;IAEf;;OAEG;IACH,2CAAS,CAAA;AACX,CAAC,EAXW,8BAA8B,KAA9B,8BAA8B,QAWzC","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\n/** @packageDocumentation\r\n * @module PresentationRules\r\n */\r\n\r\nimport { RelationshipPathSpecification } from \"../../RelationshipPathSpecification\";\r\nimport { PropertySpecification } from \"../PropertySpecification\";\r\n\r\n/**\r\n * Meaning of the relationship.\r\n * @public\r\n */\r\nexport enum RelationshipMeaning {\r\n  /**\r\n   * The properties should be displayed as if they belonged to the [primary instance]($docs/presentation/content/Terminology.md#primary-instance).\r\n   * Generally that means they assigned a category, that's nested under the default category.\r\n   */\r\n  SameInstance = \"SameInstance\",\r\n\r\n  /**\r\n   * The properties should be distinguished from properties of the [primary instance]($docs/presentation/content/Terminology.md#primary-instance)\r\n   * and shown separately to make it clear they belong to another instance. Generally that means they're assigned a separate root category.\r\n   */\r\n  RelatedInstance = \"RelatedInstance\",\r\n}\r\n\r\n/**\r\n * Special values that can be used in [[RelatedPropertiesSpecification.propertyNames]]\r\n * @public\r\n */\r\nexport enum RelatedPropertiesSpecialValues {\r\n  /**\r\n   * Used to specify that no properties should be included. Usually\r\n   * used together with [[RelatedPropertiesSpecification.nestedRelatedProperties]]\r\n   */\r\n  None = \"_none_\",\r\n\r\n  /**\r\n   * Used to specify that all properties should be included.\r\n   */\r\n  All = \"*\",\r\n}\r\n\r\n/**\r\n * This specification allows including related instance properties into the content.\r\n *\r\n * @see [Related properties specification specification reference documentation page]($docs/presentation/content/RelatedPropertiesSpecification.md)\r\n * @public\r\n */\r\nexport interface RelatedPropertiesSpecification {\r\n  /**\r\n   * Specifies a chain of [relationship path specifications]($docs/presentation/RelationshipPathSpecification.md) that\r\n   * forms a path from the content instance to the related instance(s) whose properties should additionally be loaded.\r\n   */\r\n  propertiesSource: RelationshipPathSpecification;\r\n\r\n  /**\r\n   * Condition for filtering instances targeted by the [[propertiesSource]] attribute.\r\n   *\r\n   * **See:** [ECExpressions available in instance filter]($docs/presentation/Content/ECExpressions.md#instance-filter)\r\n   */\r\n  instanceFilter?: string;\r\n\r\n  /**\r\n   * The attribute tells whether the target class specified through [[propertiesSource]] should be handled\r\n   * polymorphically. This means properties of the concrete class are loaded in addition to properties of the\r\n   * target class itself.\r\n   *\r\n   * @note There's a difference between loading properties and instances polymorphically. This attribute\r\n   * only controls polymorphism of properties, while instances are always looked up in a polymorphic fashion.\r\n   */\r\n  handleTargetClassPolymorphically?: boolean;\r\n\r\n  /**\r\n   * Should the field containing related properties be assigned the [[NestedContentField.autoExpand]]\r\n   * attribute. The attribute tells UI components showing the properties that they should be initially displayed in the expanded state.\r\n   */\r\n  autoExpand?: boolean;\r\n\r\n  /**\r\n   * Specifies whether the specification should be ignored if another higher priority specification for the same relationship already exists.\r\n   * @beta\r\n   */\r\n  skipIfDuplicate?: boolean;\r\n\r\n  /**\r\n   * The attribute describes what the related properties mean to the [primary instance]($docs/presentation/content/Terminology.md#primary-instance)\r\n   * whose properties are displayed.\r\n   * @see RelationshipMeaning\r\n   */\r\n  relationshipMeaning?: `${RelationshipMeaning}`;\r\n\r\n  /** The attribute allows loading additional related properties that are related to the target instance of this specification. */\r\n  nestedRelatedProperties?: RelatedPropertiesSpecification[];\r\n\r\n  /**\r\n   * List of names or definitions of related class properties that should be included in the content.\r\n   * @see RelatedPropertiesSpecialValues\r\n   */\r\n  properties?: Array<string | PropertySpecification> | `${RelatedPropertiesSpecialValues}`;\r\n\r\n  /**\r\n   * List of names or definitions of relationship class properties that should be included in the content.\r\n   * @see RelatedPropertiesSpecialValues\r\n   */\r\n  relationshipProperties?: Array<string | PropertySpecification> | `${RelatedPropertiesSpecialValues}`;\r\n\r\n  /**\r\n   * Specifies whether a relationship category should be created regardless of whether any relationship properties were included.\r\n   */\r\n  forceCreateRelationshipCategory?: boolean;\r\n}\r\n"]}