@itwin/presentation-common 4.0.0-dev.52 → 4.0.0-dev.55

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

@@ -1,105 +1,109 @@
-"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 RPC
- */
-var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
-    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
-    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
-    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
-    return c > 3 && r && Object.defineProperty(target, key, r), r;
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.PresentationIpcEvents = exports.PresentationRpcInterface = void 0;
-const core_common_1 = require("@itwin/core-common");
-const Error_1 = require("./Error");
-/**
- * Interface used for communication between Presentation backend and frontend.
- * @public
- */
-class PresentationRpcInterface extends core_common_1.RpcInterface {
-    /*===========================================================================================
-      NOTE: Any add/remove/change to the methods below requires an update of the interface version.
-      NOTE: Please consult the README in core/common/src/rpc for the semantic versioning rules.
-    ===========================================================================================*/
-    async getNodesCount(_token, _options) { return this.forward(arguments); }
-    async getPagedNodes(_token, _options) { return this.forward(arguments); }
-    /** @beta */
-    async getNodesDescriptor(_token, _options) { return this.forward(arguments); }
-    // TODO: add paged version of this (#387280)
-    async getNodePaths(_token, _options) { return this.forward(arguments); }
-    // TODO: add paged version of this (#387280)
-    async getFilteredNodePaths(_token, _options) { return this.forward(arguments); }
-    async getContentSources(_token, _options) { return this.forward(arguments); }
-    async getContentDescriptor(_token, _options) {
-        arguments[1] = { ...arguments[1], transport: "unparsed-json" };
-        const response = await this.forward(arguments);
-        if (response.statusCode === Error_1.PresentationStatus.Success && typeof response.result === "string") {
-            response.result = JSON.parse(response.result);
-        }
-        return response;
-    }
-    async getContentSetSize(_token, _options) { return this.forward(arguments); }
-    async getPagedContent(_token, _options) { return this.forward(arguments); }
-    async getPagedContentSet(_token, _options) { return this.forward(arguments); }
-    async getElementProperties(_token, _options) { return this.forward(arguments); }
-    async getPagedDistinctValues(_token, _options) { return this.forward(arguments); }
-    async getContentInstanceKeys(_token, _options) { return this.forward(arguments); }
-    async getDisplayLabelDefinition(_token, _options) { return this.forward(arguments); }
-    async getPagedDisplayLabelDefinitions(_token, _options) { return this.forward(arguments); }
-    async getSelectionScopes(_token, _options) { return this.forward(arguments); }
-    async computeSelection(_token, _options, _ids, _scopeId) { return this.forward(arguments); }
-}
-/** The immutable name of the interface. */
-PresentationRpcInterface.interfaceName = "PresentationRpcInterface"; // eslint-disable-line @typescript-eslint/naming-convention
-/** The semantic version of the interface. */
-PresentationRpcInterface.interfaceVersion = "4.0.0";
-__decorate([
-    core_common_1.RpcOperation.setPolicy({ allowResponseCompression: true })
-], PresentationRpcInterface.prototype, "getPagedNodes", null);
-__decorate([
-    core_common_1.RpcOperation.setPolicy({ allowResponseCompression: true })
-], PresentationRpcInterface.prototype, "getNodesDescriptor", null);
-__decorate([
-    core_common_1.RpcOperation.setPolicy({ allowResponseCompression: true })
-], PresentationRpcInterface.prototype, "getNodePaths", null);
-__decorate([
-    core_common_1.RpcOperation.setPolicy({ allowResponseCompression: true })
-], PresentationRpcInterface.prototype, "getFilteredNodePaths", null);
-__decorate([
-    core_common_1.RpcOperation.setPolicy({ allowResponseCompression: true })
-], PresentationRpcInterface.prototype, "getContentSources", null);
-__decorate([
-    core_common_1.RpcOperation.setPolicy({ allowResponseCompression: true })
-], PresentationRpcInterface.prototype, "getContentDescriptor", null);
-__decorate([
-    core_common_1.RpcOperation.setPolicy({ allowResponseCompression: true })
-], PresentationRpcInterface.prototype, "getPagedContent", null);
-__decorate([
-    core_common_1.RpcOperation.setPolicy({ allowResponseCompression: true })
-], PresentationRpcInterface.prototype, "getPagedContentSet", null);
-__decorate([
-    core_common_1.RpcOperation.setPolicy({ allowResponseCompression: true })
-], PresentationRpcInterface.prototype, "getElementProperties", null);
-__decorate([
-    core_common_1.RpcOperation.setPolicy({ allowResponseCompression: true })
-], PresentationRpcInterface.prototype, "getPagedDistinctValues", null);
-__decorate([
-    core_common_1.RpcOperation.setPolicy({ allowResponseCompression: true })
-], PresentationRpcInterface.prototype, "getPagedDisplayLabelDefinitions", null);
-__decorate([
-    core_common_1.RpcOperation.setPolicy({ allowResponseCompression: true })
-], PresentationRpcInterface.prototype, "computeSelection", null);
-exports.PresentationRpcInterface = PresentationRpcInterface;
-/** @internal */
-var PresentationIpcEvents;
-(function (PresentationIpcEvents) {
-    /**
-     * ID of an event that's emitted when backend detects changes in presented data.
-     */
-    PresentationIpcEvents["Update"] = "presentation.onUpdate";
-})(PresentationIpcEvents = exports.PresentationIpcEvents || (exports.PresentationIpcEvents = {}));
+"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 RPC
+ */
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PresentationIpcEvents = exports.PresentationRpcInterface = void 0;
+const core_common_1 = require("@itwin/core-common");
+const Error_1 = require("./Error");
+/**
+ * Interface used for communication between Presentation backend and frontend.
+ * @public
+ */
+class PresentationRpcInterface extends core_common_1.RpcInterface {
+    /*===========================================================================================
+      NOTE: Any add/remove/change to the methods below requires an update of the interface version.
+      NOTE: Please consult the README in core/common/src/rpc for the semantic versioning rules.
+    ===========================================================================================*/
+    async getNodesCount(_token, _options) { return this.forward(arguments); }
+    async getPagedNodes(_token, _options) { return this.forward(arguments); }
+    /** @beta */
+    async getNodesDescriptor(_token, _options) { return this.forward(arguments); }
+    // TODO: add paged version of this (#387280)
+    async getNodePaths(_token, _options) { return this.forward(arguments); }
+    // TODO: add paged version of this (#387280)
+    async getFilteredNodePaths(_token, _options) { return this.forward(arguments); }
+    async getContentSources(_token, _options) { return this.forward(arguments); }
+    async getContentDescriptor(_token, _options) {
+        arguments[1] = { ...arguments[1], transport: "unparsed-json" };
+        const response = await this.forward(arguments);
+        if (response.statusCode === Error_1.PresentationStatus.Success && typeof response.result === "string") {
+            response.result = JSON.parse(response.result);
+        }
+        return response;
+    }
+    async getContentSetSize(_token, _options) { return this.forward(arguments); }
+    async getPagedContent(_token, _options) { return this.forward(arguments); }
+    async getPagedContentSet(_token, _options) { return this.forward(arguments); }
+    async getElementProperties(_token, _options) { return this.forward(arguments); }
+    async getPagedDistinctValues(_token, _options) { return this.forward(arguments); }
+    async getContentInstanceKeys(_token, _options) { return this.forward(arguments); }
+    async getDisplayLabelDefinition(_token, _options) { return this.forward(arguments); }
+    async getPagedDisplayLabelDefinitions(_token, _options) { return this.forward(arguments); }
+    async getSelectionScopes(_token, _options) { return this.forward(arguments); }
+    async computeSelection(_token, _options, _ids, _scopeId) { return this.forward(arguments); }
+}
+/** The immutable name of the interface. */
+PresentationRpcInterface.interfaceName = "PresentationRpcInterface"; // eslint-disable-line @typescript-eslint/naming-convention
+/** The semantic version of the interface. */
+PresentationRpcInterface.interfaceVersion = "4.0.0";
+__decorate([
+    core_common_1.RpcOperation.setPolicy({ allowResponseCompression: true })
+    // eslint-disable-next-line deprecation/deprecation
+], PresentationRpcInterface.prototype, "getPagedNodes", null);
+__decorate([
+    core_common_1.RpcOperation.setPolicy({ allowResponseCompression: true })
+], PresentationRpcInterface.prototype, "getNodesDescriptor", null);
+__decorate([
+    core_common_1.RpcOperation.setPolicy({ allowResponseCompression: true })
+    // eslint-disable-next-line deprecation/deprecation
+], PresentationRpcInterface.prototype, "getNodePaths", null);
+__decorate([
+    core_common_1.RpcOperation.setPolicy({ allowResponseCompression: true })
+    // eslint-disable-next-line deprecation/deprecation
+], PresentationRpcInterface.prototype, "getFilteredNodePaths", null);
+__decorate([
+    core_common_1.RpcOperation.setPolicy({ allowResponseCompression: true })
+], PresentationRpcInterface.prototype, "getContentSources", null);
+__decorate([
+    core_common_1.RpcOperation.setPolicy({ allowResponseCompression: true })
+], PresentationRpcInterface.prototype, "getContentDescriptor", null);
+__decorate([
+    core_common_1.RpcOperation.setPolicy({ allowResponseCompression: true })
+], PresentationRpcInterface.prototype, "getPagedContent", null);
+__decorate([
+    core_common_1.RpcOperation.setPolicy({ allowResponseCompression: true })
+], PresentationRpcInterface.prototype, "getPagedContentSet", null);
+__decorate([
+    core_common_1.RpcOperation.setPolicy({ allowResponseCompression: true })
+], PresentationRpcInterface.prototype, "getElementProperties", null);
+__decorate([
+    core_common_1.RpcOperation.setPolicy({ allowResponseCompression: true })
+    // eslint-disable-next-line deprecation/deprecation
+], PresentationRpcInterface.prototype, "getPagedDistinctValues", null);
+__decorate([
+    core_common_1.RpcOperation.setPolicy({ allowResponseCompression: true })
+], PresentationRpcInterface.prototype, "getPagedDisplayLabelDefinitions", null);
+__decorate([
+    core_common_1.RpcOperation.setPolicy({ allowResponseCompression: true })
+], PresentationRpcInterface.prototype, "computeSelection", null);
+exports.PresentationRpcInterface = PresentationRpcInterface;
+/** @internal */
+var PresentationIpcEvents;
+(function (PresentationIpcEvents) {
+    /**
+     * ID of an event that's emitted when backend detects changes in presented data.
+     */
+    PresentationIpcEvents["Update"] = "presentation.onUpdate";
+})(PresentationIpcEvents = exports.PresentationIpcEvents || (exports.PresentationIpcEvents = {}));
 //# sourceMappingURL=PresentationRpcInterface.js.map

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

