@sap-ux/adp-tooling 0.16.13 → 0.16.14

package/dist/cf/services/api.d.ts

@@ -27,7 +27,7 @@ export declare function getFDCRequestArguments(cfConfig: CfConfig): RequestArgum
  * @param {string[]} appHostIds - The app host ids.
  * @param {CfConfig} cfConfig - The CF config.
  * @param {ToolsLogger} logger - The logger.
- * @returns {Promise<FDCResponse>} The FDC apps.
+ * @returns {Promise<CFApp[]>} The FDC apps.
  */
 export declare function getFDCApps(appHostIds: string[], cfConfig: CfConfig, logger: ToolsLogger): Promise<CFApp[]>;
 /**

package/dist/cf/services/api.js

@@ -119,7 +119,7 @@ function getFDCRequestArguments(cfConfig) {
  * @param {string[]} appHostIds - The app host ids.
  * @param {CfConfig} cfConfig - The CF config.
  * @param {ToolsLogger} logger - The logger.
- * @returns {Promise<FDCResponse>} The FDC apps.
+ * @returns {Promise<CFApp[]>} The FDC apps.
  */
 async function getFDCApps(appHostIds, cfConfig, logger) {
     const requestArguments = getFDCRequestArguments(cfConfig);

package/dist/translations/adp-tooling.i18n.json

@@ -76,7 +76,7 @@
     },
     "error": {
         "appDoesNotSupportFlexibility": "The selected application does not support flexibility because it has `flexEnabled=false`. SAPUI5 Adaptation Project only supports applications that support flexibility. Please select a different application.",
-        "failedToParseXsAppJson": "Failed to parse `xs-app.json`. Error: {{error}}",
+        "failedToParseXsAppJson": "Failed to parse the `xs-app.json` file. Error: {{error}}",
         "failedToParseManifestJson": "Failed to parse the `manifest.json` file. Error: {{error}}",
         "oDataEndpointsValidationFailed": "Validation for the OData endpoints has failed. For more information, check the logs.",
         "adpDoesNotSupportSelectedApp": "Adaptation project doesn't support the selected application. Please select a different application.",

package/dist/writer/cf.js

@@ -36,6 +36,8 @@ async function generateCf(basePath, config, logger, fs) {
     const variant = (0, project_utils_1.getCfVariant)(fullConfig);
     (0, manifest_1.fillDescriptorContent)(variant.content, app.appType, ui5.version, app.i18nModels);
     await (0, project_utils_1.writeCfTemplates)(basePath, variant, fullConfig, fs);
+    await (0, project_utils_1.writeCfUI5Yaml)(fullConfig.project.folder, fullConfig, fs);
+    await (0, project_utils_1.writeCfUI5BuildYaml)(fullConfig.project.folder, fullConfig, fs);
     return fs;
 }
 /**

package/dist/writer/options.d.ts

@@ -1,5 +1,5 @@
 import type { UI5Config } from '@sap-ux/ui5-config';
-import type { AdpWriterConfig, Content, CloudApp, InternalInboundNavigation } from '../types';
+import type { AdpWriterConfig, Content, CloudApp, InternalInboundNavigation, CfAdpWriterConfig } from '../types';
 /**
  * Generate the configuration for the middlewares required for the ui5.yaml.
  *
@@ -61,5 +61,18 @@ export declare function enhanceUI5DeployYaml(ui5Config: UI5Config, config: AdpWr
  * @param manifestChangeContent Application variant change content
  */
 export declare function enhanceManifestChangeContentWithFlpConfig(flpConfiguration: InternalInboundNavigation, appId: string, manifestChangeContent?: Content[]): void;
+/**
+ * Generate custom configuration required for the ui5.yaml.
+ *
+ * @param {UI5Config} ui5Config - Configuration representing the ui5.yaml.
+ * @param {CfAdpWriterConfig} config - Full project configuration.
+ */
+export declare function enhanceUI5YamlWithCfCustomTask(ui5Config: UI5Config, config: CfAdpWriterConfig): void;
+/**
+ * Generate custom configuration required for the ui5.yaml.
+ *
+ * @param {UI5Config} ui5Config - Configuration representing the ui5.yaml.
+ */
+export declare function enhanceUI5YamlWithCfCustomMiddleware(ui5Config: UI5Config): void;
 export {};
 //# sourceMappingURL=options.d.ts.map

package/dist/writer/options.js

@@ -7,6 +7,9 @@ exports.enhanceUI5YamlWithTranspileMiddleware = enhanceUI5YamlWithTranspileMiddl
 exports.hasDeployConfig = hasDeployConfig;
 exports.enhanceUI5DeployYaml = enhanceUI5DeployYaml;
 exports.enhanceManifestChangeContentWithFlpConfig = enhanceManifestChangeContentWithFlpConfig;
+exports.enhanceUI5YamlWithCfCustomTask = enhanceUI5YamlWithCfCustomTask;
+exports.enhanceUI5YamlWithCfCustomMiddleware = enhanceUI5YamlWithCfCustomMiddleware;
+const constants_1 = require("../base/constants");
 const VSCODE_URL = 'https://REQUIRED_FOR_VSCODE.example';
 /**
  * Generate the configuration for the middlewares required for the ui5.yaml.
@@ -289,4 +292,55 @@ function enhanceManifestChangeContentWithFlpConfig(flpConfiguration, appId, mani
         manifestChangeContent.push(removeOtherInboundsChange);
     }
 }
+/**
+ * Generate custom configuration required for the ui5.yaml.
+ *
+ * @param {UI5Config} ui5Config - Configuration representing the ui5.yaml.
+ * @param {CfAdpWriterConfig} config - Full project configuration.
+ */
+function enhanceUI5YamlWithCfCustomTask(ui5Config, config) {
+    const { baseApp, cf, project } = config;
+    ui5Config.addCustomTasks([
+        {
+            name: 'app-variant-bundler-build',
+            beforeTask: 'escapeNonAsciiCharacters',
+            configuration: {
+                module: project.name,
+                appHostId: baseApp.appHostId,
+                appName: baseApp.appName,
+                appVersion: baseApp.appVersion,
+                html5RepoRuntime: cf.html5RepoRuntimeGuid,
+                org: cf.org.GUID,
+                space: cf.space.GUID,
+                sapCloudService: cf.businessSolutionName ?? '',
+                serviceInstanceName: cf.businessService
+            }
+        }
+    ]);
+}
+/**
+ * Generate custom configuration required for the ui5.yaml.
+ *
+ * @param {UI5Config} ui5Config - Configuration representing the ui5.yaml.
+ */
+function enhanceUI5YamlWithCfCustomMiddleware(ui5Config) {
+    const ui5ConfigOptions = {
+        url: constants_1.UI5_CDN_URL
+    };
+    ui5Config.addFioriToolsProxyMiddleware({
+        ui5: ui5ConfigOptions,
+        backend: []
+    }, 'compression');
+    ui5Config.addCustomMiddleware([
+        {
+            name: 'fiori-tools-preview',
+            afterMiddleware: 'fiori-tools-proxy',
+            configuration: {
+                flp: {
+                    theme: 'sap_horizon'
+                }
+            }
+        }
+    ]);
+}
 //# sourceMappingURL=options.js.map

package/dist/writer/project-utils.d.ts

@@ -36,13 +36,6 @@ export declare function getCustomConfig(environment: OperationsType, { name: id,
  * @returns {DescriptorVariant} The variant for the CF project.
  */
 export declare function getCfVariant(config: CfAdpWriterConfig): DescriptorVariant;
-/**
- * Get the ADP config for the CF project.
- *
- * @param {CfAdpWriterConfig} config - The CF configuration.
- * @returns {Record<string, unknown>} The ADP config for the CF project.
- */
-export declare function getCfAdpConfig(config: CfAdpWriterConfig): Record<string, unknown>;
 /**
  * Writes a given project template files within a specified folder in the project directory.
  *
@@ -62,6 +55,24 @@ export declare function writeTemplateToFolder(baseTmplPath: string, projectPath:
  * @returns {void}
  */
 export declare function writeUI5Yaml(projectPath: string, data: AdpWriterConfig, fs: Editor): Promise<void>;
+/**
+ * Writes a ui5.yaml file for CF project within a specified folder in the project directory.
+ *
+ * @param {string} projectPath - The root path of the project.
+ * @param {CfAdpWriterConfig} data - The data to be populated in the template file.
+ * @param {Editor} fs - The `mem-fs-editor` instance used for file operations.
+ * @returns {void}
+ */
+export declare function writeCfUI5Yaml(projectPath: string, data: CfAdpWriterConfig, fs: Editor): Promise<void>;
+/**
+ * Writes a ui5-build.yaml file for CF project within a specified folder in the project directory.
+ *
+ * @param {string} projectPath - The root path of the project.
+ * @param {CfAdpWriterConfig} data - The data to be populated in the template file.
+ * @param {Editor} fs - The `mem-fs-editor` instance used for file operations.
+ * @returns {void}
+ */
+export declare function writeCfUI5BuildYaml(projectPath: string, data: CfAdpWriterConfig, fs: Editor): Promise<void>;
 /**
  * Writes a ui5-deploy.yaml file within a specified folder in the project directory.
  *

package/dist/writer/project-utils.js

@@ -4,15 +4,15 @@ exports.getPackageJSONInfo = getPackageJSONInfo;
 exports.getTypes = getTypes;
 exports.getCustomConfig = getCustomConfig;
 exports.getCfVariant = getCfVariant;
-exports.getCfAdpConfig = getCfAdpConfig;
 exports.writeTemplateToFolder = writeTemplateToFolder;
 exports.writeUI5Yaml = writeUI5Yaml;
+exports.writeCfUI5Yaml = writeCfUI5Yaml;
+exports.writeCfUI5BuildYaml = writeCfUI5BuildYaml;
 exports.writeUI5DeployYaml = writeUI5DeployYaml;
 exports.writeCfTemplates = writeCfTemplates;
 const node_path_1 = require("node:path");
 const node_fs_1 = require("node:fs");
 const uuid_1 = require("uuid");
-const types_1 = require("../types");
 const options_1 = require("./options");
 const ui5_config_1 = require("@sap-ux/ui5-config");
 /**
@@ -109,28 +109,6 @@ function getCfVariant(config) {
     };
     return variant;
 }
-/**
- * Get the ADP config for the CF project.
- *
- * @param {CfAdpWriterConfig} config - The CF configuration.
- * @returns {Record<string, unknown>} The ADP config for the CF project.
- */
-function getCfAdpConfig(config) {
-    const { app, project, ui5, cf } = config;
-    const configJson = {
-        componentname: app.namespace,
-        appvariant: project.name,
-        layer: app.layer,
-        isOVPApp: app.appType === types_1.ApplicationType.FIORI_ELEMENTS_OVP,
-        isFioriElement: app.appType === types_1.ApplicationType.FIORI_ELEMENTS,
-        environment: 'CF',
-        ui5Version: ui5.version,
-        cfApiUrl: cf.url,
-        cfSpace: cf.space.GUID,
-        cfOrganization: cf.org.GUID
-    };
-    return configJson;
-}
 /**
  * Writes a given project template files within a specified folder in the project directory.
  *
@@ -185,6 +163,50 @@ async function writeUI5Yaml(projectPath, data, fs) {
         throw new Error(`Could not write ui5.yaml file. Reason: ${e.message}`);
     }
 }
+/**
+ * Writes a ui5.yaml file for CF project within a specified folder in the project directory.
+ *
+ * @param {string} projectPath - The root path of the project.
+ * @param {CfAdpWriterConfig} data - The data to be populated in the template file.
+ * @param {Editor} fs - The `mem-fs-editor` instance used for file operations.
+ * @returns {void}
+ */
+async function writeCfUI5Yaml(projectPath, data, fs) {
+    try {
+        const ui5ConfigPath = (0, node_path_1.join)(projectPath, 'ui5.yaml');
+        const baseUi5ConfigContent = fs.read(ui5ConfigPath);
+        const ui5Config = await ui5_config_1.UI5Config.newInstance(baseUi5ConfigContent);
+        ui5Config.setConfiguration({ propertiesFileSourceEncoding: 'UTF-8', paths: { webapp: 'dist' } });
+        /** Middlewares */
+        (0, options_1.enhanceUI5YamlWithCfCustomMiddleware)(ui5Config);
+        fs.write(ui5ConfigPath, ui5Config.toString());
+    }
+    catch (e) {
+        throw new Error(`Could not write ui5.yaml file. Reason: ${e.message}`);
+    }
+}
+/**
+ * Writes a ui5-build.yaml file for CF project within a specified folder in the project directory.
+ *
+ * @param {string} projectPath - The root path of the project.
+ * @param {CfAdpWriterConfig} data - The data to be populated in the template file.
+ * @param {Editor} fs - The `mem-fs-editor` instance used for file operations.
+ * @returns {void}
+ */
+async function writeCfUI5BuildYaml(projectPath, data, fs) {
+    try {
+        const ui5ConfigPath = (0, node_path_1.join)(projectPath, 'ui5-build.yaml');
+        const baseUi5ConfigContent = fs.read(ui5ConfigPath);
+        const ui5Config = await ui5_config_1.UI5Config.newInstance(baseUi5ConfigContent);
+        ui5Config.setConfiguration({ propertiesFileSourceEncoding: 'UTF-8' });
+        /** Builder task */
+        (0, options_1.enhanceUI5YamlWithCfCustomTask)(ui5Config, data);
+        fs.write(ui5ConfigPath, ui5Config.toString());
+    }
+    catch (e) {
+        throw new Error(`Could not write ui5-build.yaml file. Reason: ${e.message}`);
+    }
+}
 /**
  * Writes a ui5-deploy.yaml file within a specified folder in the project directory.
  *
@@ -218,23 +240,17 @@ async function writeUI5DeployYaml(projectPath, data, fs) {
 async function writeCfTemplates(basePath, variant, config, fs) {
     const baseTmplPath = (0, node_path_1.join)(__dirname, '../../templates');
     const templatePath = config.options?.templatePathOverwrite ?? baseTmplPath;
-    const { app, baseApp, cf, project, options } = config;
+    const { app, project, options } = config;
     fs.copyTpl((0, node_path_1.join)(templatePath, 'project/webapp/manifest.appdescr_variant'), (0, node_path_1.join)(project.folder, 'webapp', 'manifest.appdescr_variant'), { app: variant });
     fs.copyTpl((0, node_path_1.join)(templatePath, 'cf/package.json'), (0, node_path_1.join)(project.folder, 'package.json'), {
         module: project.name
     });
     fs.copyTpl((0, node_path_1.join)(templatePath, 'cf/ui5.yaml'), (0, node_path_1.join)(project.folder, 'ui5.yaml'), {
-        appHostId: baseApp.appHostId,
-        appName: baseApp.appName,
-        appVersion: baseApp.appVersion,
-        module: project.name,
-        html5RepoRuntime: cf.html5RepoRuntimeGuid,
-        org: cf.org.GUID,
-        space: cf.space.GUID,
-        sapCloudService: cf.businessSolutionName ?? '',
-        instanceName: cf.businessService
+        module: project.name
+    });
+    fs.copyTpl((0, node_path_1.join)(templatePath, 'cf/ui5-build.yaml'), (0, node_path_1.join)(project.folder, 'ui5-build.yaml'), {
+        module: project.name
     });
-    fs.writeJSON((0, node_path_1.join)(project.folder, '.adp/config.json'), getCfAdpConfig(config));
     fs.copyTpl((0, node_path_1.join)(templatePath, 'cf/i18n/i18n.properties'), (0, node_path_1.join)(project.folder, 'webapp/i18n/i18n.properties'), {
         module: project.name,
         moduleTitle: app.title,

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%3Aadp-tooling"
   },
-  "version": "0.16.13",
+  "version": "0.16.14",
   "license": "Apache-2.0",
   "author": "@SAP/ux-tools-team",
   "main": "dist/index.js",

package/templates/cf/package.json

@@ -4,7 +4,9 @@
 	"description": "",
 	"main": "index.js",
 	"scripts": {
-		"build": "npm run clean && ui5 build --include-task=generateCachebusterInfo && npm run zip",
+		"prestart": "npm run build",
+		"start": "fiori run --open /test/flp.html#app-preview",
+		"build": "npm run clean && ui5 build --config ui5-build.yaml --include-task=generateCachebusterInfo && npm run zip",
 		"zip": "cd dist && npx bestzip ../<%= module %>.zip *",
 		"clean": "npx rimraf <%= module %>.zip dist",
 		"build-ui5": "npm explore @ui5/task-adaptation -- npm run rollup"
@@ -20,11 +22,12 @@
 		]
 	},
 	"devDependencies": {
-		"@sap/ui5-builder-webide-extension": "1.0.x",
-		"@sapui5/ts-types": "^1.85.1",
-		"@ui5/cli": "^3.0.0",
-		"@ui5/task-adaptation": "^1.0.x",
-		"bestzip": "2.1.4",
-		"rimraf": "3.0.2"
+		"@sap/ui5-builder-webide-extension": "^1.1.9",
+		"@sapui5/ts-types": "^1.141.2",
+		"@sap/ux-ui5-tooling": "1",
+		"@ui5/cli": "^4.0.16",
+		"@ui5/task-adaptation": "^1.5.3",
+		"bestzip": "^2.2.1",
+		"rimraf": "^5.0.5"
 	}
 }

package/templates/cf/ui5-build.yaml

@@ -0,0 +1,5 @@
+---
+specVersion: "2.2"
+type: application
+metadata:
+  name: <%= module %>

package/templates/cf/ui5.yaml

@@ -3,17 +3,3 @@ specVersion: "2.2"
 type: application
 metadata:
   name: <%= module %>
-builder:
-  customTasks:
-    - name: app-variant-bundler-build
-      beforeTask: escapeNonAsciiCharacters
-      configuration:
-        appHostId: <%= appHostId %>
-        appName: <%= appName %>
-        appVersion: <%= appVersion %>
-        moduleName: <%= module %>
-        org: <%= org %>
-        space: <%= space %>
-        html5RepoRuntime: <%= html5RepoRuntime %>
-        sapCloudService: <%= sapCloudService %>
-        serviceInstanceName: <%= instanceName %>