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

package/lib/cjs/presentation-common/rules/Variables.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.VariableValueType = void 0;
-/**
- * Available value types of user-controllable variables
- * @public
- */
-var VariableValueType;
-(function (VariableValueType) {
-    /** Bool value, that uses Yes / No strings in the UI */
-    VariableValueType["YesNo"] = "YesNo";
-    /** Bool value, that uses Show / Hide strings in the UI */
-    VariableValueType["ShowHide"] = "ShowHide";
-    /** Any string value */
-    VariableValueType["String"] = "StringValue";
-    /** Any integer value */
-    VariableValueType["Int"] = "IntValue";
-})(VariableValueType = exports.VariableValueType || (exports.VariableValueType = {}));
+"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.VariableValueType = void 0;
+/**
+ * Available value types of user-controllable variables
+ * @public
+ */
+var VariableValueType;
+(function (VariableValueType) {
+    /** Bool value, that uses Yes / No strings in the UI */
+    VariableValueType["YesNo"] = "YesNo";
+    /** Bool value, that uses Show / Hide strings in the UI */
+    VariableValueType["ShowHide"] = "ShowHide";
+    /** Any string value */
+    VariableValueType["String"] = "StringValue";
+    /** Any integer value */
+    VariableValueType["Int"] = "IntValue";
+})(VariableValueType = exports.VariableValueType || (exports.VariableValueType = {}));
 //# sourceMappingURL=Variables.js.map

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

@@ -1,42 +1,42 @@
-/** @packageDocumentation
- * @module PresentationRules
- */
-import { MultiSchemaClassesSpecification } from "../ClassSpecifications";
-import { ContentSpecificationBase } from "./ContentSpecification";
-/**
- * This specification creates content for all instances of specific ECClasses.
- *
- * @see [Content instances of specific classes specification reference documentation page]($docs/presentation/content/ContentInstancesOfSpecificClasses.md)
- * @public
- */
-export interface ContentInstancesOfSpecificClassesSpecification extends ContentSpecificationBase {
-    /** Used for serializing to JSON. */
-    specType: "ContentInstancesOfSpecificClasses";
-    /**
-     * Defines a set of [multi schema classes]($docs/presentation/MultiSchemaClassesSpecification.md) that specify which
-     * ECClasses need to be selected to form the result.
-     */
-    classes: MultiSchemaClassesSpecification | MultiSchemaClassesSpecification[];
-    /**
-     * Defines a set of [multi schema classes]($docs/presentation/MultiSchemaClassesSpecification.md) that prevents specified
-     * ECClasses and subclasses from being selected by [[classes]] attribute.
-     */
-    excludedClasses?: MultiSchemaClassesSpecification | MultiSchemaClassesSpecification[];
-    /**
-     * Tells whether selecting instances from ECClasses specified in [[classes]] and [[excludedClasses]]
-     * attributes should be polymorphic or not.
-     *
-     * @deprecated in 2.x. Specify polymorphism value inside [[classes.arePolymorphic]] or [[excludedClasses.arePolymorphic]].
-     */
-    handleInstancesPolymorphically?: boolean;
-    /**
-     * Specifies whether properties of derived [[classes]] should be included in the content.
-     */
-    handlePropertiesPolymorphically?: boolean;
-    /**
-     * Specifies an [ECExpression]($docs/presentation/content/ECExpressions.md#instance-filter) for filtering instances
-     * of ECClasses specified through the [[classes]] attribute.
-     */
-    instanceFilter?: string;
-}
+/** @packageDocumentation
+ * @module PresentationRules
+ */
+import { MultiSchemaClassesSpecification } from "../ClassSpecifications";
+import { ContentSpecificationBase } from "./ContentSpecification";
+/**
+ * This specification creates content for all instances of specific ECClasses.
+ *
+ * @see [Content instances of specific classes specification reference documentation page]($docs/presentation/content/ContentInstancesOfSpecificClasses.md)
+ * @public
+ */
+export interface ContentInstancesOfSpecificClassesSpecification extends ContentSpecificationBase {
+    /** Used for serializing to JSON. */
+    specType: "ContentInstancesOfSpecificClasses";
+    /**
+     * Defines a set of [multi schema classes]($docs/presentation/MultiSchemaClassesSpecification.md) that specify which
+     * ECClasses need to be selected to form the result.
+     */
+    classes: MultiSchemaClassesSpecification | MultiSchemaClassesSpecification[];
+    /**
+     * Defines a set of [multi schema classes]($docs/presentation/MultiSchemaClassesSpecification.md) that prevents specified
+     * ECClasses and subclasses from being selected by [[classes]] attribute.
+     */
+    excludedClasses?: MultiSchemaClassesSpecification | MultiSchemaClassesSpecification[];
+    /**
+     * Tells whether selecting instances from ECClasses specified in [[classes]] and [[excludedClasses]]
+     * attributes should be polymorphic or not.
+     *
+     * @deprecated in 2.x. Specify polymorphism value inside [[classes.arePolymorphic]] or [[excludedClasses.arePolymorphic]].
+     */
+    handleInstancesPolymorphically?: boolean;
+    /**
+     * Specifies whether properties of derived [[classes]] should be included in the content.
+     */
+    handlePropertiesPolymorphically?: boolean;
+    /**
+     * Specifies an [ECExpression]($docs/presentation/content/ECExpressions.md#instance-filter) for filtering instances
+     * of ECClasses specified through the [[classes]] attribute.
+     */
+    instanceFilter?: string;
+}
 //# sourceMappingURL=ContentInstancesOfSpecificClassesSpecification.d.ts.map

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

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

