@itwin/express-server 3.0.0-dev.100

package/CHANGELOG.md

@@ -0,0 +1,623 @@
+# Change Log - @itwin/express-server
+
+This log was last generated on Tue, 21 Sep 2021 21:06:40 GMT and should not be manually modified.
+
+## 2.19.13
+Tue, 21 Sep 2021 21:06:40 GMT
+
+_Version update only_
+
+## 2.19.12
+Wed, 15 Sep 2021 18:06:46 GMT
+
+_Version update only_
+
+## 2.19.11
+Thu, 09 Sep 2021 21:04:57 GMT
+
+_Version update only_
+
+## 2.19.10
+Wed, 08 Sep 2021 14:36:01 GMT
+
+_Version update only_
+
+## 2.19.9
+Wed, 25 Aug 2021 15:36:01 GMT
+
+_Version update only_
+
+## 2.19.8
+Mon, 23 Aug 2021 13:23:13 GMT
+
+_Version update only_
+
+## 2.19.7
+Fri, 20 Aug 2021 17:47:22 GMT
+
+_Version update only_
+
+## 2.19.6
+Tue, 17 Aug 2021 20:34:28 GMT
+
+_Version update only_
+
+## 2.19.5
+Fri, 13 Aug 2021 21:48:08 GMT
+
+_Version update only_
+
+## 2.19.4
+Thu, 12 Aug 2021 13:09:26 GMT
+
+_Version update only_
+
+## 2.19.3
+Wed, 04 Aug 2021 20:29:34 GMT
+
+_Version update only_
+
+## 2.19.2
+Tue, 03 Aug 2021 18:26:23 GMT
+
+_Version update only_
+
+## 2.19.1
+Thu, 29 Jul 2021 20:01:11 GMT
+
+_Version update only_
+
+## 2.19.0
+Mon, 26 Jul 2021 12:21:25 GMT
+
+_Version update only_
+
+## 2.18.4
+Tue, 10 Aug 2021 19:35:13 GMT
+
+_Version update only_
+
+## 2.18.3
+Wed, 28 Jul 2021 17:16:30 GMT
+
+_Version update only_
+
+## 2.18.2
+Mon, 26 Jul 2021 16:18:31 GMT
+
+_Version update only_
+
+## 2.18.1
+Fri, 16 Jul 2021 17:45:09 GMT
+
+_Version update only_
+
+## 2.18.0
+Fri, 09 Jul 2021 18:11:24 GMT
+
+_Version update only_
+
+## 2.17.3
+Mon, 26 Jul 2021 16:08:36 GMT
+
+_Version update only_
+
+## 2.17.2
+Thu, 08 Jul 2021 15:23:00 GMT
+
+_Version update only_
+
+## 2.17.1
+Fri, 02 Jul 2021 15:38:30 GMT
+
+_Version update only_
+
+## 2.17.0
+Mon, 28 Jun 2021 16:20:11 GMT
+
+_Version update only_
+
+## 2.16.10
+Thu, 22 Jul 2021 20:23:45 GMT
+
+_Version update only_
+
+## 2.16.9
+Tue, 06 Jul 2021 22:08:34 GMT
+
+_Version update only_
+
+## 2.16.8
+Fri, 02 Jul 2021 17:40:46 GMT
+
+_Version update only_
+
+## 2.16.7
+Mon, 28 Jun 2021 18:13:04 GMT
+
+_Version update only_
+
+## 2.16.6
+Mon, 28 Jun 2021 13:12:55 GMT
+
+_Version update only_
+
+## 2.16.5
+Fri, 25 Jun 2021 16:03:01 GMT
+
+_Version update only_
+
+## 2.16.4
+Wed, 23 Jun 2021 17:09:07 GMT
+
+_Version update only_
+
+## 2.16.3
+Wed, 16 Jun 2021 20:29:32 GMT
+
+_Version update only_
+
+## 2.16.2
+Thu, 03 Jun 2021 18:08:11 GMT
+
+_Version update only_
+
+## 2.16.1
+Thu, 27 May 2021 20:04:22 GMT
+
+_Version update only_
+
+## 2.16.0
+Mon, 24 May 2021 15:58:39 GMT
+
+_Version update only_
+
+## 2.15.6
+Wed, 26 May 2021 15:55:18 GMT
+
+_Version update only_
+
+## 2.15.5
+Thu, 20 May 2021 15:06:26 GMT
+
+_Version update only_
+
+## 2.15.4
+Tue, 18 May 2021 21:59:07 GMT
+
+_Version update only_
+
+## 2.15.3
+Mon, 17 May 2021 13:31:37 GMT
+
+_Version update only_
+
+## 2.15.2
+Wed, 12 May 2021 18:08:13 GMT
+
+_Version update only_
+
+## 2.15.1
+Wed, 05 May 2021 13:18:31 GMT
+
+_Version update only_
+
+## 2.15.0
+Fri, 30 Apr 2021 12:36:58 GMT
+
+_Version update only_
+
+## 2.14.4
+Thu, 22 Apr 2021 21:07:33 GMT
+
+_Version update only_
+
+## 2.14.3
+Thu, 15 Apr 2021 15:13:16 GMT
+
+_Version update only_
+
+## 2.14.2
+Thu, 08 Apr 2021 14:30:09 GMT
+
+_Version update only_
+
+## 2.14.1
+Mon, 05 Apr 2021 16:28:00 GMT
+
+_Version update only_
+
+## 2.14.0
+Fri, 02 Apr 2021 13:18:42 GMT
+
+_Version update only_
+
+## 2.13.0
+Tue, 09 Mar 2021 20:28:13 GMT
+
+### Updates
+
+- Support Node 14
+- Updated to use TypeScript 4.1
+- begin rename project from iModel.js to iTwin.js
+
+## 2.12.3
+Mon, 08 Mar 2021 15:32:00 GMT
+
+_Version update only_
+
+## 2.12.2
+Wed, 03 Mar 2021 18:48:52 GMT
+
+_Version update only_
+
+## 2.12.1
+Tue, 23 Feb 2021 20:54:45 GMT
+
+_Version update only_
+
+## 2.12.0
+Thu, 18 Feb 2021 22:10:12 GMT
+
+_Version update only_
+
+## 2.11.2
+Thu, 18 Feb 2021 02:50:59 GMT
+
+_Version update only_
+
+## 2.11.1
+Thu, 04 Feb 2021 17:22:41 GMT
+
+_Version update only_
+
+## 2.11.0
+Thu, 28 Jan 2021 13:39:27 GMT
+
+_Version update only_
+
+## 2.10.3
+Fri, 08 Jan 2021 18:34:03 GMT
+
+_Version update only_
+
+## 2.10.2
+Fri, 08 Jan 2021 14:52:02 GMT
+
+_Version update only_
+
+## 2.10.1
+Tue, 22 Dec 2020 00:53:38 GMT
+
+_Version update only_
+
+## 2.10.0
+Fri, 18 Dec 2020 18:24:01 GMT
+
+### Updates
+
+- Update minimum Node version to 10.17.0
+- Changed the max upload size to 5mb
+
+## 2.9.9
+Sun, 13 Dec 2020 19:00:03 GMT
+
+_Version update only_
+
+## 2.9.8
+Fri, 11 Dec 2020 02:57:36 GMT
+
+_Version update only_
+
+## 2.9.7
+Wed, 09 Dec 2020 20:58:23 GMT
+
+_Version update only_
+
+## 2.9.6
+Mon, 07 Dec 2020 18:40:48 GMT
+
+_Version update only_
+
+## 2.9.5
+Sat, 05 Dec 2020 01:55:56 GMT
+
+_Version update only_
+
+## 2.9.4
+Wed, 02 Dec 2020 20:55:40 GMT
+
+_Version update only_
+
+## 2.9.3
+Mon, 23 Nov 2020 20:57:56 GMT
+
+_Version update only_
+
+## 2.9.2
+Mon, 23 Nov 2020 15:33:50 GMT
+
+_Version update only_
+
+## 2.9.1
+Thu, 19 Nov 2020 17:03:42 GMT
+
+_Version update only_
+
+## 2.9.0
+Wed, 18 Nov 2020 16:01:50 GMT
+
+_Version update only_
+
+## 2.8.1
+Tue, 03 Nov 2020 00:33:56 GMT
+
+_Version update only_
+
+## 2.8.0
+Fri, 23 Oct 2020 17:04:02 GMT
+
+_Version update only_
+
+## 2.7.6
+Wed, 11 Nov 2020 16:28:23 GMT
+
+_Version update only_
+
+## 2.7.5
+Fri, 23 Oct 2020 16:23:50 GMT
+
+_Version update only_
+
+## 2.7.4
+Mon, 19 Oct 2020 17:57:01 GMT
+
+### Updates
+
+- Update Access-Control header values
+
+## 2.7.3
+Wed, 14 Oct 2020 17:00:58 GMT
+
+_Version update only_
+
+## 2.7.2
+Tue, 13 Oct 2020 18:20:38 GMT
+
+_Version update only_
+
+## 2.7.1
+Thu, 08 Oct 2020 13:04:35 GMT
+
+_Version update only_
+
+## 2.7.0
+Fri, 02 Oct 2020 18:03:32 GMT
+
+### Updates
+
+- Introduce NoContentError (transmitted via 204)
+
+## 2.6.5
+Sat, 26 Sep 2020 16:06:34 GMT
+
+_Version update only_
+
+## 2.6.4
+Tue, 22 Sep 2020 17:40:07 GMT
+
+_Version update only_
+
+## 2.6.3
+Mon, 21 Sep 2020 14:47:09 GMT
+
+_Version update only_
+
+## 2.6.2
+Mon, 21 Sep 2020 13:07:43 GMT
+
+_Version update only_
+
+## 2.6.1
+Fri, 18 Sep 2020 13:15:08 GMT
+
+_Version update only_
+
+## 2.6.0
+Thu, 17 Sep 2020 13:16:12 GMT
+
+### Updates
+
+- Moved ESLint configuration to a plugin
+
+## 2.5.5
+Wed, 02 Sep 2020 17:42:23 GMT
+
+_Version update only_
+
+## 2.5.4
+Fri, 28 Aug 2020 15:34:15 GMT
+
+_Version update only_
+
+## 2.5.3
+Wed, 26 Aug 2020 11:46:00 GMT
+
+_Version update only_
+
+## 2.5.2
+Tue, 25 Aug 2020 22:09:08 GMT
+
+_Version update only_
+
+## 2.5.1
+Mon, 24 Aug 2020 18:13:04 GMT
+
+_Version update only_
+
+## 2.5.0
+Thu, 20 Aug 2020 20:57:09 GMT
+
+### Updates
+
+- Switch to ESLint
+
+## 2.4.2
+Fri, 14 Aug 2020 16:34:09 GMT
+
+_Version update only_
+
+## 2.4.1
+Fri, 07 Aug 2020 19:57:43 GMT
+
+_Version update only_
+
+## 2.4.0
+Tue, 28 Jul 2020 16:26:23 GMT
+
+_Version update only_
+
+## 2.3.3
+Thu, 23 Jul 2020 12:57:15 GMT
+
+_Version update only_
+
+## 2.3.2
+Tue, 14 Jul 2020 23:50:36 GMT
+
+_Version update only_
+
+## 2.3.1
+Mon, 13 Jul 2020 18:50:13 GMT
+
+_Version update only_
+
+## 2.3.0
+Fri, 10 Jul 2020 17:23:14 GMT
+
+### Updates
+
+- Support for attaching RPC interfaces after startup.
+
+## 2.2.1
+Tue, 07 Jul 2020 14:44:52 GMT
+
+_Version update only_
+
+## 2.2.0
+Fri, 19 Jun 2020 14:10:03 GMT
+
+_Version update only_
+
+## 2.1.0
+Thu, 28 May 2020 22:48:59 GMT
+
+_Version update only_
+
+## 2.0.0
+Wed, 06 May 2020 13:17:49 GMT
+
+### Updates
+
+- Remove dependency on deprecated bodyParser.
+- Update minimum Node version to 10.16.0
+- Upgrade to Rush 5.23.2
+
+## 1.14.1
+Wed, 22 Apr 2020 19:04:00 GMT
+
+_Version update only_
+
+## 1.14.0
+Tue, 31 Mar 2020 15:44:19 GMT
+
+_Version update only_
+
+## 1.13.0
+Wed, 04 Mar 2020 16:16:31 GMT
+
+_Version update only_
+
+## 1.12.0
+Wed, 12 Feb 2020 17:45:50 GMT
+
+_Version update only_
+
+## 1.11.0
+Wed, 22 Jan 2020 19:24:12 GMT
+
+### Updates
+
+- Upgrade to TypeScript 3.7.2.
+
+## 1.10.0
+Tue, 07 Jan 2020 19:44:01 GMT
+
+_Version update only_
+
+## 1.9.0
+Tue, 10 Dec 2019 18:08:56 GMT
+
+_Version update only_
+
+## 1.8.0
+Fri, 22 Nov 2019 14:03:34 GMT
+
+### Updates
+
+- Update to allow Node 12
+
+## 1.7.0
+Fri, 01 Nov 2019 13:28:37 GMT
+
+_Version update only_
+
+## 1.6.0
+Wed, 09 Oct 2019 20:28:42 GMT
+
+_Version update only_
+
+## 1.5.0
+Mon, 30 Sep 2019 22:28:48 GMT
+
+### Updates
+
+- Upgrade to TypeScript 3.6.2
+
+## 1.4.0
+Tue, 10 Sep 2019 12:09:49 GMT
+
+_Version update only_
+
+## 1.3.0
+Tue, 13 Aug 2019 20:25:53 GMT
+
+_Version update only_
+
+## 1.2.0
+Wed, 24 Jul 2019 11:47:26 GMT
+
+_Version update only_
+
+## 1.1.0
+Mon, 01 Jul 2019 19:04:29 GMT
+
+### Updates
+
+- Update to TypeScript 3.5
+
+## 1.0.0
+Mon, 03 Jun 2019 18:09:39 GMT
+
+### Updates
+
+- Change required by new compiler
+
+## 0.191.0
+Mon, 13 May 2019 15:52:05 GMT
+
+### Updates
+
+- Moved IModelJsExpressServer class into a new package (@itwin/express-server).
+- Upgrade TypeDoc dependency to 0.14.2
+

