@itwin/core-common 4.0.0-dev.44 → 4.0.0-dev.48

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

@@ -1,141 +1,141 @@
-/** @packageDocumentation
- * @module RpcInterface
- */
-import { WebAppRpcProtocol } from "./WebAppRpcProtocol";
-/** An OpenAPI 3.0 root document object.
- * @internal
- */
-export interface OpenAPIDocument {
-    openapi: "3.0.0";
-    info: OpenAPIInfo;
-    paths: OpenAPIPaths;
-}
-/** An OpenAPI 3.0 info object.
- * @public
- * @deprecated in 3.6. The RPC system will be significantly refactored (or replaced) in version 5.0.
- */
-export interface OpenAPIInfo {
-    title: string;
-    version: string;
-}
-/** An OpenAPI 3.0 paths object.
- * @internal
- */
-export interface OpenAPIPaths {
-    [index: string]: OpenAPIPathItem;
-}
-/** An OpenAPI 3.0 path item object.
- * @internal
- */
-export interface OpenAPIPathItem {
-    summary?: string;
-    get?: OpenAPIOperation;
-    put?: OpenAPIOperation;
-    post?: OpenAPIOperation;
-    delete?: OpenAPIOperation;
-    options?: OpenAPIOperation;
-    head?: OpenAPIOperation;
-    patch?: OpenAPIOperation;
-    trace?: OpenAPIOperation;
-    parameters?: OpenAPIParameter[];
-}
-/** An OpenAPI 3.0 operation object.
- * @internal
- */
-export interface OpenAPIOperation {
-    summary?: string;
-    operationId?: string;
-    parameters?: OpenAPIParameter[];
-    requestBody?: OpenAPIRequestBody;
-    responses: OpenAPIResponses;
-}
-/** An OpenAPI 3.0 content map.
- * @internal
- */
-export interface OpenAPIContentMap {
-    [index: string]: OpenAPIMediaType;
-}
-/** An OpenAPI 3.0 parameter object.
- * @internal
- */
-export interface OpenAPIParameter {
-    name: string;
-    in: "query" | "header" | "path" | "cookie";
-    description?: string;
-    required?: boolean;
-    allowEmptyValue?: boolean;
-    style?: "matrix" | "label" | "form" | "simple" | "spaceDelimited" | "pipeDelimited" | "deepObject";
-    explode?: boolean;
-    allowReserved?: boolean;
-    schema?: OpenAPISchema;
-    content?: OpenAPIContentMap;
-}
-/** An OpenAPI 3.0 media type object.
- * @internal
- */
-export interface OpenAPIMediaType {
-    schema?: OpenAPISchema;
-}
-/** An OpenAPI 3.0 schema object.
- * @internal
- */
-export interface OpenAPISchema {
-    type?: "boolean" | "object" | "array" | "number" | "string";
-    nullable?: boolean;
-    description?: string;
-}
-/** An OpenAPI 3.0 encoding object.
- * @internal
- */
-export interface OpenAPIEncoding {
-    contentType?: string;
-    style?: string;
-    explode?: boolean;
-    allowReserved?: boolean;
-}
-/** An OpenAPI 3.0 parameter object.
- * @internal
- */
-export interface OpenAPIRequestBody {
-    description?: string;
-    content: OpenAPIContentMap;
-    required?: boolean;
-}
-/** An OpenAPI 3.0 responses object.
- * @internal
- */
-export interface OpenAPIResponses {
-    default?: OpenAPIResponse;
-    "200"?: OpenAPIResponse;
-    "301"?: OpenAPIResponse;
-    "302"?: OpenAPIResponse;
-    "400"?: OpenAPIResponse;
-    "404"?: OpenAPIResponse;
-    "500"?: OpenAPIResponse;
-}
-/** An OpenAPI 3.0 response object.
- * @internal
- */
-export interface OpenAPIResponse {
-    description: string;
-    content?: {
-        [index: string]: OpenAPIMediaType;
-    };
-}
-/** An OpenAPI-compatible description of an RPC protocol.
- * @internal
- */
-export declare class RpcOpenAPIDescription {
-    /** The protocol for this description. */
-    readonly protocol: WebAppRpcProtocol;
-    /** The OpenAPI paths object for the protocol. */
-    get paths(): OpenAPIPaths;
-    /** An OpenAPI 3.0 (Swagger) description of the RESTful API that is exposed through the protocol. */
-    get document(): OpenAPIDocument;
-    /** Creates an OpenAPI description of an RPC protocol. */
-    constructor(protocol: WebAppRpcProtocol);
-    /** Converts to JSON. */
-    toJSON(): OpenAPIDocument;
-    private generateDescription;
-}
+/** @packageDocumentation
+ * @module RpcInterface
+ */
+import { WebAppRpcProtocol } from "./WebAppRpcProtocol";
+/** An OpenAPI 3.0 root document object.
+ * @internal
+ */
+export interface OpenAPIDocument {
+    openapi: "3.0.0";
+    info: OpenAPIInfo;
+    paths: OpenAPIPaths;
+}
+/** An OpenAPI 3.0 info object.
+ * @public
+ * @deprecated in 3.6. The RPC system will be significantly refactored (or replaced) in version 5.0.
+ */
+export interface OpenAPIInfo {
+    title: string;
+    version: string;
+}
+/** An OpenAPI 3.0 paths object.
+ * @internal
+ */
+export interface OpenAPIPaths {
+    [index: string]: OpenAPIPathItem;
+}
+/** An OpenAPI 3.0 path item object.
+ * @internal
+ */
+export interface OpenAPIPathItem {
+    summary?: string;
+    get?: OpenAPIOperation;
+    put?: OpenAPIOperation;
+    post?: OpenAPIOperation;
+    delete?: OpenAPIOperation;
+    options?: OpenAPIOperation;
+    head?: OpenAPIOperation;
+    patch?: OpenAPIOperation;
+    trace?: OpenAPIOperation;
+    parameters?: OpenAPIParameter[];
+}
+/** An OpenAPI 3.0 operation object.
+ * @internal
+ */
+export interface OpenAPIOperation {
+    summary?: string;
+    operationId?: string;
+    parameters?: OpenAPIParameter[];
+    requestBody?: OpenAPIRequestBody;
+    responses: OpenAPIResponses;
+}
+/** An OpenAPI 3.0 content map.
+ * @internal
+ */
+export interface OpenAPIContentMap {
+    [index: string]: OpenAPIMediaType;
+}
+/** An OpenAPI 3.0 parameter object.
+ * @internal
+ */
+export interface OpenAPIParameter {
+    name: string;
+    in: "query" | "header" | "path" | "cookie";
+    description?: string;
+    required?: boolean;
+    allowEmptyValue?: boolean;
+    style?: "matrix" | "label" | "form" | "simple" | "spaceDelimited" | "pipeDelimited" | "deepObject";
+    explode?: boolean;
+    allowReserved?: boolean;
+    schema?: OpenAPISchema;
+    content?: OpenAPIContentMap;
+}
+/** An OpenAPI 3.0 media type object.
+ * @internal
+ */
+export interface OpenAPIMediaType {
+    schema?: OpenAPISchema;
+}
+/** An OpenAPI 3.0 schema object.
+ * @internal
+ */
+export interface OpenAPISchema {
+    type?: "boolean" | "object" | "array" | "number" | "string";
+    nullable?: boolean;
+    description?: string;
+}
+/** An OpenAPI 3.0 encoding object.
+ * @internal
+ */
+export interface OpenAPIEncoding {
+    contentType?: string;
+    style?: string;
+    explode?: boolean;
+    allowReserved?: boolean;
+}
+/** An OpenAPI 3.0 parameter object.
+ * @internal
+ */
+export interface OpenAPIRequestBody {
+    description?: string;
+    content: OpenAPIContentMap;
+    required?: boolean;
+}
+/** An OpenAPI 3.0 responses object.
+ * @internal
+ */
+export interface OpenAPIResponses {
+    default?: OpenAPIResponse;
+    "200"?: OpenAPIResponse;
+    "301"?: OpenAPIResponse;
+    "302"?: OpenAPIResponse;
+    "400"?: OpenAPIResponse;
+    "404"?: OpenAPIResponse;
+    "500"?: OpenAPIResponse;
+}
+/** An OpenAPI 3.0 response object.
+ * @internal
+ */
+export interface OpenAPIResponse {
+    description: string;
+    content?: {
+        [index: string]: OpenAPIMediaType;
+    };
+}
+/** An OpenAPI-compatible description of an RPC protocol.
+ * @internal
+ */
+export declare class RpcOpenAPIDescription {
+    /** The protocol for this description. */
+    readonly protocol: WebAppRpcProtocol;
+    /** The OpenAPI paths object for the protocol. */
+    get paths(): OpenAPIPaths;
+    /** An OpenAPI 3.0 (Swagger) description of the RESTful API that is exposed through the protocol. */
+    get document(): OpenAPIDocument;
+    /** Creates an OpenAPI description of an RPC protocol. */
+    constructor(protocol: WebAppRpcProtocol);
+    /** Converts to JSON. */
+    toJSON(): OpenAPIDocument;
+    private generateDescription;
+}
 //# sourceMappingURL=OpenAPI.d.ts.map

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

