@itwin/core-common 4.5.0-dev.4 → 4.5.0-dev.7

package/lib/esm/rpc/web/WebAppRpcProtocol.d.ts

@@ -12,7 +12,7 @@ import { OpenAPIInfo, OpenAPIParameter, RpcOpenAPIDescription } from "./OpenAPI"
 import { WebAppRpcRequest } from "./WebAppRpcRequest";
 /** An HTTP server request object.
  * @public
- * @deprecated in 3.6. The RPC system will be significantly refactored (or replaced) in version 5.0.
+ * @deprecated in 3.6. The RPC system will be significantly refactored (or replaced) in the future.
  */
 export interface HttpServerRequest extends BackendReadable {
     aborted: boolean;
@@ -46,7 +46,7 @@ export interface HttpServerRequest extends BackendReadable {
 }
 /** An HTTP server response object.
  * @public
- * @deprecated in 3.6. The RPC system will be significantly refactored (or replaced) in version 5.0.
+ * @deprecated in 3.6. The RPC system will be significantly refactored (or replaced) in the future.
  */
 export interface HttpServerResponse extends BackendWritable {
     send(body?: any): HttpServerResponse;

package/lib/esm/rpc/web/WebAppRpcProtocol.js.map

@@ -1 +1 @@
-{"version":3,"file":"WebAppRpcProtocol.js","sourceRoot":"","sources":["../../../../src/rpc/web/WebAppRpcProtocol.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAEH,OAAO,EAAE,YAAY,EAAE,MAAM,EAAE,MAAM,qBAAqB,CAAC;AAC3D,OAAO,EAAE,oBAAoB,EAAE,MAAM,4BAA4B,CAAC;AAGlE,OAAO,EAAE,cAAc,EAAE,gBAAgB,EAAE,iBAAiB,EAAE,MAAM,sBAAsB,CAAC;AAE3F,OAAO,EAAE,WAAW,EAAwB,MAAM,qBAAqB,CAAC;AACxE,OAAO,EAAiC,qBAAqB,EAAE,MAAM,WAAW,CAAC;AACjF,OAAO,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AACtD,OAAO,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AA6CtD;;GAEG;AACH,MAAM,OAAgB,iBAAkB,SAAQ,WAAW;IAGzD,+EAA+E;IACxE,KAAK,CAAC,yBAAyB,CAAC,GAAsB,EAAE,GAAuB;QACpF,OAAO,IAAI,CAAC,0BAA0B,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC;IACnD,CAAC;IAED,gFAAgF;IACzE,KAAK,CAAC,0BAA0B,CAAC,GAAsB,EAAE,GAAuB;QACrF,IAAI,OAA6B,CAAC;QAClC,IAAI;YACF,OAAO,GAAG,MAAM,gBAAgB,CAAC,YAAY,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC;SAC1D;QAAC,OAAO,KAAK,EAAE;YACd,MAAM,OAAO,GAAG,YAAY,CAAC,eAAe,CAAC,KAAK,CAAC,CAAC;YACpD,MAAM,CAAC,QAAQ,CAAC,oBAAoB,CAAC,mBAAmB,EAAE,4BAA4B,OAAO,EAAE,EAAE,YAAY,CAAC,gBAAgB,CAAC,KAAK,CAAC,CAAC,CAAC;YACvI,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;YAChB,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC;YACrD,OAAO;SACR;QACD,MAAM,WAAW,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;QAChD,MAAM,gBAAgB,CAAC,YAAY,CAAC,IAAI,EAAE,OAAO,EAAE,WAAW,EAAE,GAAG,EAAE,GAAG,CAAC,CAAC;IAC5E,CAAC;IAED,iFAAiF;IAC1E,+BAA+B,CAAC,IAAuB,EAAE,GAAuB;QACrF,MAAM,WAAW,GAAG,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,kBAAkB,CAAC,CAAC;QAC5D,GAAG,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;IACxB,CAAC;IAED,wEAAwE;IACjE,MAAM,CAAC,kBAAkB,CAAC,QAAmC;QAClE,IAAI,CAAC,QAAQ;YACX,OAAO,cAAc,CAAC,OAAO,CAAC;QAEhC,IAAI,QAAQ,CAAC,OAAO,CAAC,iBAAiB,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAE;YACtD,OAAO,cAAc,CAAC,IAAI,CAAC;SAC5B;aAAM,IAAI,QAAQ,CAAC,OAAO,CAAC,iBAAiB,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE;YAC3D,OAAO,cAAc,CAAC,MAAM,CAAC;SAC9B;aAAM,IAAI,QAAQ,CAAC,OAAO,CAAC,iBAAiB,CAAC,SAAS,CAAC,KAAK,CAAC,EAAE;YAC9D,OAAO,cAAc,CAAC,SAAS,CAAC;SACjC;aAAM;YACL,OAAO,cAAc,CAAC,OAAO,CAAC;SAC/B;IACH,CAAC;IAWD,2EAA2E;IAC3D,SAAS,CAAC,IAAY;QACpC,QAAQ,IAAI,EAAE;YACZ,KAAK,GAAG,CAAC,CAAC,OAAO,gBAAgB,CAAC,QAAQ,CAAC;YAC3C,KAAK,GAAG,CAAC,CAAC,OAAO,gBAAgB,CAAC,OAAO,CAAC;YAC1C,KAAK,GAAG,CAAC,CAAC,OAAO,gBAAgB,CAAC,QAAQ,CAAC;YAC3C,KAAK,GAAG,CAAC,CAAC,OAAO,gBAAgB,CAAC,QAAQ,CAAC;YAC3C,KAAK,GAAG,CAAC,CAAC,OAAO,gBAAgB,CAAC,SAAS,CAAC;YAC5C,KAAK,GAAG,CAAC,CAAC,OAAO,gBAAgB,CAAC,UAAU,CAAC;YAC7C,KAAK,GAAG,CAAC,CAAC,OAAO,gBAAgB,CAAC,kBAAkB,CAAC;YACrD,KAAK,GAAG,CAAC,CAAC,OAAO,gBAAgB,CAAC,cAAc,CAAC;YACjD,KAAK,GAAG,CAAC,CAAC,OAAO,gBAAgB,CAAC,cAAc,CAAC;YACjD,KAAK,GAAG,CAAC,CAAC,OAAO,gBAAgB,CAAC,eAAe,CAAC;YAClD,OAAO,CAAC,CAAC,OAAO,gBAAgB,CAAC,OAAO,CAAC;SAC1C;IACH,CAAC;IAED,2EAA2E;IAC3D,OAAO,CAAC,MAAwB;QAC9C,QAAQ,MAAM,EAAE;YACd,KAAK,gBAAgB,CAAC,QAAQ,CAAC,CAAC,OAAO,GAAG,CAAC;YAC3C,KAAK,gBAAgB,CAAC,OAAO,CAAC,CAAC,OAAO,GAAG,CAAC;YAC1C,KAAK,gBAAgB,CAAC,QAAQ,CAAC,CAAC,OAAO,GAAG,CAAC;YAC3C,KAAK,gBAAgB,CAAC,QAAQ,CAAC,CAAC,OAAO,GAAG,CAAC;YAC3C,KAAK,gBAAgB,CAAC,SAAS,CAAC,CAAC,OAAO,GAAG,CAAC;YAC5C,KAAK,gBAAgB,CAAC,UAAU,CAAC,CAAC,OAAO,GAAG,CAAC;YAC7C,KAAK,gBAAgB,CAAC,kBAAkB,CAAC,CAAC,OAAO,GAAG,CAAC;YACrD,KAAK,gBAAgB,CAAC,cAAc,CAAC,CAAC,OAAO,GAAG,CAAC;YACjD,KAAK,gBAAgB,CAAC,cAAc,CAAC,CAAC,OAAO,GAAG,CAAC;YACjD,KAAK,gBAAgB,CAAC,eAAe,CAAC,CAAC,OAAO,GAAG,CAAC;YAClD,OAAO,CAAC,CAAC,OAAO,GAAG,CAAC;SACrB;IACH,CAAC;IAID,+DAA+D;IACxD,SAAS,CAAC,IAAY;QAC3B,OAAO,IAAI,KAAK,GAAG,CAAC;IACtB,CAAC;IAED;;OAEG;IACH,IAAW,kBAAkB,KAAK,OAAO,IAAI,qBAAqB,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IAO3E,mCAAmC;IACnC,YAAmB,aAA+B;QAChD,KAAK,CAAC,aAAa,CAAC,CAAC;QA3GP,oBAAe,GAAG,IAAI,CAAC;QAgDvC,sDAAsD;QAC/C,eAAU,GAAW,EAAE,CAAC;QAE/B,+CAA+C;QAC/B,gBAAW,GAAG,gBAAgB,CAAC;QAoC/B,2BAAsB,GAAG,IAAI,CAAC;QAoB5C,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC,KAAK,EAAE,KAAK,EAAE,MAAM,EAAE,EAAE,CAAC,gBAAgB,CAAC,gBAAgB,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC,CAAC;IACrG,CAAC;CACF","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 { BentleyError, Logger } from \"@itwin/core-bentley\";\r\nimport { CommonLoggerCategory } from \"../../CommonLoggerCategory\";\r\nimport { BackendReadable, BackendWritable } from \"../../BackendTypes\";\r\nimport { RpcConfiguration } from \"../core/RpcConfiguration\";\r\nimport { RpcContentType, RpcRequestStatus, WEB_RPC_CONSTANTS } from \"../core/RpcConstants\";\r\nimport { RpcOperation } from \"../core/RpcOperation\";\r\nimport { RpcProtocol, SerializedRpcRequest } from \"../core/RpcProtocol\";\r\nimport { OpenAPIInfo, OpenAPIParameter, RpcOpenAPIDescription } from \"./OpenAPI\";\r\nimport { WebAppRpcLogging } from \"./WebAppRpcLogging\";\r\nimport { WebAppRpcRequest } from \"./WebAppRpcRequest\";\r\n\r\n/* eslint-disable deprecation/deprecation */\r\n\r\n/** An HTTP server request object.\r\n * @public\r\n * @deprecated in 3.6. The RPC system will be significantly refactored (or replaced) in version 5.0.\r\n */\r\nexport interface HttpServerRequest extends BackendReadable {\r\n  aborted: boolean;\r\n  httpVersion: string;\r\n  httpVersionMajor: number;\r\n  httpVersionMinor: number;\r\n  complete: boolean;\r\n  connection: any;\r\n  headers: { [header: string]: string | string[] | undefined };\r\n  rawHeaders: string[];\r\n  trailers: { [key: string]: string | undefined };\r\n  trailersDistinct: NodeJS.Dict<string[]>;\r\n  rawTrailers: string[];\r\n  setTimeout(msecs: number, callback: () => void): void;\r\n  setTimeout(msecs: number, callback: () => void): this;\r\n  url?: string;\r\n  statusCode?: number;\r\n  statusMessage?: string;\r\n  socket: any;\r\n  destroy(error?: Error): this;\r\n  body: string | Buffer;\r\n  path: string;\r\n  method: string;\r\n  ip?: string;\r\n  header: (field: string) => string | undefined;\r\n  headersDistinct: NodeJS.Dict<string[]>;\r\n}\r\n\r\n/** An HTTP server response object.\r\n * @public\r\n * @deprecated in 3.6. The RPC system will be significantly refactored (or replaced) in version 5.0.\r\n */\r\nexport interface HttpServerResponse extends BackendWritable {\r\n  send(body?: any): HttpServerResponse;\r\n  status(code: number): HttpServerResponse;\r\n  set(field: string, value: string): void;\r\n}\r\n\r\n/** The HTTP application protocol.\r\n * @internal\r\n */\r\nexport abstract class WebAppRpcProtocol extends RpcProtocol {\r\n  public override preserveStreams = true;\r\n\r\n  /** Convenience handler for an RPC operation get request for an HTTP server. */\r\n  public async handleOperationGetRequest(req: HttpServerRequest, res: HttpServerResponse) {\r\n    return this.handleOperationPostRequest(req, res);\r\n  }\r\n\r\n  /** Convenience handler for an RPC operation post request for an HTTP server. */\r\n  public async handleOperationPostRequest(req: HttpServerRequest, res: HttpServerResponse) {\r\n    let request: SerializedRpcRequest;\r\n    try {\r\n      request = await WebAppRpcRequest.parseRequest(this, req);\r\n    } catch (error) {\r\n      const message = BentleyError.getErrorMessage(error);\r\n      Logger.logError(CommonLoggerCategory.RpcInterfaceBackend, `Failed to parse request: ${message}`, BentleyError.getErrorMetadata(error));\r\n      res.status(400);\r\n      res.send(JSON.stringify({ message, isError: true }));\r\n      return;\r\n    }\r\n    const fulfillment = await this.fulfill(request);\r\n    await WebAppRpcRequest.sendResponse(this, request, fulfillment, req, res);\r\n  }\r\n\r\n  /** Convenience handler for an OpenAPI description request for an HTTP server. */\r\n  public handleOpenApiDescriptionRequest(_req: HttpServerRequest, res: HttpServerResponse) {\r\n    const description = JSON.stringify(this.openAPIDescription);\r\n    res.send(description);\r\n  }\r\n\r\n  /** Converts an HTTP content type value to an RPC content type value. */\r\n  public static computeContentType(httpType: string | null | undefined): RpcContentType {\r\n    if (!httpType)\r\n      return RpcContentType.Unknown;\r\n\r\n    if (httpType.indexOf(WEB_RPC_CONSTANTS.ANY_TEXT) === 0) {\r\n      return RpcContentType.Text;\r\n    } else if (httpType.indexOf(WEB_RPC_CONSTANTS.BINARY) === 0) {\r\n      return RpcContentType.Binary;\r\n    } else if (httpType.indexOf(WEB_RPC_CONSTANTS.MULTIPART) === 0) {\r\n      return RpcContentType.Multipart;\r\n    } else {\r\n      return RpcContentType.Unknown;\r\n    }\r\n  }\r\n\r\n  /** The OpenAPI-compatible info object for this protocol. */\r\n  public abstract info: OpenAPIInfo;\r\n\r\n  /** An optional prefix for RPC operation URI paths. */\r\n  public pathPrefix: string = \"\";\r\n\r\n  /** The RPC request class for this protocol. */\r\n  public readonly requestType = WebAppRpcRequest;\r\n\r\n  /** Supplies the status corresponding to a protocol-specific code value. */\r\n  public override getStatus(code: number): RpcRequestStatus {\r\n    switch (code) {\r\n      case 404: return RpcRequestStatus.NotFound;\r\n      case 202: return RpcRequestStatus.Pending;\r\n      case 200: return RpcRequestStatus.Resolved;\r\n      case 500: return RpcRequestStatus.Rejected;\r\n      case 204: return RpcRequestStatus.NoContent;\r\n      case 502: return RpcRequestStatus.BadGateway;\r\n      case 503: return RpcRequestStatus.ServiceUnavailable;\r\n      case 504: return RpcRequestStatus.GatewayTimeout;\r\n      case 408: return RpcRequestStatus.RequestTimeout;\r\n      case 429: return RpcRequestStatus.TooManyRequests;\r\n      default: return RpcRequestStatus.Unknown;\r\n    }\r\n  }\r\n\r\n  /** Supplies the protocol-specific code corresponding to a status value. */\r\n  public override getCode(status: RpcRequestStatus): number {\r\n    switch (status) {\r\n      case RpcRequestStatus.NotFound: return 404;\r\n      case RpcRequestStatus.Pending: return 202;\r\n      case RpcRequestStatus.Resolved: return 200;\r\n      case RpcRequestStatus.Rejected: return 500;\r\n      case RpcRequestStatus.NoContent: return 204;\r\n      case RpcRequestStatus.BadGateway: return 502;\r\n      case RpcRequestStatus.ServiceUnavailable: return 503;\r\n      case RpcRequestStatus.GatewayTimeout: return 504;\r\n      case RpcRequestStatus.RequestTimeout: return 408;\r\n      case RpcRequestStatus.TooManyRequests: return 429;\r\n      default: return 501;\r\n    }\r\n  }\r\n\r\n  public override supportsStatusCategory = true;\r\n\r\n  /** Whether an HTTP status code indicates a request timeout. */\r\n  public isTimeout(code: number): boolean {\r\n    return code === 504;\r\n  }\r\n\r\n  /** An OpenAPI-compatible description of this protocol.\r\n   * @internal\r\n   */\r\n  public get openAPIDescription() { return new RpcOpenAPIDescription(this); }\r\n\r\n  /** Returns the OpenAPI-compatible URI path parameters for an RPC operation.\r\n   * @internal\r\n   */\r\n  public abstract supplyPathParametersForOperation(_operation: RpcOperation): OpenAPIParameter[];\r\n\r\n  /** Constructs an HTTP protocol. */\r\n  public constructor(configuration: RpcConfiguration) {\r\n    super(configuration);\r\n    this.events.addListener(async (event, object) => WebAppRpcLogging.logProtocolEvent(event, object));\r\n  }\r\n}\r\n"]}
+{"version":3,"file":"WebAppRpcProtocol.js","sourceRoot":"","sources":["../../../../src/rpc/web/WebAppRpcProtocol.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAEH,OAAO,EAAE,YAAY,EAAE,MAAM,EAAE,MAAM,qBAAqB,CAAC;AAC3D,OAAO,EAAE,oBAAoB,EAAE,MAAM,4BAA4B,CAAC;AAGlE,OAAO,EAAE,cAAc,EAAE,gBAAgB,EAAE,iBAAiB,EAAE,MAAM,sBAAsB,CAAC;AAE3F,OAAO,EAAE,WAAW,EAAwB,MAAM,qBAAqB,CAAC;AACxE,OAAO,EAAiC,qBAAqB,EAAE,MAAM,WAAW,CAAC;AACjF,OAAO,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AACtD,OAAO,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AA6CtD;;GAEG;AACH,MAAM,OAAgB,iBAAkB,SAAQ,WAAW;IAGzD,+EAA+E;IACxE,KAAK,CAAC,yBAAyB,CAAC,GAAsB,EAAE,GAAuB;QACpF,OAAO,IAAI,CAAC,0BAA0B,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC;IACnD,CAAC;IAED,gFAAgF;IACzE,KAAK,CAAC,0BAA0B,CAAC,GAAsB,EAAE,GAAuB;QACrF,IAAI,OAA6B,CAAC;QAClC,IAAI;YACF,OAAO,GAAG,MAAM,gBAAgB,CAAC,YAAY,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC;SAC1D;QAAC,OAAO,KAAK,EAAE;YACd,MAAM,OAAO,GAAG,YAAY,CAAC,eAAe,CAAC,KAAK,CAAC,CAAC;YACpD,MAAM,CAAC,QAAQ,CAAC,oBAAoB,CAAC,mBAAmB,EAAE,4BAA4B,OAAO,EAAE,EAAE,YAAY,CAAC,gBAAgB,CAAC,KAAK,CAAC,CAAC,CAAC;YACvI,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;YAChB,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC;YACrD,OAAO;SACR;QACD,MAAM,WAAW,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;QAChD,MAAM,gBAAgB,CAAC,YAAY,CAAC,IAAI,EAAE,OAAO,EAAE,WAAW,EAAE,GAAG,EAAE,GAAG,CAAC,CAAC;IAC5E,CAAC;IAED,iFAAiF;IAC1E,+BAA+B,CAAC,IAAuB,EAAE,GAAuB;QACrF,MAAM,WAAW,GAAG,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,kBAAkB,CAAC,CAAC;QAC5D,GAAG,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;IACxB,CAAC;IAED,wEAAwE;IACjE,MAAM,CAAC,kBAAkB,CAAC,QAAmC;QAClE,IAAI,CAAC,QAAQ;YACX,OAAO,cAAc,CAAC,OAAO,CAAC;QAEhC,IAAI,QAAQ,CAAC,OAAO,CAAC,iBAAiB,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAE;YACtD,OAAO,cAAc,CAAC,IAAI,CAAC;SAC5B;aAAM,IAAI,QAAQ,CAAC,OAAO,CAAC,iBAAiB,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE;YAC3D,OAAO,cAAc,CAAC,MAAM,CAAC;SAC9B;aAAM,IAAI,QAAQ,CAAC,OAAO,CAAC,iBAAiB,CAAC,SAAS,CAAC,KAAK,CAAC,EAAE;YAC9D,OAAO,cAAc,CAAC,SAAS,CAAC;SACjC;aAAM;YACL,OAAO,cAAc,CAAC,OAAO,CAAC;SAC/B;IACH,CAAC;IAWD,2EAA2E;IAC3D,SAAS,CAAC,IAAY;QACpC,QAAQ,IAAI,EAAE;YACZ,KAAK,GAAG,CAAC,CAAC,OAAO,gBAAgB,CAAC,QAAQ,CAAC;YAC3C,KAAK,GAAG,CAAC,CAAC,OAAO,gBAAgB,CAAC,OAAO,CAAC;YAC1C,KAAK,GAAG,CAAC,CAAC,OAAO,gBAAgB,CAAC,QAAQ,CAAC;YAC3C,KAAK,GAAG,CAAC,CAAC,OAAO,gBAAgB,CAAC,QAAQ,CAAC;YAC3C,KAAK,GAAG,CAAC,CAAC,OAAO,gBAAgB,CAAC,SAAS,CAAC;YAC5C,KAAK,GAAG,CAAC,CAAC,OAAO,gBAAgB,CAAC,UAAU,CAAC;YAC7C,KAAK,GAAG,CAAC,CAAC,OAAO,gBAAgB,CAAC,kBAAkB,CAAC;YACrD,KAAK,GAAG,CAAC,CAAC,OAAO,gBAAgB,CAAC,cAAc,CAAC;YACjD,KAAK,GAAG,CAAC,CAAC,OAAO,gBAAgB,CAAC,cAAc,CAAC;YACjD,KAAK,GAAG,CAAC,CAAC,OAAO,gBAAgB,CAAC,eAAe,CAAC;YAClD,OAAO,CAAC,CAAC,OAAO,gBAAgB,CAAC,OAAO,CAAC;SAC1C;IACH,CAAC;IAED,2EAA2E;IAC3D,OAAO,CAAC,MAAwB;QAC9C,QAAQ,MAAM,EAAE;YACd,KAAK,gBAAgB,CAAC,QAAQ,CAAC,CAAC,OAAO,GAAG,CAAC;YAC3C,KAAK,gBAAgB,CAAC,OAAO,CAAC,CAAC,OAAO,GAAG,CAAC;YAC1C,KAAK,gBAAgB,CAAC,QAAQ,CAAC,CAAC,OAAO,GAAG,CAAC;YAC3C,KAAK,gBAAgB,CAAC,QAAQ,CAAC,CAAC,OAAO,GAAG,CAAC;YAC3C,KAAK,gBAAgB,CAAC,SAAS,CAAC,CAAC,OAAO,GAAG,CAAC;YAC5C,KAAK,gBAAgB,CAAC,UAAU,CAAC,CAAC,OAAO,GAAG,CAAC;YAC7C,KAAK,gBAAgB,CAAC,kBAAkB,CAAC,CAAC,OAAO,GAAG,CAAC;YACrD,KAAK,gBAAgB,CAAC,cAAc,CAAC,CAAC,OAAO,GAAG,CAAC;YACjD,KAAK,gBAAgB,CAAC,cAAc,CAAC,CAAC,OAAO,GAAG,CAAC;YACjD,KAAK,gBAAgB,CAAC,eAAe,CAAC,CAAC,OAAO,GAAG,CAAC;YAClD,OAAO,CAAC,CAAC,OAAO,GAAG,CAAC;SACrB;IACH,CAAC;IAID,+DAA+D;IACxD,SAAS,CAAC,IAAY;QAC3B,OAAO,IAAI,KAAK,GAAG,CAAC;IACtB,CAAC;IAED;;OAEG;IACH,IAAW,kBAAkB,KAAK,OAAO,IAAI,qBAAqB,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IAO3E,mCAAmC;IACnC,YAAmB,aAA+B;QAChD,KAAK,CAAC,aAAa,CAAC,CAAC;QA3GP,oBAAe,GAAG,IAAI,CAAC;QAgDvC,sDAAsD;QAC/C,eAAU,GAAW,EAAE,CAAC;QAE/B,+CAA+C;QAC/B,gBAAW,GAAG,gBAAgB,CAAC;QAoC/B,2BAAsB,GAAG,IAAI,CAAC;QAoB5C,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC,KAAK,EAAE,KAAK,EAAE,MAAM,EAAE,EAAE,CAAC,gBAAgB,CAAC,gBAAgB,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC,CAAC;IACrG,CAAC;CACF","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 { BentleyError, Logger } from \"@itwin/core-bentley\";\r\nimport { CommonLoggerCategory } from \"../../CommonLoggerCategory\";\r\nimport { BackendReadable, BackendWritable } from \"../../BackendTypes\";\r\nimport { RpcConfiguration } from \"../core/RpcConfiguration\";\r\nimport { RpcContentType, RpcRequestStatus, WEB_RPC_CONSTANTS } from \"../core/RpcConstants\";\r\nimport { RpcOperation } from \"../core/RpcOperation\";\r\nimport { RpcProtocol, SerializedRpcRequest } from \"../core/RpcProtocol\";\r\nimport { OpenAPIInfo, OpenAPIParameter, RpcOpenAPIDescription } from \"./OpenAPI\";\r\nimport { WebAppRpcLogging } from \"./WebAppRpcLogging\";\r\nimport { WebAppRpcRequest } from \"./WebAppRpcRequest\";\r\n\r\n/* eslint-disable deprecation/deprecation */\r\n\r\n/** An HTTP server request object.\r\n * @public\r\n * @deprecated in 3.6. The RPC system will be significantly refactored (or replaced) in the future.\r\n */\r\nexport interface HttpServerRequest extends BackendReadable {\r\n  aborted: boolean;\r\n  httpVersion: string;\r\n  httpVersionMajor: number;\r\n  httpVersionMinor: number;\r\n  complete: boolean;\r\n  connection: any;\r\n  headers: { [header: string]: string | string[] | undefined };\r\n  rawHeaders: string[];\r\n  trailers: { [key: string]: string | undefined };\r\n  trailersDistinct: NodeJS.Dict<string[]>;\r\n  rawTrailers: string[];\r\n  setTimeout(msecs: number, callback: () => void): void;\r\n  setTimeout(msecs: number, callback: () => void): this;\r\n  url?: string;\r\n  statusCode?: number;\r\n  statusMessage?: string;\r\n  socket: any;\r\n  destroy(error?: Error): this;\r\n  body: string | Buffer;\r\n  path: string;\r\n  method: string;\r\n  ip?: string;\r\n  header: (field: string) => string | undefined;\r\n  headersDistinct: NodeJS.Dict<string[]>;\r\n}\r\n\r\n/** An HTTP server response object.\r\n * @public\r\n * @deprecated in 3.6. The RPC system will be significantly refactored (or replaced) in the future.\r\n */\r\nexport interface HttpServerResponse extends BackendWritable {\r\n  send(body?: any): HttpServerResponse;\r\n  status(code: number): HttpServerResponse;\r\n  set(field: string, value: string): void;\r\n}\r\n\r\n/** The HTTP application protocol.\r\n * @internal\r\n */\r\nexport abstract class WebAppRpcProtocol extends RpcProtocol {\r\n  public override preserveStreams = true;\r\n\r\n  /** Convenience handler for an RPC operation get request for an HTTP server. */\r\n  public async handleOperationGetRequest(req: HttpServerRequest, res: HttpServerResponse) {\r\n    return this.handleOperationPostRequest(req, res);\r\n  }\r\n\r\n  /** Convenience handler for an RPC operation post request for an HTTP server. */\r\n  public async handleOperationPostRequest(req: HttpServerRequest, res: HttpServerResponse) {\r\n    let request: SerializedRpcRequest;\r\n    try {\r\n      request = await WebAppRpcRequest.parseRequest(this, req);\r\n    } catch (error) {\r\n      const message = BentleyError.getErrorMessage(error);\r\n      Logger.logError(CommonLoggerCategory.RpcInterfaceBackend, `Failed to parse request: ${message}`, BentleyError.getErrorMetadata(error));\r\n      res.status(400);\r\n      res.send(JSON.stringify({ message, isError: true }));\r\n      return;\r\n    }\r\n    const fulfillment = await this.fulfill(request);\r\n    await WebAppRpcRequest.sendResponse(this, request, fulfillment, req, res);\r\n  }\r\n\r\n  /** Convenience handler for an OpenAPI description request for an HTTP server. */\r\n  public handleOpenApiDescriptionRequest(_req: HttpServerRequest, res: HttpServerResponse) {\r\n    const description = JSON.stringify(this.openAPIDescription);\r\n    res.send(description);\r\n  }\r\n\r\n  /** Converts an HTTP content type value to an RPC content type value. */\r\n  public static computeContentType(httpType: string | null | undefined): RpcContentType {\r\n    if (!httpType)\r\n      return RpcContentType.Unknown;\r\n\r\n    if (httpType.indexOf(WEB_RPC_CONSTANTS.ANY_TEXT) === 0) {\r\n      return RpcContentType.Text;\r\n    } else if (httpType.indexOf(WEB_RPC_CONSTANTS.BINARY) === 0) {\r\n      return RpcContentType.Binary;\r\n    } else if (httpType.indexOf(WEB_RPC_CONSTANTS.MULTIPART) === 0) {\r\n      return RpcContentType.Multipart;\r\n    } else {\r\n      return RpcContentType.Unknown;\r\n    }\r\n  }\r\n\r\n  /** The OpenAPI-compatible info object for this protocol. */\r\n  public abstract info: OpenAPIInfo;\r\n\r\n  /** An optional prefix for RPC operation URI paths. */\r\n  public pathPrefix: string = \"\";\r\n\r\n  /** The RPC request class for this protocol. */\r\n  public readonly requestType = WebAppRpcRequest;\r\n\r\n  /** Supplies the status corresponding to a protocol-specific code value. */\r\n  public override getStatus(code: number): RpcRequestStatus {\r\n    switch (code) {\r\n      case 404: return RpcRequestStatus.NotFound;\r\n      case 202: return RpcRequestStatus.Pending;\r\n      case 200: return RpcRequestStatus.Resolved;\r\n      case 500: return RpcRequestStatus.Rejected;\r\n      case 204: return RpcRequestStatus.NoContent;\r\n      case 502: return RpcRequestStatus.BadGateway;\r\n      case 503: return RpcRequestStatus.ServiceUnavailable;\r\n      case 504: return RpcRequestStatus.GatewayTimeout;\r\n      case 408: return RpcRequestStatus.RequestTimeout;\r\n      case 429: return RpcRequestStatus.TooManyRequests;\r\n      default: return RpcRequestStatus.Unknown;\r\n    }\r\n  }\r\n\r\n  /** Supplies the protocol-specific code corresponding to a status value. */\r\n  public override getCode(status: RpcRequestStatus): number {\r\n    switch (status) {\r\n      case RpcRequestStatus.NotFound: return 404;\r\n      case RpcRequestStatus.Pending: return 202;\r\n      case RpcRequestStatus.Resolved: return 200;\r\n      case RpcRequestStatus.Rejected: return 500;\r\n      case RpcRequestStatus.NoContent: return 204;\r\n      case RpcRequestStatus.BadGateway: return 502;\r\n      case RpcRequestStatus.ServiceUnavailable: return 503;\r\n      case RpcRequestStatus.GatewayTimeout: return 504;\r\n      case RpcRequestStatus.RequestTimeout: return 408;\r\n      case RpcRequestStatus.TooManyRequests: return 429;\r\n      default: return 501;\r\n    }\r\n  }\r\n\r\n  public override supportsStatusCategory = true;\r\n\r\n  /** Whether an HTTP status code indicates a request timeout. */\r\n  public isTimeout(code: number): boolean {\r\n    return code === 504;\r\n  }\r\n\r\n  /** An OpenAPI-compatible description of this protocol.\r\n   * @internal\r\n   */\r\n  public get openAPIDescription() { return new RpcOpenAPIDescription(this); }\r\n\r\n  /** Returns the OpenAPI-compatible URI path parameters for an RPC operation.\r\n   * @internal\r\n   */\r\n  public abstract supplyPathParametersForOperation(_operation: RpcOperation): OpenAPIParameter[];\r\n\r\n  /** Constructs an HTTP protocol. */\r\n  public constructor(configuration: RpcConfiguration) {\r\n    super(configuration);\r\n    this.events.addListener(async (event, object) => WebAppRpcLogging.logProtocolEvent(event, object));\r\n  }\r\n}\r\n"]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@itwin/core-common",
-  "version": "4.5.0-dev.4",
+  "version": "4.5.0-dev.7",
   "description": "iTwin.js components common to frontend and backend",
   "main": "lib/cjs/core-common.js",
   "module": "lib/esm/core-common.js",
@@ -27,8 +27,8 @@
     "js-base64": "^3.6.1"
   },
   "peerDependencies": {
-    "@itwin/core-bentley": "^4.5.0-dev.4",
-    "@itwin/core-geometry": "^4.5.0-dev.4"
+    "@itwin/core-bentley": "^4.5.0-dev.7",
+    "@itwin/core-geometry": "^4.5.0-dev.7"
   },
   "devDependencies": {
     "@itwin/eslint-plugin": "4.0.0-dev.44",
@@ -42,9 +42,9 @@
     "nyc": "^15.1.0",
     "rimraf": "^3.0.2",
     "typescript": "~5.0.2",
-    "@itwin/build-tools": "4.5.0-dev.4",
-    "@itwin/core-bentley": "4.5.0-dev.4",
-    "@itwin/core-geometry": "4.5.0-dev.4"
+    "@itwin/build-tools": "4.5.0-dev.7",
+    "@itwin/core-geometry": "4.5.0-dev.7",
+    "@itwin/core-bentley": "4.5.0-dev.7"
   },
   "nyc": {
     "extends": "./node_modules/@itwin/build-tools/.nycrc",