package/LICENSE.md

@@ -0,0 +1,9 @@
+# MIT License
+
+Copyright © 2017-2021 Bentley Systems, Incorporated. All rights reserved.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/README.md

@@ -0,0 +1,11 @@
+# @itwin/express-server
+
+Copyright © Bentley Systems, Incorporated. All rights reserved. See LICENSE.md for license terms and full copyright notice.
+
+## Description
+
+The __@itwin/express-server__ package contains the express webserver utilities to write an iTwin.js backend service.
+
+## Documentation
+
+See the [iTwin.js](https://www.itwinjs.org) documentation for more information.

package/lib/cjs/ExpressServer.d.ts

@@ -0,0 +1,36 @@
+/// <reference types="node" />
+import { Server as HttpServer } from "http";
+import { RpcConfiguration, WebAppRpcProtocol } from "@itwin/core-common";
+/**
+ * Options for configuring IModelJsExpressServer.
+ * @public
+ */
+export interface IModelJsExpressServerConfig {
+    uploadLimit: string;
+}
+/**
+ * An express web server with some reasonable defaults for web applications built with @bentley/webpack-tools.
+ * @note This server is not designed to be a hardened, secure endpoint on the public internet.
+ *       It is intended to participate in a private HTTP exchange with a public-facing routing and provisioning infrastructure
+ *       that should be supplied by the application's deployment environment.
+ * @public
+ */
+export declare class IModelJsExpressServer {
+    /** The default configuration for servers. */
+    static readonly defaults: IModelJsExpressServerConfig;
+    private _protocol;
+    private _config;
+    protected _app: import("express").Application;
+    /** @alpha */
+    get rpcConfiguration(): RpcConfiguration;
+    constructor(protocol: WebAppRpcProtocol, config?: IModelJsExpressServerConfig);
+    protected _configureMiddleware(): void;
+    protected _configureHeaders(): void;
+    protected _configureRoutes(): void;
+    /**
+     * Configure the express application with necessary headers, routes, and middleware, then starts listening on the given port.
+     * @param port The port to listen on
+     */
+    initialize(port: number | string): Promise<HttpServer>;
+}
+//# sourceMappingURL=ExpressServer.d.ts.map

package/lib/cjs/ExpressServer.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ExpressServer.d.ts","sourceRoot":"","sources":["../../src/ExpressServer.ts"],"names":[],"mappings":";AAKA,OAAO,EAAE,MAAM,IAAI,UAAU,EAAE,MAAM,MAAM,CAAC;AAC5C,OAAO,EAAgC,gBAAgB,EAAE,iBAAiB,EAAE,MAAM,oBAAoB,CAAC;AAEvG;;;GAGG;AACH,MAAM,WAAW,2BAA2B;IAC1C,WAAW,EAAE,MAAM,CAAC;CACrB;AAED;;;;;;GAMG;AACH,qBAAa,qBAAqB;IAChC,6CAA6C;IAC7C,gBAAuB,QAAQ,EAAE,2BAA2B,CAE1D;IAEF,OAAO,CAAC,SAAS,CAAoB;IACrC,OAAO,CAAC,OAAO,CAA8B;IAC7C,SAAS,CAAC,IAAI,EAAE,OAAO,SAAS,EAAE,WAAW,CAAa;IAE1D,aAAa;IACb,IAAW,gBAAgB,IAAI,gBAAgB,CAAyC;gBAE5E,QAAQ,EAAE,iBAAiB,EAAE,MAAM,8BAAiC;IAKhF,SAAS,CAAC,oBAAoB;IAK9B,SAAS,CAAC,iBAAiB;IAU3B,SAAS,CAAC,gBAAgB;IAS1B;;;OAGG;IACU,UAAU,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,GAAG,OAAO,CAAC,UAAU,CAAC;CAUpE"}

package/lib/cjs/ExpressServer.js

@@ -0,0 +1,65 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.IModelJsExpressServer = void 0;
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+const express = require("express");
+const core_common_1 = require("@itwin/core-common");
+/**
+ * An express web server with some reasonable defaults for web applications built with @bentley/webpack-tools.
+ * @note This server is not designed to be a hardened, secure endpoint on the public internet.
+ *       It is intended to participate in a private HTTP exchange with a public-facing routing and provisioning infrastructure
+ *       that should be supplied by the application's deployment environment.
+ * @public
+ */
+class IModelJsExpressServer {
+    constructor(protocol, config = IModelJsExpressServer.defaults) {
+        this._app = express();
+        this._protocol = protocol;
+        this._config = config;
+    }
+    /** @alpha */
+    get rpcConfiguration() { return this._protocol.configuration; }
+    _configureMiddleware() {
+        this._app.use(express.text({ limit: this._config.uploadLimit }));
+        this._app.use(express.raw({ limit: this._config.uploadLimit }));
+    }
+    _configureHeaders() {
+        // enable CORS for all apis
+        this._app.all("/**", (_req, res, next) => {
+            res.header("Access-Control-Allow-Origin", core_common_1.BentleyCloudRpcConfiguration.accessControl.allowOrigin);
+            res.header("Access-Control-Allow-Methods", core_common_1.BentleyCloudRpcConfiguration.accessControl.allowMethods);
+            res.header("Access-Control-Allow-Headers", core_common_1.BentleyCloudRpcConfiguration.accessControl.allowHeaders);
+            next();
+        });
+    }
+    _configureRoutes() {
+        this._app.get("/v3/swagger.json", (req, res) => this._protocol.handleOpenApiDescriptionRequest(req, res));
+        this._app.post("*", async (req, res) => this._protocol.handleOperationPostRequest(req, res));
+        this._app.get(/\/imodel\//, async (req, res) => this._protocol.handleOperationGetRequest(req, res));
+        this._app.get("/ping", async (_req, res) => res.status(200).send("Success"));
+        // for all HTTP requests, identify the server.
+        this._app.use("*", (_req, resp) => { resp.send("<h1>IModelJs RPC Server</h1>"); });
+    }
+    /**
+     * Configure the express application with necessary headers, routes, and middleware, then starts listening on the given port.
+     * @param port The port to listen on
+     */
+    async initialize(port) {
+        this._configureMiddleware();
+        this._configureHeaders();
+        this._configureRoutes();
+        this._app.set("port", port);
+        return new Promise((resolve) => {
+            const server = this._app.listen(this._app.get("port"), () => resolve(server));
+        });
+    }
+}
+exports.IModelJsExpressServer = IModelJsExpressServer;
+/** The default configuration for servers. */
+IModelJsExpressServer.defaults = {
+    uploadLimit: "5mb",
+};
+//# sourceMappingURL=ExpressServer.js.map

package/lib/cjs/ExpressServer.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ExpressServer.js","sourceRoot":"","sources":["../../src/ExpressServer.ts"],"names":[],"mappings":";;;AAAA;;;+FAG+F;AAC/F,mCAAmC;AAEnC,oDAAuG;AAUvG;;;;;;GAMG;AACH,MAAa,qBAAqB;IAahC,YAAY,QAA2B,EAAE,MAAM,GAAG,qBAAqB,CAAC,QAAQ;QALtE,SAAI,GAAkC,OAAO,EAAE,CAAC;QAMxD,IAAI,CAAC,SAAS,GAAG,QAAQ,CAAC;QAC1B,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC;IACxB,CAAC;IAND,aAAa;IACb,IAAW,gBAAgB,KAAuB,OAAO,IAAI,CAAC,SAAS,CAAC,aAAa,CAAC,CAAC,CAAC;IAO9E,oBAAoB;QAC5B,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,KAAK,EAAE,IAAI,CAAC,OAAO,CAAC,WAAW,EAAE,CAAC,CAAC,CAAC;QACjE,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE,KAAK,EAAE,IAAI,CAAC,OAAO,CAAC,WAAW,EAAE,CAAC,CAAC,CAAC;IAClE,CAAC;IAES,iBAAiB;QACzB,2BAA2B;QAC3B,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,KAAK,EAAE,CAAC,IAAI,EAAE,GAAG,EAAE,IAAI,EAAE,EAAE;YACvC,GAAG,CAAC,MAAM,CAAC,6BAA6B,EAAE,0CAA4B,CAAC,aAAa,CAAC,WAAW,CAAC,CAAC;YAClG,GAAG,CAAC,MAAM,CAAC,8BAA8B,EAAE,0CAA4B,CAAC,aAAa,CAAC,YAAY,CAAC,CAAC;YACpG,GAAG,CAAC,MAAM,CAAC,8BAA8B,EAAE,0CAA4B,CAAC,aAAa,CAAC,YAAY,CAAC,CAAC;YACpG,IAAI,EAAE,CAAC;QACT,CAAC,CAAC,CAAC;IACL,CAAC;IAES,gBAAgB;QACxB,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,kBAAkB,EAAE,CAAC,GAAG,EAAE,GAAG,EAAE,EAAE,CAAC,IAAI,CAAC,SAAS,CAAC,+BAA+B,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC,CAAC;QAC1G,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE,KAAK,EAAE,GAAG,EAAE,GAAG,EAAE,EAAE,CAAC,IAAI,CAAC,SAAS,CAAC,0BAA0B,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC,CAAC;QAC7F,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,YAAY,EAAE,KAAK,EAAE,GAAG,EAAE,GAAG,EAAE,EAAE,CAAC,IAAI,CAAC,SAAS,CAAC,yBAAyB,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC,CAAC;QACpG,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,OAAO,EAAE,KAAK,EAAE,IAAI,EAAE,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC;QAC7E,8CAA8C;QAC9C,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,GAAG,EAAE,CAAC,IAAI,EAAE,IAAI,EAAE,EAAE,GAAG,IAAI,CAAC,IAAI,CAAC,8BAA8B,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;IACrF,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,UAAU,CAAC,IAAqB;QAC3C,IAAI,CAAC,oBAAoB,EAAE,CAAC;QAC5B,IAAI,CAAC,iBAAiB,EAAE,CAAC;QACzB,IAAI,CAAC,gBAAgB,EAAE,CAAC;QAExB,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;QAC5B,OAAO,IAAI,OAAO,CAAa,CAAC,OAAO,EAAE,EAAE;YACzC,MAAM,MAAM,GAAe,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC,EAAE,GAAG,EAAE,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC;QAC5F,CAAC,CAAC,CAAC;IACL,CAAC;;AAvDH,sDAwDC;AAvDC,6CAA6C;AACtB,8BAAQ,GAAgC;IAC7D,WAAW,EAAE,KAAK;CACnB,CAAC","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\nimport * as express from \"express\";\r\nimport { Server as HttpServer } from \"http\";\r\nimport { BentleyCloudRpcConfiguration, RpcConfiguration, WebAppRpcProtocol } from \"@itwin/core-common\";\r\n\r\n/**\r\n * Options for configuring IModelJsExpressServer.\r\n * @public\r\n */\r\nexport interface IModelJsExpressServerConfig {\r\n  uploadLimit: string;\r\n}\r\n\r\n/**\r\n * An express web server with some reasonable defaults for web applications built with @bentley/webpack-tools.\r\n * @note This server is not designed to be a hardened, secure endpoint on the public internet.\r\n *       It is intended to participate in a private HTTP exchange with a public-facing routing and provisioning infrastructure\r\n *       that should be supplied by the application's deployment environment.\r\n * @public\r\n */\r\nexport class IModelJsExpressServer {\r\n  /** The default configuration for servers. */\r\n  public static readonly defaults: IModelJsExpressServerConfig = {\r\n    uploadLimit: \"5mb\",\r\n  };\r\n\r\n  private _protocol: WebAppRpcProtocol;\r\n  private _config: IModelJsExpressServerConfig;\r\n  protected _app: import(\"express\").Application = express();\r\n\r\n  /** @alpha */\r\n  public get rpcConfiguration(): RpcConfiguration { return this._protocol.configuration; }\r\n\r\n  constructor(protocol: WebAppRpcProtocol, config = IModelJsExpressServer.defaults) {\r\n    this._protocol = protocol;\r\n    this._config = config;\r\n  }\r\n\r\n  protected _configureMiddleware() {\r\n    this._app.use(express.text({ limit: this._config.uploadLimit }));\r\n    this._app.use(express.raw({ limit: this._config.uploadLimit }));\r\n  }\r\n\r\n  protected _configureHeaders() {\r\n    // enable CORS for all apis\r\n    this._app.all(\"/**\", (_req, res, next) => {\r\n      res.header(\"Access-Control-Allow-Origin\", BentleyCloudRpcConfiguration.accessControl.allowOrigin);\r\n      res.header(\"Access-Control-Allow-Methods\", BentleyCloudRpcConfiguration.accessControl.allowMethods);\r\n      res.header(\"Access-Control-Allow-Headers\", BentleyCloudRpcConfiguration.accessControl.allowHeaders);\r\n      next();\r\n    });\r\n  }\r\n\r\n  protected _configureRoutes() {\r\n    this._app.get(\"/v3/swagger.json\", (req, res) => this._protocol.handleOpenApiDescriptionRequest(req, res));\r\n    this._app.post(\"*\", async (req, res) => this._protocol.handleOperationPostRequest(req, res));\r\n    this._app.get(/\\/imodel\\//, async (req, res) => this._protocol.handleOperationGetRequest(req, res));\r\n    this._app.get(\"/ping\", async (_req, res) => res.status(200).send(\"Success\"));\r\n    // for all HTTP requests, identify the server.\r\n    this._app.use(\"*\", (_req, resp) => { resp.send(\"<h1>IModelJs RPC Server</h1>\"); });\r\n  }\r\n\r\n  /**\r\n   * Configure the express application with necessary headers, routes, and middleware, then starts listening on the given port.\r\n   * @param port The port to listen on\r\n   */\r\n  public async initialize(port: number | string): Promise<HttpServer> {\r\n    this._configureMiddleware();\r\n    this._configureHeaders();\r\n    this._configureRoutes();\r\n\r\n    this._app.set(\"port\", port);\r\n    return new Promise<HttpServer>((resolve) => {\r\n      const server: HttpServer = this._app.listen(this._app.get(\"port\"), () => resolve(server));\r\n    });\r\n  }\r\n}\r\n"]}

