@itwin/presentation-common 4.0.0-dev.70 → 4.0.0-dev.72

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/CHANGELOG.md CHANGED
@@ -1,6 +1,38 @@
1
1
  # Change Log - @itwin/presentation-common
2
2
 
3
- This log was last generated on Wed, 08 Feb 2023 14:58:40 GMT and should not be manually modified.
3
+ This log was last generated on Wed, 12 Apr 2023 13:12:42 GMT and should not be manually modified.
4
+
5
+ ## 3.7.2
6
+ Wed, 12 Apr 2023 13:12:42 GMT
7
+
8
+ _Version update only_
9
+
10
+ ## 3.7.1
11
+ Mon, 03 Apr 2023 15:15:37 GMT
12
+
13
+ _Version update only_
14
+
15
+ ## 3.7.0
16
+ Wed, 29 Mar 2023 15:02:27 GMT
17
+
18
+ ### Updates
19
+
20
+ - Fix `@deprecated` messages
21
+
22
+ ## 3.6.3
23
+ Mon, 27 Mar 2023 16:26:47 GMT
24
+
25
+ _Version update only_
26
+
27
+ ## 3.6.2
28
+ Fri, 17 Mar 2023 17:52:32 GMT
29
+
30
+ _Version update only_
31
+
32
+ ## 3.6.1
33
+ Fri, 24 Feb 2023 22:00:48 GMT
34
+
35
+ _Version update only_
4
36
 
5
37
  ## 3.6.0
6
38
  Wed, 08 Feb 2023 14:58:40 GMT
@@ -244,7 +276,7 @@ Mon, 24 Jan 2022 14:00:52 GMT
244
276
  - Optimize `KeySetJSON` size by compressing instance IDs.
245
277
  - Remove `PresentationRpcInterface.loadHierarchy`.
246
278
  - The `condition` attribute should be defined on both `ChildNodeRule` and `RootNodeRule`.
247
- - Added `ignoreCategories` parameter in `createFieldHierarchies` function for adding all of the nested properties to parent field's child fields without considering categories.
279
+ - Added `ignoreCategories` parameter in `createFieldHierarchies` function for adding all of the nested properties to parent field's child fields without considering categories.
248
280
  - Removed `PresentationUnitSystem` in favor of `UnitSystemKey` from `@itwin/core-quantity`.
249
281
  - remove ClientRequestContext.current
250
282
 
@@ -27,6 +27,7 @@
27
27
  },
28
28
  "CheckBoxRule": {
29
29
  "additionalProperties": false,
30
+ "deprecated": "in 3.x. Use `ExtendedDataRule` instead. See extended data usage page for more details.",
30
31
  "description": "CheckBox rules provide a way to create a checkbox for specific types of ECInstance's.",
31
32
  "properties": {
32
33
  "condition": {
@@ -224,6 +225,7 @@
224
225
  "description": "Defines a set of multi schema classes that prevents specified\nECClasses and subclasses from being selected by `classes` attribute."
225
226
  },
226
227
  "handleInstancesPolymorphically": {
228
+ "deprecated": "in 2.x. Specify polymorphism value inside `classes.arePolymorphic` or `excludedClasses.arePolymorphic`.",
227
229
  "description": "Tells whether selecting instances from ECClasses specified in `classes` and `excludedClasses`\nattributes should be polymorphic or not.",
228
230
  "type": "boolean"
229
231
  },
@@ -272,6 +274,7 @@
272
274
  "type": "array"
273
275
  },
274
276
  "showImages": {
277
+ "deprecated": "in 3.x. Use `ExtendedDataRule` instead. See extended data usage page for more details.",
275
278
  "description": "Should image IDs be calculated for the returned instances. When `true`, `ImageIdOverride` rules get applied when\ncreating the content.",
276
279
  "type": "boolean"
277
280
  },
@@ -412,6 +415,7 @@
412
415
  "type": "array"
413
416
  },
414
417
  "showImages": {
418
+ "deprecated": "in 3.x. Use `ExtendedDataRule` instead. See extended data usage page for more details.",
415
419
  "description": "Should image IDs be calculated for the returned instances. When `true`, `ImageIdOverride` rules get applied when\ncreating the content.",
416
420
  "type": "boolean"
417
421
  },
@@ -936,6 +940,7 @@
936
940
  },
