@itwin/core-common 4.0.0-dev.24 → 4.0.0-dev.28

package/lib/esm/rpc/core/RpcProtocol.d.ts

@@ -1,133 +1,133 @@
-/** @packageDocumentation
- * @module RpcInterface
- */
-import { BeEvent } from "@itwin/core-bentley";
-import { IModelRpcProps } from "../../IModel";
-import { RpcInterface, RpcInterfaceDefinition } from "../../RpcInterface";
-import { RpcConfiguration } from "./RpcConfiguration";
-import { RpcProtocolEvent, RpcRequestStatus, RpcResponseCacheControl } from "./RpcConstants";
-import { RpcNotFoundResponse } from "./RpcControl";
-import { RpcInvocation, SerializedRpcActivity } from "./RpcInvocation";
-import { RpcSerializedValue } from "./RpcMarshaling";
-import { RpcOperation } from "./RpcOperation";
-import { RpcRequest } from "./RpcRequest";
-/** A serialized RPC operation descriptor.
- * @internal
- */
-export interface SerializedRpcOperation {
-    interfaceDefinition: string;
-    operationName: string;
-    interfaceVersion: string;
-    encodedRequest?: string;
-}
-/** A serialized RPC operation request.
- * @internal
- */
-export interface SerializedRpcRequest extends SerializedRpcActivity {
-    operation: SerializedRpcOperation;
-    method: string;
-    path: string;
-    parameters: RpcSerializedValue;
-    caching: RpcResponseCacheControl;
-    ip?: string;
-    protocolVersion?: number;
-    parametersOverride?: any[];
-}
-/** An RPC operation request fulfillment.
- * @internal
- */
-export interface RpcRequestFulfillment {
-    /** The RPC interface for the request. */
-    interfaceName: string;
-    /** The id for the request. */
-    id: string;
-    /** The result for the request. */
-    result: RpcSerializedValue;
-    /** The un-serialized result for the request. */
-    rawResult: any;
-    /** A protocol-specific status code value for the request. */
-    status: number;
-    retry?: string;
-    /** Whether to compress the result with one of the client's supported encodings. */
-    allowCompression?: boolean;
-}
-/** @internal */
-export declare namespace RpcRequestFulfillment {
-    function forUnknownError(request: SerializedRpcRequest, error: any): Promise<RpcRequestFulfillment>;
-}
-/** Handles RPC protocol events.
- * @internal
- */
-export declare type RpcProtocolEventHandler = (type: RpcProtocolEvent, object: RpcRequest | RpcInvocation, err?: any) => void;
-/** Documents changes to the RPC protocol version.
- * @internal
- */
-export declare enum RpcProtocolVersion {
-    None = 0,
-    IntroducedNoContent = 1,
-    IntroducedStatusCategory = 2
-}
-/**
- * A backend response that is handled internally by the RPC system.
- * @internal
- */
-export interface RpcManagedStatus {
-    iTwinRpcCoreResponse: true;
-    managedStatus: "pending" | "notFound" | "noContent";
-    responseValue: string | {
-        message: string;
-    } | RpcNotFoundResponse;
-}
-/** An application protocol for an RPC interface.
- * @internal
- */
-export declare abstract class RpcProtocol {
-    /** Events raised by all protocols. See [[RpcProtocolEvent]] */
-    static readonly events: BeEvent<RpcProtocolEventHandler>;
-    /** A version code that identifies the RPC protocol capabilties of this endpoint. */
-    static readonly protocolVersion: number;
-    /** The name of the RPC protocol version header. */
-    protocolVersionHeaderName: string;
-    /** Events raised by the protocol. See [[RpcProtocolEvent]] */
-    readonly events: BeEvent<RpcProtocolEventHandler>;
-    /** The configuration for the protocol. */
-    readonly configuration: RpcConfiguration;
-    /** The RPC request class for this protocol. */
-    abstract readonly requestType: typeof RpcRequest;
-    /** The RPC invocation class for this protocol. */
-    readonly invocationType: typeof RpcInvocation;
-    serializedClientRequestContextHeaderNames: SerializedRpcActivity;
-    /** If greater than zero, specifies where to break large binary request payloads. */
-    transferChunkThreshold: number;
-    /** Used by protocols that can transmit stream values natively. */
-    preserveStreams: boolean;
-    /** Used by protocols that can transmit IModelRpcProps values natively. */
-    checkToken: boolean;
-    /** Used by protocols that support user-defined status codes. */
-    supportsStatusCategory: boolean;
-    /** If checkToken is true, will be called on the backend to inflate the IModelRpcProps for each request. */
-    inflateToken(tokenFromBody: IModelRpcProps, _request: SerializedRpcRequest): IModelRpcProps;
-    /** Override to supply the status corresponding to a protocol-specific code value. */
-    getStatus(code: number): RpcRequestStatus;
-    /** Override to supply the protocol-specific code corresponding to a status value. */
-    getCode(status: RpcRequestStatus): number;
-    /** Override to supply the protocol-specific path value for an RPC operation. */
-    supplyPathForOperation(operation: RpcOperation, _request: RpcRequest | undefined): string;
-    /** Override to supply the operation for a protocol-specific path value. */
-    getOperationFromPath(path: string): SerializedRpcOperation;
-    /** Obtains the implementation result on the backend for an RPC operation request. */
-    fulfill(request: SerializedRpcRequest): Promise<RpcRequestFulfillment>;
-    /** Serializes a request. */
-    serialize(request: RpcRequest): Promise<SerializedRpcRequest>;
-    /** Constructs a protocol. */
-    constructor(configuration: RpcConfiguration);
-    /** @internal */
-    onRpcClientInitialized(_definition: RpcInterfaceDefinition, _client: RpcInterface): void;
-    /** @internal */
-    onRpcImplInitialized(_definition: RpcInterfaceDefinition, _impl: RpcInterface): void;
-    /** @internal */
-    onRpcClientTerminated(_definition: RpcInterfaceDefinition, _client: RpcInterface): void;
-    /** @internal */
-    onRpcImplTerminated(_definition: RpcInterfaceDefinition, _impl: RpcInterface): void;
-}
+/** @packageDocumentation
+ * @module RpcInterface
+ */
+import { BeEvent } from "@itwin/core-bentley";
+import { IModelRpcProps } from "../../IModel";
+import { RpcInterface, RpcInterfaceDefinition } from "../../RpcInterface";
+import { RpcConfiguration } from "./RpcConfiguration";
+import { RpcProtocolEvent, RpcRequestStatus, RpcResponseCacheControl } from "./RpcConstants";
+import { RpcNotFoundResponse } from "./RpcControl";
+import { RpcInvocation, SerializedRpcActivity } from "./RpcInvocation";
+import { RpcSerializedValue } from "./RpcMarshaling";
+import { RpcOperation } from "./RpcOperation";
+import { RpcRequest } from "./RpcRequest";
+/** A serialized RPC operation descriptor.
+ * @internal
+ */
+export interface SerializedRpcOperation {
+    interfaceDefinition: string;
+    operationName: string;
+    interfaceVersion: string;
+    encodedRequest?: string;
+}
+/** A serialized RPC operation request.
+ * @internal
+ */
+export interface SerializedRpcRequest extends SerializedRpcActivity {
+    operation: SerializedRpcOperation;
+    method: string;
+    path: string;
+    parameters: RpcSerializedValue;
+    caching: RpcResponseCacheControl;
+    ip?: string;
+    protocolVersion?: number;
+    parametersOverride?: any[];
+}
+/** An RPC operation request fulfillment.
+ * @internal
+ */
+export interface RpcRequestFulfillment {
+    /** The RPC interface for the request. */
+    interfaceName: string;
+    /** The id for the request. */
+    id: string;
+    /** The result for the request. */
+    result: RpcSerializedValue;
+    /** The un-serialized result for the request. */
+    rawResult: any;
+    /** A protocol-specific status code value for the request. */
+    status: number;
+    retry?: string;
+    /** Whether to compress the result with one of the client's supported encodings. */
+    allowCompression?: boolean;
+}
+/** @internal */
+export declare namespace RpcRequestFulfillment {
+    function forUnknownError(request: SerializedRpcRequest, error: any): Promise<RpcRequestFulfillment>;
+}
+/** Handles RPC protocol events.
+ * @internal
+ */
+export declare type RpcProtocolEventHandler = (type: RpcProtocolEvent, object: RpcRequest | RpcInvocation, err?: any) => void;
+/** Documents changes to the RPC protocol version.
+ * @internal
+ */
+export declare enum RpcProtocolVersion {
+    None = 0,
+    IntroducedNoContent = 1,
+    IntroducedStatusCategory = 2
+}
+/**
+ * A backend response that is handled internally by the RPC system.
+ * @internal
+ */
+export interface RpcManagedStatus {
+    iTwinRpcCoreResponse: true;
+    managedStatus: "pending" | "notFound" | "noContent";
+    responseValue: string | {
+        message: string;
+    } | RpcNotFoundResponse;
+}
+/** An application protocol for an RPC interface.
+ * @internal
+ */
+export declare abstract class RpcProtocol {
+    /** Events raised by all protocols. See [[RpcProtocolEvent]] */
+    static readonly events: BeEvent<RpcProtocolEventHandler>;
+    /** A version code that identifies the RPC protocol capabilties of this endpoint. */
+    static readonly protocolVersion: number;
+    /** The name of the RPC protocol version header. */
+    protocolVersionHeaderName: string;
+    /** Events raised by the protocol. See [[RpcProtocolEvent]] */
+    readonly events: BeEvent<RpcProtocolEventHandler>;
+    /** The configuration for the protocol. */
+    readonly configuration: RpcConfiguration;
+    /** The RPC request class for this protocol. */
+    abstract readonly requestType: typeof RpcRequest;
+    /** The RPC invocation class for this protocol. */
+    readonly invocationType: typeof RpcInvocation;
+    serializedClientRequestContextHeaderNames: SerializedRpcActivity;
+    /** If greater than zero, specifies where to break large binary request payloads. */
+    transferChunkThreshold: number;
+    /** Used by protocols that can transmit stream values natively. */
+    preserveStreams: boolean;
+    /** Used by protocols that can transmit IModelRpcProps values natively. */
+    checkToken: boolean;
+    /** Used by protocols that support user-defined status codes. */
+    supportsStatusCategory: boolean;
+    /** If checkToken is true, will be called on the backend to inflate the IModelRpcProps for each request. */
+    inflateToken(tokenFromBody: IModelRpcProps, _request: SerializedRpcRequest): IModelRpcProps;
+    /** Override to supply the status corresponding to a protocol-specific code value. */
+    getStatus(code: number): RpcRequestStatus;
+    /** Override to supply the protocol-specific code corresponding to a status value. */
+    getCode(status: RpcRequestStatus): number;
+    /** Override to supply the protocol-specific path value for an RPC operation. */
+    supplyPathForOperation(operation: RpcOperation, _request: RpcRequest | undefined): string;
+    /** Override to supply the operation for a protocol-specific path value. */
+    getOperationFromPath(path: string): SerializedRpcOperation;
+    /** Obtains the implementation result on the backend for an RPC operation request. */
+    fulfill(request: SerializedRpcRequest): Promise<RpcRequestFulfillment>;
+    /** Serializes a request. */
+    serialize(request: RpcRequest): Promise<SerializedRpcRequest>;
+    /** Constructs a protocol. */
+    constructor(configuration: RpcConfiguration);
+    /** @internal */
+    onRpcClientInitialized(_definition: RpcInterfaceDefinition, _client: RpcInterface): void;
+    /** @internal */
+    onRpcImplInitialized(_definition: RpcInterfaceDefinition, _impl: RpcInterface): void;
+    /** @internal */
+    onRpcClientTerminated(_definition: RpcInterfaceDefinition, _client: RpcInterface): void;
+    /** @internal */
+    onRpcImplTerminated(_definition: RpcInterfaceDefinition, _impl: RpcInterface): void;
+}
 //# sourceMappingURL=RpcProtocol.d.ts.map

