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

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

@@ -1,69 +1,69 @@
-/*---------------------------------------------------------------------------------------------
-* 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 { RpcManager } from "../../RpcManager";
-import { RpcConfiguration } from "../core/RpcConfiguration";
-import { RpcRequestEvent } from "../core/RpcConstants";
-import { RpcRequest } from "../core/RpcRequest";
-import { BentleyCloudRpcProtocol } from "./BentleyCloudRpcProtocol";
-import { RpcRoutingToken } from "../core/RpcRoutingToken";
-/** Operating parameters for Bentley cloud RPC interface deployments.
- * @internal
- */
-export class BentleyCloudRpcConfiguration extends RpcConfiguration {
-}
-/** Access-Control header values for backend servers that serve frontends using BentleyCloudRpcProtocol. */
-BentleyCloudRpcConfiguration.accessControl = {
-    allowOrigin: "*",
-    allowMethods: "POST, GET, OPTIONS",
-    allowHeaders: "Content-Type, Access-Control-Allow-Headers, Authorization, X-Requested-With, X-Correlation-Id, X-Session-Id, X-Application-Id, X-Application-Version, X-User-Id, X-Protocol-Version",
-};
-/** Coordinates usage of RPC interfaces for Bentley cloud deployments.
- * @internal
- */
-export class BentleyCloudRpcManager extends RpcManager {
-    /** Initializes BentleyCloudRpcManager for the frontend of an application. */
-    static initializeClient(params, interfaces, routing = RpcRoutingToken.default) {
-        return BentleyCloudRpcManager.performInitialization(params, interfaces, routing);
-    }
-    /** Initializes BentleyCloudRpcManager for the backend of an application. */
-    static initializeImpl(params, interfaces) {
-        return BentleyCloudRpcManager.performInitialization(params, interfaces);
-    }
-    static performInitialization(params, interfaces, routing = RpcRoutingToken.default) {
-        const protocol = class extends (params.protocol || BentleyCloudRpcProtocol) {
-            constructor() {
-                super(...arguments);
-                this.pathPrefix = params.uriPrefix || "";
-                this.info = params.info;
-            }
-        };
-        const config = class extends BentleyCloudRpcConfiguration {
-            constructor() {
-                super(...arguments);
-                this.interfaces = () => interfaces;
-                this.protocol = new protocol(this);
-                this.routing = routing;
-            }
-        };
-        for (const def of interfaces) {
-            RpcConfiguration.assignWithRouting(def, routing, config);
-        }
-        const instance = RpcConfiguration.obtain(config);
-        RpcConfiguration.initializeInterfaces(instance);
-        if (params.pendingRequestListener) {
-            const listener = params.pendingRequestListener;
-            RpcRequest.events.addListener((type, request) => {
-                if (type === RpcRequestEvent.PendingUpdateReceived && request.protocol === instance.protocol) {
-                    listener(type, request);
-                }
-            });
-        }
-        return instance;
-    }
-}
+/*---------------------------------------------------------------------------------------------
+* 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 { RpcManager } from "../../RpcManager";
+import { RpcConfiguration } from "../core/RpcConfiguration";
+import { RpcRequestEvent } from "../core/RpcConstants";
+import { RpcRequest } from "../core/RpcRequest";
+import { BentleyCloudRpcProtocol } from "./BentleyCloudRpcProtocol";
+import { RpcRoutingToken } from "../core/RpcRoutingToken";
+/** Operating parameters for Bentley cloud RPC interface deployments.
+ * @internal
+ */
+export class BentleyCloudRpcConfiguration extends RpcConfiguration {
+}
+/** Access-Control header values for backend servers that serve frontends using BentleyCloudRpcProtocol. */
+BentleyCloudRpcConfiguration.accessControl = {
+    allowOrigin: "*",
+    allowMethods: "POST, GET, OPTIONS",
+    allowHeaders: "Content-Type, Access-Control-Allow-Headers, Authorization, X-Requested-With, X-Correlation-Id, X-Session-Id, X-Application-Id, X-Application-Version, X-User-Id, X-Protocol-Version",
+};
+/** Coordinates usage of RPC interfaces for Bentley cloud deployments.
+ * @internal
+ */
+export class BentleyCloudRpcManager extends RpcManager {
+    /** Initializes BentleyCloudRpcManager for the frontend of an application. */
+    static initializeClient(params, interfaces, routing = RpcRoutingToken.default) {
+        return BentleyCloudRpcManager.performInitialization(params, interfaces, routing);
+    }
+    /** Initializes BentleyCloudRpcManager for the backend of an application. */
+    static initializeImpl(params, interfaces) {
+        return BentleyCloudRpcManager.performInitialization(params, interfaces);
+    }
+    static performInitialization(params, interfaces, routing = RpcRoutingToken.default) {
+        const protocol = class extends (params.protocol || BentleyCloudRpcProtocol) {
+            constructor() {
+                super(...arguments);
+                this.pathPrefix = params.uriPrefix || "";
+                this.info = params.info;
+            }
+        };
+        const config = class extends BentleyCloudRpcConfiguration {
+            constructor() {
+                super(...arguments);
+                this.interfaces = () => interfaces;
+                this.protocol = new protocol(this);
+                this.routing = routing;
+            }
+        };
+        for (const def of interfaces) {
+            RpcConfiguration.assignWithRouting(def, routing, config);
+        }
+        const instance = RpcConfiguration.obtain(config);
+        RpcConfiguration.initializeInterfaces(instance);
+        if (params.pendingRequestListener) {
+            const listener = params.pendingRequestListener;
+            RpcRequest.events.addListener((type, request) => {
+                if (type === RpcRequestEvent.PendingUpdateReceived && request.protocol === instance.protocol) {
+                    listener(type, request);
+                }
+            });
+        }
+        return instance;
+    }
+}
 //# sourceMappingURL=BentleyCloudRpcManager.js.map

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

