@itwin/presentation-common 4.0.0-dev.11 → 4.0.0-dev.17

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

@@ -1,9 +1,9 @@
-/*---------------------------------------------------------------------------------------------
-* 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
- */
-export {};
+/*---------------------------------------------------------------------------------------------
+* 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
+ */
+export {};
 //# sourceMappingURL=Ruleset.js.map

package/lib/esm/presentation-common/rules/Ruleset.js.map

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

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

@@ -1,9 +1,9 @@
-/*---------------------------------------------------------------------------------------------
-* 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
- */
-export {};
+/*---------------------------------------------------------------------------------------------
+* 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
+ */
+export {};
 //# sourceMappingURL=SchemasSpecification.js.map

package/lib/esm/presentation-common/rules/SchemasSpecification.js.map

@@ -1 +1 @@
-{"version":3,"file":"SchemasSpecification.js","sourceRoot":"","sources":["../../../../src/presentation-common/rules/SchemasSpecification.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\n/** @packageDocumentation\r\n * @module PresentationRules\r\n */\r\n\r\n/**\r\n * Specification for a list of ECSchemas\r\n * @public\r\n */\r\nexport interface SchemasSpecification {\r\n  /** ECSchema names */\r\n  schemaNames: string[];\r\n\r\n  /**\r\n   * Should schemas specified in [[schemaNames]] be excluded rather than included.\r\n   * Exclusion works by including everything except what's specified in [[schemaNames]].\r\n   */\r\n  isExclude?: boolean;\r\n}\r\n\r\n/**\r\n * This specification is designed for specifying schema requirements for the [[Ruleset]] or specific\r\n * presentation rules.\r\n *\r\n * @see [Required schema specification reference documentation page]($docs/presentation/RequiredSchemaSpecification.md)\r\n * @public\r\n */\r\nexport interface RequiredSchemaSpecification {\r\n  /** Specifies the schema to whom the requirement is being set. */\r\n  name: string;\r\n\r\n  /**\r\n   * Minimum required schema version (inclusive).\r\n   * Format: `{read version}.{write version}.{minor version}`, e.g. `2.1.15`.\r\n   *\r\n   * @pattern ^[\\d]+\\.[\\d]+\\.[\\d]+$\r\n   */\r\n  minVersion?: string;\r\n\r\n  /**\r\n   * Maximum allowed schema version (exclusive).\r\n   * Format: `{read version}.{write version}.{minor version}`, e.g. `2.1.15`.\r\n   *\r\n   * @pattern ^[\\d]+\\.[\\d]+\\.[\\d]+$\r\n   */\r\n  maxVersion?: string;\r\n}\r\n"]}
+{"version":3,"file":"SchemasSpecification.js","sourceRoot":"","sources":["../../../../src/presentation-common/rules/SchemasSpecification.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG","sourcesContent":["/*---------------------------------------------------------------------------------------------\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n* See LICENSE.md in the project root for license terms and full copyright notice.\n*--------------------------------------------------------------------------------------------*/\n/** @packageDocumentation\n * @module PresentationRules\n */\n\n/**\n * Specification for a list of ECSchemas\n * @public\n */\nexport interface SchemasSpecification {\n  /** ECSchema names */\n  schemaNames: string[];\n\n  /**\n   * Should schemas specified in [[schemaNames]] be excluded rather than included.\n   * Exclusion works by including everything except what's specified in [[schemaNames]].\n   */\n  isExclude?: boolean;\n}\n\n/**\n * This specification is designed for specifying schema requirements for the [[Ruleset]] or specific\n * presentation rules.\n *\n * @see [Required schema specification reference documentation page]($docs/presentation/RequiredSchemaSpecification.md)\n * @public\n */\nexport interface RequiredSchemaSpecification {\n  /** Specifies the schema to whom the requirement is being set. */\n  name: string;\n\n  /**\n   * Minimum required schema version (inclusive).\n   * Format: `{read version}.{write version}.{minor version}`, e.g. `2.1.15`.\n   *\n   * @pattern ^[\\d]+\\.[\\d]+\\.[\\d]+$\n   */\n  minVersion?: string;\n\n  /**\n   * Maximum allowed schema version (exclusive).\n   * Format: `{read version}.{write version}.{minor version}`, e.g. `2.1.15`.\n   *\n   * @pattern ^[\\d]+\\.[\\d]+\\.[\\d]+$\n   */\n  maxVersion?: string;\n}\n"]}

package/lib/esm/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/esm/presentation-common/rules/Variables.js

@@ -1,23 +1,23 @@
-/*---------------------------------------------------------------------------------------------
-* 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
- */
-/**
- * Available value types of user-controllable variables
- * @public
- */
-export 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 || (VariableValueType = {}));
+/*---------------------------------------------------------------------------------------------
+* 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
+ */
+/**
+ * Available value types of user-controllable variables
+ * @public
+ */
+export 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 || (VariableValueType = {}));
 //# sourceMappingURL=Variables.js.map

