@itwin/presentation-common 3.6.0-dev.52 → 3.6.0-dev.53

package/lib/cjs/presentation-common/rules/customization/ImageIdOverride.js.map

@@ -1 +1 @@
-{"version":3,"file":"ImageIdOverride.js","sourceRoot":"","sources":["../../../../../src/presentation-common/rules/customization/ImageIdOverride.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\n\r\n/**\r\n * ImageId override rules allow setting an image ID to specific types of ECInstances.\r\n *\r\n * @see [Image ID override reference documentation page]($docs/presentation/customization/ImageIdOverride.md)\r\n * @public\r\n * @deprecated Use [[ExtendedDataRule]] instead. See [extended data usage page]($docs/presentation/customization/ExtendedDataUsage.md) for more details.\r\n */\r\nexport interface ImageIdOverride extends RuleBase {\r\n  /** Used for serializing to JSON. */\r\n  ruleType: RuleTypes.ImageIdOverride;\r\n\r\n  /**\r\n   * Defines a condition for the rule, which needs to be met in order to execute it. Condition\r\n   * is an [ECExpression]($docs/presentation/advanced/ECExpressions.md), which can use\r\n   * a [limited set of symbols]($docs/presentation/customization/ECExpressions.md#rule-condition).\r\n   */\r\n  condition?: string;\r\n\r\n  /**\r\n   * An expression whose result becomes the image ID. This is\r\n   * an [ECExpression]($docs/presentation/customization/ECExpressions.md), so ID can be\r\n   * defined/formatted dynamically based on the context - for example ECInstance property value.\r\n   *\r\n   * @minLength 1\r\n   */\r\n  imageIdExpression: string;\r\n}\r\n"]}
+{"version":3,"file":"ImageIdOverride.js","sourceRoot":"","sources":["../../../../../src/presentation-common/rules/customization/ImageIdOverride.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 { RuleBase, RuleTypes } from \"../Rule\";\n\n/**\n * ImageId override rules allow setting an image ID to specific types of ECInstances.\n *\n * @see [Image ID override reference documentation page]($docs/presentation/customization/ImageIdOverride.md)\n * @public\n * @deprecated in 3.x. Use [[ExtendedDataRule]] instead. See [extended data usage page]($docs/presentation/customization/ExtendedDataUsage.md) for more details.\n */\nexport interface ImageIdOverride extends RuleBase {\n  /** Used for serializing to JSON. */\n  ruleType: RuleTypes.ImageIdOverride;\n\n  /**\n   * Defines a condition for the rule, which needs to be met in order to execute it. Condition\n   * is an [ECExpression]($docs/presentation/advanced/ECExpressions.md), which can use\n   * a [limited set of symbols]($docs/presentation/customization/ECExpressions.md#rule-condition).\n   */\n  condition?: string;\n\n  /**\n   * An expression whose result becomes the image ID. This is\n   * an [ECExpression]($docs/presentation/customization/ECExpressions.md), so ID can be\n   * defined/formatted dynamically based on the context - for example ECInstance property value.\n   *\n   * @minLength 1\n   */\n  imageIdExpression: string;\n}\n"]}

package/lib/cjs/presentation-common/rules/customization/InstanceLabelOverride.d.ts