@@ -1 +1 @@
-{"version":3,"file":"BentleyCloudRpcManager.js","sourceRoot":"","sources":["../../../../src/rpc/web/BentleyCloudRpcManager.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAGH,OAAO,EAAE,UAAU,EAAE,MAAM,kBAAkB,CAAC;AAC9C,OAAO,EAAE,gBAAgB,EAAE,MAAM,0BAA0B,CAAC;AAC5D,OAAO,EAAE,eAAe,EAAE,MAAM,sBAAsB,CAAC;AACvD,OAAO,EAAE,UAAU,EAA0B,MAAM,oBAAoB,CAAC;AACxE,OAAO,EAAE,uBAAuB,EAAE,MAAM,2BAA2B,CAAC;AAEpE,OAAO,EAAE,eAAe,EAAE,MAAM,yBAAyB,CAAC;AAgB1D;;GAEG;AACH,MAAM,OAAgB,4BAA6B,SAAQ,gBAAgB;;AACzE,2GAA2G;AACpF,0CAAa,GAAG;IACrC,WAAW,EAAE,GAAG;IAChB,YAAY,EAAE,oBAAoB;IAClC,YAAY,EAAE,qLAAqL;CACpM,CAAC;AAMJ;;GAEG;AACH,MAAM,OAAO,sBAAuB,SAAQ,UAAU;IACpD,6EAA6E;IACtE,MAAM,CAAC,gBAAgB,CAAC,MAA6B,EAAE,UAAoC,EAAE,UAA2B,eAAe,CAAC,OAAO;QACpJ,OAAO,sBAAsB,CAAC,qBAAqB,CAAC,MAAM,EAAE,UAAU,EAAE,OAAO,CAAC,CAAC;IACnF,CAAC;IAED,4EAA4E;IACrE,MAAM,CAAC,cAAc,CAAC,MAA6B,EAAE,UAAoC;QAC9F,OAAO,sBAAsB,CAAC,qBAAqB,CAAC,MAAM,EAAE,UAAU,CAAC,CAAC;IAC1E,CAAC;IAEO,MAAM,CAAC,qBAAqB,CAAC,MAA6B,EAAE,UAAoC,EAAE,UAA2B,eAAe,CAAC,OAAO;QAC1J,MAAM,QAAQ,GAAG,KAAM,SAAQ,CAAC,MAAM,CAAC,QAAQ,IAAI,uBAAuB,CAAC;YAA1D;;gBACC,eAAU,GAAG,MAAM,CAAC,SAAS,IAAI,EAAE,CAAC;gBAC7C,SAAI,GAAG,MAAM,CAAC,IAAI,CAAC;YAC5B,CAAC;SAAA,CAAC;QAEF,MAAM,MAAM,GAAG,KAAM,SAAQ,4BAA4B;YAA1C;;gBACN,eAAU,GAAG,GAAG,EAAE,CAAC,UAAU,CAAC;gBAC9B,aAAQ,GAA4B,IAAI,QAAQ,CAAC,IAAI,CAAC,CAAC;gBAC9C,YAAO,GAAG,OAAO,CAAC;YACpC,CAAC;SAAA,CAAC;QAEF,KAAK,MAAM,GAAG,IAAI,UAAU,EAAE;YAC5B,gBAAgB,CAAC,iBAAiB,CAAC,GAAG,EAAE,OAAO,EAAE,MAAM,CAAC,CAAC;SAC1D;QAED,MAAM,QAAQ,GAAG,gBAAgB,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;QACjD,gBAAgB,CAAC,oBAAoB,CAAC,QAAQ,CAAC,CAAC;QAEhD,IAAI,MAAM,CAAC,sBAAsB,EAAE;YACjC,MAAM,QAAQ,GAAG,MAAM,CAAC,sBAAsB,CAAC;YAE/C,UAAU,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC,IAAI,EAAE,OAAO,EAAE,EAAE;gBAC9C,IAAI,IAAI,KAAK,eAAe,CAAC,qBAAqB,IAAI,OAAO,CAAC,QAAQ,KAAK,QAAQ,CAAC,QAAQ,EAAE;oBAC5F,QAAQ,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;iBACzB;YACH,CAAC,CAAC,CAAC;SACJ;QAED,OAAO,QAAQ,CAAC;IAClB,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 { RpcInterfaceDefinition } from \"../../RpcInterface\";\r\nimport { RpcManager } from \"../../RpcManager\";\r\nimport { RpcConfiguration } from \"../core/RpcConfiguration\";\r\nimport { RpcRequestEvent } from \"../core/RpcConstants\";\r\nimport { RpcRequest, RpcRequestEventHandler } from \"../core/RpcRequest\";\r\nimport { BentleyCloudRpcProtocol } from \"./BentleyCloudRpcProtocol\";\r\nimport { OpenAPIInfo } from \"./OpenAPI\";\r\nimport { RpcRoutingToken } from \"../core/RpcRoutingToken\";\r\n\r\n/** Initialization parameters for BentleyCloudRpcConfiguration.\r\n * @internal\r\n */\r\nexport interface BentleyCloudRpcParams {\r\n  /** Identifies the remote server that implements a set of RpcInterfaces. Note that the ID of the remote server is not a URI or hostname. It is a string that matches a key in the orchestrator's app registry. */\r\n  info: OpenAPIInfo;\r\n  /** The protocol for Bentley cloud RPC interface deployments */\r\n  protocol?: typeof BentleyCloudRpcProtocol;\r\n  /** The URI of the orchestrator that will route requests to the remote RpcInterface server. If not supplied, this default to the origin of the Web page. This is required only when calling initializeClient and only if the server is not the origin of the Web page. */\r\n  uriPrefix?: string;\r\n  /** Handler for RPC request events. */\r\n  pendingRequestListener?: RpcRequestEventHandler;\r\n}\r\n\r\n/** Operating parameters for Bentley cloud RPC interface deployments.\r\n * @internal\r\n */\r\nexport abstract class BentleyCloudRpcConfiguration extends RpcConfiguration {\r\n  /** Access-Control header values for backend servers that serve frontends using BentleyCloudRpcProtocol. */\r\n  public static readonly accessControl = {\r\n    allowOrigin: \"*\",\r\n    allowMethods: \"POST, GET, OPTIONS\",\r\n    allowHeaders: \"Content-Type, Access-Control-Allow-Headers, Authorization, X-Requested-With, X-Correlation-Id, X-Session-Id, X-Application-Id, X-Application-Version, X-User-Id, X-Protocol-Version\",\r\n  };\r\n\r\n  /** The protocol of the configuration. */\r\n  public abstract override readonly protocol: BentleyCloudRpcProtocol;\r\n}\r\n\r\n/** Coordinates usage of RPC interfaces for Bentley cloud deployments.\r\n * @internal\r\n */\r\nexport class BentleyCloudRpcManager extends RpcManager {\r\n  /** Initializes BentleyCloudRpcManager for the frontend of an application. */\r\n  public static initializeClient(params: BentleyCloudRpcParams, interfaces: RpcInterfaceDefinition[], routing: RpcRoutingToken = RpcRoutingToken.default): BentleyCloudRpcConfiguration {\r\n    return BentleyCloudRpcManager.performInitialization(params, interfaces, routing);\r\n  }\r\n\r\n  /** Initializes BentleyCloudRpcManager for the backend of an application. */\r\n  public static initializeImpl(params: BentleyCloudRpcParams, interfaces: RpcInterfaceDefinition[]): BentleyCloudRpcConfiguration {\r\n    return BentleyCloudRpcManager.performInitialization(params, interfaces);\r\n  }\r\n\r\n  private static performInitialization(params: BentleyCloudRpcParams, interfaces: RpcInterfaceDefinition[], routing: RpcRoutingToken = RpcRoutingToken.default): BentleyCloudRpcConfiguration {\r\n    const protocol = class extends (params.protocol || BentleyCloudRpcProtocol) {\r\n      public override pathPrefix = params.uriPrefix || \"\";\r\n      public info = params.info;\r\n    };\r\n\r\n    const config = class extends BentleyCloudRpcConfiguration {\r\n      public interfaces = () => interfaces;\r\n      public protocol: BentleyCloudRpcProtocol = new protocol(this);\r\n      public override routing = routing;\r\n    };\r\n\r\n    for (const def of interfaces) {\r\n      RpcConfiguration.assignWithRouting(def, routing, config);\r\n    }\r\n\r\n    const instance = RpcConfiguration.obtain(config);\r\n    RpcConfiguration.initializeInterfaces(instance);\r\n\r\n    if (params.pendingRequestListener) {\r\n      const listener = params.pendingRequestListener;\r\n\r\n      RpcRequest.events.addListener((type, request) => {\r\n        if (type === RpcRequestEvent.PendingUpdateReceived && request.protocol === instance.protocol) {\r\n          listener(type, request);\r\n        }\r\n      });\r\n    }\r\n\r\n    return instance;\r\n  }\r\n}\r\n"]}
+{"version":3,"file":"BentleyCloudRpcManager.js","sourceRoot":"","sources":["../../../../src/rpc/web/BentleyCloudRpcManager.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAGH,OAAO,EAAE,UAAU,EAAE,MAAM,kBAAkB,CAAC;AAC9C,OAAO,EAAE,gBAAgB,EAAE,MAAM,0BAA0B,CAAC;AAC5D,OAAO,EAAE,eAAe,EAAE,MAAM,sBAAsB,CAAC;AACvD,OAAO,EAAE,UAAU,EAA0B,MAAM,oBAAoB,CAAC;AACxE,OAAO,EAAE,uBAAuB,EAAE,MAAM,2BAA2B,CAAC;AAEpE,OAAO,EAAE,eAAe,EAAE,MAAM,yBAAyB,CAAC;AAgB1D;;GAEG;AACH,MAAM,OAAgB,4BAA6B,SAAQ,gBAAgB;;AACzE,2GAA2G;AACpF,0CAAa,GAAG;IACrC,WAAW,EAAE,GAAG;IAChB,YAAY,EAAE,oBAAoB;IAClC,YAAY,EAAE,qLAAqL;CACpM,CAAC;AAMJ;;GAEG;AACH,MAAM,OAAO,sBAAuB,SAAQ,UAAU;IACpD,6EAA6E;IACtE,MAAM,CAAC,gBAAgB,CAAC,MAA6B,EAAE,UAAoC,EAAE,UAA2B,eAAe,CAAC,OAAO;QACpJ,OAAO,sBAAsB,CAAC,qBAAqB,CAAC,MAAM,EAAE,UAAU,EAAE,OAAO,CAAC,CAAC;IACnF,CAAC;IAED,4EAA4E;IACrE,MAAM,CAAC,cAAc,CAAC,MAA6B,EAAE,UAAoC;QAC9F,OAAO,sBAAsB,CAAC,qBAAqB,CAAC,MAAM,EAAE,UAAU,CAAC,CAAC;IAC1E,CAAC;IAEO,MAAM,CAAC,qBAAqB,CAAC,MAA6B,EAAE,UAAoC,EAAE,UAA2B,eAAe,CAAC,OAAO;QAC1J,MAAM,QAAQ,GAAG,KAAM,SAAQ,CAAC,MAAM,CAAC,QAAQ,IAAI,uBAAuB,CAAC;YAA1D;;gBACC,eAAU,GAAG,MAAM,CAAC,SAAS,IAAI,EAAE,CAAC;gBAC7C,SAAI,GAAG,MAAM,CAAC,IAAI,CAAC;YAC5B,CAAC;SAAA,CAAC;QAEF,MAAM,MAAM,GAAG,KAAM,SAAQ,4BAA4B;YAA1C;;gBACN,eAAU,GAAG,GAAG,EAAE,CAAC,UAAU,CAAC;gBAC9B,aAAQ,GAA4B,IAAI,QAAQ,CAAC,IAAI,CAAC,CAAC;gBAC9C,YAAO,GAAG,OAAO,CAAC;YACpC,CAAC;SAAA,CAAC;QAEF,KAAK,MAAM,GAAG,IAAI,UAAU,EAAE;YAC5B,gBAAgB,CAAC,iBAAiB,CAAC,GAAG,EAAE,OAAO,EAAE,MAAM,CAAC,CAAC;SAC1D;QAED,MAAM,QAAQ,GAAG,gBAAgB,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;QACjD,gBAAgB,CAAC,oBAAoB,CAAC,QAAQ,CAAC,CAAC;QAEhD,IAAI,MAAM,CAAC,sBAAsB,EAAE;YACjC,MAAM,QAAQ,GAAG,MAAM,CAAC,sBAAsB,CAAC;YAE/C,UAAU,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC,IAAI,EAAE,OAAO,EAAE,EAAE;gBAC9C,IAAI,IAAI,KAAK,eAAe,CAAC,qBAAqB,IAAI,OAAO,CAAC,QAAQ,KAAK,QAAQ,CAAC,QAAQ,EAAE;oBAC5F,QAAQ,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;iBACzB;YACH,CAAC,CAAC,CAAC;SACJ;QAED,OAAO,QAAQ,CAAC;IAClB,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 { RpcInterfaceDefinition } from \"../../RpcInterface\";\nimport { RpcManager } from \"../../RpcManager\";\nimport { RpcConfiguration } from \"../core/RpcConfiguration\";\nimport { RpcRequestEvent } from \"../core/RpcConstants\";\nimport { RpcRequest, RpcRequestEventHandler } from \"../core/RpcRequest\";\nimport { BentleyCloudRpcProtocol } from \"./BentleyCloudRpcProtocol\";\nimport { OpenAPIInfo } from \"./OpenAPI\";\nimport { RpcRoutingToken } from \"../core/RpcRoutingToken\";\n\n/** Initialization parameters for BentleyCloudRpcConfiguration.\n * @internal\n */\nexport interface BentleyCloudRpcParams {\n  /** Identifies the remote server that implements a set of RpcInterfaces. Note that the ID of the remote server is not a URI or hostname. It is a string that matches a key in the orchestrator's app registry. */\n  info: OpenAPIInfo;\n  /** The protocol for Bentley cloud RPC interface deployments */\n  protocol?: typeof BentleyCloudRpcProtocol;\n  /** The URI of the orchestrator that will route requests to the remote RpcInterface server. If not supplied, this default to the origin of the Web page. This is required only when calling initializeClient and only if the server is not the origin of the Web page. */\n  uriPrefix?: string;\n  /** Handler for RPC request events. */\n  pendingRequestListener?: RpcRequestEventHandler;\n}\n\n/** Operating parameters for Bentley cloud RPC interface deployments.\n * @internal\n */\nexport abstract class BentleyCloudRpcConfiguration extends RpcConfiguration {\n  /** Access-Control header values for backend servers that serve frontends using BentleyCloudRpcProtocol. */\n  public static readonly accessControl = {\n    allowOrigin: \"*\",\n    allowMethods: \"POST, GET, OPTIONS\",\n    allowHeaders: \"Content-Type, Access-Control-Allow-Headers, Authorization, X-Requested-With, X-Correlation-Id, X-Session-Id, X-Application-Id, X-Application-Version, X-User-Id, X-Protocol-Version\",\n  };\n\n  /** The protocol of the configuration. */\n  public abstract override readonly protocol: BentleyCloudRpcProtocol;\n}\n\n/** Coordinates usage of RPC interfaces for Bentley cloud deployments.\n * @internal\n */\nexport class BentleyCloudRpcManager extends RpcManager {\n  /** Initializes BentleyCloudRpcManager for the frontend of an application. */\n  public static initializeClient(params: BentleyCloudRpcParams, interfaces: RpcInterfaceDefinition[], routing: RpcRoutingToken = RpcRoutingToken.default): BentleyCloudRpcConfiguration {\n    return BentleyCloudRpcManager.performInitialization(params, interfaces, routing);\n  }\n\n  /** Initializes BentleyCloudRpcManager for the backend of an application. */\n  public static initializeImpl(params: BentleyCloudRpcParams, interfaces: RpcInterfaceDefinition[]): BentleyCloudRpcConfiguration {\n    return BentleyCloudRpcManager.performInitialization(params, interfaces);\n  }\n\n  private static performInitialization(params: BentleyCloudRpcParams, interfaces: RpcInterfaceDefinition[], routing: RpcRoutingToken = RpcRoutingToken.default): BentleyCloudRpcConfiguration {\n    const protocol = class extends (params.protocol || BentleyCloudRpcProtocol) {\n      public override pathPrefix = params.uriPrefix || \"\";\n      public info = params.info;\n    };\n\n    const config = class extends BentleyCloudRpcConfiguration {\n      public interfaces = () => interfaces;\n      public protocol: BentleyCloudRpcProtocol = new protocol(this);\n      public override routing = routing;\n    };\n\n    for (const def of interfaces) {\n      RpcConfiguration.assignWithRouting(def, routing, config);\n    }\n\n    const instance = RpcConfiguration.obtain(config);\n    RpcConfiguration.initializeInterfaces(instance);\n\n    if (params.pendingRequestListener) {\n      const listener = params.pendingRequestListener;\n\n      RpcRequest.events.addListener((type, request) => {\n        if (type === RpcRequestEvent.PendingUpdateReceived && request.protocol === instance.protocol) {\n          listener(type, request);\n        }\n      });\n    }\n\n    return instance;\n  }\n}\n"]}

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