package/lib/esm/rpc/core/RpcProtocol.js

@@ -1,124 +1,124 @@
-/*---------------------------------------------------------------------------------------------
-* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
-* See LICENSE.md in the project root for license terms and full copyright notice.
-*--------------------------------------------------------------------------------------------*/
-/** @packageDocumentation
- * @module RpcInterface
- */
-import { BeEvent } from "@itwin/core-bentley";
-import { RpcConfiguration } from "./RpcConfiguration";
-import { RpcRequestStatus, RpcResponseCacheControl } from "./RpcConstants";
-import { RpcInvocation } from "./RpcInvocation";
-import { RpcMarshaling } from "./RpcMarshaling";
-/** @internal */
-export var RpcRequestFulfillment;
-(function (RpcRequestFulfillment) {
-    async function forUnknownError(request, error) {
-        const result = await RpcMarshaling.serialize(undefined, error);
-        return {
-            interfaceName: request.operation.interfaceDefinition,
-            id: request.id,
-            result,
-            rawResult: error,
-            status: RpcRequestStatus.Rejected,
-        };
-    }
-    RpcRequestFulfillment.forUnknownError = forUnknownError;
-})(RpcRequestFulfillment || (RpcRequestFulfillment = {}));
-/** Documents changes to the RPC protocol version.
- * @internal
- */
-export var RpcProtocolVersion;
-(function (RpcProtocolVersion) {
-    RpcProtocolVersion[RpcProtocolVersion["None"] = 0] = "None";
-    RpcProtocolVersion[RpcProtocolVersion["IntroducedNoContent"] = 1] = "IntroducedNoContent";
-    RpcProtocolVersion[RpcProtocolVersion["IntroducedStatusCategory"] = 2] = "IntroducedStatusCategory";
-})(RpcProtocolVersion || (RpcProtocolVersion = {}));
-/** An application protocol for an RPC interface.
- * @internal
- */
-export class RpcProtocol {
-    /** Constructs a protocol. */
-    constructor(configuration) {
-        /** The name of the RPC protocol version header. */
-        this.protocolVersionHeaderName = "";
-        /** Events raised by the protocol. See [[RpcProtocolEvent]] */
-        this.events = new BeEvent();
-        /** The RPC invocation class for this protocol. */
-        this.invocationType = RpcInvocation;
-        this.serializedClientRequestContextHeaderNames = {
-            /** The name of the request id header. */
-            id: "",
-            /** The name of the application id header  */
-            applicationId: "",
-            /** The name of the version header. */
-            applicationVersion: "",
-            /** The name of the session id header  */
-            sessionId: "",
-            /** The name of the authorization header. */
-            authorization: "",
-        };
-        /** If greater than zero, specifies where to break large binary request payloads. */
-        this.transferChunkThreshold = 0;
-        /** Used by protocols that can transmit stream values natively. */
-        this.preserveStreams = false;
-        /** Used by protocols that can transmit IModelRpcProps values natively. */
-        this.checkToken = false;
-        /** Used by protocols that support user-defined status codes. */
-        this.supportsStatusCategory = false;
-        this.configuration = configuration;
-        this.events.addListener((type, object) => RpcProtocol.events.raiseEvent(type, object));
-    }
-    /** If checkToken is true, will be called on the backend to inflate the IModelRpcProps for each request. */
-    inflateToken(tokenFromBody, _request) { return tokenFromBody; }
-    /** Override to supply the status corresponding to a protocol-specific code value. */
-    getStatus(code) {
-        return code;
-    }
-    /** Override to supply the protocol-specific code corresponding to a status value. */
-    getCode(status) {
-        return status;
-    }
-    /** Override to supply the protocol-specific path value for an RPC operation. */
-    supplyPathForOperation(operation, _request) {
-        return JSON.stringify(operation);
-    }
-    /** Override to supply the operation for a protocol-specific path value. */
-    getOperationFromPath(path) {
-        return JSON.parse(path);
-    }
-    /** Obtains the implementation result on the backend for an RPC operation request. */
-    async fulfill(request) {
-        return new (this.invocationType)(this, request).fulfillment;
-    }
-    /** Serializes a request. */
-    async serialize(request) {
-        const serializedContext = await RpcConfiguration.requestContext.serialize(request);
-        return {
-            ...serializedContext,
-            operation: {
-                interfaceDefinition: request.operation.interfaceDefinition.interfaceName,
-                operationName: request.operation.operationName,
-                interfaceVersion: request.operation.interfaceVersion,
-            },
-            method: request.method,
-            path: request.path,
-            parameters: await RpcMarshaling.serialize(request.protocol, request.parameters),
-            caching: RpcResponseCacheControl.None,
-            protocolVersion: RpcProtocol.protocolVersion,
-        };
-    }
-    /** @internal */
-    onRpcClientInitialized(_definition, _client) { }
-    /** @internal */
-    onRpcImplInitialized(_definition, _impl) { }
-    /** @internal */
-    onRpcClientTerminated(_definition, _client) { }
-    /** @internal */
-    onRpcImplTerminated(_definition, _impl) { }
-}
-/** Events raised by all protocols. See [[RpcProtocolEvent]] */
-RpcProtocol.events = new BeEvent();
-/** A version code that identifies the RPC protocol capabilties of this endpoint. */
-RpcProtocol.protocolVersion = RpcProtocolVersion.IntroducedStatusCategory;
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+/** @packageDocumentation
+ * @module RpcInterface
+ */
+import { BeEvent } from "@itwin/core-bentley";
+import { RpcConfiguration } from "./RpcConfiguration";
+import { RpcRequestStatus, RpcResponseCacheControl } from "./RpcConstants";
+import { RpcInvocation } from "./RpcInvocation";
+import { RpcMarshaling } from "./RpcMarshaling";
+/** @internal */
+export var RpcRequestFulfillment;
+(function (RpcRequestFulfillment) {
+    async function forUnknownError(request, error) {
+        const result = await RpcMarshaling.serialize(undefined, error);
+        return {
+            interfaceName: request.operation.interfaceDefinition,
+            id: request.id,
+            result,
+            rawResult: error,
+            status: RpcRequestStatus.Rejected,
+        };
+    }
+    RpcRequestFulfillment.forUnknownError = forUnknownError;
+})(RpcRequestFulfillment || (RpcRequestFulfillment = {}));
+/** Documents changes to the RPC protocol version.
+ * @internal
+ */
+export var RpcProtocolVersion;
+(function (RpcProtocolVersion) {
+    RpcProtocolVersion[RpcProtocolVersion["None"] = 0] = "None";
+    RpcProtocolVersion[RpcProtocolVersion["IntroducedNoContent"] = 1] = "IntroducedNoContent";
+    RpcProtocolVersion[RpcProtocolVersion["IntroducedStatusCategory"] = 2] = "IntroducedStatusCategory";
+})(RpcProtocolVersion || (RpcProtocolVersion = {}));
+/** An application protocol for an RPC interface.
+ * @internal
+ */
+export class RpcProtocol {
+    /** Constructs a protocol. */
+    constructor(configuration) {
+        /** The name of the RPC protocol version header. */
+        this.protocolVersionHeaderName = "";
+        /** Events raised by the protocol. See [[RpcProtocolEvent]] */
+        this.events = new BeEvent();
+        /** The RPC invocation class for this protocol. */
+        this.invocationType = RpcInvocation;
+        this.serializedClientRequestContextHeaderNames = {
+            /** The name of the request id header. */
+            id: "",
+            /** The name of the application id header  */
+            applicationId: "",
+            /** The name of the version header. */
+            applicationVersion: "",
+            /** The name of the session id header  */
+            sessionId: "",
+            /** The name of the authorization header. */
+            authorization: "",
+        };
+        /** If greater than zero, specifies where to break large binary request payloads. */
+        this.transferChunkThreshold = 0;
+        /** Used by protocols that can transmit stream values natively. */
+        this.preserveStreams = false;
+        /** Used by protocols that can transmit IModelRpcProps values natively. */
+        this.checkToken = false;
+        /** Used by protocols that support user-defined status codes. */
+        this.supportsStatusCategory = false;
+        this.configuration = configuration;
+        this.events.addListener((type, object) => RpcProtocol.events.raiseEvent(type, object));
+    }
+    /** If checkToken is true, will be called on the backend to inflate the IModelRpcProps for each request. */
+    inflateToken(tokenFromBody, _request) { return tokenFromBody; }
+    /** Override to supply the status corresponding to a protocol-specific code value. */
+    getStatus(code) {
+        return code;
+    }
+    /** Override to supply the protocol-specific code corresponding to a status value. */
+    getCode(status) {
+        return status;
+    }
+    /** Override to supply the protocol-specific path value for an RPC operation. */
+    supplyPathForOperation(operation, _request) {
+        return JSON.stringify(operation);
+    }
+    /** Override to supply the operation for a protocol-specific path value. */
+    getOperationFromPath(path) {
+        return JSON.parse(path);
+    }
+    /** Obtains the implementation result on the backend for an RPC operation request. */
+    async fulfill(request) {
+        return new (this.invocationType)(this, request).fulfillment;
+    }
+    /** Serializes a request. */
+    async serialize(request) {
+        const serializedContext = await RpcConfiguration.requestContext.serialize(request);
+        return {
+            ...serializedContext,
+            operation: {
+                interfaceDefinition: request.operation.interfaceDefinition.interfaceName,
+                operationName: request.operation.operationName,
+                interfaceVersion: request.operation.interfaceVersion,
+            },
+            method: request.method,
+            path: request.path,
+            parameters: await RpcMarshaling.serialize(request.protocol, request.parameters),
+            caching: RpcResponseCacheControl.None,
+            protocolVersion: RpcProtocol.protocolVersion,
+        };
+    }
+    /** @internal */
+    onRpcClientInitialized(_definition, _client) { }
+    /** @internal */
+    onRpcImplInitialized(_definition, _impl) { }
+    /** @internal */
+    onRpcClientTerminated(_definition, _client) { }
+    /** @internal */
+    onRpcImplTerminated(_definition, _impl) { }
+}
+/** Events raised by all protocols. See [[RpcProtocolEvent]] */
+RpcProtocol.events = new BeEvent();
+/** A version code that identifies the RPC protocol capabilties of this endpoint. */
+RpcProtocol.protocolVersion = RpcProtocolVersion.IntroducedStatusCategory;
 //# sourceMappingURL=RpcProtocol.js.map

