@itwin/core-common 3.6.0-dev.8 → 3.7.0-dev.1

package/lib/cjs/rpc/web/BentleyCloudRpcProtocol.js.map

@@ -1 +1 @@
-{"version":3,"file":"BentleyCloudRpcProtocol.js","sourceRoot":"","sources":["../../../../src/rpc/web/BentleyCloudRpcProtocol.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,sDAAoD;AAEpD,mDAAgD;AAChD,+DAA4D;AAC5D,uDAAoD;AAIpD,2DAAwD;AAGxD,IAAK,OAEJ;AAFD,WAAK,OAAO;IACV,gCAAqB,CAAA;AACvB,CAAC,EAFI,OAAO,KAAP,OAAO,QAEX;AAED;;GAEG;AACH,MAAsB,uBAAwB,SAAQ,qCAAiB;IAAvE;;QACkB,eAAU,GAAG,IAAI,CAAC;QAElC,iFAAiF;QACjE,8CAAyC,GAA0B;YACjF,8CAA8C;YAC9C,EAAE,EAAE,kBAAkB;YAEtB,kDAAkD;YAClD,aAAa,EAAE,kBAAkB;YAEjC,uDAAuD;YACvD,kBAAkB,EAAE,uBAAuB;YAE3C,8CAA8C;YAC9C,SAAS,EAAE,cAAc;YAEzB,iDAAiD;YACjD,aAAa,EAAE,eAAe;SAC/B,CAAC;QAEF,mDAAmD;QACnC,8BAAyB,GAAG,oBAAoB,CAAC;IA6GnE,CAAC;IA3GC,yEAAyE;IACzD,oBAAoB,CAAC,IAAY;QAC/C,MAAM,GAAG,GAAG,IAAI,GAAG,CAAC,IAAI,EAAE,oBAAoB,CAAC,CAAC;QAChD,MAAM,UAAU,GAAG,GAAG,CAAC,QAAQ,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,4BAA4B;QAEzF,MAAM,kBAAkB,GAAG,UAAU,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;QACnD,MAAM,cAAc,GAAG,GAAG,CAAC,YAAY,CAAC,GAAG,CAAC,YAAY,CAAC,IAAI,EAAE,CAAC;QAEhE,mFAAmF;QACnF,IAAI,eAAe,CAAC,IAAI,CAAC,cAAc,CAAC;YACtC,MAAM,IAAI,yBAAW,CAAC,4BAAa,CAAC,KAAK,EAAE,qDAAqD,CAAC,CAAC;QAEpG,MAAM,WAAW,GAAG,kBAAkB,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;QACpD,MAAM,UAAU,GAAG,kBAAkB,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC;QACvD,MAAM,mBAAmB,GAAG,kBAAkB,CAAC,KAAK,CAAC,CAAC,EAAE,WAAW,CAAC,CAAC;QACrE,MAAM,gBAAgB,GAAG,kBAAkB,CAAC,KAAK,CAAC,WAAW,GAAG,CAAC,EAAE,UAAU,CAAC,CAAC;QAC/E,MAAM,aAAa,GAAG,kBAAkB,CAAC,KAAK,CAAC,UAAU,GAAG,CAAC,CAAC,CAAC;QAE/D,OAAO,EAAE,mBAAmB,EAAE,aAAa,EAAE,gBAAgB,EAAE,cAAc,EAAE,CAAC;IAClF,CAAC;IAED,qEAAqE;IACrD,sBAAsB,CAAC,SAAuB,EAAE,OAA+B;;QAC7F,MAAM,MAAM,GAAG,IAAI,CAAC,UAAU,CAAC;QAC/B,MAAM,QAAQ,GAAG,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC;QACjC,MAAM,UAAU,GAAG,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC;QACrC,MAAM,WAAW,GAAG,GAAG,SAAS,CAAC,mBAAmB,CAAC,aAAa,IAAI,SAAS,CAAC,gBAAgB,IAAI,SAAS,CAAC,aAAa,EAAE,CAAC;QAE9H,IAAI,OAAO,GAAW,EAAE,CAAC;QACzB,IAAI,OAAO,GAAW,EAAE,CAAC;QACzB,IAAI,QAAQ,GAAW,EAAE,CAAC;QAC1B,IAAI,gBAAoC,CAAC;QACzC;;;;2DAImD;QAEnD,IAAI,OAAO,KAAK,SAAS,EAAE;YACzB,OAAO,GAAG,UAAU,CAAC;YACrB,OAAO,GAAG,WAAW,CAAC;YACtB,QAAQ,GAAG,YAAY,CAAC;YACxB,gBAAgB,GAAG,eAAe,CAAC;SACpC;aAAM;YACL,IAAI,KAAK,GAAG,SAAS,CAAC,MAAM,CAAC,KAAK,CAAC,OAAO,CAAC,IAAI,2BAAY,CAAC,aAAa,CAAC;YAE1E,IAAI,CAAC,KAAK,IAAI,CAAC,KAAK,CAAC,QAAQ,EAAE;gBAC7B,IAAI,mCAAgB,CAAC,wBAAwB,EAAE;oBAC7C,KAAK,GAAG,EAAE,GAAG,EAAE,EAAE,EAAE,CAAC;iBACrB;qBAAM;oBACL,MAAM,IAAI,yBAAW,CAAC,4BAAa,CAAC,KAAK,EAAE,+CAA+C,CAAC,CAAC;iBAC7F;aACF;YAED,OAAO,GAAG,kBAAkB,CAAC,KAAK,CAAC,OAAO,IAAI,EAAE,CAAC,CAAC;YAClD,QAAQ,GAAG,kBAAkB,CAAC,KAAK,CAAC,QAAS,CAAC,CAAC;YAE/C,gBAAgB,GAAG,CAAA,MAAA,KAAK,CAAC,SAAS,0CAAE,EAAE,KAAI,GAAG,CAAC;YAC9C,OAAO,GAAG,OAAO,CAAC,eAAe,CAAC;SACnC;QAED,OAAO,GAAG,MAAM,IAAI,QAAQ,IAAI,UAAU,SAAS,OAAO,YAAY,OAAO,WAAW,QAAQ,GAAG,CAAC,CAAC,gBAAgB,CAAC,CAAC,CAAC,cAAc,gBAAgB,EAAE,CAAC,CAAC,CAAC,EAAE,IAAI,WAAW,EAAE,CAAC;IACjL,CAAC;IAED;;;OAGG;IACa,YAAY,CAAC,aAA6B,EAAE,OAA6B;;QACvF,MAAM,iBAAiB,GAAG,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;QAElD,MAAM,SAAS,GAAG,aAAa,CAAC,GAAG,CAAC;QACpC,IAAI,QAAQ,GAAG,aAAa,CAAC,QAAQ,CAAC;QACtC,IAAI,OAAO,GAAG,aAAa,CAAC,OAAO,CAAC;QACpC,MAAM,SAAS,GAAG,EAAE,EAAE,EAAE,MAAA,MAAA,aAAa,CAAC,SAAS,0CAAE,EAAE,mCAAI,GAAG,EAAE,KAAK,EAAE,MAAA,aAAa,CAAC,SAAS,0CAAE,KAAK,EAAE,CAAC;QAEpG,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,IAAI,iBAAiB,CAAC,MAAM,EAAE,EAAE,CAAC,EAAE;YAClD,MAAM,GAAG,GAAG,iBAAiB,CAAC,CAAC,CAAC,CAAC;YACjC,MAAM,KAAK,GAAG,iBAAiB,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC;YACvC,IAAI,GAAG,KAAK,MAAM,EAAE;gBAClB,EAAE,CAAC,CAAC;aACL;iBAAM,IAAI,GAAG,KAAK,SAAS,EAAE;gBAC5B,OAAO,GAAG,KAAK,CAAC;gBAChB,EAAE,CAAC,CAAC;aACL;iBAAM,IAAI,GAAG,KAAK,QAAQ,EAAE;gBAC3B,QAAQ,GAAG,KAAK,CAAC;gBACjB,EAAE,CAAC,CAAC;aACL;iBAAM,IAAI,GAAG,KAAK,WAAW,EAAE;gBAC9B,SAAS,CAAC,EAAE,GAAG,CAAC,KAAK,KAAK,GAAG,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,KAAK,CAAC;gBAC5C,EAAE,CAAC,CAAC;aACL;SACF;QAED,OAAO,EAAE,GAAG,EAAE,SAAS,EAAE,OAAO,EAAE,QAAQ,EAAE,SAAS,EAAE,CAAC;IAC1D,CAAC;IAED;;OAEG;IACI,gCAAgC,CAAC,UAAwB;QAC9D,OAAO;YACL,EAAE,IAAI,EAAE,QAAQ,EAAE,EAAE,EAAE,MAAM,EAAE,QAAQ,EAAE,IAAI,EAAE,MAAM,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,EAAE;YAC1E,EAAE,IAAI,EAAE,SAAS,EAAE,EAAE,EAAE,MAAM,EAAE,QAAQ,EAAE,IAAI,EAAE,MAAM,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,EAAE;YAC3E,EAAE,IAAI,EAAE,UAAU,EAAE,EAAE,EAAE,MAAM,EAAE,QAAQ,EAAE,IAAI,EAAE,MAAM,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,EAAE;YAC5E,EAAE,IAAI,EAAE,aAAa,EAAE,EAAE,EAAE,MAAM,EAAE,QAAQ,EAAE,KAAK,EAAE,MAAM,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,EAAE;SACjF,CAAC;IACJ,CAAC;CACF;AAnID,0DAmIC","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 } from \"@itwin/core-bentley\";\r\nimport { IModelRpcProps } from \"../../IModel\";\r\nimport { IModelError } from \"../../IModelError\";\r\nimport { RpcConfiguration } from \"../core/RpcConfiguration\";\r\nimport { RpcOperation } from \"../core/RpcOperation\";\r\nimport { SerializedRpcOperation, SerializedRpcRequest } from \"../core/RpcProtocol\";\r\nimport { RpcRequest } from \"../core/RpcRequest\";\r\nimport { OpenAPIParameter } from \"./OpenAPI\";\r\nimport { WebAppRpcProtocol } from \"./WebAppRpcProtocol\";\r\nimport { SerializedRpcActivity } from \"../core/RpcInvocation\";\r\n\r\nenum AppMode {\r\n  MilestoneReview = \"1\",\r\n}\r\n\r\n/** An http protocol for Bentley cloud RPC interface deployments.\r\n * @internal\r\n */\r\nexport abstract class BentleyCloudRpcProtocol extends WebAppRpcProtocol {\r\n  public override checkToken = true;\r\n\r\n  /** The name of various HTTP request headers based on client's request context */\r\n  public override serializedClientRequestContextHeaderNames: SerializedRpcActivity = {\r\n    /** The name of the HTTP request id header. */\r\n    id: \"X-Correlation-Id\",\r\n\r\n    /** The name of the HTTP application id header. */\r\n    applicationId: \"X-Application-Id\",\r\n\r\n    /** The name of the HTTP application version header. */\r\n    applicationVersion: \"X-Application-Version\",\r\n\r\n    /** The name of the HTTP session id header. */\r\n    sessionId: \"X-Session-Id\",\r\n\r\n    /** The name of the HTTP authorization header. */\r\n    authorization: \"Authorization\",\r\n  };\r\n\r\n  /** The name of the RPC protocol version header. */\r\n  public override protocolVersionHeaderName = \"X-Protocol-Version\";\r\n\r\n  /** Returns the operation specified by an OpenAPI-compatible URI path. */\r\n  public override getOperationFromPath(path: string): SerializedRpcOperation {\r\n    const url = new URL(path, \"https://localhost/\");\r\n    const components = url.pathname.split(\"/\").filter((x) => x); // filter out empty segments\r\n\r\n    const operationComponent = components.slice(-1)[0];\r\n    const encodedRequest = url.searchParams.get(\"parameters\") || \"\";\r\n\r\n    // The encodedRequest should be base64 - fail now if any other characters detected.\r\n    if (/[^A-z0-9=+\\/]/.test(encodedRequest))\r\n      throw new IModelError(BentleyStatus.ERROR, `Invalid request: Malformed URL parameters detected.`);\r\n\r\n    const firstHyphen = operationComponent.indexOf(\"-\");\r\n    const lastHyphen = operationComponent.lastIndexOf(\"-\");\r\n    const interfaceDefinition = operationComponent.slice(0, firstHyphen);\r\n    const interfaceVersion = operationComponent.slice(firstHyphen + 1, lastHyphen);\r\n    const operationName = operationComponent.slice(lastHyphen + 1);\r\n\r\n    return { interfaceDefinition, operationName, interfaceVersion, encodedRequest };\r\n  }\r\n\r\n  /** Supplies the OpenAPI-compatible URI path for an RPC operation. */\r\n  public override supplyPathForOperation(operation: RpcOperation, request: RpcRequest | undefined) {\r\n    const prefix = this.pathPrefix;\r\n    const appTitle = this.info.title;\r\n    const appVersion = this.info.version;\r\n    const operationId = `${operation.interfaceDefinition.interfaceName}-${operation.interfaceVersion}-${operation.operationName}`;\r\n\r\n    let appMode: string = \"\";\r\n    let iTwinId: string = \"\";\r\n    let iModelId: string = \"\";\r\n    let routeChangesetId: string | undefined;\r\n    /* Note: The changesetId field is omitted in the route in the case of ReadWrite connections since the connection is generally expected to be at the\r\n     * latest version and not some specific changeset. Also, for the first version (before any changesets), the changesetId in the route is arbitrarily\r\n     * set to \"0\" instead of an empty string, since the latter is more un-intuitive for a route. However, in all other use cases, including the changesetId\r\n     * held by the IModelRpcProps itself, the changesetId of \"\" (i.e., empty string) signifies the first version - this is more intuitive and retains\r\n     * compatibility with the majority of use cases. */\r\n\r\n    if (request === undefined) {\r\n      appMode = \"{modeId}\";\r\n      iTwinId = \"{iTwinId}\";\r\n      iModelId = \"{iModelId}\";\r\n      routeChangesetId = \"{changeSetId}\";\r\n    } else {\r\n      let token = operation.policy.token(request) || RpcOperation.fallbackToken;\r\n\r\n      if (!token || !token.iModelId) {\r\n        if (RpcConfiguration.disableRoutingValidation) {\r\n          token = { key: \"\" };\r\n        } else {\r\n          throw new IModelError(BentleyStatus.ERROR, \"Invalid iModelToken for RPC operation request\");\r\n        }\r\n      }\r\n\r\n      iTwinId = encodeURIComponent(token.iTwinId || \"\");\r\n      iModelId = encodeURIComponent(token.iModelId!);\r\n\r\n      routeChangesetId = token.changeset?.id || \"0\";\r\n      appMode = AppMode.MilestoneReview;\r\n    }\r\n\r\n    return `${prefix}/${appTitle}/${appVersion}/mode/${appMode}/context/${iTwinId}/imodel/${iModelId}${!!routeChangesetId ? `/changeset/${routeChangesetId}` : \"\"}/${operationId}`;\r\n  }\r\n\r\n  /**\r\n   * Inflates the IModelRpcProps from the URL path for each request on the backend.\r\n   * @note This function updates the IModelRpcProps value supplied in the request body.\r\n   */\r\n  public override inflateToken(tokenFromBody: IModelRpcProps, request: SerializedRpcRequest): IModelRpcProps {\r\n    const urlPathComponents = request.path.split(\"/\");\r\n\r\n    const iModelKey = tokenFromBody.key;\r\n    let iModelId = tokenFromBody.iModelId;\r\n    let iTwinId = tokenFromBody.iTwinId;\r\n    const changeset = { id: tokenFromBody.changeset?.id ?? \"0\", index: tokenFromBody.changeset?.index };\r\n\r\n    for (let i = 0; i <= urlPathComponents.length; ++i) {\r\n      const key = urlPathComponents[i];\r\n      const value = urlPathComponents[i + 1];\r\n      if (key === \"mode\") {\r\n        ++i;\r\n      } else if (key === \"context\") {\r\n        iTwinId = value;\r\n        ++i;\r\n      } else if (key === \"imodel\") {\r\n        iModelId = value;\r\n        ++i;\r\n      } else if (key === \"changeset\") {\r\n        changeset.id = (value === \"0\") ? \"\" : value;\r\n        ++i;\r\n      }\r\n    }\r\n\r\n    return { key: iModelKey, iTwinId, iModelId, changeset };\r\n  }\r\n\r\n  /** Returns the OpenAPI-compatible URI path parameters for an RPC operation.\r\n   * @internal\r\n   */\r\n  public supplyPathParametersForOperation(_operation: RpcOperation): OpenAPIParameter[] {\r\n    return [\r\n      { name: \"modeId\", in: \"path\", required: true, schema: { type: \"string\" } },\r\n      { name: \"iTwinId\", in: \"path\", required: true, schema: { type: \"string\" } },\r\n      { name: \"iModelId\", in: \"path\", required: true, schema: { type: \"string\" } },\r\n      { name: \"changeSetId\", in: \"path\", required: false, schema: { type: \"string\" } },\r\n    ];\r\n  }\r\n}\r\n"]}
+{"version":3,"file":"BentleyCloudRpcProtocol.js","sourceRoot":"","sources":["../../../../src/rpc/web/BentleyCloudRpcProtocol.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,sDAAoD;AAEpD,mDAAgD;AAChD,+DAA4D;AAC5D,uDAAoD;AAIpD,2DAAwD;AAGxD,4CAA4C;AAE5C,IAAK,OAEJ;AAFD,WAAK,OAAO;IACV,gCAAqB,CAAA;AACvB,CAAC,EAFI,OAAO,KAAP,OAAO,QAEX;AAED;;GAEG;AACH,MAAsB,uBAAwB,SAAQ,qCAAiB;IAAvE;;QACkB,eAAU,GAAG,IAAI,CAAC;QAElC,iFAAiF;QACjE,8CAAyC,GAA0B;YACjF,8CAA8C;YAC9C,EAAE,EAAE,kBAAkB;YAEtB,kDAAkD;YAClD,aAAa,EAAE,kBAAkB;YAEjC,uDAAuD;YACvD,kBAAkB,EAAE,uBAAuB;YAE3C,8CAA8C;YAC9C,SAAS,EAAE,cAAc;YAEzB,iDAAiD;YACjD,aAAa,EAAE,eAAe;SAC/B,CAAC;QAEF,mDAAmD;QACnC,8BAAyB,GAAG,oBAAoB,CAAC;IA6GnE,CAAC;IA3GC,yEAAyE;IACzD,oBAAoB,CAAC,IAAY;QAC/C,MAAM,GAAG,GAAG,IAAI,GAAG,CAAC,IAAI,EAAE,oBAAoB,CAAC,CAAC;QAChD,MAAM,UAAU,GAAG,GAAG,CAAC,QAAQ,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,4BAA4B;QAEzF,MAAM,kBAAkB,GAAG,UAAU,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;QACnD,MAAM,cAAc,GAAG,GAAG,CAAC,YAAY,CAAC,GAAG,CAAC,YAAY,CAAC,IAAI,EAAE,CAAC;QAEhE,mFAAmF;QACnF,IAAI,eAAe,CAAC,IAAI,CAAC,cAAc,CAAC;YACtC,MAAM,IAAI,yBAAW,CAAC,4BAAa,CAAC,KAAK,EAAE,qDAAqD,CAAC,CAAC;QAEpG,MAAM,WAAW,GAAG,kBAAkB,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;QACpD,MAAM,UAAU,GAAG,kBAAkB,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC;QACvD,MAAM,mBAAmB,GAAG,kBAAkB,CAAC,KAAK,CAAC,CAAC,EAAE,WAAW,CAAC,CAAC;QACrE,MAAM,gBAAgB,GAAG,kBAAkB,CAAC,KAAK,CAAC,WAAW,GAAG,CAAC,EAAE,UAAU,CAAC,CAAC;QAC/E,MAAM,aAAa,GAAG,kBAAkB,CAAC,KAAK,CAAC,UAAU,GAAG,CAAC,CAAC,CAAC;QAE/D,OAAO,EAAE,mBAAmB,EAAE,aAAa,EAAE,gBAAgB,EAAE,cAAc,EAAE,CAAC;IAClF,CAAC;IAED,qEAAqE;IACrD,sBAAsB,CAAC,SAAuB,EAAE,OAA+B;;QAC7F,MAAM,MAAM,GAAG,IAAI,CAAC,UAAU,CAAC;QAC/B,MAAM,QAAQ,GAAG,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC;QACjC,MAAM,UAAU,GAAG,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC;QACrC,MAAM,WAAW,GAAG,GAAG,SAAS,CAAC,mBAAmB,CAAC,aAAa,IAAI,SAAS,CAAC,gBAAgB,IAAI,SAAS,CAAC,aAAa,EAAE,CAAC;QAE9H,IAAI,OAAO,GAAW,EAAE,CAAC;QACzB,IAAI,OAAO,GAAW,EAAE,CAAC;QACzB,IAAI,QAAQ,GAAW,EAAE,CAAC;QAC1B,IAAI,gBAAoC,CAAC;QACzC;;;;2DAImD;QAEnD,IAAI,OAAO,KAAK,SAAS,EAAE;YACzB,OAAO,GAAG,UAAU,CAAC;YACrB,OAAO,GAAG,WAAW,CAAC;YACtB,QAAQ,GAAG,YAAY,CAAC;YACxB,gBAAgB,GAAG,eAAe,CAAC;SACpC;aAAM;YACL,IAAI,KAAK,GAAG,SAAS,CAAC,MAAM,CAAC,KAAK,CAAC,OAAO,CAAC,IAAI,2BAAY,CAAC,aAAa,CAAC;YAE1E,IAAI,CAAC,KAAK,IAAI,CAAC,KAAK,CAAC,QAAQ,EAAE;gBAC7B,IAAI,mCAAgB,CAAC,wBAAwB,EAAE;oBAC7C,KAAK,GAAG,EAAE,GAAG,EAAE,EAAE,EAAE,CAAC;iBACrB;qBAAM;oBACL,MAAM,IAAI,yBAAW,CAAC,4BAAa,CAAC,KAAK,EAAE,+CAA+C,CAAC,CAAC;iBAC7F;aACF;YAED,OAAO,GAAG,kBAAkB,CAAC,KAAK,CAAC,OAAO,IAAI,EAAE,CAAC,CAAC;YAClD,QAAQ,GAAG,kBAAkB,CAAC,KAAK,CAAC,QAAS,CAAC,CAAC;YAE/C,gBAAgB,GAAG,CAAA,MAAA,KAAK,CAAC,SAAS,0CAAE,EAAE,KAAI,GAAG,CAAC;YAC9C,OAAO,GAAG,OAAO,CAAC,eAAe,CAAC;SACnC;QAED,OAAO,GAAG,MAAM,IAAI,QAAQ,IAAI,UAAU,SAAS,OAAO,YAAY,OAAO,WAAW,QAAQ,GAAG,CAAC,CAAC,gBAAgB,CAAC,CAAC,CAAC,cAAc,gBAAgB,EAAE,CAAC,CAAC,CAAC,EAAE,IAAI,WAAW,EAAE,CAAC;IACjL,CAAC;IAED;;;OAGG;IACa,YAAY,CAAC,aAA6B,EAAE,OAA6B;;QACvF,MAAM,iBAAiB,GAAG,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;QAElD,MAAM,SAAS,GAAG,aAAa,CAAC,GAAG,CAAC;QACpC,IAAI,QAAQ,GAAG,aAAa,CAAC,QAAQ,CAAC;QACtC,IAAI,OAAO,GAAG,aAAa,CAAC,OAAO,CAAC;QACpC,MAAM,SAAS,GAAG,EAAE,EAAE,EAAE,MAAA,MAAA,aAAa,CAAC,SAAS,0CAAE,EAAE,mCAAI,GAAG,EAAE,KAAK,EAAE,MAAA,aAAa,CAAC,SAAS,0CAAE,KAAK,EAAE,CAAC;QAEpG,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,IAAI,iBAAiB,CAAC,MAAM,EAAE,EAAE,CAAC,EAAE;YAClD,MAAM,GAAG,GAAG,iBAAiB,CAAC,CAAC,CAAC,CAAC;YACjC,MAAM,KAAK,GAAG,iBAAiB,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC;YACvC,IAAI,GAAG,KAAK,MAAM,EAAE;gBAClB,EAAE,CAAC,CAAC;aACL;iBAAM,IAAI,GAAG,KAAK,SAAS,EAAE;gBAC5B,OAAO,GAAG,KAAK,CAAC;gBAChB,EAAE,CAAC,CAAC;aACL;iBAAM,IAAI,GAAG,KAAK,QAAQ,EAAE;gBAC3B,QAAQ,GAAG,KAAK,CAAC;gBACjB,EAAE,CAAC,CAAC;aACL;iBAAM,IAAI,GAAG,KAAK,WAAW,EAAE;gBAC9B,SAAS,CAAC,EAAE,GAAG,CAAC,KAAK,KAAK,GAAG,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,KAAK,CAAC;gBAC5C,EAAE,CAAC,CAAC;aACL;SACF;QAED,OAAO,EAAE,GAAG,EAAE,SAAS,EAAE,OAAO,EAAE,QAAQ,EAAE,SAAS,EAAE,CAAC;IAC1D,CAAC;IAED;;OAEG;IACI,gCAAgC,CAAC,UAAwB;QAC9D,OAAO;YACL,EAAE,IAAI,EAAE,QAAQ,EAAE,EAAE,EAAE,MAAM,EAAE,QAAQ,EAAE,IAAI,EAAE,MAAM,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,EAAE;YAC1E,EAAE,IAAI,EAAE,SAAS,EAAE,EAAE,EAAE,MAAM,EAAE,QAAQ,EAAE,IAAI,EAAE,MAAM,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,EAAE;YAC3E,EAAE,IAAI,EAAE,UAAU,EAAE,EAAE,EAAE,MAAM,EAAE,QAAQ,EAAE,IAAI,EAAE,MAAM,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,EAAE;YAC5E,EAAE,IAAI,EAAE,aAAa,EAAE,EAAE,EAAE,MAAM,EAAE,QAAQ,EAAE,KAAK,EAAE,MAAM,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,EAAE;SACjF,CAAC;IACJ,CAAC;CACF;AAnID,0DAmIC","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 } from \"@itwin/core-bentley\";\nimport { IModelRpcProps } from \"../../IModel\";\nimport { IModelError } from \"../../IModelError\";\nimport { RpcConfiguration } from \"../core/RpcConfiguration\";\nimport { RpcOperation } from \"../core/RpcOperation\";\nimport { SerializedRpcOperation, SerializedRpcRequest } from \"../core/RpcProtocol\";\nimport { RpcRequest } from \"../core/RpcRequest\";\nimport { OpenAPIParameter } from \"./OpenAPI\";\nimport { WebAppRpcProtocol } from \"./WebAppRpcProtocol\";\nimport { SerializedRpcActivity } from \"../core/RpcInvocation\";\n\n/* eslint-disable deprecation/deprecation */\n\nenum AppMode {\n  MilestoneReview = \"1\",\n}\n\n/** An http protocol for Bentley cloud RPC interface deployments.\n * @internal\n */\nexport abstract class BentleyCloudRpcProtocol extends WebAppRpcProtocol {\n  public override checkToken = true;\n\n  /** The name of various HTTP request headers based on client's request context */\n  public override serializedClientRequestContextHeaderNames: SerializedRpcActivity = {\n    /** The name of the HTTP request id header. */\n    id: \"X-Correlation-Id\",\n\n    /** The name of the HTTP application id header. */\n    applicationId: \"X-Application-Id\",\n\n    /** The name of the HTTP application version header. */\n    applicationVersion: \"X-Application-Version\",\n\n    /** The name of the HTTP session id header. */\n    sessionId: \"X-Session-Id\",\n\n    /** The name of the HTTP authorization header. */\n    authorization: \"Authorization\",\n  };\n\n  /** The name of the RPC protocol version header. */\n  public override protocolVersionHeaderName = \"X-Protocol-Version\";\n\n  /** Returns the operation specified by an OpenAPI-compatible URI path. */\n  public override getOperationFromPath(path: string): SerializedRpcOperation {\n    const url = new URL(path, \"https://localhost/\");\n    const components = url.pathname.split(\"/\").filter((x) => x); // filter out empty segments\n\n    const operationComponent = components.slice(-1)[0];\n    const encodedRequest = url.searchParams.get(\"parameters\") || \"\";\n\n    // The encodedRequest should be base64 - fail now if any other characters detected.\n    if (/[^A-z0-9=+\\/]/.test(encodedRequest))\n      throw new IModelError(BentleyStatus.ERROR, `Invalid request: Malformed URL parameters detected.`);\n\n    const firstHyphen = operationComponent.indexOf(\"-\");\n    const lastHyphen = operationComponent.lastIndexOf(\"-\");\n    const interfaceDefinition = operationComponent.slice(0, firstHyphen);\n    const interfaceVersion = operationComponent.slice(firstHyphen + 1, lastHyphen);\n    const operationName = operationComponent.slice(lastHyphen + 1);\n\n    return { interfaceDefinition, operationName, interfaceVersion, encodedRequest };\n  }\n\n  /** Supplies the OpenAPI-compatible URI path for an RPC operation. */\n  public override supplyPathForOperation(operation: RpcOperation, request: RpcRequest | undefined) {\n    const prefix = this.pathPrefix;\n    const appTitle = this.info.title;\n    const appVersion = this.info.version;\n    const operationId = `${operation.interfaceDefinition.interfaceName}-${operation.interfaceVersion}-${operation.operationName}`;\n\n    let appMode: string = \"\";\n    let iTwinId: string = \"\";\n    let iModelId: string = \"\";\n    let routeChangesetId: string | undefined;\n    /* Note: The changesetId field is omitted in the route in the case of ReadWrite connections since the connection is generally expected to be at the\n     * latest version and not some specific changeset. Also, for the first version (before any changesets), the changesetId in the route is arbitrarily\n     * set to \"0\" instead of an empty string, since the latter is more un-intuitive for a route. However, in all other use cases, including the changesetId\n     * held by the IModelRpcProps itself, the changesetId of \"\" (i.e., empty string) signifies the first version - this is more intuitive and retains\n     * compatibility with the majority of use cases. */\n\n    if (request === undefined) {\n      appMode = \"{modeId}\";\n      iTwinId = \"{iTwinId}\";\n      iModelId = \"{iModelId}\";\n      routeChangesetId = \"{changeSetId}\";\n    } else {\n      let token = operation.policy.token(request) || RpcOperation.fallbackToken;\n\n      if (!token || !token.iModelId) {\n        if (RpcConfiguration.disableRoutingValidation) {\n          token = { key: \"\" };\n        } else {\n          throw new IModelError(BentleyStatus.ERROR, \"Invalid iModelToken for RPC operation request\");\n        }\n      }\n\n      iTwinId = encodeURIComponent(token.iTwinId || \"\");\n      iModelId = encodeURIComponent(token.iModelId!);\n\n      routeChangesetId = token.changeset?.id || \"0\";\n      appMode = AppMode.MilestoneReview;\n    }\n\n    return `${prefix}/${appTitle}/${appVersion}/mode/${appMode}/context/${iTwinId}/imodel/${iModelId}${!!routeChangesetId ? `/changeset/${routeChangesetId}` : \"\"}/${operationId}`;\n  }\n\n  /**\n   * Inflates the IModelRpcProps from the URL path for each request on the backend.\n   * @note This function updates the IModelRpcProps value supplied in the request body.\n   */\n  public override inflateToken(tokenFromBody: IModelRpcProps, request: SerializedRpcRequest): IModelRpcProps {\n    const urlPathComponents = request.path.split(\"/\");\n\n    const iModelKey = tokenFromBody.key;\n    let iModelId = tokenFromBody.iModelId;\n    let iTwinId = tokenFromBody.iTwinId;\n    const changeset = { id: tokenFromBody.changeset?.id ?? \"0\", index: tokenFromBody.changeset?.index };\n\n    for (let i = 0; i <= urlPathComponents.length; ++i) {\n      const key = urlPathComponents[i];\n      const value = urlPathComponents[i + 1];\n      if (key === \"mode\") {\n        ++i;\n      } else if (key === \"context\") {\n        iTwinId = value;\n        ++i;\n      } else if (key === \"imodel\") {\n        iModelId = value;\n        ++i;\n      } else if (key === \"changeset\") {\n        changeset.id = (value === \"0\") ? \"\" : value;\n        ++i;\n      }\n    }\n\n    return { key: iModelKey, iTwinId, iModelId, changeset };\n  }\n\n  /** Returns the OpenAPI-compatible URI path parameters for an RPC operation.\n   * @internal\n   */\n  public supplyPathParametersForOperation(_operation: RpcOperation): OpenAPIParameter[] {\n    return [\n      { name: \"modeId\", in: \"path\", required: true, schema: { type: \"string\" } },\n      { name: \"iTwinId\", in: \"path\", required: true, schema: { type: \"string\" } },\n      { name: \"iModelId\", in: \"path\", required: true, schema: { type: \"string\" } },\n      { name: \"changeSetId\", in: \"path\", required: false, schema: { type: \"string\" } },\n    ];\n  }\n}\n"]}

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