@@ -1,34 +1,34 @@
-/** @packageDocumentation
- * @module RpcInterface
- */
-import { IModelRpcProps } from "../../IModel";
-import { RpcOperation } from "../core/RpcOperation";
-import { SerializedRpcOperation, SerializedRpcRequest } from "../core/RpcProtocol";
-import { RpcRequest } from "../core/RpcRequest";
-import { OpenAPIParameter } from "./OpenAPI";
-import { WebAppRpcProtocol } from "./WebAppRpcProtocol";
-import { SerializedRpcActivity } from "../core/RpcInvocation";
-/** An http protocol for Bentley cloud RPC interface deployments.
- * @internal
- */
-export declare abstract class BentleyCloudRpcProtocol extends WebAppRpcProtocol {
-    checkToken: boolean;
-    /** The name of various HTTP request headers based on client's request context */
-    serializedClientRequestContextHeaderNames: SerializedRpcActivity;
-    /** The name of the RPC protocol version header. */
-    protocolVersionHeaderName: string;
-    /** Returns the operation specified by an OpenAPI-compatible URI path. */
-    getOperationFromPath(path: string): SerializedRpcOperation;
-    /** Supplies the OpenAPI-compatible URI path for an RPC operation. */
-    supplyPathForOperation(operation: RpcOperation, request: RpcRequest | undefined): string;
-    /**
-     * Inflates the IModelRpcProps from the URL path for each request on the backend.
-     * @note This function updates the IModelRpcProps value supplied in the request body.
-     */
-    inflateToken(tokenFromBody: IModelRpcProps, request: SerializedRpcRequest): IModelRpcProps;
-    /** Returns the OpenAPI-compatible URI path parameters for an RPC operation.
-     * @internal
-     */
-    supplyPathParametersForOperation(_operation: RpcOperation): OpenAPIParameter[];
-}
+/** @packageDocumentation
+ * @module RpcInterface
+ */
+import { IModelRpcProps } from "../../IModel";
+import { RpcOperation } from "../core/RpcOperation";
+import { SerializedRpcOperation, SerializedRpcRequest } from "../core/RpcProtocol";
+import { RpcRequest } from "../core/RpcRequest";
+import { OpenAPIParameter } from "./OpenAPI";
+import { WebAppRpcProtocol } from "./WebAppRpcProtocol";
+import { SerializedRpcActivity } from "../core/RpcInvocation";
+/** An http protocol for Bentley cloud RPC interface deployments.
+ * @internal
+ */
+export declare abstract class BentleyCloudRpcProtocol extends WebAppRpcProtocol {
+    checkToken: boolean;
+    /** The name of various HTTP request headers based on client's request context */
+    serializedClientRequestContextHeaderNames: SerializedRpcActivity;
+    /** The name of the RPC protocol version header. */
+    protocolVersionHeaderName: string;
+    /** Returns the operation specified by an OpenAPI-compatible URI path. */
+    getOperationFromPath(path: string): SerializedRpcOperation;
+    /** Supplies the OpenAPI-compatible URI path for an RPC operation. */
+    supplyPathForOperation(operation: RpcOperation, request: RpcRequest | undefined): string;
+    /**
+     * Inflates the IModelRpcProps from the URL path for each request on the backend.
+     * @note This function updates the IModelRpcProps value supplied in the request body.
+     */
+    inflateToken(tokenFromBody: IModelRpcProps, request: SerializedRpcRequest): IModelRpcProps;
+    /** Returns the OpenAPI-compatible URI path parameters for an RPC operation.
+     * @internal
+     */
+    supplyPathParametersForOperation(_operation: RpcOperation): OpenAPIParameter[];
+}
 //# sourceMappingURL=BentleyCloudRpcProtocol.d.ts.map

