@sap-ux/app-config-writer 0.7.2 → 0.7.4

package/dist/flp-embedded-config/index.d.ts

@@ -0,0 +1,18 @@
+import type { Editor } from 'mem-fs-editor';
+import type { ToolsLogger } from '@sap-ux/logger';
+export declare const DEFAULT_FLP_PATH = "sap/bc/ui5_ui5/ui2/ushell/shells/abap/Fiorilaunchpad.html";
+/**
+ * Generates the FLP Embedded Mode configuration for a Fiori app:
+ * - adds the `start-embedded` npm script to package.json
+ * - creates flp.yaml based on the existing ui5.yaml
+ *
+ * @param basePath - root of the project (where package.json is)
+ * @param bspApplication - BSP application name of the deployed app
+ * @param flpPath - FLP URL path (defaults to the standard ABAP FLP path)
+ * @param yamlPath - path to the ui5.yaml to use as base (defaults to ui5.yaml in basePath)
+ * @param fs - optional mem-fs editor instance
+ * @param logger - optional logger
+ * @returns mem-fs editor instance with modified/created files
+ */
+export declare function generateFlpEmbeddedConfig(basePath: string, bspApplication: string, flpPath?: string, yamlPath?: string, fs?: Editor, logger?: ToolsLogger): Promise<Editor>;
+//# sourceMappingURL=index.d.ts.map

package/dist/flp-embedded-config/index.js

@@ -0,0 +1,110 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DEFAULT_FLP_PATH = void 0;
+exports.generateFlpEmbeddedConfig = generateFlpEmbeddedConfig;
+const node_path_1 = require("node:path");
+const mem_fs_editor_1 = require("mem-fs-editor");
+const mem_fs_1 = require("mem-fs");
+const project_access_1 = require("@sap-ux/project-access");
+exports.DEFAULT_FLP_PATH = 'sap/bc/ui5_ui5/ui2/ushell/shells/abap/Fiorilaunchpad.html';
+/**
+ * Generates the FLP Embedded Mode configuration for a Fiori app:
+ * - adds the `start-embedded` npm script to package.json
+ * - creates flp.yaml based on the existing ui5.yaml
+ *
+ * @param basePath - root of the project (where package.json is)
+ * @param bspApplication - BSP application name of the deployed app
+ * @param flpPath - FLP URL path (defaults to the standard ABAP FLP path)
+ * @param yamlPath - path to the ui5.yaml to use as base (defaults to ui5.yaml in basePath)
+ * @param fs - optional mem-fs editor instance
+ * @param logger - optional logger
+ * @returns mem-fs editor instance with modified/created files
+ */
+async function generateFlpEmbeddedConfig(basePath, bspApplication, flpPath = exports.DEFAULT_FLP_PATH, yamlPath = project_access_1.FileName.Ui5Yaml, fs = (0, mem_fs_editor_1.create)((0, mem_fs_1.create)()), logger) {
+    const bspApp = bspApplication.trim().toLowerCase();
+    if (!bspApp) {
+        throw new Error('Mandatory parameter bspApplication is missing.');
+    }
+    if (await (0, project_access_1.isCapProject)(basePath)) {
+        throw new Error('CAP projects are not supported for FLP Embedded Mode configuration.');
+    }
+    const resolvedYamlPath = (0, node_path_1.join)(basePath, yamlPath);
+    if (!fs.exists(resolvedYamlPath)) {
+        throw new Error(`Configuration file ${resolvedYamlPath} not found. Please provide a valid path`);
+    }
+    addStartEmbeddedScript(fs, basePath, flpPath, logger);
+    await addFlpYaml(fs, basePath, yamlPath, bspApp, logger);
+    return fs;
+}
+/**
+ * Adds the start-embedded npm script to package.json.
+ * Prepends `ui5 build` so dist/ is always built before fiori run starts,
+ * avoiding issues where --clean-dest in the build script deletes dist/ and
+ * kills the file watcher mid-rebuild.
+ *
+ * @param fs - mem-fs editor instance
+ * @param basePath - project root
+ * @param flpPath - FLP URL path
+ * @param logger - optional logger
+ */
+function addStartEmbeddedScript(fs, basePath, flpPath, logger) {
+    const packageJsonPath = (0, node_path_1.join)(basePath, project_access_1.FileName.Package);
+    const packageJson = fs.readJSON(packageJsonPath);
+    if (!packageJson) {
+        throw new Error(`File 'package.json' not found at ${basePath}`);
+    }
+    packageJson.scripts ??= {};
+    packageJson.scripts['start-embedded'] =
+        `ui5 build && fiori run --config ./flp.yaml --open "${flpPath}?sap-ushell-nocb=true"`;
+    fs.writeJSON(packageJsonPath, packageJson);
+    logger?.debug(`Script 'start-embedded' written to 'package.json'.`);
+}
+/**
+ * Creates flp.yaml based on the existing ui5.yaml, adding servestatic middleware
+ * and configuring appreload and proxy middlewares.
+ *
+ * @param fs - mem-fs editor instance
+ * @param basePath - project root
+ * @param yamlFileName - relative path to the source ui5.yaml (e.g. 'ui5.yaml')
+ * @param bspApplication - BSP application name (lowercase)
+ * @param logger - optional logger
+ */
+async function addFlpYaml(fs, basePath, yamlFileName, bspApplication, logger) {
+    const flpYamlPath = (0, node_path_1.join)(basePath, 'flp.yaml');
+    const ui5Config = await (0, project_access_1.readUi5Yaml)(basePath, yamlFileName, fs);
+    const metadata = ui5Config.getMetadata();
+    if (!metadata?.name) {
+        throw new Error(`The configuration file '${yamlFileName}' is missing a 'metadata.name' field.`);
+    }
+    const appModule = metadata.name.replaceAll('.', '/');
+    const DIST = 'dist';
+    const paths = [{ path: '/**/' + bspApplication, src: DIST }];
+    if (appModule !== bspApplication) {
+        paths.push({ path: '/**/' + appModule, src: DIST });
+    }
+    ui5Config.setConfiguration({ paths: { webapp: DIST } });
+    const appreloadMiddleware = ui5Config.findCustomMiddleware('fiori-tools-appreload');
+    if (appreloadMiddleware) {
+        ui5Config.updateCustomMiddleware({
+            ...appreloadMiddleware,
+            configuration: { ...appreloadMiddleware.configuration, path: DIST }
+        });
+    }
+    const proxyMiddleware = ui5Config.findCustomMiddleware('fiori-tools-proxy');
+    if (proxyMiddleware) {
+        ui5Config.updateCustomMiddleware({
+            ...proxyMiddleware,
+            configuration: { ...proxyMiddleware.configuration, bsp: bspApplication }
+        });
+    }
+    ui5Config.addCustomMiddleware([
+        {
+            name: 'fiori-tools-servestatic',
+            beforeMiddleware: 'fiori-tools-proxy',
+            configuration: { paths }
+        }
+    ]);
+    fs.write(flpYamlPath, ui5Config.toString());
+    logger?.debug(`'flp.yaml' written.`);
+}
+//# sourceMappingURL=index.js.map

