@itwin/presentation-common 3.2.0-dev.24 → 3.2.0-dev.27

package/Ruleset.schema.json

@@ -1903,8 +1903,11 @@
           "description": "Custom property editor specification that allows assigning\na custom value editor to be used in UI."
         },
         "isDisplayed": {
-          "description": "This attribute controls whether the particular property is present in the result, even when it is marked as hidden in the\nECSchema. The allowed settings are:\n\n- Omitted or `undefined`: property visibility is controlled by the ECSchema.\n\n- `true`: property is made visible. Warning: this will automatically hide all other properties of the same class.\n   If this behavior is not desirable, set `doNotHideOtherPropertiesOnDisplayOverride` attribute to `true`.\n\n- `false`: property is made hidden.",
-          "type": "boolean"
+          "description": "This attribute controls whether the particular property is present in the result, even when it is marked as hidden in the\nECSchema. The allowed settings are:\n\n- Omitted or `undefined`: property visibility is controlled by the ECSchema.\n\n- `true`: property is made visible. Warning: this will automatically hide all other properties of the same class.\n   If this behavior is not desirable, set `doNotHideOtherPropertiesOnDisplayOverride` attribute to `true`.\n\n- `false`: property is made hidden.\n\nThe value can also be set using an ECExpression.",
+          "type": [
+            "string",
+            "boolean"
+          ]
         },
         "labelOverride": {
           "description": "This is an attribute that allows overriding the property label. May be localized.",
@@ -2068,6 +2071,10 @@
           "description": "The attribute tells whether the target class specified through `propertiesSource` should be handled\npolymorphically. This means properties of the concrete class are loaded in addition to properties of the\ntarget class itself.",
           "type": "boolean"
         },