package/lib/esm/rpc/web/BentleyCloudRpcProtocol.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"BentleyCloudRpcProtocol.d.ts","sourceRoot":"","sources":["../../../../src/rpc/web/BentleyCloudRpcProtocol.ts"],"names":[],"mappings":"AAIA;;GAEG;AAGH,OAAO,EAAE,cAAc,EAAE,MAAM,cAAc,CAAC;AAG9C,OAAO,EAAE,YAAY,EAAE,MAAM,sBAAsB,CAAC;AACpD,OAAO,EAAE,sBAAsB,EAAE,oBAAoB,EAAE,MAAM,qBAAqB,CAAC;AACnF,OAAO,EAAE,UAAU,EAAE,MAAM,oBAAoB,CAAC;AAChD,OAAO,EAAE,gBAAgB,EAAE,MAAM,WAAW,CAAC;AAC7C,OAAO,EAAE,iBAAiB,EAAE,MAAM,qBAAqB,CAAC;AACxD,OAAO,EAAE,qBAAqB,EAAE,MAAM,uBAAuB,CAAC;AAM9D;;GAEG;AACH,8BAAsB,uBAAwB,SAAQ,iBAAiB;IACrD,UAAU,UAAQ;IAElC,iFAAiF;IACjE,yCAAyC,EAAE,qBAAqB,CAe9E;IAEF,mDAAmD;IACnC,yBAAyB,SAAwB;IAEjE,yEAAyE;IACzD,oBAAoB,CAAC,IAAI,EAAE,MAAM,GAAG,sBAAsB;IAgB1E,qEAAqE;IACrD,sBAAsB,CAAC,SAAS,EAAE,YAAY,EAAE,OAAO,EAAE,UAAU,GAAG,SAAS;IA0C/F;;;OAGG;IACa,YAAY,CAAC,aAAa,EAAE,cAAc,EAAE,OAAO,EAAE,oBAAoB,GAAG,cAAc;IA4B1G;;OAEG;IACI,gCAAgC,CAAC,UAAU,EAAE,YAAY,GAAG,gBAAgB,EAAE;CAQtF"}
+{"version":3,"file":"BentleyCloudRpcProtocol.d.ts","sourceRoot":"","sources":["../../../../src/rpc/web/BentleyCloudRpcProtocol.ts"],"names":[],"mappings":"AAIA;;GAEG;AAGH,OAAO,EAAE,cAAc,EAAE,MAAM,cAAc,CAAC;AAG9C,OAAO,EAAE,YAAY,EAAE,MAAM,sBAAsB,CAAC;AACpD,OAAO,EAAE,sBAAsB,EAAE,oBAAoB,EAAE,MAAM,qBAAqB,CAAC;AACnF,OAAO,EAAE,UAAU,EAAE,MAAM,oBAAoB,CAAC;AAChD,OAAO,EAAE,gBAAgB,EAAE,MAAM,WAAW,CAAC;AAC7C,OAAO,EAAE,iBAAiB,EAAE,MAAM,qBAAqB,CAAC;AACxD,OAAO,EAAE,qBAAqB,EAAE,MAAM,uBAAuB,CAAC;AAM9D;;GAEG;AACH,8BAAsB,uBAAwB,SAAQ,iBAAiB;IACrD,UAAU,UAAQ;IAElC,iFAAiF;IACjE,yCAAyC,EAAE,qBAAqB,CAe9E;IAEF,mDAAmD;IACnC,yBAAyB,SAAwB;IAEjE,yEAAyE;IACzD,oBAAoB,CAAC,IAAI,EAAE,MAAM,GAAG,sBAAsB;IAoB1E,qEAAqE;IACrD,sBAAsB,CAAC,SAAS,EAAE,YAAY,EAAE,OAAO,EAAE,UAAU,GAAG,SAAS;IA0C/F;;;OAGG;IACa,YAAY,CAAC,aAAa,EAAE,cAAc,EAAE,OAAO,EAAE,oBAAoB,GAAG,cAAc;IA4B1G;;OAEG;IACI,gCAAgC,CAAC,UAAU,EAAE,YAAY,GAAG,gBAAgB,EAAE;CAQtF"}

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

