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

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

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

@@ -1,77 +1,77 @@
-/** @packageDocumentation
- * @module PresentationRules
- */
-import { ContentRule } from "./content/ContentRule";
-import { DefaultPropertyCategoryOverride } from "./content/DefaultPropertyCategoryOverride";
-import { ContentModifier } from "./content/modifiers/ContentModifier";
-import { CustomizationRule } from "./customization/CustomizationRule";
-import { NavigationRule } from "./hierarchy/NavigationRule";
-import { RequiredSchemaSpecification } from "./SchemasSpecification";
-/**
- * Base interface for all [[Rule]] implementations.
- * @public
- */
-export interface RuleBase {
-    /**
-     * Used for serializing to JSON.
-     * @see RuleTypes
-     */
-    ruleType: `${RuleTypes}`;
-    /**
-     * Defines the order in which rules are handled, higher number means the rule is handled first. If priorities are
-     * equal, the rules are handled in the order they're defined.
-     *
-     * @type integer
-     */
-    priority?: number;
-    /**
-     * Tells the library that the rule should only be handled if no other rule of the same type was handled previously (based on rule
-     * priorities and definition order). This allows adding fallback rules which can be overriden by higher-priority rules.
-     */
-    onlyIfNotHandled?: boolean;
-    /**
-     * A list of [ECSchema requirements]($docs/presentation/RequiredSchemaSpecification.md) that need to be met for the rule to be used.
-     */
-    requiredSchemas?: RequiredSchemaSpecification[];
-}
-/**
- * A union of all presentation rule types.
- * @public
- */
-export declare type Rule = CustomizationRule | NavigationRule | ContentRule | ContentModifier | DefaultPropertyCategoryOverride;
-/**
- * Container of a [[condition]] property. Used for rules that support conditions. Not
- * meant to be used directly, see [[Rule]].
- *
- * @deprecated in 3.x. This interface is not used anymore. All interfaces that used to extend it, have the [[condition]]
- * attribute of their own.
- * @public
- */
-export interface ConditionContainer {
-    /**
-     * Defines a condition for the rule, which needs to be met in order to execute it.
-     */
-    condition?: string;
-}
-/**
- * Used for serializing [[Rule]] objects to JSON.
- * @public
- */
-export declare enum RuleTypes {
-    RootNodes = "RootNodes",
-    ChildNodes = "ChildNodes",
-    Content = "Content",
-    ContentModifier = "ContentModifier",
-    DefaultPropertyCategoryOverride = "DefaultPropertyCategoryOverride",
-    Grouping = "Grouping",
-    PropertySorting = "PropertySorting",
-    DisabledSorting = "DisabledSorting",
-    NodeArtifacts = "NodeArtifacts",
-    InstanceLabelOverride = "InstanceLabelOverride",
-    LabelOverride = "LabelOverride",
-    CheckBox = "CheckBox",
-    ImageIdOverride = "ImageIdOverride",
-    StyleOverride = "StyleOverride",
-    ExtendedData = "ExtendedData"
-}
+/** @packageDocumentation
+ * @module PresentationRules
+ */
+import { ContentRule } from "./content/ContentRule";
+import { DefaultPropertyCategoryOverride } from "./content/DefaultPropertyCategoryOverride";
+import { ContentModifier } from "./content/modifiers/ContentModifier";
+import { CustomizationRule } from "./customization/CustomizationRule";
+import { NavigationRule } from "./hierarchy/NavigationRule";
+import { RequiredSchemaSpecification } from "./SchemasSpecification";
+/**
+ * Base interface for all [[Rule]] implementations.
+ * @public
+ */
+export interface RuleBase {
+    /**
+     * Used for serializing to JSON.
+     * @see RuleTypes
+     */
+    ruleType: `${RuleTypes}`;
+    /**
+     * Defines the order in which rules are handled, higher number means the rule is handled first. If priorities are
+     * equal, the rules are handled in the order they're defined.
+     *
+     * @type integer
+     */
+    priority?: number;
+    /**
+     * Tells the library that the rule should only be handled if no other rule of the same type was handled previously (based on rule
+     * priorities and definition order). This allows adding fallback rules which can be overriden by higher-priority rules.
+     */
+    onlyIfNotHandled?: boolean;
+    /**
+     * A list of [ECSchema requirements]($docs/presentation/RequiredSchemaSpecification.md) that need to be met for the rule to be used.
+     */
+    requiredSchemas?: RequiredSchemaSpecification[];
+}
+/**
+ * A union of all presentation rule types.
+ * @public
+ */
+export declare type Rule = CustomizationRule | NavigationRule | ContentRule | ContentModifier | DefaultPropertyCategoryOverride;
+/**
+ * Container of a [[condition]] property. Used for rules that support conditions. Not
+ * meant to be used directly, see [[Rule]].
+ *
+ * @deprecated in 3.x. This interface is not used anymore. All interfaces that used to extend it, have the [[condition]]
+ * attribute of their own.
+ * @public
+ */
+export interface ConditionContainer {
+    /**
+     * Defines a condition for the rule, which needs to be met in order to execute it.
+     */
+    condition?: string;
+}
+/**
+ * Used for serializing [[Rule]] objects to JSON.
+ * @public
+ */
+export declare enum RuleTypes {
+    RootNodes = "RootNodes",
+    ChildNodes = "ChildNodes",
+    Content = "Content",
+    ContentModifier = "ContentModifier",
+    DefaultPropertyCategoryOverride = "DefaultPropertyCategoryOverride",
+    Grouping = "Grouping",
+    PropertySorting = "PropertySorting",
+    DisabledSorting = "DisabledSorting",
+    NodeArtifacts = "NodeArtifacts",
+    InstanceLabelOverride = "InstanceLabelOverride",
+    LabelOverride = "LabelOverride",
+    CheckBox = "CheckBox",
+    ImageIdOverride = "ImageIdOverride",
+    StyleOverride = "StyleOverride",
+    ExtendedData = "ExtendedData"
+}
 //# sourceMappingURL=Rule.d.ts.map

