@itwin/presentation-common 3.5.0-dev.8 → 3.5.1

package/CHANGELOG.md

@@ -1,6 +1,76 @@
 # Change Log - @itwin/presentation-common
 
-This log was last generated on Thu, 01 Sep 2022 14:37:22 GMT and should not be manually modified.
+This log was last generated on Thu, 15 Dec 2022 16:38:29 GMT and should not be manually modified.
+
+## 3.5.1
+Thu, 15 Dec 2022 16:38:29 GMT
+
+_Version update only_
+
+## 3.5.0
+Wed, 07 Dec 2022 19:12:37 GMT
+
+### Updates
+
+- Renamed content descriptor property 'filterExpression' to 'fieldsFilterExpression'
+- Added InstanceFilterDefinition
+- Remove uses of `__dirname`, which is not available in ESM context.
+- Add support for old `KeySetJSON` format which used uncompressed IDs.
+
+## 3.4.7
+Wed, 30 Nov 2022 14:28:19 GMT
+
+_Version update only_
+
+## 3.4.6
+Tue, 22 Nov 2022 14:24:19 GMT
+
+_Version update only_
+
+## 3.4.5
+Thu, 17 Nov 2022 21:32:50 GMT
+
+_Version update only_
+
+## 3.4.4
+Thu, 10 Nov 2022 19:32:17 GMT
+
+_Version update only_
+
+## 3.4.3
+Fri, 28 Oct 2022 13:34:58 GMT
+
+_Version update only_
+
+## 3.4.2
+Mon, 24 Oct 2022 13:23:45 GMT
+
+_Version update only_
+
+## 3.4.1
+Mon, 17 Oct 2022 20:06:51 GMT
+
+_Version update only_
+
+## 3.4.0
+Thu, 13 Oct 2022 20:24:47 GMT
+
+_Version update only_
+
+## 3.3.5
+Tue, 27 Sep 2022 11:50:59 GMT
+
+_Version update only_
+
+## 3.3.4
+Thu, 08 Sep 2022 19:00:05 GMT
+
+_Version update only_
+
+## 3.3.3
+Tue, 06 Sep 2022 20:54:19 GMT
+
+_Version update only_
 
 ## 3.3.2
 Thu, 01 Sep 2022 14:37:22 GMT

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

@@ -1,18 +1,18 @@
-{
-  "Categories": {
-    "SourceFileInformation": "Source File Information",
-    "SourceInformation": "Source Information",
-    "SourceInformationModelSource": "Model Source",
-    "SourceInformationSecondarySources": "Secondary Sources"
-  },
-  "Properties": {
-    "SourceElementId": "Source Element ID",
-    "SourceFileName": "Source File Name",
-    "SourceFilePath": "Source File Path",
-    "SourceInformation": {
-      "ElementId": "Element ID",
-      "Name": "Name",
-      "Path": "Path"
-    }
-  }
-}
+{
+  "Categories": {
+    "SourceFileInformation": "Source File Information",
+    "SourceInformation": "Source Information",
+    "SourceInformationModelSource": "Model Source",
+    "SourceInformationSecondarySources": "Secondary Sources"
+  },
+  "Properties": {
+    "SourceElementId": "Source Element ID",
+    "SourceFileName": "Source File Name",
+    "SourceFilePath": "Source File Path",
+    "SourceInformation": {
+      "ElementId": "Element ID",
+      "Name": "Name",
+      "Path": "Path"
+    }
+  }
+}

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

@@ -1,9 +1,9 @@
-{
-  "LABEL_General_DisplayLabel": "Label",
-  "LABEL_Category_General": "General",
-  "LABEL_Category_Favorite": "Favorite",
-  "FIELD_LABEL_DisplayLabel": "Label",
-  "CATEGORY_LABEL_SelectedItems": "Selected Item(s)",
-  "CATEGORY_DESCRIPTION_SelectedItems": "Contains properties of selected item(s)",
-  "ERROR_General_Unknown": "Unknown error"
-}
+{
+  "LABEL_General_DisplayLabel": "Label",
+  "LABEL_Category_General": "General",
+  "LABEL_Category_Favorite": "Favorite",
+  "FIELD_LABEL_DisplayLabel": "Label",
+  "CATEGORY_LABEL_SelectedItems": "Selected Item(s)",
+  "CATEGORY_DESCRIPTION_SelectedItems": "Contains properties of selected item(s)",
+  "ERROR_General_Unknown": "Unknown error"
+}

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

