@itwin/express-server 5.0.0-dev.90 → 5.0.0-dev.92

package/lib/esm/ExpressServer.d.ts

@@ -0,0 +1,42 @@
+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>;
+}
+/**
+ * @alpha
+ */
+export declare class WebEditServer extends IModelJsExpressServer {
+    protected _configureRoutes(): void;
+    constructor(protocol: WebAppRpcProtocol, config?: IModelJsExpressServerConfig);
+}
+//# sourceMappingURL=ExpressServer.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"ExpressServer.d.ts","sourceRoot":"","sources":["../../src/ExpressServer.ts"],"names":[],"mappings":"AAMA,OAAO,EAAE,MAAM,IAAI,UAAU,EAAE,MAAM,MAAM,CAAC;AAC5C,OAAO,EAAgC,gBAAgB,EAAE,iBAAiB,EAAE,MAAM,oBAAoB,CAAC;AAGvG;;;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;IAW1B;;;OAGG;IACU,UAAU,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,GAAG,OAAO,CAAC,UAAU,CAAC;CAUpE;AAED;;GAEG;AACH,qBAAa,aAAc,SAAQ,qBAAqB;cACnC,gBAAgB;gBAKvB,QAAQ,EAAE,iBAAiB,EAAE,MAAM,8BAAiC;CAIjF"}

package/lib/esm/ExpressServer.js

@@ -0,0 +1,80 @@
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+import * as express from "express";
+import * as enableWs from "express-ws";
+import { BentleyCloudRpcConfiguration } from "@itwin/core-common";
+import { LocalhostIpcHost } from "@itwin/core-backend";
+/**
+ * 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 class IModelJsExpressServer {
+    /** The default configuration for servers. */
+    static defaults = {
+        uploadLimit: "5mb",
+    };
+    _protocol;
+    _config;
+    _app = express();
+    /** @alpha */
+    get rpcConfiguration() { return this._protocol.configuration; }
+    constructor(protocol, config = IModelJsExpressServer.defaults) {
+        this._protocol = protocol;
+        this._config = config;
+    }
+    _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", BentleyCloudRpcConfiguration.accessControl.allowOrigin);
+            res.header("Access-Control-Allow-Methods", BentleyCloudRpcConfiguration.accessControl.allowMethods);
+            res.header("Access-Control-Allow-Headers", 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));
+        });
+    }
+}
+/**
+ * @alpha
+ */
+export class WebEditServer extends IModelJsExpressServer {
+    _configureRoutes() {
+        this._app.ws("/ipc", (ws, _req) => LocalhostIpcHost.connect(ws));
+        super._configureRoutes();
+    }
+    constructor(protocol, config = IModelJsExpressServer.defaults) {
+        super(protocol, config);
+        enableWs(this._app);
+    }
+}
+//# sourceMappingURL=ExpressServer.js.map