@@ -1,57 +1,57 @@
-/*---------------------------------------------------------------------------------------------
-* 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 { RpcOperation } from "../core/RpcOperation";
-/** An OpenAPI-compatible description of an RPC protocol.
- * @internal
- */
-export class RpcOpenAPIDescription {
-    /** Creates an OpenAPI description of an RPC protocol. */
-    constructor(protocol) {
-        this.protocol = protocol;
-    }
-    /** The OpenAPI paths object for the protocol. */
-    get paths() {
-        const paths = {};
-        this.protocol.configuration.interfaces().forEach((definition) => {
-            RpcOperation.forEach(definition, (operation) => {
-                const path = this.protocol.supplyPathForOperation(operation, undefined);
-                paths[path] = this.generateDescription(operation);
-            });
-        });
-        return paths;
-    }
-    /** An OpenAPI 3.0 (Swagger) description of the RESTful API that is exposed through the protocol. */
-    get document() {
-        return {
-            openapi: "3.0.0",
-            info: this.protocol.info,
-            paths: this.paths,
-        };
-    }
-    /** Converts to JSON. */
-    toJSON() {
-        return this.document;
-    }
-    generateDescription(operation) {
-        const requestContent = { "application/json": { schema: { type: "array" } } };
-        const responseContent = { "application/json": { schema: { type: "object" } } };
-        const description = {};
-        description.head = {
-            requestBody: { content: requestContent, required: true },
-            responses: {
-                200: { description: "Success", content: responseContent },
-                default: { description: "Error", content: responseContent },
-            },
-        };
-        const parameters = this.protocol.supplyPathParametersForOperation(operation);
-        if (parameters.length)
-            description.parameters = parameters;
-        return description;
-    }
-}
+/*---------------------------------------------------------------------------------------------
+* 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 { RpcOperation } from "../core/RpcOperation";
+/** An OpenAPI-compatible description of an RPC protocol.
+ * @internal
+ */
+export class RpcOpenAPIDescription {
+    /** Creates an OpenAPI description of an RPC protocol. */
+    constructor(protocol) {
+        this.protocol = protocol;
+    }
+    /** The OpenAPI paths object for the protocol. */
+    get paths() {
+        const paths = {};
+        this.protocol.configuration.interfaces().forEach((definition) => {
+            RpcOperation.forEach(definition, (operation) => {
+                const path = this.protocol.supplyPathForOperation(operation, undefined);
+                paths[path] = this.generateDescription(operation);
+            });
+        });
+        return paths;
+    }
+    /** An OpenAPI 3.0 (Swagger) description of the RESTful API that is exposed through the protocol. */
+    get document() {
+        return {
+            openapi: "3.0.0",
+            info: this.protocol.info,
+            paths: this.paths,
+        };
+    }
+    /** Converts to JSON. */
+    toJSON() {
+        return this.document;
+    }
+    generateDescription(operation) {
+        const requestContent = { "application/json": { schema: { type: "array" } } };
+        const responseContent = { "application/json": { schema: { type: "object" } } };
+        const description = {};
+        description.head = {
+            requestBody: { content: requestContent, required: true },
+            responses: {
+                200: { description: "Success", content: responseContent },
+                default: { description: "Error", content: responseContent },
+            },
+        };
+        const parameters = this.protocol.supplyPathParametersForOperation(operation);
+        if (parameters.length)
+            description.parameters = parameters;
+        return description;
+    }
+}
 //# sourceMappingURL=OpenAPI.js.map

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

