@itwin/presentation-common 4.9.0-dev.24 → 4.9.0-dev.26

package/CHANGELOG.md

@@ -1,6 +1,11 @@
 # Change Log - @itwin/presentation-common
 
-This log was last generated on Fri, 06 Sep 2024 05:08:18 GMT and should not be manually modified.
+This log was last generated on Fri, 13 Sep 2024 15:12:41 GMT and should not be manually modified.
+
+## 4.8.7
+Fri, 13 Sep 2024 15:11:17 GMT
+
+_Version update only_
 
 ## 4.8.6
 Fri, 06 Sep 2024 05:06:49 GMT

package/Ruleset.schema.json

@@ -39,6 +39,19 @@
           "$ref": "#/definitions/CustomRendererSpecification",
           "description": "Custom property renderer specification that allows assigning a\ncustom value renderer to be used in UI. The specification is used to set up `Field.renderer` for\nthis property and it's up to the UI component to make sure appropriate renderer is used to render the property."
         },
+        "type": {
+          "description": "Specifies return type of the calculated property. If unsupported type is provided, calculated property won't appear in the property pane.\n\nType can have these values: `string`, `boolean`, `bool`, `dateTime`, `double`, `int`, `long`",
+          "enum": [
+            "bool",
+            "boolean",
+            "dateTime",
+            "double",
+            "int",
+            "long",
+            "string"
+          ],
+          "type": "string"
+        },
         "value": {
           "description": "Defines an expression to calculate the value. The expression can use ECInstance\nand Ruleset Variables symbol contexts.",
           "type": "string"

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

@@ -38,5 +38,11 @@ export interface CalculatedPropertiesSpecification {
      * @type integer
      */
     priority?: number;
+    /**
+     * Specifies return type of the calculated property. If unsupported type is provided, calculated property won't appear in the property pane.
+     *
+     * Type can have these values: `string`, `boolean`, `bool`, `dateTime`, `double`, `int`, `long`
+     */
+    type?: `string` | `boolean` | `bool` | `dateTime` | `double` | `int` | `long`;
 }
 //# sourceMappingURL=CalculatedPropertiesSpecification.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"CalculatedPropertiesSpecification.d.ts","sourceRoot":"","sources":["../../../../../../src/presentation-common/rules/content/modifiers/CalculatedPropertiesSpecification.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,2BAA2B,EAAE,MAAM,+BAA+B,CAAC;AAC5E,OAAO,EAAE,kBAAkB,EAAE,MAAM,iCAAiC,CAAC;AACrE,OAAO,EAAE,2BAA2B,EAAE,MAAM,gCAAgC,CAAC;AAE7E;;;;;GAKG;AACH,MAAM,WAAW,iCAAiC;IAChD,wHAAwH;IACxH,KAAK,EAAE,MAAM,CAAC;IAEd;;;OAGG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf,qFAAqF;IACrF,UAAU,CAAC,EAAE,MAAM,GAAG,kBAAkB,CAAC;IAEzC;;;;OAIG;IACH,QAAQ,CAAC,EAAE,2BAA2B,CAAC;IAEvC;;;OAGG;IACH,MAAM,CAAC,EAAE,2BAA2B,CAAC;IAErC;;;;;OAKG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB"}
+{"version":3,"file":"CalculatedPropertiesSpecification.d.ts","sourceRoot":"","sources":["../../../../../../src/presentation-common/rules/content/modifiers/CalculatedPropertiesSpecification.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,2BAA2B,EAAE,MAAM,+BAA+B,CAAC;AAC5E,OAAO,EAAE,kBAAkB,EAAE,MAAM,iCAAiC,CAAC;AACrE,OAAO,EAAE,2BAA2B,EAAE,MAAM,gCAAgC,CAAC;AAE7E;;;;;GAKG;AACH,MAAM,WAAW,iCAAiC;IAChD,wHAAwH;IACxH,KAAK,EAAE,MAAM,CAAC;IAEd;;;OAGG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf,qFAAqF;IACrF,UAAU,CAAC,EAAE,MAAM,GAAG,kBAAkB,CAAC;IAEzC;;;;OAIG;IACH,QAAQ,CAAC,EAAE,2BAA2B,CAAC;IAEvC;;;OAGG;IACH,MAAM,CAAC,EAAE,2BAA2B,CAAC;IAErC;;;;;OAKG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;;;OAIG;IACH,IAAI,CAAC,EAAE,QAAQ,GAAG,SAAS,GAAG,MAAM,GAAG,UAAU,GAAG,QAAQ,GAAG,KAAK,GAAG,MAAM,CAAC;CAC/E"}

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

@@ -1 +1 @@
-{"version":3,"file":"CalculatedPropertiesSpecification.js","sourceRoot":"","sources":["../../../../../../src/presentation-common/rules/content/modifiers/CalculatedPropertiesSpecification.ts"],"names":[],"mappings":";AAAA;;;gGAGgG;AAChG;;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 { CustomRendererSpecification } from \"./CustomRendererSpecification\";\r\nimport { CategoryIdentifier } from \"./PropertyCategorySpecification\";\r\nimport { PropertyEditorSpecification } from \"./PropertyEditorsSpecification\";\r\n\r\n/**\r\n * This content modifier allows including additional calculated properties into the content.\r\n *\r\n * @see [Calculated properties specification reference documentation page]($docs/presentation/content/CalculatedPropertiesSpecification.md)\r\n * @public\r\n */\r\nexport interface CalculatedPropertiesSpecification {\r\n  /** Specifies label of the calculated property. Supports [localization]($docs/presentation/advanced/Localization.md). */\r\n  label: string;\r\n\r\n  /**\r\n   * Defines an expression to calculate the value. The expression can use [ECInstance]($docs/presentation/advanced/ECExpressions.md#ecinstance)\r\n   * and [Ruleset Variables]($docs/presentation/advanced/ECExpressions.md#ruleset-variables-user-settings) symbol contexts.\r\n   */\r\n  value?: string;\r\n\r\n  /** The attribute allows moving the calculated property into a different category. */\r\n  categoryId?: string | CategoryIdentifier;\r\n\r\n  /**\r\n   * Custom property [renderer specification]($docs/presentation/content/RendererSpecification.md) that allows assigning a\r\n   * custom value renderer to be used in UI. The specification is used to set up [[Field.renderer]] for\r\n   * this property and it's up to the UI component to make sure appropriate renderer is used to render the property.\r\n   */\r\n  renderer?: CustomRendererSpecification;\r\n\r\n  /**\r\n   * Custom [property editor specification]($docs/presentation/content/PropertyEditorSpecification) that allows assigning\r\n   * a custom value editor to be used in UI.\r\n   */\r\n  editor?: PropertyEditorSpecification;\r\n\r\n  /**\r\n   * Assign a custom [[Field.priority]] to the property. It's up to the UI component to make sure that priority\r\n   * is respected - properties with higher priority should appear before or above properties with lower priority.\r\n   *\r\n   * @type integer\r\n   */\r\n  priority?: number;\r\n}\r\n"]}
+{"version":3,"file":"CalculatedPropertiesSpecification.js","sourceRoot":"","sources":["../../../../../../src/presentation-common/rules/content/modifiers/CalculatedPropertiesSpecification.ts"],"names":[],"mappings":";AAAA;;;gGAGgG;AAChG;;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 { CustomRendererSpecification } from \"./CustomRendererSpecification\";\r\nimport { CategoryIdentifier } from \"./PropertyCategorySpecification\";\r\nimport { PropertyEditorSpecification } from \"./PropertyEditorsSpecification\";\r\n\r\n/**\r\n * This content modifier allows including additional calculated properties into the content.\r\n *\r\n * @see [Calculated properties specification reference documentation page]($docs/presentation/content/CalculatedPropertiesSpecification.md)\r\n * @public\r\n */\r\nexport interface CalculatedPropertiesSpecification {\r\n  /** Specifies label of the calculated property. Supports [localization]($docs/presentation/advanced/Localization.md). */\r\n  label: string;\r\n\r\n  /**\r\n   * Defines an expression to calculate the value. The expression can use [ECInstance]($docs/presentation/advanced/ECExpressions.md#ecinstance)\r\n   * and [Ruleset Variables]($docs/presentation/advanced/ECExpressions.md#ruleset-variables-user-settings) symbol contexts.\r\n   */\r\n  value?: string;\r\n\r\n  /** The attribute allows moving the calculated property into a different category. */\r\n  categoryId?: string | CategoryIdentifier;\r\n\r\n  /**\r\n   * Custom property [renderer specification]($docs/presentation/content/RendererSpecification.md) that allows assigning a\r\n   * custom value renderer to be used in UI. The specification is used to set up [[Field.renderer]] for\r\n   * this property and it's up to the UI component to make sure appropriate renderer is used to render the property.\r\n   */\r\n  renderer?: CustomRendererSpecification;\r\n\r\n  /**\r\n   * Custom [property editor specification]($docs/presentation/content/PropertyEditorSpecification) that allows assigning\r\n   * a custom value editor to be used in UI.\r\n   */\r\n  editor?: PropertyEditorSpecification;\r\n\r\n  /**\r\n   * Assign a custom [[Field.priority]] to the property. It's up to the UI component to make sure that priority\r\n   * is respected - properties with higher priority should appear before or above properties with lower priority.\r\n   *\r\n   * @type integer\r\n   */\r\n  priority?: number;\r\n\r\n  /**\r\n   * Specifies return type of the calculated property. If unsupported type is provided, calculated property won't appear in the property pane.\r\n   *\r\n   * Type can have these values: `string`, `boolean`, `bool`, `dateTime`, `double`, `int`, `long`\r\n   */\r\n  type?: `string` | `boolean` | `bool` | `dateTime` | `double` | `int` | `long`;\r\n}\r\n"]}

