@sap-ux/preview-middleware 0.16.110 → 0.16.112

package/dist/base/config.d.ts

@@ -98,9 +98,16 @@ export declare function sanitizeConfig(config: MiddlewareConfig, logger: ToolsLo
  * @param manifest manifest of the additional target app
  * @param app configuration for the preview
  * @param logger logger instance
- * @param descriptor descriptor of the additional target app
  */
-export declare function addApp(templateConfig: TemplateConfig, manifest: Partial<Manifest>, app: App, logger: Logger, descriptor?: MergedAppDescriptor): Promise<void>;
+export declare function addApp(templateConfig: TemplateConfig, manifest: Partial<Manifest>, app: App, logger: Logger): Promise<void>;
+/**
+ * Get the application name based on the manifest and app configuration.
+ *
+ * @param manifest - The application manifest.
+ * @param intent - The app configuration.
+ * @returns The application name.
+ */
+export declare function getAppName(manifest: Partial<Manifest>, intent?: Intent): string;
 /**
  * Creates the configuration object for the sandbox.html template.
  *

package/dist/base/config.js

@@ -4,6 +4,7 @@ exports.DEFAULT_INTENT = exports.DEFAULT_PATH = exports.DEFAULT_THEME = exports.
 exports.getFlpConfigWithDefaults = getFlpConfigWithDefaults;
 exports.sanitizeConfig = sanitizeConfig;
 exports.addApp = addApp;
+exports.getAppName = getAppName;
 exports.createFlpTemplateConfig = createFlpTemplateConfig;
 exports.createTestTemplateConfig = createTestTemplateConfig;
 exports.getPreviewPaths = getPreviewPaths;
@@ -156,15 +157,10 @@ function getFlexSettings() {
  * @param manifest manifest of the additional target app
  * @param app configuration for the preview
  * @param logger logger instance
- * @param descriptor descriptor of the additional target app
  */
-async function addApp(templateConfig, manifest, app, logger, descriptor) {
+async function addApp(templateConfig, manifest, app, logger) {
     const id = manifest['sap.app']?.id ?? '';
-    app.intent ??= {
-        object: id.replace(/\./g, ''),
-        action: 'preview'
-    };
-    const appName = `${app.intent?.object}-${app.intent?.action}`;
+    const appName = getAppName(manifest, app.intent);
     templateConfig.ui5.resources[id] = app.target;
     templateConfig.apps[appName] = {
         title: (await getI18nTextFromProperty(app.local, manifest['sap.app']?.title, logger)) ?? id,
@@ -173,9 +169,21 @@ async function addApp(templateConfig, manifest, app, logger, descriptor) {
         applicationType: 'URL',
         url: app.target
     };
-    if (descriptor) {
-        templateConfig.apps[appName].applicationDependencies = descriptor;
-    }
+}
+/**
+ * Get the application name based on the manifest and app configuration.
+ *
+ * @param manifest - The application manifest.
+ * @param intent - The app configuration.
+ * @returns The application name.
+ */
+function getAppName(manifest, intent) {
+    const id = manifest['sap.app']?.id ?? '';
+    intent ??= {
+        object: id.replace(/\./g, ''),
+        action: 'preview'
+    };
+    return `${intent?.object}-${intent?.action}`;
 }
 /**
  * Get the i18n text of the given property.

package/dist/base/flp.d.ts

@@ -4,8 +4,7 @@ import type { Router } from 'express';
 import type { Logger, ToolsLogger } from '@sap-ux/logger';
 import type { MiddlewareUtils } from '@ui5/server';
 import type { Manifest } from '@sap-ux/project-access';
-import { type AdpPreviewConfig, type CommonChangeProperties, type OperationType } from '@sap-ux/adp-tooling';
-import type { MergedAppDescriptor } from '@sap-ux/axios-extension';
+import { AdpPreview, type AdpPreviewConfig, type CommonChangeProperties, type OperationType } from '@sap-ux/adp-tooling';
 import type { FlpConfig, MiddlewareConfig, RtaConfig, TestConfig } from '../types';
 import { type TemplateConfig } from './config';
 /**
@@ -22,6 +21,8 @@ export declare class FlpSandbox {
     private readonly project;
     private readonly utils;
     private readonly logger;
+    private adp?;
+    private manifest;
     protected onChangeRequest: OnChangeRequestHandler | undefined;
     protected templateConfig: TemplateConfig;
     readonly config: FlpConfig;
@@ -49,9 +50,9 @@ export declare class FlpSandbox {
      * @param manifest application manifest
      * @param componentId optional componentId e.g. for adaptation projects
      * @param resources optional additional resource mappings
-     * @param descriptor optional additional descriptor mappings
+     * @param adp optional reference to the ADP tooling
      */
-    init(manifest: Manifest, componentId?: string, resources?: Record<string, string>, descriptor?: MergedAppDescriptor): Promise<void>;
+    init(manifest: Manifest, componentId?: string, resources?: Record<string, string>, adp?: AdpPreview): Promise<void>;
     /**
      * Generates the FLP sandbox for an editor.
      *
@@ -60,6 +61,13 @@ export declare class FlpSandbox {
      * @returns FLP sandbox html
      */
     private generateSandboxForEditor;
+    /**
+     * Sets application dependencies in the template configuration.
+     * The descriptor is refreshed if the global flag is set.
+     *
+     * @returns Promise that resolves when the application dependencies are set
+     */
+    private setApplicationDependencies;
     /**
      * Add additional routes for configured editors.
      *

package/dist/base/flp.js

@@ -31,6 +31,8 @@ class FlpSandbox {
     project;
     utils;
     logger;
+    adp;
+    manifest;
     onChangeRequest;
     templateConfig;
     config;
@@ -69,19 +71,21 @@ class FlpSandbox {
      * @param manifest application manifest
      * @param componentId optional componentId e.g. for adaptation projects
      * @param resources optional additional resource mappings
-     * @param descriptor optional additional descriptor mappings
+     * @param adp optional reference to the ADP tooling
      */
-    async init(manifest, componentId, resources = {}, descriptor) {
+    async init(manifest, componentId, resources = {}, adp) {
         this.createFlexHandler();
         this.config.libs ??= await this.hasLocateReuseLibsScript();
-        const id = manifest['sap.app'].id;
+        const id = manifest['sap.app']?.id ?? '';
         this.templateConfig = (0, config_1.createFlpTemplateConfig)(this.config, manifest, resources);
+        this.adp = adp;
+        this.manifest = manifest;
         await (0, config_1.addApp)(this.templateConfig, manifest, {
             componentId,
             target: resources[componentId ?? id] ?? this.templateConfig.basePath,
             local: '.',
             intent: this.config.intent
-        }, this.logger, descriptor);
+        }, this.logger);
         this.addStandardRoutes();
         if (this.rta) {
             this.rta.options ??= {};
@@ -104,10 +108,11 @@ class FlpSandbox {
      * @param editor editor configuration
      * @returns FLP sandbox html
      */
-    generateSandboxForEditor(rta, editor) {
+    async generateSandboxForEditor(rta, editor) {
         const defaultGenerator = editor.developerMode
             ? '@sap-ux/control-property-editor'
             : '@sap-ux/preview-middleware';
+        await this.setApplicationDependencies();
         const config = { ...this.templateConfig };
         /* sap.ui.rta needs to be added to the list of preload libs for variants management and adaptation projects */
         if (!config.ui5.libs.includes('sap.ui.rta')) {
@@ -129,6 +134,19 @@ class FlpSandbox {
         const template = (0, fs_1.readFileSync)((0, path_1.join)(__dirname, '../../templates/flp/sandbox.html'), 'utf-8');
         return (0, ejs_1.render)(template, config);
     }
+    /**
+     * Sets application dependencies in the template configuration.
+     * The descriptor is refreshed if the global flag is set.
+     *
+     * @returns Promise that resolves when the application dependencies are set
+     */
+    async setApplicationDependencies() {
+        if (this.adp) {
+            await this.adp.sync();
+            const appName = (0, config_1.getAppName)(this.manifest, this.config.intent);
+            this.templateConfig.apps[appName].applicationDependencies = this.adp.descriptor;
+        }
+    }
     /**
      * Add additional routes for configured editors.
      *
@@ -170,7 +188,7 @@ class FlpSandbox {
                 }
                 this.router.use(`${path}editor`, (0, express_1.static)(cpe));
             }
-            this.router.get(previewUrl, (req, res) => {
+            this.router.get(previewUrl, async (req, res) => {
                 if (!req.query['fiori-tools-rta-mode']) {
                     // Redirect to the same URL but add the necessary parameter
                     const params = JSON.parse(JSON.stringify(req.query));
@@ -180,7 +198,7 @@ class FlpSandbox {
                     res.redirect(302, `${previewUrl}?${new URLSearchParams(params)}`);
                     return;
                 }
-                const html = this.generateSandboxForEditor(rta, editor).replace('</body>', `</body>\n<!-- livereload disabled for editor </body>-->`);
+                const html = (await this.generateSandboxForEditor(rta, editor)).replace('</body>', `</body>\n<!-- livereload disabled for editor </body>-->`);
                 this.sendResponse(res, 'text/html', 200, html);
             });
         }
@@ -470,7 +488,7 @@ async function initAdp(rootProject, config, flp, util, logger) {
         }
         const descriptor = adp.descriptor;
         const { name, manifest } = descriptor;
-        await flp.init(manifest, name, adp.resources, 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)());

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.16.110",
+  "version": "0.16.112",
   "license": "Apache-2.0",
   "author": "@SAP/ux-tools-team",
   "main": "dist/index.js",
@@ -27,8 +27,8 @@
     "mem-fs-editor": "9.4.0",
     "@sap-ux/logger": "0.6.0",
     "@sap-ux/feature-toggle": "0.2.2",
-    "@sap-ux/btp-utils": "0.15.2",
-    "@sap-ux/adp-tooling": "0.12.73",
+    "@sap-ux/btp-utils": "0.16.0",
+    "@sap-ux/adp-tooling": "0.12.75",
     "@sap-ux/control-property-editor-sources": "npm:@sap-ux/control-property-editor@0.5.24",
     "@sap-ux/project-access": "1.28.6"
   },
@@ -47,7 +47,7 @@
     "@sap-ux-private/playwright": "0.1.0",
     "dotenv": "16.3.1",
     "@private/preview-middleware-client": "npm:@sap-ux-private/preview-middleware-client@0.11.25",
-    "@sap-ux/axios-extension": "1.17.1",
+    "@sap-ux/axios-extension": "1.17.2",
     "@sap-ux/store": "0.9.3",
     "@sap-ux/ui5-info": "0.8.3",
     "@sap-ux/i18n": "0.2.0"