@@ -1,6 +1,6 @@
-{
-  "LABEL_General_NotSpecified": "Not specified",
-  "LABEL_General_Other": "Other",
-  "LABEL_General_Varies": "Varies",
-  "LABEL_General_MultipleInstances": "Multiple items"
+{
+  "LABEL_General_NotSpecified": "Not specified",
+  "LABEL_General_Other": "Other",
+  "LABEL_General_Varies": "Varies",
+  "LABEL_General_MultipleInstances": "Multiple items"
 }

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"]}

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

@@ -1,126 +1,126 @@
-/** @packageDocumentation
- * @module Core
- */
-/**
- * Type of diagnostics logger severity.
- * @beta
- */
-export declare type DiagnosticsLoggerSeverity = "error" | "warning" | "info" | "debug" | "trace";
-/**
- * Returns lower severity of the given two. Examples:
- * ```
- * combineDiagnosticsSeverities("error", "error") === "error"
- * combineDiagnosticsSeverities("error", "debug") === "debug"
- * combineDiagnosticsSeverities("debug", "error") === "debug"
- * ```
- * @internal
- */
-export declare function combineDiagnosticsSeverities(lhs: undefined | boolean | DiagnosticsLoggerSeverity, rhs: undefined | boolean | DiagnosticsLoggerSeverity): DiagnosticsLoggerSeverity | undefined;
-/**
- * Returns 0 if the given severities are equal after normalization, negative if `lhs` is lower, positive if higher. Examples:
- * ```
- * compareDiagnosticsSeverities("error", "error") === 0
- * compareDiagnosticsSeverities("error", false) === 0
- * compareDiagnosticsSeverities("error", undefined) === 0
- * compareDiagnosticsSeverities("debug", true) === 0
- * compareDiagnosticsSeverities("debug", "error") < 0
- * compareDiagnosticsSeverities("error", "debug") > 0
- * ```
- * @internal
- */
-export declare function compareDiagnosticsSeverities(lhs: undefined | boolean | DiagnosticsLoggerSeverity, rhs: undefined | boolean | DiagnosticsLoggerSeverity): 0 | 1 | -1;
-/**
- * Data structure for diagnostics information.
- * @beta
- */
-export interface Diagnostics {
-    logs?: DiagnosticsScopeLogs[];
-}
-/**
- * Data structure with client diagnostics information.
- * @beta
- */
-export interface ClientDiagnostics extends Diagnostics {
-    backendVersion?: string;
-}
-/**
- * Data structure for diagnostics options.
- * @beta
- */
-export interface DiagnosticsOptions {
-    /**
-     * Flag specifying that performance should be measured, or
-     * minimum duration in milliseconds for which performance metric should be included.
-     */
-    perf?: boolean | {
-        minimumDuration: number;
-    };
-    /** Severity for developer log messages */
-    dev?: boolean | DiagnosticsLoggerSeverity;
-    /** Severity for presentation rules' editor log messages */
-    editor?: boolean | DiagnosticsLoggerSeverity;
-}
-/**
- * A function that can be called after receiving diagnostics.
- * @beta
- */
-export declare type ClientDiagnosticsHandler = (logs: ClientDiagnostics) => void;
-/**
- * Data structure for client diagnostics options.
- * @beta
- */
-export interface ClientDiagnosticsOptions extends DiagnosticsOptions {
-    backendVersion?: boolean;
-    handler: ClientDiagnosticsHandler;
-}
-/**
- * Data structure which contains client diagnostics options.
- * @public
- */
-export interface ClientDiagnosticsAttribute {
-    /**
-     * Diagnostics options.
-     * @beta
-     */
-    diagnostics?: ClientDiagnosticsOptions;
-}
-/**
- * Data structure for diagnostics log message information.
- * @beta
- */
-export interface DiagnosticsLogMessage {
-    severity: {
-        dev?: DiagnosticsLoggerSeverity;
-        editor?: DiagnosticsLoggerSeverity;
-    };
-    category: string;
-    message: string;
-    timestamp: number;
-}
-/**
- * Data structure for diagnostics scope information.
- * @beta
- */
-export interface DiagnosticsScopeLogs {
-    scope: string;
-    scopeCreateTimestamp?: number;
-    duration?: number;
-    logs?: DiagnosticsLogEntry[];
-    attributes?: {
-        [attributeKey: string]: string | string[];
-    };
-}
-/**
- * Data structure for diagnostics log entry.
- * @beta
- */
-export declare type DiagnosticsLogEntry = DiagnosticsLogMessage | DiagnosticsScopeLogs;
-/**
- * Functions related to diagnostics log entry.
- * @beta
- */
-export declare namespace DiagnosticsLogEntry {
-    function isMessage(entry: DiagnosticsLogEntry): entry is DiagnosticsLogMessage;
-    function isScope(entry: DiagnosticsLogEntry): entry is DiagnosticsScopeLogs;
-}
+/** @packageDocumentation
+ * @module Core
+ */
+/**
+ * Type of diagnostics logger severity.
+ * @beta
+ */
+export declare type DiagnosticsLoggerSeverity = "error" | "warning" | "info" | "debug" | "trace";
+/**
+ * Returns lower severity of the given two. Examples:
+ * ```
+ * combineDiagnosticsSeverities("error", "error") === "error"
+ * combineDiagnosticsSeverities("error", "debug") === "debug"
+ * combineDiagnosticsSeverities("debug", "error") === "debug"
+ * ```
+ * @internal
+ */
+export declare function combineDiagnosticsSeverities(lhs: undefined | boolean | DiagnosticsLoggerSeverity, rhs: undefined | boolean | DiagnosticsLoggerSeverity): DiagnosticsLoggerSeverity | undefined;
+/**
+ * Returns 0 if the given severities are equal after normalization, negative if `lhs` is lower, positive if higher. Examples:
+ * ```
+ * compareDiagnosticsSeverities("error", "error") === 0
+ * compareDiagnosticsSeverities("error", false) === 0
+ * compareDiagnosticsSeverities("error", undefined) === 0
+ * compareDiagnosticsSeverities("debug", true) === 0
+ * compareDiagnosticsSeverities("debug", "error") < 0
+ * compareDiagnosticsSeverities("error", "debug") > 0
+ * ```
+ * @internal
+ */
+export declare function compareDiagnosticsSeverities(lhs: undefined | boolean | DiagnosticsLoggerSeverity, rhs: undefined | boolean | DiagnosticsLoggerSeverity): 0 | 1 | -1;
+/**
+ * Data structure for diagnostics information.
+ * @beta
+ */
+export interface Diagnostics {
+    logs?: DiagnosticsScopeLogs[];
+}
+/**
+ * Data structure with client diagnostics information.
+ * @beta
+ */
+export interface ClientDiagnostics extends Diagnostics {
+    backendVersion?: string;
+}
+/**
+ * Data structure for diagnostics options.
+ * @beta
+ */
+export interface DiagnosticsOptions {
+    /**
+     * Flag specifying that performance should be measured, or
+     * minimum duration in milliseconds for which performance metric should be included.
+     */
+    perf?: boolean | {
+        minimumDuration: number;
+    };
+    /** Severity for developer log messages */
+    dev?: boolean | DiagnosticsLoggerSeverity;
+    /** Severity for presentation rules' editor log messages */
+    editor?: boolean | DiagnosticsLoggerSeverity;
+}
+/**
+ * A function that can be called after receiving diagnostics.
+ * @beta
+ */
+export declare type ClientDiagnosticsHandler = (logs: ClientDiagnostics) => void;
+/**
+ * Data structure for client diagnostics options.
+ * @beta
+ */
+export interface ClientDiagnosticsOptions extends DiagnosticsOptions {
+    backendVersion?: boolean;
+    handler: ClientDiagnosticsHandler;
+}
+/**
+ * Data structure which contains client diagnostics options.
+ * @public
+ */
+export interface ClientDiagnosticsAttribute {
+    /**
+     * Diagnostics options.
+     * @beta
+     */
+    diagnostics?: ClientDiagnosticsOptions;
+}
+/**
+ * Data structure for diagnostics log message information.
+ * @beta
+ */
+export interface DiagnosticsLogMessage {
+    severity: {
+        dev?: DiagnosticsLoggerSeverity;
+        editor?: DiagnosticsLoggerSeverity;
+    };
+    category: string;
+    message: string;
+    timestamp: number;
+}
+/**
+ * Data structure for diagnostics scope information.
+ * @beta
+ */
+export interface DiagnosticsScopeLogs {
+    scope: string;
+    scopeCreateTimestamp?: number;
+    duration?: number;
+    logs?: DiagnosticsLogEntry[];
+    attributes?: {
+        [attributeKey: string]: string | string[];
+    };
+}
+/**
+ * Data structure for diagnostics log entry.
+ * @beta
+ */
+export declare type DiagnosticsLogEntry = DiagnosticsLogMessage | DiagnosticsScopeLogs;
+/**
+ * Functions related to diagnostics log entry.
+ * @beta
+ */
+export declare namespace DiagnosticsLogEntry {
+    function isMessage(entry: DiagnosticsLogEntry): entry is DiagnosticsLogMessage;
+    function isScope(entry: DiagnosticsLogEntry): entry is DiagnosticsScopeLogs;
+}
 //# sourceMappingURL=Diagnostics.d.ts.map