@@ -1 +1 @@
-{"version":3,"file":"PresentationRpcInterface.js","sourceRoot":"","sources":["../../../src/presentation-common/PresentationRpcInterface.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;;;;;;;AAGH,oDAAgF;AAOhF,mCAA6C;AA0J7C;;;GAGG;AACH,MAAa,wBAAyB,SAAQ,0BAAY;IAOxD;;;iGAG6F;IAEtF,KAAK,CAAC,aAAa,CAAC,MAAsB,EAAE,QAAoC,IAAqC,OAAO,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC;IAItJ,KAAK,CAAC,aAAa,CAAC,MAAsB,EAAE,QAA2C,IAAsD,OAAO,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC;IAErL,YAAY;IAEL,KAAK,CAAC,kBAAkB,CAAC,MAAsB,EAAE,QAAmD,IAAkE,OAAO,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC;IAE9M,4CAA4C;IAGrC,KAAK,CAAC,YAAY,CAAC,MAAsB,EAAE,QAAyD,IAAoD,OAAO,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC;IAEhM,4CAA4C;IAGrC,KAAK,CAAC,oBAAoB,CAAC,MAAsB,EAAE,QAAgD,IAAoD,OAAO,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC;IAGxL,KAAK,CAAC,iBAAiB,CAAC,MAAsB,EAAE,QAAyC,IAAsD,OAAO,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC;IAGhL,KAAK,CAAC,oBAAoB,CAAC,MAAsB,EAAE,QAA4C;QACpG,SAAS,CAAC,CAAC,CAAC,GAAG,EAAE,GAAG,SAAS,CAAC,CAAC,CAAC,EAAE,SAAS,EAAE,eAAe,EAAE,CAAC;QAC/D,MAAM,QAAQ,GAAqE,MAAM,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;QACjH,IAAI,QAAQ,CAAC,UAAU,KAAK,0BAAkB,CAAC,OAAO,IAAI,OAAO,QAAQ,CAAC,MAAM,KAAK,QAAQ,EAAE;YAC7F,QAAQ,CAAC,MAAM,GAAG,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;SAC/C;QACD,OAAO,QAAmE,CAAC;IAC7E,CAAC;IAEM,KAAK,CAAC,iBAAiB,CAAC,MAAsB,EAAE,QAAkC,IAAqC,OAAO,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC;IAGxJ,KAAK,CAAC,eAAe,CAAC,MAAsB,EAAE,QAAyC,IAA8G,OAAO,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC;IAGtO,KAAK,CAAC,kBAAkB,CAAC,MAAsB,EAAE,QAAyC,IAAsD,OAAO,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC;IAGjL,KAAK,CAAC,oBAAoB,CAAC,MAAsB,EAAE,QAAkD,IAA4D,OAAO,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC;IAIlM,KAAK,CAAC,sBAAsB,CAAC,MAAsB,EAAE,QAAyC,IAAmE,OAAO,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC;IAElM,KAAK,CAAC,sBAAsB,CAAC,MAAsB,EAAE,QAA8C,IAAmE,OAAO,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC;IAEvM,KAAK,CAAC,yBAAyB,CAAC,MAAsB,EAAE,QAAuC,IAA8C,OAAO,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC;IAG9K,KAAK,CAAC,+BAA+B,CAAC,MAAsB,EAAE,QAAwC,IAA6D,OAAO,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC;IAEpM,KAAK,CAAC,kBAAkB,CAAC,MAAsB,EAAE,QAAyC,IAA+C,OAAO,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC;IAM1K,KAAK,CAAC,gBAAgB,CAAC,MAAsB,EAAE,QAA6E,EAAE,IAAmB,EAAE,QAAiB,IAAyC,OAAO,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC;;AAxErP,2CAA2C;AACpB,sCAAa,GAAG,0BAA0B,CAAC,CAAC,2DAA2D;AAE9H,6CAA6C;AAC/B,yCAAgB,GAAG,OAAO,CAAC;AAWzC;IAFC,0BAAY,CAAC,SAAS,CAAC,EAAE,wBAAwB,EAAE,IAAI,EAAE,CAAC;6DAE0H;AAIrL;IADC,0BAAY,CAAC,SAAS,CAAC,EAAE,wBAAwB,EAAE,IAAI,EAAE,CAAC;kEACmJ;AAK9M;IAFC,0BAAY,CAAC,SAAS,CAAC,EAAE,wBAAwB,EAAE,IAAI,EAAE,CAAC;4DAEqI;AAKhM;IAFC,0BAAY,CAAC,SAAS,CAAC,EAAE,wBAAwB,EAAE,IAAI,EAAE,CAAC;oEAEoI;AAG/L;IADC,0BAAY,CAAC,SAAS,CAAC,EAAE,wBAAwB,EAAE,IAAI,EAAE,CAAC;iEAC4H;AAGvL;IADC,0BAAY,CAAC,SAAS,CAAC,EAAE,wBAAwB,EAAE,IAAI,EAAE,CAAC;oEAQ1D;AAKD;IADC,0BAAY,CAAC,SAAS,CAAC,EAAE,wBAAwB,EAAE,IAAI,EAAE,CAAC;+DACkL;AAG7O;IADC,0BAAY,CAAC,SAAS,CAAC,EAAE,wBAAwB,EAAE,IAAI,EAAE,CAAC;kEAC6H;AAGxL;IADC,0BAAY,CAAC,SAAS,CAAC,EAAE,wBAAwB,EAAE,IAAI,EAAE,CAAC;oEAC8I;AAIzM;IAFC,0BAAY,CAAC,SAAS,CAAC,EAAE,wBAAwB,EAAE,IAAI,EAAE,CAAC;sEAE8I;AAOzM;IADC,0BAAY,CAAC,SAAS,CAAC,EAAE,wBAAwB,EAAE,IAAI,EAAE,CAAC;+EACgJ;AAQ3M;IADC,0BAAY,CAAC,SAAS,CAAC,EAAE,wBAAwB,EAAE,IAAI,EAAE,CAAC;gEAC0L;AAzEvP,4DA0EC;AAED,gBAAgB;AAChB,IAAY,qBAKX;AALD,WAAY,qBAAqB;IAC/B;;OAEG;IACH,yDAAgC,CAAA;AAClC,CAAC,EALW,qBAAqB,GAArB,6BAAqB,KAArB,6BAAqB,QAKhC","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 RPC\r\n */\r\n\r\nimport { Id64String } from \"@itwin/core-bentley\";\r\nimport { IModelRpcProps, RpcInterface, RpcOperation } from \"@itwin/core-common\";\r\nimport { DescriptorJSON, DescriptorOverrides, SelectClassInfoJSON } from \"./content/Descriptor\";\r\nimport { ItemJSON } from \"./content/Item\";\r\nimport { DisplayValueGroupJSON } from \"./content/Value\";\r\nimport { ClientDiagnostics, ClientDiagnosticsOptions } from \"./Diagnostics\";\r\nimport { CompressedClassInfoJSON, InstanceKey } from \"./EC\";\r\nimport { ElementProperties } from \"./ElementProperties\";\r\nimport { PresentationStatus } from \"./Error\";\r\nimport { NodeKey } from \"./hierarchy/Key\";\r\nimport { NodeJSON } from \"./hierarchy/Node\";\r\nimport { NodePathElementJSON } from \"./hierarchy/NodePathElement\";\r\nimport { KeySetJSON } from \"./KeySet\";\r\nimport { LabelDefinition } from \"./LabelDefinition\";\r\nimport {\r\n  ComputeSelectionRequestOptions, ContentDescriptorRequestOptions, ContentInstanceKeysRequestOptions, ContentRequestOptions,\r\n  ContentSourcesRequestOptions, DisplayLabelRequestOptions, DisplayLabelsRequestOptions, DistinctValuesRequestOptions,\r\n  FilterByInstancePathsHierarchyRequestOptions, FilterByTextHierarchyRequestOptions, HierarchyLevelDescriptorRequestOptions, HierarchyRequestOptions,\r\n  Paged, SelectionScopeRequestOptions, SingleElementPropertiesRequestOptions,\r\n} from \"./PresentationManagerOptions\";\r\nimport { RulesetVariableJSON } from \"./RulesetVariables\";\r\nimport { SelectionScope } from \"./selection/SelectionScope\";\r\nimport { Omit, PagedResponse } from \"./Utils\";\r\n\r\n/**\r\n * Base options for all presentation RPC requests.\r\n * @public\r\n */\r\nexport type PresentationRpcRequestOptions<TManagerRequestOptions> = Omit<TManagerRequestOptions, \"imodel\" | \"diagnostics\"> & {\r\n  /** @internal ID of the client requesting data */\r\n  clientId?: string;\r\n  /**\r\n   * RPC request diagnostics options.\r\n   * @beta\r\n   */\r\n  diagnostics?: RpcDiagnosticsOptions;\r\n};\r\n\r\n/**\r\n * Data structure for presentation RPC responses\r\n * @public\r\n */\r\nexport interface PresentationRpcResponseData<TResult = undefined> {\r\n  /** Response status code */\r\n  statusCode: PresentationStatus;\r\n  /** In case of an error response, the error message */\r\n  errorMessage?: string;\r\n  /** In case of a success response, the result */\r\n  result?: TResult;\r\n  /**\r\n   * Diagnostics response.\r\n   * @beta\r\n   */\r\n  diagnostics?: ClientDiagnostics;\r\n}\r\n\r\n/**\r\n * Data structure for RPC diagnostics options.\r\n * @beta\r\n */\r\nexport type RpcDiagnosticsOptions = Omit<ClientDiagnosticsOptions, \"handler\">;\r\n\r\n/**\r\n * A promise of [[PresentationRpcResponseData]].\r\n * @public\r\n */\r\nexport type PresentationRpcResponse<TResult = undefined> = Promise<PresentationRpcResponseData<TResult>>;\r\n\r\n/**\r\n * Data structure for hierarchy request options.\r\n * @public\r\n */\r\nexport type HierarchyRpcRequestOptions = PresentationRpcRequestOptions<HierarchyRequestOptions<never, NodeKey, RulesetVariableJSON>>;\r\n\r\n/**\r\n * Data structure for hierarchy level descriptor RPC request options.\r\n * @beta\r\n */\r\nexport type HierarchyLevelDescriptorRpcRequestOptions = PresentationRpcRequestOptions<HierarchyLevelDescriptorRequestOptions<never, NodeKey, RulesetVariableJSON>>;\r\n\r\n/**\r\n * Data structure for filtering hierarchy by ECInstance paths request options.\r\n * @public\r\n */\r\nexport type FilterByInstancePathsHierarchyRpcRequestOptions = PresentationRpcRequestOptions<FilterByInstancePathsHierarchyRequestOptions<never, RulesetVariableJSON>>;\r\n\r\n/**\r\n * Data structure for filtering hierarchy by text request options.\r\n * @public\r\n */\r\nexport type FilterByTextHierarchyRpcRequestOptions = PresentationRpcRequestOptions<FilterByTextHierarchyRequestOptions<never, RulesetVariableJSON>>;\r\n\r\n/**\r\n * Data structure for content sources RPC request options.\r\n * @public\r\n */\r\nexport type ContentSourcesRpcRequestOptions = PresentationRpcRequestOptions<ContentSourcesRequestOptions<never>>;\r\n/**\r\n * Data structure for content sources RPC response.\r\n * @public\r\n */\r\nexport interface ContentSourcesRpcResult {\r\n  /** A list of objects containing content source information. */\r\n  sources: SelectClassInfoJSON<Id64String>[];\r\n  /** An `ECClassId` => [[CompressedClassInfoJSON]] map for deserializing [[sources]]. */\r\n  classesMap: { [id: string]: CompressedClassInfoJSON };\r\n}\r\n\r\n/**\r\n * Data structure for content descriptor RPC request options.\r\n * @public\r\n */\r\nexport type ContentDescriptorRpcRequestOptions = PresentationRpcRequestOptions<ContentDescriptorRequestOptions<never, KeySetJSON, RulesetVariableJSON>>;\r\n\r\n/**\r\n * Data structure for content RPC request options.\r\n * @public\r\n */\r\nexport type ContentRpcRequestOptions = PresentationRpcRequestOptions<ContentRequestOptions<never, DescriptorOverrides, KeySetJSON, RulesetVariableJSON>>;\r\n\r\n/**\r\n * Data structure for single element properties RPC request options.\r\n * @public\r\n */\r\nexport type SingleElementPropertiesRpcRequestOptions = PresentationRpcRequestOptions<SingleElementPropertiesRequestOptions<never>>;\r\n\r\n/**\r\n * Data structure for distinct values' request options.\r\n * @public\r\n */\r\nexport type DistinctValuesRpcRequestOptions = PresentationRpcRequestOptions<DistinctValuesRequestOptions<never, DescriptorOverrides, KeySetJSON, RulesetVariableJSON>>;\r\n\r\n/**\r\n * Data structure for content instance keys' request options.\r\n * @public\r\n */\r\nexport type ContentInstanceKeysRpcRequestOptions = PresentationRpcRequestOptions<ContentInstanceKeysRequestOptions<never, KeySetJSON, RulesetVariableJSON>>;\r\n\r\n/**\r\n * Data structure for label request options.\r\n * @public\r\n */\r\nexport type DisplayLabelRpcRequestOptions = PresentationRpcRequestOptions<DisplayLabelRequestOptions<never, InstanceKey>>;\r\n\r\n/**\r\n * Data structure for labels request options.\r\n * @public\r\n */\r\nexport type DisplayLabelsRpcRequestOptions = PresentationRpcRequestOptions<DisplayLabelsRequestOptions<never, InstanceKey>>;\r\n\r\n/**\r\n * Data structure for selection scope request options.\r\n * @public\r\n */\r\nexport type SelectionScopeRpcRequestOptions = PresentationRpcRequestOptions<SelectionScopeRequestOptions<never>>;\r\n\r\n/**\r\n * Request options data structure for computing selection based on given selection scope and element IDs.\r\n * @public\r\n */\r\nexport type ComputeSelectionRpcRequestOptions = PresentationRpcRequestOptions<ComputeSelectionRequestOptions<never>>;\r\n\r\n/**\r\n * Interface used for communication between Presentation backend and frontend.\r\n * @public\r\n */\r\nexport class PresentationRpcInterface extends RpcInterface { // eslint-disable-line deprecation/deprecation\r\n  /** The immutable name of the interface. */\r\n  public static readonly interfaceName = \"PresentationRpcInterface\"; // eslint-disable-line @typescript-eslint/naming-convention\r\n\r\n  /** The semantic version of the interface. */\r\n  public static interfaceVersion = \"4.0.0\";\r\n\r\n  /*===========================================================================================\r\n    NOTE: Any add/remove/change to the methods below requires an update of the interface version.\r\n    NOTE: Please consult the README in core/common/src/rpc for the semantic versioning rules.\r\n  ===========================================================================================*/\r\n\r\n  public async getNodesCount(_token: IModelRpcProps, _options: HierarchyRpcRequestOptions): PresentationRpcResponse<number> { return this.forward(arguments); }\r\n\r\n  @RpcOperation.setPolicy({ allowResponseCompression: true })\r\n  // eslint-disable-next-line deprecation/deprecation\r\n  public async getPagedNodes(_token: IModelRpcProps, _options: Paged<HierarchyRpcRequestOptions>): PresentationRpcResponse<PagedResponse<NodeJSON>> { return this.forward(arguments); }\r\n\r\n  /** @beta */\r\n  @RpcOperation.setPolicy({ allowResponseCompression: true })\r\n  public async getNodesDescriptor(_token: IModelRpcProps, _options: HierarchyLevelDescriptorRpcRequestOptions): PresentationRpcResponse<string | DescriptorJSON | undefined> { return this.forward(arguments); }\r\n\r\n  // TODO: add paged version of this (#387280)\r\n  @RpcOperation.setPolicy({ allowResponseCompression: true })\r\n  // eslint-disable-next-line deprecation/deprecation\r\n  public async getNodePaths(_token: IModelRpcProps, _options: FilterByInstancePathsHierarchyRpcRequestOptions): PresentationRpcResponse<NodePathElementJSON[]> { return this.forward(arguments); }\r\n\r\n  // TODO: add paged version of this (#387280)\r\n  @RpcOperation.setPolicy({ allowResponseCompression: true })\r\n  // eslint-disable-next-line deprecation/deprecation\r\n  public async getFilteredNodePaths(_token: IModelRpcProps, _options: FilterByTextHierarchyRpcRequestOptions): PresentationRpcResponse<NodePathElementJSON[]> { return this.forward(arguments); }\r\n\r\n  @RpcOperation.setPolicy({ allowResponseCompression: true })\r\n  public async getContentSources(_token: IModelRpcProps, _options: ContentSourcesRpcRequestOptions): PresentationRpcResponse<ContentSourcesRpcResult> { return this.forward(arguments); }\r\n\r\n  @RpcOperation.setPolicy({ allowResponseCompression: true })\r\n  public async getContentDescriptor(_token: IModelRpcProps, _options: ContentDescriptorRpcRequestOptions): PresentationRpcResponse<DescriptorJSON | undefined> {\r\n    arguments[1] = { ...arguments[1], transport: \"unparsed-json\" };\r\n    const response: PresentationRpcResponseData<DescriptorJSON | string | undefined> = await this.forward(arguments);\r\n    if (response.statusCode === PresentationStatus.Success && typeof response.result === \"string\") {\r\n      response.result = JSON.parse(response.result);\r\n    }\r\n    return response as PresentationRpcResponseData<DescriptorJSON | undefined>;\r\n  }\r\n\r\n  public async getContentSetSize(_token: IModelRpcProps, _options: ContentRpcRequestOptions): PresentationRpcResponse<number> { return this.forward(arguments); }\r\n\r\n  @RpcOperation.setPolicy({ allowResponseCompression: true })\r\n  public async getPagedContent(_token: IModelRpcProps, _options: Paged<ContentRpcRequestOptions>): PresentationRpcResponse<{ descriptor: DescriptorJSON, contentSet: PagedResponse<ItemJSON> } | undefined> { return this.forward(arguments); }\r\n\r\n  @RpcOperation.setPolicy({ allowResponseCompression: true })\r\n  public async getPagedContentSet(_token: IModelRpcProps, _options: Paged<ContentRpcRequestOptions>): PresentationRpcResponse<PagedResponse<ItemJSON>> { return this.forward(arguments); }\r\n\r\n  @RpcOperation.setPolicy({ allowResponseCompression: true })\r\n  public async getElementProperties(_token: IModelRpcProps, _options: SingleElementPropertiesRpcRequestOptions): PresentationRpcResponse<ElementProperties | undefined> { return this.forward(arguments); }\r\n\r\n  @RpcOperation.setPolicy({ allowResponseCompression: true })\r\n  // eslint-disable-next-line deprecation/deprecation\r\n  public async getPagedDistinctValues(_token: IModelRpcProps, _options: DistinctValuesRpcRequestOptions): PresentationRpcResponse<PagedResponse<DisplayValueGroupJSON>> { return this.forward(arguments); }\r\n\r\n  public async getContentInstanceKeys(_token: IModelRpcProps, _options: ContentInstanceKeysRpcRequestOptions): PresentationRpcResponse<{ total: number, items: KeySetJSON }> { return this.forward(arguments); }\r\n\r\n  public async getDisplayLabelDefinition(_token: IModelRpcProps, _options: DisplayLabelRpcRequestOptions): PresentationRpcResponse<LabelDefinition> { return this.forward(arguments); }\r\n\r\n  @RpcOperation.setPolicy({ allowResponseCompression: true })\r\n  public async getPagedDisplayLabelDefinitions(_token: IModelRpcProps, _options: DisplayLabelsRpcRequestOptions): PresentationRpcResponse<PagedResponse<LabelDefinition>> { return this.forward(arguments); }\r\n\r\n  public async getSelectionScopes(_token: IModelRpcProps, _options: SelectionScopeRpcRequestOptions): PresentationRpcResponse<SelectionScope[]> { return this.forward(arguments); }\r\n\r\n  /** @deprecated in 3.x. Use the override with [[ComputeSelectionRpcRequestOptions]]. */\r\n  public async computeSelection(_token: IModelRpcProps, _options: SelectionScopeRpcRequestOptions, _ids: Id64String[], _scopeId: string): PresentationRpcResponse<KeySetJSON>;\r\n  public async computeSelection(_token: IModelRpcProps, _options: ComputeSelectionRpcRequestOptions): PresentationRpcResponse<KeySetJSON>;\r\n  @RpcOperation.setPolicy({ allowResponseCompression: true })\r\n  public async computeSelection(_token: IModelRpcProps, _options: ComputeSelectionRpcRequestOptions | SelectionScopeRpcRequestOptions, _ids?: Id64String[], _scopeId?: string): PresentationRpcResponse<KeySetJSON> { return this.forward(arguments); }\r\n}\r\n\r\n/** @internal */\r\nexport enum PresentationIpcEvents {\r\n  /**\r\n   * ID of an event that's emitted when backend detects changes in presented data.\r\n   */\r\n  Update = \"presentation.onUpdate\",\r\n}\r\n"]}
+{"version":3,"file":"PresentationRpcInterface.js","sourceRoot":"","sources":["../../../src/presentation-common/PresentationRpcInterface.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;;;;;;;AAGH,oDAAgF;AAOhF,mCAA6C;AA0J7C;;;GAGG;AACH,MAAa,wBAAyB,SAAQ,0BAAY;IAOxD;;;iGAG6F;IAEtF,KAAK,CAAC,aAAa,CAAC,MAAsB,EAAE,QAAoC,IAAqC,OAAO,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC;IAIhJ,AAAN,KAAK,CAAC,aAAa,CAAC,MAAsB,EAAE,QAA2C,IAAsD,OAAO,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC;IAErL,YAAY;IAEC,AAAN,KAAK,CAAC,kBAAkB,CAAC,MAAsB,EAAE,QAAmD,IAAkE,OAAO,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC;IAE9M,4CAA4C;IAG/B,AAAN,KAAK,CAAC,YAAY,CAAC,MAAsB,EAAE,QAAyD,IAAoD,OAAO,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC;IAEhM,4CAA4C;IAG/B,AAAN,KAAK,CAAC,oBAAoB,CAAC,MAAsB,EAAE,QAAgD,IAAoD,OAAO,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC;IAGlL,AAAN,KAAK,CAAC,iBAAiB,CAAC,MAAsB,EAAE,QAAyC,IAAsD,OAAO,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC;IAG1K,AAAN,KAAK,CAAC,oBAAoB,CAAC,MAAsB,EAAE,QAA4C;QACpG,SAAS,CAAC,CAAC,CAAC,GAAG,EAAE,GAAG,SAAS,CAAC,CAAC,CAAC,EAAE,SAAS,EAAE,eAAe,EAAE,CAAC;QAC/D,MAAM,QAAQ,GAAqE,MAAM,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;QACjH,IAAI,QAAQ,CAAC,UAAU,KAAK,0BAAkB,CAAC,OAAO,IAAI,OAAO,QAAQ,CAAC,MAAM,KAAK,QAAQ,EAAE;YAC7F,QAAQ,CAAC,MAAM,GAAG,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;SAC/C;QACD,OAAO,QAAmE,CAAC;IAC7E,CAAC;IAEM,KAAK,CAAC,iBAAiB,CAAC,MAAsB,EAAE,QAAkC,IAAqC,OAAO,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC;IAGlJ,AAAN,KAAK,CAAC,eAAe,CAAC,MAAsB,EAAE,QAAyC,IAA8G,OAAO,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC;IAGhO,AAAN,KAAK,CAAC,kBAAkB,CAAC,MAAsB,EAAE,QAAyC,IAAsD,OAAO,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC;IAG3K,AAAN,KAAK,CAAC,oBAAoB,CAAC,MAAsB,EAAE,QAAkD,IAA4D,OAAO,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC;IAI5L,AAAN,KAAK,CAAC,sBAAsB,CAAC,MAAsB,EAAE,QAAyC,IAAmE,OAAO,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC;IAElM,KAAK,CAAC,sBAAsB,CAAC,MAAsB,EAAE,QAA8C,IAAmE,OAAO,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC;IAEvM,KAAK,CAAC,yBAAyB,CAAC,MAAsB,EAAE,QAAuC,IAA8C,OAAO,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC;IAGxK,AAAN,KAAK,CAAC,+BAA+B,CAAC,MAAsB,EAAE,QAAwC,IAA6D,OAAO,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC;IAEpM,KAAK,CAAC,kBAAkB,CAAC,MAAsB,EAAE,QAAyC,IAA+C,OAAO,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC;IAMpK,AAAN,KAAK,CAAC,gBAAgB,CAAC,MAAsB,EAAE,QAA6E,EAAE,IAAmB,EAAE,QAAiB,IAAyC,OAAO,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC;;AAxErP,2CAA2C;AACpB,sCAAa,GAAG,0BAA0B,CAAC,CAAC,2DAA2D;AAE9H,6CAA6C;AAC/B,yCAAgB,GAAG,OAAO,CAAC;AAW5B;IAFZ,0BAAY,CAAC,SAAS,CAAC,EAAE,wBAAwB,EAAE,IAAI,EAAE,CAAC;IAC3D,mDAAmD;6DACkI;AAIxK;IADZ,0BAAY,CAAC,SAAS,CAAC,EAAE,wBAAwB,EAAE,IAAI,EAAE,CAAC;kEACmJ;AAKjM;IAFZ,0BAAY,CAAC,SAAS,CAAC,EAAE,wBAAwB,EAAE,IAAI,EAAE,CAAC;IAC3D,mDAAmD;4DAC6I;AAKnL;IAFZ,0BAAY,CAAC,SAAS,CAAC,EAAE,wBAAwB,EAAE,IAAI,EAAE,CAAC;IAC3D,mDAAmD;oEAC4I;AAGlL;IADZ,0BAAY,CAAC,SAAS,CAAC,EAAE,wBAAwB,EAAE,IAAI,EAAE,CAAC;iEAC4H;AAG1K;IADZ,0BAAY,CAAC,SAAS,CAAC,EAAE,wBAAwB,EAAE,IAAI,EAAE,CAAC;oEAQ1D;AAKY;IADZ,0BAAY,CAAC,SAAS,CAAC,EAAE,wBAAwB,EAAE,IAAI,EAAE,CAAC;+DACkL;AAGhO;IADZ,0BAAY,CAAC,SAAS,CAAC,EAAE,wBAAwB,EAAE,IAAI,EAAE,CAAC;kEAC6H;AAG3K;IADZ,0BAAY,CAAC,SAAS,CAAC,EAAE,wBAAwB,EAAE,IAAI,EAAE,CAAC;oEAC8I;AAI5L;IAFZ,0BAAY,CAAC,SAAS,CAAC,EAAE,wBAAwB,EAAE,IAAI,EAAE,CAAC;IAC3D,mDAAmD;sEACsJ;AAO5L;IADZ,0BAAY,CAAC,SAAS,CAAC,EAAE,wBAAwB,EAAE,IAAI,EAAE,CAAC;+EACgJ;AAQ9L;IADZ,0BAAY,CAAC,SAAS,CAAC,EAAE,wBAAwB,EAAE,IAAI,EAAE,CAAC;gEAC0L;AAzE1O,4DAAwB;AA4ErC,gBAAgB;AAChB,IAAY,qBAKX;AALD,WAAY,qBAAqB;IAC/B;;OAEG;IACH,yDAAgC,CAAA;AAClC,CAAC,EALW,qBAAqB,GAArB,6BAAqB,KAArB,6BAAqB,QAKhC","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 RPC\r\n */\r\n\r\nimport { Id64String } from \"@itwin/core-bentley\";\r\nimport { IModelRpcProps, RpcInterface, RpcOperation } from \"@itwin/core-common\";\r\nimport { DescriptorJSON, DescriptorOverrides, SelectClassInfoJSON } from \"./content/Descriptor\";\r\nimport { ItemJSON } from \"./content/Item\";\r\nimport { DisplayValueGroupJSON } from \"./content/Value\";\r\nimport { ClientDiagnostics, ClientDiagnosticsOptions } from \"./Diagnostics\";\r\nimport { CompressedClassInfoJSON, InstanceKey } from \"./EC\";\r\nimport { ElementProperties } from \"./ElementProperties\";\r\nimport { PresentationStatus } from \"./Error\";\r\nimport { NodeKey } from \"./hierarchy/Key\";\r\nimport { NodeJSON } from \"./hierarchy/Node\";\r\nimport { NodePathElementJSON } from \"./hierarchy/NodePathElement\";\r\nimport { KeySetJSON } from \"./KeySet\";\r\nimport { LabelDefinition } from \"./LabelDefinition\";\r\nimport {\r\n  ComputeSelectionRequestOptions, ContentDescriptorRequestOptions, ContentInstanceKeysRequestOptions, ContentRequestOptions,\r\n  ContentSourcesRequestOptions, DisplayLabelRequestOptions, DisplayLabelsRequestOptions, DistinctValuesRequestOptions,\r\n  FilterByInstancePathsHierarchyRequestOptions, FilterByTextHierarchyRequestOptions, HierarchyLevelDescriptorRequestOptions, HierarchyRequestOptions,\r\n  Paged, SelectionScopeRequestOptions, SingleElementPropertiesRequestOptions,\r\n} from \"./PresentationManagerOptions\";\r\nimport { RulesetVariableJSON } from \"./RulesetVariables\";\r\nimport { SelectionScope } from \"./selection/SelectionScope\";\r\nimport { Omit, PagedResponse } from \"./Utils\";\r\n\r\n/**\r\n * Base options for all presentation RPC requests.\r\n * @public\r\n */\r\nexport type PresentationRpcRequestOptions<TManagerRequestOptions> = Omit<TManagerRequestOptions, \"imodel\" | \"diagnostics\"> & {\r\n  /** @internal ID of the client requesting data */\r\n  clientId?: string;\r\n  /**\r\n   * RPC request diagnostics options.\r\n   * @beta\r\n   */\r\n  diagnostics?: RpcDiagnosticsOptions;\r\n};\r\n\r\n/**\r\n * Data structure for presentation RPC responses\r\n * @public\r\n */\r\nexport interface PresentationRpcResponseData<TResult = undefined> {\r\n  /** Response status code */\r\n  statusCode: PresentationStatus;\r\n  /** In case of an error response, the error message */\r\n  errorMessage?: string;\r\n  /** In case of a success response, the result */\r\n  result?: TResult;\r\n  /**\r\n   * Diagnostics response.\r\n   * @beta\r\n   */\r\n  diagnostics?: ClientDiagnostics;\r\n}\r\n\r\n/**\r\n * Data structure for RPC diagnostics options.\r\n * @beta\r\n */\r\nexport type RpcDiagnosticsOptions = Omit<ClientDiagnosticsOptions, \"handler\">;\r\n\r\n/**\r\n * A promise of [[PresentationRpcResponseData]].\r\n * @public\r\n */\r\nexport type PresentationRpcResponse<TResult = undefined> = Promise<PresentationRpcResponseData<TResult>>;\r\n\r\n/**\r\n * Data structure for hierarchy request options.\r\n * @public\r\n */\r\nexport type HierarchyRpcRequestOptions = PresentationRpcRequestOptions<HierarchyRequestOptions<never, NodeKey, RulesetVariableJSON>>;\r\n\r\n/**\r\n * Data structure for hierarchy level descriptor RPC request options.\r\n * @beta\r\n */\r\nexport type HierarchyLevelDescriptorRpcRequestOptions = PresentationRpcRequestOptions<HierarchyLevelDescriptorRequestOptions<never, NodeKey, RulesetVariableJSON>>;\r\n\r\n/**\r\n * Data structure for filtering hierarchy by ECInstance paths request options.\r\n * @public\r\n */\r\nexport type FilterByInstancePathsHierarchyRpcRequestOptions = PresentationRpcRequestOptions<FilterByInstancePathsHierarchyRequestOptions<never, RulesetVariableJSON>>;\r\n\r\n/**\r\n * Data structure for filtering hierarchy by text request options.\r\n * @public\r\n */\r\nexport type FilterByTextHierarchyRpcRequestOptions = PresentationRpcRequestOptions<FilterByTextHierarchyRequestOptions<never, RulesetVariableJSON>>;\r\n\r\n/**\r\n * Data structure for content sources RPC request options.\r\n * @public\r\n */\r\nexport type ContentSourcesRpcRequestOptions = PresentationRpcRequestOptions<ContentSourcesRequestOptions<never>>;\r\n/**\r\n * Data structure for content sources RPC response.\r\n * @public\r\n */\r\nexport interface ContentSourcesRpcResult {\r\n  /** A list of objects containing content source information. */\r\n  sources: SelectClassInfoJSON<Id64String>[];\r\n  /** An `ECClassId` => [[CompressedClassInfoJSON]] map for deserializing [[sources]]. */\r\n  classesMap: { [id: string]: CompressedClassInfoJSON };\r\n}\r\n\r\n/**\r\n * Data structure for content descriptor RPC request options.\r\n * @public\r\n */\r\nexport type ContentDescriptorRpcRequestOptions = PresentationRpcRequestOptions<ContentDescriptorRequestOptions<never, KeySetJSON, RulesetVariableJSON>>;\r\n\r\n/**\r\n * Data structure for content RPC request options.\r\n * @public\r\n */\r\nexport type ContentRpcRequestOptions = PresentationRpcRequestOptions<ContentRequestOptions<never, DescriptorOverrides, KeySetJSON, RulesetVariableJSON>>;\r\n\r\n/**\r\n * Data structure for single element properties RPC request options.\r\n * @public\r\n */\r\nexport type SingleElementPropertiesRpcRequestOptions = PresentationRpcRequestOptions<SingleElementPropertiesRequestOptions<never>>;\r\n\r\n/**\r\n * Data structure for distinct values' request options.\r\n * @public\r\n */\r\nexport type DistinctValuesRpcRequestOptions = PresentationRpcRequestOptions<DistinctValuesRequestOptions<never, DescriptorOverrides, KeySetJSON, RulesetVariableJSON>>;\r\n\r\n/**\r\n * Data structure for content instance keys' request options.\r\n * @public\r\n */\r\nexport type ContentInstanceKeysRpcRequestOptions = PresentationRpcRequestOptions<ContentInstanceKeysRequestOptions<never, KeySetJSON, RulesetVariableJSON>>;\r\n\r\n/**\r\n * Data structure for label request options.\r\n * @public\r\n */\r\nexport type DisplayLabelRpcRequestOptions = PresentationRpcRequestOptions<DisplayLabelRequestOptions<never, InstanceKey>>;\r\n\r\n/**\r\n * Data structure for labels request options.\r\n * @public\r\n */\r\nexport type DisplayLabelsRpcRequestOptions = PresentationRpcRequestOptions<DisplayLabelsRequestOptions<never, InstanceKey>>;\r\n\r\n/**\r\n * Data structure for selection scope request options.\r\n * @public\r\n */\r\nexport type SelectionScopeRpcRequestOptions = PresentationRpcRequestOptions<SelectionScopeRequestOptions<never>>;\r\n\r\n/**\r\n * Request options data structure for computing selection based on given selection scope and element IDs.\r\n * @public\r\n */\r\nexport type ComputeSelectionRpcRequestOptions = PresentationRpcRequestOptions<ComputeSelectionRequestOptions<never>>;\r\n\r\n/**\r\n * Interface used for communication between Presentation backend and frontend.\r\n * @public\r\n */\r\nexport class PresentationRpcInterface extends RpcInterface { // eslint-disable-line deprecation/deprecation\r\n  /** The immutable name of the interface. */\r\n  public static readonly interfaceName = \"PresentationRpcInterface\"; // eslint-disable-line @typescript-eslint/naming-convention\r\n\r\n  /** The semantic version of the interface. */\r\n  public static interfaceVersion = \"4.0.0\";\r\n\r\n  /*===========================================================================================\r\n    NOTE: Any add/remove/change to the methods below requires an update of the interface version.\r\n    NOTE: Please consult the README in core/common/src/rpc for the semantic versioning rules.\r\n  ===========================================================================================*/\r\n\r\n  public async getNodesCount(_token: IModelRpcProps, _options: HierarchyRpcRequestOptions): PresentationRpcResponse<number> { return this.forward(arguments); }\r\n\r\n  @RpcOperation.setPolicy({ allowResponseCompression: true })\r\n  // eslint-disable-next-line deprecation/deprecation\r\n  public async getPagedNodes(_token: IModelRpcProps, _options: Paged<HierarchyRpcRequestOptions>): PresentationRpcResponse<PagedResponse<NodeJSON>> { return this.forward(arguments); }\r\n\r\n  /** @beta */\r\n  @RpcOperation.setPolicy({ allowResponseCompression: true })\r\n  public async getNodesDescriptor(_token: IModelRpcProps, _options: HierarchyLevelDescriptorRpcRequestOptions): PresentationRpcResponse<string | DescriptorJSON | undefined> { return this.forward(arguments); }\r\n\r\n  // TODO: add paged version of this (#387280)\r\n  @RpcOperation.setPolicy({ allowResponseCompression: true })\r\n  // eslint-disable-next-line deprecation/deprecation\r\n  public async getNodePaths(_token: IModelRpcProps, _options: FilterByInstancePathsHierarchyRpcRequestOptions): PresentationRpcResponse<NodePathElementJSON[]> { return this.forward(arguments); }\r\n\r\n  // TODO: add paged version of this (#387280)\r\n  @RpcOperation.setPolicy({ allowResponseCompression: true })\r\n  // eslint-disable-next-line deprecation/deprecation\r\n  public async getFilteredNodePaths(_token: IModelRpcProps, _options: FilterByTextHierarchyRpcRequestOptions): PresentationRpcResponse<NodePathElementJSON[]> { return this.forward(arguments); }\r\n\r\n  @RpcOperation.setPolicy({ allowResponseCompression: true })\r\n  public async getContentSources(_token: IModelRpcProps, _options: ContentSourcesRpcRequestOptions): PresentationRpcResponse<ContentSourcesRpcResult> { return this.forward(arguments); }\r\n\r\n  @RpcOperation.setPolicy({ allowResponseCompression: true })\r\n  public async getContentDescriptor(_token: IModelRpcProps, _options: ContentDescriptorRpcRequestOptions): PresentationRpcResponse<DescriptorJSON | undefined> {\r\n    arguments[1] = { ...arguments[1], transport: \"unparsed-json\" };\r\n    const response: PresentationRpcResponseData<DescriptorJSON | string | undefined> = await this.forward(arguments);\r\n    if (response.statusCode === PresentationStatus.Success && typeof response.result === \"string\") {\r\n      response.result = JSON.parse(response.result);\r\n    }\r\n    return response as PresentationRpcResponseData<DescriptorJSON | undefined>;\r\n  }\r\n\r\n  public async getContentSetSize(_token: IModelRpcProps, _options: ContentRpcRequestOptions): PresentationRpcResponse<number> { return this.forward(arguments); }\r\n\r\n  @RpcOperation.setPolicy({ allowResponseCompression: true })\r\n  public async getPagedContent(_token: IModelRpcProps, _options: Paged<ContentRpcRequestOptions>): PresentationRpcResponse<{ descriptor: DescriptorJSON, contentSet: PagedResponse<ItemJSON> } | undefined> { return this.forward(arguments); }\r\n\r\n  @RpcOperation.setPolicy({ allowResponseCompression: true })\r\n  public async getPagedContentSet(_token: IModelRpcProps, _options: Paged<ContentRpcRequestOptions>): PresentationRpcResponse<PagedResponse<ItemJSON>> { return this.forward(arguments); }\r\n\r\n  @RpcOperation.setPolicy({ allowResponseCompression: true })\r\n  public async getElementProperties(_token: IModelRpcProps, _options: SingleElementPropertiesRpcRequestOptions): PresentationRpcResponse<ElementProperties | undefined> { return this.forward(arguments); }\r\n\r\n  @RpcOperation.setPolicy({ allowResponseCompression: true })\r\n  // eslint-disable-next-line deprecation/deprecation\r\n  public async getPagedDistinctValues(_token: IModelRpcProps, _options: DistinctValuesRpcRequestOptions): PresentationRpcResponse<PagedResponse<DisplayValueGroupJSON>> { return this.forward(arguments); }\r\n\r\n  public async getContentInstanceKeys(_token: IModelRpcProps, _options: ContentInstanceKeysRpcRequestOptions): PresentationRpcResponse<{ total: number, items: KeySetJSON }> { return this.forward(arguments); }\r\n\r\n  public async getDisplayLabelDefinition(_token: IModelRpcProps, _options: DisplayLabelRpcRequestOptions): PresentationRpcResponse<LabelDefinition> { return this.forward(arguments); }\r\n\r\n  @RpcOperation.setPolicy({ allowResponseCompression: true })\r\n  public async getPagedDisplayLabelDefinitions(_token: IModelRpcProps, _options: DisplayLabelsRpcRequestOptions): PresentationRpcResponse<PagedResponse<LabelDefinition>> { return this.forward(arguments); }\r\n\r\n  public async getSelectionScopes(_token: IModelRpcProps, _options: SelectionScopeRpcRequestOptions): PresentationRpcResponse<SelectionScope[]> { return this.forward(arguments); }\r\n\r\n  /** @deprecated in 3.x. Use the override with [[ComputeSelectionRpcRequestOptions]]. */\r\n  public async computeSelection(_token: IModelRpcProps, _options: SelectionScopeRpcRequestOptions, _ids: Id64String[], _scopeId: string): PresentationRpcResponse<KeySetJSON>;\r\n  public async computeSelection(_token: IModelRpcProps, _options: ComputeSelectionRpcRequestOptions): PresentationRpcResponse<KeySetJSON>;\r\n  @RpcOperation.setPolicy({ allowResponseCompression: true })\r\n  public async computeSelection(_token: IModelRpcProps, _options: ComputeSelectionRpcRequestOptions | SelectionScopeRpcRequestOptions, _ids?: Id64String[], _scopeId?: string): PresentationRpcResponse<KeySetJSON> { return this.forward(arguments); }\r\n}\r\n\r\n/** @internal */\r\nexport enum PresentationIpcEvents {\r\n  /**\r\n   * ID of an event that's emitted when backend detects changes in presented data.\r\n   */\r\n  Update = \"presentation.onUpdate\",\r\n}\r\n"]}

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