package/lib/esm/ExpressServer.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ExpressServer.js","sourceRoot":"","sources":["../../src/ExpressServer.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F,OAAO,KAAK,OAAO,MAAM,SAAS,CAAC;AACnC,OAAO,KAAK,QAAQ,MAAM,YAAY,CAAC;AAEvC,OAAO,EAAE,4BAA4B,EAAuC,MAAM,oBAAoB,CAAC;AACvG,OAAO,EAAE,gBAAgB,EAAE,MAAM,qBAAqB,CAAC;AAUvD;;;;;;GAMG;AACH,MAAM,OAAO,qBAAqB;IAChC,6CAA6C;IACtC,MAAM,CAAU,QAAQ,GAAgC;QAC7D,WAAW,EAAE,KAAK;KACnB,CAAC;IAEM,SAAS,CAAoB;IAC7B,OAAO,CAA8B;IACnC,IAAI,GAAkC,OAAO,EAAE,CAAC;IAE1D,aAAa;IACb,IAAW,gBAAgB,KAAuB,OAAO,IAAI,CAAC,SAAS,CAAC,aAAa,CAAC,CAAC,CAAC;IAExF,YAAY,QAA2B,EAAE,MAAM,GAAG,qBAAqB,CAAC,QAAQ;QAC9E,IAAI,CAAC,SAAS,GAAG,QAAQ,CAAC;QAC1B,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC;IACxB,CAAC;IAES,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,4BAA4B,CAAC,aAAa,CAAC,WAAW,CAAC,CAAC;YAClG,GAAG,CAAC,MAAM,CAAC,8BAA8B,EAAE,4BAA4B,CAAC,aAAa,CAAC,YAAY,CAAC,CAAC;YACpG,GAAG,CAAC,MAAM,CAAC,8BAA8B,EAAE,4BAA4B,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;YAChC,IAAI,CAAC,IAAI,CAAC,8BAA8B,CAAC,CAAC;QAC5C,CAAC,CAAC,CAAC;IACL,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;;AAGH;;GAEG;AACH,MAAM,OAAO,aAAc,SAAQ,qBAAqB;IACnC,gBAAgB;QAChC,IAAI,CAAC,IAAY,CAAC,EAAE,CAAC,MAAM,EAAE,CAAC,EAAO,EAAE,IAAS,EAAE,EAAE,CAAC,gBAAgB,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC,CAAC;QACpF,KAAK,CAAC,gBAAgB,EAAE,CAAC;IAC3B,CAAC;IAED,YAAY,QAA2B,EAAE,MAAM,GAAG,qBAAqB,CAAC,QAAQ;QAC9E,KAAK,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAC;QACxB,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IACtB,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*--------------------------------------------------------------------------------------------*/\nimport * as express from \"express\";\nimport * as enableWs from \"express-ws\";\nimport { Server as HttpServer } from \"http\";\nimport { BentleyCloudRpcConfiguration, RpcConfiguration, WebAppRpcProtocol } from \"@itwin/core-common\";\nimport { LocalhostIpcHost } from \"@itwin/core-backend\";\n\n/**\n * Options for configuring IModelJsExpressServer.\n * @public\n */\nexport interface IModelJsExpressServerConfig {\n  uploadLimit: string;\n}\n\n/**\n * An express web server with some reasonable defaults for web applications built with @bentley/webpack-tools.\n * @note This server is not designed to be a hardened, secure endpoint on the public internet.\n *       It is intended to participate in a private HTTP exchange with a public-facing routing and provisioning infrastructure\n *       that should be supplied by the application's deployment environment.\n * @public\n */\nexport class IModelJsExpressServer {\n  /** The default configuration for servers. */\n  public static readonly defaults: IModelJsExpressServerConfig = {\n    uploadLimit: \"5mb\",\n  };\n\n  private _protocol: WebAppRpcProtocol;\n  private _config: IModelJsExpressServerConfig;\n  protected _app: import(\"express\").Application = express();\n\n  /** @alpha */\n  public get rpcConfiguration(): RpcConfiguration { return this._protocol.configuration; }\n\n  constructor(protocol: WebAppRpcProtocol, config = IModelJsExpressServer.defaults) {\n    this._protocol = protocol;\n    this._config = config;\n  }\n\n  protected _configureMiddleware() {\n    this._app.use(express.text({ limit: this._config.uploadLimit }));\n    this._app.use(express.raw({ limit: this._config.uploadLimit }));\n  }\n\n  protected _configureHeaders() {\n    // enable CORS for all apis\n    this._app.all(\"/**\", (_req, res, next) => {\n      res.header(\"Access-Control-Allow-Origin\", BentleyCloudRpcConfiguration.accessControl.allowOrigin);\n      res.header(\"Access-Control-Allow-Methods\", BentleyCloudRpcConfiguration.accessControl.allowMethods);\n      res.header(\"Access-Control-Allow-Headers\", BentleyCloudRpcConfiguration.accessControl.allowHeaders);\n      next();\n    });\n  }\n\n  protected _configureRoutes() {\n    this._app.get(\"/v3/swagger.json\", (req, res) => this._protocol.handleOpenApiDescriptionRequest(req, res));\n    this._app.post(\"*\", async (req, res) => this._protocol.handleOperationPostRequest(req, res));\n    this._app.get(/\\/imodel\\//, async (req, res) => this._protocol.handleOperationGetRequest(req, res));\n    this._app.get(\"/ping\", async (_req, res) => res.status(200).send(\"Success\"));\n    // for all HTTP requests, identify the server.\n    this._app.use(\"*\", (_req, resp) => {\n      resp.send(\"<h1>IModelJs RPC Server</h1>\");\n    });\n  }\n\n  /**\n   * Configure the express application with necessary headers, routes, and middleware, then starts listening on the given port.\n   * @param port The port to listen on\n   */\n  public async initialize(port: number | string): Promise<HttpServer> {\n    this._configureMiddleware();\n    this._configureHeaders();\n    this._configureRoutes();\n\n    this._app.set(\"port\", port);\n    return new Promise<HttpServer>((resolve) => {\n      const server: HttpServer = this._app.listen(this._app.get(\"port\"), () => resolve(server));\n    });\n  }\n}\n\n/**\n * @alpha\n */\nexport class WebEditServer extends IModelJsExpressServer {\n  protected override _configureRoutes() {\n    (this._app as any).ws(\"/ipc\", (ws: any, _req: any) => LocalhostIpcHost.connect(ws));\n    super._configureRoutes();\n  }\n\n  constructor(protocol: WebAppRpcProtocol, config = IModelJsExpressServer.defaults) {\n    super(protocol, config);\n    enableWs(this._app);\n  }\n}\n"]}

