@sap-ux/fiori-freestyle-writer 2.2.8 → 2.3.1

package/dist/defaults.d.ts

@@ -1,4 +1,10 @@
 import type { FreestyleApp } from './types';
+/**
+ * Sets defaults for relevant parameters (`flpAppId`, `startFile`, `localStartFile`,  ) when virtual endpoints are used.
+ *
+ * @param ffApp - Fiori freestyle application config
+ */
+export declare function setVirtualEndpointDefaults(ffApp: FreestyleApp<unknown>): void;
 /**
  * Set defaults for missing parameters on the given instance of the overall config.
  * Adds source template info.

package/dist/defaults.js

@@ -4,10 +4,13 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.escapeFLPText = void 0;
+exports.setVirtualEndpointDefaults = setVirtualEndpointDefaults;
 exports.setDefaults = setDefaults;
 const read_pkg_up_1 = __importDefault(require("read-pkg-up"));
 const types_1 = require("./types");
 const utils_1 = require("./utils");
+const defaultVirtualPreviewFile = 'test/flp.html'; // Default virtual preview file name
+const defaultIntent = 'app-preview';
 /**
  * Set defaults for missing parameters on the given Fiori/UI5 app instance.
  *
@@ -25,6 +28,16 @@ function setAppDefaults(app) {
 function setBasicTemplateDefaults(settings) {
     settings.viewName = settings.viewName || 'View1';
 }
+/**
+ * Sets defaults for relevant parameters (`flpAppId`, `startFile`, `localStartFile`,  ) when virtual endpoints are used.
+ *
+ * @param ffApp - Fiori freestyle application config
+ */
+function setVirtualEndpointDefaults(ffApp) {
+    ffApp.app.flpAppId = defaultIntent;
+    ffApp.app.localStartFile = defaultVirtualPreviewFile;
+    ffApp.app.startFile = defaultVirtualPreviewFile;
+}
 /**
  * Set defaults for missing parameters on the given instance of the overall config.
  * Adds source template info.

package/dist/index.d.ts

@@ -1,6 +1,6 @@
-import type { Editor } from 'mem-fs-editor';
 import { FreestyleApp } from './types';
 import type { Logger } from '@sap-ux/logger';
+import type { Editor } from 'mem-fs-editor';
 /**
  * Generate a UI5 application based on the specified Fiori Freestyle floorplan template.
  *

package/dist/index.js

@@ -39,7 +39,11 @@ async function generate(basePath, data, fs, log) {
     fs = await (0, ui5_application_writer_1.generate)(basePath, ffApp, fs);
     // add new and overwrite files from templates e.g.
     const tmplPath = (0, path_1.join)(__dirname, '..', 'templates');
-    const ignore = [isTypeScriptEnabled ? '**/*.js' : '**/*.ts'];
+    const ignore = [
+        isTypeScriptEnabled ? '**/*.js' : '**/*.ts',
+        // if using virtual endpoints for preview, do not add the flpSandbox.html file
+        ...(ffApp.appOptions?.useVirtualPreviewEndpoints ? ['**/webapp/test/flpSandbox.html'] : [])
+    ];
     // Determine if the project type is 'EDMXBackend'.
     const isEdmxProjectType = ffApp.app.projectType === 'EDMXBackend';
     // Get the resource URLs for the UShell bootstrap and UI bootstrap based on the project type and UI5 framework details
@@ -85,6 +89,9 @@ async function generate(basePath, data, fs, log) {
     fs.extendJSON(packagePath, JSON.parse((0, ejs_1.render)(fs.read((0, path_1.join)(tmplPath, 'common', 'extend', 'package.json')), ffApp, {})));
     const addTests = ffApp.appOptions?.addTests;
     const packageJson = JSON.parse(fs.read(packagePath));
+    if (ffApp.appOptions?.useVirtualPreviewEndpoints) {
+        (0, defaults_1.setVirtualEndpointDefaults)(ffApp);
+    }
     if (isEdmxProjectType) {
         const addMock = !!ffApp.service?.metadata;
         // Add scripts for non-CAP applications
@@ -95,10 +102,11 @@ async function generate(basePath, data, fs, log) {
                 addMock,
                 sapClient: ffApp.service?.client,
                 flpAppId: ffApp.app.flpAppId,
-                startFile: data?.app?.startFile,
-                localStartFile: data?.app?.localStartFile,
+                startFile: ffApp.app?.startFile,
+                localStartFile: ffApp.app?.localStartFile,
                 generateIndex: ffApp.appOptions?.generateIndex,
-                addTest: addTests && ffApp.template.type === types_1.TemplateType.Basic
+                addTest: addTests && ffApp.template.type === types_1.TemplateType.Basic,
+                supportVirtualEndpoints: ffApp.appOptions?.useVirtualPreviewEndpoints // no need for search params if virtual endpoints are used
             })
         };
         if (addTests) {

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@sap-ux/fiori-freestyle-writer",
   "description": "SAP Fiori freestyle application writer",
-  "version": "2.2.8",
+  "version": "2.3.1",
   "repository": {
     "type": "git",
     "url": "https://github.com/SAP/open-ux-tools.git",
@@ -27,12 +27,12 @@
     "mem-fs-editor": "9.4.0",
     "read-pkg-up": "7.0.1",
     "semver": "7.5.4",
-    "@sap-ux/odata-service-writer": "0.26.13",
-    "@sap-ux/ui5-application-writer": "1.3.3",
-    "@sap-ux/ui5-config": "0.26.5",
-    "@sap-ux/fiori-generator-shared": "0.10.2",
-    "@sap-ux/cap-config-writer": "0.9.25",
-    "@sap-ux/ui5-test-writer": "0.6.3",
+    "@sap-ux/odata-service-writer": "0.26.15",
+    "@sap-ux/ui5-application-writer": "1.4.1",
+    "@sap-ux/ui5-config": "0.27.1",
+    "@sap-ux/fiori-generator-shared": "0.11.1",
+    "@sap-ux/cap-config-writer": "0.9.27",
+    "@sap-ux/ui5-test-writer": "0.6.5",
     "@sap-ux/logger": "0.6.0"
   },
   "devDependencies": {