@ui5/server 3.0.0-rc.2 → 3.0.0

package/CHANGELOG.md

@@ -2,20 +2,24 @@
 All notable changes to this project will be documented in this file.  
 This project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
 
-A list of unreleased changes can be found [here](https://github.com/SAP/ui5-server/compare/v3.0.0-rc.2...HEAD).
+A list of unreleased changes can be found [here](https://github.com/SAP/ui5-server/compare/v3.0.0...HEAD).
 
-<a name="v3.0.0-rc.2"></a>
-## [v3.0.0-rc.2] - 2023-01-24
-
-<a name="v3.0.0-rc.1"></a>
-## [v3.0.0-rc.1] - 2023-01-23
-
-<a name="v3.0.0-rc.0"></a>
-## [v3.0.0-rc.0] - 2022-12-23
+<a name="v3.0.0"></a>
+## [v3.0.0] - 2023-02-09
 ### Breaking Changes
+- Transform to ES Modules ([#501](https://github.com/SAP/ui5-server/issues/501)) [`05e3013`](https://github.com/SAP/ui5-server/commit/05e3013605e28e9ab5a785aa57616473d40e5710)
 - Remove "/proxy" endpoint ([#550](https://github.com/SAP/ui5-server/issues/550)) [`4bdf839`](https://github.com/SAP/ui5-server/commit/4bdf839e96f67ddbc4cb2a18216921d54df4006e)
+- Require Project Graph ([#479](https://github.com/SAP/ui5-server/issues/479)) [`d62f85a`](https://github.com/SAP/ui5-server/commit/d62f85a193115a587dbf58225e8130318a475023)
+- Require Node.js >= 16.18.0 / npm >= 8 [`63d216a`](https://github.com/SAP/ui5-server/commit/63d216a3ba34e8e50acc6621d43a78c3a0804d67)
 
 ### BREAKING CHANGE
+This package has been transformed to ES Modules. Therefore it no longer provides a CommonJS export.
+If your project uses CommonJS, it needs to be converted to ESM or use a dynamic import.
+
+For more information see also:
+
+- https://sap.github.io/ui5-tooling/updates/migrate-v3/
+- https://gist.github.com/sindresorhus/a39789f98801d908bbc7ff3ecc99d99c
 
 This removes the "/proxy" endpoint and the corresponding
 "connectUi5Proxy" middleware from the standard ui5-server.
@@ -28,68 +32,22 @@ in the form of custom middleware extensions from the UI5-community.
 The UI5 Team might provide a dedicated custom middleware extension,
 with similar functionality, in the future.
 
+- Server now requires a Project Graph instance instead.
+- Standard middleware now rely on Project instances being available on Resources (see https://github.com/SAP/ui5-fs/pull/381)
+- MiddlewareRepository#addMiddleware has been removed. Custom middleware need to be added to the project graph instead
 
-<a name="v3.0.0-beta.4"></a>
-## [v3.0.0-beta.4] - 2022-12-01
-### Dependency Updates
-- Bump connect-openui5 from 0.10.2 to 0.10.3 [`90871f8`](https://github.com/SAP/ui5-server/commit/90871f89815501860616ffbdf8927824412ec909)
-
-
-<a name="v3.0.0-beta.3"></a>
-## [v3.0.0-beta.3] - 2022-11-30
+Support for older Node.js and npm releases has been dropped.
+Only Node.js v16.18.0 and npm v8 or higher are supported.
 
-<a name="v3.0.0-beta.2"></a>
-## [v3.0.0-beta.2] - 2022-11-29
 ### Features
 - **MiddlewareUtil:** Add getProject/getDependencies/resourceFactory API to interface ([#547](https://github.com/SAP/ui5-server/issues/547)) [`ab28f78`](https://github.com/SAP/ui5-server/commit/ab28f789ba929ef1319b6e562267e9717cc9937b)
 
 
-<a name="v3.0.0-beta.1"></a>
-## [v3.0.0-beta.1] - 2022-11-07
-
-<a name="v3.0.0-alpha.4"></a>
-## [v3.0.0-alpha.4] - 2022-10-24
-### Breaking Changes
-- Transform to native ESM ([#501](https://github.com/SAP/ui5-server/issues/501)) [`05e3013`](https://github.com/SAP/ui5-server/commit/05e3013605e28e9ab5a785aa57616473d40e5710)
-
-### BREAKING CHANGE
-
-This package has been transformed to native ESM. Therefore it no longer provides a CommonJS export.
-If your project uses CommonJS, it needs to be converted to ESM or use a dynamic import.
-
-For more information see also:
-- https://sap.github.io/ui5-tooling/updates/migrate-v3/
-- https://gist.github.com/sindresorhus/a39789f98801d908bbc7ff3ecc99d99c
-
-
-<a name="v3.0.0-alpha.3"></a>
-## [v3.0.0-alpha.3] - 2022-07-27
-
-<a name="v3.0.0-alpha.2"></a>
-## [v3.0.0-alpha.2] - 2022-06-14
-### Breaking Changes
-- Require Project Graph ([#479](https://github.com/SAP/ui5-server/issues/479)) [`d62f85a`](https://github.com/SAP/ui5-server/commit/d62f85a193115a587dbf58225e8130318a475023)
-
-### BREAKING CHANGE
-
-* Server now requires a Project Graph instance instead.
-* Standard middleware now rely on Project instances being available on Resources (see https://github.com/SAP/ui5-fs/pull/381)
-* MiddlewareRepository#addMiddleware has been removed. Custom middleware need to be added to the project graph instead
-
-
-<a name="v3.0.0-alpha.1"></a>
-## [v3.0.0-alpha.1] - 2022-01-25
-### Breaking Changes
-- Require Node.js >= 16.13.2 / npm >= 8 [`63d216a`](https://github.com/SAP/ui5-server/commit/63d216a3ba34e8e50acc6621d43a78c3a0804d67)
-
-### BREAKING CHANGE
-
-Support for older Node.js and npm releases has been dropped.
-Only Node.js v16.13.2 and npm v8 or higher are supported.
-
+<a name="v2.4.1"></a>
+## [v2.4.1] - 2022-11-30
+### Dependency Updates
+- Bump connect-openui5 from 0.10.2 to 0.10.3 [`20b6fc8`](https://github.com/SAP/ui5-server/commit/20b6fc8fbad69265bae3e8f7efd320f6297ac4c4)
 
-<a name="v3.0.0-alpha.0"></a>
-## [v3.0.0-alpha.0] - 2021-12-14
 
 <a name="v2.4.0"></a>
 ## [v2.4.0] - 2021-10-19
@@ -125,7 +83,7 @@ Only Node.js v16.13.2 and npm v8 or higher are supported.
 ## [v2.2.6] - 2020-10-22
 ### Bug Fixes
 - Improve parallel theme request handling [`88bc0d6`](https://github.com/SAP/ui5-server/commit/88bc0d6d4e5ca8bb191029335451713579360e1c)
-- **nonReadRequests middleware:** Use native response API [`2d2325f`](https://github.com/SAP/ui5-server/commit/2d2325f638820d25738ddbd56afe0d104e37f2e0)
+- **nonReadRequests middleware:** Use response API [`2d2325f`](https://github.com/SAP/ui5-server/commit/2d2325f638820d25738ddbd56afe0d104e37f2e0)
 
 
 <a name="v2.2.5"></a>
@@ -174,7 +132,7 @@ Only Node.js v16.13.2 and npm v8 or higher are supported.
 <a name="v2.0.2"></a>
 ## [v2.0.2] - 2020-04-30
 ### Bug Fixes
-- **CSP Middleware:** Use native res.getHeader/setHeader methods ([#312](https://github.com/SAP/ui5-server/issues/312)) [`c53525c`](https://github.com/SAP/ui5-server/commit/c53525ca4bb5825d241d0f137ce3912d681e6548)
+- **CSP Middleware:** Use res.getHeader/setHeader methods ([#312](https://github.com/SAP/ui5-server/issues/312)) [`c53525c`](https://github.com/SAP/ui5-server/commit/c53525ca4bb5825d241d0f137ce3912d681e6548)
 
 
 <a name="v2.0.1"></a>
@@ -332,19 +290,8 @@ Only Node.js v10 or higher is supported.
 
 <a name="v0.0.1"></a>
 ## v0.0.1 - 2018-06-06
-
-[v3.0.0-rc.2]: https://github.com/SAP/ui5-server/compare/v3.0.0-rc.1...v3.0.0-rc.2
-[v3.0.0-rc.1]: https://github.com/SAP/ui5-server/compare/v3.0.0-rc.0...v3.0.0-rc.1
-[v3.0.0-rc.0]: https://github.com/SAP/ui5-server/compare/v3.0.0-beta.4...v3.0.0-rc.0
-[v3.0.0-beta.4]: https://github.com/SAP/ui5-server/compare/v3.0.0-beta.3...v3.0.0-beta.4
-[v3.0.0-beta.3]: https://github.com/SAP/ui5-server/compare/v3.0.0-beta.2...v3.0.0-beta.3
-[v3.0.0-beta.2]: https://github.com/SAP/ui5-server/compare/v3.0.0-beta.1...v3.0.0-beta.2
-[v3.0.0-beta.1]: https://github.com/SAP/ui5-server/compare/v3.0.0-alpha.4...v3.0.0-beta.1
-[v3.0.0-alpha.4]: https://github.com/SAP/ui5-server/compare/v3.0.0-alpha.3...v3.0.0-alpha.4
-[v3.0.0-alpha.3]: https://github.com/SAP/ui5-server/compare/v3.0.0-alpha.2...v3.0.0-alpha.3
-[v3.0.0-alpha.2]: https://github.com/SAP/ui5-server/compare/v3.0.0-alpha.1...v3.0.0-alpha.2
-[v3.0.0-alpha.1]: https://github.com/SAP/ui5-server/compare/v3.0.0-alpha.0...v3.0.0-alpha.1
-[v3.0.0-alpha.0]: https://github.com/SAP/ui5-server/compare/v2.4.0...v3.0.0-alpha.0
+[v3.0.0]: https://github.com/SAP/ui5-server/compare/v2.4.0...v3.0.0
+[v2.4.1]: https://github.com/SAP/ui5-server/compare/v2.4.0...v2.4.1
 [v2.4.0]: https://github.com/SAP/ui5-server/compare/v2.3.1...v2.4.0
 [v2.3.1]: https://github.com/SAP/ui5-server/compare/v2.3.0...v2.3.1
 [v2.3.0]: https://github.com/SAP/ui5-server/compare/v2.2.10...v2.3.0

package/lib/middleware/MiddlewareManager.js

@@ -274,6 +274,12 @@ class MiddlewareManager {
 					`Custom middleware definition ${middlewareDef.name} of project ${project.getName()} ` +
 					`defines neither a "beforeMiddleware" nor an "afterMiddleware" parameter. One must be defined.`);
 			}
+			const customMiddleware = this.graph.getExtension(middlewareDef.name);
+			if (!customMiddleware) {
+				throw new Error(
+					`Could not find custom middleware ${middlewareDef.name}, ` +
+					`referenced by project ${project.getName()}`);
+			}
 
 			let middlewareName = middlewareDef.name;
 			if (this.middleware[middlewareName]) {
@@ -288,8 +294,6 @@ class MiddlewareManager {
 
 			await this.addMiddleware(middlewareName, {
 				customMiddleware: async ({resources, middlewareUtil}) => {
-					const customMiddleware = this.graph.getExtension(middlewareDef.name);
-
 					const params = {
 						resources,
 						options: {

package/lib/middleware/MiddlewareUtil.js

@@ -108,6 +108,7 @@ class MiddlewareUtil {
 	 * @property {Function} getNamespace Get the project namespace
 	 * @property {Function} getRootReader Get the project rootReader
 	 * @property {Function} getReader Get the project reader
+	 * @property {Function} getRootPath Get the local File System path of the project's root directory
 	 * @property {Function} getSourcePath Get the local File System path of the project's source directory
 	 * @property {Function} getCustomConfiguration Get the project Custom Configuration
 	 * @property {Function} isFrameworkProject Check whether the project is a UI5-Framework project
@@ -226,7 +227,7 @@ class MiddlewareUtil {
 				const baseProjectInterface = {};
 				bindFunctions(project, baseProjectInterface, [
 					"getType", "getName", "getVersion", "getNamespace",
-					"getRootReader", "getReader", "getSourcePath",
+					"getRootReader", "getReader", "getRootPath", "getSourcePath",
 					"getCustomConfiguration", "isFrameworkProject"
 				]);
 				return baseProjectInterface;

package/lib/middleware/serveIndex.js

@@ -56,7 +56,7 @@ function createResourceInfo(resource) {
 		size: formatSize(stat.size),
 		sizeInBytes: stat.size,
 		project: resource.getProject()?.getName() || "<unknown>",
-		projectPath: resource.getProject()?.getPath() || "<unknown>"
+		projectPath: resource.getProject()?.getRootPath() || "<unknown>"
 	};
 }
 

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@ui5/server",
-	"version": "3.0.0-rc.2",
+	"version": "3.0.0",
 	"description": "UI5 Tooling - Server",
 	"author": {
 		"name": "SAP SE",
@@ -25,7 +25,7 @@
 		"./package.json": "./package.json"
 	},
 	"engines": {
-		"node": "^16.18.0 || >=18.0.0",
+		"node": "^16.18.0 || >=18.12.0",
 		"npm": ">= 8"
 	},
 	"scripts": {
@@ -43,7 +43,7 @@
 		"jsdoc-generate": "jsdoc -c ./jsdoc.json -t $(node -p 'path.dirname(require.resolve(\"docdash\"))') ./lib/ || (echo 'Error during JSDoc generation! Check log.' && exit 1)",
 		"jsdoc-watch": "npm run jsdoc && chokidar \"./lib/**/*.js\" -c \"npm run jsdoc-generate\"",
 		"preversion": "npm test",
-		"version": "git-chglog --sort semver --next-tag v$npm_package_version -o CHANGELOG.md && git add CHANGELOG.md",
+		"version": "git-chglog --sort semver --next-tag v$npm_package_version -o CHANGELOG.md v3.0.0.. && git add CHANGELOG.md",
 		"postversion": "git push --follow-tags",
 		"release-note": "git-chglog --sort semver -c .chglog/release-config.yml v$npm_package_version",
 		"depcheck": "depcheck --ignores @ui5/server,docdash,compression,cors,@istanbuljs/esm-loader-hook --parsers='**/*.js:es6,**/*.cjs:es6'"
@@ -114,9 +114,9 @@
 		"url": "git@github.com:SAP/ui5-server.git"
 	},
 	"dependencies": {
-		"@ui5/builder": "^3.0.0-rc.3",
-		"@ui5/fs": "^3.0.0-rc.4",
-		"@ui5/logger": "^3.0.1-rc.2",
+		"@ui5/builder": "^3.0.0",
+		"@ui5/fs": "^3.0.0",
+		"@ui5/logger": "^3.0.0",
 		"body-parser": "^1.20.1",
 		"compression": "^1.7.4",
 		"cors": "^2.8.5",
@@ -136,21 +136,21 @@
 	},
 	"devDependencies": {
 		"@istanbuljs/esm-loader-hook": "^0.2.0",
-		"@ui5/project": "^3.0.0-rc.6",
-		"ava": "^5.1.1",
+		"@ui5/project": "^3.0.0-rc.9",
+		"ava": "^5.2.0",
 		"chokidar-cli": "^3.0.0",
 		"cross-env": "^7.0.3",
 		"depcheck": "^1.4.3",
 		"docdash": "^2.0.1",
-		"eslint": "^8.32.0",
+		"eslint": "^8.33.0",
 		"eslint-config-google": "^0.14.0",
 		"eslint-plugin-ava": "^14.0.0",
-		"eslint-plugin-jsdoc": "^39.6.7",
+		"eslint-plugin-jsdoc": "^39.8.0",
 		"esmock": "^2.1.0",
-		"jsdoc": "^3.6.11",
+		"jsdoc": "^4.0.0",
 		"nyc": "^15.1.0",
 		"open-cli": "^7.1.0",
-		"rimraf": "^4.1.1",
+		"rimraf": "^4.1.2",
 		"sinon": "^15.0.1",
 		"supertest": "^6.3.3",
 		"tap-xunit": "^2.4.1"