@@ -1,157 +1,157 @@
-/** @packageDocumentation
- * @module PresentationRules
- */
-import { SingleSchemaClassSpecification } from "../ClassSpecifications";
-import { RelationshipPathSpecification } from "../RelationshipPathSpecification";
-import { RuleBase, RuleTypes } from "../Rule";
-/**
- * Instance label override rule provides a way to set instance label to one of its property values,
- * other attributes and/or combination of them.
- *
- * @see [Instance label override reference documentation page]($docs/presentation/customization/InstanceLabelOverride.md)
- * @public
- */
-export interface InstanceLabelOverride extends RuleBase {
-    /** Used for serializing to JSON. */
-    ruleType: RuleTypes.InstanceLabelOverride;
-    /**
-     * Specifies the ECClass to apply this rule to.
-     */
-    class: SingleSchemaClassSpecification;
-    /**
-     * Specifications of values used to override label. The first non-empty value is used as the actual label.
-     */
-    values: InstanceLabelOverrideValueSpecification[];
-}
-/**
- * Types of possible [[InstanceLabelOverride]] label values.
- * @public
- */
-export declare enum InstanceLabelOverrideValueSpecificationType {
-    Composite = "Composite",
-    Property = "Property",
-    ClassName = "ClassName",
-    ClassLabel = "ClassLabel",
-    BriefcaseId = "BriefcaseId",
-    LocalId = "LocalId",
-    String = "String",
-    RelatedInstanceLabel = "RelatedInstanceLabel"
-}
-/**
- * Base interface for all [[InstanceLabelOverrideValueSpecification]] implementations.
- * @public
- */
-export interface InstanceLabelOverrideValueSpecificationBase {
-    /** Type of the specification */
-    specType: InstanceLabelOverrideValueSpecificationType;
-}
-/**
- * Specification allows creating a label value composited using multiple other specifications.
- *
- * @see [Composite value specification reference documentation page]($docs/presentation/customization/InstanceLabelOverride.md#composite-value-specification)
- * @public
- */
-export interface InstanceLabelOverrideCompositeValueSpecification extends InstanceLabelOverrideValueSpecificationBase {
-    specType: InstanceLabelOverrideValueSpecificationType.Composite;
-    /**
-     * Parts of the value.
-     *
-     * If any of the parts with `isRequired` flag evaluate to an empty string, the
-     * result of this specification is also an empty string.
-     */
-    parts: Array<{
-        spec: InstanceLabelOverrideValueSpecification;
-        isRequired?: boolean;
-    }>;
-    /** Separator to use when joining the parts. Defaults to a space character. */
-    separator?: string;
-}
-/**
- * Specification uses property value as the label content.
- *
- * @see [Property value specification reference documentation page]($docs/presentation/customization/InstanceLabelOverride.md#property-value-specification)
- * @public
- */
-export interface InstanceLabelOverridePropertyValueSpecification extends InstanceLabelOverrideValueSpecificationBase {
-    specType: InstanceLabelOverrideValueSpecificationType.Property;
-    /**
-     * Name of the property whose value should be used.
-     * @note A property with this name must exist on the property class (see [[propertySource]]).
-     */
-    propertyName: string;
-    /**
-     * [Specification of the relationship path]($docs/presentation/RelationshipPathSpecification.md) from `InstanceLabelOverride.class`
-     * to class of the property. If omitted, `InstanceLabelOverride.class` is used as property class.
-     * @beta
-     */
-    propertySource?: RelationshipPathSpecification;
-}
-/**
- * Specification uses ECClass name as the label content.
- *
- * @see [Class name value specification reference documentation page]($docs/presentation/customization/InstanceLabelOverride.md#class-name-value-specification)
- * @public
- */
-export interface InstanceLabelOverrideClassNameSpecification extends InstanceLabelOverrideValueSpecificationBase {
-    specType: InstanceLabelOverrideValueSpecificationType.ClassName;
-    /** Should full (`{schemaName}.{className}`) class name be used */
-    full?: boolean;
-}
-/**
- * Specification uses ECClass display label as the label content.
- *
- * @see [Class label value specification reference documentation page]($docs/presentation/customization/InstanceLabelOverride.md#class-label-value-specification)
- * @public
- */
-export interface InstanceLabelOverrideClassLabelSpecification extends InstanceLabelOverrideValueSpecificationBase {
-    specType: InstanceLabelOverrideValueSpecificationType.ClassLabel;
-}
-/**
- * Specification returns ECInstance's briefcase ID in base36 format.
- *
- * @see [BriefcaseId value specification reference documentation page]($docs/presentation/customization/InstanceLabelOverride.md#briefcaseid-value-specification)
- * @public
- */
-export interface InstanceLabelOverrideBriefcaseIdSpecification extends InstanceLabelOverrideValueSpecificationBase {
-    specType: InstanceLabelOverrideValueSpecificationType.BriefcaseId;
-}
-/**
- * Specification returns ECInstance's local ID in base36 format.
- *
- * @see [LocalId value specification reference documentation page]($docs/presentation/customization/InstanceLabelOverride.md#localid-value-specification)
- * @public
- */
-export interface InstanceLabelOverrideLocalIdSpecification extends InstanceLabelOverrideValueSpecificationBase {
-    specType: InstanceLabelOverrideValueSpecificationType.LocalId;
-}
-/**
- * Specification uses the specified value as the label content.
- *
- * @see [String value specification reference documentation page]($docs/presentation/customization/InstanceLabelOverride.md#string-value-specification)
- * @public
- */
-export interface InstanceLabelOverrideStringValueSpecification extends InstanceLabelOverrideValueSpecificationBase {
-    specType: InstanceLabelOverrideValueSpecificationType.String;
-    /** The value to use as the label content. */
-    value: string;
-}
-/**
- * Specification uses label of another related instance as the label content.
- *
- * @see [Related instance label value specification reference documentation page]($docs/presentation/customization/InstanceLabelOverride.md#related-instance-label-value-specification)
- * @public
- */
-export interface InstanceLabelOverrideRelatedInstanceLabelSpecification extends InstanceLabelOverrideValueSpecificationBase {
-    specType: InstanceLabelOverrideValueSpecificationType.RelatedInstanceLabel;
-    /**
-     * [Specification of the relationship path]($docs/presentation/RelationshipPathSpecification.md) from `InstanceLabelOverride.class`
-     * to class of the related instance.
-     */
-    pathToRelatedInstance: RelationshipPathSpecification;
-}
-/**
- * Specification to define how the label for [[InstanceLabelOverride]] should be created.
- * @public
- */
-export declare type InstanceLabelOverrideValueSpecification = InstanceLabelOverrideCompositeValueSpecification | InstanceLabelOverridePropertyValueSpecification | InstanceLabelOverrideStringValueSpecification | InstanceLabelOverrideClassNameSpecification | InstanceLabelOverrideClassLabelSpecification | InstanceLabelOverrideBriefcaseIdSpecification | InstanceLabelOverrideLocalIdSpecification | InstanceLabelOverrideRelatedInstanceLabelSpecification;
+/** @packageDocumentation
+ * @module PresentationRules
+ */
+import { SingleSchemaClassSpecification } from "../ClassSpecifications";
+import { RelationshipPathSpecification } from "../RelationshipPathSpecification";
+import { RuleBase, RuleTypes } from "../Rule";
+/**
+ * Instance label override rule provides a way to set instance label to one of its property values,
+ * other attributes and/or combination of them.
+ *
+ * @see [Instance label override reference documentation page]($docs/presentation/customization/InstanceLabelOverride.md)
+ * @public
+ */
+export interface InstanceLabelOverride extends RuleBase {
+    /** Used for serializing to JSON. */
+    ruleType: RuleTypes.InstanceLabelOverride;
+    /**
+     * Specifies the ECClass to apply this rule to.
+     */
+    class: SingleSchemaClassSpecification;
+    /**
+     * Specifications of values used to override label. The first non-empty value is used as the actual label.
+     */
+    values: InstanceLabelOverrideValueSpecification[];
+}
+/**
+ * Types of possible [[InstanceLabelOverride]] label values.
+ * @public
+ */
+export declare enum InstanceLabelOverrideValueSpecificationType {
+    Composite = "Composite",
+    Property = "Property",
+    ClassName = "ClassName",
+    ClassLabel = "ClassLabel",
+    BriefcaseId = "BriefcaseId",
+    LocalId = "LocalId",
+    String = "String",
+    RelatedInstanceLabel = "RelatedInstanceLabel"
+}
+/**
+ * Base interface for all [[InstanceLabelOverrideValueSpecification]] implementations.
+ * @public
+ */
+export interface InstanceLabelOverrideValueSpecificationBase {
+    /** Type of the specification */
+    specType: InstanceLabelOverrideValueSpecificationType;
+}
+/**
+ * Specification allows creating a label value composited using multiple other specifications.
+ *
+ * @see [Composite value specification reference documentation page]($docs/presentation/customization/InstanceLabelOverride.md#composite-value-specification)
+ * @public
+ */
+export interface InstanceLabelOverrideCompositeValueSpecification extends InstanceLabelOverrideValueSpecificationBase {
+    specType: InstanceLabelOverrideValueSpecificationType.Composite;
+    /**
+     * Parts of the value.
+     *
+     * If any of the parts with `isRequired` flag evaluate to an empty string, the
+     * result of this specification is also an empty string.
+     */
+    parts: Array<{
+        spec: InstanceLabelOverrideValueSpecification;
+        isRequired?: boolean;
+    }>;
+    /** Separator to use when joining the parts. Defaults to a space character. */
+    separator?: string;
+}
+/**
+ * Specification uses property value as the label content.
+ *
+ * @see [Property value specification reference documentation page]($docs/presentation/customization/InstanceLabelOverride.md#property-value-specification)
+ * @public
+ */
+export interface InstanceLabelOverridePropertyValueSpecification extends InstanceLabelOverrideValueSpecificationBase {
+    specType: InstanceLabelOverrideValueSpecificationType.Property;
+    /**
+     * Name of the property whose value should be used.
+     * @note A property with this name must exist on the property class (see [[propertySource]]).
+     */
+    propertyName: string;
+    /**
+     * [Specification of the relationship path]($docs/presentation/RelationshipPathSpecification.md) from `InstanceLabelOverride.class`
+     * to class of the property. If omitted, `InstanceLabelOverride.class` is used as property class.
+     * @beta
+     */
+    propertySource?: RelationshipPathSpecification;
+}
+/**
+ * Specification uses ECClass name as the label content.
+ *
+ * @see [Class name value specification reference documentation page]($docs/presentation/customization/InstanceLabelOverride.md#class-name-value-specification)
+ * @public
+ */
+export interface InstanceLabelOverrideClassNameSpecification extends InstanceLabelOverrideValueSpecificationBase {
+    specType: InstanceLabelOverrideValueSpecificationType.ClassName;
+    /** Should full (`{schemaName}.{className}`) class name be used */
+    full?: boolean;
+}
+/**
+ * Specification uses ECClass display label as the label content.
+ *
+ * @see [Class label value specification reference documentation page]($docs/presentation/customization/InstanceLabelOverride.md#class-label-value-specification)
+ * @public
+ */
+export interface InstanceLabelOverrideClassLabelSpecification extends InstanceLabelOverrideValueSpecificationBase {
+    specType: InstanceLabelOverrideValueSpecificationType.ClassLabel;
+}
+/**
+ * Specification returns ECInstance's briefcase ID in base36 format.
+ *
+ * @see [BriefcaseId value specification reference documentation page]($docs/presentation/customization/InstanceLabelOverride.md#briefcaseid-value-specification)
+ * @public
+ */
+export interface InstanceLabelOverrideBriefcaseIdSpecification extends InstanceLabelOverrideValueSpecificationBase {
+    specType: InstanceLabelOverrideValueSpecificationType.BriefcaseId;
+}
+/**
+ * Specification returns ECInstance's local ID in base36 format.
+ *
+ * @see [LocalId value specification reference documentation page]($docs/presentation/customization/InstanceLabelOverride.md#localid-value-specification)
+ * @public
+ */
+export interface InstanceLabelOverrideLocalIdSpecification extends InstanceLabelOverrideValueSpecificationBase {
+    specType: InstanceLabelOverrideValueSpecificationType.LocalId;
+}
+/**
+ * Specification uses the specified value as the label content.
+ *
+ * @see [String value specification reference documentation page]($docs/presentation/customization/InstanceLabelOverride.md#string-value-specification)
+ * @public
+ */
+export interface InstanceLabelOverrideStringValueSpecification extends InstanceLabelOverrideValueSpecificationBase {
+    specType: InstanceLabelOverrideValueSpecificationType.String;
+    /** The value to use as the label content. */
+    value: string;
+}
+/**
+ * Specification uses label of another related instance as the label content.
+ *
+ * @see [Related instance label value specification reference documentation page]($docs/presentation/customization/InstanceLabelOverride.md#related-instance-label-value-specification)
+ * @public
+ */
+export interface InstanceLabelOverrideRelatedInstanceLabelSpecification extends InstanceLabelOverrideValueSpecificationBase {
+    specType: InstanceLabelOverrideValueSpecificationType.RelatedInstanceLabel;
+    /**
+     * [Specification of the relationship path]($docs/presentation/RelationshipPathSpecification.md) from `InstanceLabelOverride.class`
+     * to class of the related instance.
+     */
+    pathToRelatedInstance: RelationshipPathSpecification;
+}
+/**
+ * Specification to define how the label for [[InstanceLabelOverride]] should be created.
+ * @public
+ */
+export declare type InstanceLabelOverrideValueSpecification = InstanceLabelOverrideCompositeValueSpecification | InstanceLabelOverridePropertyValueSpecification | InstanceLabelOverrideStringValueSpecification | InstanceLabelOverrideClassNameSpecification | InstanceLabelOverrideClassLabelSpecification | InstanceLabelOverrideBriefcaseIdSpecification | InstanceLabelOverrideLocalIdSpecification | InstanceLabelOverrideRelatedInstanceLabelSpecification;
 //# sourceMappingURL=InstanceLabelOverride.d.ts.map