@@ -1,26 +1,26 @@
-/** @packageDocumentation
- * @module PresentationRules
- */
-import { RepeatableRelationshipPathSpecification } from "../RelationshipPathSpecification";
-import { ContentSpecificationBase } from "./ContentSpecification";
-/**
- * Returns content for instances related to the selected (input) instances.
- *
- * @see [Content related instances specification reference documentation page]($docs/presentation/content/ContentRelatedInstances.md)
- * @public
- */
-export interface ContentRelatedInstancesSpecification extends ContentSpecificationBase {
-    /** Used for serializing to JSON. */
-    specType: "ContentRelatedInstances";
-    /**
-     * Specifies a chain of [relationship path specifications]($docs/presentation/RepeatableRelationshipPathSpecification.md) that
-     * forms a path from an input instance to the output instances. When this array is empty, the specification produces no results.
-     */
-    relationshipPaths: RepeatableRelationshipPathSpecification[];
-    /**
-     * Specifies an [ECExpression]($docs/presentation/content/ECExpressions.md#instance-filter) for filtering instances
-     * of ECClasses targeted through the [[relationshipPaths]] attribute.
-     */
-    instanceFilter?: string;
-}
+/** @packageDocumentation
+ * @module PresentationRules
+ */
+import { RepeatableRelationshipPathSpecification } from "../RelationshipPathSpecification";
+import { ContentSpecificationBase } from "./ContentSpecification";
+/**
+ * Returns content for instances related to the selected (input) instances.
+ *
+ * @see [Content related instances specification reference documentation page]($docs/presentation/content/ContentRelatedInstances.md)
+ * @public
+ */
+export interface ContentRelatedInstancesSpecification extends ContentSpecificationBase {
+    /** Used for serializing to JSON. */
+    specType: "ContentRelatedInstances";
+    /**
+     * Specifies a chain of [relationship path specifications]($docs/presentation/RepeatableRelationshipPathSpecification.md) that
+     * forms a path from an input instance to the output instances. When this array is empty, the specification produces no results.
+     */
+    relationshipPaths: RepeatableRelationshipPathSpecification[];
+    /**
+     * Specifies an [ECExpression]($docs/presentation/content/ECExpressions.md#instance-filter) for filtering instances
+     * of ECClasses targeted through the [[relationshipPaths]] attribute.
+     */
+    instanceFilter?: string;
+}
 //# sourceMappingURL=ContentRelatedInstancesSpecification.d.ts.map

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

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

