Add external service support to headless generator (#4576)

* wip

* wip

* wip

* Linting auto fix commit

* changeset and clean up

* clean up

* fix tests

* test order

* throw errors on try catches for the file path reads and parsing.

---------

Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>

Author: kjose90

.changeset/headless-value-list-metadata.md

@@ -0,0 +1,9 @@
+---
+"@sap-ux/axios-extension": patch
+"@sap-ux/fiori-generator-shared": patch
+"@sap-ux/fiori-app-sub-generator": patch
+---
+
+fix(axios-extension): export EntitySetData type
+feat(fiori-generator-shared): add ExternalServiceConfig headless type supporting metadata and entityData as inline values or file paths
+feat(fiori-app-sub-generator): resolve external service metadata and entityData file paths in headless generator before passing to writer

packages/axios-extension/src/abap/index.ts

@@ -36,5 +36,6 @@ export {
     CodeListService,
     ValueListService,
     ExternalServiceReference,
-    ExternalService
+    ExternalService,
+    EntitySetData
 } from './types';

packages/fiori-app-sub-generator/src/app-headless/index.ts

@@ -4,6 +4,7 @@ import type { FioriAppGeneratorOptions } from '../fiori-app-generator';
 import { APP_GENERATOR_MODULE, FioriAppGenerator } from '../fiori-app-generator';
 import { initI18nFioriAppSubGenerator, t } from '../utils/i18n';
 import { transformExtState } from './transforms';
+import { resolveExternalServices } from './resolve';
 
 /**
  * Generator that allows the creation of a Fiori applications without prompting based on a provided app config.
@@ -24,7 +25,11 @@ export class FioriAppGeneratorHeadless extends FioriAppGenerator {
         );
 
         try {
-            this.state = transformExtState(this.options.appConfig);
+            const appConfig = this.options.appConfig;
+            if (appConfig.service?.externalServices) {
+                appConfig.service.externalServices = resolveExternalServices(appConfig.service.externalServices);
+            }
+            this.state = transformExtState(appConfig);
         } catch (error) {
             this.log(t('logMessages.generatorExiting'));
             this.env.error(error);

packages/fiori-app-sub-generator/src/app-headless/resolve.ts

@@ -0,0 +1,62 @@
+import type { EntitySetData, ExternalService } from '@sap-ux/axios-extension';
+import type { ExternalServiceConfig } from '@sap-ux/fiori-generator-shared';
+import { existsSync, readFileSync } from 'node:fs';
+import { isAbsolute, resolve } from 'node:path';
+
+/**
+ * Returns inline XML, or reads and returns the contents of the file at the given path.
+ *
+ * @param metadata The metadata XML string or the path to the metadata file.
+ */
+export function resolveMetadata(metadata: string): string {
+    if (metadata.trimStart().startsWith('<')) {
+        return metadata;
+    }
+    const filePath = isAbsolute(metadata) ? metadata : resolve(process.cwd(), metadata);
+    if (!existsSync(filePath)) {
+        throw new Error(`Metadata file not found: ${filePath}`);
+    }
+    try {
+        return readFileSync(filePath, 'utf-8');
+    } catch (error) {
+        throw new Error(`Failed to read metadata file: ${filePath}. ${error instanceof Error ? error.message : error}`);
+    }
+}
+
+/**
+ * Returns an inline array, or reads and parses the JSON file at the given path.
+ *
+ * @param entityData The entity data array or the path to the JSON file.
+ */
+export function resolveEntityData(entityData: EntitySetData[] | string): EntitySetData[] {
+    if (Array.isArray(entityData)) {
+        return entityData;
+    }
+    const filePath = isAbsolute(entityData) ? entityData : resolve(process.cwd(), entityData);
+    if (!existsSync(filePath)) {
+        throw new Error(`Entity data file not found: ${filePath}`);
+    }
+    try {
+        return JSON.parse(readFileSync(filePath, 'utf-8'));
+    } catch (error) {
+        throw new Error(
+            `Failed to read or parse entity data file: ${filePath}. ${error instanceof Error ? error.message : error}`
+        );
+    }
+}
+
+/**
+ * Resolves metadata and entityData entries based on their content.
+ *
+ * @param services External service configurations.
+ */
+export function resolveExternalServices(services: ExternalServiceConfig[]): ExternalService[] {
+    return services.map(
+        (entry) =>
+            ({
+                ...entry,
+                metadata: resolveMetadata(entry.metadata),
+                entityData: entry.entityData ? resolveEntityData(entry.entityData) : undefined
+            }) as ExternalService
+    );
+}

packages/fiori-app-sub-generator/src/app-headless/transforms.ts

@@ -145,7 +145,8 @@ function _setServiceDefaults(floorplan: AppConfig['floorplan'], service?: AppCon
         servicePath: service?.servicePath,
         client: service?.client,
         edmx: service?.edmx,
-        version
+        version,
+        valueListMetadata: service?.externalServices
     } as Service;
 
     if (service?.destination) {

packages/fiori-app-sub-generator/test/int/fiori-elements/expected-output/headless/lrop_v4_with_vh/.appGenInfo.json

@@ -0,0 +1,33 @@
+{
+  "generationParameters": {
+    "generationDate": "Fri Apr 17 2026 13:29:25 GMT+0100 (Irish Standard Time)",
+    "generatorPlatform": "Visual Studio Code",
+    "serviceType": "OData URL",
+    "metadataFilename": "",
+    "serviceUrl": "https://sap-ux-mock-services-v4-feop.cfapps.us10.hana.ondemand.com/sap/opu/odata4/dmo/sb_travel_mduu_o4/srvd/dmo/sd_travel_mduu/0001/",
+    "appName": "lrop_v4_with_vh",
+    "appTitle": "Project's \"Title\"",
+    "appDescription": "Test 'Project' \"Description\"",
+    "appNamespace": "testNameSpace",
+    "ui5Theme": "sap_fiori_3",
+    "ui5Version": "1.84.0",
+    "enableEslint": false,
+    "enableTypeScript": false,
+    "showMockDataInfo": true,
+    "generatorVersion": "0.0.0",
+    "template": "List Report Page V4",
+    "generatorName": "SAP Fiori Application Generator",
+    "entityRelatedConfig": [
+      {
+        "type": "Main Entity",
+        "value": "Travel"
+      },
+      {
+        "type": "Navigation Entity",
+        "value": "_Booking"
+      }
+    ],
+    "launchText": "To launch the generated application, run the following from the generated application root folder:\n\n```\n    npm start\n```",
+    "valueHelpDownloaded": true
+  }
+}

packages/fiori-app-sub-generator/test/int/fiori-elements/expected-output/headless/lrop_v4_with_vh/.gitignore

@@ -0,0 +1,10 @@
+node_modules/
+dist/
+.scp/
+.env
+Makefile*.mta
+mta_archives
+mta-*
+resources
+archive.zip
+.*_mta_build_tmp

packages/fiori-app-sub-generator/test/int/fiori-elements/expected-output/headless/lrop_v4_with_vh/README.md

@@ -0,0 +1,44 @@
+## Application Details
+|               |
+| ------------- |
+|**Generation Date and Time**<br>Fri Apr 17 2026 13:29:25 GMT+0100 (Irish Standard Time)|
+|**App Generator**<br>SAP Fiori Application Generator|
+|**App Generator Version**<br>0.0.0|
+|**Generation Platform**<br>Visual Studio Code|
+|**Template Used**<br>List Report Page V4|
+|**Service Type**<br>OData URL|
+|**Service URL**<br>https://sap-ux-mock-services-v4-feop.cfapps.us10.hana.ondemand.com/sap/opu/odata4/dmo/sb_travel_mduu_o4/srvd/dmo/sd_travel_mduu/0001/|
+|**Module Name**<br>lrop_v4_with_vh|
+|**Application Title**<br>Project&#39;s &#34;Title&#34;|
+|**Namespace**<br>testNameSpace|
+|**UI5 Theme**<br>sap_fiori_3|
+|**UI5 Version**<br>1.84.0|
+|**Enable TypeScript**<br>False|
+|**Add Eslint configuration**<br>False|
+|**Value Help Metadata**<br>Downloaded for external services|
+|**Main Entity**<br>Travel|
+|**Navigation Entity**<br>_Booking|
+
+## lrop_v4_with_vh
+
+Test &#39;Project&#39; &#34;Description&#34;
+
+### Starting the generated app
+
+-   This app has been generated using the SAP Fiori tools - App Generator, as part of the SAP Fiori tools suite.  To launch the generated application, run the following from the generated application root folder:
+
+```
+    npm start
+```
+
+- It is also possible to run the application using mock data that reflects the OData Service URL supplied during application generation.  In order to run the application with Mock Data, run the following from the generated app root folder:
+
+```
+    npm run start-mock
+```
+
+#### Pre-requisites:
+
+1. Active NodeJS LTS (Long Term Support) version and associated supported NPM version.  (See https://nodejs.org)
+
+

packages/fiori-app-sub-generator/test/int/fiori-elements/expected-output/headless/lrop_v4_with_vh/package.json

@@ -0,0 +1,30 @@
+{
+  "name": "lrop_v4_with_vh",
+  "version": "0.0.1",
+  "description": "Test 'Project' "Description"",
+  "keywords": [
+    "ui5",
+    "openui5",
+    "sapui5"
+  ],
+  "main": "webapp/index.html",
+  "dependencies": {},
+  "devDependencies": {
+    "@ui5/cli": "^4.0.33",
+    "@sap/ux-ui5-tooling": "1",
+    "@sap-ux/ui5-middleware-fe-mockserver": "2"
+  },
+  "scripts": {
+    "start": "fiori run --open \"/test/flpSandbox.html?sap-ui-xx-viewCache=false#testNameSpacelropv4withvh-tile\"",
+    "start-local": "fiori run --config ./ui5-local.yaml --open \"/test/flpSandbox.html?sap-ui-xx-viewCache=false#testNameSpacelropv4withvh-tile\"",
+    "build": "ui5 build --config=ui5.yaml --clean-dest --dest dist",
+    "start-mock": "fiori run --config ./ui5-mock.yaml --open \"/test/flpSandbox.html?sap-ui-xx-viewCache=false#testNameSpacelropv4withvh-tile\"",
+    "deploy": "fiori verify",
+    "deploy-config": "fiori add deploy-config",
+    "start-noflp": "fiori run --open \"/index.html?sap-ui-xx-viewCache=false\"",
+    "int-test": "fiori run --config ./ui5-mock.yaml --open \"/test/integration/opaTests.qunit.html\"",
+    "start-variants-management": "fiori run --open \"/preview.html?sap-ui-xx-viewCache=false&fiori-tools-rta-mode=true&sap-ui-rta-skip-flex-validation=true#testNameSpacelropv4withvh-tile\""
+  },
+  "sapuxLayer": "CUSTOMER_BASE",
+  "sapux": true
+}

packages/fiori-app-sub-generator/test/int/fiori-elements/expected-output/headless/lrop_v4_with_vh/ui5-local.yaml

@@ -0,0 +1,50 @@
+# yaml-language-server: $schema=https://sap.github.io/ui5-tooling/schema/ui5.yaml.json
+
+specVersion: "4.0"
+metadata:
+  name: testNameSpace.lropv4withvh
+type: application
+framework:
+  name: SAPUI5
+  version: 1.82.2
+  libraries:
+    - name: sap.m
+    - name: sap.ui.core
+    - name: sap.fe.templates
+    - name: sap.ushell
+    - name: themelib_sap_fiori_3
+server:
+  customMiddleware:
+    - name: fiori-tools-appreload
+      afterMiddleware: compression
+      configuration:
+        port: 35729
+        path: webapp
+        delay: 300
+    - name: fiori-tools-preview
+      afterMiddleware: fiori-tools-appreload
+      configuration:
+        flp:
+          theme: sap_fiori_3
+          path: test/flpSandbox.html
+          intent:
+            object: testNameSpacelropv4withvh
+            action: tile
+    - name: fiori-tools-proxy
+      afterMiddleware: compression
+      configuration:
+        ignoreCertErrors: false # If set to true, certificate errors will be ignored. E.g. self-signed certificates will be accepted
+        backend:
+          - path: /sap
+            url: https://sap-ux-mock-services-v4-feop.cfapps.us10.hana.ondemand.com
+    - name: sap-fe-mockserver
+      beforeMiddleware: csp
+      configuration:
+        mountPath: /
+        services:
+          - urlPath: /sap/opu/odata4/dmo/sb_travel_mduu_o4/srvd/dmo/sd_travel_mduu/0001
+            metadataPath: ./webapp/localService/mainService/metadata.xml
+            mockdataPath: ./webapp/localService/mainService/data
+            generateMockData: true
+            resolveExternalServiceReferences: true
+        annotations: []