@sap-ux/preview-middleware 0.23.63 → 0.23.64

package/README.md

@@ -29,6 +29,7 @@ When this middleware is used together with the `reload-middleware`, then the ord
 | `flp.enhancedHomePage`  | `boolean`  | optional                                       | `false`          | Flag for enabling enhanced FLP homepage, available only from UI5 version 1.123.0 onwards                                                                                                                                                              |
 | `adp.target`            | ---        | mandatory for adaptation projects              | ---              | Configuration object defining the connected back end                                                                                                                                                                                                  |
 | `adp.ignoreCertErrors`  | `boolean`  | optional                                       | `false`          | Flag to ignore certification validation errors when working with development systems with self-signed certificates, for example                                                                                                                       |
+| `adp.cfBuildPath`       | `string`   | optional (experimental, CF only)               | `undefined`      | **Experimental**: For CF ADP projects only. Path to build output folder (e.g., `dist`) to serve built resources directly. When set, the middleware serves static files from this path and reads manifest.json from it. |
 | `rta`                   | ---        | 🚫 deprecated</br> *use `editors.rta` instead* | ---              | Configuration allowing to add mount points for runtime adaptation                                                                                                                                                                                     |
 | `editors`               | `array`    | optional                                       | `undefined`      | List of configurations allowing to add mount points for additional editors                                                                                                                                                                            |
 | `editors.rta`           | `array`    | optional                                       | `undefined`      | Configuration allowing to add mount points for runtime adaptation                                                                                                                                                                                     |
@@ -171,7 +172,31 @@ server:
           - path: /test/adaptation-editor.html
             developerMode: true
 ```
-When the middleware is used in an adaptation project together with a middleware proxying requests to the back end e.g. the `backend-proxy-middleware`, then it is critically important that the `preview-middleware` is handling requests before the back-end proxy because it intercepts requests to the `manifest.json` of the original application and merges it with the local variant.
+
+### [CF ADP Build Path Mode (Experimental)](#cf-adp-build-path-mode-experimental)
+**⚠️ Experimental feature - CF ADP projects only**
+
+For Cloud Foundry ADP projects, you can use the `cfBuildPath` option to serve built resources directly from a build output folder. This is useful for testing built applications without requiring backend connectivity.
+
+When `cfBuildPath` is set:
+- The middleware serves static files directly from the specified path (e.g., `dist` or `build/dist`)
+- The manifest.json is read from the build output folder
+- Static resources are served directly without backend services
+
+**Note:** This feature is experimental and only works with CF ADP projects. The path should be relative to the project root and must contain a `manifest.json` file.
+
+```Yaml
+server:
+  customMiddleware:
+  - name: preview-middleware
+    afterMiddleware: compression
+    configuration:
+      adp: 
+        target: 
+          url: http://sap.example
+        cfBuildPath: dist  # Path to build output folder (experimental, CF only)
+```
+When the middleware is used in an adaptation project together with a middleware proxying requests to the back end e.g. the `backend-proxy-middleware`, then it is critically important that the `preview-middleware` is handling requests before the back-end proxy because it intercepts requests to the `manifest.json` of the original application and merges it with the variant.
 ```Yaml
 - name: preview-middleware
   afterMiddleware: rcompression

package/dist/base/flp.d.ts

@@ -1,7 +1,7 @@
 import type { ReaderCollection } from '@ui5/fs';
 import type { Editor as MemFsEditor } from 'mem-fs-editor';
 import type { Request, Router } from 'express';
-import type { Logger, ToolsLogger } from '@sap-ux/logger';
+import type { Logger } from '@sap-ux/logger';
 import type { MiddlewareUtils } from '@ui5/server';
 import { type Manifest } from '@sap-ux/project-access';
 import { AdpPreview, type AdpPreviewConfig, type CommonChangeProperties, type OperationType, type CommonAdditionalChangeInfoProperties } from '@sap-ux/adp-tooling';
@@ -309,17 +309,26 @@ export declare class FlpSandbox {
      * @returns {Promise<void>} A promise that resolves when the route is added.
      */
     addStoreI18nKeysRoute(): Promise<void>;
+    /**
+     * Initialize the preview for an adaptation project.
+     *
+     * @param config configuration from the ui5.yaml
+     * @throws Error in case no manifest.appdescr_variant found
+     */
+    initAdp(config: AdpPreviewConfig): Promise<void>;
+    /**
+     * Setup common ADP middleware and handlers.
+     *
+     * @param adp AdpPreview instance
+     */
+    private setupAdpCommonHandlers;
+    /**
+     * Setup the CF build path mode for the ADP project.
+     *
+     * @param cfBuildPath path to the build output folder
+     * @returns the manifest
+     */
+    private setupCfBuildMode;
 }
-/**
- * Initialize the preview for an adaptation project.
- *
- * @param rootProject reference to the project
- * @param config configuration from the ui5.yaml
- * @param flp FlpSandbox instance
- * @param util middleware utilities provided by the UI5 CLI
- * @param logger logger instance
- * @throws Error in case no manifest.appdescr_variant found
- */
-export declare function initAdp(rootProject: ReaderCollection, config: AdpPreviewConfig, flp: FlpSandbox, util: MiddlewareUtils, logger: ToolsLogger): Promise<void>;
 export {};
 //# sourceMappingURL=flp.d.ts.map