@@ -1,140 +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
- */
-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/cjs/rpc/web/OpenAPI.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"OpenAPI.d.ts","sourceRoot":"","sources":["../../../../src/rpc/web/OpenAPI.ts"],"names":[],"mappings":"AAIA;;GAEG;AAGH,OAAO,EAAE,iBAAiB,EAAE,MAAM,qBAAqB,CAAC;AAExD;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B,OAAO,EAAE,OAAO,CAAC;IACjB,IAAI,EAAE,WAAW,CAAC;IAClB,KAAK,EAAE,YAAY,CAAC;CACrB;AAED;;GAEG;AACH,MAAM,WAAW,WAAW;IAC1B,KAAK,EAAE,MAAM,CAAC;IACd,OAAO,EAAE,MAAM,CAAC;CACjB;AAED;;GAEG;AACH,MAAM,WAAW,YAAY;IAC3B,CAAC,KAAK,EAAE,MAAM,GAAG,eAAe,CAAC;CAClC;AAED;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,GAAG,CAAC,EAAE,gBAAgB,CAAC;IACvB,GAAG,CAAC,EAAE,gBAAgB,CAAC;IACvB,IAAI,CAAC,EAAE,gBAAgB,CAAC;IACxB,MAAM,CAAC,EAAE,gBAAgB,CAAC;IAC1B,OAAO,CAAC,EAAE,gBAAgB,CAAC;IAC3B,IAAI,CAAC,EAAE,gBAAgB,CAAC;IACxB,KAAK,CAAC,EAAE,gBAAgB,CAAC;IACzB,KAAK,CAAC,EAAE,gBAAgB,CAAC;IACzB,UAAU,CAAC,EAAE,gBAAgB,EAAE,CAAC;CACjC;AAED;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC/B,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,UAAU,CAAC,EAAE,gBAAgB,EAAE,CAAC;IAChC,WAAW,CAAC,EAAE,kBAAkB,CAAC;IACjC,SAAS,EAAE,gBAAgB,CAAC;CAC7B;AAED;;GAEG;AACH,MAAM,WAAW,iBAAiB;IAChC,CAAC,KAAK,EAAE,MAAM,GAAG,gBAAgB,CAAC;CACnC;AAED;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC/B,IAAI,EAAE,MAAM,CAAC;IACb,EAAE,EAAE,OAAO,GAAG,QAAQ,GAAG,MAAM,GAAG,QAAQ,CAAC;IAC3C,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,eAAe,CAAC,EAAE,OAAO,CAAC;IAC1B,KAAK,CAAC,EAAE,QAAQ,GAAG,OAAO,GAAG,MAAM,GAAG,QAAQ,GAAG,gBAAgB,GAAG,eAAe,GAAG,YAAY,CAAC;IACnG,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,aAAa,CAAC,EAAE,OAAO,CAAC;IACxB,MAAM,CAAC,EAAE,aAAa,CAAC;IACvB,OAAO,CAAC,EAAE,iBAAiB,CAAC;CAC7B;AAED;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC/B,MAAM,CAAC,EAAE,aAAa,CAAC;CACxB;AAED;;GAEG;AACH,MAAM,WAAW,aAAa;IAC5B,IAAI,CAAC,EAAE,SAAS,GAAG,QAAQ,GAAG,OAAO,GAAG,QAAQ,GAAG,QAAQ,CAAC;IAC5D,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,aAAa,CAAC,EAAE,OAAO,CAAC;CACzB;AAED;;GAEG;AACH,MAAM,WAAW,kBAAkB;IACjC,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,OAAO,EAAE,iBAAiB,CAAC;IAC3B,QAAQ,CAAC,EAAE,OAAO,CAAC;CACpB;AAED;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC/B,OAAO,CAAC,EAAE,eAAe,CAAC;IAC1B,KAAK,CAAC,EAAE,eAAe,CAAC;IACxB,KAAK,CAAC,EAAE,eAAe,CAAC;IACxB,KAAK,CAAC,EAAE,eAAe,CAAC;IACxB,KAAK,CAAC,EAAE,eAAe,CAAC;IACxB,KAAK,CAAC,EAAE,eAAe,CAAC;IACxB,KAAK,CAAC,EAAE,eAAe,CAAC;CACzB;AAED;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B,WAAW,EAAE,MAAM,CAAC;IACpB,OAAO,CAAC,EAAE;QAAE,CAAC,KAAK,EAAE,MAAM,GAAG,gBAAgB,CAAA;KAAE,CAAC;CACjD;AAED;;GAEG;AACH,qBAAa,qBAAqB;IAChC,yCAAyC;IACzC,SAAgB,QAAQ,EAAE,iBAAiB,CAAC;IAE5C,iDAAiD;IACjD,IAAW,KAAK,IAAI,YAAY,CAW/B;IAED,oGAAoG;IACpG,IAAW,QAAQ,IAAI,eAAe,CAMrC;IAED,yDAAyD;gBACtC,QAAQ,EAAE,iBAAiB;IAI9C,wBAAwB;IACjB,MAAM;IAIb,OAAO,CAAC,mBAAmB;CAoB5B"}
+{"version":3,"file":"OpenAPI.d.ts","sourceRoot":"","sources":["../../../../src/rpc/web/OpenAPI.ts"],"names":[],"mappings":"AAIA;;GAEG;AAGH,OAAO,EAAE,iBAAiB,EAAE,MAAM,qBAAqB,CAAC;AAIxD;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B,OAAO,EAAE,OAAO,CAAC;IACjB,IAAI,EAAE,WAAW,CAAC;IAClB,KAAK,EAAE,YAAY,CAAC;CACrB;AAED;;;GAGG;AACH,MAAM,WAAW,WAAW;IAC1B,KAAK,EAAE,MAAM,CAAC;IACd,OAAO,EAAE,MAAM,CAAC;CACjB;AAED;;GAEG;AACH,MAAM,WAAW,YAAY;IAC3B,CAAC,KAAK,EAAE,MAAM,GAAG,eAAe,CAAC;CAClC;AAED;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,GAAG,CAAC,EAAE,gBAAgB,CAAC;IACvB,GAAG,CAAC,EAAE,gBAAgB,CAAC;IACvB,IAAI,CAAC,EAAE,gBAAgB,CAAC;IACxB,MAAM,CAAC,EAAE,gBAAgB,CAAC;IAC1B,OAAO,CAAC,EAAE,gBAAgB,CAAC;IAC3B,IAAI,CAAC,EAAE,gBAAgB,CAAC;IACxB,KAAK,CAAC,EAAE,gBAAgB,CAAC;IACzB,KAAK,CAAC,EAAE,gBAAgB,CAAC;IACzB,UAAU,CAAC,EAAE,gBAAgB,EAAE,CAAC;CACjC;AAED;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC/B,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,UAAU,CAAC,EAAE,gBAAgB,EAAE,CAAC;IAChC,WAAW,CAAC,EAAE,kBAAkB,CAAC;IACjC,SAAS,EAAE,gBAAgB,CAAC;CAC7B;AAED;;GAEG;AACH,MAAM,WAAW,iBAAiB;IAChC,CAAC,KAAK,EAAE,MAAM,GAAG,gBAAgB,CAAC;CACnC;AAED;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC/B,IAAI,EAAE,MAAM,CAAC;IACb,EAAE,EAAE,OAAO,GAAG,QAAQ,GAAG,MAAM,GAAG,QAAQ,CAAC;IAC3C,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,eAAe,CAAC,EAAE,OAAO,CAAC;IAC1B,KAAK,CAAC,EAAE,QAAQ,GAAG,OAAO,GAAG,MAAM,GAAG,QAAQ,GAAG,gBAAgB,GAAG,eAAe,GAAG,YAAY,CAAC;IACnG,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,aAAa,CAAC,EAAE,OAAO,CAAC;IACxB,MAAM,CAAC,EAAE,aAAa,CAAC;IACvB,OAAO,CAAC,EAAE,iBAAiB,CAAC;CAC7B;AAED;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC/B,MAAM,CAAC,EAAE,aAAa,CAAC;CACxB;AAED;;GAEG;AACH,MAAM,WAAW,aAAa;IAC5B,IAAI,CAAC,EAAE,SAAS,GAAG,QAAQ,GAAG,OAAO,GAAG,QAAQ,GAAG,QAAQ,CAAC;IAC5D,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,aAAa,CAAC,EAAE,OAAO,CAAC;CACzB;AAED;;GAEG;AACH,MAAM,WAAW,kBAAkB;IACjC,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,OAAO,EAAE,iBAAiB,CAAC;IAC3B,QAAQ,CAAC,EAAE,OAAO,CAAC;CACpB;AAED;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC/B,OAAO,CAAC,EAAE,eAAe,CAAC;IAC1B,KAAK,CAAC,EAAE,eAAe,CAAC;IACxB,KAAK,CAAC,EAAE,eAAe,CAAC;IACxB,KAAK,CAAC,EAAE,eAAe,CAAC;IACxB,KAAK,CAAC,EAAE,eAAe,CAAC;IACxB,KAAK,CAAC,EAAE,eAAe,CAAC;IACxB,KAAK,CAAC,EAAE,eAAe,CAAC;CACzB;AAED;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B,WAAW,EAAE,MAAM,CAAC;IACpB,OAAO,CAAC,EAAE;QAAE,CAAC,KAAK,EAAE,MAAM,GAAG,gBAAgB,CAAA;KAAE,CAAC;CACjD;AAED;;GAEG;AACH,qBAAa,qBAAqB;IAChC,yCAAyC;IACzC,SAAgB,QAAQ,EAAE,iBAAiB,CAAC;IAE5C,iDAAiD;IACjD,IAAW,KAAK,IAAI,YAAY,CAW/B;IAED,oGAAoG;IACpG,IAAW,QAAQ,IAAI,eAAe,CAMrC;IAED,yDAAyD;gBACtC,QAAQ,EAAE,iBAAiB;IAI9C,wBAAwB;IACjB,MAAM;IAIb,OAAO,CAAC,mBAAmB;CAoB5B"}

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