@@ -1 +1 @@
-{"version":3,"file":"OpenAPI.js","sourceRoot":"","sources":["../../../../src/rpc/web/OpenAPI.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAEH,OAAO,EAAE,YAAY,EAAE,MAAM,sBAAsB,CAAC;AAwIpD;;GAEG;AACH,MAAM,OAAO,qBAAqB;IA2BhC,yDAAyD;IACzD,YAAmB,QAA2B;QAC5C,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;IAC3B,CAAC;IA1BD,iDAAiD;IACjD,IAAW,KAAK;QACd,MAAM,KAAK,GAAiB,EAAE,CAAC;QAE/B,IAAI,CAAC,QAAQ,CAAC,aAAa,CAAC,UAAU,EAAE,CAAC,OAAO,CAAC,CAAC,UAAU,EAAE,EAAE;YAC9D,YAAY,CAAC,OAAO,CAAC,UAAU,EAAE,CAAC,SAAS,EAAE,EAAE;gBAC7C,MAAM,IAAI,GAAG,IAAI,CAAC,QAAQ,CAAC,sBAAsB,CAAC,SAAS,EAAE,SAAS,CAAC,CAAC;gBACxE,KAAK,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC,mBAAmB,CAAC,SAAS,CAAC,CAAC;YACpD,CAAC,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;QAEH,OAAO,KAAK,CAAC;IACf,CAAC;IAED,oGAAoG;IACpG,IAAW,QAAQ;QACjB,OAAO;YACL,OAAO,EAAE,OAAO;YAChB,IAAI,EAAE,IAAI,CAAC,QAAQ,CAAC,IAAI;YACxB,KAAK,EAAE,IAAI,CAAC,KAAK;SAClB,CAAC;IACJ,CAAC;IAOD,wBAAwB;IACjB,MAAM;QACX,OAAO,IAAI,CAAC,QAAQ,CAAC;IACvB,CAAC;IAEO,mBAAmB,CAAC,SAAuB;QACjD,MAAM,cAAc,GAAsB,EAAE,kBAAkB,EAAE,EAAE,MAAM,EAAE,EAAE,IAAI,EAAE,OAAO,EAAE,EAAE,EAAE,CAAC;QAChG,MAAM,eAAe,GAAsB,EAAE,kBAAkB,EAAE,EAAE,MAAM,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,EAAE,EAAE,CAAC;QAElG,MAAM,WAAW,GAAoB,EAAE,CAAC;QAExC,WAAW,CAAC,IAAI,GAAG;YACjB,WAAW,EAAE,EAAE,OAAO,EAAE,cAAc,EAAE,QAAQ,EAAE,IAAI,EAAE;YACxD,SAAS,EAAE;gBACT,GAAG,EAAE,EAAE,WAAW,EAAE,SAAS,EAAE,OAAO,EAAE,eAAe,EAAE;gBACzD,OAAO,EAAE,EAAE,WAAW,EAAE,OAAO,EAAE,OAAO,EAAE,eAAe,EAAE;aAC5D;SACF,CAAC;QAEF,MAAM,UAAU,GAAG,IAAI,CAAC,QAAQ,CAAC,gCAAgC,CAAC,SAAS,CAAC,CAAC;QAC7E,IAAI,UAAU,CAAC,MAAM;YACnB,WAAW,CAAC,UAAU,GAAG,UAAU,CAAC;QAEtC,OAAO,WAAW,CAAC;IACrB,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 { RpcOperation } from \"../core/RpcOperation\";\r\nimport { WebAppRpcProtocol } from \"./WebAppRpcProtocol\";\r\n\r\n/* eslint-disable deprecation/deprecation */\r\n\r\n/** An OpenAPI 3.0 root document object.\r\n * @internal\r\n */\r\nexport interface OpenAPIDocument {\r\n  openapi: \"3.0.0\";\r\n  info: OpenAPIInfo;\r\n  paths: OpenAPIPaths;\r\n}\r\n\r\n/** An OpenAPI 3.0 info 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 OpenAPIInfo {\r\n  title: string;\r\n  version: string;\r\n}\r\n\r\n/** An OpenAPI 3.0 paths object.\r\n * @internal\r\n */\r\nexport interface OpenAPIPaths {\r\n  [index: string]: OpenAPIPathItem;\r\n}\r\n\r\n/** An OpenAPI 3.0 path item object.\r\n * @internal\r\n */\r\nexport interface OpenAPIPathItem {\r\n  summary?: string;\r\n  get?: OpenAPIOperation;\r\n  put?: OpenAPIOperation;\r\n  post?: OpenAPIOperation;\r\n  delete?: OpenAPIOperation;\r\n  options?: OpenAPIOperation;\r\n  head?: OpenAPIOperation;\r\n  patch?: OpenAPIOperation;\r\n  trace?: OpenAPIOperation;\r\n  parameters?: OpenAPIParameter[];\r\n}\r\n\r\n/** An OpenAPI 3.0 operation object.\r\n * @internal\r\n */\r\nexport interface OpenAPIOperation {\r\n  summary?: string;\r\n  operationId?: string;\r\n  parameters?: OpenAPIParameter[];\r\n  requestBody?: OpenAPIRequestBody;\r\n  responses: OpenAPIResponses;\r\n}\r\n\r\n/** An OpenAPI 3.0 content map.\r\n * @internal\r\n */\r\nexport interface OpenAPIContentMap {\r\n  [index: string]: OpenAPIMediaType;\r\n}\r\n\r\n/** An OpenAPI 3.0 parameter object.\r\n * @internal\r\n */\r\nexport interface OpenAPIParameter {\r\n  name: string;\r\n  in: \"query\" | \"header\" | \"path\" | \"cookie\";\r\n  description?: string;\r\n  required?: boolean;\r\n  allowEmptyValue?: boolean;\r\n  style?: \"matrix\" | \"label\" | \"form\" | \"simple\" | \"spaceDelimited\" | \"pipeDelimited\" | \"deepObject\";\r\n  explode?: boolean;\r\n  allowReserved?: boolean;\r\n  schema?: OpenAPISchema;\r\n  content?: OpenAPIContentMap;\r\n}\r\n\r\n/** An OpenAPI 3.0 media type object.\r\n * @internal\r\n */\r\nexport interface OpenAPIMediaType {\r\n  schema?: OpenAPISchema;\r\n}\r\n\r\n/** An OpenAPI 3.0 schema object.\r\n * @internal\r\n */\r\nexport interface OpenAPISchema {\r\n  type?: \"boolean\" | \"object\" | \"array\" | \"number\" | \"string\";\r\n  nullable?: boolean;\r\n  description?: string;\r\n}\r\n\r\n/** An OpenAPI 3.0 encoding object.\r\n * @internal\r\n */\r\nexport interface OpenAPIEncoding {\r\n  contentType?: string;\r\n  style?: string;\r\n  explode?: boolean;\r\n  allowReserved?: boolean;\r\n}\r\n\r\n/** An OpenAPI 3.0 parameter object.\r\n * @internal\r\n */\r\nexport interface OpenAPIRequestBody {\r\n  description?: string;\r\n  content: OpenAPIContentMap;\r\n  required?: boolean;\r\n}\r\n\r\n/** An OpenAPI 3.0 responses object.\r\n * @internal\r\n */\r\nexport interface OpenAPIResponses {\r\n  default?: OpenAPIResponse;\r\n  \"200\"?: OpenAPIResponse;\r\n  \"301\"?: OpenAPIResponse;\r\n  \"302\"?: OpenAPIResponse;\r\n  \"400\"?: OpenAPIResponse;\r\n  \"404\"?: OpenAPIResponse;\r\n  \"500\"?: OpenAPIResponse;\r\n}\r\n\r\n/** An OpenAPI 3.0 response object.\r\n * @internal\r\n */\r\nexport interface OpenAPIResponse {\r\n  description: string;\r\n  content?: { [index: string]: OpenAPIMediaType };\r\n}\r\n\r\n/** An OpenAPI-compatible description of an RPC protocol.\r\n * @internal\r\n */\r\nexport class RpcOpenAPIDescription {\r\n  /** The protocol for this description. */\r\n  public readonly protocol: WebAppRpcProtocol;\r\n\r\n  /** The OpenAPI paths object for the protocol. */\r\n  public get paths(): OpenAPIPaths {\r\n    const paths: OpenAPIPaths = {};\r\n\r\n    this.protocol.configuration.interfaces().forEach((definition) => {\r\n      RpcOperation.forEach(definition, (operation) => {\r\n        const path = this.protocol.supplyPathForOperation(operation, undefined);\r\n        paths[path] = this.generateDescription(operation);\r\n      });\r\n    });\r\n\r\n    return paths;\r\n  }\r\n\r\n  /** An OpenAPI 3.0 (Swagger) description of the RESTful API that is exposed through the protocol. */\r\n  public get document(): OpenAPIDocument {\r\n    return {\r\n      openapi: \"3.0.0\",\r\n      info: this.protocol.info,\r\n      paths: this.paths,\r\n    };\r\n  }\r\n\r\n  /** Creates an OpenAPI description of an RPC protocol. */\r\n  public constructor(protocol: WebAppRpcProtocol) {\r\n    this.protocol = protocol;\r\n  }\r\n\r\n  /** Converts to JSON. */\r\n  public toJSON() {\r\n    return this.document;\r\n  }\r\n\r\n  private generateDescription(operation: RpcOperation): OpenAPIPathItem {\r\n    const requestContent: OpenAPIContentMap = { \"application/json\": { schema: { type: \"array\" } } };\r\n    const responseContent: OpenAPIContentMap = { \"application/json\": { schema: { type: \"object\" } } };\r\n\r\n    const description: OpenAPIPathItem = {};\r\n\r\n    description.head = {\r\n      requestBody: { content: requestContent, required: true },\r\n      responses: {\r\n        200: { description: \"Success\", content: responseContent },\r\n        default: { description: \"Error\", content: responseContent },\r\n      },\r\n    };\r\n\r\n    const parameters = this.protocol.supplyPathParametersForOperation(operation);\r\n    if (parameters.length)\r\n      description.parameters = parameters;\r\n\r\n    return description;\r\n  }\r\n}\r\n"]}
+{"version":3,"file":"OpenAPI.js","sourceRoot":"","sources":["../../../../src/rpc/web/OpenAPI.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAEH,OAAO,EAAE,YAAY,EAAE,MAAM,sBAAsB,CAAC;AAwIpD;;GAEG;AACH,MAAM,OAAO,qBAAqB;IA2BhC,yDAAyD;IACzD,YAAmB,QAA2B;QAC5C,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;IAC3B,CAAC;IA1BD,iDAAiD;IACjD,IAAW,KAAK;QACd,MAAM,KAAK,GAAiB,EAAE,CAAC;QAE/B,IAAI,CAAC,QAAQ,CAAC,aAAa,CAAC,UAAU,EAAE,CAAC,OAAO,CAAC,CAAC,UAAU,EAAE,EAAE;YAC9D,YAAY,CAAC,OAAO,CAAC,UAAU,EAAE,CAAC,SAAS,EAAE,EAAE;gBAC7C,MAAM,IAAI,GAAG,IAAI,CAAC,QAAQ,CAAC,sBAAsB,CAAC,SAAS,EAAE,SAAS,CAAC,CAAC;gBACxE,KAAK,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC,mBAAmB,CAAC,SAAS,CAAC,CAAC;YACpD,CAAC,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;QAEH,OAAO,KAAK,CAAC;IACf,CAAC;IAED,oGAAoG;IACpG,IAAW,QAAQ;QACjB,OAAO;YACL,OAAO,EAAE,OAAO;YAChB,IAAI,EAAE,IAAI,CAAC,QAAQ,CAAC,IAAI;YACxB,KAAK,EAAE,IAAI,CAAC,KAAK;SAClB,CAAC;IACJ,CAAC;IAOD,wBAAwB;IACjB,MAAM;QACX,OAAO,IAAI,CAAC,QAAQ,CAAC;IACvB,CAAC;IAEO,mBAAmB,CAAC,SAAuB;QACjD,MAAM,cAAc,GAAsB,EAAE,kBAAkB,EAAE,EAAE,MAAM,EAAE,EAAE,IAAI,EAAE,OAAO,EAAE,EAAE,EAAE,CAAC;QAChG,MAAM,eAAe,GAAsB,EAAE,kBAAkB,EAAE,EAAE,MAAM,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,EAAE,EAAE,CAAC;QAElG,MAAM,WAAW,GAAoB,EAAE,CAAC;QAExC,WAAW,CAAC,IAAI,GAAG;YACjB,WAAW,EAAE,EAAE,OAAO,EAAE,cAAc,EAAE,QAAQ,EAAE,IAAI,EAAE;YACxD,SAAS,EAAE;gBACT,GAAG,EAAE,EAAE,WAAW,EAAE,SAAS,EAAE,OAAO,EAAE,eAAe,EAAE;gBACzD,OAAO,EAAE,EAAE,WAAW,EAAE,OAAO,EAAE,OAAO,EAAE,eAAe,EAAE;aAC5D;SACF,CAAC;QAEF,MAAM,UAAU,GAAG,IAAI,CAAC,QAAQ,CAAC,gCAAgC,CAAC,SAAS,CAAC,CAAC;QAC7E,IAAI,UAAU,CAAC,MAAM;YACnB,WAAW,CAAC,UAAU,GAAG,UAAU,CAAC;QAEtC,OAAO,WAAW,CAAC;IACrB,CAAC;CACF","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 { RpcOperation } from \"../core/RpcOperation\";\nimport { WebAppRpcProtocol } from \"./WebAppRpcProtocol\";\n\n/* eslint-disable deprecation/deprecation */\n\n/** An OpenAPI 3.0 root document object.\n * @internal\n */\nexport interface OpenAPIDocument {\n  openapi: \"3.0.0\";\n  info: OpenAPIInfo;\n  paths: OpenAPIPaths;\n}\n\n/** An OpenAPI 3.0 info object.\n * @public\n * @deprecated in 3.6. The RPC system will be significantly refactored (or replaced) in version 5.0.\n */\nexport interface OpenAPIInfo {\n  title: string;\n  version: string;\n}\n\n/** An OpenAPI 3.0 paths object.\n * @internal\n */\nexport interface OpenAPIPaths {\n  [index: string]: OpenAPIPathItem;\n}\n\n/** An OpenAPI 3.0 path item object.\n * @internal\n */\nexport interface OpenAPIPathItem {\n  summary?: string;\n  get?: OpenAPIOperation;\n  put?: OpenAPIOperation;\n  post?: OpenAPIOperation;\n  delete?: OpenAPIOperation;\n  options?: OpenAPIOperation;\n  head?: OpenAPIOperation;\n  patch?: OpenAPIOperation;\n  trace?: OpenAPIOperation;\n  parameters?: OpenAPIParameter[];\n}\n\n/** An OpenAPI 3.0 operation object.\n * @internal\n */\nexport interface OpenAPIOperation {\n  summary?: string;\n  operationId?: string;\n  parameters?: OpenAPIParameter[];\n  requestBody?: OpenAPIRequestBody;\n  responses: OpenAPIResponses;\n}\n\n/** An OpenAPI 3.0 content map.\n * @internal\n */\nexport interface OpenAPIContentMap {\n  [index: string]: OpenAPIMediaType;\n}\n\n/** An OpenAPI 3.0 parameter object.\n * @internal\n */\nexport interface OpenAPIParameter {\n  name: string;\n  in: \"query\" | \"header\" | \"path\" | \"cookie\";\n  description?: string;\n  required?: boolean;\n  allowEmptyValue?: boolean;\n  style?: \"matrix\" | \"label\" | \"form\" | \"simple\" | \"spaceDelimited\" | \"pipeDelimited\" | \"deepObject\";\n  explode?: boolean;\n  allowReserved?: boolean;\n  schema?: OpenAPISchema;\n  content?: OpenAPIContentMap;\n}\n\n/** An OpenAPI 3.0 media type object.\n * @internal\n */\nexport interface OpenAPIMediaType {\n  schema?: OpenAPISchema;\n}\n\n/** An OpenAPI 3.0 schema object.\n * @internal\n */\nexport interface OpenAPISchema {\n  type?: \"boolean\" | \"object\" | \"array\" | \"number\" | \"string\";\n  nullable?: boolean;\n  description?: string;\n}\n\n/** An OpenAPI 3.0 encoding object.\n * @internal\n */\nexport interface OpenAPIEncoding {\n  contentType?: string;\n  style?: string;\n  explode?: boolean;\n  allowReserved?: boolean;\n}\n\n/** An OpenAPI 3.0 parameter object.\n * @internal\n */\nexport interface OpenAPIRequestBody {\n  description?: string;\n  content: OpenAPIContentMap;\n  required?: boolean;\n}\n\n/** An OpenAPI 3.0 responses object.\n * @internal\n */\nexport interface OpenAPIResponses {\n  default?: OpenAPIResponse;\n  \"200\"?: OpenAPIResponse;\n  \"301\"?: OpenAPIResponse;\n  \"302\"?: OpenAPIResponse;\n  \"400\"?: OpenAPIResponse;\n  \"404\"?: OpenAPIResponse;\n  \"500\"?: OpenAPIResponse;\n}\n\n/** An OpenAPI 3.0 response object.\n * @internal\n */\nexport interface OpenAPIResponse {\n  description: string;\n  content?: { [index: string]: OpenAPIMediaType };\n}\n\n/** An OpenAPI-compatible description of an RPC protocol.\n * @internal\n */\nexport class RpcOpenAPIDescription {\n  /** The protocol for this description. */\n  public readonly protocol: WebAppRpcProtocol;\n\n  /** The OpenAPI paths object for the protocol. */\n  public get paths(): OpenAPIPaths {\n    const paths: OpenAPIPaths = {};\n\n    this.protocol.configuration.interfaces().forEach((definition) => {\n      RpcOperation.forEach(definition, (operation) => {\n        const path = this.protocol.supplyPathForOperation(operation, undefined);\n        paths[path] = this.generateDescription(operation);\n      });\n    });\n\n    return paths;\n  }\n\n  /** An OpenAPI 3.0 (Swagger) description of the RESTful API that is exposed through the protocol. */\n  public get document(): OpenAPIDocument {\n    return {\n      openapi: \"3.0.0\",\n      info: this.protocol.info,\n      paths: this.paths,\n    };\n  }\n\n  /** Creates an OpenAPI description of an RPC protocol. */\n  public constructor(protocol: WebAppRpcProtocol) {\n    this.protocol = protocol;\n  }\n\n  /** Converts to JSON. */\n  public toJSON() {\n    return this.document;\n  }\n\n  private generateDescription(operation: RpcOperation): OpenAPIPathItem {\n    const requestContent: OpenAPIContentMap = { \"application/json\": { schema: { type: \"array\" } } };\n    const responseContent: OpenAPIContentMap = { \"application/json\": { schema: { type: \"object\" } } };\n\n    const description: OpenAPIPathItem = {};\n\n    description.head = {\n      requestBody: { content: requestContent, required: true },\n      responses: {\n        200: { description: \"Success\", content: responseContent },\n        default: { description: \"Error\", content: responseContent },\n      },\n    };\n\n    const parameters = this.protocol.supplyPathParametersForOperation(operation);\n    if (parameters.length)\n      description.parameters = parameters;\n\n    return description;\n  }\n}\n"]}

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