package/lib/esm/rpc/core/RpcProtocol.js.map

@@ -1 +1 @@
-{"version":3,"file":"RpcProtocol.js","sourceRoot":"","sources":["../../../../src/rpc/core/RpcProtocol.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAEH,OAAO,EAAE,OAAO,EAAE,MAAM,qBAAqB,CAAC;AAG9C,OAAO,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AACtD,OAAO,EAAoB,gBAAgB,EAAE,uBAAuB,EAAE,MAAM,gBAAgB,CAAC;AAE7F,OAAO,EAAE,aAAa,EAAyB,MAAM,iBAAiB,CAAC;AACvE,OAAO,EAAE,aAAa,EAAsB,MAAM,iBAAiB,CAAC;AAwDpE,gBAAgB;AAChB,MAAM,KAAW,qBAAqB,CAYrC;AAZD,WAAiB,qBAAqB;IAC7B,KAAK,UAAU,eAAe,CAAC,OAA6B,EAAE,KAAU;QAC7E,MAAM,MAAM,GAAG,MAAM,aAAa,CAAC,SAAS,CAAC,SAAS,EAAE,KAAK,CAAC,CAAC;QAE/D,OAAO;YACL,aAAa,EAAE,OAAO,CAAC,SAAS,CAAC,mBAAmB;YACpD,EAAE,EAAE,OAAO,CAAC,EAAE;YACd,MAAM;YACN,SAAS,EAAE,KAAK;YAChB,MAAM,EAAE,gBAAgB,CAAC,QAAQ;SAClC,CAAC;IACJ,CAAC;IAVqB,qCAAe,kBAUpC,CAAA;AACH,CAAC,EAZgB,qBAAqB,KAArB,qBAAqB,QAYrC;AAOD;;GAEG;AACH,MAAM,CAAN,IAAY,kBAIX;AAJD,WAAY,kBAAkB;IAC5B,2DAAQ,CAAA;IACR,yFAAuB,CAAA;IACvB,mGAA4B,CAAA;AAC9B,CAAC,EAJW,kBAAkB,KAAlB,kBAAkB,QAI7B;AAYD;;GAEG;AACH,MAAM,OAAgB,WAAW;IAiG/B,6BAA6B;IAC7B,YAAmB,aAA+B;QA3FlD,mDAAmD;QAC5C,8BAAyB,GAAG,EAAE,CAAC;QAEtC,8DAA8D;QAC9C,WAAM,GAAqC,IAAI,OAAO,EAAE,CAAC;QAQzE,kDAAkD;QAClC,mBAAc,GAAyB,aAAa,CAAC;QAE9D,8CAAyC,GAA0B;YACxE,yCAAyC;YACzC,EAAE,EAAE,EAAE;YAEN,6CAA6C;YAC7C,aAAa,EAAE,EAAE;YAEjB,sCAAsC;YACtC,kBAAkB,EAAE,EAAE;YAEtB,yCAAyC;YACzC,SAAS,EAAE,EAAE;YAEb,4CAA4C;YAC5C,aAAa,EAAE,EAAE;SAClB,CAAC;QAEF,oFAAoF;QAC7E,2BAAsB,GAAW,CAAC,CAAC;QAE1C,kEAAkE;QAC3D,oBAAe,GAAY,KAAK,CAAC;QAExC,0EAA0E;QACnE,eAAU,GAAY,KAAK,CAAC;QAEnC,gEAAgE;QACzD,2BAAsB,GAAY,KAAK,CAAC;QAkD7C,IAAI,CAAC,aAAa,GAAG,aAAa,CAAC;QACnC,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC,IAAI,EAAE,MAAM,EAAE,EAAE,CAAC,WAAW,CAAC,MAAM,CAAC,UAAU,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC,CAAC;IACzF,CAAC;IAlDD,2GAA2G;IACpG,YAAY,CAAC,aAA6B,EAAE,QAA8B,IAAoB,OAAO,aAAa,CAAC,CAAC,CAAC;IAE5H,qFAAqF;IAC9E,SAAS,CAAC,IAAY;QAC3B,OAAO,IAAI,CAAC;IACd,CAAC;IAED,qFAAqF;IAC9E,OAAO,CAAC,MAAwB;QACrC,OAAO,MAAM,CAAC;IAChB,CAAC;IAED,gFAAgF;IACzE,sBAAsB,CAAC,SAAuB,EAAE,QAAgC;QACrF,OAAO,IAAI,CAAC,SAAS,CAAC,SAAS,CAAC,CAAC;IACnC,CAAC;IAED,2EAA2E;IACpE,oBAAoB,CAAC,IAAY;QACtC,OAAO,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;IAC1B,CAAC;IAED,qFAAqF;IAC9E,KAAK,CAAC,OAAO,CAAC,OAA6B;QAChD,OAAO,IAAI,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC,WAAW,CAAC;IAC9D,CAAC;IAED,4BAA4B;IACrB,KAAK,CAAC,SAAS,CAAC,OAAmB;QACxC,MAAM,iBAAiB,GAAG,MAAM,gBAAgB,CAAC,cAAc,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC;QACnF,OAAO;YACL,GAAG,iBAAiB;YACpB,SAAS,EAAE;gBACT,mBAAmB,EAAE,OAAO,CAAC,SAAS,CAAC,mBAAmB,CAAC,aAAa;gBACxE,aAAa,EAAE,OAAO,CAAC,SAAS,CAAC,aAAa;gBAC9C,gBAAgB,EAAE,OAAO,CAAC,SAAS,CAAC,gBAAgB;aACrD;YACD,MAAM,EAAE,OAAO,CAAC,MAAM;YACtB,IAAI,EAAE,OAAO,CAAC,IAAI;YAClB,UAAU,EAAE,MAAM,aAAa,CAAC,SAAS,CAAC,OAAO,CAAC,QAAQ,EAAE,OAAO,CAAC,UAAU,CAAC;YAC/E,OAAO,EAAE,uBAAuB,CAAC,IAAI;YACrC,eAAe,EAAE,WAAW,CAAC,eAAe;SAC7C,CAAC;IACJ,CAAC;IAQD,gBAAgB;IACT,sBAAsB,CAAC,WAAmC,EAAE,OAAqB,IAAU,CAAC;IAEnG,gBAAgB;IACT,oBAAoB,CAAC,WAAmC,EAAE,KAAmB,IAAU,CAAC;IAE/F,gBAAgB;IACT,qBAAqB,CAAC,WAAmC,EAAE,OAAqB,IAAU,CAAC;IAElG,gBAAgB;IACT,mBAAmB,CAAC,WAAmC,EAAE,KAAmB,IAAU,CAAC;;AAhH9F,+DAA+D;AACxC,kBAAM,GAAqC,IAAI,OAAO,EAAE,CAAC;AAEhF,oFAAoF;AAC7D,2BAAe,GAAW,kBAAkB,CAAC,wBAAwB,CAAC","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 RpcInterface\r\n */\r\n\r\nimport { BeEvent } from \"@itwin/core-bentley\";\r\nimport { IModelRpcProps } from \"../../IModel\";\r\nimport { RpcInterface, RpcInterfaceDefinition } from \"../../RpcInterface\";\r\nimport { RpcConfiguration } from \"./RpcConfiguration\";\r\nimport { RpcProtocolEvent, RpcRequestStatus, RpcResponseCacheControl } from \"./RpcConstants\";\r\nimport { RpcNotFoundResponse } from \"./RpcControl\";\r\nimport { RpcInvocation, SerializedRpcActivity } from \"./RpcInvocation\";\r\nimport { RpcMarshaling, RpcSerializedValue } from \"./RpcMarshaling\";\r\nimport { RpcOperation } from \"./RpcOperation\";\r\nimport { RpcRequest } from \"./RpcRequest\";\r\n\r\n/* eslint-disable deprecation/deprecation */\r\n\r\n/** A serialized RPC operation descriptor.\r\n * @internal\r\n */\r\nexport interface SerializedRpcOperation {\r\n  interfaceDefinition: string;\r\n  operationName: string;\r\n  interfaceVersion: string;\r\n  encodedRequest?: string;\r\n}\r\n\r\n/** A serialized RPC operation request.\r\n * @internal\r\n */\r\nexport interface SerializedRpcRequest extends SerializedRpcActivity {\r\n  operation: SerializedRpcOperation;\r\n  method: string;\r\n  path: string;\r\n  parameters: RpcSerializedValue;\r\n  caching: RpcResponseCacheControl;\r\n  ip?: string;\r\n  protocolVersion?: number;\r\n  parametersOverride?: any[];\r\n}\r\n\r\n/** An RPC operation request fulfillment.\r\n * @internal\r\n */\r\nexport interface RpcRequestFulfillment {\r\n  /** The RPC interface for the request. */\r\n  interfaceName: string;\r\n\r\n  /** The id for the request. */\r\n  id: string;\r\n\r\n  /** The result for the request. */\r\n  result: RpcSerializedValue;\r\n\r\n  /** The un-serialized result for the request. */\r\n  rawResult: any;\r\n\r\n  /** A protocol-specific status code value for the request. */\r\n  status: number;\r\n\r\n  /* A protocol-specific value for retrying this request. */\r\n  retry?: string;\r\n\r\n  /** Whether to compress the result with one of the client's supported encodings. */\r\n  allowCompression?: boolean;\r\n}\r\n\r\n/** @internal */\r\nexport namespace RpcRequestFulfillment {\r\n  export async function forUnknownError(request: SerializedRpcRequest, error: any): Promise<RpcRequestFulfillment> {\r\n    const result = await RpcMarshaling.serialize(undefined, error);\r\n\r\n    return {\r\n      interfaceName: request.operation.interfaceDefinition,\r\n      id: request.id,\r\n      result,\r\n      rawResult: error,\r\n      status: RpcRequestStatus.Rejected,\r\n    };\r\n  }\r\n}\r\n\r\n/** Handles RPC protocol events.\r\n * @internal\r\n */\r\nexport type RpcProtocolEventHandler = (type: RpcProtocolEvent, object: RpcRequest | RpcInvocation, err?: any) => void;\r\n\r\n/** Documents changes to the RPC protocol version.\r\n * @internal\r\n */\r\nexport enum RpcProtocolVersion {\r\n  None = 0,\r\n  IntroducedNoContent = 1,\r\n  IntroducedStatusCategory = 2\r\n}\r\n\r\n/**\r\n * A backend response that is handled internally by the RPC system.\r\n * @internal\r\n */\r\nexport interface RpcManagedStatus {\r\n  iTwinRpcCoreResponse: true;\r\n  managedStatus: \"pending\" | \"notFound\" | \"noContent\";\r\n  responseValue: string | { message: string } | RpcNotFoundResponse;\r\n}\r\n\r\n/** An application protocol for an RPC interface.\r\n * @internal\r\n */\r\nexport abstract class RpcProtocol {\r\n  /** Events raised by all protocols. See [[RpcProtocolEvent]] */\r\n  public static readonly events: BeEvent<RpcProtocolEventHandler> = new BeEvent();\r\n\r\n  /** A version code that identifies the RPC protocol capabilties of this endpoint. */\r\n  public static readonly protocolVersion: number = RpcProtocolVersion.IntroducedStatusCategory;\r\n\r\n  /** The name of the RPC protocol version header. */\r\n  public protocolVersionHeaderName = \"\";\r\n\r\n  /** Events raised by the protocol. See [[RpcProtocolEvent]] */\r\n  public readonly events: BeEvent<RpcProtocolEventHandler> = new BeEvent();\r\n\r\n  /** The configuration for the protocol. */\r\n  public readonly configuration: RpcConfiguration;\r\n\r\n  /** The RPC request class for this protocol. */\r\n  public abstract readonly requestType: typeof RpcRequest;\r\n\r\n  /** The RPC invocation class for this protocol. */\r\n  public readonly invocationType: typeof RpcInvocation = RpcInvocation;\r\n\r\n  public serializedClientRequestContextHeaderNames: SerializedRpcActivity = {\r\n    /** The name of the request id header. */\r\n    id: \"\",\r\n\r\n    /** The name of the application id header  */\r\n    applicationId: \"\",\r\n\r\n    /** The name of the version header. */\r\n    applicationVersion: \"\",\r\n\r\n    /** The name of the session id header  */\r\n    sessionId: \"\",\r\n\r\n    /** The name of the authorization header. */\r\n    authorization: \"\",\r\n  };\r\n\r\n  /** If greater than zero, specifies where to break large binary request payloads. */\r\n  public transferChunkThreshold: number = 0;\r\n\r\n  /** Used by protocols that can transmit stream values natively. */\r\n  public preserveStreams: boolean = false;\r\n\r\n  /** Used by protocols that can transmit IModelRpcProps values natively. */\r\n  public checkToken: boolean = false;\r\n\r\n  /** Used by protocols that support user-defined status codes. */\r\n  public supportsStatusCategory: boolean = false;\r\n\r\n  /** If checkToken is true, will be called on the backend to inflate the IModelRpcProps for each request. */\r\n  public inflateToken(tokenFromBody: IModelRpcProps, _request: SerializedRpcRequest): IModelRpcProps { return tokenFromBody; }\r\n\r\n  /** Override to supply the status corresponding to a protocol-specific code value. */\r\n  public getStatus(code: number): RpcRequestStatus {\r\n    return code;\r\n  }\r\n\r\n  /** Override to supply the protocol-specific code corresponding to a status value. */\r\n  public getCode(status: RpcRequestStatus): number {\r\n    return status;\r\n  }\r\n\r\n  /** Override to supply the protocol-specific path value for an RPC operation. */\r\n  public supplyPathForOperation(operation: RpcOperation, _request: RpcRequest | undefined): string {\r\n    return JSON.stringify(operation);\r\n  }\r\n\r\n  /** Override to supply the operation for a protocol-specific path value. */\r\n  public getOperationFromPath(path: string): SerializedRpcOperation {\r\n    return JSON.parse(path);\r\n  }\r\n\r\n  /** Obtains the implementation result on the backend for an RPC operation request. */\r\n  public async fulfill(request: SerializedRpcRequest): Promise<RpcRequestFulfillment> {\r\n    return new (this.invocationType)(this, request).fulfillment;\r\n  }\r\n\r\n  /** Serializes a request. */\r\n  public async serialize(request: RpcRequest): Promise<SerializedRpcRequest> {\r\n    const serializedContext = await RpcConfiguration.requestContext.serialize(request);\r\n    return {\r\n      ...serializedContext,\r\n      operation: {\r\n        interfaceDefinition: request.operation.interfaceDefinition.interfaceName,\r\n        operationName: request.operation.operationName,\r\n        interfaceVersion: request.operation.interfaceVersion,\r\n      },\r\n      method: request.method,\r\n      path: request.path,\r\n      parameters: await RpcMarshaling.serialize(request.protocol, request.parameters),\r\n      caching: RpcResponseCacheControl.None,\r\n      protocolVersion: RpcProtocol.protocolVersion,\r\n    };\r\n  }\r\n\r\n  /** Constructs a protocol. */\r\n  public constructor(configuration: RpcConfiguration) {\r\n    this.configuration = configuration;\r\n    this.events.addListener((type, object) => RpcProtocol.events.raiseEvent(type, object));\r\n  }\r\n\r\n  /** @internal */\r\n  public onRpcClientInitialized(_definition: RpcInterfaceDefinition, _client: RpcInterface): void { }\r\n\r\n  /** @internal */\r\n  public onRpcImplInitialized(_definition: RpcInterfaceDefinition, _impl: RpcInterface): void { }\r\n\r\n  /** @internal */\r\n  public onRpcClientTerminated(_definition: RpcInterfaceDefinition, _client: RpcInterface): void { }\r\n\r\n  /** @internal */\r\n  public onRpcImplTerminated(_definition: RpcInterfaceDefinition, _impl: RpcInterface): void { }\r\n}\r\n"]}
+{"version":3,"file":"RpcProtocol.js","sourceRoot":"","sources":["../../../../src/rpc/core/RpcProtocol.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAEH,OAAO,EAAE,OAAO,EAAE,MAAM,qBAAqB,CAAC;AAG9C,OAAO,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AACtD,OAAO,EAAoB,gBAAgB,EAAE,uBAAuB,EAAE,MAAM,gBAAgB,CAAC;AAE7F,OAAO,EAAE,aAAa,EAAyB,MAAM,iBAAiB,CAAC;AACvE,OAAO,EAAE,aAAa,EAAsB,MAAM,iBAAiB,CAAC;AAwDpE,gBAAgB;AAChB,MAAM,KAAW,qBAAqB,CAYrC;AAZD,WAAiB,qBAAqB;IAC7B,KAAK,UAAU,eAAe,CAAC,OAA6B,EAAE,KAAU;QAC7E,MAAM,MAAM,GAAG,MAAM,aAAa,CAAC,SAAS,CAAC,SAAS,EAAE,KAAK,CAAC,CAAC;QAE/D,OAAO;YACL,aAAa,EAAE,OAAO,CAAC,SAAS,CAAC,mBAAmB;YACpD,EAAE,EAAE,OAAO,CAAC,EAAE;YACd,MAAM;YACN,SAAS,EAAE,KAAK;YAChB,MAAM,EAAE,gBAAgB,CAAC,QAAQ;SAClC,CAAC;IACJ,CAAC;IAVqB,qCAAe,kBAUpC,CAAA;AACH,CAAC,EAZgB,qBAAqB,KAArB,qBAAqB,QAYrC;AAOD;;GAEG;AACH,MAAM,CAAN,IAAY,kBAIX;AAJD,WAAY,kBAAkB;IAC5B,2DAAQ,CAAA;IACR,yFAAuB,CAAA;IACvB,mGAA4B,CAAA;AAC9B,CAAC,EAJW,kBAAkB,KAAlB,kBAAkB,QAI7B;AAYD;;GAEG;AACH,MAAM,OAAgB,WAAW;IAiG/B,6BAA6B;IAC7B,YAAmB,aAA+B;QA3FlD,mDAAmD;QAC5C,8BAAyB,GAAG,EAAE,CAAC;QAEtC,8DAA8D;QAC9C,WAAM,GAAqC,IAAI,OAAO,EAAE,CAAC;QAQzE,kDAAkD;QAClC,mBAAc,GAAyB,aAAa,CAAC;QAE9D,8CAAyC,GAA0B;YACxE,yCAAyC;YACzC,EAAE,EAAE,EAAE;YAEN,6CAA6C;YAC7C,aAAa,EAAE,EAAE;YAEjB,sCAAsC;YACtC,kBAAkB,EAAE,EAAE;YAEtB,yCAAyC;YACzC,SAAS,EAAE,EAAE;YAEb,4CAA4C;YAC5C,aAAa,EAAE,EAAE;SAClB,CAAC;QAEF,oFAAoF;QAC7E,2BAAsB,GAAW,CAAC,CAAC;QAE1C,kEAAkE;QAC3D,oBAAe,GAAY,KAAK,CAAC;QAExC,0EAA0E;QACnE,eAAU,GAAY,KAAK,CAAC;QAEnC,gEAAgE;QACzD,2BAAsB,GAAY,KAAK,CAAC;QAkD7C,IAAI,CAAC,aAAa,GAAG,aAAa,CAAC;QACnC,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC,IAAI,EAAE,MAAM,EAAE,EAAE,CAAC,WAAW,CAAC,MAAM,CAAC,UAAU,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC,CAAC;IACzF,CAAC;IAlDD,2GAA2G;IACpG,YAAY,CAAC,aAA6B,EAAE,QAA8B,IAAoB,OAAO,aAAa,CAAC,CAAC,CAAC;IAE5H,qFAAqF;IAC9E,SAAS,CAAC,IAAY;QAC3B,OAAO,IAAI,CAAC;IACd,CAAC;IAED,qFAAqF;IAC9E,OAAO,CAAC,MAAwB;QACrC,OAAO,MAAM,CAAC;IAChB,CAAC;IAED,gFAAgF;IACzE,sBAAsB,CAAC,SAAuB,EAAE,QAAgC;QACrF,OAAO,IAAI,CAAC,SAAS,CAAC,SAAS,CAAC,CAAC;IACnC,CAAC;IAED,2EAA2E;IACpE,oBAAoB,CAAC,IAAY;QACtC,OAAO,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;IAC1B,CAAC;IAED,qFAAqF;IAC9E,KAAK,CAAC,OAAO,CAAC,OAA6B;QAChD,OAAO,IAAI,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC,WAAW,CAAC;IAC9D,CAAC;IAED,4BAA4B;IACrB,KAAK,CAAC,SAAS,CAAC,OAAmB;QACxC,MAAM,iBAAiB,GAAG,MAAM,gBAAgB,CAAC,cAAc,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC;QACnF,OAAO;YACL,GAAG,iBAAiB;YACpB,SAAS,EAAE;gBACT,mBAAmB,EAAE,OAAO,CAAC,SAAS,CAAC,mBAAmB,CAAC,aAAa;gBACxE,aAAa,EAAE,OAAO,CAAC,SAAS,CAAC,aAAa;gBAC9C,gBAAgB,EAAE,OAAO,CAAC,SAAS,CAAC,gBAAgB;aACrD;YACD,MAAM,EAAE,OAAO,CAAC,MAAM;YACtB,IAAI,EAAE,OAAO,CAAC,IAAI;YAClB,UAAU,EAAE,MAAM,aAAa,CAAC,SAAS,CAAC,OAAO,CAAC,QAAQ,EAAE,OAAO,CAAC,UAAU,CAAC;YAC/E,OAAO,EAAE,uBAAuB,CAAC,IAAI;YACrC,eAAe,EAAE,WAAW,CAAC,eAAe;SAC7C,CAAC;IACJ,CAAC;IAQD,gBAAgB;IACT,sBAAsB,CAAC,WAAmC,EAAE,OAAqB,IAAU,CAAC;IAEnG,gBAAgB;IACT,oBAAoB,CAAC,WAAmC,EAAE,KAAmB,IAAU,CAAC;IAE/F,gBAAgB;IACT,qBAAqB,CAAC,WAAmC,EAAE,OAAqB,IAAU,CAAC;IAElG,gBAAgB;IACT,mBAAmB,CAAC,WAAmC,EAAE,KAAmB,IAAU,CAAC;;AAhH9F,+DAA+D;AACxC,kBAAM,GAAqC,IAAI,OAAO,EAAE,CAAC;AAEhF,oFAAoF;AAC7D,2BAAe,GAAW,kBAAkB,CAAC,wBAAwB,CAAC","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 RpcInterface\n */\n\nimport { BeEvent } from \"@itwin/core-bentley\";\nimport { IModelRpcProps } from \"../../IModel\";\nimport { RpcInterface, RpcInterfaceDefinition } from \"../../RpcInterface\";\nimport { RpcConfiguration } from \"./RpcConfiguration\";\nimport { RpcProtocolEvent, RpcRequestStatus, RpcResponseCacheControl } from \"./RpcConstants\";\nimport { RpcNotFoundResponse } from \"./RpcControl\";\nimport { RpcInvocation, SerializedRpcActivity } from \"./RpcInvocation\";\nimport { RpcMarshaling, RpcSerializedValue } from \"./RpcMarshaling\";\nimport { RpcOperation } from \"./RpcOperation\";\nimport { RpcRequest } from \"./RpcRequest\";\n\n/* eslint-disable deprecation/deprecation */\n\n/** A serialized RPC operation descriptor.\n * @internal\n */\nexport interface SerializedRpcOperation {\n  interfaceDefinition: string;\n  operationName: string;\n  interfaceVersion: string;\n  encodedRequest?: string;\n}\n\n/** A serialized RPC operation request.\n * @internal\n */\nexport interface SerializedRpcRequest extends SerializedRpcActivity {\n  operation: SerializedRpcOperation;\n  method: string;\n  path: string;\n  parameters: RpcSerializedValue;\n  caching: RpcResponseCacheControl;\n  ip?: string;\n  protocolVersion?: number;\n  parametersOverride?: any[];\n}\n\n/** An RPC operation request fulfillment.\n * @internal\n */\nexport interface RpcRequestFulfillment {\n  /** The RPC interface for the request. */\n  interfaceName: string;\n\n  /** The id for the request. */\n  id: string;\n\n  /** The result for the request. */\n  result: RpcSerializedValue;\n\n  /** The un-serialized result for the request. */\n  rawResult: any;\n\n  /** A protocol-specific status code value for the request. */\n  status: number;\n\n  /* A protocol-specific value for retrying this request. */\n  retry?: string;\n\n  /** Whether to compress the result with one of the client's supported encodings. */\n  allowCompression?: boolean;\n}\n\n/** @internal */\nexport namespace RpcRequestFulfillment {\n  export async function forUnknownError(request: SerializedRpcRequest, error: any): Promise<RpcRequestFulfillment> {\n    const result = await RpcMarshaling.serialize(undefined, error);\n\n    return {\n      interfaceName: request.operation.interfaceDefinition,\n      id: request.id,\n      result,\n      rawResult: error,\n      status: RpcRequestStatus.Rejected,\n    };\n  }\n}\n\n/** Handles RPC protocol events.\n * @internal\n */\nexport type RpcProtocolEventHandler = (type: RpcProtocolEvent, object: RpcRequest | RpcInvocation, err?: any) => void;\n\n/** Documents changes to the RPC protocol version.\n * @internal\n */\nexport enum RpcProtocolVersion {\n  None = 0,\n  IntroducedNoContent = 1,\n  IntroducedStatusCategory = 2\n}\n\n/**\n * A backend response that is handled internally by the RPC system.\n * @internal\n */\nexport interface RpcManagedStatus {\n  iTwinRpcCoreResponse: true;\n  managedStatus: \"pending\" | \"notFound\" | \"noContent\";\n  responseValue: string | { message: string } | RpcNotFoundResponse;\n}\n\n/** An application protocol for an RPC interface.\n * @internal\n */\nexport abstract class RpcProtocol {\n  /** Events raised by all protocols. See [[RpcProtocolEvent]] */\n  public static readonly events: BeEvent<RpcProtocolEventHandler> = new BeEvent();\n\n  /** A version code that identifies the RPC protocol capabilties of this endpoint. */\n  public static readonly protocolVersion: number = RpcProtocolVersion.IntroducedStatusCategory;\n\n  /** The name of the RPC protocol version header. */\n  public protocolVersionHeaderName = \"\";\n\n  /** Events raised by the protocol. See [[RpcProtocolEvent]] */\n  public readonly events: BeEvent<RpcProtocolEventHandler> = new BeEvent();\n\n  /** The configuration for the protocol. */\n  public readonly configuration: RpcConfiguration;\n\n  /** The RPC request class for this protocol. */\n  public abstract readonly requestType: typeof RpcRequest;\n\n  /** The RPC invocation class for this protocol. */\n  public readonly invocationType: typeof RpcInvocation = RpcInvocation;\n\n  public serializedClientRequestContextHeaderNames: SerializedRpcActivity = {\n    /** The name of the request id header. */\n    id: \"\",\n\n    /** The name of the application id header  */\n    applicationId: \"\",\n\n    /** The name of the version header. */\n    applicationVersion: \"\",\n\n    /** The name of the session id header  */\n    sessionId: \"\",\n\n    /** The name of the authorization header. */\n    authorization: \"\",\n  };\n\n  /** If greater than zero, specifies where to break large binary request payloads. */\n  public transferChunkThreshold: number = 0;\n\n  /** Used by protocols that can transmit stream values natively. */\n  public preserveStreams: boolean = false;\n\n  /** Used by protocols that can transmit IModelRpcProps values natively. */\n  public checkToken: boolean = false;\n\n  /** Used by protocols that support user-defined status codes. */\n  public supportsStatusCategory: boolean = false;\n\n  /** If checkToken is true, will be called on the backend to inflate the IModelRpcProps for each request. */\n  public inflateToken(tokenFromBody: IModelRpcProps, _request: SerializedRpcRequest): IModelRpcProps { return tokenFromBody; }\n\n  /** Override to supply the status corresponding to a protocol-specific code value. */\n  public getStatus(code: number): RpcRequestStatus {\n    return code;\n  }\n\n  /** Override to supply the protocol-specific code corresponding to a status value. */\n  public getCode(status: RpcRequestStatus): number {\n    return status;\n  }\n\n  /** Override to supply the protocol-specific path value for an RPC operation. */\n  public supplyPathForOperation(operation: RpcOperation, _request: RpcRequest | undefined): string {\n    return JSON.stringify(operation);\n  }\n\n  /** Override to supply the operation for a protocol-specific path value. */\n  public getOperationFromPath(path: string): SerializedRpcOperation {\n    return JSON.parse(path);\n  }\n\n  /** Obtains the implementation result on the backend for an RPC operation request. */\n  public async fulfill(request: SerializedRpcRequest): Promise<RpcRequestFulfillment> {\n    return new (this.invocationType)(this, request).fulfillment;\n  }\n\n  /** Serializes a request. */\n  public async serialize(request: RpcRequest): Promise<SerializedRpcRequest> {\n    const serializedContext = await RpcConfiguration.requestContext.serialize(request);\n    return {\n      ...serializedContext,\n      operation: {\n        interfaceDefinition: request.operation.interfaceDefinition.interfaceName,\n        operationName: request.operation.operationName,\n        interfaceVersion: request.operation.interfaceVersion,\n      },\n      method: request.method,\n      path: request.path,\n      parameters: await RpcMarshaling.serialize(request.protocol, request.parameters),\n      caching: RpcResponseCacheControl.None,\n      protocolVersion: RpcProtocol.protocolVersion,\n    };\n  }\n\n  /** Constructs a protocol. */\n  public constructor(configuration: RpcConfiguration) {\n    this.configuration = configuration;\n    this.events.addListener((type, object) => RpcProtocol.events.raiseEvent(type, object));\n  }\n\n  /** @internal */\n  public onRpcClientInitialized(_definition: RpcInterfaceDefinition, _client: RpcInterface): void { }\n\n  /** @internal */\n  public onRpcImplInitialized(_definition: RpcInterfaceDefinition, _impl: RpcInterface): void { }\n\n  /** @internal */\n  public onRpcClientTerminated(_definition: RpcInterfaceDefinition, _client: RpcInterface): void { }\n\n  /** @internal */\n  public onRpcImplTerminated(_definition: RpcInterfaceDefinition, _impl: RpcInterface): void { }\n}\n"]}