@itwin/presentation-common 4.0.0-dev.10 → 4.0.0-dev.101

package/CHANGELOG.md

@@ -1,6 +1,66 @@
 # Change Log - @itwin/presentation-common
 
-This log was last generated on Thu, 26 Jan 2023 22:53:28 GMT and should not be manually modified.
+This log was last generated on Tue, 25 Apr 2023 17:50:35 GMT and should not be manually modified.
+
+## 3.7.4
+Tue, 25 Apr 2023 17:50:35 GMT
+
+_Version update only_
+
+## 3.7.3
+Thu, 20 Apr 2023 13:19:29 GMT
+
+_Version update only_
+
+## 3.7.2
+Wed, 12 Apr 2023 13:12:42 GMT
+
+_Version update only_
+
+## 3.7.1
+Mon, 03 Apr 2023 15:15:37 GMT
+
+_Version update only_
+
+## 3.7.0
+Wed, 29 Mar 2023 15:02:27 GMT
+
+### Updates
+
+- Fix `@deprecated` messages
+
+## 3.6.3
+Mon, 27 Mar 2023 16:26:47 GMT
+
+_Version update only_
+
+## 3.6.2
+Fri, 17 Mar 2023 17:52:32 GMT
+
+_Version update only_
+
+## 3.6.1
+Fri, 24 Feb 2023 22:00:48 GMT
+
+_Version update only_
+
+## 3.6.0
+Wed, 08 Feb 2023 14:58:40 GMT
+
+### Updates
+
+- API promotions
+- Deprecate a number of `{api_name}JSON` interfaces in favor of sibling `{api_name}` interface
+- Take `InstanceFilterDefinition` instead of pure string ECExpression for hierarchy level filter
+- Allow specifying enum values in presentation rules as strings
+- Add APIs to get hierarchy level descriptor
+- Introduce unfilterable nodes and hierarchy levels
+- React to RPC deprecations.
+
+## 3.5.6
+Fri, 24 Feb 2023 16:02:47 GMT
+
+_Version update only_
 
 ## 3.5.5
 Thu, 26 Jan 2023 22:53:28 GMT

package/Ruleset.schema.json