package/dist/base/flp.js

@@ -34,7 +34,6 @@ var __importStar = (this && this.__importStar) || (function () {
 })();
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.FlpSandbox = void 0;
-exports.initAdp = initAdp;
 const mem_fs_1 = require("mem-fs");
 const mem_fs_editor_1 = require("mem-fs-editor");
 const ejs_1 = require("ejs");
@@ -887,6 +886,53 @@ class FlpSandbox {
             await this.storeI18nKeysHandler(req, res);
         });
     }
+    /**
+     * Initialize the preview for an adaptation project.
+     *
+     * @param config configuration from the ui5.yaml
+     * @throws Error in case no manifest.appdescr_variant found
+     */
+    async initAdp(config) {
+        const variant = await (0, adp_tooling_1.loadAppVariant)(this.project);
+        const adp = new adp_tooling_1.AdpPreview(config, this.project, this.utils, this.logger);
+        const layer = await adp.init(variant);
+        // CF ADP build path mode: serve built resources directly from build output
+        if (config.cfBuildPath) {
+            const manifest = this.setupCfBuildMode(config.cfBuildPath);
+            configureRta(this.rta, layer, variant.id, false);
+            await this.init(manifest, variant.reference);
+            this.setupAdpCommonHandlers(adp);
+            return;
+        }
+        configureRta(this.rta, layer, variant.id, adp.isCloudProject);
+        const descriptor = adp.descriptor;
+        const { name, manifest } = descriptor;
+        await this.init(manifest, name, adp.resources, adp);
+        this.router.use(adp.descriptor.url, adp.proxy.bind(adp));
+        this.setupAdpCommonHandlers(adp);
+    }
+    /**
+     * Setup common ADP middleware and handlers.
+     *
+     * @param adp AdpPreview instance
+     */
+    setupAdpCommonHandlers(adp) {
+        this.addOnChangeRequestHandler(adp.onChangeRequest.bind(adp));
+        this.router.use((0, express_1.json)());
+        adp.addApis(this.router);
+    }
+    /**
+     * Setup the CF build path mode for the ADP project.
+     *
+     * @param cfBuildPath path to the build output folder
+     * @returns the manifest
+     */
+    setupCfBuildMode(cfBuildPath) {
+        const manifest = (0, adp_tooling_1.readManifestFromBuildPath)(cfBuildPath);
+        this.router.use('/', (0, express_1.static)(cfBuildPath));
+        this.logger.info(`Initialized CF ADP with cfBuildPath, serving from ${cfBuildPath}`);
+        return manifest;
+    }
 }
 exports.FlpSandbox = FlpSandbox;
 /**
@@ -914,43 +960,26 @@ function serializeUi5Configuration(config) {
     return '\n' + serializeDataAttributes(config, '        ', 'data-sap-ui');
 }
 /**
- * Initialize the preview for an adaptation project.
+ * Configure RTA (Runtime Adaptation) for the FLP sandbox.
  *
- * @param rootProject reference to the project
- * @param config configuration from the ui5.yaml
- * @param flp FlpSandbox instance
- * @param util middleware utilities provided by the UI5 CLI
- * @param logger logger instance
- * @throws Error in case no manifest.appdescr_variant found
+ * @param rta RtaConfig instance
+ * @param layer UI5 flex layer
+ * @param variantId variant identifier
+ * @param isCloud whether this is a cloud project
  */
