@itwin/presentation-common 3.2.0-dev.7 → 3.2.0-dev.72

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

@@ -1 +1 @@
-{"version":3,"file":"ContentSpecification.js","sourceRoot":"","sources":["../../../../../src/presentation-common/rules/content/ContentSpecification.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAQH;;;GAGG;AACH,IAAY,yBAIX;AAJD,WAAY,yBAAyB;IACnC,oGAAuE,CAAA;IACvE,gFAAmD,CAAA;IACnD,4EAA+C,CAAA;AACjD,CAAC,EAJW,yBAAyB,GAAzB,iCAAyB,KAAzB,iCAAyB,QAIpC","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\n/** @packageDocumentation\r\n * @module PresentationRules\r\n */\r\n\r\nimport { RelatedInstanceSpecification } from \"../RelatedInstanceSpecification\";\r\nimport { ContentInstancesOfSpecificClassesSpecification } from \"./ContentInstancesOfSpecificClassesSpecification\";\r\nimport { ContentRelatedInstancesSpecification } from \"./ContentRelatedInstancesSpecification\";\r\nimport { ContentModifiersList } from \"./modifiers/ContentModifier\";\r\nimport { SelectedNodeInstancesSpecification } from \"./SelectedNodeInstancesSpecification\";\r\n\r\n/**\r\n * Used for serializing array of [[ContentSpecification]]\r\n * @public\r\n */\r\nexport enum ContentSpecificationTypes {\r\n  ContentInstancesOfSpecificClasses = \"ContentInstancesOfSpecificClasses\",\r\n  ContentRelatedInstances = \"ContentRelatedInstances\",\r\n  SelectedNodeInstances = \"SelectedNodeInstances\",\r\n}\r\n\r\n/**\r\n * Base interface for all [[ContentSpecification]] implementations. Not\r\n * meant to be used directly, see `ContentSpecification`.\r\n *\r\n * @public\r\n */\r\nexport interface ContentSpecificationBase extends ContentModifiersList {\r\n  /** Used for serializing to JSON. */\r\n  specType: ContentSpecificationTypes;\r\n\r\n  /**\r\n   * Defines the order in which specifications are evaluated and executed. Defaults to `1000`.\r\n   *\r\n   * @type integer\r\n   */\r\n  priority?: number;\r\n\r\n  /** Should each content record be assigned an image id */\r\n  showImages?: boolean;\r\n\r\n  /** Specifications for joining related instances */\r\n  relatedInstances?: RelatedInstanceSpecification[];\r\n\r\n  /**\r\n   * Identifies whether we should ignore this specification if there is already an existing specification\r\n   * with higher `priority` that already provides content.\r\n   */\r\n  onlyIfNotHandled?: boolean;\r\n}\r\n\r\n/**\r\n * Content rule specifications which define what content is returned\r\n * when rule is used.\r\n *\r\n * @public\r\n */\r\nexport declare type ContentSpecification = ContentInstancesOfSpecificClassesSpecification | ContentRelatedInstancesSpecification | SelectedNodeInstancesSpecification;\r\n"]}
+{"version":3,"file":"ContentSpecification.js","sourceRoot":"","sources":["../../../../../src/presentation-common/rules/content/ContentSpecification.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAQH;;;GAGG;AACH,IAAY,yBAIX;AAJD,WAAY,yBAAyB;IACnC,oGAAuE,CAAA;IACvE,gFAAmD,CAAA;IACnD,4EAA+C,CAAA;AACjD,CAAC,EAJW,yBAAyB,GAAzB,iCAAyB,KAAzB,iCAAyB,QAIpC","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\n/** @packageDocumentation\r\n * @module PresentationRules\r\n */\r\n\r\nimport { RelatedInstanceSpecification } from \"../RelatedInstanceSpecification\";\r\nimport { ContentInstancesOfSpecificClassesSpecification } from \"./ContentInstancesOfSpecificClassesSpecification\";\r\nimport { ContentRelatedInstancesSpecification } from \"./ContentRelatedInstancesSpecification\";\r\nimport { ContentModifiersList } from \"./modifiers/ContentModifier\";\r\nimport { SelectedNodeInstancesSpecification } from \"./SelectedNodeInstancesSpecification\";\r\n\r\n/**\r\n * Used for serializing array of [[ContentSpecification]]\r\n * @public\r\n */\r\nexport enum ContentSpecificationTypes {\r\n  ContentInstancesOfSpecificClasses = \"ContentInstancesOfSpecificClasses\",\r\n  ContentRelatedInstances = \"ContentRelatedInstances\",\r\n  SelectedNodeInstances = \"SelectedNodeInstances\",\r\n}\r\n\r\n/**\r\n * Base interface for all [[ContentSpecification]] implementations. Not\r\n * meant to be used directly, see `ContentSpecification`.\r\n *\r\n * @public\r\n */\r\nexport interface ContentSpecificationBase extends ContentModifiersList {\r\n  /** Used for serializing to JSON. */\r\n  specType: ContentSpecificationTypes;\r\n\r\n  /**\r\n   * Controls the order in which specifications are handled — specification with higher priority value is handled\r\n   * first. If priorities are equal, the specifications are handled in the order they appear in the ruleset.\r\n   *\r\n   * @type integer\r\n   */\r\n  priority?: number;\r\n\r\n  /**\r\n   * Should image IDs be calculated for the returned instances. When `true`, [[ImageIdOverride]] rules get applied when\r\n   * creating the content.\r\n   *\r\n   * @deprecated Use [[ExtendedDataRule]] instead. See [extended data usage page]($docs/presentation/customization/ExtendedDataUsage.md) for more details.\r\n   */\r\n  showImages?: boolean;\r\n\r\n  /** Specifications of [related instances]($docs/presentation/RelatedInstanceSpecification.md) that can be used when creating the content. */\r\n  relatedInstances?: RelatedInstanceSpecification[];\r\n\r\n  /**\r\n   * Specifies whether this specification should be ignored if another specification was handled before as\r\n   * determined by rule and specification priorities. This provides a mechanism for defining a fallback specification.\r\n   */\r\n  onlyIfNotHandled?: boolean;\r\n}\r\n\r\n/**\r\n * Content rule specifications which define what content is returned\r\n * when rule is used.\r\n *\r\n * @public\r\n */\r\nexport declare type ContentSpecification = ContentInstancesOfSpecificClassesSpecification | ContentRelatedInstancesSpecification | SelectedNodeInstancesSpecification;\r\n"]}

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

@@ -6,16 +6,15 @@ import { PropertyCategorySpecification } from "./modifiers/PropertyCategorySpeci
 /**
  * A rule that allows overriding the default property category.
  *
- * The default property category is a category that gets assigned to properties
- * that otherwise have no category.
+ * The default property category is a category that gets assigned to properties that otherwise have no category.
  *
- * @see [More details]($docs/presentation/Content/DefaultPropertyCategoryOverride.md)
+ * @see [Default property category override reference documentation page]($docs/presentation/content/DefaultPropertyCategoryOverride.md)
  * @public
  */
 export interface DefaultPropertyCategoryOverride extends RuleBase {
     /** Used for serializing to JSON. */
     ruleType: RuleTypes.DefaultPropertyCategoryOverride;
-    /** Specification of the category override */
+    /** Specification for the custom property category. */
     specification: PropertyCategorySpecification;
 }
 //# sourceMappingURL=DefaultPropertyCategoryOverride.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"DefaultPropertyCategoryOverride.d.ts","sourceRoot":"","sources":["../../../../../src/presentation-common/rules/content/DefaultPropertyCategoryOverride.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,QAAQ,EAAE,SAAS,EAAE,MAAM,SAAS,CAAC;AAC9C,OAAO,EAAE,6BAA6B,EAAE,MAAM,2CAA2C,CAAC;AAE1F;;;;;;;;GAQG;AACH,MAAM,WAAW,+BAAgC,SAAQ,QAAQ;IAC/D,oCAAoC;IACpC,QAAQ,EAAE,SAAS,CAAC,+BAA+B,CAAC;IAEpD,6CAA6C;IAC7C,aAAa,EAAE,6BAA6B,CAAC;CAC9C"}