@@ -1,61 +1,61 @@
-"use strict";
-/*---------------------------------------------------------------------------------------------
-* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
-* See LICENSE.md in the project root for license terms and full copyright notice.
-*--------------------------------------------------------------------------------------------*/
-/** @packageDocumentation
- * @module RpcInterface
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.RpcOpenAPIDescription = void 0;
-const RpcOperation_1 = require("../core/RpcOperation");
-/** An OpenAPI-compatible description of an RPC protocol.
- * @internal
- */
-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_1.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;
-    }
-}
-exports.RpcOpenAPIDescription = RpcOpenAPIDescription;
+"use strict";
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+/** @packageDocumentation
+ * @module RpcInterface
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.RpcOpenAPIDescription = void 0;
+const RpcOperation_1 = require("../core/RpcOperation");
+/** An OpenAPI-compatible description of an RPC protocol.
+ * @internal
+ */
+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_1.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;
+    }
+}
+exports.RpcOpenAPIDescription = RpcOpenAPIDescription;
 //# sourceMappingURL=OpenAPI.js.map

package/lib/cjs/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,uDAAoD;AAqIpD;;GAEG;AACH,MAAa,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,2BAAY,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;AAzDD,sDAyDC","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/** 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 */\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,uDAAoD;AAwIpD;;GAEG;AACH,MAAa,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,2BAAY,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;AAzDD,sDAyDC","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/cjs/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