@@ -1,36 +1,36 @@
-/** @packageDocumentation
- * @module RpcInterface
- */
-import { BackendBuffer, BackendReadable } from "../../BackendTypes";
-import { RpcSerializedValue } from "../core/RpcMarshaling";
-import { HttpServerRequest } from "../web/WebAppRpcProtocol";
-/** @internal */
-export interface FormDataCommon {
-    append(name: string, value: string | Blob | BackendBuffer, fileName?: string): void;
-}
-/** @internal */
-export interface ReadableFormData extends BackendReadable {
-    getHeaders(): {
-        [key: string]: any;
-    };
-}
-/** Support for transporting RPC values using the HTTP multipart content type.
- * @internal
- */
-export declare class RpcMultipart {
-    /** Creates a multipart form object for an RPC value. */
-    static createForm(value: RpcSerializedValue): FormData;
-    /** Creates a multipart stream for an RPC value. */
-    static createStream(value: RpcSerializedValue): ReadableFormData;
-    /** Obtains the RPC value from a multipart HTTP request. */
-    static parseRequest(req: HttpServerRequest): Promise<RpcSerializedValue>;
-    /** @internal */
-    static writeValueToForm(form: FormDataCommon, value: RpcSerializedValue): void;
-    /** @internal */
-    static platform: {
-        createStream(_value: RpcSerializedValue): ReadableFormData;
-        parseRequest(_req: HttpServerRequest): Promise<RpcSerializedValue>;
-        appendToForm(i: number, form: FormDataCommon, value: RpcSerializedValue): void;
-    };
-}
+/** @packageDocumentation
+ * @module RpcInterface
+ */
+import { BackendBuffer, BackendReadable } from "../../BackendTypes";
+import { RpcSerializedValue } from "../core/RpcMarshaling";
+import { HttpServerRequest } from "../web/WebAppRpcProtocol";
+/** @internal */
+export interface FormDataCommon {
+    append(name: string, value: string | Blob | BackendBuffer, fileName?: string): void;
+}
+/** @internal */
+export interface ReadableFormData extends BackendReadable {
+    getHeaders(): {
+        [key: string]: any;
+    };
+}
+/** Support for transporting RPC values using the HTTP multipart content type.
+ * @internal
+ */
+export declare class RpcMultipart {
+    /** Creates a multipart form object for an RPC value. */
+    static createForm(value: RpcSerializedValue): FormData;
+    /** Creates a multipart stream for an RPC value. */
+    static createStream(value: RpcSerializedValue): ReadableFormData;
+    /** Obtains the RPC value from a multipart HTTP request. */
+    static parseRequest(req: HttpServerRequest): Promise<RpcSerializedValue>;
+    /** @internal */
+    static writeValueToForm(form: FormDataCommon, value: RpcSerializedValue): void;
+    /** @internal */
+    static platform: {
+        createStream(_value: RpcSerializedValue): ReadableFormData;
+        parseRequest(_req: HttpServerRequest): Promise<RpcSerializedValue>;
+        appendToForm(i: number, form: FormDataCommon, value: RpcSerializedValue): void;
+    };
+}
 //# sourceMappingURL=RpcMultipart.d.ts.map

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

