@itwin/presentation-common 4.0.0-dev.52 → 4.0.0-dev.55

package/lib/cjs/presentation-common/rules/Ruleset.d.ts

@@ -1,66 +1,66 @@
-/** @packageDocumentation
- * @module PresentationRules
- */
-import { Rule } from "./Rule";
-import { RequiredSchemaSpecification } from "./SchemasSpecification";
-import { VariablesGroup } from "./Variables";
-/**
- * Presentation ruleset is a list of rules that define tree hierarchy and content provided by
- * the presentation library. The ruleset consists of:
- * - Ruleset options
- * - Hierarchy rules:
- *   - Root node rules
- *   - Child node rules
- * - Content rules for content you see in content controls like property grid and table.
- * - Customization rules used for additional customizations such as styling, labeling, checkboxes, etc.
- * - User-controllable variables.
- *
- * @see [Presentation library documentation page]($docs/presentation/index.md)
- * @public
- */
-export interface Ruleset {
-    /**
-     * Ruleset identifier. This ID is used to bind UI components with the specific rule set.
-     *
-     * @minLength 1
-     */
-    id: string;
-    /**
-     * Version of the presentation ruleset in SemVer format: `{major}.{minor}.{patch}`.
-     *
-     * Setting the version is optional, but might be useful when ruleset is persisted
-     * somewhere and evolves over time. Having a version helps choose persisting
-     * strategy (keep all versions or only latest) and find the latest ruleset from a list
-     * of rulesets with the same id.
-     *
-     * Defaults to `0.0.0`.
-     *
-     * @pattern ^[\d]+\.[\d]+\.[\d]+$
-     * @beta
-     */
-    version?: string;
-    /**
-     * Schema requirements for this ruleset. The ruleset is not used if the requirements are not met.
-     */
-    requiredSchemas?: RequiredSchemaSpecification[];
-    /** Supplementation-related information for this ruleset */
-    supplementationInfo?: SupplementationInfo;
-    /** User-controllable variable definitions */
-    vars?: VariablesGroup[];
-    /** Presentation rules used to create hierarchies and content */
-    rules: Rule[];
-}
-/**
- * Contains supplementation-related information for
- * [supplemental rulesets]($docs/presentation/advanced/RulesetSupplementation.md).
- *
- * @public
- */
-export interface SupplementationInfo {
-    /**
-     * Identifies why supplementation is done and uniquely identifies particular supplemental ruleset.
-     * There can be only one supplemental rule set with the same [[Ruleset.id]] and [[supplementationPurpose]].
-     */
-    supplementationPurpose: string;
-}
+/** @packageDocumentation
+ * @module PresentationRules
+ */
+import { Rule } from "./Rule";
+import { RequiredSchemaSpecification } from "./SchemasSpecification";
+import { VariablesGroup } from "./Variables";
+/**
+ * Presentation ruleset is a list of rules that define tree hierarchy and content provided by
+ * the presentation library. The ruleset consists of:
+ * - Ruleset options
+ * - Hierarchy rules:
+ *   - Root node rules
+ *   - Child node rules
+ * - Content rules for content you see in content controls like property grid and table.
+ * - Customization rules used for additional customizations such as styling, labeling, checkboxes, etc.
+ * - User-controllable variables.
+ *
+ * @see [Presentation library documentation page]($docs/presentation/index.md)
+ * @public
+ */
+export interface Ruleset {
+    /**
+     * Ruleset identifier. This ID is used to bind UI components with the specific rule set.
+     *
+     * @minLength 1
+     */
+    id: string;
+    /**
+     * Version of the presentation ruleset in SemVer format: `{major}.{minor}.{patch}`.
+     *
+     * Setting the version is optional, but might be useful when ruleset is persisted
+     * somewhere and evolves over time. Having a version helps choose persisting
+     * strategy (keep all versions or only latest) and find the latest ruleset from a list
+     * of rulesets with the same id.
+     *
+     * Defaults to `0.0.0`.
+     *
+     * @pattern ^[\d]+\.[\d]+\.[\d]+$
+     * @beta
+     */
+    version?: string;
+    /**
+     * Schema requirements for this ruleset. The ruleset is not used if the requirements are not met.
+     */
+    requiredSchemas?: RequiredSchemaSpecification[];
+    /** Supplementation-related information for this ruleset */
+    supplementationInfo?: SupplementationInfo;
+    /** User-controllable variable definitions */
+    vars?: VariablesGroup[];
+    /** Presentation rules used to create hierarchies and content */
+    rules: Rule[];
+}
+/**
+ * Contains supplementation-related information for
+ * [supplemental rulesets]($docs/presentation/advanced/RulesetSupplementation.md).
+ *
+ * @public
+ */
+export interface SupplementationInfo {
+    /**
+     * Identifies why supplementation is done and uniquely identifies particular supplemental ruleset.
+     * There can be only one supplemental rule set with the same [[Ruleset.id]] and [[supplementationPurpose]].
+     */
+    supplementationPurpose: string;
+}
 //# sourceMappingURL=Ruleset.d.ts.map

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