package/lib/cjs/presentation-common/rules/Rule.js

@@ -1,36 +1,36 @@
-"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.RuleTypes = void 0;
-/**
- * Used for serializing [[Rule]] objects to JSON.
- * @public
- */
-var RuleTypes;
-(function (RuleTypes) {
-    // hierarchy rules
-    RuleTypes["RootNodes"] = "RootNodes";
-    RuleTypes["ChildNodes"] = "ChildNodes";
-    // content rules
-    RuleTypes["Content"] = "Content";
-    RuleTypes["ContentModifier"] = "ContentModifier";
-    RuleTypes["DefaultPropertyCategoryOverride"] = "DefaultPropertyCategoryOverride";
-    // customization rules
-    RuleTypes["Grouping"] = "Grouping";
-    RuleTypes["PropertySorting"] = "PropertySorting";
-    RuleTypes["DisabledSorting"] = "DisabledSorting";
-    RuleTypes["NodeArtifacts"] = "NodeArtifacts";
-    RuleTypes["InstanceLabelOverride"] = "InstanceLabelOverride";
-    RuleTypes["LabelOverride"] = "LabelOverride";
-    RuleTypes["CheckBox"] = "CheckBox";
-    RuleTypes["ImageIdOverride"] = "ImageIdOverride";
-    RuleTypes["StyleOverride"] = "StyleOverride";
-    RuleTypes["ExtendedData"] = "ExtendedData";
-})(RuleTypes = exports.RuleTypes || (exports.RuleTypes = {}));
+"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.RuleTypes = void 0;
+/**
+ * Used for serializing [[Rule]] objects to JSON.
+ * @public
+ */
+var RuleTypes;
+(function (RuleTypes) {
+    // hierarchy rules
+    RuleTypes["RootNodes"] = "RootNodes";
+    RuleTypes["ChildNodes"] = "ChildNodes";
+    // content rules
+    RuleTypes["Content"] = "Content";
+    RuleTypes["ContentModifier"] = "ContentModifier";
+    RuleTypes["DefaultPropertyCategoryOverride"] = "DefaultPropertyCategoryOverride";
+    // customization rules
+    RuleTypes["Grouping"] = "Grouping";
+    RuleTypes["PropertySorting"] = "PropertySorting";
+    RuleTypes["DisabledSorting"] = "DisabledSorting";
+    RuleTypes["NodeArtifacts"] = "NodeArtifacts";
+    RuleTypes["InstanceLabelOverride"] = "InstanceLabelOverride";
+    RuleTypes["LabelOverride"] = "LabelOverride";
+    RuleTypes["CheckBox"] = "CheckBox";
+    RuleTypes["ImageIdOverride"] = "ImageIdOverride";
+    RuleTypes["StyleOverride"] = "StyleOverride";
+    RuleTypes["ExtendedData"] = "ExtendedData";
+})(RuleTypes = exports.RuleTypes || (exports.RuleTypes = {}));
 //# sourceMappingURL=Rule.js.map

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