@@ -1,47 +1,47 @@
-/*---------------------------------------------------------------------------------------------
-* 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 { BentleyStatus, IModelError } from "../../IModelError";
-/** Support for transporting RPC values using the HTTP multipart content type.
- * @internal
- */
-export class RpcMultipart {
-    /** Creates a multipart form object for an RPC value. */
-    static createForm(value) {
-        const form = new FormData();
-        RpcMultipart.writeValueToForm(form, value);
-        return form;
-    }
-    /** Creates a multipart stream for an RPC value. */
-    static createStream(value) {
-        return this.platform.createStream(value);
-    }
-    /** Obtains the RPC value from a multipart HTTP request. */
-    static async parseRequest(req) {
-        return this.platform.parseRequest(req);
-    }
-    /** @internal */
-    static writeValueToForm(form, value) {
-        form.append("objects", value.objects);
-        for (let i = 0; i !== value.data.length; ++i) {
-            this.platform.appendToForm(i, form, value);
-        }
-    }
-}
-/** @internal */
-RpcMultipart.platform = {
-    createStream(_value) {
-        throw new IModelError(BentleyStatus.ERROR, "Not bound.");
-    },
-    async parseRequest(_req) {
-        throw new IModelError(BentleyStatus.ERROR, "Not bound.");
-    },
-    appendToForm(i, form, value) {
-        form.append(`data-${i}`, new Blob([value.data[i]], { type: "application/octet-stream" }));
-    },
-};
+/*---------------------------------------------------------------------------------------------
+* 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 { BentleyStatus, IModelError } from "../../IModelError";
+/** Support for transporting RPC values using the HTTP multipart content type.
+ * @internal
+ */
+export class RpcMultipart {
+    /** Creates a multipart form object for an RPC value. */
+    static createForm(value) {
+        const form = new FormData();
+        RpcMultipart.writeValueToForm(form, value);
+        return form;
+    }
+    /** Creates a multipart stream for an RPC value. */
+    static createStream(value) {
+        return this.platform.createStream(value);
+    }
+    /** Obtains the RPC value from a multipart HTTP request. */
+    static async parseRequest(req) {
+        return this.platform.parseRequest(req);
+    }
+    /** @internal */
+    static writeValueToForm(form, value) {
+        form.append("objects", value.objects);
+        for (let i = 0; i !== value.data.length; ++i) {
+            this.platform.appendToForm(i, form, value);
+        }
+    }
+}
+/** @internal */
+RpcMultipart.platform = {
+    createStream(_value) {
+        throw new IModelError(BentleyStatus.ERROR, "Not bound.");
+    },
+    async parseRequest(_req) {
+        throw new IModelError(BentleyStatus.ERROR, "Not bound.");
+    },
+    appendToForm(i, form, value) {
+        form.append(`data-${i}`, new Blob([value.data[i]], { type: "application/octet-stream" }));
+    },
+};
 //# sourceMappingURL=RpcMultipart.js.map

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

