@itwin/express-server 4.1.0 → 4.1.2

package/CHANGELOG.md

@@ -1,6 +1,16 @@
 # Change Log - @itwin/express-server
 
-This log was last generated on Mon, 14 Aug 2023 14:36:34 GMT and should not be manually modified.
+This log was last generated on Wed, 23 Aug 2023 15:25:29 GMT and should not be manually modified.
+
+## 4.1.2
+Wed, 23 Aug 2023 15:25:29 GMT
+
+_Version update only_
+
+## 4.1.1
+Fri, 18 Aug 2023 13:02:53 GMT
+
+_Version update only_
 
 ## 4.1.0
 Mon, 14 Aug 2023 14:36:34 GMT
@@ -10,6 +20,11 @@ Mon, 14 Aug 2023 14:36:34 GMT
 - Upgrade sinon to 15.0.4
 - Switch to ESLint new flat config system
 
+## 4.0.7
+Thu, 10 Aug 2023 13:19:24 GMT
+
+_Version update only_
+
 ## 4.0.6
 Mon, 24 Jul 2023 05:07:33 GMT
 
@@ -49,6 +64,16 @@ Mon, 22 May 2023 15:34:14 GMT
 - Drop Node 12 and Node 14.
 - Drop Node 16 support.
 
+## 3.7.13
+Tue, 08 Aug 2023 19:49:18 GMT
+
+_Version update only_
+
+## 3.7.12
+Thu, 27 Jul 2023 21:50:57 GMT
+
+_Version update only_
+
 ## 3.7.11
 Tue, 11 Jul 2023 17:17:22 GMT
 

package/lib/cjs/ExpressServer.js.map

@@ -1 +1 @@
-{"version":3,"file":"ExpressServer.js","sourceRoot":"","sources":["../../src/ExpressServer.ts"],"names":[],"mappings":";;;AAAA;;;+FAG+F;AAC/F,mCAAmC;AACnC,uCAAuC;AAEvC,oDAAuG;AACvG,sDAAuD;AAUvD;;;;;;GAMG;AACH,MAAa,qBAAqB;IAUhC,aAAa;IACb,IAAW,gBAAgB,KAAuB,OAAO,IAAI,CAAC,SAAS,CAAC,aAAa,CAAC,CAAC,CAAC;IAExF,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;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,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;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;;AAxDD,6CAA6C;AACtB,8BAAQ,GAAgC;IAC7D,WAAW,EAAE,KAAK;CACnB,AAF8B,CAE7B;AAJS,sDAAqB;AA4DlC;;GAEG;AACH,MAAa,aAAc,SAAQ,qBAAqB;IACnC,gBAAgB;QAChC,IAAI,CAAC,IAAY,CAAC,EAAE,CAAC,MAAM,EAAE,CAAC,EAAO,EAAE,IAAS,EAAE,EAAE,CAAC,+BAAgB,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;AAVD,sCAUC","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"]}
+{"version":3,"file":"ExpressServer.js","sourceRoot":"","sources":["../../src/ExpressServer.ts"],"names":[],"mappings":";;;AAAA;;;+FAG+F;AAC/F,mCAAmC;AACnC,uCAAuC;AAEvC,oDAAuG;AACvG,sDAAuD;AAUvD;;;;;;GAMG;AACH,MAAa,qBAAqB;IAUhC,aAAa;IACb,IAAW,gBAAgB,KAAuB,OAAO,IAAI,CAAC,SAAS,CAAC,aAAa,CAAC,CAAC,CAAC;IAExF,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;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,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;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;;AAxDD,6CAA6C;AACtB,8BAAQ,GAAgC;IAC7D,WAAW,EAAE,KAAK;CACnB,AAF8B,CAE7B;AAJS,sDAAqB;AA4DlC;;GAEG;AACH,MAAa,aAAc,SAAQ,qBAAqB;IACnC,gBAAgB;QAChC,IAAI,CAAC,IAAY,CAAC,EAAE,CAAC,MAAM,EAAE,CAAC,EAAO,EAAE,IAAS,EAAE,EAAE,CAAC,+BAAgB,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;AAVD,sCAUC","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 * as enableWs from \"express-ws\";\r\nimport { Server as HttpServer } from \"http\";\r\nimport { BentleyCloudRpcConfiguration, RpcConfiguration, WebAppRpcProtocol } from \"@itwin/core-common\";\r\nimport { LocalhostIpcHost } from \"@itwin/core-backend\";\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) => {\r\n      resp.send(\"<h1>IModelJs RPC Server</h1>\");\r\n    });\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\r\n/**\r\n * @alpha\r\n */\r\nexport class WebEditServer extends IModelJsExpressServer {\r\n  protected override _configureRoutes() {\r\n    (this._app as any).ws(\"/ipc\", (ws: any, _req: any) => LocalhostIpcHost.connect(ws));\r\n    super._configureRoutes();\r\n  }\r\n\r\n  constructor(protocol: WebAppRpcProtocol, config = IModelJsExpressServer.defaults) {\r\n    super(protocol, config);\r\n    enableWs(this._app);\r\n  }\r\n}\r\n"]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@itwin/express-server",
-  "version": "4.1.0",
+  "version": "4.1.2",
   "description": "iTwin.js express utilities",
   "main": "lib/cjs/ExpressServer.js",
   "typings": "lib/cjs/ExpressServer",
@@ -42,12 +42,12 @@
     "sinon": "^15.0.4",
     "supertest": "^3.0.0",
     "typescript": "~5.0.2",
-    "@itwin/build-tools": "4.1.0",
-    "@itwin/core-common": "4.1.0",
-    "@itwin/core-backend": "4.1.0"
+    "@itwin/build-tools": "4.1.2",
+    "@itwin/core-backend": "4.1.2",
+    "@itwin/core-common": "4.1.2"
   },
   "peerDependencies": {
-    "@itwin/core-backend": "4.1.0"
+    "@itwin/core-backend": "4.1.2"
   },
   "dependencies": {
     "express": "^4.16.3",