package/lib/cjs/presentation-common/rules/customization/InstanceLabelOverride.js

@@ -1,26 +1,26 @@
-"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 });
-exports.InstanceLabelOverrideValueSpecificationType = void 0;
-/**
- * Types of possible [[InstanceLabelOverride]] label values.
- * @public
- */
-var InstanceLabelOverrideValueSpecificationType;
-(function (InstanceLabelOverrideValueSpecificationType) {
-    InstanceLabelOverrideValueSpecificationType["Composite"] = "Composite";
-    InstanceLabelOverrideValueSpecificationType["Property"] = "Property";
-    InstanceLabelOverrideValueSpecificationType["ClassName"] = "ClassName";
-    InstanceLabelOverrideValueSpecificationType["ClassLabel"] = "ClassLabel";
-    InstanceLabelOverrideValueSpecificationType["BriefcaseId"] = "BriefcaseId";
-    InstanceLabelOverrideValueSpecificationType["LocalId"] = "LocalId";
-    InstanceLabelOverrideValueSpecificationType["String"] = "String";
-    InstanceLabelOverrideValueSpecificationType["RelatedInstanceLabel"] = "RelatedInstanceLabel";
-})(InstanceLabelOverrideValueSpecificationType = exports.InstanceLabelOverrideValueSpecificationType || (exports.InstanceLabelOverrideValueSpecificationType = {}));
+"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 });
+exports.InstanceLabelOverrideValueSpecificationType = void 0;
+/**
+ * Types of possible [[InstanceLabelOverride]] label values.
+ * @public
+ */
+var InstanceLabelOverrideValueSpecificationType;
+(function (InstanceLabelOverrideValueSpecificationType) {
+    InstanceLabelOverrideValueSpecificationType["Composite"] = "Composite";
+    InstanceLabelOverrideValueSpecificationType["Property"] = "Property";
+    InstanceLabelOverrideValueSpecificationType["ClassName"] = "ClassName";
+    InstanceLabelOverrideValueSpecificationType["ClassLabel"] = "ClassLabel";
+    InstanceLabelOverrideValueSpecificationType["BriefcaseId"] = "BriefcaseId";
+    InstanceLabelOverrideValueSpecificationType["LocalId"] = "LocalId";
+    InstanceLabelOverrideValueSpecificationType["String"] = "String";
+    InstanceLabelOverrideValueSpecificationType["RelatedInstanceLabel"] = "RelatedInstanceLabel";
+})(InstanceLabelOverrideValueSpecificationType = exports.InstanceLabelOverrideValueSpecificationType || (exports.InstanceLabelOverrideValueSpecificationType = {}));
 //# sourceMappingURL=InstanceLabelOverride.js.map