package/lib/cjs/presentation-common/rules/SchemasSpecification.d.ts

@@ -1,42 +1,42 @@
-/** @packageDocumentation
- * @module PresentationRules
- */
-/**
- * Specification for a list of ECSchemas
- * @public
- */
-export interface SchemasSpecification {
-    /** ECSchema names */
-    schemaNames: string[];
-    /**
-     * Should schemas specified in [[schemaNames]] be excluded rather than included.
-     * Exclusion works by including everything except what's specified in [[schemaNames]].
-     */
-    isExclude?: boolean;
-}
-/**
- * This specification is designed for specifying schema requirements for the [[Ruleset]] or specific
- * presentation rules.
- *
- * @see [Required schema specification reference documentation page]($docs/presentation/RequiredSchemaSpecification.md)
- * @public
- */
-export interface RequiredSchemaSpecification {
-    /** Specifies the schema to whom the requirement is being set. */
-    name: string;
-    /**
-     * Minimum required schema version (inclusive).
-     * Format: `{read version}.{write version}.{minor version}`, e.g. `2.1.15`.
-     *
-     * @pattern ^[\d]+\.[\d]+\.[\d]+$
-     */
-    minVersion?: string;
-    /**
-     * Maximum allowed schema version (exclusive).
-     * Format: `{read version}.{write version}.{minor version}`, e.g. `2.1.15`.
-     *
-     * @pattern ^[\d]+\.[\d]+\.[\d]+$
-     */
-    maxVersion?: string;
-}
+/** @packageDocumentation
+ * @module PresentationRules
+ */
+/**
+ * Specification for a list of ECSchemas
+ * @public
+ */
+export interface SchemasSpecification {
+    /** ECSchema names */
+    schemaNames: string[];
+    /**
+     * Should schemas specified in [[schemaNames]] be excluded rather than included.
+     * Exclusion works by including everything except what's specified in [[schemaNames]].
+     */
+    isExclude?: boolean;
+}
+/**
+ * This specification is designed for specifying schema requirements for the [[Ruleset]] or specific
+ * presentation rules.
+ *
+ * @see [Required schema specification reference documentation page]($docs/presentation/RequiredSchemaSpecification.md)
+ * @public
+ */
+export interface RequiredSchemaSpecification {
+    /** Specifies the schema to whom the requirement is being set. */
+    name: string;
+    /**
+     * Minimum required schema version (inclusive).
+     * Format: `{read version}.{write version}.{minor version}`, e.g. `2.1.15`.
+     *
+     * @pattern ^[\d]+\.[\d]+\.[\d]+$
+     */
+    minVersion?: string;
+    /**
+     * Maximum allowed schema version (exclusive).
+     * Format: `{read version}.{write version}.{minor version}`, e.g. `2.1.15`.
+     *
+     * @pattern ^[\d]+\.[\d]+\.[\d]+$
+     */
+    maxVersion?: string;
+}
 //# sourceMappingURL=SchemasSpecification.d.ts.map

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