-async function initAdp(rootProject, config, flp, util, logger) {
-    const appVariant = await rootProject.byPath('/manifest.appdescr_variant');
-    if (appVariant) {
-        const adp = new adp_tooling_1.AdpPreview(config, rootProject, util, logger);
-        const variant = JSON.parse(await appVariant.getString());
-        const layer = await adp.init(variant);
-        if (flp.rta) {
-            flp.rta.layer = layer;
-            flp.rta.options = {
-                ...flp.rta.options,
-                projectId: variant.id,
-                scenario: 'ADAPTATION_PROJECT',
-                isCloud: adp.isCloudProject
-            };
-            for (const editor of flp.rta.endpoints) {
-                editor.pluginScript ??= 'open/ux/preview/client/adp/init';
-            }
-        }
-        const descriptor = adp.descriptor;
-        const { name, manifest } = descriptor;
-        await flp.init(manifest, name, adp.resources, adp);
-        flp.router.use(adp.descriptor.url, adp.proxy.bind(adp));
-        flp.addOnChangeRequestHandler(adp.onChangeRequest.bind(adp));
-        flp.router.use((0, express_1.json)());
-        adp.addApis(flp.router);
-    }
-    else {
-        throw new Error('ADP configured but no manifest.appdescr_variant found.');
+function configureRta(rta, layer, variantId, isCloud) {
+    if (!rta) {
+        return;
+    }
+    rta.layer = layer;
+    rta.options = {
+        ...rta.options,
+        projectId: variantId,
+        scenario: 'ADAPTATION_PROJECT',
+        isCloud
+    };
+    for (const editor of rta.endpoints) {
+        editor.pluginScript ??= 'open/ux/preview/client/adp/init';
     }
 }
 //# sourceMappingURL=flp.js.map

package/dist/base/index.d.ts

@@ -1,4 +1,4 @@
-export { FlpSandbox, initAdp } from './flp';
+export { FlpSandbox } from './flp';
 export { generatePreviewFiles, getPreviewPaths, sanitizeRtaConfig } from './config';
 export { logRemoteUrl, isRemoteConnectionsEnabled } from './remote-url';
 //# sourceMappingURL=index.d.ts.map

package/dist/base/index.js

@@ -1,9 +1,8 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.isRemoteConnectionsEnabled = exports.logRemoteUrl = exports.sanitizeRtaConfig = exports.getPreviewPaths = exports.generatePreviewFiles = exports.initAdp = exports.FlpSandbox = void 0;
+exports.isRemoteConnectionsEnabled = exports.logRemoteUrl = exports.sanitizeRtaConfig = exports.getPreviewPaths = exports.generatePreviewFiles = exports.FlpSandbox = void 0;
 var flp_1 = require("./flp");
 Object.defineProperty(exports, "FlpSandbox", { enumerable: true, get: function () { return flp_1.FlpSandbox; } });
-Object.defineProperty(exports, "initAdp", { enumerable: true, get: function () { return flp_1.initAdp; } });
 var config_1 = require("./config");
 Object.defineProperty(exports, "generatePreviewFiles", { enumerable: true, get: function () { return config_1.generatePreviewFiles; } });
 Object.defineProperty(exports, "getPreviewPaths", { enumerable: true, get: function () { return config_1.getPreviewPaths; } });

package/dist/index.d.ts

@@ -1,4 +1,4 @@
 export * from './ui5/middleware';
-export { FlpSandbox, initAdp, generatePreviewFiles, getPreviewPaths, sanitizeRtaConfig, logRemoteUrl, isRemoteConnectionsEnabled } from './base';
+export { FlpSandbox, generatePreviewFiles, getPreviewPaths, sanitizeRtaConfig, logRemoteUrl, isRemoteConnectionsEnabled } from './base';
 export { FlpConfig, RtaConfig, TestConfig, MiddlewareConfig, DefaultFlpPath, DefaultIntent, TestConfigDefaults } from './types';
 //# sourceMappingURL=index.d.ts.map

package/dist/index.js

@@ -14,11 +14,10 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.isRemoteConnectionsEnabled = exports.logRemoteUrl = exports.sanitizeRtaConfig = exports.getPreviewPaths = exports.generatePreviewFiles = exports.initAdp = exports.FlpSandbox = void 0;
+exports.isRemoteConnectionsEnabled = exports.logRemoteUrl = exports.sanitizeRtaConfig = exports.getPreviewPaths = exports.generatePreviewFiles = exports.FlpSandbox = void 0;
 __exportStar(require("./ui5/middleware"), exports);
 var base_1 = require("./base");
 Object.defineProperty(exports, "FlpSandbox", { enumerable: true, get: function () { return base_1.FlpSandbox; } });
-Object.defineProperty(exports, "initAdp", { enumerable: true, get: function () { return base_1.initAdp; } });
 Object.defineProperty(exports, "generatePreviewFiles", { enumerable: true, get: function () { return base_1.generatePreviewFiles; } });
 Object.defineProperty(exports, "getPreviewPaths", { enumerable: true, get: function () { return base_1.getPreviewPaths; } });
 Object.defineProperty(exports, "sanitizeRtaConfig", { enumerable: true, get: function () { return base_1.sanitizeRtaConfig; } });

package/dist/ui5/middleware.js

@@ -22,7 +22,7 @@ async function createRouter({ resources, options, middlewareUtil }, logger) {
     // configure the FLP sandbox based on information from the manifest
     const flp = new flp_1.FlpSandbox(config, resources.rootProject, middlewareUtil, logger);
     if (config.adp) {
-        await (0, flp_1.initAdp)(resources.rootProject, config.adp, flp, middlewareUtil, logger);
+        await flp.initAdp(config.adp);
     }
     else {
         // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment

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.23.63",
+  "version": "0.23.64",
   "license": "Apache-2.0",
   "author": "@SAP/ux-tools-team",
   "main": "dist/index.js",
@@ -27,7 +27,7 @@
     "mem-fs-editor": "9.4.0",
     "qrcode": "1.5.4",
     "@sap/bas-sdk": "3.12.0",
-    "@sap-ux/adp-tooling": "0.18.11",
+    "@sap-ux/adp-tooling": "0.18.12",
     "@sap-ux/btp-utils": "1.1.5",
     "@sap-ux/control-property-editor-sources": "npm:@sap-ux/control-property-editor@0.7.2",
     "@sap-ux/feature-toggle": "0.3.4",