package/lib/cjs/presentation-common/rules/customization/InstanceLabelOverride.js.map

@@ -1 +1 @@
-{"version":3,"file":"InstanceLabelOverride.js","sourceRoot":"","sources":["../../../../../src/presentation-common/rules/customization/InstanceLabelOverride.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AA4BH;;;GAGG;AACH,IAAY,2CASX;AATD,WAAY,2CAA2C;IACrD,sEAAuB,CAAA;IACvB,oEAAqB,CAAA;IACrB,sEAAuB,CAAA;IACvB,wEAAyB,CAAA;IACzB,0EAA2B,CAAA;IAC3B,kEAAmB,CAAA;IACnB,gEAAiB,CAAA;IACjB,4FAA6C,CAAA;AAC/C,CAAC,EATW,2CAA2C,GAA3C,mDAA2C,KAA3C,mDAA2C,QAStD","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 { RelationshipPathSpecification } from \"../RelationshipPathSpecification\";\r\nimport { RuleBase, RuleTypes } from \"../Rule\";\r\n\r\n/**\r\n * Instance label override rule provides a way to set instance label to one of its property values,\r\n * other attributes and/or combination of them.\r\n *\r\n * @see [Instance label override reference documentation page]($docs/presentation/customization/InstanceLabelOverride.md)\r\n * @public\r\n */\r\nexport interface InstanceLabelOverride extends RuleBase {\r\n  /** Used for serializing to JSON. */\r\n  ruleType: RuleTypes.InstanceLabelOverride;\r\n\r\n  /**\r\n   * Specifies the ECClass to apply this rule to.\r\n   */\r\n  class: SingleSchemaClassSpecification;\r\n\r\n  /**\r\n   * Specifications of values used to override label. The first non-empty value is used as the actual label.\r\n   */\r\n  values: InstanceLabelOverrideValueSpecification[];\r\n}\r\n\r\n/**\r\n * Types of possible [[InstanceLabelOverride]] label values.\r\n * @public\r\n */\r\nexport enum InstanceLabelOverrideValueSpecificationType {\r\n  Composite = \"Composite\",\r\n  Property = \"Property\",\r\n  ClassName = \"ClassName\",\r\n  ClassLabel = \"ClassLabel\",\r\n  BriefcaseId = \"BriefcaseId\",\r\n  LocalId = \"LocalId\",\r\n  String = \"String\",\r\n  RelatedInstanceLabel = \"RelatedInstanceLabel\",\r\n}\r\n\r\n/**\r\n * Base interface for all [[InstanceLabelOverrideValueSpecification]] implementations.\r\n * @public\r\n */\r\nexport interface InstanceLabelOverrideValueSpecificationBase {\r\n  /** Type of the specification */\r\n  specType: InstanceLabelOverrideValueSpecificationType;\r\n}\r\n\r\n/**\r\n * Specification allows creating a label value composited using multiple other specifications.\r\n *\r\n * @see [Composite value specification reference documentation page]($docs/presentation/customization/InstanceLabelOverride.md#composite-value-specification)\r\n * @public\r\n */\r\nexport interface InstanceLabelOverrideCompositeValueSpecification extends InstanceLabelOverrideValueSpecificationBase {\r\n  specType: InstanceLabelOverrideValueSpecificationType.Composite;\r\n\r\n  /**\r\n   * Parts of the value.\r\n   *\r\n   * If any of the parts with `isRequired` flag evaluate to an empty string, the\r\n   * result of this specification is also an empty string.\r\n   */\r\n  parts: Array<{ spec: InstanceLabelOverrideValueSpecification, isRequired?: boolean }>;\r\n\r\n  /** Separator to use when joining the parts. Defaults to a space character. */\r\n  separator?: string;\r\n}\r\n\r\n/**\r\n * Specification uses property value as the label content.\r\n *\r\n * @see [Property value specification reference documentation page]($docs/presentation/customization/InstanceLabelOverride.md#property-value-specification)\r\n * @public\r\n */\r\nexport interface InstanceLabelOverridePropertyValueSpecification extends InstanceLabelOverrideValueSpecificationBase {\r\n  specType: InstanceLabelOverrideValueSpecificationType.Property;\r\n\r\n  /**\r\n   * Name of the property whose value should be used.\r\n   * @note A property with this name must exist on the property class (see [[propertySource]]).\r\n   */\r\n  propertyName: string;\r\n\r\n  /**\r\n   * [Specification of the relationship path]($docs/presentation/RelationshipPathSpecification.md) from `InstanceLabelOverride.class`\r\n   * to class of the property. If omitted, `InstanceLabelOverride.class` is used as property class.\r\n   * @beta\r\n   */\r\n  propertySource?: RelationshipPathSpecification;\r\n}\r\n\r\n/**\r\n * Specification uses ECClass name as the label content.\r\n *\r\n * @see [Class name value specification reference documentation page]($docs/presentation/customization/InstanceLabelOverride.md#class-name-value-specification)\r\n * @public\r\n */\r\nexport interface InstanceLabelOverrideClassNameSpecification extends InstanceLabelOverrideValueSpecificationBase {\r\n  specType: InstanceLabelOverrideValueSpecificationType.ClassName;\r\n\r\n  /** Should full (`{schemaName}.{className}`) class name be used */\r\n  full?: boolean;\r\n}\r\n\r\n/**\r\n * Specification uses ECClass display label as the label content.\r\n *\r\n * @see [Class label value specification reference documentation page]($docs/presentation/customization/InstanceLabelOverride.md#class-label-value-specification)\r\n * @public\r\n */\r\nexport interface InstanceLabelOverrideClassLabelSpecification extends InstanceLabelOverrideValueSpecificationBase {\r\n  specType: InstanceLabelOverrideValueSpecificationType.ClassLabel;\r\n}\r\n\r\n/**\r\n * Specification returns ECInstance's briefcase ID in base36 format.\r\n *\r\n * @see [BriefcaseId value specification reference documentation page]($docs/presentation/customization/InstanceLabelOverride.md#briefcaseid-value-specification)\r\n * @public\r\n */\r\nexport interface InstanceLabelOverrideBriefcaseIdSpecification extends InstanceLabelOverrideValueSpecificationBase {\r\n  specType: InstanceLabelOverrideValueSpecificationType.BriefcaseId;\r\n}\r\n\r\n/**\r\n * Specification returns ECInstance's local ID in base36 format.\r\n *\r\n * @see [LocalId value specification reference documentation page]($docs/presentation/customization/InstanceLabelOverride.md#localid-value-specification)\r\n * @public\r\n */\r\nexport interface InstanceLabelOverrideLocalIdSpecification extends InstanceLabelOverrideValueSpecificationBase {\r\n  specType: InstanceLabelOverrideValueSpecificationType.LocalId;\r\n}\r\n\r\n/**\r\n * Specification uses the specified value as the label content.\r\n *\r\n * @see [String value specification reference documentation page]($docs/presentation/customization/InstanceLabelOverride.md#string-value-specification)\r\n * @public\r\n */\r\nexport interface InstanceLabelOverrideStringValueSpecification extends InstanceLabelOverrideValueSpecificationBase {\r\n  specType: InstanceLabelOverrideValueSpecificationType.String;\r\n\r\n  /** The value to use as the label content. */\r\n  value: string;\r\n}\r\n\r\n/**\r\n * Specification uses label of another related instance as the label content.\r\n *\r\n * @see [Related instance label value specification reference documentation page]($docs/presentation/customization/InstanceLabelOverride.md#related-instance-label-value-specification)\r\n * @public\r\n */\r\nexport interface InstanceLabelOverrideRelatedInstanceLabelSpecification extends InstanceLabelOverrideValueSpecificationBase {\r\n  specType: InstanceLabelOverrideValueSpecificationType.RelatedInstanceLabel;\r\n\r\n  /**\r\n   * [Specification of the relationship path]($docs/presentation/RelationshipPathSpecification.md) from `InstanceLabelOverride.class`\r\n   * to class of the related instance.\r\n   */\r\n  pathToRelatedInstance: RelationshipPathSpecification;\r\n}\r\n\r\n/**\r\n * Specification to define how the label for [[InstanceLabelOverride]] should be created.\r\n * @public\r\n */\r\nexport type InstanceLabelOverrideValueSpecification =\r\n  InstanceLabelOverrideCompositeValueSpecification | InstanceLabelOverridePropertyValueSpecification |\r\n  InstanceLabelOverrideStringValueSpecification | InstanceLabelOverrideClassNameSpecification |\r\n  InstanceLabelOverrideClassLabelSpecification | InstanceLabelOverrideBriefcaseIdSpecification |\r\n  InstanceLabelOverrideLocalIdSpecification | InstanceLabelOverrideRelatedInstanceLabelSpecification;\r\n"]}
+{"version":3,"file":"InstanceLabelOverride.js","sourceRoot":"","sources":["../../../../../src/presentation-common/rules/customization/InstanceLabelOverride.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AA4BH;;;GAGG;AACH,IAAY,2CASX;AATD,WAAY,2CAA2C;IACrD,sEAAuB,CAAA;IACvB,oEAAqB,CAAA;IACrB,sEAAuB,CAAA;IACvB,wEAAyB,CAAA;IACzB,0EAA2B,CAAA;IAC3B,kEAAmB,CAAA;IACnB,gEAAiB,CAAA;IACjB,4FAA6C,CAAA;AAC/C,CAAC,EATW,2CAA2C,GAA3C,mDAA2C,KAA3C,mDAA2C,QAStD","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 { RelationshipPathSpecification } from \"../RelationshipPathSpecification\";\nimport { RuleBase, RuleTypes } from \"../Rule\";\n\n/**\n * Instance label override rule provides a way to set instance label to one of its property values,\n * other attributes and/or combination of them.\n *\n * @see [Instance label override reference documentation page]($docs/presentation/customization/InstanceLabelOverride.md)\n * @public\n */\nexport interface InstanceLabelOverride extends RuleBase {\n  /** Used for serializing to JSON. */\n  ruleType: RuleTypes.InstanceLabelOverride;\n\n  /**\n   * Specifies the ECClass to apply this rule to.\n   */\n  class: SingleSchemaClassSpecification;\n\n  /**\n   * Specifications of values used to override label. The first non-empty value is used as the actual label.\n   */\n  values: InstanceLabelOverrideValueSpecification[];\n}\n\n/**\n * Types of possible [[InstanceLabelOverride]] label values.\n * @public\n */\nexport enum InstanceLabelOverrideValueSpecificationType {\n  Composite = \"Composite\",\n  Property = \"Property\",\n  ClassName = \"ClassName\",\n  ClassLabel = \"ClassLabel\",\n  BriefcaseId = \"BriefcaseId\",\n  LocalId = \"LocalId\",\n  String = \"String\",\n  RelatedInstanceLabel = \"RelatedInstanceLabel\",\n}\n\n/**\n * Base interface for all [[InstanceLabelOverrideValueSpecification]] implementations.\n * @public\n */\nexport interface InstanceLabelOverrideValueSpecificationBase {\n  /** Type of the specification */\n  specType: InstanceLabelOverrideValueSpecificationType;\n}\n\n/**\n * Specification allows creating a label value composited using multiple other specifications.\n *\n * @see [Composite value specification reference documentation page]($docs/presentation/customization/InstanceLabelOverride.md#composite-value-specification)\n * @public\n */\nexport interface InstanceLabelOverrideCompositeValueSpecification extends InstanceLabelOverrideValueSpecificationBase {\n  specType: InstanceLabelOverrideValueSpecificationType.Composite;\n\n  /**\n   * Parts of the value.\n   *\n   * If any of the parts with `isRequired` flag evaluate to an empty string, the\n   * result of this specification is also an empty string.\n   */\n  parts: Array<{ spec: InstanceLabelOverrideValueSpecification, isRequired?: boolean }>;\n\n  /** Separator to use when joining the parts. Defaults to a space character. */\n  separator?: string;\n}\n\n/**\n * Specification uses property value as the label content.\n *\n * @see [Property value specification reference documentation page]($docs/presentation/customization/InstanceLabelOverride.md#property-value-specification)\n * @public\n */\nexport interface InstanceLabelOverridePropertyValueSpecification extends InstanceLabelOverrideValueSpecificationBase {\n  specType: InstanceLabelOverrideValueSpecificationType.Property;\n\n  /**\n   * Name of the property whose value should be used.\n   * @note A property with this name must exist on the property class (see [[propertySource]]).\n   */\n  propertyName: string;\n\n  /**\n   * [Specification of the relationship path]($docs/presentation/RelationshipPathSpecification.md) from `InstanceLabelOverride.class`\n   * to class of the property. If omitted, `InstanceLabelOverride.class` is used as property class.\n   * @beta\n   */\n  propertySource?: RelationshipPathSpecification;\n}\n\n/**\n * Specification uses ECClass name as the label content.\n *\n * @see [Class name value specification reference documentation page]($docs/presentation/customization/InstanceLabelOverride.md#class-name-value-specification)\n * @public\n */\nexport interface InstanceLabelOverrideClassNameSpecification extends InstanceLabelOverrideValueSpecificationBase {\n  specType: InstanceLabelOverrideValueSpecificationType.ClassName;\n\n  /** Should full (`{schemaName}.{className}`) class name be used */\n  full?: boolean;\n}\n\n/**\n * Specification uses ECClass display label as the label content.\n *\n * @see [Class label value specification reference documentation page]($docs/presentation/customization/InstanceLabelOverride.md#class-label-value-specification)\n * @public\n */\nexport interface InstanceLabelOverrideClassLabelSpecification extends InstanceLabelOverrideValueSpecificationBase {\n  specType: InstanceLabelOverrideValueSpecificationType.ClassLabel;\n}\n\n/**\n * Specification returns ECInstance's briefcase ID in base36 format.\n *\n * @see [BriefcaseId value specification reference documentation page]($docs/presentation/customization/InstanceLabelOverride.md#briefcaseid-value-specification)\n * @public\n */\nexport interface InstanceLabelOverrideBriefcaseIdSpecification extends InstanceLabelOverrideValueSpecificationBase {\n  specType: InstanceLabelOverrideValueSpecificationType.BriefcaseId;\n}\n\n/**\n * Specification returns ECInstance's local ID in base36 format.\n *\n * @see [LocalId value specification reference documentation page]($docs/presentation/customization/InstanceLabelOverride.md#localid-value-specification)\n * @public\n */\nexport interface InstanceLabelOverrideLocalIdSpecification extends InstanceLabelOverrideValueSpecificationBase {\n  specType: InstanceLabelOverrideValueSpecificationType.LocalId;\n}\n\n/**\n * Specification uses the specified value as the label content.\n *\n * @see [String value specification reference documentation page]($docs/presentation/customization/InstanceLabelOverride.md#string-value-specification)\n * @public\n */\nexport interface InstanceLabelOverrideStringValueSpecification extends InstanceLabelOverrideValueSpecificationBase {\n  specType: InstanceLabelOverrideValueSpecificationType.String;\n\n  /** The value to use as the label content. */\n  value: string;\n}\n\n/**\n * Specification uses label of another related instance as the label content.\n *\n * @see [Related instance label value specification reference documentation page]($docs/presentation/customization/InstanceLabelOverride.md#related-instance-label-value-specification)\n * @public\n */\nexport interface InstanceLabelOverrideRelatedInstanceLabelSpecification extends InstanceLabelOverrideValueSpecificationBase {\n  specType: InstanceLabelOverrideValueSpecificationType.RelatedInstanceLabel;\n\n  /**\n   * [Specification of the relationship path]($docs/presentation/RelationshipPathSpecification.md) from `InstanceLabelOverride.class`\n   * to class of the related instance.\n   */\n  pathToRelatedInstance: RelationshipPathSpecification;\n}\n\n/**\n * Specification to define how the label for [[InstanceLabelOverride]] should be created.\n * @public\n */\nexport type InstanceLabelOverrideValueSpecification =\n  InstanceLabelOverrideCompositeValueSpecification | InstanceLabelOverridePropertyValueSpecification |\n  InstanceLabelOverrideStringValueSpecification | InstanceLabelOverrideClassNameSpecification |\n  InstanceLabelOverrideClassLabelSpecification | InstanceLabelOverrideBriefcaseIdSpecification |\n  InstanceLabelOverrideLocalIdSpecification | InstanceLabelOverrideRelatedInstanceLabelSpecification;\n"]}