package/lib/cjs/presentation-common/rules/Variables.d.ts

@@ -1,59 +1,59 @@
-/** @packageDocumentation
- * @module PresentationRules
- */
-/**
- * Presentation rules support variables that allow having additional customization of the hierarchy
- * and content based on variables whose values can change during application session.
- *
- * There are [special ECExpression symbols]($docs/presentation/advanced/ECExpressions.md#ruleset-variables-user-settings)
- * that can be used to access variables by their ID, so rule conditions can check for a value and change
- * the behavior. It allows showing / hiding some nodes in the hierarchy, change the grouping, etc.
- *
- * @public
- */
-export interface VariablesGroup {
-    /**
-     * Group label to display in the UI.
-     * May be [localized]($docs/presentation/advanced/Localization.md).
-     */
-    label: string;
-    /** Grouped variables */
-    vars: Variable[];
-    /** Nested variable groups. */
-    nestedGroups?: VariablesGroup[];
-}
-/**
- * Available value types of user-controllable variables
- * @public
- */
-export declare enum VariableValueType {
-    /** Bool value, that uses Yes / No strings in the UI */
-    YesNo = "YesNo",
-    /** Bool value, that uses Show / Hide strings in the UI */
-    ShowHide = "ShowHide",
-    /** Any string value */
-    String = "StringValue",
-    /** Any integer value */
-    Int = "IntValue"
-}
-/**
- * Definition for single user-controllable variable
- * @public
- */
-export interface Variable {
-    /** Id of the variable */
-    id: string;
-    /**
-     * Label of the variable that is shown in the UI.
-     * May be [localized]($docs/presentation/advanced/Localization.md).
-     */
-    label: string;
-    /**
-     * Defines value type. Defaults to [[VariableValueType.YesNo]].
-     * @see VariableValueType
-     */
-    type?: `${VariableValueType}`;
-    /** Default value. */
-    defaultValue?: string;
-}
+/** @packageDocumentation
+ * @module PresentationRules
+ */
+/**
+ * Presentation rules support variables that allow having additional customization of the hierarchy
+ * and content based on variables whose values can change during application session.
+ *
+ * There are [special ECExpression symbols]($docs/presentation/advanced/ECExpressions.md#ruleset-variables-user-settings)
+ * that can be used to access variables by their ID, so rule conditions can check for a value and change
+ * the behavior. It allows showing / hiding some nodes in the hierarchy, change the grouping, etc.
+ *
+ * @public
+ */
+export interface VariablesGroup {
+    /**
+     * Group label to display in the UI.
+     * May be [localized]($docs/presentation/advanced/Localization.md).
+     */
+    label: string;
+    /** Grouped variables */
+    vars: Variable[];
+    /** Nested variable groups. */
+    nestedGroups?: VariablesGroup[];
+}
+/**
+ * Available value types of user-controllable variables
+ * @public
+ */
+export declare enum VariableValueType {
+    /** Bool value, that uses Yes / No strings in the UI */
+    YesNo = "YesNo",
+    /** Bool value, that uses Show / Hide strings in the UI */
+    ShowHide = "ShowHide",
+    /** Any string value */
+    String = "StringValue",
+    /** Any integer value */
+    Int = "IntValue"
+}
+/**
+ * Definition for single user-controllable variable
+ * @public
+ */
+export interface Variable {
+    /** Id of the variable */
+    id: string;
+    /**
+     * Label of the variable that is shown in the UI.
+     * May be [localized]($docs/presentation/advanced/Localization.md).
+     */
+    label: string;
+    /**
+     * Defines value type. Defaults to [[VariableValueType.YesNo]].
+     * @see VariableValueType
+     */
+    type?: `${VariableValueType}`;
+    /** Default value. */
+    defaultValue?: string;
+}
 //# sourceMappingURL=Variables.d.ts.map

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