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

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

@@ -1,10 +1,10 @@
-"use strict";
-/*---------------------------------------------------------------------------------------------
-* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
-* See LICENSE.md in the project root for license terms and full copyright notice.
-*--------------------------------------------------------------------------------------------*/
-/** @packageDocumentation
- * @module PresentationRules
- */
-Object.defineProperty(exports, "__esModule", { value: true });
+"use strict";
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+/** @packageDocumentation
+ * @module PresentationRules
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
 //# sourceMappingURL=CalculatedPropertiesSpecification.js.map

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 * 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"]}
+{"version":3,"file":"CalculatedPropertiesSpecification.js","sourceRoot":"","sources":["../../../../../../src/presentation-common/rules/content/modifiers/CalculatedPropertiesSpecification.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG","sourcesContent":["/*---------------------------------------------------------------------------------------------\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n* See LICENSE.md in the project root for license terms and full copyright notice.\n*--------------------------------------------------------------------------------------------*/\n/** @packageDocumentation\n * @module PresentationRules\n */\n\n/**\n * This content modifier allows including additional calculated properties into the content.\n *\n * @see [Calculated properties specification reference documentation page]($docs/presentation/content/CalculatedPropertiesSpecification.md)\n * @public\n */\nexport interface CalculatedPropertiesSpecification {\n  /** Specifies label of the calculated property. Supports [localization]($docs/presentation/advanced/Localization.md). */\n  label: string;\n\n  /**\n   * Defines an expression to calculate the value. The expression can use [ECInstance]($docs/presentation/advanced/ECExpressions.md#ecinstance)\n   * and [Ruleset Variables]($docs/presentation/advanced/ECExpressions.md#ruleset-variables-user-settings) symbol contexts.\n   */\n  value: string;\n\n  /**\n   * Assign a custom [[Field.priority]] to the property. It's up to the UI component to make sure that priority\n   * is respected - properties with higher priority should appear before or above properties with lower priority.\n   *\n   * @type integer\n   */\n  priority?: number;\n}\n"]}

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

@@ -1,58 +1,58 @@
-/** @packageDocumentation
- * @module PresentationRules
- */
-import { SingleSchemaClassSpecification } from "../../ClassSpecifications";
-import { RuleBase } from "../../Rule";
-import { PropertySpecification } from "../PropertySpecification";
-import { CalculatedPropertiesSpecification } from "./CalculatedPropertiesSpecification";
-import { PropertyCategorySpecification } from "./PropertyCategorySpecification";
-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]].
- *
- * @see [Content modifier rule reference documentation page]($docs/presentation/content/ContentModifier.md)
- * @public
- */
-export interface ContentModifiersList {
-    /**
-     * Specifications of [related properties]($docs/presentation/content/RelatedPropertiesSpecification.md) which are
-     * included in the generated content.
-     */
-    relatedProperties?: RelatedPropertiesSpecification[];
-    /**
-     * 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]($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]($docs/presentation/content/PropertySpecification.md) that allow customizing property display.
-     */
-    propertyOverrides?: PropertySpecification[];
-}
-/**
- * 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 [Content modifier rule reference documentation page]($docs/presentation/content/ContentModifier.md)
- * @public
- */
-export interface ContentModifier extends RuleBase, ContentModifiersList {
-    /** Used for serializing to JSON. */
-    ruleType: "ContentModifier";
-    /**
-     * Specification of ECClass whose content should be modified. The modifier is applied to all content
-     * if this attribute is not specified.
-     */
-    class?: SingleSchemaClassSpecification;
-}
+/** @packageDocumentation
+ * @module PresentationRules
+ */
+import { SingleSchemaClassSpecification } from "../../ClassSpecifications";
+import { RuleBase } from "../../Rule";
+import { PropertySpecification } from "../PropertySpecification";
+import { CalculatedPropertiesSpecification } from "./CalculatedPropertiesSpecification";
+import { PropertyCategorySpecification } from "./PropertyCategorySpecification";
+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]].
+ *
+ * @see [Content modifier rule reference documentation page]($docs/presentation/content/ContentModifier.md)
+ * @public
+ */
+export interface ContentModifiersList {
+    /**
+     * Specifications of [related properties]($docs/presentation/content/RelatedPropertiesSpecification.md) which are
+     * included in the generated content.
+     */
+    relatedProperties?: RelatedPropertiesSpecification[];
+    /**
+     * 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]($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]($docs/presentation/content/PropertySpecification.md) that allow customizing property display.
+     */
+    propertyOverrides?: PropertySpecification[];
+}
+/**
+ * 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 [Content modifier rule reference documentation page]($docs/presentation/content/ContentModifier.md)
+ * @public
+ */
+export interface ContentModifier extends RuleBase, ContentModifiersList {
+    /** Used for serializing to JSON. */
+    ruleType: "ContentModifier";
+    /**
+     * Specification of ECClass whose content should be modified. The modifier is applied to all content
+     * if this attribute is not specified.
+     */
+    class?: SingleSchemaClassSpecification;
+}
 //# sourceMappingURL=ContentModifier.d.ts.map

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