package/package.json

@@ -1,8 +1,9 @@
 {
   "name": "@itwin/express-server",
-  "version": "5.0.0-dev.90",
+  "version": "5.0.0-dev.92",
   "description": "iTwin.js express utilities",
   "main": "lib/cjs/ExpressServer.js",
+  "module": "lib/esm/ExpressServer.js",
   "typings": "lib/cjs/ExpressServer",
   "license": "MIT",
   "engines": {
@@ -42,13 +43,13 @@
     "sinon": "^17.0.2",
     "supertest": "^7.0.0",
     "typescript": "~5.6.2",
-    "@itwin/build-tools": "5.0.0-dev.90",
-    "@itwin/core-backend": "5.0.0-dev.90",
-    "@itwin/core-common": "5.0.0-dev.90"
+    "@itwin/build-tools": "5.0.0-dev.92",
+    "@itwin/core-common": "5.0.0-dev.92",
+    "@itwin/core-backend": "5.0.0-dev.92"
   },
   "peerDependencies": {
-    "@itwin/core-backend": "5.0.0-dev.90",
-    "@itwin/core-common": "5.0.0-dev.90"
+    "@itwin/core-backend": "5.0.0-dev.92",
+    "@itwin/core-common": "5.0.0-dev.92"
   },
   "dependencies": {
     "express": "^4.21.2",
@@ -58,8 +59,9 @@
     "extends": "./node_modules/@itwin/build-tools/.nycrc"
   },
   "scripts": {
-    "build": "npm run -s build:cjs",
+    "build": "npm run -s build:cjs && npm run -s build:esm",
     "build:cjs": "tsc 1>&2 --outDir lib/cjs",
+    "build:esm": "tsc 1>&2 --module ES2022 --outDir lib/esm",
     "clean": "rimraf -g lib .rush/temp/package-deps*.json",
     "docs": "betools docs --json=../../generated-docs/core/express-server/file.json --tsIndexFile=./ExpressServer.ts --onlyJson",
     "extract-api": "betools extract-api --entry=ExpressServer",