@@ -1,31 +1,31 @@
-/** @packageDocumentation
- * @module Core
- */
-import { FormatterSpec, ParserSpec, UnitSystemKey } from "@itwin/core-quantity";
-import { SchemaContext } from "@itwin/ecschema-metadata";
-import { Content } from "./content/Content";
-/** @alpha */
-export interface FormatOptions {
-    koqName: string;
-    unitSystem: UnitSystemKey;
-}
-/** @alpha */
-export declare class PropertyValueFormatter {
-    private _schemaContext;
-    private _unitsProvider;
-    constructor(_schemaContext: SchemaContext);
-    format(value: number, options: FormatOptions): Promise<string | undefined>;
-    getFormatterSpec(options: FormatOptions): Promise<FormatterSpec | undefined>;
-    getParserSpec(options: FormatOptions): Promise<ParserSpec | undefined>;
-}
-/** @alpha */
-export declare class ContentPropertyValueFormatter {
-    private _propertyValueFormatter;
-    private _unitSystem;
-    constructor(_propertyValueFormatter: PropertyValueFormatter, _unitSystem: UnitSystemKey);
-    formatContent(content: Content): Promise<Content>;
-    private formatValues;
-    private formatNestedContentDisplayValues;
-    private isFormattable;
-}
+/** @packageDocumentation
+ * @module Core
+ */
+import { FormatterSpec, ParserSpec, UnitSystemKey } from "@itwin/core-quantity";
+import { SchemaContext } from "@itwin/ecschema-metadata";
+import { Content } from "./content/Content";
+/** @alpha */
+export interface FormatOptions {
+    koqName: string;
+    unitSystem: UnitSystemKey;
+}
+/** @alpha */
+export declare class PropertyValueFormatter {
+    private _schemaContext;
+    private _unitsProvider;
+    constructor(_schemaContext: SchemaContext);
+    format(value: number, options: FormatOptions): Promise<string | undefined>;
+    getFormatterSpec(options: FormatOptions): Promise<FormatterSpec | undefined>;
+    getParserSpec(options: FormatOptions): Promise<ParserSpec | undefined>;
+}
+/** @alpha */
+export declare class ContentPropertyValueFormatter {
+    private _propertyValueFormatter;
+    private _unitSystem;
+    constructor(_propertyValueFormatter: PropertyValueFormatter, _unitSystem: UnitSystemKey);
+    formatContent(content: Content): Promise<Content>;
+    private formatValues;
+    private formatNestedContentDisplayValues;
+    private isFormattable;
+}
 //# sourceMappingURL=PropertyFormatter.d.ts.map