@sap-ux/ui5-application-writer 1.3.3 → 1.4.1

package/dist/index.d.ts

@@ -1,7 +1,7 @@
-import type { Editor } from 'mem-fs-editor';
-import type { App, AppOptions, UI5 } from './types';
 import { type Package } from '@sap-ux/project-access';
 import { Ui5App } from './types';
+import type { Editor } from 'mem-fs-editor';
+import type { App, AppOptions, UI5 } from './types';
 /**
  * Writes the template to the memfs editor instance.
  *

package/dist/index.js

@@ -57,8 +57,9 @@ async function generate(basePath, ui5AppConfig, fs) {
     });
     ui5Config.addFioriToolsAppReloadMiddleware();
     if (isEdmxProjectType) {
+        const previewMiddleWareOpts = getPreviewMiddlewareOpts(ui5App.app, ui5App.ui5?.ui5Theme, ui5AppConfig.appOptions?.useVirtualPreviewEndpoints);
         // add preview middleware to ui5Config
-        ui5Config.addFioriToolsPreviewMiddleware(ui5App.app.id, ui5App.ui5?.ui5Theme);
+        ui5Config.addFioriToolsPreviewMiddleware(previewMiddleWareOpts);
         const ui5LocalConfigPath = (0, path_1.join)(basePath, 'ui5-local.yaml');
         // write ui5-local.yaml only for non-CAP applications
         const ui5LocalConfig = await ui5_config_1.UI5Config.newInstance(fs.read(ui5LocalConfigPath));
@@ -67,7 +68,7 @@ async function generate(basePath, ui5AppConfig, fs) {
         // Add optional features
         await (0, options_1.applyOptionalFeatures)(ui5App, fs, basePath, tmplPath, [ui5Config, ui5LocalConfig]);
         // add preview middleware to ui5LocalConfig
-        ui5LocalConfig.addFioriToolsPreviewMiddleware(ui5App.app.id, ui5App.ui5?.ui5Theme);
+        ui5LocalConfig.addFioriToolsPreviewMiddleware(previewMiddleWareOpts);
         // write ui5 local yaml
         fs.write(ui5LocalConfigPath, ui5LocalConfig.toString());
     }
@@ -79,6 +80,27 @@ async function generate(basePath, ui5AppConfig, fs) {
     fs.write(ui5ConfigPath, ui5Config.toString());
     return fs;
 }
+/**
+ * Get the preview middleware options.
+ *
+ * @param app - the app config
+ * @param ui5Theme - the UI5 theme
+ * @param useVirtualPreviewEndpoints - boolean to determine if virtual endpoints are used
+ * @returns preview middleware options
+ */
+function getPreviewMiddlewareOpts(app, ui5Theme, useVirtualPreviewEndpoints = false) {
+    return {
+        ui5Theme,
+        ...(useVirtualPreviewEndpoints && {
+            localStartFile: app.localStartFile
+        }),
+        // only add flp intent if not using virtual endpoints (default `app-preview` will be used by middleware)
+        ...(!useVirtualPreviewEndpoints && {
+            flpAction: app.flpAction,
+            appId: app.id
+        })
+    };
+}
 /**
  * Check if Typescript is enabled for the given path.
  *

package/dist/types.d.ts

@@ -19,6 +19,7 @@ export interface App {
     baseComponent?: string;
     startFile?: string;
     localStartFile?: string;
+    flpAction?: string;
     /**
      * Defines the template used by the generation tool
      */
@@ -150,6 +151,12 @@ export interface AppOptions {
      * Excludes the index.html from the template and does not add the `start-noflp` script in package.json
      */
     generateIndex?: boolean;
+    /**
+     * Enables the use of virtually serving the endpoints for preview.
+     * Prevents generating `flpSandbox.html`, and if applicable the `changes_loader.js`, `changes_preview.js` & `locate-reuse-libs.js`.
+     * Also updates the configs (e.g. ui5.yaml) and package.json scripts accordingly.
+     */
+    useVirtualPreviewEndpoints?: boolean;
 }
 export interface Ui5App {
     app: App;

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%3Aui5-application-writer"
   },
-  "version": "1.3.3",
+  "version": "1.4.1",
   "license": "Apache-2.0",
   "main": "dist/index.js",
   "files": [
@@ -27,7 +27,7 @@
     "mem-fs": "2.1.0",
     "mem-fs-editor": "9.4.0",
     "semver": "7.5.4",
-    "@sap-ux/ui5-config": "0.26.5"
+    "@sap-ux/ui5-config": "0.27.1"
   },
   "devDependencies": {
     "@types/ejs": "3.1.2",
@@ -38,7 +38,7 @@
     "@types/semver": "7.5.2",
     "fs-extra": "10.0.0",
     "@sap-ux/eslint-plugin-fiori-tools": "0.5.0",
-    "@sap-ux/project-access": "1.29.17"
+    "@sap-ux/project-access": "1.29.20"
   },
   "engines": {
     "node": ">=18.x"