@itwin/presentation-common 4.0.0-dev.8 → 4.0.0-dev.80

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

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

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

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

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

@@ -1,45 +1,45 @@
-/** @packageDocumentation
- * @module PresentationRules
- */
-import { RuleBase } from "../Rule";
-/**
- * CheckBox rules provide a way to create a checkbox for specific types of ECInstance's.
- *
- * @see [CheckBox rule reference documentation page]($docs/presentation/customization/CheckBoxRule.md)
- * @public
- * @deprecated in 3.x. Use [[ExtendedDataRule]] instead. See [extended data usage page]($docs/presentation/customization/ExtendedDataUsage.md) for more details.
- */
-export interface CheckBoxRule extends RuleBase {
-    /** Used for serializing to JSON. */
-    ruleType: "CheckBox";
-    /**
-     * 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;
-    /**
-     * Name of boolean type ECProperty which is bound with the check box state. When set, property
-     * value gets bound to checkbox state.
-     *
-     * @minLength 1
-     */
-    propertyName?: string;
-    /**
-     * Should property value be inversed for the check box state.
-     *
-     * **Note:** Only makes sense when bound to an ECProperty.
-     */
-    useInversedPropertyValue?: boolean;
-    /**
-     * Default value to use for the check box state
-     *
-     * **Note:** Only makes sense when *not* bound to an ECProperty.
-     */
-    defaultValue?: boolean;
-    /**
-     * Indicates whether check box is enabled or disabled.
-     */
-    isEnabled?: string | boolean;
-}
+/** @packageDocumentation
+ * @module PresentationRules
+ */
+import { RuleBase } from "../Rule";
+/**
+ * CheckBox rules provide a way to create a checkbox for specific types of ECInstance's.
+ *
+ * @see [CheckBox rule reference documentation page]($docs/presentation/customization/CheckBoxRule.md)
+ * @public
+ * @deprecated in 3.x. Use [[ExtendedDataRule]] instead. See [extended data usage page]($docs/presentation/customization/ExtendedDataUsage.md) for more details.
+ */
+export interface CheckBoxRule extends RuleBase {
+    /** Used for serializing to JSON. */
+    ruleType: "CheckBox";
+    /**
+     * 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;
+    /**
+     * Name of boolean type ECProperty which is bound with the check box state. When set, property
+     * value gets bound to checkbox state.
+     *
+     * @minLength 1
+     */
+    propertyName?: string;
+    /**
+     * Should property value be inversed for the check box state.
+     *
+     * **Note:** Only makes sense when bound to an ECProperty.
+     */
+    useInversedPropertyValue?: boolean;
+    /**
+     * Default value to use for the check box state
+     *
+     * **Note:** Only makes sense when *not* bound to an ECProperty.
+     */
+    defaultValue?: boolean;
+    /**
+     * Indicates whether check box is enabled or disabled.
+     */
+    isEnabled?: string | boolean;
+}
 //# sourceMappingURL=CheckBoxRule.d.ts.map

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

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