@@ -27,6 +27,7 @@
     },
     "CheckBoxRule": {
       "additionalProperties": false,
+      "deprecated": "in 3.x. Use `ExtendedDataRule` instead. See extended data usage page for more details.",
       "description": "CheckBox rules provide a way to create a checkbox for specific types of ECInstance's.",
       "properties": {
         "condition": {
@@ -224,6 +225,7 @@
           "description": "Defines a set of multi schema classes that prevents specified\nECClasses and subclasses from being selected by `classes` attribute."
         },
         "handleInstancesPolymorphically": {
+          "deprecated": "in 2.x. Specify polymorphism value inside `classes.arePolymorphic` or `excludedClasses.arePolymorphic`.",
           "description": "Tells whether selecting instances from ECClasses specified in `classes` and `excludedClasses`\nattributes should be polymorphic or not.",
           "type": "boolean"
         },
@@ -272,6 +274,7 @@
           "type": "array"
         },
         "showImages": {
+          "deprecated": "in 3.x. Use `ExtendedDataRule` instead. See extended data usage page for more details.",
           "description": "Should image IDs be calculated for the returned instances. When `true`, `ImageIdOverride` rules get applied when\ncreating the content.",
           "type": "boolean"
         },
@@ -293,6 +296,10 @@
       "additionalProperties": false,
       "description": "Content modifiers are used to modify how instances of specified ECClasses are displayed in content which is\nproduced using content rules. They do not produce any content\nby themselves.",
       "properties": {
+        "applyOnNestedContent": {
+          "description": "Specifies whether `calculatedProperties` and\n`relatedProperties` specifications should also be applied on\nnested content.",
+          "type": "boolean"
+        },
         "calculatedProperties": {
           "description": "Specifications of calculated properties whose values are\ngenerated using provided ECExpressions.",
           "items": {
@@ -412,6 +419,7 @@
           "type": "array"
         },
         "showImages": {
+          "deprecated": "in 3.x. Use `ExtendedDataRule` instead. See extended data usage page for more details.",
           "description": "Should image IDs be calculated for the returned instances. When `true`, `ImageIdOverride` rules get applied when\ncreating the content.",
           "type": "boolean"
         },
@@ -936,6 +944,7 @@
     },
     "ImageIdOverride": {
       "additionalProperties": false,
+      "deprecated": "in 3.x. Use `ExtendedDataRule` instead. See extended data usage page for more details.",
       "description": "ImageId override rules allow setting an image ID to specific types of ECInstances.",
       "properties": {
         "condition": {
@@ -1248,6 +1257,7 @@
       "description": "Returns nodes for instances of specific ECClasses.",
       "properties": {
         "arePolymorphic": {
+          "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.",
           "description": "Tells whether selecting instances from ECClasses specified in `classes` and `excludedClasses`\nattributes should be polymorphic or not.",
           "type": "boolean"
         },
@@ -1354,6 +1364,7 @@
     },
     "LabelOverride": {
       "additionalProperties": false,
+      "deprecated": "in 3.x. Use `InstanceLabelOverride` rule instead.",
       "description": "Label override rules provide advanced ways to override instance labels and descriptions in\nexchange of some performance penalty.",
       "properties": {
         "condition": {
@@ -1713,6 +1724,7 @@
           "type": "boolean"
         },
         "groupingValue": {
+          "deprecated": "in 3.x. Display value should always be used for grouping.",
           "description": "Specifies whether instances should be grouped using property's display or raw value.",
           "enum": [
             "DisplayLabel",
@@ -1738,6 +1750,7 @@
           "type": "array"
         },
         "sortingValue": {
+          "deprecated": "in 3.x. Property grouping nodes should always be sorted by display label.",
           "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.",
           "enum": [
             "DisplayLabel",
@@ -2469,6 +2482,7 @@
           "type": "array"
         },
         "showImages": {
+          "deprecated": "in 3.x. Use `ExtendedDataRule` instead. See extended data usage page for more details.",
           "description": "Should image IDs be calculated for the returned instances. When `true`, `ImageIdOverride` rules get applied when\ncreating the content.",
           "type": "boolean"
         },
@@ -2535,6 +2549,7 @@
     },
     "StyleOverride": {
       "additionalProperties": false,
+      "deprecated": "in 3.x. Use `ExtendedDataRule` instead. See extended data usage page for more details.",
       "description": "Style override rules allow customizing display style of specific types of ECInstances.",
       "properties": {
         "backColor": {

package/lib/cjs/assets/locales/en/Presentation.json

@@ -0,0 +1,19 @@
+{
+  "label": {
+    "notSpecified": "Not specified",
+    "other": "Other",
+    "varies": "Varies",
+    "multipleInstances": "Multiple items"
+  },
+  "field": {
+    "label": "Label"
+  },
+  "selectedItems": {
+    "categoryLabel": "Selected Item(s)",
+    "categoryDescription": "Contains properties of selected item(s)"
+  },
+  "value": {
+    "true": "True",
+    "false": "False"
+  }
+}

package/lib/cjs/assets/locales/en-PSEUDO/Presentation.json

@@ -0,0 +1,19 @@
+{
+  "label": {
+    "notSpecified": "Ñót spêçìfíêd",
+    "other": "Òthér",
+    "varies": "Vàríês",
+    "multipleInstances": "Mµltíplê ïtèms"
+  },
+  "field": {
+    "label": "£ábêl"
+  },
+  "selectedItems": {
+    "categoryLabel": "$élêçtèd Ítêm(s)",
+    "categoryDescription": "Çóñtãìñs pròpërtìés öf sëlèçtêd ïtèm(s)"
+  },
+  "value": {
+    "true": "Trµé",
+    "false": "Fàlsé"
+  }
+}

package/lib/cjs/presentation-common/AsyncTasks.d.ts

@@ -1,23 +1,23 @@
-/** @packageDocumentation
- * @module Core
- */
-import { IDisposable } from "@itwin/core-bentley";
-/**
- * A helper to track ongoing async tasks. Usage:
- * ```
- * await using(tracker.trackAsyncTask(), async (_r) => {
- *   await doSomethingAsync();
- * });
- * ```
- *
- * Can be used with `waitForPendingAsyncs` in test helpers to wait for all
- * async tasks to complete.
- *
- * @internal
- */
-export declare class AsyncTasksTracker {
-    private _asyncsInProgress;
-    get pendingAsyncs(): Set<string>;
-    trackAsyncTask(): IDisposable;
-}
+/** @packageDocumentation
+ * @module Core
+ */
+import { IDisposable } from "@itwin/core-bentley";
+/**
+ * A helper to track ongoing async tasks. Usage:
+ * ```
+ * await using(tracker.trackAsyncTask(), async (_r) => {
+ *   await doSomethingAsync();
+ * });
+ * ```
+ *
+ * Can be used with `waitForPendingAsyncs` in test helpers to wait for all
+ * async tasks to complete.
+ *
+ * @internal
+ */
+export declare class AsyncTasksTracker {
+    private _asyncsInProgress;
+    get pendingAsyncs(): Set<string>;
+    trackAsyncTask(): IDisposable;
+}
 //# sourceMappingURL=AsyncTasks.d.ts.map

package/lib/cjs/presentation-common/AsyncTasks.js

@@ -1,39 +1,39 @@
-"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 Core
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.AsyncTasksTracker = void 0;
-const core_bentley_1 = require("@itwin/core-bentley");
-/**
- * A helper to track ongoing async tasks. Usage:
- * ```
- * await using(tracker.trackAsyncTask(), async (_r) => {
- *   await doSomethingAsync();
- * });
- * ```
- *
- * Can be used with `waitForPendingAsyncs` in test helpers to wait for all
- * async tasks to complete.
- *
- * @internal
- */
-class AsyncTasksTracker {
-    constructor() {
-        this._asyncsInProgress = new Set();
-    }
-    get pendingAsyncs() { return this._asyncsInProgress; }
-    trackAsyncTask() {
-        const id = core_bentley_1.Guid.createValue();
-        this._asyncsInProgress.add(id);
-        return {
-            dispose: () => this._asyncsInProgress.delete(id),
-        };
-    }
-}
-exports.AsyncTasksTracker = AsyncTasksTracker;
+"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 Core
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AsyncTasksTracker = void 0;
+const core_bentley_1 = require("@itwin/core-bentley");
+/**
+ * A helper to track ongoing async tasks. Usage:
+ * ```
+ * await using(tracker.trackAsyncTask(), async (_r) => {
+ *   await doSomethingAsync();
+ * });
+ * ```
+ *
+ * Can be used with `waitForPendingAsyncs` in test helpers to wait for all
+ * async tasks to complete.
+ *
+ * @internal
+ */
+class AsyncTasksTracker {
+    constructor() {
+        this._asyncsInProgress = new Set();
+    }
+    get pendingAsyncs() { return this._asyncsInProgress; }
+    trackAsyncTask() {
+        const id = core_bentley_1.Guid.createValue();
+        this._asyncsInProgress.add(id);
+        return {
+            dispose: () => this._asyncsInProgress.delete(id),
+        };
+    }
+}
+exports.AsyncTasksTracker = AsyncTasksTracker;
 //# sourceMappingURL=AsyncTasks.js.map

package/lib/cjs/presentation-common/AsyncTasks.js.map

@@ -1 +1 @@
-{"version":3,"file":"AsyncTasks.js","sourceRoot":"","sources":["../../../src/presentation-common/AsyncTasks.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,sDAAoE;AAEpE;;;;;;;;;;;;GAYG;AACH,MAAa,iBAAiB;IAA9B;QACU,sBAAiB,GAAG,IAAI,GAAG,EAAc,CAAC;IASpD,CAAC;IARC,IAAW,aAAa,KAAK,OAAO,IAAI,CAAC,iBAAiB,CAAC,CAAC,CAAC;IACtD,cAAc;QACnB,MAAM,EAAE,GAAG,mBAAI,CAAC,WAAW,EAAE,CAAC;QAC9B,IAAI,CAAC,iBAAiB,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;QAC/B,OAAO;YACL,OAAO,EAAE,GAAG,EAAE,CAAC,IAAI,CAAC,iBAAiB,CAAC,MAAM,CAAC,EAAE,CAAC;SACjD,CAAC;IACJ,CAAC;CACF;AAVD,8CAUC","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 Core\r\n */\r\n\r\nimport { Guid, GuidString, IDisposable } from \"@itwin/core-bentley\";\r\n\r\n/**\r\n * A helper to track ongoing async tasks. Usage:\r\n * ```\r\n * await using(tracker.trackAsyncTask(), async (_r) => {\r\n *   await doSomethingAsync();\r\n * });\r\n * ```\r\n *\r\n * Can be used with `waitForPendingAsyncs` in test helpers to wait for all\r\n * async tasks to complete.\r\n *\r\n * @internal\r\n */\r\nexport class AsyncTasksTracker {\r\n  private _asyncsInProgress = new Set<GuidString>();\r\n  public get pendingAsyncs() { return this._asyncsInProgress; }\r\n  public trackAsyncTask(): IDisposable {\r\n    const id = Guid.createValue();\r\n    this._asyncsInProgress.add(id);\r\n    return {\r\n      dispose: () => this._asyncsInProgress.delete(id),\r\n    };\r\n  }\r\n}\r\n"]}
+{"version":3,"file":"AsyncTasks.js","sourceRoot":"","sources":["../../../src/presentation-common/AsyncTasks.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,sDAAoE;AAEpE;;;;;;;;;;;;GAYG;AACH,MAAa,iBAAiB;IAA9B;QACU,sBAAiB,GAAG,IAAI,GAAG,EAAc,CAAC;IASpD,CAAC;IARC,IAAW,aAAa,KAAK,OAAO,IAAI,CAAC,iBAAiB,CAAC,CAAC,CAAC;IACtD,cAAc;QACnB,MAAM,EAAE,GAAG,mBAAI,CAAC,WAAW,EAAE,CAAC;QAC9B,IAAI,CAAC,iBAAiB,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;QAC/B,OAAO;YACL,OAAO,EAAE,GAAG,EAAE,CAAC,IAAI,CAAC,iBAAiB,CAAC,MAAM,CAAC,EAAE,CAAC;SACjD,CAAC;IACJ,CAAC;CACF;AAVD,8CAUC","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 Core\n */\n\nimport { Guid, GuidString, IDisposable } from \"@itwin/core-bentley\";\n\n/**\n * A helper to track ongoing async tasks. Usage:\n * ```\n * await using(tracker.trackAsyncTask(), async (_r) => {\n *   await doSomethingAsync();\n * });\n * ```\n *\n * Can be used with `waitForPendingAsyncs` in test helpers to wait for all\n * async tasks to complete.\n *\n * @internal\n */\nexport class AsyncTasksTracker {\n  private _asyncsInProgress = new Set<GuidString>();\n  public get pendingAsyncs() { return this._asyncsInProgress; }\n  public trackAsyncTask(): IDisposable {\n    const id = Guid.createValue();\n    this._asyncsInProgress.add(id);\n    return {\n      dispose: () => this._asyncsInProgress.delete(id),\n    };\n  }\n}\n"]}

package/lib/cjs/presentation-common/CommonLoggerCategory.d.ts

@@ -1,13 +1,13 @@
-/** @packageDocumentation
- * @module Core
- */
-/**
- * Logger categories used by this package
- * @note All logger categories in this package start with the `presentation-common` prefix.
- * @see [Logger]($bentley)
- * @public
- */
-export declare enum PresentationCommonLoggerCategory {
-    Package = "presentation-common"
-}
+/** @packageDocumentation
+ * @module Core
+ */
+/**
+ * Logger categories used by this package
+ * @note All logger categories in this package start with the `presentation-common` prefix.
+ * @see [Logger]($bentley)
+ * @public
+ */
+export declare enum PresentationCommonLoggerCategory {
+    Package = "presentation-common"
+}
 //# sourceMappingURL=CommonLoggerCategory.d.ts.map

package/lib/cjs/presentation-common/CommonLoggerCategory.js

@@ -1,21 +1,21 @@
-"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 Core
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.PresentationCommonLoggerCategory = void 0;
-/**
- * Logger categories used by this package
- * @note All logger categories in this package start with the `presentation-common` prefix.
- * @see [Logger]($bentley)
- * @public
- */
-var PresentationCommonLoggerCategory;
-(function (PresentationCommonLoggerCategory) {
-    PresentationCommonLoggerCategory["Package"] = "presentation-common";
-})(PresentationCommonLoggerCategory = exports.PresentationCommonLoggerCategory || (exports.PresentationCommonLoggerCategory = {}));
+"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 Core
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PresentationCommonLoggerCategory = void 0;
+/**
+ * Logger categories used by this package
+ * @note All logger categories in this package start with the `presentation-common` prefix.
+ * @see [Logger]($bentley)
+ * @public
+ */
+var PresentationCommonLoggerCategory;
+(function (PresentationCommonLoggerCategory) {
+    PresentationCommonLoggerCategory["Package"] = "presentation-common";
+})(PresentationCommonLoggerCategory = exports.PresentationCommonLoggerCategory || (exports.PresentationCommonLoggerCategory = {}));
 //# sourceMappingURL=CommonLoggerCategory.js.map

package/lib/cjs/presentation-common/CommonLoggerCategory.js.map

@@ -1 +1 @@
-{"version":3,"file":"CommonLoggerCategory.js","sourceRoot":"","sources":["../../../src/presentation-common/CommonLoggerCategory.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH;;;;;GAKG;AACH,IAAY,gCAEX;AAFD,WAAY,gCAAgC;IAC1C,mEAA+B,CAAA;AACjC,CAAC,EAFW,gCAAgC,GAAhC,wCAAgC,KAAhC,wCAAgC,QAE3C","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 Core\r\n */\r\n\r\n/**\r\n * Logger categories used by this package\r\n * @note All logger categories in this package start with the `presentation-common` prefix.\r\n * @see [Logger]($bentley)\r\n * @public\r\n */\r\nexport enum PresentationCommonLoggerCategory {\r\n  Package = \"presentation-common\",\r\n}\r\n"]}
+{"version":3,"file":"CommonLoggerCategory.js","sourceRoot":"","sources":["../../../src/presentation-common/CommonLoggerCategory.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH;;;;;GAKG;AACH,IAAY,gCAEX;AAFD,WAAY,gCAAgC;IAC1C,mEAA+B,CAAA;AACjC,CAAC,EAFW,gCAAgC,GAAhC,wCAAgC,KAAhC,wCAAgC,QAE3C","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 Core\n */\n\n/**\n * Logger categories used by this package\n * @note All logger categories in this package start with the `presentation-common` prefix.\n * @see [Logger]($bentley)\n * @public\n */\nexport enum PresentationCommonLoggerCategory {\n  Package = \"presentation-common\",\n}\n"]}