937
941
  "ImageIdOverride": {
938
942
  "additionalProperties": false,
943
+ "deprecated": "in 3.x. Use `ExtendedDataRule` instead. See extended data usage page for more details.",
939
944
  "description": "ImageId override rules allow setting an image ID to specific types of ECInstances.",
940
945
  "properties": {
941
946
  "condition": {
@@ -1248,6 +1253,7 @@
1248
1253
  "description": "Returns nodes for instances of specific ECClasses.",
1249
1254
  "properties": {
1250
1255
  "arePolymorphic": {
1256
+ "deprecated": "in 3.x. The attribute was replaced by `arePolymorphic` attribute specified individually for each class definition\nunder `classes` and `excludedClasses` attributes. At the moment, to keep backwards compatibility, this attribute acts\nas a fallback value in case the flag is not specified individually for a class definition.",
1251
1257
  "description": "Tells whether selecting instances from ECClasses specified in `classes` and `excludedClasses`\nattributes should be polymorphic or not.",
1252
1258
  "type": "boolean"
1253
1259
  },
@@ -1354,6 +1360,7 @@
1354
1360
  },
1355
1361
  "LabelOverride": {
1356
1362
  "additionalProperties": false,
1363
+ "deprecated": "in 3.x. Use `InstanceLabelOverride` rule instead.",
1357
1364
  "description": "Label override rules provide advanced ways to override instance labels and descriptions in\nexchange of some performance penalty.",
1358
1365
  "properties": {
1359
1366
  "condition": {
@@ -1713,6 +1720,7 @@
1713
1720
  "type": "boolean"
1714
1721
  },
1715
1722
  "groupingValue": {
1723
+ "deprecated": "in 3.x. Display value should always be used for grouping.",
1716
1724
  "description": "Specifies whether instances should be grouped using property's display or raw value.",
1717
1725
  "enum": [
1718
1726
  "DisplayLabel",
@@ -1738,6 +1746,7 @@
1738
1746
  "type": "array"
1739
1747
  },
1740
1748
  "sortingValue": {
1749
+ "deprecated": "in 3.x. Property grouping nodes should always be sorted by display label.",
1741
1750
  "description": "Specifies whether nodes should be sorted by their display label or the grouping property's value. In most cases the result\nis the same, unless a label override rule is used to change node's display label.",
1742
1751
  "enum": [
1743
1752
  "DisplayLabel",
@@ -2469,6 +2478,7 @@
2469
2478
  "type": "array"
2470
2479
  },
2471
2480
  "showImages": {
2481
+ "deprecated": "in 3.x. Use `ExtendedDataRule` instead. See extended data usage page for more details.",
2472
2482
  "description": "Should image IDs be calculated for the returned instances. When `true`, `ImageIdOverride` rules get applied when\ncreating the content.",
2473
2483
  "type": "boolean"
2474
2484
  },
@@ -2535,6 +2545,7 @@
2535
2545
  },
2536
2546
  "StyleOverride": {
2537
2547
  "additionalProperties": false,
2548
+ "deprecated": "in 3.x. Use `ExtendedDataRule` instead. See extended data usage page for more details.",
2538
2549
  "description": "Style override rules allow customizing display style of specific types of ECInstances.",
2539
2550
  "properties": {
2540
2551
  "backColor": {
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@itwin/presentation-common",
3
- "version": "4.0.0-dev.70",
3
+ "version": "4.0.0-dev.72",
4
4
  "description": "Common pieces for iModel.js presentation packages",
5
5
  "license": "MIT",
6
6
  "repository": {
@@ -22,18 +22,18 @@
22
22
  "module": "lib/esm/presentation-common.js",
23
23
  "typings": "lib/cjs/presentation-common",
24
24
  "peerDependencies": {
25
- "@itwin/core-bentley": "^4.0.0-dev.70",
26
- "@itwin/core-common": "^4.0.0-dev.70",
27
- "@itwin/core-quantity": "^4.0.0-dev.70",
28
- "@itwin/ecschema-metadata": "^4.0.0-dev.70"
25
+ "@itwin/core-bentley": "^4.0.0-dev.72",
26
+ "@itwin/core-common": "^4.0.0-dev.72",
27
+ "@itwin/core-quantity": "^4.0.0-dev.72",
28
+ "@itwin/ecschema-metadata": "^4.0.0-dev.72"
29
29
  },
30
30
  "devDependencies": {
31
- "@itwin/build-tools": "4.0.0-dev.70",
32
- "@itwin/core-bentley": "4.0.0-dev.70",
33
- "@itwin/core-common": "4.0.0-dev.70",
34
- "@itwin/core-quantity": "4.0.0-dev.70",
35
- "@itwin/ecschema-metadata": "4.0.0-dev.70",
36
- "@itwin/eslint-plugin": "^4.0.0-dev.32",
31
+ "@itwin/build-tools": "4.0.0-dev.72",
32
+ "@itwin/core-bentley": "4.0.0-dev.72",
33
+ "@itwin/core-common": "4.0.0-dev.72",
34
+ "@itwin/core-quantity": "4.0.0-dev.72",
35
+ "@itwin/ecschema-metadata": "4.0.0-dev.72",
36
+ "@itwin/eslint-plugin": "^4.0.0-dev.33",
37
37
  "@types/chai": "4.3.1",
38
38
  "@types/chai-as-promised": "^7",
39
39
  "@types/chai-jest-snapshot": "^1.3.0",
@@ -51,7 +51,7 @@
51
51
  "cpx2": "^3.0.0",
52
52
  "cross-env": "^5.1.4",
53
53
  "deep-equal": "^1",
54
- "eslint": "^7.11.0",
54
+ "eslint": "^8.36.0",
55
55
  "faker": "^4.1.0",
56
56
  "json-schema-faker": "0.5.0-rc16",
57
57
  "mocha": "^10.0.0",
@@ -89,7 +89,7 @@
89
89
  "extract": "betools extract --fileExt=ts --extractFrom=./src/test --recursive --out=../../generated-docs/extract",
90
90
  "extract-api": "betools extract-api --entry=presentation-common",
91
91
  "ruleset-json-schema": "npm run -s ruleset-json-schema:generate && npm run -s ruleset-json-schema:post-process",
92
- "ruleset-json-schema:generate": "typescript-json-schema ./tsconfig.json Ruleset --noExtraProps --required --strictNullChecks --include ./src/presentation-common/rules/**/*.ts --include ./src/presentation-common/rules/*.ts > ./Ruleset.schema.json",
92
+ "ruleset-json-schema:generate": "typescript-json-schema ./tsconfig.json Ruleset --noExtraProps --required --strictNullChecks --validationKeywords deprecated --include ./src/presentation-common/rules/**/*.ts --include ./src/presentation-common/rules/*.ts > ./Ruleset.schema.json",
93
93
  "ruleset-json-schema:post-process": "node ./scripts/post-process-json-schema.js --path ./Ruleset.schema.json",
94
94
  "lint": "eslint -f visualstudio \"./src/**/*.ts\" 1>&2",
95
95
  "pseudolocalize:assets": "betools pseudolocalize --englishDir ./assets/locales/en --out ./lib/cjs/assets/locales/en-PSEUDO",