@@ -1,37 +1,37 @@
-/** @packageDocumentation
- * @module PresentationRules
- */
-import { NodeArtifactsRule } from "../hierarchy/NodeArtifactsRule";
-import { CheckBoxRule } from "./CheckBoxRule";
-import { ExtendedDataRule } from "./ExtendedDataRule";
-import { GroupingRule } from "./GroupingRule";
-import { ImageIdOverride } from "./ImageIdOverride";
-import { InstanceLabelOverride } from "./InstanceLabelOverride";
-import { LabelOverride } from "./LabelOverride";
-import { SortingRule } from "./SortingRule";
-import { StyleOverride } from "./StyleOverride";
-/**
- * Customization rules allow customizing each node or content item separately.
- * Most of the rules have a `condition` property which uses [ECExpressions]($docs/presentation/customization/ECExpressions.md)
- * for conditional rule filtering.
- *
- * **Nested customization rules:**
- *
- * Customization rules may be specified at ruleset level, in which case they're
- * applied to all content produced by the ruleset, or nested under navigation rules,
- * in which case they're applied only for nodes created by those rules.
- *
- * **Customization rule priorities:**
- *
- * Customization rules have a `priority` attribute which defines the order in which they're applied. If priorities match,
- * rules engine looks at the nesting level - the deeper the rule is nested, the higher is its `priority`.
- * If the nesting levels also match, the rule defined first wins.
- *
- * @public
- */
-export declare type CustomizationRule = InstanceLabelOverride | CheckBoxRule | // eslint-disable-line deprecation/deprecation
-GroupingRule | ImageIdOverride | // eslint-disable-line deprecation/deprecation
-LabelOverride | // eslint-disable-line deprecation/deprecation
-SortingRule | StyleOverride | // eslint-disable-line deprecation/deprecation
-ExtendedDataRule | NodeArtifactsRule;
+/** @packageDocumentation
+ * @module PresentationRules
+ */
+import { NodeArtifactsRule } from "../hierarchy/NodeArtifactsRule";
+import { CheckBoxRule } from "./CheckBoxRule";
+import { ExtendedDataRule } from "./ExtendedDataRule";
+import { GroupingRule } from "./GroupingRule";
+import { ImageIdOverride } from "./ImageIdOverride";
+import { InstanceLabelOverride } from "./InstanceLabelOverride";
+import { LabelOverride } from "./LabelOverride";
+import { SortingRule } from "./SortingRule";
+import { StyleOverride } from "./StyleOverride";
+/**
+ * Customization rules allow customizing each node or content item separately.
+ * Most of the rules have a `condition` property which uses [ECExpressions]($docs/presentation/customization/ECExpressions.md)
+ * for conditional rule filtering.
+ *
+ * **Nested customization rules:**
+ *
+ * Customization rules may be specified at ruleset level, in which case they're
+ * applied to all content produced by the ruleset, or nested under navigation rules,
+ * in which case they're applied only for nodes created by those rules.
+ *
+ * **Customization rule priorities:**
+ *
+ * Customization rules have a `priority` attribute which defines the order in which they're applied. If priorities match,
+ * rules engine looks at the nesting level - the deeper the rule is nested, the higher is its `priority`.
+ * If the nesting levels also match, the rule defined first wins.
+ *
+ * @public
+ */
+export declare type CustomizationRule = InstanceLabelOverride | CheckBoxRule | // eslint-disable-line deprecation/deprecation
+GroupingRule | ImageIdOverride | // eslint-disable-line deprecation/deprecation
+LabelOverride | // eslint-disable-line deprecation/deprecation
+SortingRule | StyleOverride | // eslint-disable-line deprecation/deprecation
+ExtendedDataRule | NodeArtifactsRule;
 //# sourceMappingURL=CustomizationRule.d.ts.map

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

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

@@ -1,28 +1,28 @@
-/** @packageDocumentation
- * @module PresentationRules
- */
-import { RuleBase } from "../Rule";
-/**
- * Extended data rule is used to inject some arbitrary data into presentation data objects (nodes, content records).
- *
- * @see [Extended data rule reference documentation page]($docs/presentation/customization/ExtendedDataRule.md)
- * @public
- */
-export interface ExtendedDataRule extends RuleBase {
-    /** Used for serializing to JSON. */
-    ruleType: "ExtendedData";
-    /**
-     * Defines a condition which needs to be met in order for the rule to be used. The condition
-     * is an [ECExpression]($docs/presentation/customization/ECExpressions.md#rule-condition) which has
-     * to evaluate to a boolean value.
-     */
-    condition?: string;
-    /**
-     * A map of [ECExpressions]($docs/presentation/customization/ECExpressions.md#rule-condition) whose
-     * evaluation results are used as extended data values.
-     */
-    items: {
-        [key: string]: string;
-    };
-}
+/** @packageDocumentation
+ * @module PresentationRules
+ */
+import { RuleBase } from "../Rule";
+/**
+ * Extended data rule is used to inject some arbitrary data into presentation data objects (nodes, content records).
+ *
+ * @see [Extended data rule reference documentation page]($docs/presentation/customization/ExtendedDataRule.md)
+ * @public
+ */
+export interface ExtendedDataRule extends RuleBase {
+    /** Used for serializing to JSON. */
+    ruleType: "ExtendedData";
+    /**
+     * Defines a condition which needs to be met in order for the rule to be used. The condition
+     * is an [ECExpression]($docs/presentation/customization/ECExpressions.md#rule-condition) which has
+     * to evaluate to a boolean value.
+     */
+    condition?: string;
+    /**
+     * A map of [ECExpressions]($docs/presentation/customization/ECExpressions.md#rule-condition) whose
+     * evaluation results are used as extended data values.
+     */
+    items: {
+        [key: string]: string;
+    };
+}
 //# sourceMappingURL=ExtendedDataRule.d.ts.map

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