@itwin/core-common 4.1.0-dev.6 → 4.1.0-dev.7

package/lib/esm/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,OAAO,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAC;AAEpD,OAAO,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAC;AAChD,OAAO,EAAE,gBAAgB,EAAE,MAAM,0BAA0B,CAAC;AAC5D,OAAO,EAAE,YAAY,EAAE,MAAM,sBAAsB,CAAC;AAIpD,OAAO,EAAE,iBAAiB,EAAE,MAAM,qBAAqB,CAAC;AAGxD,4CAA4C;AAE5C,IAAK,OAEJ;AAFD,WAAK,OAAO;IACV,gCAAqB,CAAA;AACvB,CAAC,EAFI,OAAO,KAAP,OAAO,QAEX;AAED;;GAEG;AACH,MAAM,OAAgB,uBAAwB,SAAQ,iBAAiB;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,WAAW,CAAC,aAAa,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,YAAY,CAAC,aAAa,CAAC;YAE1E,IAAI,CAAC,KAAK,IAAI,CAAC,KAAK,CAAC,QAAQ,EAAE;gBAC7B,IAAI,gBAAgB,CAAC,wBAAwB,EAAE;oBAC7C,KAAK,GAAG,EAAE,GAAG,EAAE,EAAE,EAAE,CAAC;iBACrB;qBAAM;oBACL,MAAM,IAAI,WAAW,CAAC,aAAa,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,KAAK,CAAC,SAAS,EAAE,EAAE,IAAI,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,aAAa,CAAC,SAAS,EAAE,EAAE,IAAI,GAAG,EAAE,KAAK,EAAE,aAAa,CAAC,SAAS,EAAE,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","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\n/* eslint-disable deprecation/deprecation */\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,OAAO,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAC;AAEpD,OAAO,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAC;AAChD,OAAO,EAAE,gBAAgB,EAAE,MAAM,0BAA0B,CAAC;AAC5D,OAAO,EAAE,YAAY,EAAE,MAAM,sBAAsB,CAAC;AAIpD,OAAO,EAAE,iBAAiB,EAAE,MAAM,qBAAqB,CAAC;AAGxD,4CAA4C;AAE5C,IAAK,OAEJ;AAFD,WAAK,OAAO;IACV,gCAAqB,CAAA;AACvB,CAAC,EAFI,OAAO,KAAP,OAAO,QAEX;AAED;;GAEG;AACH,MAAM,OAAgB,uBAAwB,SAAQ,iBAAiB;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,mBAAmB,CAAC,IAAI,CAAC,cAAc,CAAC;YAC1C,MAAM,IAAI,WAAW,CAAC,aAAa,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,YAAY,CAAC,aAAa,CAAC;YAE1E,IAAI,CAAC,KAAK,IAAI,CAAC,KAAK,CAAC,QAAQ,EAAE;gBAC7B,IAAI,gBAAgB,CAAC,wBAAwB,EAAE;oBAC7C,KAAK,GAAG,EAAE,GAAG,EAAE,EAAE,EAAE,CAAC;iBACrB;qBAAM;oBACL,MAAM,IAAI,WAAW,CAAC,aAAa,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,KAAK,CAAC,SAAS,EAAE,EAAE,IAAI,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,aAAa,CAAC,SAAS,EAAE,EAAE,IAAI,GAAG,EAAE,KAAK,EAAE,aAAa,CAAC,SAAS,EAAE,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","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\n/* eslint-disable deprecation/deprecation */\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-zA-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"]}

package/package.json

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