cds-plugin-ui5 0.2.3 → 0.4.0

package/CHANGELOG.md

@@ -3,6 +3,28 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+# [0.4.0](https://github.com/ui5-community/ui5-ecosystem-showcase/compare/cds-plugin-ui5@0.3.0...cds-plugin-ui5@0.4.0) (2023-08-21)
+
+
+### Features
+
+* **cds-plugin-ui5:** allow to attach custom app pages to cds server ([#800](https://github.com/ui5-community/ui5-ecosystem-showcase/issues/800)) ([0670b5e](https://github.com/ui5-community/ui5-ecosystem-showcase/commit/0670b5e9d01175ecf9d1f0db332963b8c9fec007)), closes [#785](https://github.com/ui5-community/ui5-ecosystem-showcase/issues/785)
+
+
+
+
+
+# [0.3.0](https://github.com/ui5-community/ui5-ecosystem-showcase/compare/cds-plugin-ui5@0.2.3...cds-plugin-ui5@0.3.0) (2023-08-17)
+
+
+### Features
+
+* include moduleId in return value to increase reuseability of fu… ([#796](https://github.com/ui5-community/ui5-ecosystem-showcase/issues/796)) ([ae69ed4](https://github.com/ui5-community/ui5-ecosystem-showcase/commit/ae69ed44070f72b0460893904729b49cf4341ffe))
+
+
+
+
+
 ## [0.2.3](https://github.com/ui5-community/ui5-ecosystem-showcase/compare/cds-plugin-ui5@0.2.2...cds-plugin-ui5@0.2.3) (2023-08-12)
 
 **Note:** Version bump only for package cds-plugin-ui5

package/README.md

@@ -21,6 +21,34 @@ npm add cds-plugin-ui5 -D
 
 That's it!
 
+## Info for UI5 Tooling Extension Developers
+
+Custom middlewares may generate virtual app pages which should also be listed as web applications in the welcome page of the `@sap/cds` server. This is possible by assigning a static `getAppPages` function to the middleware function. The following snippet show-cases how this can be done:
+
+```js
+// the middleware factory function
+module.exports = async ({ log, resources, options }) => {
+  // create the middleware function
+  const mwFn = (req, res, next) => {
+    [...]
+  };
+
+  /**
+   * Returns an array of app pages to be added to the welcome
+   * page of the <code>@sap/cds</code> server.
+   * @returns {undefined|string[]} array of app pages
+   */
+  mwFn.getAppPages = function() {
+    return ["/test.html"];
+  };
+
+  // finally return the middleware function
+  return mwFn;
+};
+```
+
+The returned app pages will be added to the welcome page within the respective mount path.
+
 ## Support
 
 Please use the GitHub bug tracking system to post questions, bug reports or to create pull requests.

package/cds-plugin.js

@@ -59,7 +59,7 @@ cds.on("bootstrap", async function bootstrap(app) {
 		// append the HTML pages to the links
 		appInfo.pages.forEach((page) => {
 			const prefix = mountPath !== "/" ? mountPath : "";
-			links.push(`${prefix}${page.getPath()}`);
+			links.push(`${prefix}${page}`);
 		});
 	}
 

package/lib/applyUI5Middleware.js

@@ -1,5 +1,7 @@
 const path = require("path");
 
+const log = require("./log");
+
 /**
  * @typedef UI5AppInfo
  * @type {object}
@@ -69,7 +71,25 @@ module.exports = async function applyUI5Middleware(router, { basePath, configPat
 	});
 	await middlewareManager.applyMiddleware(router);
 
+	// collect app pages from workspace
+	const pages = (await rootReader.byGlob("**/*.html")).map((resource) => resource.getPath());
+
+	// collect app pages from middlewares implementing the getAppPages
+	middlewareManager.middlewareExecutionOrder?.map((name) => {
+		const { middleware } = middlewareManager.middleware?.[name] || {};
+		if (typeof middleware?.getAppPages === "function") {
+			const customAppPages = middleware.getAppPages();
+			if (Array.isArray(customAppPages)) {
+				pages.push(...customAppPages);
+			} else {
+				if (customAppPages) {
+					log.warn(`The middleware ${name} returns an unexpected value for "getAppPages". The value must be either undefined or string[]! Ignoring app pages from middleware!`);
+				}
+			}
+		}
+	});
+
 	return {
-		pages: await rootReader.byGlob("**/*.html"),
+		pages,
 	};
 };

package/lib/findUI5Modules.js

@@ -112,7 +112,21 @@ module.exports = async function findUI5Modules({ cwd, skipLocalApps, skipDeps })
 
 				// determine the module path based on the location of the ui5.yaml
 				const modulePath = path.dirname(ui5YamlPath);
-				apps.push({ modulePath, mountPath });
+
+				// manually get the module name as defined in package.json
+				// skipDeps is only true if we are looking for UI5 apps inside a CAP server project
+				// in all other cases the module name equals the appDir
+				let moduleName;
+				if (skipDeps) {
+					const packageJsonPath = require.resolve(path.join(appDir, "package.json"), {
+						paths: [cwd],
+					});
+					const packageJsonContent = fs.readFileSync(packageJsonPath, "utf-8");
+					moduleName = JSON.parse(packageJsonContent).name;
+				}
+				const moduleId = moduleName || appDir;
+
+				apps.push({ moduleId, modulePath, mountPath });
 			}
 		}
 	}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "cds-plugin-ui5",
-  "version": "0.2.3",
+  "version": "0.4.0",
   "description": "A CAP server cds-plugin to inject the middlewares of all related UI5 tooling based projects.",
   "author": "Peter Muessig",
   "license": "Apache-2.0",
@@ -24,5 +24,5 @@
     "@sap/cds": ">=6.8.2",
     "express": ">=4.18.2"
   },
-  "gitHead": "6233f8b4d2bfaf7e7f2b32afe4320acb7fab521a"
+  "gitHead": "f187f504307eafdf24b94374264d298774331ab3"
 }