package/lib/cjs/presentation-common/rules/customization/LabelOverride.d.ts

@@ -1,41 +1,41 @@
-/** @packageDocumentation
- * @module PresentationRules
- */
-import { RuleBase, RuleTypes } from "../Rule";
-/**
- * Label override rules provide advanced ways to override instance labels and descriptions in
- * exchange of some performance penalty.
- *
- * @see [Label override reference documentation page]($docs/presentation/customization/LabelOverride.md)
- * @public
- * @deprecated Use [[InstanceLabelOverride]] rule instead.
- */
-export interface LabelOverride extends RuleBase {
-    /** Used for serializing to JSON. */
-    ruleType: RuleTypes.LabelOverride;
-    /**
-     * Defines a condition for the rule, which needs to be met in order to execute it. Condition
-     * is an [ECExpression]($docs/presentation/advanced/ECExpressions.md), which can use
-     * a [limited set of symbols]($docs/presentation/customization/ECExpressions.md#rule-condition).
-     */
-    condition?: string;
-    /**
-     * An expression whose result becomes the label. This is
-     * an [ECExpression]($docs/presentation/customization/ECExpressions.md), so label
-     * can be defined/formatted dynamically based on the context - for example
-     * ECInstance property value. May be [localized]($docs/presentation/advanced/Localization.md).
-     *
-     * @minLength 1
-     */
-    label?: string;
-    /**
-     * An expression whose result becomes the description. This is
-     * an [ECExpression]($docs/presentation/customization/ECExpressions.md), so
-     * description can be defined/formatted dynamically based on the context - for example
-     * ECInstance property value. May be [localized]($docs/presentation/advanced/Localization.md).
-     *
-     * @minLength 1
-     */
-    description?: string;
-}
+/** @packageDocumentation
+ * @module PresentationRules
+ */
+import { RuleBase, RuleTypes } from "../Rule";
+/**
+ * Label override rules provide advanced ways to override instance labels and descriptions in
+ * exchange of some performance penalty.
+ *
+ * @see [Label override reference documentation page]($docs/presentation/customization/LabelOverride.md)
+ * @public
+ * @deprecated in 3.x. Use [[InstanceLabelOverride]] rule instead.
+ */
+export interface LabelOverride extends RuleBase {
+    /** Used for serializing to JSON. */
+    ruleType: RuleTypes.LabelOverride;
+    /**
+     * Defines a condition for the rule, which needs to be met in order to execute it. Condition
+     * is an [ECExpression]($docs/presentation/advanced/ECExpressions.md), which can use
+     * a [limited set of symbols]($docs/presentation/customization/ECExpressions.md#rule-condition).
+     */
+    condition?: string;
+    /**
+     * An expression whose result becomes the label. This is
+     * an [ECExpression]($docs/presentation/customization/ECExpressions.md), so label
+     * can be defined/formatted dynamically based on the context - for example
+     * ECInstance property value. May be [localized]($docs/presentation/advanced/Localization.md).
+     *
+     * @minLength 1
+     */
+    label?: string;
+    /**
+     * An expression whose result becomes the description. This is
+     * an [ECExpression]($docs/presentation/customization/ECExpressions.md), so
+     * description can be defined/formatted dynamically based on the context - for example
+     * ECInstance property value. May be [localized]($docs/presentation/advanced/Localization.md).
+     *
+     * @minLength 1
+     */
+    description?: string;
+}
 //# sourceMappingURL=LabelOverride.d.ts.map