@@ -1,136 +1,139 @@
-/*---------------------------------------------------------------------------------------------
-* 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 } from "@itwin/core-bentley";
-import { IModelError } from "../../IModelError";
-import { RpcConfiguration } from "../core/RpcConfiguration";
-import { RpcOperation } from "../core/RpcOperation";
-import { WebAppRpcProtocol } from "./WebAppRpcProtocol";
-var AppMode;
-(function (AppMode) {
-    AppMode["MilestoneReview"] = "1";
-})(AppMode || (AppMode = {}));
-/** An http protocol for Bentley cloud RPC interface deployments.
- * @internal
- */
-export class BentleyCloudRpcProtocol extends WebAppRpcProtocol {
-    constructor() {
-        super(...arguments);
-        this.checkToken = true;
-        /** The name of various HTTP request headers based on client's request context */
-        this.serializedClientRequestContextHeaderNames = {
-            /** The name of the HTTP request id header. */
-            id: "X-Correlation-Id",
-            /** The name of the HTTP application id header. */
-            applicationId: "X-Application-Id",
-            /** The name of the HTTP application version header. */
-            applicationVersion: "X-Application-Version",
-            /** The name of the HTTP session id header. */
-            sessionId: "X-Session-Id",
-            /** The name of the HTTP authorization header. */
-            authorization: "Authorization",
-        };
-        /** The name of the RPC protocol version header. */
-        this.protocolVersionHeaderName = "X-Protocol-Version";
-    }
-    /** Returns the operation specified by an OpenAPI-compatible URI path. */
-    getOperationFromPath(path) {
-        const url = new URL(path, "https://localhost/");
-        const components = url.pathname.split("/").filter((x) => x); // filter out empty segments
-        const operationComponent = components.slice(-1)[0];
-        const encodedRequest = url.searchParams.get("parameters") || "";
-        const firstHyphen = operationComponent.indexOf("-");
-        const lastHyphen = operationComponent.lastIndexOf("-");
-        const interfaceDefinition = operationComponent.slice(0, firstHyphen);
-        const interfaceVersion = operationComponent.slice(firstHyphen + 1, lastHyphen);
-        const operationName = operationComponent.slice(lastHyphen + 1);
-        return { interfaceDefinition, operationName, interfaceVersion, encodedRequest };
-    }
-    /** Supplies the OpenAPI-compatible URI path for an RPC operation. */
-    supplyPathForOperation(operation, request) {
-        var _a;
-        const prefix = this.pathPrefix;
-        const appTitle = this.info.title;
-        const appVersion = this.info.version;
-        const operationId = `${operation.interfaceDefinition.interfaceName}-${operation.interfaceVersion}-${operation.operationName}`;
-        let appMode = "";
-        let iTwinId = "";
-        let iModelId = "";
-        let routeChangesetId;
-        /* 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
-         * latest version and not some specific changeset. Also, for the first version (before any changesets), the changesetId in the route is arbitrarily
-         * 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
-         * held by the IModelRpcProps itself, the changesetId of "" (i.e., empty string) signifies the first version - this is more intuitive and retains
-         * compatibility with the majority of use cases. */
-        if (request === undefined) {
-            appMode = "{modeId}";
-            iTwinId = "{iTwinId}";
-            iModelId = "{iModelId}";
-            routeChangesetId = "{changeSetId}";
-        }
-        else {
-            let token = operation.policy.token(request) || RpcOperation.fallbackToken;
-            if (!token || !token.iModelId) {
-                if (RpcConfiguration.disableRoutingValidation) {
-                    token = { key: "" };
-                }
-                else {
-                    throw new IModelError(BentleyStatus.ERROR, "Invalid iModelToken for RPC operation request");
-                }
-            }
-            iTwinId = encodeURIComponent(token.iTwinId || "");
-            iModelId = encodeURIComponent(token.iModelId);
-            routeChangesetId = ((_a = token.changeset) === null || _a === void 0 ? void 0 : _a.id) || "0";
-            appMode = AppMode.MilestoneReview;
-        }
-        return `${prefix}/${appTitle}/${appVersion}/mode/${appMode}/context/${iTwinId}/imodel/${iModelId}${!!routeChangesetId ? `/changeset/${routeChangesetId}` : ""}/${operationId}`;
-    }
-    /**
-     * Inflates the IModelRpcProps from the URL path for each request on the backend.
-     * @note This function updates the IModelRpcProps value supplied in the request body.
-     */
-    inflateToken(tokenFromBody, request) {
-        var _a, _b, _c;
-        const urlPathComponents = request.path.split("/");
-        const iModelKey = tokenFromBody.key;
-        let iModelId = tokenFromBody.iModelId;
-        let iTwinId = tokenFromBody.iTwinId;
-        const changeset = { id: (_b = (_a = tokenFromBody.changeset) === null || _a === void 0 ? void 0 : _a.id) !== null && _b !== void 0 ? _b : "0", index: (_c = tokenFromBody.changeset) === null || _c === void 0 ? void 0 : _c.index };
-        for (let i = 0; i <= urlPathComponents.length; ++i) {
-            const key = urlPathComponents[i];
-            const value = urlPathComponents[i + 1];
-            if (key === "mode") {
-                ++i;
-            }
-            else if (key === "context") {
-                iTwinId = value;
-                ++i;
-            }
-            else if (key === "imodel") {
-                iModelId = value;
-                ++i;
-            }
-            else if (key === "changeset") {
-                changeset.id = (value === "0") ? "" : value;
-                ++i;
-            }
-        }
-        return { key: iModelKey, iTwinId, iModelId, changeset };
-    }
-    /** Returns the OpenAPI-compatible URI path parameters for an RPC operation.
-     * @internal
-     */
-    supplyPathParametersForOperation(_operation) {
-        return [
-            { name: "modeId", in: "path", required: true, schema: { type: "string" } },
-            { name: "iTwinId", in: "path", required: true, schema: { type: "string" } },
-            { name: "iModelId", in: "path", required: true, schema: { type: "string" } },
-            { name: "changeSetId", in: "path", required: false, schema: { type: "string" } },
-        ];
-    }
-}
+/*---------------------------------------------------------------------------------------------
+* 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 } from "@itwin/core-bentley";
+import { IModelError } from "../../IModelError";
+import { RpcConfiguration } from "../core/RpcConfiguration";
+import { RpcOperation } from "../core/RpcOperation";
+import { WebAppRpcProtocol } from "./WebAppRpcProtocol";
+var AppMode;
+(function (AppMode) {
+    AppMode["MilestoneReview"] = "1";
+})(AppMode || (AppMode = {}));
+/** An http protocol for Bentley cloud RPC interface deployments.
+ * @internal
+ */
+export class BentleyCloudRpcProtocol extends WebAppRpcProtocol {
+    constructor() {
+        super(...arguments);
+        this.checkToken = true;
+        /** The name of various HTTP request headers based on client's request context */
+        this.serializedClientRequestContextHeaderNames = {
+            /** The name of the HTTP request id header. */
+            id: "X-Correlation-Id",
+            /** The name of the HTTP application id header. */
+            applicationId: "X-Application-Id",
+            /** The name of the HTTP application version header. */
+            applicationVersion: "X-Application-Version",
+            /** The name of the HTTP session id header. */
+            sessionId: "X-Session-Id",
+            /** The name of the HTTP authorization header. */
+            authorization: "Authorization",
+        };
+        /** The name of the RPC protocol version header. */
+        this.protocolVersionHeaderName = "X-Protocol-Version";
+    }
+    /** Returns the operation specified by an OpenAPI-compatible URI path. */
+    getOperationFromPath(path) {
+        const url = new URL(path, "https://localhost/");
+        const components = url.pathname.split("/").filter((x) => x); // filter out empty segments
+        const operationComponent = components.slice(-1)[0];
+        const encodedRequest = url.searchParams.get("parameters") || "";
+        // The encodedRequest should be base64 - fail now if any other characters detected.
+        if (/[^A-z0-9=+\/]/.test(encodedRequest))
+            throw new IModelError(BentleyStatus.ERROR, `Invalid request: Malformed URL parameters detected.`);
+        const firstHyphen = operationComponent.indexOf("-");
+        const lastHyphen = operationComponent.lastIndexOf("-");
+        const interfaceDefinition = operationComponent.slice(0, firstHyphen);
+        const interfaceVersion = operationComponent.slice(firstHyphen + 1, lastHyphen);
+        const operationName = operationComponent.slice(lastHyphen + 1);
+        return { interfaceDefinition, operationName, interfaceVersion, encodedRequest };
+    }
+    /** Supplies the OpenAPI-compatible URI path for an RPC operation. */
+    supplyPathForOperation(operation, request) {
+        var _a;
+        const prefix = this.pathPrefix;
+        const appTitle = this.info.title;
+        const appVersion = this.info.version;
+        const operationId = `${operation.interfaceDefinition.interfaceName}-${operation.interfaceVersion}-${operation.operationName}`;
+        let appMode = "";
+        let iTwinId = "";
+        let iModelId = "";
+        let routeChangesetId;
+        /* 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
+         * latest version and not some specific changeset. Also, for the first version (before any changesets), the changesetId in the route is arbitrarily
+         * 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
+         * held by the IModelRpcProps itself, the changesetId of "" (i.e., empty string) signifies the first version - this is more intuitive and retains
+         * compatibility with the majority of use cases. */
+        if (request === undefined) {
+            appMode = "{modeId}";
+            iTwinId = "{iTwinId}";
+            iModelId = "{iModelId}";
+            routeChangesetId = "{changeSetId}";
+        }
+        else {
+            let token = operation.policy.token(request) || RpcOperation.fallbackToken;
+            if (!token || !token.iModelId) {
+                if (RpcConfiguration.disableRoutingValidation) {
+                    token = { key: "" };
+                }
+                else {
+                    throw new IModelError(BentleyStatus.ERROR, "Invalid iModelToken for RPC operation request");
+                }
+            }
+            iTwinId = encodeURIComponent(token.iTwinId || "");
+            iModelId = encodeURIComponent(token.iModelId);
+            routeChangesetId = ((_a = token.changeset) === null || _a === void 0 ? void 0 : _a.id) || "0";
+            appMode = AppMode.MilestoneReview;
+        }
+        return `${prefix}/${appTitle}/${appVersion}/mode/${appMode}/context/${iTwinId}/imodel/${iModelId}${!!routeChangesetId ? `/changeset/${routeChangesetId}` : ""}/${operationId}`;
+    }
+    /**
+     * Inflates the IModelRpcProps from the URL path for each request on the backend.
+     * @note This function updates the IModelRpcProps value supplied in the request body.
+     */
+    inflateToken(tokenFromBody, request) {
+        var _a, _b, _c;
+        const urlPathComponents = request.path.split("/");
+        const iModelKey = tokenFromBody.key;
+        let iModelId = tokenFromBody.iModelId;
+        let iTwinId = tokenFromBody.iTwinId;
+        const changeset = { id: (_b = (_a = tokenFromBody.changeset) === null || _a === void 0 ? void 0 : _a.id) !== null && _b !== void 0 ? _b : "0", index: (_c = tokenFromBody.changeset) === null || _c === void 0 ? void 0 : _c.index };
+        for (let i = 0; i <= urlPathComponents.length; ++i) {
+            const key = urlPathComponents[i];
+            const value = urlPathComponents[i + 1];
+            if (key === "mode") {
+                ++i;
+            }
+            else if (key === "context") {
+                iTwinId = value;
+                ++i;
+            }
+            else if (key === "imodel") {
+                iModelId = value;
+                ++i;
+            }
+            else if (key === "changeset") {
+                changeset.id = (value === "0") ? "" : value;
+                ++i;
+            }
+        }
+        return { key: iModelKey, iTwinId, iModelId, changeset };
+    }
+    /** Returns the OpenAPI-compatible URI path parameters for an RPC operation.
+     * @internal
+     */
+    supplyPathParametersForOperation(_operation) {
+        return [
+            { name: "modeId", in: "path", required: true, schema: { type: "string" } },
+            { name: "iTwinId", in: "path", required: true, schema: { type: "string" } },
+            { name: "iModelId", in: "path", required: true, schema: { type: "string" } },
+            { name: "changeSetId", in: "path", required: false, schema: { type: "string" } },
+        ];
+    }
+}
 //# sourceMappingURL=BentleyCloudRpcProtocol.js.map

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,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;IAyGnE,CAAC;IAvGC,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,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,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","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    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,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,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","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\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"]}