@sap-ux/preview-middleware 0.20.29 → 0.20.31

package/README.md

@@ -32,7 +32,7 @@ When this middleware is used together with the `reload-middleware`, then the ord
 | `editors.rta`           | `array`    | optional                                       | `undefined`      | Configuration allowing to add mount points for runtime adaptation                                                                                                                                                                                     |
 | `editors.rta.layer`     | `string`   | optional                                       | `(calculated)`   | Property for defining the runtime adaptation layer for changes (default is `CUSTOMER_BASE` or read from the project for adaptation projects)                                                                                                          |
 | `editors.rta.endpoints` | `array`    | optional                                       | `undefined`      | List of mount points for editing                                                                                                                                               
-| `editors.cardGenerator` | ---    | optional                                       | `undefined`      | Configuration object to enable card generation for an application.
+| `editors.cardGenerator` | ---    | optional                                       | `undefined`      | Configuration object to enable card generation for an application (only supported for non-CAP apps).
 | `editors.cardGenerator.path` | `string`   | optional                              | `test/flpGeneratorSandbox.html`      | The mount point of the local SAP Fiori launchpad which will be considered for card generation.          
 | `test`                  | `array`    | optional                                       | `undefined`      | List of configurations for automated testing.                                                                                                                                                                                                         |
 | `debug`                 | `boolean`  | optional                                       | `false`          | Enables the debug output                                                                                                                                                                                                                              |
@@ -127,10 +127,11 @@ server:
   - name: preview-middleware
     afterMiddleware: compression
     configuration:
-      rta:
-        layer: CUSTOMER_BASE
-        editors:
-          - path: /test/variant-editor.html
+      editors:
+        rta:
+          layer: CUSTOMER_BASE
+          endpoints:
+            - path: /test/variant-editor.html
 ```
 This mount path can be used with a run script that looks as follows.
 ```Json

package/dist/base/flp.js

@@ -395,7 +395,13 @@ class FlpSandbox {
         const previewGeneratorPath = this.cardGenerator?.path ?? config_1.CARD_GENERATOR_DEFAULT.previewGeneratorSandbox;
         this.logger.debug(`Add route for ${previewGeneratorPath}`);
         this.router.get(previewGeneratorPath, async (req, res, next) => {
-            this.templateConfig.enableCardGenerator = !!this.cardGenerator?.path;
+            if (this.projectType === 'EDMXBackend') {
+                this.templateConfig.enableCardGenerator = !!this.cardGenerator?.path;
+            }
+            else {
+                this.logger.warn(`The Card Generator is not available for CAP projects.`);
+                this.templateConfig.enableCardGenerator = false;
+            }
             await this.flpGetHandler(req, res, next);
         });
     }