+{"version":3,"file":"DefaultPropertyCategoryOverride.d.ts","sourceRoot":"","sources":["../../../../../src/presentation-common/rules/content/DefaultPropertyCategoryOverride.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,QAAQ,EAAE,SAAS,EAAE,MAAM,SAAS,CAAC;AAC9C,OAAO,EAAE,6BAA6B,EAAE,MAAM,2CAA2C,CAAC;AAE1F;;;;;;;GAOG;AACH,MAAM,WAAW,+BAAgC,SAAQ,QAAQ;IAC/D,oCAAoC;IACpC,QAAQ,EAAE,SAAS,CAAC,+BAA+B,CAAC;IAEpD,sDAAsD;IACtD,aAAa,EAAE,6BAA6B,CAAC;CAC9C"}

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

@@ -1 +1 @@
-{"version":3,"file":"DefaultPropertyCategoryOverride.js","sourceRoot":"","sources":["../../../../../src/presentation-common/rules/content/DefaultPropertyCategoryOverride.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\n/** @packageDocumentation\r\n * @module PresentationRules\r\n */\r\n\r\nimport { RuleBase, RuleTypes } from \"../Rule\";\r\nimport { PropertyCategorySpecification } from \"./modifiers/PropertyCategorySpecification\";\r\n\r\n/**\r\n * A rule that allows overriding the default property category.\r\n *\r\n * The default property category is a category that gets assigned to properties\r\n * that otherwise have no category.\r\n *\r\n * @see [More details]($docs/presentation/Content/DefaultPropertyCategoryOverride.md)\r\n * @public\r\n */\r\nexport interface DefaultPropertyCategoryOverride extends RuleBase {\r\n  /** Used for serializing to JSON. */\r\n  ruleType: RuleTypes.DefaultPropertyCategoryOverride;\r\n\r\n  /** Specification of the category override */\r\n  specification: PropertyCategorySpecification;\r\n}\r\n"]}
+{"version":3,"file":"DefaultPropertyCategoryOverride.js","sourceRoot":"","sources":["../../../../../src/presentation-common/rules/content/DefaultPropertyCategoryOverride.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\n/** @packageDocumentation\r\n * @module PresentationRules\r\n */\r\n\r\nimport { RuleBase, RuleTypes } from \"../Rule\";\r\nimport { PropertyCategorySpecification } from \"./modifiers/PropertyCategorySpecification\";\r\n\r\n/**\r\n * A rule that allows overriding the default property category.\r\n *\r\n * The default property category is a category that gets assigned to properties that otherwise have no category.\r\n *\r\n * @see [Default property category override reference documentation page]($docs/presentation/content/DefaultPropertyCategoryOverride.md)\r\n * @public\r\n */\r\nexport interface DefaultPropertyCategoryOverride extends RuleBase {\r\n  /** Used for serializing to JSON. */\r\n  ruleType: RuleTypes.DefaultPropertyCategoryOverride;\r\n\r\n  /** Specification for the custom property category. */\r\n  specification: PropertyCategorySpecification;\r\n}\r\n"]}

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

@@ -6,46 +6,70 @@ import { CategoryIdentifier } from "./modifiers/PropertyCategorySpecification";
 import { PropertyEditorSpecification } from "./modifiers/PropertyEditorsSpecification";
 /**
  * A container structure for possible property overrides
+ *
+ * @see [Property specification reference documentation page]($docs/presentation/content/PropertySpecification.md)
  * @public
  */
 export interface PropertyOverrides {
-    /** Priority of the specified overrides. */
+    /**
+     * There may be multiple property specifications that apply to a single property and there may be conflicts between
+     * different attributes. The `overridesPriority` attribute is here to help solve the problem - if multiple specifications
+     * attempt to override the same attribute, the override of specification with highest `overridesPriority` value is used.
+     * The order of overrides from specification with the same `overridesPriority` is defined by the order they appear in
+     * the overrides list.
+     */
     overridesPriority?: number;
-    /** Label override. May be [localized]($docs/presentation/Advanced/Localization.md). */
+    /** This is an attribute that allows overriding the property label. May be [localized]($docs/presentation/advanced/Localization.md). */
     labelOverride?: string;
-    /** Identifier of a category that should be used for the property. */
+    /** The attribute allows moving the property into a different category. */
     categoryId?: string | CategoryIdentifier;
-    /** Display override. `true` to force display, `false` to force hide, `undefined` to use default. */
-    isDisplayed?: boolean;
-    /** Custom property renderer specification. */
+    /**
+     * This attribute controls whether the particular property is present in the result, even when it is marked as hidden in the
+     * ECSchema. The allowed settings are:
+     *
+     * - Omitted or `undefined`: property visibility is controlled by the ECSchema.
+     *
+     * - `true`: property is made visible. **Warning:** this will automatically hide all other properties of the same class.
+     *   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 | 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
+     * this property and it's up to the UI component to make sure appropriate renderer is used to render the property.
+     */
     renderer?: CustomRendererSpecification;
-    /** Custom property editor specification. */
+    /**
+     * Custom [property editor specification]($docs/presentation/content/PropertyEditorSpecification) that allows assigning
+     * a custom value editor to be used in UI.
+     */
     editor?: PropertyEditorSpecification;
     /**
-     * Flag to control behavior of `isDisplayed` override when it's set to `true`.
-     * By default, forcing property display hides all other properties.
-     * Setting `doNotHideOtherPropertiesOnDisplayOverride` to `true` disables that behavior and
-     * prevents forcing property display of one property from hiding other properties.
+     * This attribute controls whether making the property visible using [[isDisplayed]] attribute should automatically hide
+     * all other properties of the same class. When `true`, this behavior is disabled.
      */
     doNotHideOtherPropertiesOnDisplayOverride?: boolean;
 }
 /**
- * Specification of an ECProperty and its overrides
+ * This specification allows overriding some attributes of specific ECProperty or define how it's displayed.
  *
- * @see [More details]($docs/presentation/Content/PropertySpecification.md)
+ * @see [Property specification reference documentation page]($docs/presentation/content/PropertySpecification.md)
  * @public
  */
 export interface PropertySpecification extends PropertyOverrides {
     /**
-     * Name of the ECProperty.
+     * Name of the ECProperty to apply overrides to. A `"*"` may be specified to match all properties in current context.
+     * The current context is determined based on where the override is specified:
+     *
+     * - When used in a [content modifier]($docs/presentation/content/ContentModifier.md#attribute-propertyoverrides), the
+     *   properties of the ECClass specified by the [`class` attribute]($docs/presentation/content/ContentModifier.md#attribute-class) are used.
      *
-     * A `"*"` may be specified to match all properties in current context:
-     * - when the specification is used in an ECClass context (e.g. in a [[ContentModifier]] rule),
-     *   all properties of that class are matched (including properties derived from base classes, but excluding
-     *   subclass properties).
-     * - when specification is used outside of class context, all properties found in that context are matched. E.g. when
-     *   used in [[ContentSpecification.propertyOverrides]] where [[ContentSpecification]] creates content with properties of
-     *   different classes.
+     * - When used in one of the [content specifications]($docs/presentation/content/ContentRule.md#attribute-specifications),
+     *   properties produced by that specification are used.
      */
     name: string;
 }

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;;;GAGG;AACH,MAAM,WAAW,iBAAiB;IAChC,2CAA2C;IAC3C,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAE3B,uFAAuF;IACvF,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB,qEAAqE;IACrE,UAAU,CAAC,EAAE,MAAM,GAAG,kBAAkB,CAAC;IAEzC,oGAAoG;IACpG,WAAW,CAAC,EAAE,OAAO,CAAC;IAEtB,8CAA8C;IAC9C,QAAQ,CAAC,EAAE,2BAA2B,CAAC;IAEvC,4CAA4C;IAC5C,MAAM,CAAC,EAAE,2BAA2B,CAAC;IAErC;;;;;OAKG;IACH,yCAAyC,CAAC,EAAE,OAAO,CAAC;CACrD;AAED;;;;;GAKG;AACH,MAAM,WAAW,qBAAsB,SAAQ,iBAAiB;IAC9D;;;;;;;;;;OAUG;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 * @public\r\n */\r\nexport interface PropertyOverrides {\r\n  /** Priority of the specified overrides. */\r\n  overridesPriority?: number;\r\n\r\n  /** Label override. May be [localized]($docs/presentation/Advanced/Localization.md). */\r\n  labelOverride?: string;\r\n\r\n  /** Identifier of a category that should be used for the property. */\r\n  categoryId?: string | CategoryIdentifier;\r\n\r\n  /** Display override. `true` to force display, `false` to force hide, `undefined` to use default. */\r\n  isDisplayed?: boolean;\r\n\r\n  /** Custom property renderer specification. */\r\n  renderer?: CustomRendererSpecification;\r\n\r\n  /** Custom property editor specification. */\r\n  editor?: PropertyEditorSpecification;\r\n\r\n  /**\r\n   * Flag to control behavior of `isDisplayed` override when it's set to `true`.\r\n   * By default, forcing property display hides all other properties.\r\n   * Setting `doNotHideOtherPropertiesOnDisplayOverride` to `true` disables that behavior and\r\n   * prevents forcing property display of one property from hiding other properties.\r\n   */\r\n  doNotHideOtherPropertiesOnDisplayOverride?: boolean;\r\n}\r\n\r\n/**\r\n * Specification of an ECProperty and its overrides\r\n *\r\n * @see [More details]($docs/presentation/Content/PropertySpecification.md)\r\n * @public\r\n */\r\nexport interface PropertySpecification extends PropertyOverrides {\r\n  /**\r\n   * Name of the ECProperty.\r\n   *\r\n   * A `\"*\"` may be specified to match all properties in current context:\r\n   * - when the specification is used in an ECClass context (e.g. in a [[ContentModifier]] rule),\r\n   *   all properties of that class are matched (including properties derived from base classes, but excluding\r\n   *   subclass properties).\r\n   * - when specification is used outside of class context, all properties found in that context are matched. E.g. when\r\n   *   used in [[ContentSpecification.propertyOverrides]] where [[ContentSpecification]] creates content with properties of\r\n   *   different classes.\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/SelectedNodeInstancesSpecification.d.ts

@@ -3,31 +3,26 @@
  */
 import { ContentSpecificationBase, ContentSpecificationTypes } from "./ContentSpecification";
 /**
- * Creates content for current selection.
+ * Returns content for selected (input) instances.
  *
- * **Note:** No data is returned for selected custom nodes.
- *
- * @see [More details]($docs/presentation/Content/SelectedNodeInstances.md)
+ * @see [Selected node instances specification reference documentation page]($docs/presentation/content/SelectedNodeInstances.md)
  * @public
  */
 export interface SelectedNodeInstancesSpecification extends ContentSpecificationBase {
     /** Used for serializing to JSON. */
     specType: ContentSpecificationTypes.SelectedNodeInstances;
     /**
-     * Filter selected nodes by specified schema name. All schemas are
-     * accepted if not specified.
+     * Specifies ECSchema name which the input instances have to match for the specification to be used.
      *
      * @pattern ^[\w\d]+$
      */
     acceptableSchemaName?: string;
     /**
-     * Filter selected nodes by specified class names. All classes are
-     * accepted if not specified.
+     * Specifies a list of class names which the input instances have to match for the specification to be used.
      */
     acceptableClassNames?: string[];
     /**
-     * Should [[acceptableClassNames]] property be checked polymorphically. If true, all derived
-     * classes are accepted as well.
+     * Specifies whether derived classes of [[acceptableClassNames]] should be included in the content.
      */
     acceptablePolymorphically?: boolean;
 }

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

@@ -1 +1 @@
-{"version":3,"file":"SelectedNodeInstancesSpecification.d.ts","sourceRoot":"","sources":["../../../../../src/presentation-common/rules/content/SelectedNodeInstancesSpecification.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,wBAAwB,EAAE,yBAAyB,EAAE,MAAM,wBAAwB,CAAC;AAE7F;;;;;;;GAOG;AACH,MAAM,WAAW,kCAAmC,SAAQ,wBAAwB;IAClF,oCAAoC;IACpC,QAAQ,EAAE,yBAAyB,CAAC,qBAAqB,CAAC;IAE1D;;;;;OAKG;IACH,oBAAoB,CAAC,EAAE,MAAM,CAAC;IAE9B;;;OAGG;IACH,oBAAoB,CAAC,EAAE,MAAM,EAAE,CAAC;IAEhC;;;OAGG;IACH,yBAAyB,CAAC,EAAE,OAAO,CAAC;CACrC"}
+{"version":3,"file":"SelectedNodeInstancesSpecification.d.ts","sourceRoot":"","sources":["../../../../../src/presentation-common/rules/content/SelectedNodeInstancesSpecification.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,wBAAwB,EAAE,yBAAyB,EAAE,MAAM,wBAAwB,CAAC;AAE7F;;;;;GAKG;AACH,MAAM,WAAW,kCAAmC,SAAQ,wBAAwB;IAClF,oCAAoC;IACpC,QAAQ,EAAE,yBAAyB,CAAC,qBAAqB,CAAC;IAE1D;;;;OAIG;IACH,oBAAoB,CAAC,EAAE,MAAM,CAAC;IAE9B;;OAEG;IACH,oBAAoB,CAAC,EAAE,MAAM,EAAE,CAAC;IAEhC;;OAEG;IACH,yBAAyB,CAAC,EAAE,OAAO,CAAC;CACrC"}

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

@@ -1 +1 @@
-{"version":3,"file":"SelectedNodeInstancesSpecification.js","sourceRoot":"","sources":["../../../../../src/presentation-common/rules/content/SelectedNodeInstancesSpecification.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 { ContentSpecificationBase, ContentSpecificationTypes } from \"./ContentSpecification\";\r\n\r\n/**\r\n * Creates content for current selection.\r\n *\r\n * **Note:** No data is returned for selected custom nodes.\r\n *\r\n * @see [More details]($docs/presentation/Content/SelectedNodeInstances.md)\r\n * @public\r\n */\r\nexport interface SelectedNodeInstancesSpecification extends ContentSpecificationBase {\r\n  /** Used for serializing to JSON. */\r\n  specType: ContentSpecificationTypes.SelectedNodeInstances;\r\n\r\n  /**\r\n   * Filter selected nodes by specified schema name. All schemas are\r\n   * accepted if not specified.\r\n   *\r\n   * @pattern ^[\\w\\d]+$\r\n   */\r\n  acceptableSchemaName?: string;\r\n\r\n  /**\r\n   * Filter selected nodes by specified class names. All classes are\r\n   * accepted if not specified.\r\n   */\r\n  acceptableClassNames?: string[];\r\n\r\n  /**\r\n   * Should [[acceptableClassNames]] property be checked polymorphically. If true, all derived\r\n   * classes are accepted as well.\r\n   */\r\n  acceptablePolymorphically?: boolean;\r\n}\r\n"]}
+{"version":3,"file":"SelectedNodeInstancesSpecification.js","sourceRoot":"","sources":["../../../../../src/presentation-common/rules/content/SelectedNodeInstancesSpecification.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 { ContentSpecificationBase, ContentSpecificationTypes } from \"./ContentSpecification\";\r\n\r\n/**\r\n * Returns content for selected (input) instances.\r\n *\r\n * @see [Selected node instances specification reference documentation page]($docs/presentation/content/SelectedNodeInstances.md)\r\n * @public\r\n */\r\nexport interface SelectedNodeInstancesSpecification extends ContentSpecificationBase {\r\n  /** Used for serializing to JSON. */\r\n  specType: ContentSpecificationTypes.SelectedNodeInstances;\r\n\r\n  /**\r\n   * Specifies ECSchema name which the input instances have to match for the specification to be used.\r\n   *\r\n   * @pattern ^[\\w\\d]+$\r\n   */\r\n  acceptableSchemaName?: string;\r\n\r\n  /**\r\n   * Specifies a list of class names which the input instances have to match for the specification to be used.\r\n   */\r\n  acceptableClassNames?: string[];\r\n\r\n  /**\r\n   * Specifies whether derived classes of [[acceptableClassNames]] should be included in the content.\r\n   */\r\n  acceptablePolymorphically?: boolean;\r\n}\r\n"]}

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

@@ -2,25 +2,22 @@
  * @module PresentationRules
  */
 /**
- * Sub-specification to include additional calculated properties into the content.
+ * This content modifier allows including additional calculated properties into the content.
  *
- * @see [More details]($docs/presentation/Content/CalculatedPropertiesSpecification.md)
+ * @see [Calculated properties specification reference documentation page]($docs/presentation/content/CalculatedPropertiesSpecification.md)
  * @public
  */
 export interface CalculatedPropertiesSpecification {
-    /** Label of the calculated property. May be [localized]($docs/presentation/Advanced/Localization.md). */
+    /** Specifies label of the calculated property. Supports [localization]($docs/presentation/advanced/Localization.md). */
     label: string;
     /**
-     * [ECExpression]($docs/presentation/Advanced/ECExpressions.md) used to calculate the value. The
-     * following symbol sets are available:
-     * - [ECInstance ECExpression context]($docs/presentation/Advanced/ECExpressions.md#ecinstance)
-     * - [Ruleset variables]($docs/presentation/Advanced/ECExpressions.md#ruleset-variables-user-settings)
+     * Defines an expression to calculate the value. The expression can use [ECInstance]($docs/presentation/advanced/ECExpressions.md#ecinstance)
+     * and [Ruleset Variables]($docs/presentation/advanced/ECExpressions.md#ruleset-variables-user-settings) symbol contexts.
      */
     value: string;
     /**
-     * Priority of the property. Determines the position of this property in UI
-     * components - higher priority means the property should be more visible.
-     * Defaults to `1000`.
+     * Assign a custom [[Field.priority]] to the property. It's up to the UI component to make sure that priority
+     * is respected - properties with higher priority should appear before or above properties with lower priority.
      *
      * @type integer
      */

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

@@ -1 +1 @@
-{"version":3,"file":"CalculatedPropertiesSpecification.d.ts","sourceRoot":"","sources":["../../../../../../src/presentation-common/rules/content/modifiers/CalculatedPropertiesSpecification.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH;;;;;GAKG;AACH,MAAM,WAAW,iCAAiC;IAChD,yGAAyG;IACzG,KAAK,EAAE,MAAM,CAAC;IAEd;;;;;OAKG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;;;;;OAMG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB"}
+{"version":3,"file":"CalculatedPropertiesSpecification.d.ts","sourceRoot":"","sources":["../../../../../../src/presentation-common/rules/content/modifiers/CalculatedPropertiesSpecification.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH;;;;;GAKG;AACH,MAAM,WAAW,iCAAiC;IAChD,wHAAwH;IACxH,KAAK,EAAE,MAAM,CAAC;IAEd;;;OAGG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;;;;OAKG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB"}

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

@@ -1 +1 @@
-{"version":3,"file":"CalculatedPropertiesSpecification.js","sourceRoot":"","sources":["../../../../../../src/presentation-common/rules/content/modifiers/CalculatedPropertiesSpecification.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\n/** @packageDocumentation\r\n * @module PresentationRules\r\n */\r\n\r\n/**\r\n * Sub-specification to include additional calculated properties into the content.\r\n *\r\n * @see [More details]($docs/presentation/Content/CalculatedPropertiesSpecification.md)\r\n * @public\r\n */\r\nexport interface CalculatedPropertiesSpecification {\r\n  /** Label of the calculated property. May be [localized]($docs/presentation/Advanced/Localization.md). */\r\n  label: string;\r\n\r\n  /**\r\n   * [ECExpression]($docs/presentation/Advanced/ECExpressions.md) used to calculate the value. The\r\n   * following symbol sets are available:\r\n   * - [ECInstance ECExpression context]($docs/presentation/Advanced/ECExpressions.md#ecinstance)\r\n   * - [Ruleset variables]($docs/presentation/Advanced/ECExpressions.md#ruleset-variables-user-settings)\r\n   */\r\n  value: string;\r\n\r\n  /**\r\n   * Priority of the property. Determines the position of this property in UI\r\n   * components - higher priority means the property should be more visible.\r\n   * Defaults to `1000`.\r\n   *\r\n   * @type integer\r\n   */\r\n  priority?: number;\r\n}\r\n"]}
+{"version":3,"file":"CalculatedPropertiesSpecification.js","sourceRoot":"","sources":["../../../../../../src/presentation-common/rules/content/modifiers/CalculatedPropertiesSpecification.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\n/** @packageDocumentation\r\n * @module PresentationRules\r\n */\r\n\r\n/**\r\n * This content modifier allows including additional calculated properties into the content.\r\n *\r\n * @see [Calculated properties specification reference documentation page]($docs/presentation/content/CalculatedPropertiesSpecification.md)\r\n * @public\r\n */\r\nexport interface CalculatedPropertiesSpecification {\r\n  /** Specifies label of the calculated property. Supports [localization]($docs/presentation/advanced/Localization.md). */\r\n  label: string;\r\n\r\n  /**\r\n   * Defines an expression to calculate the value. The expression can use [ECInstance]($docs/presentation/advanced/ECExpressions.md#ecinstance)\r\n   * and [Ruleset Variables]($docs/presentation/advanced/ECExpressions.md#ruleset-variables-user-settings) symbol contexts.\r\n   */\r\n  value: string;\r\n\r\n  /**\r\n   * Assign a custom [[Field.priority]] to the property. It's up to the UI component to make sure that priority\r\n   * is respected - properties with higher priority should appear before or above properties with lower priority.\r\n   *\r\n   * @type integer\r\n   */\r\n  priority?: number;\r\n}\r\n"]}

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

@@ -10,38 +10,48 @@ import { RelatedPropertiesSpecification } from "./RelatedPropertiesSpecification
 /**
  * Contains various rule attributes that allow modifying returned content.
  *
- * This is not expected to be used directly - use through either `ContentModifier` or `ContentSpecification`.
+ * This is not expected to be used directly - use through either [[ContentModifier]]
+ * or [[ContentSpecification]].
  *
+ * @see [Content modifier rule reference documentation page]($docs/presentation/content/ContentModifier.md)
  * @public
  */
 export interface ContentModifiersList {
-    /** Specifications for including properties of related instances */
+    /**
+     * Specifications of [related properties]($docs/presentation/content/RelatedPropertiesSpecification.md) which are
+     * included in the generated content.
+     */
     relatedProperties?: RelatedPropertiesSpecification[];
-    /** Specifications for including calculated properties */
+    /**
+     * Specifications of [calculated properties]($docs/presentation/content/CalculatedPropertiesSpecification.md) whose values are
+     * generated using provided [ECExpressions]($docs/presentation/advanced/ECExpressions.md).
+     */
     calculatedProperties?: CalculatedPropertiesSpecification[];
     /**
-     * Specifications for custom categories. Simply defining the categories does
-     * nothing - they have to be referenced from [[PropertySpecification]] defined in
+     * Specifications for [custom categories]($docs/presentation/content/PropertyCategorySpecification.md). Simply defining the categories does
+     * nothing - they have to be referenced from [property specification]($docs/presentation/content/PropertySpecification.md) defined in
      * [[propertyOverrides]] by `id`.
      */
     propertyCategories?: PropertyCategorySpecification[];
-    /** Specifications for various property overrides. */
+    /**
+     * Specifications for various [property overrides]($docs/presentation/content/PropertySpecification.md) that allow customizing property display.
+     */
     propertyOverrides?: PropertySpecification[];
 }
 /**
- * Rule that allows supplementing content with additional
- * specifications for certain ECClasses.
+ * Content modifiers are used to modify how instances of specified ECClasses are displayed in content which is
+ * produced using [content rules]($docs/presentation/content/ContentRule.md). They do not produce any content
+ * by themselves.
  *
- * @see [More details]($docs/presentation/Content/ContentModifier.md)
+ * @see [Content modifier rule reference documentation page]($docs/presentation/content/ContentModifier.md)
  * @public
  */
 export interface ContentModifier extends RuleBase, ContentModifiersList {
     /** Used for serializing to JSON. */
     ruleType: RuleTypes.ContentModifier;
     /**
-     * Specification of ECClass whose content should be supplemented.
-     * The modifier is applied to all ECClasses if this property
-     * is not specified.
+     * Specification of ECClass whose content should be modified. The modifier is applied to all content
+     * if this attribute is not specified.
      */
     class?: SingleSchemaClassSpecification;
 }

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

@@ -1 +1 @@
-{"version":3,"file":"ContentModifier.d.ts","sourceRoot":"","sources":["../../../../../../src/presentation-common/rules/content/modifiers/ContentModifier.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,8BAA8B,EAAE,MAAM,2BAA2B,CAAC;AAC3E,OAAO,EAAE,QAAQ,EAAE,SAAS,EAAE,MAAM,YAAY,CAAC;AACjD,OAAO,EAAE,qBAAqB,EAAE,MAAM,0BAA0B,CAAC;AACjE,OAAO,EAAE,iCAAiC,EAAE,MAAM,qCAAqC,CAAC;AACxF,OAAO,EAAE,6BAA6B,EAAE,MAAM,iCAAiC,CAAC;AAChF,OAAO,EAAE,8BAA8B,EAAE,MAAM,kCAAkC,CAAC;AAElF;;;;;;GAMG;AACH,MAAM,WAAW,oBAAoB;IACnC,mEAAmE;IACnE,iBAAiB,CAAC,EAAE,8BAA8B,EAAE,CAAC;IAErD,yDAAyD;IACzD,oBAAoB,CAAC,EAAE,iCAAiC,EAAE,CAAC;IAE3D;;;;OAIG;IACH,kBAAkB,CAAC,EAAE,6BAA6B,EAAE,CAAC;IAErD,qDAAqD;IACrD,iBAAiB,CAAC,EAAE,qBAAqB,EAAE,CAAC;CAC7C;AAED;;;;;;GAMG;AACH,MAAM,WAAW,eAAgB,SAAQ,QAAQ,EAAE,oBAAoB;IACrE,oCAAoC;IACpC,QAAQ,EAAE,SAAS,CAAC,eAAe,CAAC;IAEpC;;;;OAIG;IACH,KAAK,CAAC,EAAE,8BAA8B,CAAC;CACxC"}
+{"version":3,"file":"ContentModifier.d.ts","sourceRoot":"","sources":["../../../../../../src/presentation-common/rules/content/modifiers/ContentModifier.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,8BAA8B,EAAE,MAAM,2BAA2B,CAAC;AAC3E,OAAO,EAAE,QAAQ,EAAE,SAAS,EAAE,MAAM,YAAY,CAAC;AACjD,OAAO,EAAE,qBAAqB,EAAE,MAAM,0BAA0B,CAAC;AACjE,OAAO,EAAE,iCAAiC,EAAE,MAAM,qCAAqC,CAAC;AACxF,OAAO,EAAE,6BAA6B,EAAE,MAAM,iCAAiC,CAAC;AAChF,OAAO,EAAE,8BAA8B,EAAE,MAAM,kCAAkC,CAAC;AAElF;;;;;;;;GAQG;AACH,MAAM,WAAW,oBAAoB;IACnC;;;OAGG;IACH,iBAAiB,CAAC,EAAE,8BAA8B,EAAE,CAAC;IAErD;;;OAGG;IACH,oBAAoB,CAAC,EAAE,iCAAiC,EAAE,CAAC;IAE3D;;;;OAIG;IACH,kBAAkB,CAAC,EAAE,6BAA6B,EAAE,CAAC;IAErD;;OAEG;IACH,iBAAiB,CAAC,EAAE,qBAAqB,EAAE,CAAC;CAC7C;AAED;;;;;;;GAOG;AACH,MAAM,WAAW,eAAgB,SAAQ,QAAQ,EAAE,oBAAoB;IACrE,oCAAoC;IACpC,QAAQ,EAAE,SAAS,CAAC,eAAe,CAAC;IAEpC;;;OAGG;IACH,KAAK,CAAC,EAAE,8BAA8B,CAAC;CACxC"}

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

@@ -1 +1 @@
-{"version":3,"file":"ContentModifier.js","sourceRoot":"","sources":["../../../../../../src/presentation-common/rules/content/modifiers/ContentModifier.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\n/** @packageDocumentation\r\n * @module PresentationRules\r\n */\r\n\r\nimport { SingleSchemaClassSpecification } from \"../../ClassSpecifications\";\r\nimport { RuleBase, RuleTypes } from \"../../Rule\";\r\nimport { PropertySpecification } from \"../PropertySpecification\";\r\nimport { CalculatedPropertiesSpecification } from \"./CalculatedPropertiesSpecification\";\r\nimport { PropertyCategorySpecification } from \"./PropertyCategorySpecification\";\r\nimport { RelatedPropertiesSpecification } from \"./RelatedPropertiesSpecification\";\r\n\r\n/**\r\n * Contains various rule attributes that allow modifying returned content.\r\n *\r\n * This is not expected to be used directly - use through either `ContentModifier` or `ContentSpecification`.\r\n *\r\n * @public\r\n */\r\nexport interface ContentModifiersList {\r\n  /** Specifications for including properties of related instances */\r\n  relatedProperties?: RelatedPropertiesSpecification[];\r\n\r\n  /** Specifications for including calculated properties */\r\n  calculatedProperties?: CalculatedPropertiesSpecification[];\r\n\r\n  /**\r\n   * Specifications for custom categories. Simply defining the categories does\r\n   * nothing - they have to be referenced from [[PropertySpecification]] defined in\r\n   * [[propertyOverrides]] by `id`.\r\n   */\r\n  propertyCategories?: PropertyCategorySpecification[];\r\n\r\n  /** Specifications for various property overrides. */\r\n  propertyOverrides?: PropertySpecification[];\r\n}\r\n\r\n/**\r\n * Rule that allows supplementing content with additional\r\n * specifications for certain ECClasses.\r\n *\r\n * @see [More details]($docs/presentation/Content/ContentModifier.md)\r\n * @public\r\n */\r\nexport interface ContentModifier extends RuleBase, ContentModifiersList {\r\n  /** Used for serializing to JSON. */\r\n  ruleType: RuleTypes.ContentModifier;\r\n\r\n  /**\r\n   * Specification of ECClass whose content should be supplemented.\r\n   * The modifier is applied to all ECClasses if this property\r\n   * is not specified.\r\n   */\r\n  class?: SingleSchemaClassSpecification;\r\n}\r\n"]}
+{"version":3,"file":"ContentModifier.js","sourceRoot":"","sources":["../../../../../../src/presentation-common/rules/content/modifiers/ContentModifier.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\n/** @packageDocumentation\r\n * @module PresentationRules\r\n */\r\n\r\nimport { SingleSchemaClassSpecification } from \"../../ClassSpecifications\";\r\nimport { RuleBase, RuleTypes } from \"../../Rule\";\r\nimport { PropertySpecification } from \"../PropertySpecification\";\r\nimport { CalculatedPropertiesSpecification } from \"./CalculatedPropertiesSpecification\";\r\nimport { PropertyCategorySpecification } from \"./PropertyCategorySpecification\";\r\nimport { RelatedPropertiesSpecification } from \"./RelatedPropertiesSpecification\";\r\n\r\n/**\r\n * Contains various rule attributes that allow modifying returned content.\r\n *\r\n * This is not expected to be used directly - use through either [[ContentModifier]]\r\n * or [[ContentSpecification]].\r\n *\r\n * @see [Content modifier rule reference documentation page]($docs/presentation/content/ContentModifier.md)\r\n * @public\r\n */\r\nexport interface ContentModifiersList {\r\n  /**\r\n   * Specifications of [related properties]($docs/presentation/content/RelatedPropertiesSpecification.md) which are\r\n   * included in the generated content.\r\n   */\r\n  relatedProperties?: RelatedPropertiesSpecification[];\r\n\r\n  /**\r\n   * Specifications of [calculated properties]($docs/presentation/content/CalculatedPropertiesSpecification.md) whose values are\r\n   * generated using provided [ECExpressions]($docs/presentation/advanced/ECExpressions.md).\r\n   */\r\n  calculatedProperties?: CalculatedPropertiesSpecification[];\r\n\r\n  /**\r\n   * Specifications for [custom categories]($docs/presentation/content/PropertyCategorySpecification.md). Simply defining the categories does\r\n   * nothing - they have to be referenced from [property specification]($docs/presentation/content/PropertySpecification.md) defined in\r\n   * [[propertyOverrides]] by `id`.\r\n   */\r\n  propertyCategories?: PropertyCategorySpecification[];\r\n\r\n  /**\r\n   * Specifications for various [property overrides]($docs/presentation/content/PropertySpecification.md) that allow customizing property display.\r\n   */\r\n  propertyOverrides?: PropertySpecification[];\r\n}\r\n\r\n/**\r\n * Content modifiers are used to modify how instances of specified ECClasses are displayed in content which is\r\n * produced using [content rules]($docs/presentation/content/ContentRule.md). They do not produce any content\r\n * by themselves.\r\n *\r\n * @see [Content modifier rule reference documentation page]($docs/presentation/content/ContentModifier.md)\r\n * @public\r\n */\r\nexport interface ContentModifier extends RuleBase, ContentModifiersList {\r\n  /** Used for serializing to JSON. */\r\n  ruleType: RuleTypes.ContentModifier;\r\n\r\n  /**\r\n   * Specification of ECClass whose content should be modified. The modifier is applied to all content\r\n   * if this attribute is not specified.\r\n   */\r\n  class?: SingleSchemaClassSpecification;\r\n}\r\n"]}

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

@@ -2,11 +2,17 @@
  * @module PresentationRules
  */
 /**
- * Specification for custom content renderer.
+ * This specification allows defining a custom renderer, which can be used to render properties or categories.
+ *
+ * @see [Renderer specification reference documentation page]($docs/presentation/content/RendererSpecification.md)
  * @public
  */
 export interface CustomRendererSpecification {
-    /** Name of the custom renderer. */
+    /**
+     * Name of the renderer that's going to be used in UI components. Value of this attribute corresponds
+     * to [[RendererDescription.name]] attribute that gets assigned to whatever the renderer
+     * is set on.
+     */
     rendererName: string;
 }
 //# sourceMappingURL=CustomRendererSpecification.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"CustomRendererSpecification.d.ts","sourceRoot":"","sources":["../../../../../../src/presentation-common/rules/content/modifiers/CustomRendererSpecification.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH;;;GAGG;AACH,MAAM,WAAW,2BAA2B;IAC1C,mCAAmC;IACnC,YAAY,EAAE,MAAM,CAAC;CACtB"}
+{"version":3,"file":"CustomRendererSpecification.d.ts","sourceRoot":"","sources":["../../../../../../src/presentation-common/rules/content/modifiers/CustomRendererSpecification.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH;;;;;GAKG;AACH,MAAM,WAAW,2BAA2B;IAC1C;;;;OAIG;IACH,YAAY,EAAE,MAAM,CAAC;CACtB"}

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

@@ -1 +1 @@
-{"version":3,"file":"CustomRendererSpecification.js","sourceRoot":"","sources":["../../../../../../src/presentation-common/rules/content/modifiers/CustomRendererSpecification.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\n/** @packageDocumentation\r\n * @module PresentationRules\r\n */\r\n\r\n/**\r\n * Specification for custom content renderer.\r\n * @public\r\n */\r\nexport interface CustomRendererSpecification {\r\n  /** Name of the custom renderer. */\r\n  rendererName: string;\r\n}\r\n"]}
+{"version":3,"file":"CustomRendererSpecification.js","sourceRoot":"","sources":["../../../../../../src/presentation-common/rules/content/modifiers/CustomRendererSpecification.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\n/** @packageDocumentation\r\n * @module PresentationRules\r\n */\r\n\r\n/**\r\n * This specification allows defining a custom renderer, which can be used to render properties or categories.\r\n *\r\n * @see [Renderer specification reference documentation page]($docs/presentation/content/RendererSpecification.md)\r\n * @public\r\n */\r\nexport interface CustomRendererSpecification {\r\n  /**\r\n   * Name of the renderer that's going to be used in UI components. Value of this attribute corresponds\r\n   * to [[RendererDescription.name]] attribute that gets assigned to whatever the renderer\r\n   * is set on.\r\n   */\r\n  rendererName: string;\r\n}\r\n"]}

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

@@ -58,31 +58,51 @@ export interface IdCategoryIdentifier {
  */
 export declare type CategoryIdentifier = ParentCategoryIdentifier | RootCategoryIdentifier | IdCategoryIdentifier;
 /**
- * Specification to define a custom property category.
+ * Content modifier for defining custom property categories. Custom categories are not present in the result unless
+ * they contain at least one property. One way to assign a property to the category is by using
+ * [property overrides]($docs/presentation/content/PropertySpecification.md).
  *
- * @see [More details]($docs/presentation/Content/PropertyCategorySpecification.md)
+ * @see [Property category specification reference documentation page]($docs/presentation/content/PropertyCategorySpecification.md)
  * @public
  */
 export interface PropertyCategorySpecification {
-    /** Category identifier which has to be unique at the scope of it's definition. */
+    /**
+     * Category identifier used to reference the category definition from property overrides or other category
+     * definitions. The identifier has to be unique within the list of category definitions where this
+     * specification is used.
+     */
     id: string;
     /**
-     * Identifier of a parent category. When specified as a `string`,
-     * the value acts as an [[IdCategoryIdentifier]]. Defaults to [[ParentCategoryIdentifier]].
+     * Identifier of a parent category. When specifying the parent category by ID, it has to be available in
+     * the scope of this category definition.
      */
     parentId?: string | CategoryIdentifier | NoCategoryIdentifier;
-    /** Display label of the category. May be [localized]($docs/presentation/Advanced/Localization.md). */
+    /** Display label of the category. May be [localized]($docs/presentation/advanced/Localization.md). */
     label: string;
-    /** Optional extensive description of the category. */
+    /**
+     * Extensive description of the category. The description is assigned to the category object that's set
+     * on content fields and it's up to UI component to decide how the description is displayed.
+     */
     description?: string;
     /**
-     * Priority of the category. Higher priority categories are displayed on top. Defaults to `1000`.
+     * Assign a custom [[CategoryDescription.priority]] to the category. It's up to the
+     * UI component to make sure that priority is respected - categories with higher priority should appear
+     * before or above categories with lower priority.
+     *
      * @type integer
      */
     priority?: number;
-    /** Should this category be auto-expanded. Defaults to `false`. */
+    /**
+     * Controls the value of [[CategoryDescription.expand]] which tells the UI component
+     * displaying the category to auto-expand the category.
+     */
     autoExpand?: boolean;
-    /** Custom category renderer specification. */
+    /**
+     * Custom category [renderer specification]($docs/presentation/content/RendererSpecification.md) that allows
+     * assigning a custom category renderer to be used in UI. This specification is used to set up
+     * [[CategoryDescription.renderer]] for this category and it's up to the UI component to
+     * make sure appropriate renderer is used to render the category.
+     */
     renderer?: CustomRendererSpecification;
 }
 //# sourceMappingURL=PropertyCategorySpecification.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"PropertyCategorySpecification.d.ts","sourceRoot":"","sources":["../../../../../../src/presentation-common/rules/content/modifiers/PropertyCategorySpecification.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,2BAA2B,EAAE,MAAM,+BAA+B,CAAC;AAE5E;;;;;GAKG;AACH,MAAM,WAAW,oBAAoB;IACnC,6BAA6B;IAC7B,IAAI,EAAE,MAAM,CAAC;CACd;AAED;;;;;;;;;;GAUG;AACH,MAAM,WAAW,wBAAwB;IACvC,6BAA6B;IAC7B,IAAI,EAAE,eAAe,CAAC;CACvB;AAED;;;;;;;;;;GAUG;AACH,MAAM,WAAW,sBAAsB;IACrC,6BAA6B;IAC7B,IAAI,EAAE,MAAM,CAAC;CACd;AAED;;;GAGG;AACH,MAAM,WAAW,oBAAoB;IACnC,6BAA6B;IAC7B,IAAI,EAAE,IAAI,CAAC;IAEX,uDAAuD;IACvD,UAAU,EAAE,MAAM,CAAC;CACpB;AAED;;;GAGG;AACH,oBAAY,kBAAkB,GAAG,wBAAwB,GAAG,sBAAsB,GAAG,oBAAoB,CAAC;AAE1G;;;;;GAKG;AACH,MAAM,WAAW,6BAA6B;IAC5C,kFAAkF;IAClF,EAAE,EAAE,MAAM,CAAC;IAEX;;;OAGG;IACH,QAAQ,CAAC,EAAE,MAAM,GAAG,kBAAkB,GAAG,oBAAoB,CAAC;IAE9D,sGAAsG;IACtG,KAAK,EAAE,MAAM,CAAC;IAEd,sDAAsD;IACtD,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;;OAGG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB,kEAAkE;IAClE,UAAU,CAAC,EAAE,OAAO,CAAC;IAErB,8CAA8C;IAC9C,QAAQ,CAAC,EAAE,2BAA2B,CAAC;CACxC"}
+{"version":3,"file":"PropertyCategorySpecification.d.ts","sourceRoot":"","sources":["../../../../../../src/presentation-common/rules/content/modifiers/PropertyCategorySpecification.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,2BAA2B,EAAE,MAAM,+BAA+B,CAAC;AAE5E;;;;;GAKG;AACH,MAAM,WAAW,oBAAoB;IACnC,6BAA6B;IAC7B,IAAI,EAAE,MAAM,CAAC;CACd;AAED;;;;;;;;;;GAUG;AACH,MAAM,WAAW,wBAAwB;IACvC,6BAA6B;IAC7B,IAAI,EAAE,eAAe,CAAC;CACvB;AAED;;;;;;;;;;GAUG;AACH,MAAM,WAAW,sBAAsB;IACrC,6BAA6B;IAC7B,IAAI,EAAE,MAAM,CAAC;CACd;AAED;;;GAGG;AACH,MAAM,WAAW,oBAAoB;IACnC,6BAA6B;IAC7B,IAAI,EAAE,IAAI,CAAC;IAEX,uDAAuD;IACvD,UAAU,EAAE,MAAM,CAAC;CACpB;AAED;;;GAGG;AACH,oBAAY,kBAAkB,GAAG,wBAAwB,GAAG,sBAAsB,GAAG,oBAAoB,CAAC;AAE1G;;;;;;;GAOG;AACH,MAAM,WAAW,6BAA6B;IAC5C;;;;OAIG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;;OAGG;IACH,QAAQ,CAAC,EAAE,MAAM,GAAG,kBAAkB,GAAG,oBAAoB,CAAC;IAE9D,sGAAsG;IACtG,KAAK,EAAE,MAAM,CAAC;IAEd;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;;;;;OAMG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;;OAGG;IACH,UAAU,CAAC,EAAE,OAAO,CAAC;IAErB;;;;;OAKG;IACH,QAAQ,CAAC,EAAE,2BAA2B,CAAC;CACxC"}

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

@@ -1 +1 @@
-{"version":3,"file":"PropertyCategorySpecification.js","sourceRoot":"","sources":["../../../../../../src/presentation-common/rules/content/modifiers/PropertyCategorySpecification.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 \"./CustomRendererSpecification\";\r\n\r\n/**\r\n * Identifier for no category. Used to make category displayed at root level by using\r\n * this identifier for [[PropertyCategorySpecification.parentId]].\r\n *\r\n * @public\r\n */\r\nexport interface NoCategoryIdentifier {\r\n  /** Type of the identifier */\r\n  type: \"None\";\r\n}\r\n\r\n/**\r\n * Identifier of the default parent category.\r\n *\r\n * For direct properties it's the default category. See [[DefaultPropertyCategoryOverride]] for overriding the default category.\r\n *\r\n * For related properties it's the category made up from the related ECClass defined by the **last**\r\n * [[RelatedPropertiesSpecification]] with [[RelationshipMeaning.RelatedInstance]]. If there's no such specification,\r\n * the default category is used.\r\n *\r\n * @public\r\n */\r\nexport interface ParentCategoryIdentifier {\r\n  /** Type of the identifier */\r\n  type: \"DefaultParent\";\r\n}\r\n\r\n/**\r\n * Identifier of the root category.\r\n *\r\n * For direct properties it's the default category. See [[DefaultPropertyCategoryOverride]] for overriding the default category.\r\n *\r\n * For related properties it's the category made up from the related ECClass defined by the **first**\r\n * [[RelatedPropertiesSpecification]] with [[RelationshipMeaning.RelatedInstance]]. If there's no such specification,\r\n * the default category is used.\r\n *\r\n * @public\r\n */\r\nexport interface RootCategoryIdentifier {\r\n  /** Type of the identifier */\r\n  type: \"Root\";\r\n}\r\n\r\n/**\r\n * Identifier of a category specified through [[PropertyCategorySpecification]] in this scope.\r\n * @public\r\n */\r\nexport interface IdCategoryIdentifier {\r\n  /** Type of the identifier */\r\n  type: \"Id\";\r\n\r\n  /** ID of the category pointed to by this identifier */\r\n  categoryId: string;\r\n}\r\n\r\n/**\r\n * Category identifier used to assign properties to a category.\r\n * @public\r\n */\r\nexport type CategoryIdentifier = ParentCategoryIdentifier | RootCategoryIdentifier | IdCategoryIdentifier;\r\n\r\n/**\r\n * Specification to define a custom property category.\r\n *\r\n * @see [More details]($docs/presentation/Content/PropertyCategorySpecification.md)\r\n * @public\r\n */\r\nexport interface PropertyCategorySpecification {\r\n  /** Category identifier which has to be unique at the scope of it's definition. */\r\n  id: string;\r\n\r\n  /**\r\n   * Identifier of a parent category. When specified as a `string`,\r\n   * the value acts as an [[IdCategoryIdentifier]]. Defaults to [[ParentCategoryIdentifier]].\r\n   */\r\n  parentId?: string | CategoryIdentifier | NoCategoryIdentifier;\r\n\r\n  /** Display label of the category. May be [localized]($docs/presentation/Advanced/Localization.md). */\r\n  label: string;\r\n\r\n  /** Optional extensive description of the category. */\r\n  description?: string;\r\n\r\n  /**\r\n   * Priority of the category. Higher priority categories are displayed on top. Defaults to `1000`.\r\n   * @type integer\r\n   */\r\n  priority?: number;\r\n\r\n  /** Should this category be auto-expanded. Defaults to `false`. */\r\n  autoExpand?: boolean;\r\n\r\n  /** Custom category renderer specification. */\r\n  renderer?: CustomRendererSpecification;\r\n}\r\n"]}
+{"version":3,"file":"PropertyCategorySpecification.js","sourceRoot":"","sources":["../../../../../../src/presentation-common/rules/content/modifiers/PropertyCategorySpecification.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 \"./CustomRendererSpecification\";\r\n\r\n/**\r\n * Identifier for no category. Used to make category displayed at root level by using\r\n * this identifier for [[PropertyCategorySpecification.parentId]].\r\n *\r\n * @public\r\n */\r\nexport interface NoCategoryIdentifier {\r\n  /** Type of the identifier */\r\n  type: \"None\";\r\n}\r\n\r\n/**\r\n * Identifier of the default parent category.\r\n *\r\n * For direct properties it's the default category. See [[DefaultPropertyCategoryOverride]] for overriding the default category.\r\n *\r\n * For related properties it's the category made up from the related ECClass defined by the **last**\r\n * [[RelatedPropertiesSpecification]] with [[RelationshipMeaning.RelatedInstance]]. If there's no such specification,\r\n * the default category is used.\r\n *\r\n * @public\r\n */\r\nexport interface ParentCategoryIdentifier {\r\n  /** Type of the identifier */\r\n  type: \"DefaultParent\";\r\n}\r\n\r\n/**\r\n * Identifier of the root category.\r\n *\r\n * For direct properties it's the default category. See [[DefaultPropertyCategoryOverride]] for overriding the default category.\r\n *\r\n * For related properties it's the category made up from the related ECClass defined by the **first**\r\n * [[RelatedPropertiesSpecification]] with [[RelationshipMeaning.RelatedInstance]]. If there's no such specification,\r\n * the default category is used.\r\n *\r\n * @public\r\n */\r\nexport interface RootCategoryIdentifier {\r\n  /** Type of the identifier */\r\n  type: \"Root\";\r\n}\r\n\r\n/**\r\n * Identifier of a category specified through [[PropertyCategorySpecification]] in this scope.\r\n * @public\r\n */\r\nexport interface IdCategoryIdentifier {\r\n  /** Type of the identifier */\r\n  type: \"Id\";\r\n\r\n  /** ID of the category pointed to by this identifier */\r\n  categoryId: string;\r\n}\r\n\r\n/**\r\n * Category identifier used to assign properties to a category.\r\n * @public\r\n */\r\nexport type CategoryIdentifier = ParentCategoryIdentifier | RootCategoryIdentifier | IdCategoryIdentifier;\r\n\r\n/**\r\n * Content modifier for defining custom property categories. Custom categories are not present in the result unless\r\n * they contain at least one property. One way to assign a property to the category is by using\r\n * [property overrides]($docs/presentation/content/PropertySpecification.md).\r\n *\r\n * @see [Property category specification reference documentation page]($docs/presentation/content/PropertyCategorySpecification.md)\r\n * @public\r\n */\r\nexport interface PropertyCategorySpecification {\r\n  /**\r\n   * Category identifier used to reference the category definition from property overrides or other category\r\n   * definitions. The identifier has to be unique within the list of category definitions where this\r\n   * specification is used.\r\n   */\r\n  id: string;\r\n\r\n  /**\r\n   * Identifier of a parent category. When specifying the parent category by ID, it has to be available in\r\n   * the scope of this category definition.\r\n   */\r\n  parentId?: string | CategoryIdentifier | NoCategoryIdentifier;\r\n\r\n  /** Display label of the category. May be [localized]($docs/presentation/advanced/Localization.md). */\r\n  label: string;\r\n\r\n  /**\r\n   * Extensive description of the category. The description is assigned to the category object that's set\r\n   * on content fields and it's up to UI component to decide how the description is displayed.\r\n   */\r\n  description?: string;\r\n\r\n  /**\r\n   * Assign a custom [[CategoryDescription.priority]] to the category. It's up to the\r\n   * UI component to make sure that priority is respected - categories with higher priority should appear\r\n   * before or above categories with lower priority.\r\n   *\r\n   * @type integer\r\n   */\r\n  priority?: number;\r\n\r\n  /**\r\n   * Controls the value of [[CategoryDescription.expand]] which tells the UI component\r\n   * displaying the category to auto-expand the category.\r\n   */\r\n  autoExpand?: boolean;\r\n\r\n  /**\r\n   * Custom category [renderer specification]($docs/presentation/content/RendererSpecification.md) that allows\r\n   * assigning a custom category renderer to be used in UI. This specification is used to set up\r\n   * [[CategoryDescription.renderer]] for this category and it's up to the UI component to\r\n   * make sure appropriate renderer is used to render the category.\r\n   */\r\n  renderer?: CustomRendererSpecification;\r\n}\r\n"]}

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

@@ -2,16 +2,21 @@
  * @module PresentationRules
  */
 /**
- * Specification for custom property editor
+ * This specification allows assigning a custom property editor to specific properties.
  *
- * @see [More details]($docs/presentation/Content/PropertyEditorSpecification.md)
+ * @see [Property editor specification specification reference documentation page]($docs/presentation/content/PropertyEditorSpecification.md)
  * @public
  */
 export interface PropertyEditorSpecification {
-    /** Name of the custom editor */
+    /**
+     * 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
+     * Parameters for the editor.
+     * @note At this moment the attribute is not used.
      * @public
      */
     parameters?: PropertyEditorParameters[];

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

@@ -1 +1 @@
-{"version":3,"file":"PropertyEditorsSpecification.d.ts","sourceRoot":"","sources":["../../../../../../src/presentation-common/rules/content/modifiers/PropertyEditorsSpecification.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH;;;;;GAKG;AACH,MAAM,WAAW,2BAA2B;IAC1C,gCAAgC;IAChC,UAAU,EAAE,MAAM,CAAC;IAEnB;;;OAGG;IACH,UAAU,CAAC,EAAE,wBAAwB,EAAE,CAAC;CACzC;AAED;;;GAGG;AACH,MAAM,CAAC,OAAO,MAAM,wBAAwB,GAAG,4BAA4B,GAAG,iCAAiC,GAAG,6BAA6B,GAAG,8BAA8B,CAAC;AAEjL;;;GAGG;AACH,oBAAY,4BAA4B;IACtC,IAAI,SAAS;IACb,SAAS,cAAc;IACvB,KAAK,UAAU;IACf,MAAM,WAAW;CAClB;AAED;;;;GAIG;AACH,MAAM,WAAW,4BAA4B;IAC3C,oCAAoC;IACpC,UAAU,EAAE,4BAA4B,CAAC;CAC1C;AAED;;;GAGG;AACH,MAAM,WAAW,4BAA6B,SAAQ,4BAA4B;IAChF,oCAAoC;IACpC,UAAU,EAAE,4BAA4B,CAAC,IAAI,CAAC;IAE9C,8DAA8D;IAC9D,IAAI,EAAE,GAAG,CAAC;CACX;AAED;;;GAGG;AACH,MAAM,WAAW,iCAAkC,SAAQ,4BAA4B;IACrF,oCAAoC;IACpC,UAAU,EAAE,4BAA4B,CAAC,SAAS,CAAC;IAEnD;;;;;OAKG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED;;;GAGG;AACH,MAAM,WAAW,6BAA8B,SAAQ,4BAA4B;IACjF,oCAAoC;IACpC,UAAU,EAAE,4BAA4B,CAAC,KAAK,CAAC;IAE/C,kCAAkC;IAClC,GAAG,CAAC,EAAE,MAAM,CAAC;IAEb,kCAAkC;IAClC,GAAG,CAAC,EAAE,MAAM,CAAC;CACd;AAED;;;GAGG;AACH,MAAM,WAAW,8BAA+B,SAAQ,4BAA4B;IAClF,oCAAoC;IACpC,UAAU,EAAE,4BAA4B,CAAC,MAAM,CAAC;IAEhD,qCAAqC;IACrC,GAAG,EAAE,MAAM,CAAC;IAEZ,qCAAqC;IACrC,GAAG,EAAE,MAAM,CAAC;IAEZ;;;;;OAKG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB,0BAA0B;IAC1B,UAAU,CAAC,EAAE,OAAO,CAAC;CACtB"}
+{"version":3,"file":"PropertyEditorsSpecification.d.ts","sourceRoot":"","sources":["../../../../../../src/presentation-common/rules/content/modifiers/PropertyEditorsSpecification.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH;;;;;GAKG;AACH,MAAM,WAAW,2BAA2B;IAC1C;;;;OAIG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;;;OAIG;IACH,UAAU,CAAC,EAAE,wBAAwB,EAAE,CAAC;CACzC;AAED;;;GAGG;AACH,MAAM,CAAC,OAAO,MAAM,wBAAwB,GAAG,4BAA4B,GAAG,iCAAiC,GAAG,6BAA6B,GAAG,8BAA8B,CAAC;AAEjL;;;GAGG;AACH,oBAAY,4BAA4B;IACtC,IAAI,SAAS;IACb,SAAS,cAAc;IACvB,KAAK,UAAU;IACf,MAAM,WAAW;CAClB;AAED;;;;GAIG;AACH,MAAM,WAAW,4BAA4B;IAC3C,oCAAoC;IACpC,UAAU,EAAE,4BAA4B,CAAC;CAC1C;AAED;;;GAGG;AACH,MAAM,WAAW,4BAA6B,SAAQ,4BAA4B;IAChF,oCAAoC;IACpC,UAAU,EAAE,4BAA4B,CAAC,IAAI,CAAC;IAE9C,8DAA8D;IAC9D,IAAI,EAAE,GAAG,CAAC;CACX;AAED;;;GAGG;AACH,MAAM,WAAW,iCAAkC,SAAQ,4BAA4B;IACrF,oCAAoC;IACpC,UAAU,EAAE,4BAA4B,CAAC,SAAS,CAAC;IAEnD;;;;;OAKG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED;;;GAGG;AACH,MAAM,WAAW,6BAA8B,SAAQ,4BAA4B;IACjF,oCAAoC;IACpC,UAAU,EAAE,4BAA4B,CAAC,KAAK,CAAC;IAE/C,kCAAkC;IAClC,GAAG,CAAC,EAAE,MAAM,CAAC;IAEb,kCAAkC;IAClC,GAAG,CAAC,EAAE,MAAM,CAAC;CACd;AAED;;;GAGG;AACH,MAAM,WAAW,8BAA+B,SAAQ,4BAA4B;IAClF,oCAAoC;IACpC,UAAU,EAAE,4BAA4B,CAAC,MAAM,CAAC;IAEhD,qCAAqC;IACrC,GAAG,EAAE,MAAM,CAAC;IAEZ,qCAAqC;IACrC,GAAG,EAAE,MAAM,CAAC;IAEZ;;;;;OAKG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB,0BAA0B;IAC1B,UAAU,CAAC,EAAE,OAAO,CAAC;CACtB"}

package/lib/cjs/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;;;AAyBH;;;GAGG;AACH,IAAY,4BAKX;AALD,WAAY,4BAA4B;IACtC,6CAAa,CAAA;IACb,uDAAuB,CAAA;IACvB,+CAAe,CAAA;IACf,iDAAiB,CAAA;AACnB,CAAC,EALW,4BAA4B,GAA5B,oCAA4B,KAA5B,oCAA4B,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 * Specification for custom property editor\r\n *\r\n * @see [More details]($docs/presentation/Content/PropertyEditorSpecification.md)\r\n * @public\r\n */\r\nexport interface PropertyEditorSpecification {\r\n  /** Name of the custom editor */\r\n  editorName: string;\r\n\r\n  /**\r\n   * Parameters for the editor\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  /** Used for serializing to JSON. */\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: PropertyEditorParameterTypes.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: PropertyEditorParameterTypes.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: PropertyEditorParameterTypes.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: PropertyEditorParameterTypes.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"]}
+{"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,IAAY,4BAKX;AALD,WAAY,4BAA4B;IACtC,6CAAa,CAAA;IACb,uDAAuB,CAAA;IACvB,+CAAe,CAAA;IACf,iDAAiB,CAAA;AACnB,CAAC,EALW,4BAA4B,GAA5B,oCAA4B,KAA5B,oCAA4B,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  /** Used for serializing to JSON. */\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: PropertyEditorParameterTypes.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: PropertyEditorParameterTypes.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: PropertyEditorParameterTypes.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: PropertyEditorParameterTypes.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"]}