package/lib/cjs/presentation-common/rules/customization/LabelOverride.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=LabelOverride.js.map

package/lib/cjs/presentation-common/rules/customization/LabelOverride.js.map

@@ -1 +1 @@
-{"version":3,"file":"LabelOverride.js","sourceRoot":"","sources":["../../../../../src/presentation-common/rules/customization/LabelOverride.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\n\r\n/**\r\n * Label override rules provide advanced ways to override instance labels and descriptions in\r\n * exchange of some performance penalty.\r\n *\r\n * @see [Label override reference documentation page]($docs/presentation/customization/LabelOverride.md)\r\n * @public\r\n * @deprecated Use [[InstanceLabelOverride]] rule instead.\r\n */\r\nexport interface LabelOverride extends RuleBase {\r\n  /** Used for serializing to JSON. */\r\n  ruleType: RuleTypes.LabelOverride;\r\n\r\n  /**\r\n   * Defines a condition for the rule, which needs to be met in order to execute it. Condition\r\n   * is an [ECExpression]($docs/presentation/advanced/ECExpressions.md), which can use\r\n   * a [limited set of symbols]($docs/presentation/customization/ECExpressions.md#rule-condition).\r\n   */\r\n  condition?: string;\r\n\r\n  /**\r\n   * An expression whose result becomes the label. This is\r\n   * an [ECExpression]($docs/presentation/customization/ECExpressions.md), so label\r\n   * can be defined/formatted dynamically based on the context - for example\r\n   * ECInstance property value. May be [localized]($docs/presentation/advanced/Localization.md).\r\n   *\r\n   * @minLength 1\r\n   */\r\n  label?: string;\r\n\r\n  /**\r\n   * An expression whose result becomes the description. This is\r\n   * an [ECExpression]($docs/presentation/customization/ECExpressions.md), so\r\n   * description can be defined/formatted dynamically based on the context - for example\r\n   * ECInstance property value. May be [localized]($docs/presentation/advanced/Localization.md).\r\n   *\r\n   * @minLength 1\r\n   */\r\n  description?: string;\r\n}\r\n"]}
+{"version":3,"file":"LabelOverride.js","sourceRoot":"","sources":["../../../../../src/presentation-common/rules/customization/LabelOverride.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 { RuleBase, RuleTypes } from \"../Rule\";\n\n/**\n * Label override rules provide advanced ways to override instance labels and descriptions in\n * exchange of some performance penalty.\n *\n * @see [Label override reference documentation page]($docs/presentation/customization/LabelOverride.md)\n * @public\n * @deprecated in 3.x. Use [[InstanceLabelOverride]] rule instead.\n */\nexport interface LabelOverride extends RuleBase {\n  /** Used for serializing to JSON. */\n  ruleType: RuleTypes.LabelOverride;\n\n  /**\n   * Defines a condition for the rule, which needs to be met in order to execute it. Condition\n   * is an [ECExpression]($docs/presentation/advanced/ECExpressions.md), which can use\n   * a [limited set of symbols]($docs/presentation/customization/ECExpressions.md#rule-condition).\n   */\n  condition?: string;\n\n  /**\n   * An expression whose result becomes the label. This is\n   * an [ECExpression]($docs/presentation/customization/ECExpressions.md), so label\n   * can be defined/formatted dynamically based on the context - for example\n   * ECInstance property value. May be [localized]($docs/presentation/advanced/Localization.md).\n   *\n   * @minLength 1\n   */\n  label?: string;\n\n  /**\n   * An expression whose result becomes the description. This is\n   * an [ECExpression]($docs/presentation/customization/ECExpressions.md), so\n   * description can be defined/formatted dynamically based on the context - for example\n   * ECInstance property value. May be [localized]($docs/presentation/advanced/Localization.md).\n   *\n   * @minLength 1\n   */\n  description?: string;\n}\n"]}