@@ -813,6 +819,9 @@ class FlpSandbox {
      * @returns {Promise<void>} A promise that resolves when the route is added.
      */
     async addStoreCardManifestRoute() {
+        if (this.projectType !== 'EDMXBackend') {
+            return;
+        }
         this.router.use(config_1.CARD_GENERATOR_DEFAULT.cardsStore, (0, express_1.json)());
         this.logger.debug(`Add route for ${config_1.CARD_GENERATOR_DEFAULT.cardsStore}`);
         this.router.post(config_1.CARD_GENERATOR_DEFAULT.cardsStore, async (req, res) => {
@@ -853,6 +862,9 @@ class FlpSandbox {
      * @returns {Promise<void>} A promise that resolves when the route is added.
      */
     async addStoreI18nKeysRoute() {
+        if (this.projectType !== 'EDMXBackend') {
+            return;
+        }
         this.router.use(config_1.CARD_GENERATOR_DEFAULT.i18nStore, (0, express_1.json)());
         this.logger.debug(`Add route for ${config_1.CARD_GENERATOR_DEFAULT.i18nStore}`);
         this.router.post(config_1.CARD_GENERATOR_DEFAULT.i18nStore, async (req, res) => {

package/dist/client/flp/init.js

@@ -195,6 +195,9 @@ sap.ui.define([
     }
     async function init(_ref) {
         let {appUrls, flex, customInit, enhancedHomePage, enableCardGenerator} = _ref;
+        if (enhancedHomePage) {
+            initCdm();
+        }
         const urlParams = new URLSearchParams(window.location.search);
         const container = sap?.ushell?.Container ?? (await __ui5_require_async('sap/ushell/Container')).default;
         let scenario = '';
@@ -263,7 +266,7 @@ sap.ui.define([
         setI18nTitle(resourceBundle);
         registerSAPFonts();
         if (enhancedHomePage) {
-            await initCdm(container);
+            await container.init('cdm');
         }
         const renderer = ui5VersionInfo.major < 2 && !ui5VersionInfo.label?.includes('legacy-free') ? await container.createRenderer(undefined, true) : await container.createRendererInternal(undefined, true);
         renderer.placeAt('content');

package/dist/client/flp/init.ts

@@ -305,6 +305,12 @@ export async function init({
     enhancedHomePage?: boolean | null;
     enableCardGenerator?: boolean
 }): Promise<void> {
+    // Set CDM configuration before importing ushell container
+    // to ensure proper configuration pickup during bootstrap
+    if (enhancedHomePage) {
+        initCdm();
+    }
+
     const urlParams = new URLSearchParams(window.location.search);
     const container = sap?.ushell?.Container ??
         (await import('sap/ushell/Container')).default as unknown as typeof sap.ushell.Container;
@@ -389,7 +395,7 @@ export async function init({
     registerSAPFonts();
 
     if (enhancedHomePage) {
-        await initCdm(container);
+        await container.init('cdm');
     }
 
     const renderer =

package/dist/client/flp/initCdm.js

@@ -6,10 +6,9 @@ sap.ui.define([], function () {
   /**
    * Initializes the CDM (Common Data Model) configuration for the SAP Fiori Launchpad.
    *
-   * @param {sap.ushell.Container} container - The SAP Fiori Launchpad container.
-   * @returns {Promise<void>} A promise that resolves when the initialization is complete.
+   * @returns {void}
    */
-  async function initCdm(container) {
+  function initCdm() {
     window['sap-ushell-config'] = {
       defaultRenderer: 'fiori2',
       renderers: {
@@ -112,7 +111,6 @@ sap.ui.define([], function () {
         }
       }
     };
-    await container.init('cdm');
   }
   return initCdm;
 });

package/dist/client/flp/initCdm.ts

@@ -3,10 +3,9 @@ import { Window } from 'types/global';
 /**
  * Initializes the CDM (Common Data Model) configuration for the SAP Fiori Launchpad.
  *
- * @param {sap.ushell.Container} container - The SAP Fiori Launchpad container.
- * @returns {Promise<void>} A promise that resolves when the initialization is complete.
+ * @returns {void}
  */
-export default async function initCdm(container: typeof sap.ushell.Container): Promise<void> {
+export default function initCdm(): void {
     (window as unknown as Window)['sap-ushell-config'] = {
         defaultRenderer: 'fiori2',
         renderers: {
@@ -113,6 +112,4 @@ export default async function initCdm(container: typeof sap.ushell.Container): P
             }
         }
     };
-
-    await container.init('cdm');
 }

package/package.json

@@ -9,7 +9,7 @@
   "bugs": {
     "url": "https://github.com/SAP/open-ux-tools/issues?q=is%3Aopen+is%3Aissue+label%3Abug+label%3Apreview-middleware"
   },
-  "version": "0.20.29",
+  "version": "0.20.31",
   "license": "Apache-2.0",
   "author": "@SAP/ux-tools-team",
   "main": "dist/index.js",
@@ -25,7 +25,7 @@
     "ejs": "3.1.10",
     "mem-fs": "2.1.0",
     "mem-fs-editor": "9.4.0",
-    "@sap-ux/adp-tooling": "0.14.19",
+    "@sap-ux/adp-tooling": "0.14.20",
     "@sap-ux/btp-utils": "1.1.0",
     "@sap-ux/control-property-editor-sources": "npm:@sap-ux/control-property-editor@0.6.6",
     "@sap-ux/feature-toggle": "0.3.0",
@@ -49,7 +49,7 @@
     "nock": "13.4.0",
     "npm-run-all2": "6.2.0",
     "supertest": "6.3.3",
-    "@private/preview-middleware-client": "npm:@sap-ux-private/preview-middleware-client@0.14.6",
+    "@private/preview-middleware-client": "npm:@sap-ux-private/preview-middleware-client@0.14.7",
     "@sap-ux/axios-extension": "1.21.4",
     "@sap-ux/i18n": "0.3.0",
     "@sap-ux/store": "1.1.0",