@itwin/core-common 3.4.0-dev.9 → 3.5.0-dev.5

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

@@ -1,97 +1,113 @@
-/*---------------------------------------------------------------------------------------------
-* 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 { RpcContentType, RpcRequestStatus, WEB_RPC_CONSTANTS } from "../core/RpcConstants";
-import { RpcProtocol } from "../core/RpcProtocol";
-import { RpcOpenAPIDescription } from "./OpenAPI";
-import { WebAppRpcLogging } from "./WebAppRpcLogging";
-import { WebAppRpcRequest } from "./WebAppRpcRequest";
-/** The HTTP application protocol.
- * @internal
- */
-export class WebAppRpcProtocol extends RpcProtocol {
-    /** Constructs an HTTP protocol. */
-    constructor(configuration) {
-        super(configuration);
-        this.preserveStreams = true;
-        /** An optional prefix for RPC operation URI paths. */
-        this.pathPrefix = "";
-        /** The RPC request class for this protocol. */
-        this.requestType = WebAppRpcRequest;
-        this.supportsStatusCategory = true;
-        this.events.addListener(WebAppRpcLogging.logProtocolEvent);
-    }
-    /** Convenience handler for an RPC operation get request for an HTTP server. */
-    async handleOperationGetRequest(req, res) {
-        return this.handleOperationPostRequest(req, res);
-    }
-    /** Convenience handler for an RPC operation post request for an HTTP server. */
-    async handleOperationPostRequest(req, res) {
-        const request = await WebAppRpcRequest.parseRequest(this, req);
-        const fulfillment = await this.fulfill(request);
-        await WebAppRpcRequest.sendResponse(this, request, fulfillment, req, res);
-    }
-    /** Convenience handler for an OpenAPI description request for an HTTP server. */
-    handleOpenApiDescriptionRequest(_req, res) {
-        const description = JSON.stringify(this.openAPIDescription);
-        res.send(description);
-    }
-    /** Converts an HTTP content type value to an RPC content type value. */
-    static computeContentType(httpType) {
-        if (!httpType)
-            return RpcContentType.Unknown;
-        if (httpType.indexOf(WEB_RPC_CONSTANTS.ANY_TEXT) === 0) {
-            return RpcContentType.Text;
-        }
-        else if (httpType.indexOf(WEB_RPC_CONSTANTS.BINARY) === 0) {
-            return RpcContentType.Binary;
-        }
-        else if (httpType.indexOf(WEB_RPC_CONSTANTS.MULTIPART) === 0) {
-            return RpcContentType.Multipart;
-        }
-        else {
-            return RpcContentType.Unknown;
-        }
-    }
-    /** Supplies the status corresponding to a protocol-specific code value. */
-    getStatus(code) {
-        switch (code) {
-            case 404: return RpcRequestStatus.NotFound;
-            case 202: return RpcRequestStatus.Pending;
-            case 200: return RpcRequestStatus.Resolved;
-            case 500: return RpcRequestStatus.Rejected;
-            case 204: return RpcRequestStatus.NoContent;
-            case 502: return RpcRequestStatus.BadGateway;
-            case 503: return RpcRequestStatus.ServiceUnavailable;
-            case 504: return RpcRequestStatus.GatewayTimeout;
-            default: return RpcRequestStatus.Unknown;
-        }
-    }
-    /** Supplies the protocol-specific code corresponding to a status value. */
-    getCode(status) {
-        switch (status) {
-            case RpcRequestStatus.NotFound: return 404;
-            case RpcRequestStatus.Pending: return 202;
-            case RpcRequestStatus.Resolved: return 200;
-            case RpcRequestStatus.Rejected: return 500;
-            case RpcRequestStatus.NoContent: return 204;
-            case RpcRequestStatus.BadGateway: return 502;
-            case RpcRequestStatus.ServiceUnavailable: return 503;
-            case RpcRequestStatus.GatewayTimeout: return 504;
-            default: return 501;
-        }
-    }
-    /** Whether an HTTP status code indicates a request timeout. */
-    isTimeout(code) {
-        return code === 504;
-    }
-    /** An OpenAPI-compatible description of this protocol.
-     * @internal
-     */
-    get openAPIDescription() { return new RpcOpenAPIDescription(this); }
-}
+/*---------------------------------------------------------------------------------------------
+* 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 { BentleyError, Logger } from "@itwin/core-bentley";
+import { CommonLoggerCategory } from "../../CommonLoggerCategory";
+import { RpcContentType, RpcRequestStatus, WEB_RPC_CONSTANTS } from "../core/RpcConstants";
+import { RpcProtocol } from "../core/RpcProtocol";
+import { RpcOpenAPIDescription } from "./OpenAPI";
+import { WebAppRpcLogging } from "./WebAppRpcLogging";
+import { WebAppRpcRequest } from "./WebAppRpcRequest";
+/** The HTTP application protocol.
+ * @internal
+ */
+export class WebAppRpcProtocol extends RpcProtocol {
+    /** Constructs an HTTP protocol. */
+    constructor(configuration) {
+        super(configuration);
+        this.preserveStreams = true;
+        /** An optional prefix for RPC operation URI paths. */
+        this.pathPrefix = "";
+        /** The RPC request class for this protocol. */
+        this.requestType = WebAppRpcRequest;
+        this.supportsStatusCategory = true;
+        this.events.addListener(WebAppRpcLogging.logProtocolEvent);
+    }
+    /** Convenience handler for an RPC operation get request for an HTTP server. */
+    async handleOperationGetRequest(req, res) {
+        return this.handleOperationPostRequest(req, res);
+    }
+    /** Convenience handler for an RPC operation post request for an HTTP server. */
+    async handleOperationPostRequest(req, res) {
+        let request;
+        try {
+            request = await WebAppRpcRequest.parseRequest(this, req);
+        }
+        catch (error) {
+            const message = BentleyError.getErrorMessage(error);
+            Logger.logError(CommonLoggerCategory.RpcInterfaceBackend, `Failed to parse request: ${message}`, BentleyError.getErrorMetadata(error));
+            res.status(400);
+            res.send(JSON.stringify({ message, isError: true }));
+            return;
+        }
+        const fulfillment = await this.fulfill(request);
+        await WebAppRpcRequest.sendResponse(this, request, fulfillment, req, res);
+    }
+    /** Convenience handler for an OpenAPI description request for an HTTP server. */
+    handleOpenApiDescriptionRequest(_req, res) {
+        const description = JSON.stringify(this.openAPIDescription);
+        res.send(description);
+    }
+    /** Converts an HTTP content type value to an RPC content type value. */
+    static computeContentType(httpType) {
+        if (!httpType)
+            return RpcContentType.Unknown;
+        if (httpType.indexOf(WEB_RPC_CONSTANTS.ANY_TEXT) === 0) {
+            return RpcContentType.Text;
+        }
+        else if (httpType.indexOf(WEB_RPC_CONSTANTS.BINARY) === 0) {
+            return RpcContentType.Binary;
+        }
+        else if (httpType.indexOf(WEB_RPC_CONSTANTS.MULTIPART) === 0) {
+            return RpcContentType.Multipart;
+        }
+        else {
+            return RpcContentType.Unknown;
+        }
+    }
+    /** Supplies the status corresponding to a protocol-specific code value. */
+    getStatus(code) {
+        switch (code) {
+            case 404: return RpcRequestStatus.NotFound;
+            case 202: return RpcRequestStatus.Pending;
+            case 200: return RpcRequestStatus.Resolved;
+            case 500: return RpcRequestStatus.Rejected;
+            case 204: return RpcRequestStatus.NoContent;
+            case 502: return RpcRequestStatus.BadGateway;
+            case 503: return RpcRequestStatus.ServiceUnavailable;
+            case 504: return RpcRequestStatus.GatewayTimeout;
+            case 408: return RpcRequestStatus.RequestTimeout;
+            case 429: return RpcRequestStatus.TooManyRequests;
+            default: return RpcRequestStatus.Unknown;
+        }
+    }
+    /** Supplies the protocol-specific code corresponding to a status value. */
+    getCode(status) {
+        switch (status) {
+            case RpcRequestStatus.NotFound: return 404;
+            case RpcRequestStatus.Pending: return 202;
+            case RpcRequestStatus.Resolved: return 200;
+            case RpcRequestStatus.Rejected: return 500;
+            case RpcRequestStatus.NoContent: return 204;
+            case RpcRequestStatus.BadGateway: return 502;
+            case RpcRequestStatus.ServiceUnavailable: return 503;
+            case RpcRequestStatus.GatewayTimeout: return 504;
+            case RpcRequestStatus.RequestTimeout: return 408;
+            case RpcRequestStatus.TooManyRequests: return 429;
+            default: return 501;
+        }
+    }
+    /** Whether an HTTP status code indicates a request timeout. */
+    isTimeout(code) {
+        return code === 504;
+    }
+    /** An OpenAPI-compatible description of this protocol.
+     * @internal
+     */
+    get openAPIDescription() { return new RpcOpenAPIDescription(this); }
+}
 //# sourceMappingURL=WebAppRpcProtocol.js.map

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;AAIH,OAAO,EAAE,cAAc,EAAE,gBAAgB,EAAE,iBAAiB,EAAE,MAAM,sBAAsB,CAAC;AAE3F,OAAO,EAAE,WAAW,EAAE,MAAM,qBAAqB,CAAC;AAClD,OAAO,EAAiC,qBAAqB,EAAE,MAAM,WAAW,CAAC;AACjF,OAAO,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AACtD,OAAO,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AAsCtD;;GAEG;AACH,MAAM,OAAgB,iBAAkB,SAAQ,WAAW;IA6FzD,mCAAmC;IACnC,YAAmB,aAA+B;QAChD,KAAK,CAAC,aAAa,CAAC,CAAC;QA9FP,oBAAe,GAAG,IAAI,CAAC;QAuCvC,sDAAsD;QAC/C,eAAU,GAAW,EAAE,CAAC;QAE/B,+CAA+C;QAC/B,gBAAW,GAAG,gBAAgB,CAAC;QAgC/B,2BAAsB,GAAG,IAAI,CAAC;QAoB5C,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC,gBAAgB,CAAC,gBAAgB,CAAC,CAAC;IAC7D,CAAC;IA9FD,+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,MAAM,OAAO,GAAG,MAAM,gBAAgB,CAAC,YAAY,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC;QAC/D,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,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,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;CAY5E","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 { Readable, Writable } from \"stream\";\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 } from \"../core/RpcProtocol\";\r\nimport { OpenAPIInfo, OpenAPIParameter, RpcOpenAPIDescription } from \"./OpenAPI\";\r\nimport { WebAppRpcLogging } from \"./WebAppRpcLogging\";\r\nimport { WebAppRpcRequest } from \"./WebAppRpcRequest\";\r\n\r\n/** An HTTP server request object.\r\n * @public\r\n */\r\nexport interface HttpServerRequest extends Readable {\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  rawTrailers: string[];\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): void;\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}\r\n\r\n/** An HTTP server response object.\r\n * @public\r\n */\r\nexport interface HttpServerResponse extends Writable {\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    const request = await WebAppRpcRequest.parseRequest(this, req);\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      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      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(WebAppRpcLogging.logProtocolEvent);\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;AAE3D,OAAO,EAAE,oBAAoB,EAAE,MAAM,4BAA4B,CAAC;AAElE,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;AAsCtD;;GAEG;AACH,MAAM,OAAgB,iBAAkB,SAAQ,WAAW;IA0GzD,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,gBAAgB,CAAC,gBAAgB,CAAC,CAAC;IAC7D,CAAC;IA3GD,+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;CAY5E","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 { BentleyError, Logger } from \"@itwin/core-bentley\";\nimport { Readable, Writable } from \"stream\";\nimport { CommonLoggerCategory } from \"../../CommonLoggerCategory\";\nimport { RpcConfiguration } from \"../core/RpcConfiguration\";\nimport { RpcContentType, RpcRequestStatus, WEB_RPC_CONSTANTS } from \"../core/RpcConstants\";\nimport { RpcOperation } from \"../core/RpcOperation\";\nimport { RpcProtocol, SerializedRpcRequest } from \"../core/RpcProtocol\";\nimport { OpenAPIInfo, OpenAPIParameter, RpcOpenAPIDescription } from \"./OpenAPI\";\nimport { WebAppRpcLogging } from \"./WebAppRpcLogging\";\nimport { WebAppRpcRequest } from \"./WebAppRpcRequest\";\n\n/** An HTTP server request object.\n * @public\n */\nexport interface HttpServerRequest extends Readable {\n  aborted: boolean;\n  httpVersion: string;\n  httpVersionMajor: number;\n  httpVersionMinor: number;\n  complete: boolean;\n  connection: any;\n  headers: { [header: string]: string | string[] | undefined };\n  rawHeaders: string[];\n  trailers: { [key: string]: string | undefined };\n  rawTrailers: string[];\n  setTimeout(msecs: number, callback: () => void): this;\n  url?: string;\n  statusCode?: number;\n  statusMessage?: string;\n  socket: any;\n  destroy(error?: Error): this;\n  body: string | Buffer;\n  path: string;\n  method: string;\n  ip?: string;\n  header: (field: string) => string | undefined;\n}\n\n/** An HTTP server response object.\n * @public\n */\nexport interface HttpServerResponse extends Writable {\n  send(body?: any): HttpServerResponse;\n  status(code: number): HttpServerResponse;\n  set(field: string, value: string): void;\n}\n\n/** The HTTP application protocol.\n * @internal\n */\nexport abstract class WebAppRpcProtocol extends RpcProtocol {\n  public override preserveStreams = true;\n\n  /** Convenience handler for an RPC operation get request for an HTTP server. */\n  public async handleOperationGetRequest(req: HttpServerRequest, res: HttpServerResponse) {\n    return this.handleOperationPostRequest(req, res);\n  }\n\n  /** Convenience handler for an RPC operation post request for an HTTP server. */\n  public async handleOperationPostRequest(req: HttpServerRequest, res: HttpServerResponse) {\n    let request: SerializedRpcRequest;\n    try {\n      request = await WebAppRpcRequest.parseRequest(this, req);\n    } catch (error) {\n      const message = BentleyError.getErrorMessage(error);\n      Logger.logError(CommonLoggerCategory.RpcInterfaceBackend, `Failed to parse request: ${message}`, BentleyError.getErrorMetadata(error));\n      res.status(400);\n      res.send(JSON.stringify({ message, isError: true }));\n      return;\n    }\n    const fulfillment = await this.fulfill(request);\n    await WebAppRpcRequest.sendResponse(this, request, fulfillment, req, res);\n  }\n\n  /** Convenience handler for an OpenAPI description request for an HTTP server. */\n  public handleOpenApiDescriptionRequest(_req: HttpServerRequest, res: HttpServerResponse) {\n    const description = JSON.stringify(this.openAPIDescription);\n    res.send(description);\n  }\n\n  /** Converts an HTTP content type value to an RPC content type value. */\n  public static computeContentType(httpType: string | null | undefined): RpcContentType {\n    if (!httpType)\n      return RpcContentType.Unknown;\n\n    if (httpType.indexOf(WEB_RPC_CONSTANTS.ANY_TEXT) === 0) {\n      return RpcContentType.Text;\n    } else if (httpType.indexOf(WEB_RPC_CONSTANTS.BINARY) === 0) {\n      return RpcContentType.Binary;\n    } else if (httpType.indexOf(WEB_RPC_CONSTANTS.MULTIPART) === 0) {\n      return RpcContentType.Multipart;\n    } else {\n      return RpcContentType.Unknown;\n    }\n  }\n\n  /** The OpenAPI-compatible info object for this protocol. */\n  public abstract info: OpenAPIInfo;\n\n  /** An optional prefix for RPC operation URI paths. */\n  public pathPrefix: string = \"\";\n\n  /** The RPC request class for this protocol. */\n  public readonly requestType = WebAppRpcRequest;\n\n  /** Supplies the status corresponding to a protocol-specific code value. */\n  public override getStatus(code: number): RpcRequestStatus {\n    switch (code) {\n      case 404: return RpcRequestStatus.NotFound;\n      case 202: return RpcRequestStatus.Pending;\n      case 200: return RpcRequestStatus.Resolved;\n      case 500: return RpcRequestStatus.Rejected;\n      case 204: return RpcRequestStatus.NoContent;\n      case 502: return RpcRequestStatus.BadGateway;\n      case 503: return RpcRequestStatus.ServiceUnavailable;\n      case 504: return RpcRequestStatus.GatewayTimeout;\n      case 408: return RpcRequestStatus.RequestTimeout;\n      case 429: return RpcRequestStatus.TooManyRequests;\n      default: return RpcRequestStatus.Unknown;\n    }\n  }\n\n  /** Supplies the protocol-specific code corresponding to a status value. */\n  public override getCode(status: RpcRequestStatus): number {\n    switch (status) {\n      case RpcRequestStatus.NotFound: return 404;\n      case RpcRequestStatus.Pending: return 202;\n      case RpcRequestStatus.Resolved: return 200;\n      case RpcRequestStatus.Rejected: return 500;\n      case RpcRequestStatus.NoContent: return 204;\n      case RpcRequestStatus.BadGateway: return 502;\n      case RpcRequestStatus.ServiceUnavailable: return 503;\n      case RpcRequestStatus.GatewayTimeout: return 504;\n      case RpcRequestStatus.RequestTimeout: return 408;\n      case RpcRequestStatus.TooManyRequests: return 429;\n      default: return 501;\n    }\n  }\n\n  public override supportsStatusCategory = true;\n\n  /** Whether an HTTP status code indicates a request timeout. */\n  public isTimeout(code: number): boolean {\n    return code === 504;\n  }\n\n  /** An OpenAPI-compatible description of this protocol.\n   * @internal\n   */\n  public get openAPIDescription() { return new RpcOpenAPIDescription(this); }\n\n  /** Returns the OpenAPI-compatible URI path parameters for an RPC operation.\n   * @internal\n   */\n  public abstract supplyPathParametersForOperation(_operation: RpcOperation): OpenAPIParameter[];\n\n  /** Constructs an HTTP protocol. */\n  public constructor(configuration: RpcConfiguration) {\n    super(configuration);\n    this.events.addListener(WebAppRpcLogging.logProtocolEvent);\n  }\n}\n"]}

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

