cds-plugin-ui5 0.6.8 → 0.6.9

package/CHANGELOG.md

@@ -3,6 +3,17 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [0.6.9](https://github.com/ui5-community/ui5-ecosystem-showcase/compare/cds-plugin-ui5@0.6.8...cds-plugin-ui5@0.6.9) (2023-09-15)
+
+
+### Bug Fixes
+
+* prevent side-effects for combined scenarios ([#842](https://github.com/ui5-community/ui5-ecosystem-showcase/issues/842)) ([36aaa5f](https://github.com/ui5-community/ui5-ecosystem-showcase/commit/36aaa5f8d8b8404725250664704a560229055943))
+
+
+
+
+
 ## [0.6.8](https://github.com/ui5-community/ui5-ecosystem-showcase/compare/cds-plugin-ui5@0.6.7...cds-plugin-ui5@0.6.8) (2023-09-13)
 
 

package/README.md

@@ -2,7 +2,7 @@
 
 > :wave: This is a **community project** and there is no official support for this package! Feel free to use it, open issues, contribute, and help answering questions.
 
-The `cds-plugin-ui5` is a CAP server `cds-plugin` which enables the integration of UI5 tooling based (UI5 freestyle or Fiori elements) projects into the CAP server via the UI5 tooling express middlewares. The UI5 or Fiori elements projects just need to be located in the `app` folder of the CAP server or be dependency of the CAP server.
+The `cds-plugin-ui5` is a CDS server `cds-plugin` which enables the integration of UI5 tooling based (UI5 freestyle or Fiori elements) projects into the CDS server via the UI5 tooling express middlewares. The UI5 or Fiori elements projects just need to be located in the `app` folder of the CDS server or be dependency of the CDS server.
 
 > :construction: **Note**
 > This cds-plugin is still work in progress and not final yet!
@@ -13,7 +13,7 @@ The plugin requires [`@sap/cds`](https://www.npmjs.com/package/@sap/cds) `>=6.8.
 
 ## Usage
 
-Add a `devDependency` to the `cds-plugin-ui5` to your CAP server project:
+Add a `devDependency` to the `cds-plugin-ui5` to your CDS server project:
 
 ```sh
 npm add cds-plugin-ui5 -D
@@ -23,7 +23,7 @@ That's it!
 
 ### Configuration
 
-The plugin accepts configuration to control the mount path for the embedding into the CAP server and selected configuration options for the UI5 server middlewares which are embedded into the mount path of the CAP server.
+The plugin accepts configuration to control the mount path for the embedding into the CDS server and selected configuration options for the UI5 server middlewares which are embedded into the mount path of the CDS server.
 
 #### Mount Path
 
@@ -48,7 +48,7 @@ customConfiguration:
     mountPath: /bookshop
 ```
 
-In some cases it is necessary to overrule the UI5 application local configuration in the CAP server. Therefore, you can add custom configuration into the `package.json` of the CAP server into the section: `cds/cds-plugin-ui5/modules/%moduleId%/mountPath`
+In some cases it is necessary to overrule the UI5 application local configuration in the CDS server. Therefore, you can add custom configuration into the `package.json` of the CDS server into the section: `cds/cds-plugin-ui5/modules/%moduleId%/mountPath`
 
 ```json
 {
@@ -67,7 +67,7 @@ In some cases it is necessary to overrule the UI5 application local configuratio
 }
 ```
 
-The `moduleId` is either the directory name for local apps in the `app` directory of the CAP server or for dependencies the `name` from the `package.json`.
+The `moduleId` is either the directory name for local apps in the `app` directory of the CDS server or for dependencies the `name` from the `package.json`.
 
 The configuration can also be injected with the environment variable `CDS_PLUGIN_UI5_MODULES`. It contains the JSON string from the configuration above, e.g.:
 
@@ -77,7 +77,7 @@ CDS_PLUGIN_UI5_MODULES="{ \"ui5-bookshop\": { \"mountPath\": \"/the-bookshop\" }
 
 #### UI5 Server Middlewares
 
-If you require to configure the UI5 server middlewares, you can do so by adding some selected configuration options in the `package.json` of the CAP server in the section: `cds/cds-plugin-ui5/modules/%moduleId%`
+If you require to configure the UI5 server middlewares, you can do so by adding some selected configuration options in the `package.json` of the CDS server in the section: `cds/cds-plugin-ui5/modules/%moduleId%`
 
 ```json
 {
@@ -99,7 +99,7 @@ If you require to configure the UI5 server middlewares, you can do so by adding
 }
 ```
 
-The `moduleId` is either the directory name for local apps in the `app` directory of the CAP server or for dependencies the `name` from the `package.json`.
+The `moduleId` is either the directory name for local apps in the `app` directory of the CDS server or for dependencies the `name` from the `package.json`.
 
 The available configuration options are:
 

package/cds-plugin.js

@@ -41,7 +41,7 @@ cds.on("bootstrap", async function bootstrap(app) {
 	for await (const ui5Module of ui5Modules) {
 		const { moduleId, mountPath, modulePath } = ui5Module;
 
-		// mounting the Router for the UI5 application to the CAP server
+		// mounting the Router for the UI5 application to the CDS server
 		log.info(`Mounting ${mountPath} to UI5 app ${modulePath} (id=${moduleId})${config[moduleId] ? ` using config=${JSON.stringify(config[moduleId])}` : ""}`);
 
 		// create a patched router
@@ -65,7 +65,18 @@ cds.on("bootstrap", async function bootstrap(app) {
 		});
 	}
 
-	if (links.length > 0) {
+	// identify whether the welcome page should be rewritten
+	let rewrite = links.length > 0;
+	if (process.env["ui5-middleware-cap"]) {
+		log.info("Skip rewriting of welcome page as CDS server is started via ui5-middleware-cap!");
+		rewrite = false;
+	} else if (process.env["dev-approuter"]) {
+		log.info("Skip rewriting of welcome page as CDS server is started via dev-approuter!");
+		rewrite = false;
+	}
+
+	// rewrite the welcome page
+	if (rewrite) {
 		// register the custom middleware (similar like in @sap/cds/server.js)
 		app.get("/", function appendLinksToIndex(req, res, next) {
 			req._cds_plugin_ui5 = true; // marker for patched router to ignore
@@ -110,14 +121,14 @@ cds.on("bootstrap", async function bootstrap(app) {
 						newLis.push(...links.map((link) => `<li><a class="ui5" href="${link}">${link}</a></li>`));
 						ul.innerHTML = newLis.join("\n");
 					} else {
-						log.warn(`Failed to inject application links into CAP index page!`);
+						log.warn(`Failed to inject application links into CDS index page!`);
 					}
 				}
 			);
 			next();
 		});
 
-		// move our middleware before the CAP index serve middleware to
+		// move our middleware before the CDS index serve middleware to
 		// allow that we can intercept the response and modify it to
 		// inject our application pages an remove the exitsing ones
 		const middlewareStack = app?._router?.stack;
@@ -127,10 +138,10 @@ cds.on("bootstrap", async function bootstrap(app) {
 			if (idxOfServeStatic !== -1) {
 				middlewareStack.splice(idxOfServeStatic, 0, cmw);
 			} else {
-				log.error(`Failed to determine CAP overview page middleware! You need to manually open the application pages!`);
+				log.error(`Failed to determine welcome page middleware! The links of the application pages may not work properly!`);
 			}
 		} else {
-			log.error(`Failed to inject application pages to CAP overview page! You need to manually open the application pages!`);
+			log.error(`Failed to inject application pages to welcome page! The links of the application pages may not work properly!`);
 		}
 	}
 	// bootstrap completed, unlock the "served" event

package/lib/findUI5Modules.js

@@ -97,7 +97,7 @@ module.exports = async function findUI5Modules({ cwd, skipLocalApps, skipDeps })
 	}
 
 	// if apps are available, attach the middlewares of the UI5 apps
-	// to the express of the CAP server via a express router
+	// to the express of the CDS server via a express router
 	const apps = [];
 	apps.config = {};
 	if (appDirs) {
@@ -125,7 +125,7 @@ module.exports = async function findUI5Modules({ cwd, skipLocalApps, skipDeps })
 				const modulePath = path.dirname(ui5YamlPath);
 
 				// manually get the module name as defined in package.json
-				// skipDeps is only true if we are looking for UI5 apps inside a CAP
+				// skipDeps is only true if we are looking for UI5 apps inside a CDS
 				// server project in all other cases the module name equals the appDir
 				let moduleName;
 				if (skipDeps) {
@@ -140,7 +140,7 @@ module.exports = async function findUI5Modules({ cwd, skipLocalApps, skipDeps })
 				// by default the mount path is derived from the "metadata/name"
 				// and can be overridden by "customConfiguration/mountPath" or
 				// by "customConfiguration/cds-plugin-ui5/mountPath" or by
-				// the following configuration entry in the package.json of CAP
+				// the following configuration entry in the package.json of CDS
 				// server: "cds/cds-plugin-ui5/modules/%moduleId%/mountPath"
 				let mountPath =
 					modulesConfig?.[moduleId]?.mountPath || ui5Config?.customConfiguration?.["cds-plugin-ui5"]?.mountPath || ui5Config?.customConfiguration?.mountPath || ui5Config?.metadata?.name;
@@ -157,7 +157,7 @@ module.exports = async function findUI5Modules({ cwd, skipLocalApps, skipDeps })
 			}
 		}
 	}
-	apps.localApps = localApps; // necessary for CAP index.html rewrite
+	apps.localApps = localApps; // necessary for CDS index.html rewrite
 
 	// return the apps
 	return apps;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "cds-plugin-ui5",
-  "version": "0.6.8",
-  "description": "A CAP server cds-plugin to inject the middlewares of all related UI5 tooling based projects.",
+  "version": "0.6.9",
+  "description": "A CDS server plugin to inject the middlewares of all related UI5 tooling based projects.",
   "author": "Peter Muessig",
   "license": "Apache-2.0",
   "repository": {
@@ -24,5 +24,5 @@
     "@sap/cds": ">=6.8.2",
     "express": ">=4.18.2"
   },
-  "gitHead": "b53f5050d013dd0a8a94478ceabb7dc235234461"
+  "gitHead": "7ff4fbf9fa7501c5e2691bb2b92c1ea59a403edf"
 }