package/lib/esm/presentation-common/rules/Variables.js.map

@@ -1 +1 @@
-{"version":3,"file":"Variables.js","sourceRoot":"","sources":["../../../../src/presentation-common/rules/Variables.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AA0BH;;;GAGG;AACH,MAAM,CAAN,IAAY,iBAYX;AAZD,WAAY,iBAAiB;IAC3B,uDAAuD;IACvD,oCAAe,CAAA;IAEf,0DAA0D;IAC1D,0CAAqB,CAAA;IAErB,uBAAuB;IACvB,2CAAsB,CAAA;IAEtB,wBAAwB;IACxB,qCAAgB,CAAA;AAClB,CAAC,EAZW,iBAAiB,KAAjB,iBAAiB,QAY5B","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\n/** @packageDocumentation\r\n * @module PresentationRules\r\n */\r\n\r\n/**\r\n * Presentation rules support variables that allow having additional customization of the hierarchy\r\n * and content based on variables whose values can change during application session.\r\n *\r\n * There are [special ECExpression symbols]($docs/presentation/advanced/ECExpressions.md#ruleset-variables-user-settings)\r\n * that can be used to access variables by their ID, so rule conditions can check for a value and change\r\n * the behavior. It allows showing / hiding some nodes in the hierarchy, change the grouping, etc.\r\n *\r\n * @public\r\n */\r\nexport interface VariablesGroup {\r\n  /**\r\n   * Group label to display in the UI.\r\n   * May be [localized]($docs/presentation/advanced/Localization.md).\r\n   */\r\n  label: string;\r\n\r\n  /** Grouped variables */\r\n  vars: Variable[];\r\n\r\n  /** Nested variable groups. */\r\n  nestedGroups?: VariablesGroup[];\r\n}\r\n\r\n/**\r\n * Available value types of user-controllable variables\r\n * @public\r\n */\r\nexport enum VariableValueType {\r\n  /** Bool value, that uses Yes / No strings in the UI */\r\n  YesNo = \"YesNo\",\r\n\r\n  /** Bool value, that uses Show / Hide strings in the UI */\r\n  ShowHide = \"ShowHide\",\r\n\r\n  /** Any string value */\r\n  String = \"StringValue\",\r\n\r\n  /** Any integer value */\r\n  Int = \"IntValue\",\r\n}\r\n\r\n/**\r\n * Definition for single user-controllable variable\r\n * @public\r\n */\r\nexport interface Variable {\r\n  /** Id of the variable */\r\n  id: string;\r\n\r\n  /**\r\n   * Label of the variable that is shown in the UI.\r\n   * May be [localized]($docs/presentation/advanced/Localization.md).\r\n   */\r\n  label: string;\r\n\r\n  /**\r\n   * Defines value type. Defaults to [[VariableValueType.YesNo]].\r\n   * @see VariableValueType\r\n   */\r\n  type?: `${VariableValueType}`;\r\n\r\n  /** Default value. */\r\n  defaultValue?: string;\r\n}\r\n"]}
+{"version":3,"file":"Variables.js","sourceRoot":"","sources":["../../../../src/presentation-common/rules/Variables.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AA0BH;;;GAGG;AACH,MAAM,CAAN,IAAY,iBAYX;AAZD,WAAY,iBAAiB;IAC3B,uDAAuD;IACvD,oCAAe,CAAA;IAEf,0DAA0D;IAC1D,0CAAqB,CAAA;IAErB,uBAAuB;IACvB,2CAAsB,CAAA;IAEtB,wBAAwB;IACxB,qCAAgB,CAAA;AAClB,CAAC,EAZW,iBAAiB,KAAjB,iBAAiB,QAY5B","sourcesContent":["/*---------------------------------------------------------------------------------------------\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n* See LICENSE.md in the project root for license terms and full copyright notice.\n*--------------------------------------------------------------------------------------------*/\n/** @packageDocumentation\n * @module PresentationRules\n */\n\n/**\n * Presentation rules support variables that allow having additional customization of the hierarchy\n * and content based on variables whose values can change during application session.\n *\n * There are [special ECExpression symbols]($docs/presentation/advanced/ECExpressions.md#ruleset-variables-user-settings)\n * that can be used to access variables by their ID, so rule conditions can check for a value and change\n * the behavior. It allows showing / hiding some nodes in the hierarchy, change the grouping, etc.\n *\n * @public\n */\nexport interface VariablesGroup {\n  /**\n   * Group label to display in the UI.\n   * May be [localized]($docs/presentation/advanced/Localization.md).\n   */\n  label: string;\n\n  /** Grouped variables */\n  vars: Variable[];\n\n  /** Nested variable groups. */\n  nestedGroups?: VariablesGroup[];\n}\n\n/**\n * Available value types of user-controllable variables\n * @public\n */\nexport enum VariableValueType {\n  /** Bool value, that uses Yes / No strings in the UI */\n  YesNo = \"YesNo\",\n\n  /** Bool value, that uses Show / Hide strings in the UI */\n  ShowHide = \"ShowHide\",\n\n  /** Any string value */\n  String = \"StringValue\",\n\n  /** Any integer value */\n  Int = \"IntValue\",\n}\n\n/**\n * Definition for single user-controllable variable\n * @public\n */\nexport interface Variable {\n  /** Id of the variable */\n  id: string;\n\n  /**\n   * Label of the variable that is shown in the UI.\n   * May be [localized]($docs/presentation/advanced/Localization.md).\n   */\n  label: string;\n\n  /**\n   * Defines value type. Defaults to [[VariableValueType.YesNo]].\n   * @see VariableValueType\n   */\n  type?: `${VariableValueType}`;\n\n  /** Default value. */\n  defaultValue?: string;\n}\n"]}

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

@@ -1,9 +1,9 @@
-/*---------------------------------------------------------------------------------------------
-* 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
- */
-export {};
+/*---------------------------------------------------------------------------------------------
+* 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
+ */
+export {};
 //# sourceMappingURL=ContentInstancesOfSpecificClassesSpecification.js.map

package/lib/esm/presentation-common/rules/content/ContentInstancesOfSpecificClassesSpecification.js.map

@@ -1 +1 @@
-{"version":3,"file":"ContentInstancesOfSpecificClassesSpecification.js","sourceRoot":"","sources":["../../../../../src/presentation-common/rules/content/ContentInstancesOfSpecificClassesSpecification.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\n/** @packageDocumentation\r\n * @module PresentationRules\r\n */\r\n\r\nimport { MultiSchemaClassesSpecification } from \"../ClassSpecifications\";\r\nimport { ContentSpecificationBase } from \"./ContentSpecification\";\r\n\r\n/**\r\n * This specification creates content for all instances of specific ECClasses.\r\n *\r\n * @see [Content instances of specific classes specification reference documentation page]($docs/presentation/content/ContentInstancesOfSpecificClasses.md)\r\n * @public\r\n */\r\nexport interface ContentInstancesOfSpecificClassesSpecification extends ContentSpecificationBase {\r\n  /** Used for serializing to JSON. */\r\n  specType: \"ContentInstancesOfSpecificClasses\";\r\n\r\n  /**\r\n   * Defines a set of [multi schema classes]($docs/presentation/MultiSchemaClassesSpecification.md) that specify which\r\n   * ECClasses need to be selected to form the result.\r\n   */\r\n  classes: MultiSchemaClassesSpecification | MultiSchemaClassesSpecification[];\r\n\r\n  /**\r\n   * Defines a set of [multi schema classes]($docs/presentation/MultiSchemaClassesSpecification.md) that prevents specified\r\n   * ECClasses and subclasses from being selected by [[classes]] attribute.\r\n   */\r\n  excludedClasses?: MultiSchemaClassesSpecification | MultiSchemaClassesSpecification[];\r\n\r\n  /**\r\n   * Tells whether selecting instances from ECClasses specified in [[classes]] and [[excludedClasses]]\r\n   * attributes should be polymorphic or not.\r\n   *\r\n   * @deprecated in 2.x. Specify polymorphism value inside [[classes.arePolymorphic]] or [[excludedClasses.arePolymorphic]].\r\n   */\r\n  handleInstancesPolymorphically?: boolean;\r\n\r\n  /**\r\n   * Specifies whether properties of derived [[classes]] should be included in the content.\r\n   */\r\n  handlePropertiesPolymorphically?: boolean;\r\n\r\n  /**\r\n   * Specifies an [ECExpression]($docs/presentation/content/ECExpressions.md#instance-filter) for filtering instances\r\n   * of ECClasses specified through the [[classes]] attribute.\r\n   */\r\n  instanceFilter?: string;\r\n}\r\n"]}
+{"version":3,"file":"ContentInstancesOfSpecificClassesSpecification.js","sourceRoot":"","sources":["../../../../../src/presentation-common/rules/content/ContentInstancesOfSpecificClassesSpecification.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG","sourcesContent":["/*---------------------------------------------------------------------------------------------\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n* See LICENSE.md in the project root for license terms and full copyright notice.\n*--------------------------------------------------------------------------------------------*/\n/** @packageDocumentation\n * @module PresentationRules\n */\n\nimport { MultiSchemaClassesSpecification } from \"../ClassSpecifications\";\nimport { ContentSpecificationBase } from \"./ContentSpecification\";\n\n/**\n * This specification creates content for all instances of specific ECClasses.\n *\n * @see [Content instances of specific classes specification reference documentation page]($docs/presentation/content/ContentInstancesOfSpecificClasses.md)\n * @public\n */\nexport interface ContentInstancesOfSpecificClassesSpecification extends ContentSpecificationBase {\n  /** Used for serializing to JSON. */\n  specType: \"ContentInstancesOfSpecificClasses\";\n\n  /**\n   * Defines a set of [multi schema classes]($docs/presentation/MultiSchemaClassesSpecification.md) that specify which\n   * ECClasses need to be selected to form the result.\n   */\n  classes: MultiSchemaClassesSpecification | MultiSchemaClassesSpecification[];\n\n  /**\n   * Defines a set of [multi schema classes]($docs/presentation/MultiSchemaClassesSpecification.md) that prevents specified\n   * ECClasses and subclasses from being selected by [[classes]] attribute.\n   */\n  excludedClasses?: MultiSchemaClassesSpecification | MultiSchemaClassesSpecification[];\n\n  /**\n   * Tells whether selecting instances from ECClasses specified in [[classes]] and [[excludedClasses]]\n   * attributes should be polymorphic or not.\n   *\n   * @deprecated in 2.x. Specify polymorphism value inside [[classes.arePolymorphic]] or [[excludedClasses.arePolymorphic]].\n   */\n  handleInstancesPolymorphically?: boolean;\n\n  /**\n   * Specifies whether properties of derived [[classes]] should be included in the content.\n   */\n  handlePropertiesPolymorphically?: boolean;\n\n  /**\n   * Specifies an [ECExpression]($docs/presentation/content/ECExpressions.md#instance-filter) for filtering instances\n   * of ECClasses specified through the [[classes]] attribute.\n   */\n  instanceFilter?: string;\n}\n"]}