@@ -1,31 +1,31 @@
-/** @packageDocumentation
- * @module PresentationRules
- */
-import { RuleBase } from "../Rule";
-import { ContentSpecification } from "./ContentSpecification";
-/**
- * Content rules are used to define content that is displayed for specific type of [input]($docs/presentation/content/Terminology.md#input-instance).
- * Input consists of either ECInstances or [nodes]($docs/presentation/hierarchies/Terminology.md#node) and to make things
- * simpler everything is considered a [node]($docs/presentation/hierarchies/Terminology.md#node) - instances get converted to
- * *ECInstance nodes* (thus the `SelectedNode` symbol in [`condition` ECExpression]($docs/presentation/content/ECExpressions.md#rule-condition)).
- *
- * @see [Content rule reference documentation page]($docs/presentation/content/ContentRule.md)
- * @public
- */
-export interface ContentRule extends RuleBase {
-    /** Used for serializing to JSON. */
-    ruleType: "Content";
-    /**
-     * Defines a condition which needs to be met in order for the rule to be used. The condition is an
-     * [ECExpression]($docs/presentation/content/ECExpressions.md#rule-condition) which has to evaluate to
-     * a boolean value.
-     */
-    condition?: string;
-    /**
-     * A list of content specifications that define what content is going to be returned. This is the most
-     * important attribute which is responsible for defining what instances' properties are included in the
-     * returned content.
-     */
-    specifications: ContentSpecification[];
-}
+/** @packageDocumentation
+ * @module PresentationRules
+ */
+import { RuleBase } from "../Rule";
+import { ContentSpecification } from "./ContentSpecification";
+/**
+ * Content rules are used to define content that is displayed for specific type of [input]($docs/presentation/content/Terminology.md#input-instance).
+ * Input consists of either ECInstances or [nodes]($docs/presentation/hierarchies/Terminology.md#node) and to make things
+ * simpler everything is considered a [node]($docs/presentation/hierarchies/Terminology.md#node) - instances get converted to
+ * *ECInstance nodes* (thus the `SelectedNode` symbol in [`condition` ECExpression]($docs/presentation/content/ECExpressions.md#rule-condition)).
+ *
+ * @see [Content rule reference documentation page]($docs/presentation/content/ContentRule.md)
+ * @public
+ */
+export interface ContentRule extends RuleBase {
+    /** Used for serializing to JSON. */
+    ruleType: "Content";
+    /**
+     * Defines a condition which needs to be met in order for the rule to be used. The condition is an
+     * [ECExpression]($docs/presentation/content/ECExpressions.md#rule-condition) which has to evaluate to
+     * a boolean value.
+     */
+    condition?: string;
+    /**
+     * A list of content specifications that define what content is going to be returned. This is the most
+     * important attribute which is responsible for defining what instances' properties are included in the
+     * returned content.
+     */
+    specifications: ContentSpecification[];
+}
 //# sourceMappingURL=ContentRule.d.ts.map

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

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