@@ -1,10 +1,10 @@
-"use strict";
-/*---------------------------------------------------------------------------------------------
-* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
-* See LICENSE.md in the project root for license terms and full copyright notice.
-*--------------------------------------------------------------------------------------------*/
-/** @packageDocumentation
- * @module PresentationRules
- */
-Object.defineProperty(exports, "__esModule", { value: true });
+"use strict";
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+/** @packageDocumentation
+ * @module PresentationRules
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
 //# sourceMappingURL=ContentModifier.js.map

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

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

@@ -1,18 +1,18 @@
-/** @packageDocumentation
- * @module PresentationRules
- */
-/**
- * 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 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;
-}
+/** @packageDocumentation
+ * @module PresentationRules
+ */
+/**
+ * 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 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.js

@@ -1,10 +1,10 @@
-"use strict";
-/*---------------------------------------------------------------------------------------------
-* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
-* See LICENSE.md in the project root for license terms and full copyright notice.
-*--------------------------------------------------------------------------------------------*/
-/** @packageDocumentation
- * @module PresentationRules
- */
-Object.defineProperty(exports, "__esModule", { value: true });
+"use strict";
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+/** @packageDocumentation
+ * @module PresentationRules
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
 //# sourceMappingURL=CustomRendererSpecification.js.map

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

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

@@ -1,108 +1,108 @@
-/** @packageDocumentation
- * @module PresentationRules
- */
-import { CustomRendererSpecification } from "./CustomRendererSpecification";
-/**
- * Identifier for no category. Used to make category displayed at root level by using
- * this identifier for [[PropertyCategorySpecification.parentId]].
- *
- * @public
- */
-export interface NoCategoryIdentifier {
-    /** Type of the identifier */
-    type: "None";
-}
-/**
- * Identifier of the default parent category.
- *
- * For direct properties it's the default category. See [[DefaultPropertyCategoryOverride]] for overriding the default category.
- *
- * For related properties it's the category made up from the related ECClass defined by the **last**
- * [[RelatedPropertiesSpecification]] with [[RelationshipMeaning.RelatedInstance]]. If there's no such specification,
- * the default category is used.
- *
- * @public
- */
-export interface ParentCategoryIdentifier {
-    /** Type of the identifier */
-    type: "DefaultParent";
-}
-/**
- * Identifier of the root category.
- *
- * For direct properties it's the default category. See [[DefaultPropertyCategoryOverride]] for overriding the default category.
- *
- * For related properties it's the category made up from the related ECClass defined by the **first**
- * [[RelatedPropertiesSpecification]] with [[RelationshipMeaning.RelatedInstance]]. If there's no such specification,
- * the default category is used.
- *
- * @public
- */
-export interface RootCategoryIdentifier {
-    /** Type of the identifier */
-    type: "Root";
-}
-/**
- * Identifier of a category specified through [[PropertyCategorySpecification]] in this scope.
- * @public
- */
-export interface IdCategoryIdentifier {
-    /** Type of the identifier */
-    type: "Id";
-    /** ID of the category pointed to by this identifier */
-    categoryId: string;
-}
-/**
- * Category identifier used to assign properties to a category.
- * @public
- */
-export declare type CategoryIdentifier = ParentCategoryIdentifier | RootCategoryIdentifier | IdCategoryIdentifier;
-/**
- * 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 [Property category specification reference documentation page]($docs/presentation/content/PropertyCategorySpecification.md)
- * @public
- */
-export interface PropertyCategorySpecification {
-    /**
-     * 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 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). */
-    label: string;
-    /**
-     * 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;
-    /**
-     * 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;
-    /**
-     * 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]($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;
-}
+/** @packageDocumentation
+ * @module PresentationRules
+ */
+import { CustomRendererSpecification } from "./CustomRendererSpecification";
+/**
+ * Identifier for no category. Used to make category displayed at root level by using
+ * this identifier for [[PropertyCategorySpecification.parentId]].
+ *
+ * @public
+ */
+export interface NoCategoryIdentifier {
+    /** Type of the identifier */
+    type: "None";
+}
+/**
+ * Identifier of the default parent category.
+ *
+ * For direct properties it's the default category. See [[DefaultPropertyCategoryOverride]] for overriding the default category.
+ *
+ * For related properties it's the category made up from the related ECClass defined by the **last**
+ * [[RelatedPropertiesSpecification]] with [[RelationshipMeaning.RelatedInstance]]. If there's no such specification,
+ * the default category is used.
+ *
+ * @public
+ */
+export interface ParentCategoryIdentifier {
+    /** Type of the identifier */
+    type: "DefaultParent";
+}
+/**
+ * Identifier of the root category.
+ *
+ * For direct properties it's the default category. See [[DefaultPropertyCategoryOverride]] for overriding the default category.
+ *
+ * For related properties it's the category made up from the related ECClass defined by the **first**
+ * [[RelatedPropertiesSpecification]] with [[RelationshipMeaning.RelatedInstance]]. If there's no such specification,
+ * the default category is used.
+ *
+ * @public
+ */
+export interface RootCategoryIdentifier {
+    /** Type of the identifier */
+    type: "Root";
+}
+/**
+ * Identifier of a category specified through [[PropertyCategorySpecification]] in this scope.
+ * @public
+ */
+export interface IdCategoryIdentifier {
+    /** Type of the identifier */
+    type: "Id";
+    /** ID of the category pointed to by this identifier */
+    categoryId: string;
+}
+/**
+ * Category identifier used to assign properties to a category.
+ * @public
+ */
+export declare type CategoryIdentifier = ParentCategoryIdentifier | RootCategoryIdentifier | IdCategoryIdentifier;
+/**
+ * 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 [Property category specification reference documentation page]($docs/presentation/content/PropertyCategorySpecification.md)
+ * @public
+ */
+export interface PropertyCategorySpecification {
+    /**
+     * 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 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). */
+    label: string;
+    /**
+     * 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;
+    /**
+     * 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;
+    /**
+     * 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]($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.js

@@ -1,10 +1,10 @@
-"use strict";
-/*---------------------------------------------------------------------------------------------
-* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
-* See LICENSE.md in the project root for license terms and full copyright notice.
-*--------------------------------------------------------------------------------------------*/
-/** @packageDocumentation
- * @module PresentationRules
- */
-Object.defineProperty(exports, "__esModule", { value: true });
+"use strict";
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+/** @packageDocumentation
+ * @module PresentationRules
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
 //# sourceMappingURL=PropertyCategorySpecification.js.map

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