@@ -1 +1 @@
-{"version":3,"file":"RpcMultipart.js","sourceRoot":"","sources":["../../../../src/rpc/web/RpcMultipart.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAEH,OAAO,EAAE,aAAa,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAC;AAiB/D;;GAEG;AACH,MAAM,OAAO,YAAY;IACvB,wDAAwD;IACjD,MAAM,CAAC,UAAU,CAAC,KAAyB;QAChD,MAAM,IAAI,GAAG,IAAI,QAAQ,EAAE,CAAC;QAC5B,YAAY,CAAC,gBAAgB,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;QAC3C,OAAO,IAAI,CAAC;IACd,CAAC;IAED,mDAAmD;IAC5C,MAAM,CAAC,YAAY,CAAC,KAAyB;QAClD,OAAO,IAAI,CAAC,QAAQ,CAAC,YAAY,CAAC,KAAK,CAAC,CAAC;IAC3C,CAAC;IAED,2DAA2D;IACpD,MAAM,CAAC,KAAK,CAAC,YAAY,CAAC,GAAsB;QACrD,OAAO,IAAI,CAAC,QAAQ,CAAC,YAAY,CAAC,GAAG,CAAC,CAAC;IACzC,CAAC;IAED,gBAAgB;IACT,MAAM,CAAC,gBAAgB,CAAC,IAAoB,EAAE,KAAyB;QAC5E,IAAI,CAAC,MAAM,CAAC,SAAS,EAAE,KAAK,CAAC,OAAO,CAAC,CAAC;QAEtC,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,KAAK,KAAK,CAAC,IAAI,CAAC,MAAM,EAAE,EAAE,CAAC,EAAE;YAC5C,IAAI,CAAC,QAAQ,CAAC,YAAY,CAAC,CAAC,EAAE,IAAI,EAAE,KAAK,CAAC,CAAC;SAC5C;IACH,CAAC;;AAED,gBAAgB;AACF,qBAAQ,GAAG;IACvB,YAAY,CAAC,MAA0B;QACrC,MAAM,IAAI,WAAW,CAAC,aAAa,CAAC,KAAK,EAAE,YAAY,CAAC,CAAC;IAC3D,CAAC;IACD,KAAK,CAAC,YAAY,CAAC,IAAuB;QACxC,MAAM,IAAI,WAAW,CAAC,aAAa,CAAC,KAAK,EAAE,YAAY,CAAC,CAAC;IAC3D,CAAC;IACD,YAAY,CAAC,CAAS,EAAE,IAAoB,EAAE,KAAyB;QACrE,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,EAAE,EAAE,IAAI,IAAI,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,EAAE,EAAE,IAAI,EAAE,0BAA0B,EAAE,CAAC,CAAC,CAAC;IAC5F,CAAC;CACF,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 { BentleyStatus, IModelError } from \"../../IModelError\";\r\nimport { BackendBuffer, BackendReadable } from \"../../BackendTypes\";\r\nimport { RpcSerializedValue } from \"../core/RpcMarshaling\";\r\nimport { HttpServerRequest } from \"../web/WebAppRpcProtocol\";\r\n\r\n/* eslint-disable deprecation/deprecation */\r\n\r\n/** @internal */\r\nexport interface FormDataCommon {\r\n  append(name: string, value: string | Blob | BackendBuffer, fileName?: string): void;\r\n}\r\n\r\n/** @internal */\r\nexport interface ReadableFormData extends BackendReadable {\r\n  getHeaders(): { [key: string]: any };\r\n}\r\n\r\n/** Support for transporting RPC values using the HTTP multipart content type.\r\n * @internal\r\n */\r\nexport class RpcMultipart {\r\n  /** Creates a multipart form object for an RPC value. */\r\n  public static createForm(value: RpcSerializedValue): FormData {\r\n    const form = new FormData();\r\n    RpcMultipart.writeValueToForm(form, value);\r\n    return form;\r\n  }\r\n\r\n  /** Creates a multipart stream for an RPC value. */\r\n  public static createStream(value: RpcSerializedValue): ReadableFormData {\r\n    return this.platform.createStream(value);\r\n  }\r\n\r\n  /** Obtains the RPC value from a multipart HTTP request. */\r\n  public static async parseRequest(req: HttpServerRequest): Promise<RpcSerializedValue> {\r\n    return this.platform.parseRequest(req);\r\n  }\r\n\r\n  /** @internal */\r\n  public static writeValueToForm(form: FormDataCommon, value: RpcSerializedValue) {\r\n    form.append(\"objects\", value.objects);\r\n\r\n    for (let i = 0; i !== value.data.length; ++i) {\r\n      this.platform.appendToForm(i, form, value);\r\n    }\r\n  }\r\n\r\n  /** @internal */\r\n  public static platform = {\r\n    createStream(_value: RpcSerializedValue): ReadableFormData {\r\n      throw new IModelError(BentleyStatus.ERROR, \"Not bound.\");\r\n    },\r\n    async parseRequest(_req: HttpServerRequest): Promise<RpcSerializedValue> {\r\n      throw new IModelError(BentleyStatus.ERROR, \"Not bound.\");\r\n    },\r\n    appendToForm(i: number, form: FormDataCommon, value: RpcSerializedValue): void {\r\n      form.append(`data-${i}`, new Blob([value.data[i]], { type: \"application/octet-stream\" }));\r\n    },\r\n  };\r\n}\r\n\r\n"]}
+{"version":3,"file":"RpcMultipart.js","sourceRoot":"","sources":["../../../../src/rpc/web/RpcMultipart.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAEH,OAAO,EAAE,aAAa,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAC;AAiB/D;;GAEG;AACH,MAAM,OAAO,YAAY;IACvB,wDAAwD;IACjD,MAAM,CAAC,UAAU,CAAC,KAAyB;QAChD,MAAM,IAAI,GAAG,IAAI,QAAQ,EAAE,CAAC;QAC5B,YAAY,CAAC,gBAAgB,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;QAC3C,OAAO,IAAI,CAAC;IACd,CAAC;IAED,mDAAmD;IAC5C,MAAM,CAAC,YAAY,CAAC,KAAyB;QAClD,OAAO,IAAI,CAAC,QAAQ,CAAC,YAAY,CAAC,KAAK,CAAC,CAAC;IAC3C,CAAC;IAED,2DAA2D;IACpD,MAAM,CAAC,KAAK,CAAC,YAAY,CAAC,GAAsB;QACrD,OAAO,IAAI,CAAC,QAAQ,CAAC,YAAY,CAAC,GAAG,CAAC,CAAC;IACzC,CAAC;IAED,gBAAgB;IACT,MAAM,CAAC,gBAAgB,CAAC,IAAoB,EAAE,KAAyB;QAC5E,IAAI,CAAC,MAAM,CAAC,SAAS,EAAE,KAAK,CAAC,OAAO,CAAC,CAAC;QAEtC,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,KAAK,KAAK,CAAC,IAAI,CAAC,MAAM,EAAE,EAAE,CAAC,EAAE;YAC5C,IAAI,CAAC,QAAQ,CAAC,YAAY,CAAC,CAAC,EAAE,IAAI,EAAE,KAAK,CAAC,CAAC;SAC5C;IACH,CAAC;;AAED,gBAAgB;AACF,qBAAQ,GAAG;IACvB,YAAY,CAAC,MAA0B;QACrC,MAAM,IAAI,WAAW,CAAC,aAAa,CAAC,KAAK,EAAE,YAAY,CAAC,CAAC;IAC3D,CAAC;IACD,KAAK,CAAC,YAAY,CAAC,IAAuB;QACxC,MAAM,IAAI,WAAW,CAAC,aAAa,CAAC,KAAK,EAAE,YAAY,CAAC,CAAC;IAC3D,CAAC;IACD,YAAY,CAAC,CAAS,EAAE,IAAoB,EAAE,KAAyB;QACrE,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,EAAE,EAAE,IAAI,IAAI,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,EAAE,EAAE,IAAI,EAAE,0BAA0B,EAAE,CAAC,CAAC,CAAC;IAC5F,CAAC;CACF,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 { BentleyStatus, IModelError } from \"../../IModelError\";\nimport { BackendBuffer, BackendReadable } from \"../../BackendTypes\";\nimport { RpcSerializedValue } from \"../core/RpcMarshaling\";\nimport { HttpServerRequest } from \"../web/WebAppRpcProtocol\";\n\n/* eslint-disable deprecation/deprecation */\n\n/** @internal */\nexport interface FormDataCommon {\n  append(name: string, value: string | Blob | BackendBuffer, fileName?: string): void;\n}\n\n/** @internal */\nexport interface ReadableFormData extends BackendReadable {\n  getHeaders(): { [key: string]: any };\n}\n\n/** Support for transporting RPC values using the HTTP multipart content type.\n * @internal\n */\nexport class RpcMultipart {\n  /** Creates a multipart form object for an RPC value. */\n  public static createForm(value: RpcSerializedValue): FormData {\n    const form = new FormData();\n    RpcMultipart.writeValueToForm(form, value);\n    return form;\n  }\n\n  /** Creates a multipart stream for an RPC value. */\n  public static createStream(value: RpcSerializedValue): ReadableFormData {\n    return this.platform.createStream(value);\n  }\n\n  /** Obtains the RPC value from a multipart HTTP request. */\n  public static async parseRequest(req: HttpServerRequest): Promise<RpcSerializedValue> {\n    return this.platform.parseRequest(req);\n  }\n\n  /** @internal */\n  public static writeValueToForm(form: FormDataCommon, value: RpcSerializedValue) {\n    form.append(\"objects\", value.objects);\n\n    for (let i = 0; i !== value.data.length; ++i) {\n      this.platform.appendToForm(i, form, value);\n    }\n  }\n\n  /** @internal */\n  public static platform = {\n    createStream(_value: RpcSerializedValue): ReadableFormData {\n      throw new IModelError(BentleyStatus.ERROR, \"Not bound.\");\n    },\n    async parseRequest(_req: HttpServerRequest): Promise<RpcSerializedValue> {\n      throw new IModelError(BentleyStatus.ERROR, \"Not bound.\");\n    },\n    appendToForm(i: number, form: FormDataCommon, value: RpcSerializedValue): void {\n      form.append(`data-${i}`, new Blob([value.data[i]], { type: \"application/octet-stream\" }));\n    },\n  };\n}\n\n"]}