package/dist/index.d.ts

@@ -5,4 +5,5 @@ export { generateInboundNavigationConfig, readManifest } from './navigation-conf
 export { generateVariantsConfig } from './variants-config';
 export { convertToVirtualPreview } from './preview-config';
 export { enableCardGeneratorConfig } from './cards-config';
+export { generateFlpEmbeddedConfig, DEFAULT_FLP_PATH } from './flp-embedded-config';
 //# sourceMappingURL=index.d.ts.map

package/dist/index.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.enableCardGeneratorConfig = exports.convertToVirtualPreview = exports.generateVariantsConfig = exports.readManifest = exports.generateInboundNavigationConfig = exports.convertEslintConfig = exports.generateEslintConfig = exports.generateSmartLinksConfig = exports.includeTestRunnersPrompt = exports.simulatePrompt = exports.getSmartLinksTargetFromPrompt = void 0;
+exports.DEFAULT_FLP_PATH = exports.generateFlpEmbeddedConfig = exports.enableCardGeneratorConfig = exports.convertToVirtualPreview = exports.generateVariantsConfig = exports.readManifest = exports.generateInboundNavigationConfig = exports.convertEslintConfig = exports.generateEslintConfig = exports.generateSmartLinksConfig = exports.includeTestRunnersPrompt = exports.simulatePrompt = exports.getSmartLinksTargetFromPrompt = void 0;
 var prompt_1 = require("./prompt");
 Object.defineProperty(exports, "getSmartLinksTargetFromPrompt", { enumerable: true, get: function () { return prompt_1.getSmartLinksTargetFromPrompt; } });
 Object.defineProperty(exports, "simulatePrompt", { enumerable: true, get: function () { return prompt_1.simulatePrompt; } });
@@ -19,4 +19,7 @@ var preview_config_1 = require("./preview-config");
 Object.defineProperty(exports, "convertToVirtualPreview", { enumerable: true, get: function () { return preview_config_1.convertToVirtualPreview; } });
 var cards_config_1 = require("./cards-config");
 Object.defineProperty(exports, "enableCardGeneratorConfig", { enumerable: true, get: function () { return cards_config_1.enableCardGeneratorConfig; } });
+var flp_embedded_config_1 = require("./flp-embedded-config");
+Object.defineProperty(exports, "generateFlpEmbeddedConfig", { enumerable: true, get: function () { return flp_embedded_config_1.generateFlpEmbeddedConfig; } });
+Object.defineProperty(exports, "DEFAULT_FLP_PATH", { enumerable: true, get: function () { return flp_embedded_config_1.DEFAULT_FLP_PATH; } });
 //# sourceMappingURL=index.js.map

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@sap-ux/app-config-writer",
   "description": "Add or update configuration for SAP Fiori tools application",
-  "version": "0.7.2",
+  "version": "0.7.4",
   "repository": {
     "type": "git",
     "url": "https://github.com/SAP/open-ux-tools.git",
@@ -28,13 +28,13 @@
     "prompts": "2.4.2",
     "semver": "7.7.4",
     "cross-spawn": "7.0.6",
-    "@sap-ux/axios-extension": "1.26.0",
-    "@sap-ux/ui5-application-writer": "1.9.0",
-    "@sap-ux/btp-utils": "1.2.0",
+    "@sap-ux/axios-extension": "1.26.1",
+    "@sap-ux/ui5-application-writer": "1.9.1",
+    "@sap-ux/btp-utils": "1.2.1",
     "@sap-ux/logger": "0.9.0",
-    "@sap-ux/project-access": "1.38.0",
+    "@sap-ux/project-access": "1.38.1",
     "@sap-ux/store": "1.6.0",
-    "@sap-ux/ui5-config": "0.31.0"
+    "@sap-ux/ui5-config": "0.31.1"
   },
   "devDependencies": {
     "@types/ejs": "3.1.5",
@@ -45,7 +45,7 @@
     "@types/cross-spawn": "6.0.6",
     "axios": "1.16.0",
     "nock": "14.0.11",
-    "@sap-ux/preview-middleware": "0.26.4"
+    "@sap-ux/preview-middleware": "0.26.8"
   },
   "engines": {
     "node": ">=22.x"