package/package.json

@@ -0,0 +1,68 @@
+{
+  "name": "@itwin/express-server",
+  "version": "3.0.0-dev.100",
+  "description": "iModel.js express utilities",
+  "main": "lib/cjs/ExpressServer.js",
+  "typings": "lib/cjs/ExpressServer",
+  "license": "MIT",
+  "engines": {
+    "node": ">=12.22.0 < 14.0 || >=14.17.0 <17.0"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/imodeljs/imodeljs/tree/master/core/express-server"
+  },
+  "keywords": [
+    "Bentley",
+    "BIM",
+    "iModel"
+  ],
+  "author": {
+    "name": "Bentley Systems, Inc.",
+    "url": "http://www.bentley.com"
+  },
+  "devDependencies": {
+    "@itwin/build-tools": "3.0.0-dev.100",
+    "@itwin/eslint-plugin": "3.0.0-dev.100",
+    "@itwin/core-common": "3.0.0-dev.100",
+    "@types/body-parser": "^1.17.0",
+    "@types/chai": "^4.1.4",
+    "@types/express": "^4.16.1",
+    "@types/mocha": "^8.2.2",
+    "@types/node": "14.14.31",
+    "@types/sinon": "^9.0.0",
+    "@types/supertest": "^2.0.4",
+    "chai": "^4.1.2",
+    "eslint": "^7.11.0",
+    "mocha": "^8.3.2",
+    "nyc": "^15.1.0",
+    "rimraf": "^3.0.2",
+    "sinon": "^9.0.2",
+    "source-map-support": "^0.5.6",
+    "supertest": "^3.0.0",
+    "typescript": "~4.4.0"
+  },
+  "dependencies": {
+    "express": "^4.16.3"
+  },
+  "eslintConfig": {
+    "plugins": [
+      "@itwin"
+    ],
+    "extends": "plugin:@itwin/itwinjs-recommended"
+  },
+  "nyc": {
+    "extends": "./node_modules/@itwin/build-tools/.nycrc"
+  },
+  "scripts": {
+    "build": "npm run -s build:cjs",
+    "build:ci": "npm run -s build",
+    "build:cjs": "tsc 1>&2 --outDir lib/cjs",
+    "clean": "rimraf lib .rush/temp/package-deps*.json",
+    "docs": "betools docs --includes=../../generated-docs/extract --json=../../generated-docs/core/express-server/file.json --tsIndexFile=./ExpressServer.ts --onlyJson",
+    "extract-api": "betools extract-api --entry=ExpressServer",
+    "lint": "eslint -f visualstudio \"./src/**/*.ts\" 1>&2",
+    "test": "mocha",
+    "cover": "nyc npm -s test"
+  }
+}