@@ -1,59 +1,59 @@
-/** @packageDocumentation
- * @module PresentationRules
- */
-import { RelatedInstanceSpecification } from "../RelatedInstanceSpecification";
-import { ContentInstancesOfSpecificClassesSpecification } from "./ContentInstancesOfSpecificClassesSpecification";
-import { ContentRelatedInstancesSpecification } from "./ContentRelatedInstancesSpecification";
-import { ContentModifiersList } from "./modifiers/ContentModifier";
-import { SelectedNodeInstancesSpecification } from "./SelectedNodeInstancesSpecification";
-/**
- * Used for serializing array of [[ContentSpecification]]
- * @public
- */
-export declare enum ContentSpecificationTypes {
-    ContentInstancesOfSpecificClasses = "ContentInstancesOfSpecificClasses",
-    ContentRelatedInstances = "ContentRelatedInstances",
-    SelectedNodeInstances = "SelectedNodeInstances"
-}
-/**
- * Base interface for all [[ContentSpecification]] implementations. Not
- * meant to be used directly, see `ContentSpecification`.
- *
- * @public
- */
-export interface ContentSpecificationBase extends ContentModifiersList {
-    /**
-     * Used for serializing to JSON.
-     * @see [[ContentSpecificationTypes]]
-     */
-    specType: `${ContentSpecificationTypes}`;
-    /**
-     * Controls the order in which specifications are handled — specification with higher priority value is handled
-     * first. If priorities are equal, the specifications are handled in the order they appear in the ruleset.
-     *
-     * @type integer
-     */
-    priority?: number;
-    /**
-     * Should image IDs be calculated for the returned instances. When `true`, [[ImageIdOverride]] rules get applied when
-     * creating the content.
-     *
-     * @deprecated in 3.x. Use [[ExtendedDataRule]] instead. See [extended data usage page]($docs/presentation/customization/ExtendedDataUsage.md) for more details.
-     */
-    showImages?: boolean;
-    /** Specifications of [related instances]($docs/presentation/RelatedInstanceSpecification.md) that can be used when creating the content. */
-    relatedInstances?: RelatedInstanceSpecification[];
-    /**
-     * Specifies whether this specification should be ignored if another specification was handled before as
-     * determined by rule and specification priorities. This provides a mechanism for defining a fallback specification.
-     */
-    onlyIfNotHandled?: boolean;
-}
-/**
- * Content rule specifications which define what content is returned
- * when rule is used.
- *
- * @public
- */
-export declare type ContentSpecification = ContentInstancesOfSpecificClassesSpecification | ContentRelatedInstancesSpecification | SelectedNodeInstancesSpecification;
+/** @packageDocumentation
+ * @module PresentationRules
+ */
+import { RelatedInstanceSpecification } from "../RelatedInstanceSpecification";
+import { ContentInstancesOfSpecificClassesSpecification } from "./ContentInstancesOfSpecificClassesSpecification";
+import { ContentRelatedInstancesSpecification } from "./ContentRelatedInstancesSpecification";
+import { ContentModifiersList } from "./modifiers/ContentModifier";
+import { SelectedNodeInstancesSpecification } from "./SelectedNodeInstancesSpecification";
+/**
+ * Used for serializing array of [[ContentSpecification]]
+ * @public
+ */
+export declare enum ContentSpecificationTypes {
+    ContentInstancesOfSpecificClasses = "ContentInstancesOfSpecificClasses",
+    ContentRelatedInstances = "ContentRelatedInstances",
+    SelectedNodeInstances = "SelectedNodeInstances"
+}
+/**
+ * Base interface for all [[ContentSpecification]] implementations. Not
+ * meant to be used directly, see `ContentSpecification`.
+ *
+ * @public
+ */
+export interface ContentSpecificationBase extends ContentModifiersList {
+    /**
+     * Used for serializing to JSON.
+     * @see [[ContentSpecificationTypes]]
+     */
+    specType: `${ContentSpecificationTypes}`;
+    /**
+     * Controls the order in which specifications are handled — specification with higher priority value is handled
+     * first. If priorities are equal, the specifications are handled in the order they appear in the ruleset.
+     *
+     * @type integer
+     */
+    priority?: number;
+    /**
+     * Should image IDs be calculated for the returned instances. When `true`, [[ImageIdOverride]] rules get applied when
+     * creating the content.
+     *
+     * @deprecated in 3.x. Use [[ExtendedDataRule]] instead. See [extended data usage page]($docs/presentation/customization/ExtendedDataUsage.md) for more details.
+     */
+    showImages?: boolean;
+    /** Specifications of [related instances]($docs/presentation/RelatedInstanceSpecification.md) that can be used when creating the content. */
+    relatedInstances?: RelatedInstanceSpecification[];
+    /**
+     * Specifies whether this specification should be ignored if another specification was handled before as
+     * determined by rule and specification priorities. This provides a mechanism for defining a fallback specification.
+     */
+    onlyIfNotHandled?: boolean;
+}
+/**
+ * Content rule specifications which define what content is returned
+ * when rule is used.
+ *
+ * @public
+ */
+export declare type ContentSpecification = ContentInstancesOfSpecificClassesSpecification | ContentRelatedInstancesSpecification | SelectedNodeInstancesSpecification;
 //# sourceMappingURL=ContentSpecification.d.ts.map

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

@@ -1,21 +1,21 @@
-"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.ContentSpecificationTypes = void 0;
-/**
- * Used for serializing array of [[ContentSpecification]]
- * @public
- */
-var ContentSpecificationTypes;
-(function (ContentSpecificationTypes) {
-    ContentSpecificationTypes["ContentInstancesOfSpecificClasses"] = "ContentInstancesOfSpecificClasses";
-    ContentSpecificationTypes["ContentRelatedInstances"] = "ContentRelatedInstances";
-    ContentSpecificationTypes["SelectedNodeInstances"] = "SelectedNodeInstances";
-})(ContentSpecificationTypes = exports.ContentSpecificationTypes || (exports.ContentSpecificationTypes = {}));
+"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.ContentSpecificationTypes = void 0;
+/**
+ * Used for serializing array of [[ContentSpecification]]
+ * @public
+ */
+var ContentSpecificationTypes;
+(function (ContentSpecificationTypes) {
+    ContentSpecificationTypes["ContentInstancesOfSpecificClasses"] = "ContentInstancesOfSpecificClasses";
+    ContentSpecificationTypes["ContentRelatedInstances"] = "ContentRelatedInstances";
+    ContentSpecificationTypes["SelectedNodeInstances"] = "SelectedNodeInstances";
+})(ContentSpecificationTypes = exports.ContentSpecificationTypes || (exports.ContentSpecificationTypes = {}));
 //# sourceMappingURL=ContentSpecification.js.map

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

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

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