@sap-ux/preview-middleware 0.3.9 → 0.4.1

package/dist/base/flp.d.ts

@@ -1,8 +1,15 @@
 import type { ReaderCollection } from '@ui5/fs';
+import type { Router } from 'express';
 import type { App, FlpConfig } from '../types';
 import type { Logger } from '@sap-ux/logger';
 import type { MiddlewareUtils } from '@ui5/server';
 import type { Manifest, UI5FlexLayer } from '@sap-ux/project-access';
+/**
+ * Enhanced request handler that exposes a list of endpoints for the cds-plugin-ui5.
+ */
+export type EnhancedRouter = Router & {
+    getAppPages?: () => string[];
+};
 /**
  * Internal structure used to fill the sandbox.html template
  */
@@ -40,7 +47,7 @@ export declare class FlpSandbox {
     private readonly logger;
     protected templateConfig: TemplateConfig;
     readonly config: FlpConfig;
-    readonly router: any;
+    readonly router: EnhancedRouter;
     /**
      * Constructor setting defaults and keeping reference to workspace resources.
      *

package/dist/base/flp.js

@@ -106,7 +106,7 @@ class FlpSandbox {
      */
     addStandardRoutes() {
         // add route for the sandbox.html
-        this.router.get(this.config.path, (req, res) => {
+        this.router.get(this.config.path, ((req, res) => __awaiter(this, void 0, void 0, function* () {
             var _a, _b;
             const config = Object.assign({}, this.templateConfig);
             const fioriToolsRtaMode = req.query['fiori-tools-rta-mode'];
@@ -121,6 +121,11 @@ class FlpSandbox {
                     this.logger.error('Fiori tools RTA mode could not be started because the RTA layer is missing.');
                 }
             }
+            // warn the user if a file with the same name exists in the filesystem
+            const file = yield this.project.byPath(this.config.path);
+            if (file) {
+                this.logger.warn(`HTML file returned at ${this.config.path} is NOT loaded from the file system.`);
+            }
             const template = (0, fs_1.readFileSync)((0, path_1.join)(__dirname, '../../templates/flp/sandbox.html'), 'utf-8');
             const html = (0, ejs_1.render)(template, config);
             // if livereload is enabled, don't send it but let other middleware modify the content
@@ -131,7 +136,7 @@ class FlpSandbox {
             else {
                 res.status(200).contentType('html').send(html);
             }
-        });
+        })));
         // add route for locate-reuse-libs if requested
         if (this.config.libs && this.templateConfig.locateReuseLibsScript) {
             const pathParts = this.config.path.split('/');
@@ -186,12 +191,12 @@ class FlpSandbox {
         });
         const api = '/preview/api/changes';
         this.router.use(api, (0, express_1.json)());
-        this.router.get(api, (_req, res) => __awaiter(this, void 0, void 0, function* () {
+        this.router.get(api, ((_req, res) => __awaiter(this, void 0, void 0, function* () {
             res.status(200)
                 .contentType('application/json')
                 .send(yield (0, flex_1.readChanges)(this.project, this.logger));
-        }));
-        this.router.post(api, (req, res) => __awaiter(this, void 0, void 0, function* () {
+        })));
+        this.router.post(api, ((req, res) => __awaiter(this, void 0, void 0, function* () {
             try {
                 const { success, message } = (0, flex_1.writeChange)(req.body, this.utils.getProject().getSourcePath(), this.logger);
                 if (success) {
@@ -204,8 +209,8 @@ class FlpSandbox {
             catch (error) {
                 res.status(500).send(error.message);
             }
-        }));
-        this.router.delete(api, (req, res) => __awaiter(this, void 0, void 0, function* () {
+        })));
+        this.router.delete(api, ((req, res) => __awaiter(this, void 0, void 0, function* () {
             try {
                 const { success, message } = (0, flex_1.deleteChange)(req.body, this.utils.getProject().getSourcePath(), this.logger);
                 if (success) {
@@ -218,7 +223,7 @@ class FlpSandbox {
             catch (error) {
                 res.status(500).send(error.message);
             }
-        }));
+        })));
         return [
             {
                 applyConnector: workspaceConnectorPath,

package/dist/types/index.d.ts

@@ -24,7 +24,7 @@ export interface App {
  */
 export interface FlpConfig {
     path: string;
-    intent?: Intent;
+    intent: Intent;
     rta?: {
         layer?: UI5FlexLayer;
     };

package/dist/ui5/middleware.js

@@ -22,10 +22,10 @@ const adp_tooling_1 = require("@sap-ux/adp-tooling");
  */
 function initAdp(rootProject, config, flp, logger) {
     return __awaiter(this, void 0, void 0, function* () {
-        const files = yield rootProject.byGlob('/manifest.appdescr_variant');
-        if (files.length === 1) {
+        const appVariant = yield rootProject.byPath('/manifest.appdescr_variant');
+        if (appVariant) {
             const adp = new adp_tooling_1.AdpPreview(config, rootProject, logger);
-            const layer = yield adp.init(JSON.parse(yield files[0].getString()));
+            const layer = yield adp.init(JSON.parse(yield appVariant.getString()));
             flp.config.rta = { layer };
             yield flp.init(adp.descriptor.manifest, adp.descriptor.name, adp.resources);
             flp.router.use(adp.descriptor.url, adp.proxy.bind(adp));
@@ -57,14 +57,16 @@ function createRouter({ resources, options, middlewareUtil }, logger) {
             yield initAdp(resources.rootProject, config.adp, flp, logger);
         }
         else {
-            const files = yield resources.rootProject.byGlob('/manifest.json');
-            if (files.length === 1) {
-                yield flp.init(JSON.parse(yield files[0].getString()));
+            const manifest = yield resources.rootProject.byPath('/manifest.json');
+            if (manifest) {
+                yield flp.init(JSON.parse(yield manifest.getString()));
             }
             else {
                 throw new Error('No manifest.json found.');
             }
         }
+        // add exposed endpoints for cds-plugin-ui5
+        flp.router.getAppPages = () => [`${flp.config.path}#${flp.config.intent.object}-${flp.config.intent.action}`];
         return flp.router;
     });
 }

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.3.9",
+  "version": "0.4.1",
   "license": "Apache-2.0",
   "author": "@SAP/ux-tools-team",
   "main": "dist/index.js",
@@ -34,7 +34,7 @@
     "express": "4.18.2",
     "nock": "13.2.1",
     "supertest": "6.3.2",
-    "@sap-ux/project-access": "1.13.0",
+    "@sap-ux/project-access": "1.13.1",
     "@sap-ux/store": "0.3.12"
   },
   "peerDependencies": {