@ui5/server 3.0.0-alpha.3 → 3.0.0-alpha.4

package/CHANGELOG.md

@@ -2,7 +2,22 @@
 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-alpha.3...HEAD).
+A list of unreleased changes can be found [here](https://github.com/SAP/ui5-server/compare/v3.0.0-alpha.4...HEAD).
+
+<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
@@ -275,6 +290,7 @@ Only Node.js v10 or higher is supported.
 <a name="v0.0.1"></a>
 ## v0.0.1 - 2018-06-06
 
+[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

package/jsdoc.json

@@ -3,12 +3,12 @@
 		"allowUnknownTags": false
 	},
 	"source": {
-		"include": ["README.md", "index.js"],
+		"include": ["README.md"],
 		"includePattern": ".+\\.js$",
 		"excludePattern": "(node_modules(\\\\|/))"
 	},
 	"plugins": [
-		"./jsdoc-plugin"
+		"./jsdoc-plugin.cjs"
 	],
 	"opts": {
 		"encoding": "utf8",

package/lib/middleware/MiddlewareManager.js

@@ -1,20 +1,23 @@
-const middlewareRepository = require("./middlewareRepository");
-const MiddlewareUtil = require("./MiddlewareUtil");
+import middlewareRepository from "./middlewareRepository.js";
+import MiddlewareUtil from "./MiddlewareUtil.js";
 const hasOwn = Function.prototype.call.bind(Object.prototype.hasOwnProperty);
 
 /**
- *
- * @typedef {object} middlewareResources
- * @property {module:@ui5/fs.AbstractReader} all Reader or Collection to read resources of the
+ * @private
+ * @typedef {object} MiddlewareResources
+ * @property {@ui5/fs.AbstractReader} all Reader or Collection to read resources of the
  *                                        root project and its dependencies
- * @property {module:@ui5/fs.AbstractReader} rootProject Reader or Collection to read resources of
+ * @property {@ui5/fs.AbstractReader} rootProject Reader or Collection to read resources of
  *                                        the project the server is started in
+ * @memberof @ui5/server/internal/MiddlewareManager
  */
 
 /**
+ * The MiddlewareManager
  *
- *
- * @memberof module:@ui5/server.middleware
+ * @private
+ * @class
+ * @alias @ui5/server/internal/MiddlewareManager
  */
 class MiddlewareManager {
 	constructor({graph, resources, options = {
@@ -33,6 +36,14 @@ class MiddlewareManager {
 		this.middlewareUtil = new MiddlewareUtil();
 	}
 
+	/**
+	 * Applies the middleware to
+	 *
+	 * @private
+	 * @param {object} app The express application object
+	 * @returns {Promise<Array<undefined>>} Promise resolving to an Array with a length of the number
+	 *      of added middlewares. The entries of the Array have a value of <code>undefined</code>.
+	 */
 	async applyMiddleware(app) {
 		await this.addStandardMiddleware();
 		await this.addCustomMiddleware();
@@ -43,6 +54,18 @@ class MiddlewareManager {
 		});
 	}
 
+	/**
+	 * Adds the given middleware configuration
+	 *
+	 * @private
+	 * @param {string} configuredMiddlewareName The name of the middleware
+	 * @param {object} [options] The Options of the middleware
+	 * @param {object} [options.customMiddleware] The custom middleware
+	 * @param {Function} [options.wrapperCallback] Callback called when middleware is called
+	 * @param {string} [options.mountPath="/"] The path hosting the middleware
+	 * @param {string} [options.beforeMiddleware] The name of the middleware called before the added middleware
+	 * @param {string} [options.afterMiddleware] The name of the middleware called after the added middleware
+	 */
 	async addMiddleware(configuredMiddlewareName, {
 		customMiddleware, wrapperCallback, mountPath = "/",
 		beforeMiddleware, afterMiddleware
@@ -51,7 +74,7 @@ class MiddlewareManager {
 		if (customMiddleware) {
 			middlewareCallback = customMiddleware;
 		} else {
-			const middlewareInfo = middlewareRepository.getMiddleware(configuredMiddlewareName);
+			const middlewareInfo = await middlewareRepository.getMiddleware(configuredMiddlewareName);
 			if (wrapperCallback) {
 				middlewareCallback = wrapperCallback(middlewareInfo);
 			} else {
@@ -98,6 +121,12 @@ class MiddlewareManager {
 		};
 	}
 
+	/**
+	 * Adds all registered standard middlewares
+	 *
+	 * @private
+	 * @returns {Promise} Resolving to <code>undefined</code> once all standard middlewares are added
+	 */
 	async addStandardMiddleware() {
 		await this.addMiddleware("csp", {
 			wrapperCallback: ({middleware: cspModule}) => {
@@ -214,6 +243,12 @@ class MiddlewareManager {
 		});
 	}
 
+	/**
+	 * Adds all registered custom middlewares
+	 *
+	 * @private
+	 * @returns {Promise} Resolving to <code>undefined</code> once all custom middlewares are added
+	 */
 	async addCustomMiddleware() {
 		const project = this.graph.getRoot();
 		const projectCustomMiddleware = project.getCustomMiddleware();
@@ -238,7 +273,7 @@ class MiddlewareManager {
 					`defines neither a "beforeMiddleware" nor an "afterMiddleware" parameter. One must be defined.`);
 			}
 			await this.addMiddleware(middlewareDef.name, {
-				customMiddleware: ({resources, middlewareUtil}) => {
+				customMiddleware: async ({resources, middlewareUtil}) => {
 					const customMiddleware = this.graph.getExtension(middlewareDef.name);
 					const specVersion = customMiddleware.getSpecVersion();
 					const options = {
@@ -254,7 +289,7 @@ class MiddlewareManager {
 						// Supply interface to MiddlewareUtil instance starting with specVersion 2.0
 						params.middlewareUtil = middlewareUtil.getInterface(specVersion);
 					}
-					return customMiddleware.getMiddleware()(params);
+					return (await customMiddleware.getMiddleware())(params);
 				},
 				mountPath: middlewareDef.mountPath,
 				beforeMiddleware: middlewareDef.beforeMiddleware,
@@ -264,4 +299,4 @@ class MiddlewareManager {
 	}
 }
 
-module.exports = MiddlewareManager;
+export default MiddlewareManager;

package/lib/middleware/MiddlewareUtil.js

@@ -1,3 +1,6 @@
+import parseurl from "parseurl";
+import mime from "mime-types";
+
 /**
  * Convenience functions for UI5 Server middleware.
  * An instance of this class is passed to every standard UI5 Server middleware.
@@ -8,7 +11,9 @@
  * version defined for the extension.
  *
  * @public
- * @memberof module:@ui5/server.middleware
+ * @class
+ * @alias @ui5/server/middleware/MiddlewareUtil
+ * @hideconstructor
  */
 class MiddlewareUtil {
 	/**
@@ -54,7 +59,6 @@ class MiddlewareUtil {
 	 * @public
 	 */
 	getPathname(req) {
-		const parseurl = require("parseurl");
 		let {pathname} = parseurl(req);
 		pathname = decodeURIComponent(pathname);
 		return pathname;
@@ -75,7 +79,7 @@ class MiddlewareUtil {
 	 * @property {string} type Detected content-type for the given resource path
 	 * @property {string} charset Default charset for the detected content-type
 	 * @property {string} contentType Calculated content-type header value
-	 * @memberof module:@ui5/server.middleware.MiddlewareUtil
+	 * @memberof @ui5/server/middleware/MiddlewareUtil
 	 */
 	/**
 	 * Returns MIME information derived from a given resource path.
@@ -84,11 +88,10 @@ class MiddlewareUtil {
 	 * <b>Specification Version 2.0 and above</b>.
 	 *
 	 * @param {object} resourcePath
-	 * @returns {module:@ui5/server.middleware.MiddlewareUtil.MimeInfo}
+	 * @returns {@ui5/server/middleware/MiddlewareUtil.MimeInfo}
 	 * @public
 	 */
 	getMimeInfo(resourcePath) {
-		const mime = require("mime-types");
 		const type = mime.lookup(resourcePath) || "application/octet-stream";
 		const charset = mime.charset(type);
 		return {
@@ -99,4 +102,4 @@ class MiddlewareUtil {
 	}
 }
 
-module.exports = MiddlewareUtil;
+export default MiddlewareUtil;

package/lib/middleware/connectUi5Proxy.js

@@ -1,4 +1,4 @@
-const ui5connect = require("connect-openui5");
+import ui5connect from "connect-openui5";
 
 function createMiddleware() {
 	return ui5connect.proxy({
@@ -6,4 +6,4 @@ function createMiddleware() {
 	});
 }
 
-module.exports = createMiddleware;
+export default createMiddleware;

package/lib/middleware/csp.js

@@ -1,8 +1,10 @@
-const parseurl = require("parseurl");
-const Router = require("router");
-const querystring = require("querystring");
+import parseurl from "parseurl";
+import Router from "router";
+import querystring from "node:querystring";
+import logger from "@ui5/logger";
+import bodyParser from "body-parser";
 
-const log = require("@ui5/logger").getLogger("server:middleware:csp");
+const log = logger.getLogger("server:middleware:csp");
 
 const HEADER_CONTENT_SECURITY_POLICY = "Content-Security-Policy";
 const HEADER_CONTENT_SECURITY_POLICY_REPORT_ONLY = "Content-Security-Policy-Report-Only";
@@ -77,7 +79,6 @@ function createMiddleware(sCspUrlParameterName, oConfig) {
 	// .csplog
 	// body parser is required to parse csp-report in body (json)
 	if (serveCSPReports) {
-		const bodyParser = require("body-parser");
 		router.post("/.ui5/csp/report.csplog", bodyParser.json({type: "application/csp-report"}));
 	}
 	router.post("/.ui5/csp/report.csplog", function(req, res, next) {
@@ -196,4 +197,4 @@ function createMiddleware(sCspUrlParameterName, oConfig) {
 	return router;
 }
 
-module.exports = createMiddleware;
+export default createMiddleware;

package/lib/middleware/discovery.js

@@ -112,4 +112,4 @@ function createMiddleware({resources}) {
 	};
 }
 
-module.exports = createMiddleware;
+export default createMiddleware;

package/lib/middleware/middlewareRepository.js

@@ -1,34 +1,55 @@
 const middlewareInfos = {
 	compression: {path: "compression"},
 	cors: {path: "cors"},
-	csp: {path: "./csp"},
-	serveResources: {path: "./serveResources"},
-	serveIndex: {path: "./serveIndex"},
-	discovery: {path: "./discovery"},
-	versionInfo: {path: "./versionInfo"},
-	connectUi5Proxy: {path: "./connectUi5Proxy"},
-	serveThemes: {path: "./serveThemes"},
-	testRunner: {path: "./testRunner"},
-	nonReadRequests: {path: "./nonReadRequests"}
+	csp: {path: "./csp.js"},
+	serveResources: {path: "./serveResources.js"},
+	serveIndex: {path: "./serveIndex.js"},
+	discovery: {path: "./discovery.js"},
+	versionInfo: {path: "./versionInfo.js"},
+	connectUi5Proxy: {path: "./connectUi5Proxy.js"},
+	serveThemes: {path: "./serveThemes.js"},
+	testRunner: {path: "./testRunner.js"},
+	nonReadRequests: {path: "./nonReadRequests.js"}
 };
 
-function getMiddleware(middlewareName) {
+// see  @ui5/server/internal/middlewareRepository#getMiddleware
+async function getMiddleware(middlewareName) {
 	const middlewareInfo = middlewareInfos[middlewareName];
 
 	if (!middlewareInfo) {
 		throw new Error(`middlewareRepository: Unknown Middleware ${middlewareName}`);
 	}
 	try {
-		const middleware = require(middlewareInfo.path);
+		const {default: middleware} = await import(middlewareInfo.path);
 		return {
 			middleware
 		};
 	} catch (err) {
 		throw new Error(
-			`middlewareRepository: Failed to require middleware module for ${middlewareName}: ${err.message}`);
+			`middlewareRepository: Failed to require middleware module for ${middlewareName}:\n${err.stack}`);
 	}
 }
+/**
+ * @private
+ * @typedef {object} module:@ui5/server/internal/middlewareRepository~Middleware
+ * @property {object} middleware The middleware
+ */
 
-module.exports = {
+/**
+ * @private
+ * @module @ui5/server/internal/middlewareRepository
+ * @borrows getMiddleware as getMiddleware
+ */
+export default {
+
+	/**
+	 * Determines the desired middleware
+	 *
+	 * @private
+	 * @static
+	 * @function
+	 * @param {string} middlewareName The name of the middleware
+	 * @returns {module:@ui5/server/internal/middlewareRepository~Middleware} The middleware
+	 */
 	getMiddleware: getMiddleware
 };

package/lib/middleware/nonReadRequests.js

@@ -20,4 +20,4 @@ function createMiddleware() {
 	};
 }
 
-module.exports = createMiddleware;
+export default createMiddleware;

package/lib/middleware/serveIndex.js

@@ -1,6 +1,7 @@
-const log = require("@ui5/logger").getLogger("server:middleware:serveIndex");
-const mime = require("mime-types");
-const serveIndex = require("./serveIndex/serveIndex.js");
+import logger from "@ui5/logger";
+const log = logger.getLogger("server:middleware:serveIndex");
+import mime from "mime-types";
+import serveIndex from "./serveIndex/serveIndex.cjs";
 
 const KB = 1024;
 const MB = KB * KB;
@@ -120,4 +121,4 @@ function createMiddleware({resources, middlewareUtil, simpleIndex = false, showH
 	};
 }
 
-module.exports = createMiddleware;
+export default createMiddleware;

package/lib/middleware/serveResources.js

@@ -1,7 +1,8 @@
-const log = require("@ui5/logger").getLogger("server:middleware:serveResources");
-const replaceStream = require("replacestream");
-const etag = require("etag");
-const fresh = require("fresh");
+import logger from "@ui5/logger";
+const log = logger.getLogger("server:middleware:serveResources");
+import replaceStream from "replacestream";
+import etag from "etag";
+import fresh from "fresh";
 
 const rProperties = /\.properties$/i;
 const rReplaceVersion = /\.(library|js|json)$/i;
@@ -33,14 +34,16 @@ function createMiddleware({resources, middlewareUtil}) {
 				return;
 			}
 			if (log.isLevelEnabled("verbose")) {
-				const treeify = require("treeify");
+				const {
+					default: treeify
+				} = await import("treeify");
 				log.verbose("\n" + treeify.asTree(resource.getPathTree()));
 			}
 
 			const resourcePath = resource.getPath();
 			if (rProperties.test(resourcePath)) {
 				// Special handling for *.properties files escape non ascii characters.
-				const nonAsciiEscaper = require("@ui5/builder").processors.nonAsciiEscaper;
+				const {default: nonAsciiEscaper} = await import("@ui5/builder/processors/nonAsciiEscaper");
 				const project = resource.getProject();
 				let propertiesFileSourceEncoding = project?.getPropertiesFileSourceEncoding();
 
@@ -98,4 +101,4 @@ function createMiddleware({resources, middlewareUtil}) {
 	};
 }
 
-module.exports = createMiddleware;
+export default createMiddleware;

package/lib/middleware/serveThemes.js

@@ -1,9 +1,9 @@
-const themeBuilder = require("@ui5/builder").processors.themeBuilder;
-const fsInterface = require("@ui5/fs").fsInterface;
-const {basename, dirname} = require("path").posix;
-const etag = require("etag");
-const fresh = require("fresh");
-const parseurl = require("parseurl");
+import {ThemeBuilder} from "@ui5/builder/processors/themeBuilder";
+import fsInterface from "@ui5/fs/fsInterface";
+import {basename, dirname} from "node:path/posix";
+import etag from "etag";
+import fresh from "fresh";
+import parseurl from "parseurl";
 
 function isFresh(req, res) {
 	return fresh(req.headers, {
@@ -40,7 +40,7 @@ const themeResources = [
  * @returns {Function} Returns a server middleware closure.
  */
 function createMiddleware({resources, middlewareUtil}) {
-	const builder = new themeBuilder.ThemeBuilder({
+	const builder = new ThemeBuilder({
 		fs: fsInterface(resources.all)
 	});
 	const buildOptions = {};
@@ -120,4 +120,4 @@ function createMiddleware({resources, middlewareUtil}) {
 	};
 }
 
-module.exports = createMiddleware;
+export default createMiddleware;

package/lib/middleware/testRunner.js

@@ -1,10 +1,11 @@
-const {promisify} = require("util");
-const fs = require("graceful-fs");
+import {promisify} from "node:util";
+import fs from "graceful-fs";
 const readFile = promisify(fs.readFile);
-const path = require("path");
-const mime = require("mime-types");
-const parseurl = require("parseurl");
-const log = require("@ui5/logger").getLogger("server:middleware:testRunner");
+import {fileURLToPath} from "node:url";
+import mime from "mime-types";
+import parseurl from "parseurl";
+import logger from "@ui5/logger";
+const log = logger.getLogger("server:middleware:testRunner");
 
 const testRunnerResourceRegEx = /\/test-resources\/sap\/ui\/qunit\/(testrunner\.(html|css)|TestRunner.js)$/;
 const resourceCache = {};
@@ -40,7 +41,8 @@ function createMiddleware({resources}) {
 				log.verbose(`Serving ${pathname}`);
 				let pResource;
 				if (!resourceCache[pathname]) {
-					pResource = readFile(path.join(__dirname, "testRunner", resourceName), {encoding: "utf8"});
+					const filePath = fileURLToPath(new URL(`./testRunner/${resourceName}`, import.meta.url));
+					pResource = readFile(filePath, {encoding: "utf8"});
 					resourceCache[pathname] = pResource;
 				} else {
 					pResource = resourceCache[pathname];
@@ -57,4 +59,4 @@ function createMiddleware({resources}) {
 	};
 }
 
-module.exports = createMiddleware;
+export default createMiddleware;

package/lib/middleware/versionInfo.js

@@ -1,5 +1,5 @@
-const createVersionInfoProcessor = require("@ui5/builder").processors.versionInfoGenerator;
-const createManifestProcessor = require("@ui5/builder").processors.manifestCreator;
+import createVersionInfoProcessor from "@ui5/builder/processors/versionInfoGenerator";
+import createManifestProcessor from "@ui5/builder/processors/manifestCreator";
 
 const MANIFEST_JSON = "manifest.json";
 
@@ -8,8 +8,8 @@ const MANIFEST_JSON = "manifest.json";
  *
  * @module @ui5/server/middleware/versionInfo
  * @param {object} parameters Parameters
- * @param {module:@ui5/server.middleware.MiddlewareManager.middlewareResources} parameters.resources Parameters
- * @param {module:@ui5/project.graph.ProjectGraph} parameters.graph Project graph
+ * @param {@ui5/server.middleware.MiddlewareManager.middlewareResources} parameters.resources Parameters
+ * @param {@ui5/project.graph.ProjectGraph} parameters.graph Project graph
  * @returns {Function} Returns a server middleware closure.
  */
 function createMiddleware({resources, graph}) {
@@ -74,4 +74,4 @@ function createMiddleware({resources, graph}) {
 	};
 }
 
-module.exports = createMiddleware;
+export default createMiddleware;

package/lib/server.js

@@ -1,11 +1,13 @@
-const express = require("express");
-const portscanner = require("portscanner");
+import express from "express";
+import portscanner from "portscanner";
+import MiddlewareManager from "./middleware/MiddlewareManager.js";
+import {createReaderCollection} from "@ui5/fs/resourceFactory";
+import ReaderCollectionPrioritized from "@ui5/fs/ReaderCollectionPrioritized";
 
-const MiddlewareManager = require("./middleware/MiddlewareManager");
-
-const ui5Fs = require("@ui5/fs");
-const resourceFactory = ui5Fs.resourceFactory;
-const ReaderCollectionPrioritized = ui5Fs.ReaderCollectionPrioritized;
+/**
+ * @public
+ * @module @ui5/server
+ */
 
 /**
  * Returns a promise resolving by starting the server.
@@ -79,13 +81,14 @@ function _listen(app, port, changePortIfInUse, acceptRemoteConnections) {
  * @param {object} parameters.app The original express application
  * @param {string} parameters.key Path to private key to be used for https
  * @param {string} parameters.cert Path to certificate to be used for for https
- * @returns {object} The express application with SSL support
+ * @returns {Promise<object>} The express application with SSL support
  * @private
  */
-function _addSsl({app, key, cert}) {
+async function _addSsl({app, key, cert}) {
 	// Using spdy as http2 server as the native http2 implementation
 	// from Node v8.4.0 doesn't seem to work with express
-	return require("spdy").createServer({cert, key}, app);
+	const {default: spdy} = await import("spdy");
+	return spdy.createServer({cert, key}, app);
 }
 
 
@@ -93,7 +96,7 @@ function _addSsl({app, key, cert}) {
  * SAP target CSP middleware options
  *
  * @public
- * @typedef {object} module:@ui5/server.server.SAPTargetCSPOptions
+ * @typedef {object} module:@ui5/server.SAPTargetCSPOptions
  * @property {string} [defaultPolicy="sap-target-level-1"]
  * @property {string} [defaultPolicyIsReportOnly=true]
  * @property {string} [defaultPolicy2="sap-target-level-2"]
@@ -103,94 +106,87 @@ function _addSsl({app, key, cert}) {
 
 
 /**
+ * Start a server for the given project (sub-)tree.
+ *
  * @public
- * @namespace
- * @alias module:@ui5/server.server
+ * @param {@ui5/project/graph/ProjectGraph} graph Project graph
+ * @param {object} options Options
+ * @param {number} options.port Port to listen to
+ * @param {boolean} [options.changePortIfInUse=false] If true, change the port if it is already in use
+ * @param {boolean} [options.h2=false] Whether HTTP/2 should be used - defaults to <code>http</code>
+ * @param {string} [options.key] Path to private key to be used for https
+ * @param {string} [options.cert] Path to certificate to be used for for https
+ * @param {boolean} [options.simpleIndex=false] Use a simplified view for the server directory listing
+ * @param {boolean} [options.acceptRemoteConnections=false] If true, listens to remote connections and
+ * 															not only to localhost connections
+ * @param {boolean|module:@ui5/server.SAPTargetCSPOptions} [options.sendSAPTargetCSP=false]
+ * 										If set to <code>true</code> or an object, then the default (or configured)
+ * 										set of security policies that SAP and UI5 aim for (AKA 'target policies'),
+ * 										are send for any requested <code>*.html</code> file
+ * @param {boolean} [options.serveCSPReports=false] Enable CSP reports serving for request url
+ * 										'/.ui5/csp/csp-reports.json'
+ * @returns {Promise<object>} Promise resolving once the server is listening.
+ * 							It resolves with an object containing the <code>port</code>,
+ * 							<code>h2</code>-flag and a <code>close</code> function,
+ * 							which can be used to stop the server.
  */
-module.exports = {
-	/**
-	 * Start a server for the given project (sub-)tree.
-	 *
-	 * @public
-	 * @param {module:@ui5/project.graph.ProjectGraph} graph Project graph
-	 * @param {object} options Options
-	 * @param {number} options.port Port to listen to
-	 * @param {boolean} [options.changePortIfInUse=false] If true, change the port if it is already in use
-	 * @param {boolean} [options.h2=false] Whether HTTP/2 should be used - defaults to <code>http</code>
-	 * @param {string} [options.key] Path to private key to be used for https
-	 * @param {string} [options.cert] Path to certificate to be used for for https
-	 * @param {boolean} [options.simpleIndex=false] Use a simplified view for the server directory listing
-	 * @param {boolean} [options.acceptRemoteConnections=false] If true, listens to remote connections and
-	 * 															not only to localhost connections
-	 * @param {boolean|module:@ui5/server.server.SAPTargetCSPOptions} [options.sendSAPTargetCSP=false]
-	 * 										If set to <code>true</code> or an object, then the default (or configured)
-	 * 										set of security policies that SAP and UI5 aim for (AKA 'target policies'),
-	 * 										are send for any requested <code>*.html</code> file
-	 * @param {boolean} [options.serveCSPReports=false] Enable CSP reports serving for request url
-	 * 										'/.ui5/csp/csp-reports.json'
-	 * @returns {Promise<object>} Promise resolving once the server is listening.
-	 * 							It resolves with an object containing the <code>port</code>,
-	 * 							<code>h2</code>-flag and a <code>close</code> function,
-	 * 							which can be used to stop the server.
-	 */
-	async serve(graph, {
-		port: requestedPort, changePortIfInUse = false, h2 = false, key, cert,
-		acceptRemoteConnections = false, sendSAPTargetCSP = false, simpleIndex = false, serveCSPReports = false
-	}) {
-		const rootProject = graph.getRoot();
-
-		const readers = [];
-		await graph.traverseBreadthFirst(async function({project: dep}) {
-			if (dep.getName() === rootProject.getName()) {
-				// Ignore root project
-				return;
-			}
-			readers.push(dep.getReader({style: "runtime"}));
-		});
-
-		const dependencies = resourceFactory.createReaderCollection({
-			name: `Dependency reader collection for project ${rootProject.getName()}`,
-			readers
-		});
-
-		const rootReader = rootProject.getReader({style: "runtime"});
+export async function serve(graph, {
+	port: requestedPort, changePortIfInUse = false, h2 = false, key, cert,
+	acceptRemoteConnections = false, sendSAPTargetCSP = false, simpleIndex = false, serveCSPReports = false
+}) {
+	const rootProject = graph.getRoot();
+
+	const readers = [];
+	await graph.traverseBreadthFirst(async function({project: dep}) {
+		if (dep.getName() === rootProject.getName()) {
+			// Ignore root project
+			return;
+		}
+		readers.push(await dep.getReader({style: "runtime"}));
+	});
 
-		// TODO change to ReaderCollection once duplicates are sorted out
-		const combo = new ReaderCollectionPrioritized({
-			name: "server - prioritize workspace over dependencies",
-			readers: [rootReader, dependencies]
-		});
-		const resources = {
-			rootProject: rootReader,
-			dependencies: dependencies,
-			all: combo
-		};
-
-		const middlewareManager = new MiddlewareManager({
-			graph,
-			resources,
-			options: {
-				sendSAPTargetCSP,
-				serveCSPReports,
-				simpleIndex
-			}
-		});
+	const dependencies = createReaderCollection({
+		name: `Dependency reader collection for project ${rootProject.getName()}`,
+		readers
+	});
 
-		let app = express();
-		await middlewareManager.applyMiddleware(app);
+	const rootReader = await rootProject.getReader({style: "runtime"});
 
-		if (h2) {
-			app = _addSsl({app, key, cert});
+	// TODO change to ReaderCollection once duplicates are sorted out
+	const combo = new ReaderCollectionPrioritized({
+		name: "server - prioritize workspace over dependencies",
+		readers: [rootReader, dependencies]
+	});
+	const resources = {
+		rootProject: rootReader,
+		dependencies: dependencies,
+		all: combo
+	};
+
+	const middlewareManager = new MiddlewareManager({
+		graph,
+		resources,
+		options: {
+			sendSAPTargetCSP,
+			serveCSPReports,
+			simpleIndex
 		}
+	});
 
-		const {port, server} = await _listen(app, requestedPort, changePortIfInUse, acceptRemoteConnections);
+	let app = express();
+	await middlewareManager.applyMiddleware(app);
 
-		return {
-			h2,
-			port,
-			close: function(callback) {
-				server.close(callback);
-			}
-		};
+	if (h2) {
+		app = await _addSsl({app, key, cert});
 	}
-};
+
+	const {port, server} = await _listen(app, requestedPort, changePortIfInUse, acceptRemoteConnections);
+
+	return {
+		h2,
+		port,
+		close: function(callback) {
+			server.close(callback);
+		}
+	};
+}

package/lib/sslUtil.js

@@ -1,58 +1,63 @@
-const os = require("os");
-const fs = require("fs");
-const log = require("@ui5/logger").getLogger("server:sslUtil");
-const {promisify} = require("util");
+import os from "node:os";
+import fs from "node:fs";
+import logger from "@ui5/logger";
+const log = logger.getLogger("server:sslUtil");
+import {promisify} from "node:util";
 
 const stat = promisify(fs.stat);
-const path = require("path");
+import path from "node:path";
 
 const readFile = promisify(fs.readFile);
 const writeFile = promisify(fs.writeFile);
-const makeDir = require("make-dir");
 
-const sslUtil = {
-	/**
-	 * Creates a new SSL certificate or validates an existing one.
-	 *
-	 * @module @ui5/server/sslUtil
-	 * @param {string} [keyPath=$HOME/.ui5/server/server.key]  Path to private key to be used for https.
-	 *                                                         Defaults to <code>$HOME/.ui5/server/server.key</code>
-	 * @param {string} [certPath=$HOME/.ui5/server/server.crt] Path to certificate to be used for for https.
-	 *                                                         Defaults to <code>$HOME/.ui5/server/server.crt</codee>
-	 * @returns {Promise<object>} Resolves with an sslObject containing <code>cert</code> and <code>key</code>
-	 */
-	getSslCertificate: function(
-		keyPath = path.join(os.homedir(), ".ui5/server/server.key"),
-		certPath = path.join(os.homedir(), ".ui5/server/server.crt")
-	) {
-		// checks the certificates if they are present
-		return Promise.all([
-			fileExists(keyPath).then((bExists) => {
-				if (!bExists) {
-					log.verbose(`No SSL private key found at ${keyPath}`);
-					return false;
-				}
-				return readFile(keyPath);
-			}),
-			fileExists(certPath).then((bExists) => {
-				if (!bExists) {
-					log.verbose(`No SSL certificate found at ${certPath}`);
-					return false;
-				}
-				return readFile(certPath);
-			})
-		]).then(function([key, cert]) {
-			if (key && cert) {
-				return {key, cert};
+
+/**
+ * @private
+ * @module @ui5/server/internal/sslUtil
+ */
+
+/**
+ * Creates a new SSL certificate or validates an existing one.
+ *
+ * @private
+ * @static
+ * @param {string} [keyPath=$HOME/.ui5/server/server.key]  Path to private key to be used for https.
+ *                                                         Defaults to <code>$HOME/.ui5/server/server.key</code>
+ * @param {string} [certPath=$HOME/.ui5/server/server.crt] Path to certificate to be used for for https.
+ *                                                         Defaults to <code>$HOME/.ui5/server/server.crt</codee>
+ * @returns {Promise<object>} Resolves with an sslObject containing <code>cert</code> and <code>key</code>
+ */
+export function getSslCertificate(
+	keyPath = path.join(os.homedir(), ".ui5/server/server.key"),
+	certPath = path.join(os.homedir(), ".ui5/server/server.crt")
+) {
+	// checks the certificates if they are present
+	return Promise.all([
+		fileExists(keyPath).then((bExists) => {
+			if (!bExists) {
+				log.verbose(`No SSL private key found at ${keyPath}`);
+				return false;
 			}
-			return createAndInstallCertificate(keyPath, certPath);
-		});
-	}
-};
+			return readFile(keyPath);
+		}),
+		fileExists(certPath).then((bExists) => {
+			if (!bExists) {
+				log.verbose(`No SSL certificate found at ${certPath}`);
+				return false;
+			}
+			return readFile(certPath);
+		})
+	]).then(function([key, cert]) {
+		if (key && cert) {
+			return {key, cert};
+		}
+		return createAndInstallCertificate(keyPath, certPath);
+	});
+}
 
 
 async function createAndInstallCertificate(keyPath, certPath) {
-	const yesno = require("yesno");
+	const {default: yesno} = await import("yesno");
 
 	const ok = await yesno({
 		question: "No SSL certificates found. " +
@@ -65,7 +70,7 @@ async function createAndInstallCertificate(keyPath, certPath) {
 	}
 
 	// In case certificate is not found, create a self-signed one and put it into the user's trust store
-	const devCert = require("devcert-sanscache");
+	const {default: devCert} = await import("devcert-sanscache");
 
 	// Inform end user about entering his root password (needed for importing
 	// the created certificate into the system)
@@ -81,6 +86,9 @@ async function createAndInstallCertificate(keyPath, certPath) {
 	}
 
 	const {key, cert} = await devCert("UI5Tooling");
+
+	const {default: makeDir} = await import("make-dir");
+
 	await Promise.all([
 		// Write certificates to the ui5 certificate folder
 		// such that they are used by default upon next startup
@@ -99,5 +107,3 @@ function fileExists(filePath) {
 		}
 	});
 }
-
-module.exports = sslUtil;

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@ui5/server",
-	"version": "3.0.0-alpha.3",
+	"version": "3.0.0-alpha.4",
 	"description": "UI5 Tooling - Server",
 	"author": {
 		"name": "SAP SE",
@@ -16,7 +16,14 @@
 		"development",
 		"tool"
 	],
-	"main": "index.js",
+	"type": "module",
+	"exports": {
+		".": "./lib/server.js",
+		"./internal/sslUtil": "./lib/sslUtil.js",
+		"./internal/middlewareRepository": "./lib/middleware/middlewareRepository.js",
+		"./internal/MiddlewareManager": "./lib/middleware/MiddlewareManager.js",
+		"./package.json": "./package.json"
+	},
 	"engines": {
 		"node": ">= 16.13.2",
 		"npm": ">= 8"
@@ -27,11 +34,11 @@
 		"lint": "eslint ./",
 		"unit": "rimraf test/tmp && ava",
 		"unit-verbose": "rimraf test/tmp && cross-env UI5_LOG_LVL=verbose ava --verbose --serial",
-		"unit-watch": "rimraf test/tmp && ava --watch",
-		"unit-nyan": "rimraf test/tmp && ava --tap | tnyan",
-		"unit-xunit": "rimraf test/tmp && ava --tap | tap-xunit --dontUseCommentsAsTestNames=true > test-results.xml",
+		"unit-watch": "npm run unit -- --watch",
+		"unit-nyan": "npm run unit -- --tap | tnyan",
+		"unit-xunit": "rimraf test/tmp && ava --node-arguments=\"--experimental-loader=@istanbuljs/esm-loader-hook\" --tap | tap-xunit --dontUseCommentsAsTestNames=true > test-results.xml",
 		"unit-inspect": "cross-env UI5_LOG_LVL=verbose ava debug --break",
-		"coverage": "nyc npm run unit",
+		"coverage": "rimraf test/tmp && nyc ava --node-arguments=\"--experimental-loader=@istanbuljs/esm-loader-hook\"",
 		"coverage-xunit": "nyc --reporter=text --reporter=text-summary --reporter=cobertura npm run unit-xunit",
 		"jsdoc": "npm run jsdoc-generate && open-cli jsdocs/index.html",
 		"jsdoc-generate": "jsdoc -c ./jsdoc.json -t $(node -p 'path.dirname(require.resolve(\"docdash\"))') ./lib/ || (echo 'Error during JSDoc generation! Check log.' && exit 1)",
@@ -40,10 +47,9 @@
 		"version": "git-chglog --sort semver --next-tag v$npm_package_version -o CHANGELOG.md && 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 docdash,compression,cors"
+		"depcheck": "depcheck --ignores @ui5/server,docdash,compression,cors,@istanbuljs/esm-loader-hook --parsers='**/*.js:es6,**/*.cjs:es6'"
 	},
 	"files": [
-		"index.js",
 		"CHANGELOG.md",
 		"CONTRIBUTING.md",
 		"jsdoc.json",
@@ -57,6 +63,10 @@
 		],
 		"ignoredByWatcher": [
 			"test/tmp/**"
+		],
+		"nodeArguments": [
+			"--loader=esmock",
+			"--no-warnings"
 		]
 	},
 	"nyc": {
@@ -71,8 +81,8 @@
 			"jsdocs/**",
 			"coverage/**",
 			"test/**",
-			".eslintrc.js",
-			"jsdoc-plugin.js"
+			".eslintrc.cjs",
+			"jsdoc-plugin.cjs"
 		],
 		"check-coverage": true,
 		"statements": 90,
@@ -105,9 +115,9 @@
 		"url": "git@github.com:SAP/ui5-server.git"
 	},
 	"dependencies": {
-		"@ui5/builder": "^3.0.0-alpha.9",
-		"@ui5/fs": "^3.0.0-alpha.5",
-		"@ui5/logger": "^3.0.1-alpha.1",
+		"@ui5/builder": "^3.0.0-alpha.12",
+		"@ui5/fs": "^3.0.0-alpha.7",
+		"@ui5/logger": "^3.0.1-alpha.3",
 		"body-parser": "^1.19.1",
 		"compression": "^1.7.4",
 		"connect-openui5": "^0.10.2",
@@ -129,21 +139,23 @@
 		"yesno": "^0.3.1"
 	},
 	"devDependencies": {
-		"@ui5/project": "^3.0.0-alpha.6",
-		"ava": "^3.15.0",
+		"@istanbuljs/esm-loader-hook": "^0.2.0",
+		"@ui5/project": "^3.0.0-alpha.10",
+		"ava": "^4.3.3",
 		"chokidar-cli": "^3.0.0",
 		"cross-env": "^7.0.3",
 		"depcheck": "^1.4.3",
 		"docdash": "^1.2.0",
 		"eslint": "^8.7.0",
 		"eslint-config-google": "^0.14.0",
+		"eslint-plugin-ava": "^13.0.2",
 		"eslint-plugin-jsdoc": "^37.6.3",
+		"esmock": "^2.0.0",
 		"jsdoc": "^3.6.7",
-		"mock-require": "^3.0.3",
 		"nyc": "^15.1.0",
 		"open-cli": "^6.0.1",
 		"rimraf": "^3.0.2",
-		"sinon": "^11.1.2",
+		"sinon": "^14.0.0",
 		"supertest": "^6.2.1",
 		"tap-nyan": "^1.1.0",
 		"tap-xunit": "^2.4.1"

package/index.js

@@ -1,35 +0,0 @@
-/**
- * @module @ui5/server
- * @public
- */
-module.exports = {
-	/**
-	 * @type {import('./lib/server')}
-	 */
-	server: "./lib/server",
-	/**
-	 * @type {import('./lib/sslUtil')}
-	 */
-	sslUtil: "./lib/sslUtil",
-	/**
-	 * @type {import('./lib/middleware/middlewareRepository')}
-	 */
-	middlewareRepository: "./lib/middleware/middlewareRepository"
-};
-
-function exportModules(exportRoot, modulePaths) {
-	for (const moduleName of Object.keys(modulePaths)) {
-		if (typeof modulePaths[moduleName] === "object") {
-			exportRoot[moduleName] = {};
-			exportModules(exportRoot[moduleName], modulePaths[moduleName]);
-		} else {
-			Object.defineProperty(exportRoot, moduleName, {
-				get() {
-					return require(modulePaths[moduleName]);
-				}
-			});
-		}
-	}
-}
-
-exportModules(module.exports, JSON.parse(JSON.stringify(module.exports)));