+        "instanceFilter": {
+          "description": "Condition for filtering instances targeted by the `propertiesSource` attribute.\n\nSee: ECExpressions available in instance filter",
+          "type": "string"
+        },
         "nestedRelatedProperties": {
           "description": "The attribute allows loading additional related properties that are related to the target instance of this specification.",
           "items": {

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

@@ -33,8 +33,10 @@ export interface PropertyOverrides {
      *   If this behavior is not desirable, set [[doNotHideOtherPropertiesOnDisplayOverride]] attribute to `true`.
      *
      * - `false`: property is made hidden.
+     *
+     * The value can also be set using an ECExpression.
      */
-    isDisplayed?: boolean;
+    isDisplayed?: boolean | string;
     /**
      * Custom property [renderer specification]($docs/presentation/content/RendererSpecification.md) that allows assigning a
      * custom value renderer to be used in UI. The specification is used to set up [[Field.renderer]] for

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

@@ -1 +1 @@
-{"version":3,"file":"PropertySpecification.d.ts","sourceRoot":"","sources":["../../../../../src/presentation-common/rules/content/PropertySpecification.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,2BAA2B,EAAE,MAAM,yCAAyC,CAAC;AACtF,OAAO,EAAE,kBAAkB,EAAE,MAAM,2CAA2C,CAAC;AAC/E,OAAO,EAAE,2BAA2B,EAAE,MAAM,0CAA0C,CAAC;AAEvF;;;;;GAKG;AACH,MAAM,WAAW,iBAAiB;IAChC;;;;;;OAMG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAE3B,uIAAuI;IACvI,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB,0EAA0E;IAC1E,UAAU,CAAC,EAAE,MAAM,GAAG,kBAAkB,CAAC;IAEzC;;;;;;;;;;OAUG;IACH,WAAW,CAAC,EAAE,OAAO,CAAC;IAEtB;;;;OAIG;IACH,QAAQ,CAAC,EAAE,2BAA2B,CAAC;IAEvC;;;OAGG;IACH,MAAM,CAAC,EAAE,2BAA2B,CAAC;IAErC;;;OAGG;IACH,yCAAyC,CAAC,EAAE,OAAO,CAAC;CACrD;AAED;;;;;GAKG;AACH,MAAM,WAAW,qBAAsB,SAAQ,iBAAiB;IAC9D;;;;;;;;;OASG;IACH,IAAI,EAAE,MAAM,CAAC;CACd"}
+{"version":3,"file":"PropertySpecification.d.ts","sourceRoot":"","sources":["../../../../../src/presentation-common/rules/content/PropertySpecification.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,2BAA2B,EAAE,MAAM,yCAAyC,CAAC;AACtF,OAAO,EAAE,kBAAkB,EAAE,MAAM,2CAA2C,CAAC;AAC/E,OAAO,EAAE,2BAA2B,EAAE,MAAM,0CAA0C,CAAC;AAEvF;;;;;GAKG;AACH,MAAM,WAAW,iBAAiB;IAChC;;;;;;OAMG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAE3B,uIAAuI;IACvI,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB,0EAA0E;IAC1E,UAAU,CAAC,EAAE,MAAM,GAAG,kBAAkB,CAAC;IAEzC;;;;;;;;;;;;OAYG;IACH,WAAW,CAAC,EAAE,OAAO,GAAG,MAAM,CAAC;IAE/B;;;;OAIG;IACH,QAAQ,CAAC,EAAE,2BAA2B,CAAC;IAEvC;;;OAGG;IACH,MAAM,CAAC,EAAE,2BAA2B,CAAC;IAErC;;;OAGG;IACH,yCAAyC,CAAC,EAAE,OAAO,CAAC;CACrD;AAED;;;;;GAKG;AACH,MAAM,WAAW,qBAAsB,SAAQ,iBAAiB;IAC9D;;;;;;;;;OASG;IACH,IAAI,EAAE,MAAM,CAAC;CACd"}

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

@@ -1 +1 @@
-{"version":3,"file":"PropertySpecification.js","sourceRoot":"","sources":["../../../../../src/presentation-common/rules/content/PropertySpecification.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 { CustomRendererSpecification } from \"./modifiers/CustomRendererSpecification\";\r\nimport { CategoryIdentifier } from \"./modifiers/PropertyCategorySpecification\";\r\nimport { PropertyEditorSpecification } from \"./modifiers/PropertyEditorsSpecification\";\r\n\r\n/**\r\n * A container structure for possible property overrides\r\n *\r\n * @see [Property specification reference documentation page]($docs/presentation/content/PropertySpecification.md)\r\n * @public\r\n */\r\nexport interface PropertyOverrides {\r\n  /**\r\n   * There may be multiple property specifications that apply to a single property and there may be conflicts between\r\n   * different attributes. The `overridesPriority` attribute is here to help solve the problem - if multiple specifications\r\n   * attempt to override the same attribute, the override of specification with highest `overridesPriority` value is used.\r\n   * The order of overrides from specification with the same `overridesPriority` is defined by the order they appear in\r\n   * the overrides list.\r\n   */\r\n  overridesPriority?: number;\r\n\r\n  /** This is an attribute that allows overriding the property label. May be [localized]($docs/presentation/advanced/Localization.md). */\r\n  labelOverride?: string;\r\n\r\n  /** The attribute allows moving the property into a different category. */\r\n  categoryId?: string | CategoryIdentifier;\r\n\r\n  /**\r\n   * This attribute controls whether the particular property is present in the result, even when it is marked as hidden in the\r\n   * ECSchema. The allowed settings are:\r\n   *\r\n   * - Omitted or `undefined`: property visibility is controlled by the ECSchema.\r\n   *\r\n   * - `true`: property is made visible. **Warning:** this will automatically hide all other properties of the same class.\r\n   *   If this behavior is not desirable, set [[doNotHideOtherPropertiesOnDisplayOverride]] attribute to `true`.\r\n   *\r\n   * - `false`: property is made hidden.\r\n   */\r\n  isDisplayed?: boolean;\r\n\r\n  /**\r\n   * Custom property [renderer specification]($docs/presentation/content/RendererSpecification.md) that allows assigning a\r\n   * custom value renderer to be used in UI. The specification is used to set up [[Field.renderer]] for\r\n   * this property and it's up to the UI component to make sure appropriate renderer is used to render the property.\r\n   */\r\n  renderer?: CustomRendererSpecification;\r\n\r\n  /**\r\n   * Custom [property editor specification]($docs/presentation/content/PropertyEditorSpecification) that allows assigning\r\n   * a custom value editor to be used in UI.\r\n   */\r\n  editor?: PropertyEditorSpecification;\r\n\r\n  /**\r\n   * This attribute controls whether making the property visible using [[isDisplayed]] attribute should automatically hide\r\n   * all other properties of the same class. When `true`, this behavior is disabled.\r\n   */\r\n  doNotHideOtherPropertiesOnDisplayOverride?: boolean;\r\n}\r\n\r\n/**\r\n * This specification allows overriding some attributes of specific ECProperty or define how it's displayed.\r\n *\r\n * @see [Property specification reference documentation page]($docs/presentation/content/PropertySpecification.md)\r\n * @public\r\n */\r\nexport interface PropertySpecification extends PropertyOverrides {\r\n  /**\r\n   * Name of the ECProperty to apply overrides to. A `\"*\"` may be specified to match all properties in current context.\r\n   * The current context is determined based on where the override is specified:\r\n   *\r\n   * - When used in a [content modifier]($docs/presentation/content/ContentModifier.md#attribute-propertyoverrides), the\r\n   *   properties of the ECClass specified by the [`class` attribute]($docs/presentation/content/ContentModifier.md#attribute-class) are used.\r\n   *\r\n   * - When used in one of the [content specifications]($docs/presentation/content/ContentRule.md#attribute-specifications),\r\n   *   properties produced by that specification are used.\r\n   */\r\n  name: string;\r\n}\r\n"]}
+{"version":3,"file":"PropertySpecification.js","sourceRoot":"","sources":["../../../../../src/presentation-common/rules/content/PropertySpecification.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 { CustomRendererSpecification } from \"./modifiers/CustomRendererSpecification\";\r\nimport { CategoryIdentifier } from \"./modifiers/PropertyCategorySpecification\";\r\nimport { PropertyEditorSpecification } from \"./modifiers/PropertyEditorsSpecification\";\r\n\r\n/**\r\n * A container structure for possible property overrides\r\n *\r\n * @see [Property specification reference documentation page]($docs/presentation/content/PropertySpecification.md)\r\n * @public\r\n */\r\nexport interface PropertyOverrides {\r\n  /**\r\n   * There may be multiple property specifications that apply to a single property and there may be conflicts between\r\n   * different attributes. The `overridesPriority` attribute is here to help solve the problem - if multiple specifications\r\n   * attempt to override the same attribute, the override of specification with highest `overridesPriority` value is used.\r\n   * The order of overrides from specification with the same `overridesPriority` is defined by the order they appear in\r\n   * the overrides list.\r\n   */\r\n  overridesPriority?: number;\r\n\r\n  /** This is an attribute that allows overriding the property label. May be [localized]($docs/presentation/advanced/Localization.md). */\r\n  labelOverride?: string;\r\n\r\n  /** The attribute allows moving the property into a different category. */\r\n  categoryId?: string | CategoryIdentifier;\r\n\r\n  /**\r\n   * This attribute controls whether the particular property is present in the result, even when it is marked as hidden in the\r\n   * ECSchema. The allowed settings are:\r\n   *\r\n   * - Omitted or `undefined`: property visibility is controlled by the ECSchema.\r\n   *\r\n   * - `true`: property is made visible. **Warning:** this will automatically hide all other properties of the same class.\r\n   *   If this behavior is not desirable, set [[doNotHideOtherPropertiesOnDisplayOverride]] attribute to `true`.\r\n   *\r\n   * - `false`: property is made hidden.\r\n   *\r\n   * The value can also be set using an ECExpression.\r\n   */\r\n  isDisplayed?: boolean | string;\r\n\r\n  /**\r\n   * Custom property [renderer specification]($docs/presentation/content/RendererSpecification.md) that allows assigning a\r\n   * custom value renderer to be used in UI. The specification is used to set up [[Field.renderer]] for\r\n   * this property and it's up to the UI component to make sure appropriate renderer is used to render the property.\r\n   */\r\n  renderer?: CustomRendererSpecification;\r\n\r\n  /**\r\n   * Custom [property editor specification]($docs/presentation/content/PropertyEditorSpecification) that allows assigning\r\n   * a custom value editor to be used in UI.\r\n   */\r\n  editor?: PropertyEditorSpecification;\r\n\r\n  /**\r\n   * This attribute controls whether making the property visible using [[isDisplayed]] attribute should automatically hide\r\n   * all other properties of the same class. When `true`, this behavior is disabled.\r\n   */\r\n  doNotHideOtherPropertiesOnDisplayOverride?: boolean;\r\n}\r\n\r\n/**\r\n * This specification allows overriding some attributes of specific ECProperty or define how it's displayed.\r\n *\r\n * @see [Property specification reference documentation page]($docs/presentation/content/PropertySpecification.md)\r\n * @public\r\n */\r\nexport interface PropertySpecification extends PropertyOverrides {\r\n  /**\r\n   * Name of the ECProperty to apply overrides to. A `\"*\"` may be specified to match all properties in current context.\r\n   * The current context is determined based on where the override is specified:\r\n   *\r\n   * - When used in a [content modifier]($docs/presentation/content/ContentModifier.md#attribute-propertyoverrides), the\r\n   *   properties of the ECClass specified by the [`class` attribute]($docs/presentation/content/ContentModifier.md#attribute-class) are used.\r\n   *\r\n   * - When used in one of the [content specifications]($docs/presentation/content/ContentRule.md#attribute-specifications),\r\n   *   properties produced by that specification are used.\r\n   */\r\n  name: string;\r\n}\r\n"]}

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

@@ -46,6 +46,12 @@ export interface RelatedPropertiesSpecification {
      * 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

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

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

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

@@ -1 +1 @@
-{"version":3,"file":"RelatedPropertiesSpecification.js","sourceRoot":"","sources":["../../../../../../src/presentation-common/rules/content/modifiers/RelatedPropertiesSpecification.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAKH;;;GAGG;AACH,IAAY,mBAYX;AAZD,WAAY,mBAAmB;IAC7B;;;OAGG;IACH,oDAA6B,CAAA;IAE7B;;;OAGG;IACH,0DAAmC,CAAA;AACrC,CAAC,EAZW,mBAAmB,GAAnB,2BAAmB,KAAnB,2BAAmB,QAY9B;AAED;;;GAGG;AACH,IAAY,8BAWX;AAXD,WAAY,8BAA8B;IACxC;;;OAGG;IACH,iDAAe,CAAA;IAEf;;OAEG;IACH,2CAAS,CAAA;AACX,CAAC,EAXW,8BAA8B,GAA9B,sCAA8B,KAA9B,sCAA8B,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   * 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   */\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   */\r\n  properties?: Array<string | PropertySpecification> | RelatedPropertiesSpecialValues;\r\n}\r\n"]}
+{"version":3,"file":"RelatedPropertiesSpecification.js","sourceRoot":"","sources":["../../../../../../src/presentation-common/rules/content/modifiers/RelatedPropertiesSpecification.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAKH;;;GAGG;AACH,IAAY,mBAYX;AAZD,WAAY,mBAAmB;IAC7B;;;OAGG;IACH,oDAA6B,CAAA;IAE7B;;;OAGG;IACH,0DAAmC,CAAA;AACrC,CAAC,EAZW,mBAAmB,GAAnB,2BAAmB,KAAnB,2BAAmB,QAY9B;AAED;;;GAGG;AACH,IAAY,8BAWX;AAXD,WAAY,8BAA8B;IACxC;;;OAGG;IACH,iDAAe,CAAA;IAEf;;OAEG;IACH,2CAAS,CAAA;AACX,CAAC,EAXW,8BAA8B,GAA9B,sCAA8B,KAA9B,sCAA8B,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   */\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   */\r\n  properties?: Array<string | PropertySpecification> | RelatedPropertiesSpecialValues;\r\n}\r\n"]}

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

@@ -33,8 +33,10 @@ export interface PropertyOverrides {
      *   If this behavior is not desirable, set [[doNotHideOtherPropertiesOnDisplayOverride]] attribute to `true`.
      *
      * - `false`: property is made hidden.
+     *
+     * The value can also be set using an ECExpression.
      */
-    isDisplayed?: boolean;
+    isDisplayed?: boolean | string;
     /**
      * Custom property [renderer specification]($docs/presentation/content/RendererSpecification.md) that allows assigning a
      * custom value renderer to be used in UI. The specification is used to set up [[Field.renderer]] for

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

@@ -1 +1 @@
-{"version":3,"file":"PropertySpecification.d.ts","sourceRoot":"","sources":["../../../../../src/presentation-common/rules/content/PropertySpecification.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,2BAA2B,EAAE,MAAM,yCAAyC,CAAC;AACtF,OAAO,EAAE,kBAAkB,EAAE,MAAM,2CAA2C,CAAC;AAC/E,OAAO,EAAE,2BAA2B,EAAE,MAAM,0CAA0C,CAAC;AAEvF;;;;;GAKG;AACH,MAAM,WAAW,iBAAiB;IAChC;;;;;;OAMG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAE3B,uIAAuI;IACvI,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB,0EAA0E;IAC1E,UAAU,CAAC,EAAE,MAAM,GAAG,kBAAkB,CAAC;IAEzC;;;;;;;;;;OAUG;IACH,WAAW,CAAC,EAAE,OAAO,CAAC;IAEtB;;;;OAIG;IACH,QAAQ,CAAC,EAAE,2BAA2B,CAAC;IAEvC;;;OAGG;IACH,MAAM,CAAC,EAAE,2BAA2B,CAAC;IAErC;;;OAGG;IACH,yCAAyC,CAAC,EAAE,OAAO,CAAC;CACrD;AAED;;;;;GAKG;AACH,MAAM,WAAW,qBAAsB,SAAQ,iBAAiB;IAC9D;;;;;;;;;OASG;IACH,IAAI,EAAE,MAAM,CAAC;CACd"}
+{"version":3,"file":"PropertySpecification.d.ts","sourceRoot":"","sources":["../../../../../src/presentation-common/rules/content/PropertySpecification.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,2BAA2B,EAAE,MAAM,yCAAyC,CAAC;AACtF,OAAO,EAAE,kBAAkB,EAAE,MAAM,2CAA2C,CAAC;AAC/E,OAAO,EAAE,2BAA2B,EAAE,MAAM,0CAA0C,CAAC;AAEvF;;;;;GAKG;AACH,MAAM,WAAW,iBAAiB;IAChC;;;;;;OAMG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAE3B,uIAAuI;IACvI,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB,0EAA0E;IAC1E,UAAU,CAAC,EAAE,MAAM,GAAG,kBAAkB,CAAC;IAEzC;;;;;;;;;;;;OAYG;IACH,WAAW,CAAC,EAAE,OAAO,GAAG,MAAM,CAAC;IAE/B;;;;OAIG;IACH,QAAQ,CAAC,EAAE,2BAA2B,CAAC;IAEvC;;;OAGG;IACH,MAAM,CAAC,EAAE,2BAA2B,CAAC;IAErC;;;OAGG;IACH,yCAAyC,CAAC,EAAE,OAAO,CAAC;CACrD;AAED;;;;;GAKG;AACH,MAAM,WAAW,qBAAsB,SAAQ,iBAAiB;IAC9D;;;;;;;;;OASG;IACH,IAAI,EAAE,MAAM,CAAC;CACd"}

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

@@ -1 +1 @@
-{"version":3,"file":"PropertySpecification.js","sourceRoot":"","sources":["../../../../../src/presentation-common/rules/content/PropertySpecification.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 { CustomRendererSpecification } from \"./modifiers/CustomRendererSpecification\";\r\nimport { CategoryIdentifier } from \"./modifiers/PropertyCategorySpecification\";\r\nimport { PropertyEditorSpecification } from \"./modifiers/PropertyEditorsSpecification\";\r\n\r\n/**\r\n * A container structure for possible property overrides\r\n *\r\n * @see [Property specification reference documentation page]($docs/presentation/content/PropertySpecification.md)\r\n * @public\r\n */\r\nexport interface PropertyOverrides {\r\n  /**\r\n   * There may be multiple property specifications that apply to a single property and there may be conflicts between\r\n   * different attributes. The `overridesPriority` attribute is here to help solve the problem - if multiple specifications\r\n   * attempt to override the same attribute, the override of specification with highest `overridesPriority` value is used.\r\n   * The order of overrides from specification with the same `overridesPriority` is defined by the order they appear in\r\n   * the overrides list.\r\n   */\r\n  overridesPriority?: number;\r\n\r\n  /** This is an attribute that allows overriding the property label. May be [localized]($docs/presentation/advanced/Localization.md). */\r\n  labelOverride?: string;\r\n\r\n  /** The attribute allows moving the property into a different category. */\r\n  categoryId?: string | CategoryIdentifier;\r\n\r\n  /**\r\n   * This attribute controls whether the particular property is present in the result, even when it is marked as hidden in the\r\n   * ECSchema. The allowed settings are:\r\n   *\r\n   * - Omitted or `undefined`: property visibility is controlled by the ECSchema.\r\n   *\r\n   * - `true`: property is made visible. **Warning:** this will automatically hide all other properties of the same class.\r\n   *   If this behavior is not desirable, set [[doNotHideOtherPropertiesOnDisplayOverride]] attribute to `true`.\r\n   *\r\n   * - `false`: property is made hidden.\r\n   */\r\n  isDisplayed?: boolean;\r\n\r\n  /**\r\n   * Custom property [renderer specification]($docs/presentation/content/RendererSpecification.md) that allows assigning a\r\n   * custom value renderer to be used in UI. The specification is used to set up [[Field.renderer]] for\r\n   * this property and it's up to the UI component to make sure appropriate renderer is used to render the property.\r\n   */\r\n  renderer?: CustomRendererSpecification;\r\n\r\n  /**\r\n   * Custom [property editor specification]($docs/presentation/content/PropertyEditorSpecification) that allows assigning\r\n   * a custom value editor to be used in UI.\r\n   */\r\n  editor?: PropertyEditorSpecification;\r\n\r\n  /**\r\n   * This attribute controls whether making the property visible using [[isDisplayed]] attribute should automatically hide\r\n   * all other properties of the same class. When `true`, this behavior is disabled.\r\n   */\r\n  doNotHideOtherPropertiesOnDisplayOverride?: boolean;\r\n}\r\n\r\n/**\r\n * This specification allows overriding some attributes of specific ECProperty or define how it's displayed.\r\n *\r\n * @see [Property specification reference documentation page]($docs/presentation/content/PropertySpecification.md)\r\n * @public\r\n */\r\nexport interface PropertySpecification extends PropertyOverrides {\r\n  /**\r\n   * Name of the ECProperty to apply overrides to. A `\"*\"` may be specified to match all properties in current context.\r\n   * The current context is determined based on where the override is specified:\r\n   *\r\n   * - When used in a [content modifier]($docs/presentation/content/ContentModifier.md#attribute-propertyoverrides), the\r\n   *   properties of the ECClass specified by the [`class` attribute]($docs/presentation/content/ContentModifier.md#attribute-class) are used.\r\n   *\r\n   * - When used in one of the [content specifications]($docs/presentation/content/ContentRule.md#attribute-specifications),\r\n   *   properties produced by that specification are used.\r\n   */\r\n  name: string;\r\n}\r\n"]}
+{"version":3,"file":"PropertySpecification.js","sourceRoot":"","sources":["../../../../../src/presentation-common/rules/content/PropertySpecification.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 { CustomRendererSpecification } from \"./modifiers/CustomRendererSpecification\";\r\nimport { CategoryIdentifier } from \"./modifiers/PropertyCategorySpecification\";\r\nimport { PropertyEditorSpecification } from \"./modifiers/PropertyEditorsSpecification\";\r\n\r\n/**\r\n * A container structure for possible property overrides\r\n *\r\n * @see [Property specification reference documentation page]($docs/presentation/content/PropertySpecification.md)\r\n * @public\r\n */\r\nexport interface PropertyOverrides {\r\n  /**\r\n   * There may be multiple property specifications that apply to a single property and there may be conflicts between\r\n   * different attributes. The `overridesPriority` attribute is here to help solve the problem - if multiple specifications\r\n   * attempt to override the same attribute, the override of specification with highest `overridesPriority` value is used.\r\n   * The order of overrides from specification with the same `overridesPriority` is defined by the order they appear in\r\n   * the overrides list.\r\n   */\r\n  overridesPriority?: number;\r\n\r\n  /** This is an attribute that allows overriding the property label. May be [localized]($docs/presentation/advanced/Localization.md). */\r\n  labelOverride?: string;\r\n\r\n  /** The attribute allows moving the property into a different category. */\r\n  categoryId?: string | CategoryIdentifier;\r\n\r\n  /**\r\n   * This attribute controls whether the particular property is present in the result, even when it is marked as hidden in the\r\n   * ECSchema. The allowed settings are:\r\n   *\r\n   * - Omitted or `undefined`: property visibility is controlled by the ECSchema.\r\n   *\r\n   * - `true`: property is made visible. **Warning:** this will automatically hide all other properties of the same class.\r\n   *   If this behavior is not desirable, set [[doNotHideOtherPropertiesOnDisplayOverride]] attribute to `true`.\r\n   *\r\n   * - `false`: property is made hidden.\r\n   *\r\n   * The value can also be set using an ECExpression.\r\n   */\r\n  isDisplayed?: boolean | string;\r\n\r\n  /**\r\n   * Custom property [renderer specification]($docs/presentation/content/RendererSpecification.md) that allows assigning a\r\n   * custom value renderer to be used in UI. The specification is used to set up [[Field.renderer]] for\r\n   * this property and it's up to the UI component to make sure appropriate renderer is used to render the property.\r\n   */\r\n  renderer?: CustomRendererSpecification;\r\n\r\n  /**\r\n   * Custom [property editor specification]($docs/presentation/content/PropertyEditorSpecification) that allows assigning\r\n   * a custom value editor to be used in UI.\r\n   */\r\n  editor?: PropertyEditorSpecification;\r\n\r\n  /**\r\n   * This attribute controls whether making the property visible using [[isDisplayed]] attribute should automatically hide\r\n   * all other properties of the same class. When `true`, this behavior is disabled.\r\n   */\r\n  doNotHideOtherPropertiesOnDisplayOverride?: boolean;\r\n}\r\n\r\n/**\r\n * This specification allows overriding some attributes of specific ECProperty or define how it's displayed.\r\n *\r\n * @see [Property specification reference documentation page]($docs/presentation/content/PropertySpecification.md)\r\n * @public\r\n */\r\nexport interface PropertySpecification extends PropertyOverrides {\r\n  /**\r\n   * Name of the ECProperty to apply overrides to. A `\"*\"` may be specified to match all properties in current context.\r\n   * The current context is determined based on where the override is specified:\r\n   *\r\n   * - When used in a [content modifier]($docs/presentation/content/ContentModifier.md#attribute-propertyoverrides), the\r\n   *   properties of the ECClass specified by the [`class` attribute]($docs/presentation/content/ContentModifier.md#attribute-class) are used.\r\n   *\r\n   * - When used in one of the [content specifications]($docs/presentation/content/ContentRule.md#attribute-specifications),\r\n   *   properties produced by that specification are used.\r\n   */\r\n  name: string;\r\n}\r\n"]}

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

@@ -46,6 +46,12 @@ export interface RelatedPropertiesSpecification {
      * 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

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

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

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":["/*---------------------------------------------------------------------------------------------\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   * 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   */\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   */\r\n  properties?: Array<string | PropertySpecification> | RelatedPropertiesSpecialValues;\r\n}\r\n"]}
+{"version":3,"file":"RelatedPropertiesSpecification.js","sourceRoot":"","sources":["../../../../../../src/presentation-common/rules/content/modifiers/RelatedPropertiesSpecification.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAKH;;;GAGG;AACH,MAAM,CAAN,IAAY,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   */\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   */\r\n  properties?: Array<string | PropertySpecification> | RelatedPropertiesSpecialValues;\r\n}\r\n"]}

package/package.json

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