package/lib/esm/presentation-common/rules/content/modifiers/CalculatedPropertiesSpecification.d.ts

@@ -38,5 +38,11 @@ export interface CalculatedPropertiesSpecification {
      * @type integer
      */
     priority?: number;
+    /**
+     * Specifies return type of the calculated property. If unsupported type is provided, calculated property won't appear in the property pane.
+     *
+     * Type can have these values: `string`, `boolean`, `bool`, `dateTime`, `double`, `int`, `long`
+     */
+    type?: `string` | `boolean` | `bool` | `dateTime` | `double` | `int` | `long`;
 }
 //# sourceMappingURL=CalculatedPropertiesSpecification.d.ts.map

package/lib/esm/presentation-common/rules/content/modifiers/CalculatedPropertiesSpecification.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"CalculatedPropertiesSpecification.d.ts","sourceRoot":"","sources":["../../../../../../src/presentation-common/rules/content/modifiers/CalculatedPropertiesSpecification.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,2BAA2B,EAAE,MAAM,+BAA+B,CAAC;AAC5E,OAAO,EAAE,kBAAkB,EAAE,MAAM,iCAAiC,CAAC;AACrE,OAAO,EAAE,2BAA2B,EAAE,MAAM,gCAAgC,CAAC;AAE7E;;;;;GAKG;AACH,MAAM,WAAW,iCAAiC;IAChD,wHAAwH;IACxH,KAAK,EAAE,MAAM,CAAC;IAEd;;;OAGG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf,qFAAqF;IACrF,UAAU,CAAC,EAAE,MAAM,GAAG,kBAAkB,CAAC;IAEzC;;;;OAIG;IACH,QAAQ,CAAC,EAAE,2BAA2B,CAAC;IAEvC;;;OAGG;IACH,MAAM,CAAC,EAAE,2BAA2B,CAAC;IAErC;;;;;OAKG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB"}
+{"version":3,"file":"CalculatedPropertiesSpecification.d.ts","sourceRoot":"","sources":["../../../../../../src/presentation-common/rules/content/modifiers/CalculatedPropertiesSpecification.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,2BAA2B,EAAE,MAAM,+BAA+B,CAAC;AAC5E,OAAO,EAAE,kBAAkB,EAAE,MAAM,iCAAiC,CAAC;AACrE,OAAO,EAAE,2BAA2B,EAAE,MAAM,gCAAgC,CAAC;AAE7E;;;;;GAKG;AACH,MAAM,WAAW,iCAAiC;IAChD,wHAAwH;IACxH,KAAK,EAAE,MAAM,CAAC;IAEd;;;OAGG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf,qFAAqF;IACrF,UAAU,CAAC,EAAE,MAAM,GAAG,kBAAkB,CAAC;IAEzC;;;;OAIG;IACH,QAAQ,CAAC,EAAE,2BAA2B,CAAC;IAEvC;;;OAGG;IACH,MAAM,CAAC,EAAE,2BAA2B,CAAC;IAErC;;;;;OAKG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;;;OAIG;IACH,IAAI,CAAC,EAAE,QAAQ,GAAG,SAAS,GAAG,MAAM,GAAG,UAAU,GAAG,QAAQ,GAAG,KAAK,GAAG,MAAM,CAAC;CAC/E"}

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

@@ -1 +1 @@
-{"version":3,"file":"CalculatedPropertiesSpecification.js","sourceRoot":"","sources":["../../../../../../src/presentation-common/rules/content/modifiers/CalculatedPropertiesSpecification.ts"],"names":[],"mappings":"AAAA;;;gGAGgG;AAChG;;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 { CustomRendererSpecification } from \"./CustomRendererSpecification\";\r\nimport { CategoryIdentifier } from \"./PropertyCategorySpecification\";\r\nimport { PropertyEditorSpecification } from \"./PropertyEditorsSpecification\";\r\n\r\n/**\r\n * This content modifier allows including additional calculated properties into the content.\r\n *\r\n * @see [Calculated properties specification reference documentation page]($docs/presentation/content/CalculatedPropertiesSpecification.md)\r\n * @public\r\n */\r\nexport interface CalculatedPropertiesSpecification {\r\n  /** Specifies label of the calculated property. Supports [localization]($docs/presentation/advanced/Localization.md). */\r\n  label: string;\r\n\r\n  /**\r\n   * Defines an expression to calculate the value. The expression can use [ECInstance]($docs/presentation/advanced/ECExpressions.md#ecinstance)\r\n   * and [Ruleset Variables]($docs/presentation/advanced/ECExpressions.md#ruleset-variables-user-settings) symbol contexts.\r\n   */\r\n  value?: string;\r\n\r\n  /** The attribute allows moving the calculated property into a different category. */\r\n  categoryId?: string | CategoryIdentifier;\r\n\r\n  /**\r\n   * Custom property [renderer specification]($docs/presentation/content/RendererSpecification.md) that allows assigning a\r\n   * custom value renderer to be used in UI. The specification is used to set up [[Field.renderer]] for\r\n   * this property and it's up to the UI component to make sure appropriate renderer is used to render the property.\r\n   */\r\n  renderer?: CustomRendererSpecification;\r\n\r\n  /**\r\n   * Custom [property editor specification]($docs/presentation/content/PropertyEditorSpecification) that allows assigning\r\n   * a custom value editor to be used in UI.\r\n   */\r\n  editor?: PropertyEditorSpecification;\r\n\r\n  /**\r\n   * Assign a custom [[Field.priority]] to the property. It's up to the UI component to make sure that priority\r\n   * is respected - properties with higher priority should appear before or above properties with lower priority.\r\n   *\r\n   * @type integer\r\n   */\r\n  priority?: number;\r\n}\r\n"]}
+{"version":3,"file":"CalculatedPropertiesSpecification.js","sourceRoot":"","sources":["../../../../../../src/presentation-common/rules/content/modifiers/CalculatedPropertiesSpecification.ts"],"names":[],"mappings":"AAAA;;;gGAGgG;AAChG;;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 { CustomRendererSpecification } from \"./CustomRendererSpecification\";\r\nimport { CategoryIdentifier } from \"./PropertyCategorySpecification\";\r\nimport { PropertyEditorSpecification } from \"./PropertyEditorsSpecification\";\r\n\r\n/**\r\n * This content modifier allows including additional calculated properties into the content.\r\n *\r\n * @see [Calculated properties specification reference documentation page]($docs/presentation/content/CalculatedPropertiesSpecification.md)\r\n * @public\r\n */\r\nexport interface CalculatedPropertiesSpecification {\r\n  /** Specifies label of the calculated property. Supports [localization]($docs/presentation/advanced/Localization.md). */\r\n  label: string;\r\n\r\n  /**\r\n   * Defines an expression to calculate the value. The expression can use [ECInstance]($docs/presentation/advanced/ECExpressions.md#ecinstance)\r\n   * and [Ruleset Variables]($docs/presentation/advanced/ECExpressions.md#ruleset-variables-user-settings) symbol contexts.\r\n   */\r\n  value?: string;\r\n\r\n  /** The attribute allows moving the calculated property into a different category. */\r\n  categoryId?: string | CategoryIdentifier;\r\n\r\n  /**\r\n   * Custom property [renderer specification]($docs/presentation/content/RendererSpecification.md) that allows assigning a\r\n   * custom value renderer to be used in UI. The specification is used to set up [[Field.renderer]] for\r\n   * this property and it's up to the UI component to make sure appropriate renderer is used to render the property.\r\n   */\r\n  renderer?: CustomRendererSpecification;\r\n\r\n  /**\r\n   * Custom [property editor specification]($docs/presentation/content/PropertyEditorSpecification) that allows assigning\r\n   * a custom value editor to be used in UI.\r\n   */\r\n  editor?: PropertyEditorSpecification;\r\n\r\n  /**\r\n   * Assign a custom [[Field.priority]] to the property. It's up to the UI component to make sure that priority\r\n   * is respected - properties with higher priority should appear before or above properties with lower priority.\r\n   *\r\n   * @type integer\r\n   */\r\n  priority?: number;\r\n\r\n  /**\r\n   * Specifies return type of the calculated property. If unsupported type is provided, calculated property won't appear in the property pane.\r\n   *\r\n   * Type can have these values: `string`, `boolean`, `bool`, `dateTime`, `double`, `int`, `long`\r\n   */\r\n  type?: `string` | `boolean` | `bool` | `dateTime` | `double` | `int` | `long`;\r\n}\r\n"]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@itwin/presentation-common",
-  "version": "4.9.0-dev.24",
+  "version": "4.9.0-dev.26",
   "description": "Common pieces for iModel.js presentation packages",
   "license": "MIT",
   "repository": {
@@ -22,10 +22,10 @@
   "module": "lib/esm/presentation-common.js",
   "typings": "lib/cjs/presentation-common",
   "peerDependencies": {
-    "@itwin/core-bentley": "^4.9.0-dev.24",
-    "@itwin/core-common": "^4.9.0-dev.24",
-    "@itwin/core-quantity": "^4.9.0-dev.24",
-    "@itwin/ecschema-metadata": "^4.9.0-dev.24"
+    "@itwin/core-bentley": "^4.9.0-dev.26",
+    "@itwin/core-common": "^4.9.0-dev.26",
+    "@itwin/core-quantity": "^4.9.0-dev.26",
+    "@itwin/ecschema-metadata": "^4.9.0-dev.26"
   },
   "devDependencies": {
     "@itwin/eslint-plugin": "^4.0.2",
@@ -61,11 +61,11 @@
     "typescript": "~5.3.3",
     "typescript-json-schema": "^0.55.0",
     "yargs": "^17.4.0",
-    "@itwin/build-tools": "4.9.0-dev.24",
-    "@itwin/core-bentley": "4.9.0-dev.24",
-    "@itwin/core-common": "4.9.0-dev.24",
-    "@itwin/core-quantity": "4.9.0-dev.24",
-    "@itwin/ecschema-metadata": "4.9.0-dev.24"
+    "@itwin/build-tools": "4.9.0-dev.26",
+    "@itwin/core-common": "4.9.0-dev.26",
+    "@itwin/core-bentley": "4.9.0-dev.26",
+    "@itwin/core-quantity": "4.9.0-dev.26",
+    "@itwin/ecschema-metadata": "4.9.0-dev.26"
   },
   "nyc": {
     "extends": "./node_modules/@itwin/build-tools/.nycrc"