@@ -1,72 +1,72 @@
-/** @packageDocumentation
- * @module RpcInterface
- */
-import { RpcInterface } from "../../RpcInterface";
-import { RpcContentType } from "../core/RpcConstants";
-import { RpcSerializedValue } from "../core/RpcMarshaling";
-import { RpcRequestFulfillment, SerializedRpcRequest } from "../core/RpcProtocol";
-import { RpcRequest } from "../core/RpcRequest";
-import { HttpServerRequest, HttpServerResponse, WebAppRpcProtocol } from "./WebAppRpcProtocol";
-/** @internal */
-export declare type HttpMethod_T = "get" | "put" | "post" | "delete" | "options" | "head" | "patch" | "trace";
-/** A web application RPC request.
- * @internal
- */
-export declare class WebAppRpcRequest extends RpcRequest {
-    private _loading;
-    private _request;
-    private _pathSuffix;
-    private get _headers();
-    /** The maximum size permitted for an encoded component in a URL.
-     * Note that some backends limit the total cumulative request size. Our current node backends accept requests with a max size of 16 kb.
-     * In addition to the url size, an authorization header may also add considerably to the request size.
-     * @note This is used for features like encoding the payload of a cacheable request in the URL.
-     */
-    static maxUrlComponentSize: number;
-    /** The HTTP method for this request. */
-    method: HttpMethod_T;
-    /** Convenience access to the protocol of this request. */
-    readonly protocol: WebAppRpcProtocol;
-    /** Standardized access to metadata about the request (useful for purposes such as logging). */
-    metadata: {
-        status: number;
-        message: string;
-    };
-    /** Parse headers */
-    private static parseHeaders;
-    /** Parses a request. */
-    static parseRequest(protocol: WebAppRpcProtocol, req: HttpServerRequest): Promise<SerializedRpcRequest>;
-    /** Sends the response for a web request. */
-    static sendResponse(protocol: WebAppRpcProtocol, request: SerializedRpcRequest, fulfillment: RpcRequestFulfillment, req: HttpServerRequest, res: HttpServerResponse): Promise<void>;
-    /** Determines the most efficient transport type for an RPC value. */
-    protected static computeTransportType(value: RpcSerializedValue, source: any): RpcContentType;
-    /** Constructs a web application request. */
-    constructor(client: RpcInterface, operation: string, parameters: any[]);
-    /** Sets request header values. */
-    protected setHeader(name: string, value: string): void;
-    /** Sends the request. */
-    protected send(): Promise<number>;
-    protected computeRetryAfter(attempts: number): number;
-    protected handleUnknownResponse(code: number): void;
-    protected load(): Promise<RpcSerializedValue>;
-    /** Override to supply an alternate fetch function. */
-    protected supplyFetch(): typeof fetch;
-    /** Override to supply an alternate Request function. */
-    protected supplyRequest(): typeof Request;
-    private static configureResponse;
-    private static configureText;
-    private static configureBinary;
-    private static configureMultipart;
-    private static configureStream;
-    private static parseFromPath;
-    private static parseFromBody;
-    private performFetch;
-    private loadText;
-    private loadBinary;
-    private loadMultipart;
-    private setupTransport;
-    private setupBinaryTransport;
-    private setupMultipartTransport;
-    private setupTextTransport;
-}
+/** @packageDocumentation
+ * @module RpcInterface
+ */
+import { RpcInterface } from "../../RpcInterface";
+import { RpcContentType } from "../core/RpcConstants";
+import { RpcSerializedValue } from "../core/RpcMarshaling";
+import { RpcRequestFulfillment, SerializedRpcRequest } from "../core/RpcProtocol";
+import { RpcRequest } from "../core/RpcRequest";
+import { HttpServerRequest, HttpServerResponse, WebAppRpcProtocol } from "./WebAppRpcProtocol";
+/** @internal */
+export declare type HttpMethod_T = "get" | "put" | "post" | "delete" | "options" | "head" | "patch" | "trace";
+/** A web application RPC request.
+ * @internal
+ */
+export declare class WebAppRpcRequest extends RpcRequest {
+    private _loading;
+    private _request;
+    private _pathSuffix;
+    private get _headers();
+    /** The maximum size permitted for an encoded component in a URL.
+     * Note that some backends limit the total cumulative request size. Our current node backends accept requests with a max size of 16 kb.
+     * In addition to the url size, an authorization header may also add considerably to the request size.
+     * @note This is used for features like encoding the payload of a cacheable request in the URL.
+     */
+    static maxUrlComponentSize: number;
+    /** The HTTP method for this request. */
+    method: HttpMethod_T;
+    /** Convenience access to the protocol of this request. */
+    readonly protocol: WebAppRpcProtocol;
+    /** Standardized access to metadata about the request (useful for purposes such as logging). */
+    metadata: {
+        status: number;
+        message: string;
+    };
+    /** Parse headers */
+    private static parseHeaders;
+    /** Parses a request. */
+    static parseRequest(protocol: WebAppRpcProtocol, req: HttpServerRequest): Promise<SerializedRpcRequest>;
+    /** Sends the response for a web request. */
+    static sendResponse(protocol: WebAppRpcProtocol, request: SerializedRpcRequest, fulfillment: RpcRequestFulfillment, req: HttpServerRequest, res: HttpServerResponse): Promise<void>;
+    /** Determines the most efficient transport type for an RPC value. */
+    protected static computeTransportType(value: RpcSerializedValue, source: any): RpcContentType;
+    /** Constructs a web application request. */
+    constructor(client: RpcInterface, operation: string, parameters: any[]);
+    /** Sets request header values. */
+    protected setHeader(name: string, value: string): void;
+    /** Sends the request. */
+    protected send(): Promise<number>;
+    protected computeRetryAfter(attempts: number): number;
+    protected handleUnknownResponse(code: number): void;
+    protected load(): Promise<RpcSerializedValue>;
+    /** Override to supply an alternate fetch function. */
+    protected supplyFetch(): typeof fetch;
+    /** Override to supply an alternate Request function. */
+    protected supplyRequest(): typeof Request;
+    private static configureResponse;
+    private static configureText;
+    private static configureBinary;
+    private static configureMultipart;
+    private static configureStream;
+    private static parseFromPath;
+    private static parseFromBody;
+    private performFetch;
+    private loadText;
+    private loadBinary;
+    private loadMultipart;
+    private setupTransport;
+    private setupBinaryTransport;
+    private setupMultipartTransport;
+    private setupTextTransport;
+}
 //# sourceMappingURL=WebAppRpcRequest.d.ts.map