@sap-ux/cf-deploy-config-writer 0.3.82 → 0.3.83

package/README.md

@@ -45,29 +45,10 @@ await mtaConfig.addMtaExtensionConfig('mynewdestination', 'https://my-service-ur
 await mtaConfig.save();
 ```
 
-## Example: Appending a `Managed` Approuter Configuration to an SAP Fiori UI5 Application
-
-Calling the `generateAppConfig` function to append Cloud Foundry configuration to a HTML5 application, assumes `manifest.json` and `ui5.yaml` configurations are present otherwise the process will exit with an error;
-```Typescript
-import { generateAppConfig, DefaultMTADestination } from '@sap-ux/cf-deploy-config-writer'
-import { join } from 'path';
-
-const exampleWriter = async () => {
-  const ui5AppPath = join(__dirname, 'testapp');
-  // Option 1. Append managed approuter configuration, toggle `addManagedAppRouter` to false to ommit the managed approuter configuration being appended to the mta.yaml
-  const fs = await generateAppConfig({appPath: ui5AppPath, addManagedAppRouter: true, destinationName: 'SAPBTPDestination'}); 
-  return new Promise((resolve) => {
-      fs.commit(resolve); // When using with Yeoman it handle the fs commit.
-  });
-}
-// Calling the function
-await exampleWriter();
-```
-
 ## Example: Generate or Append a `Managed` Approuter Configuration to a SAP Fiori UI5 Application
 
 Calling the `generateAppConfig` function to append Cloud Foundry configuration to a HTML5 application;
-- Assumes `manifest.json` and `ui5.yaml` configurations are present in the target folder
+- Assumes `manifest.json` and `ui5.yaml` configurations are present in the target folder, otherwise the process will exit with an error
 - Supports `CAP` projects where an existing `mta.yaml` is already present and you are adding a SAP Fiori UI5 app to it
 
 ```Typescript
@@ -76,12 +57,12 @@ import { join } from 'path';
 
 const exampleWriter = async () => {
   const ui5AppPath = join(__dirname, 'testapp');
-  // Option 1. Append managed approuter configuration, toggle `addManagedAppRouter` to false to ommit the managed approuter configuration being appended to the mta.yaml
-  const fs = await generateAppConfig({appPath: ui5AppPath, addManagedAppRouter: true, destinationName: 'SAPBTPDestination'}); 
+  // Option 1. Append managed approuter configuration, toggle `addManagedAppRouter` to false to omit the managed approuter configuration being appended to the mta.yaml
+  const fs1 = await generateAppConfig({appPath: ui5AppPath, addManagedAppRouter: true, destinationName: 'SAPBTPDestination'});
   // Option 2. For CAP flows, set the destination to DefaultMTADestination to create a destination instance between the HTML5 app and CAP Project
-  const fs = await generateAppConfig({appPath: ui5AppPath, addManagedAppRouter: true, destinationName: DefaultMTADestination});
+  const fs2 = await generateAppConfig({appPath: ui5AppPath, addManagedAppRouter: true, destinationName: DefaultMTADestination});
   return new Promise((resolve) => {
-      fs.commit(resolve); // When using with Yeoman it handle the fs commit.
+      fs2.commit(resolve); // When using with Yeoman it handles the fs commit.
   });
 }
 // Calling the function
@@ -100,12 +81,12 @@ import { join } from 'path';
 
 const exampleWriter = async () => {
   const mtaPath = join(__dirname, 'testproject');
-  // If your SAPUI5 application will be consuming an SAB BTP OnPremise destination, Connectivity serivce is required; Refer to https://discovery-center.cloud.sap/serviceCatalog/connectivity-service?region=all
+  // If your SAPUI5 application will be consuming an SAP BTP OnPremise destination, Connectivity service is required; Refer to https://discovery-center.cloud.sap/serviceCatalog/connectivity-service?region=all
   const addConnectivityService = true;
-  // Generate an approuter configuration, with the default being a Managed Approuter, toggle the routerType to genereate RouterModuleType.AppFront or RouterModuleType.Standard configurations
+  // Generate an approuter configuration, with the default being a Managed Approuter, toggle the routerType to generate RouterModuleType.AppFront or RouterModuleType.Standard configurations
   const fs = await generateBaseConfig({ mtaId: 'mymtaproject', routerType: RouterModuleType.Managed, mtaPath, addConnectivityService });
   return new Promise((resolve) => {
-      fs.commit(resolve); // When using with Yeoman it handle the fs commit.
+      fs.commit(resolve); // When using with Yeoman it handles the fs commit.
   });
 }
 // Calling the function
@@ -124,10 +105,10 @@ import { join } from 'path';
 
 const exampleWriter = async () => {
   const mtaPath = join(__dirname, 'testcapproject');
-  // Generate an approuter configuration, with the default being a Managed Approuter, toggle the routerType to genereate RouterModuleType.AppFront or RouterModuleType.Standard configurations 
+  // Generate an approuter configuration, with the default being a Managed Approuter, toggle the routerType to generate RouterModuleType.AppFront or RouterModuleType.Standard configurations
   const fs = await generateCAPConfig({ mtaId: 'mymtaproject', routerType: RouterModuleType.Managed, mtaPath });
   return new Promise((resolve) => {
-      fs.commit(resolve); // When using with Yeoman it handle the fs commit.
+      fs.commit(resolve); // When using with Yeoman it handles the fs commit.
   });
 }
 // Calling the function
@@ -152,6 +133,30 @@ For example, the following configuration will be appended to the `xs-app.json` r
 
 Replace `<apply-service-segment-path>` with the actual service path you want to use, for example `/sap` or `/myservice`;
 
+## Error Handling
+
+The package throws errors in the following scenarios:
+- **MTA Binary Not Found**: If the MTA tool is not installed or not in PATH
+- **Invalid MTA ID**: If the MTA ID doesn't meet naming requirements (must start with letter/underscore, max 128 chars, only letters/numbers/dashes/periods/underscores)
+- **Missing Required Files**: If `manifest.json` or `ui5.yaml` are missing for UI5 app configuration
+- **Existing MTA Configuration**: If an `mta.yaml` file already exists when generating base config
+- **Missing ABAP Service Details**: If ABAP service binding is specified without required service details
+- **Invalid CAP Project**: If the target folder doesn't contain a valid Node.js CAP project
+
+All error messages support internationalization (i18n) for proper localization.
+
+## CAP Project Considerations
+
+When using `generateCAPConfig`, note that CAP projects do not support direct ABAP service binding. The `CAPConfig` interface intentionally excludes `abapServiceProvider` properties to provide type safety and semantic clarity for CAP-specific deployments.
+
+## MTA Module Naming
+
+Application names are automatically converted to MTA-compatible module names by:
+- Removing special characters (`` `~!@#$%^&*£()|+=?;:'",.<>`` )
+- Keeping only letters, numbers, dots (.), hyphens (-), and underscores (_)
+- Truncating to maximum allowed length (128 characters for IDs)
+
+For example: `sap.ux.app` remains `sap.ux.app`, but `my-app@v1.0` becomes `my-appv1.0`
 
 ## Keywords
 SAP Fiori elements

package/dist/cf-writer/app-config.d.ts

@@ -4,25 +4,27 @@ import { type CFAppConfig, type CFConfig } from '../types';
 /**
  * Add a managed approuter configuration to an existing HTML5 application, any exceptions thrown will be handled by the calling client.
  *
- * @param cfAppConfig writer configuration
- * @param fs an optional reference to a mem-fs editor
- * @param logger optional logger instance
- * @returns file system reference
+ * @param cfAppConfig Writer configuration
+ * @param fs An optional reference to a mem-fs editor
+ * @param logger Optional logger instance
+ * @returns File system reference
+ * @throws {Error} If MTA binary is not found in the system path
+ * @throws {Error} If required files (manifest.json, ui5.yaml) are missing or invalid
  */
 export declare function generateAppConfig(cfAppConfig: CFAppConfig, fs?: Editor, logger?: Logger): Promise<Editor>;
 /**
  * Creates the MTA configuration file.
  *
- * @param cfConfig writer configuration
- * @param fs reference to a mem-fs editor
+ * @param cfConfig Writer configuration containing MTA details
+ * @param fs Reference to a mem-fs editor
+ * @throws {Error} If MTA file creation or CAP MTA generation fails
  */
 export declare function generateMTAFile(cfConfig: CFConfig, fs: Editor): Promise<void>;
 /**
  * Generate UI5 deploy config.
  *
- * @param cfConfig - the deployment config
- * @param fs reference to a mem-fs editor
- * @returns the deploy config
+ * @param cfConfig The deployment configuration
+ * @param fs Reference to a mem-fs editor
  */
 export declare function generateUI5DeployConfig(cfConfig: CFConfig, fs: Editor): Promise<void>;
 //# sourceMappingURL=app-config.d.ts.map

package/dist/cf-writer/app-config.js

@@ -20,10 +20,12 @@ const i18n_1 = require("../i18n");
 /**
  * Add a managed approuter configuration to an existing HTML5 application, any exceptions thrown will be handled by the calling client.
  *
- * @param cfAppConfig writer configuration
- * @param fs an optional reference to a mem-fs editor
- * @param logger optional logger instance
- * @returns file system reference
+ * @param cfAppConfig Writer configuration
+ * @param fs An optional reference to a mem-fs editor
+ * @param logger Optional logger instance
+ * @returns File system reference
+ * @throws {Error} If MTA binary is not found in the system path
+ * @throws {Error} If required files (manifest.json, ui5.yaml) are missing or invalid
  */
 async function generateAppConfig(cfAppConfig, fs, logger) {
     fs ??= (0, mem_fs_editor_1.create)((0, mem_fs_1.create)());
@@ -37,9 +39,10 @@ async function generateAppConfig(cfAppConfig, fs, logger) {
 /**
  * Returns the updated configuration for the given HTML5 app, after reading all the required files.
  *
- * @param cfAppConfig writer configuration
- * @param fs reference to a mem-fs editor
- * @returns updated writer configuration
+ * @param cfAppConfig Writer configuration
+ * @param fs Reference to a mem-fs editor
+ * @returns Updated writer configuration
+ * @throws {Error} If no SAP Fiori UI5 application is found (missing app ID)
  */
 async function getUpdatedConfig(cfAppConfig, fs) {
     const isLCAP = cfAppConfig.lcapMode ?? false;
@@ -47,7 +50,7 @@ async function getUpdatedConfig(cfAppConfig, fs) {
     const { serviceHost, destination, firstServicePathSegmentUI5Config } = await processUI5Config(cfAppConfig.appPath, fs);
     const { servicePath, firstServicePathSegment, appId } = await processManifest(cfAppConfig.appPath, fs);
     if (!appId) {
-        throw new Error('No SAP Fiori UI5 application found.');
+        throw new Error((0, i18n_1.t)('error.noUI5AppFound'));
     }
     const { destinationIsFullUrl, destinationAuthentication } = await (0, utils_1.getDestinationProperties)(cfAppConfig.destinationName ?? destination);
     (0, utils_1.enforceValidRouterConfig)(cfAppConfig);
@@ -146,8 +149,9 @@ async function processManifest(appPath, fs) {
 /**
  * Generates the deployment configuration for the HTML5 application.
  *
- * @param cfAppConfig writer configuration
- * @param fs reference to a mem-fs editor
+ * @param cfAppConfig Writer configuration
+ * @param fs Reference to a mem-fs editor
+ * @throws {Error} If MTA generation or configuration update fails
  */
 async function generateDeployConfig(cfAppConfig, fs) {
     logger_helper_1.default?.logger?.debug(`Generate HTML5 app deployment configuration with: \n ${JSON.stringify(cfAppConfig)}`);
@@ -168,8 +172,9 @@ async function generateDeployConfig(cfAppConfig, fs) {
 /**
  * Creates the MTA configuration file.
  *
- * @param cfConfig writer configuration
- * @param fs reference to a mem-fs editor
+ * @param cfConfig Writer configuration containing MTA details
+ * @param fs Reference to a mem-fs editor
+ * @throws {Error} If MTA file creation or CAP MTA generation fails
  */
 async function generateMTAFile(cfConfig, fs) {
     // Step1. Create mta.yaml
@@ -191,8 +196,9 @@ async function generateMTAFile(cfConfig, fs) {
 /**
  * Updates the MTA configuration file with the app router and destination.
  *
- * @param cfConfig writer configuration
- * @param fs reference to a mem-fs editor
+ * @param cfConfig Writer configuration
+ * @param fs Reference to a mem-fs editor
+ * @throws {Error} If MTA configuration update or save fails
  */
 async function appendAppRouter(cfConfig, fs) {
     const mtaInstance = await (0, mta_config_1.getMtaConfig)(cfConfig.rootPath);
@@ -225,12 +231,12 @@ async function appendAppRouter(cfConfig, fs) {
 /**
  * Cleans up standalone routes in a Cloud Foundry application configuration.
  *
- * @param {object} cfConfig - The Cloud Foundry configuration object
- * @param {string} cfConfig.rootPath - The root path of the application
- * @param {string} cfConfig.appId - The application identifier
- * @param {MtaConfig} mtaInstance - The MTA configuration instance
- * @param {Editor} fs - The file system editor for performing cleanup operations
- * @returns {void} - This function does not return a value
+ * @param cfConfig The Cloud Foundry configuration object
+ * @param cfConfig.rootPath The root path of the application
+ * @param cfConfig.appId The application identifier
+ * @param mtaInstance The MTA configuration instance
+ * @param fs The file system editor for performing cleanup operations
+ * @throws {Error} If xs-app.json cannot be read or updated
  */
 function cleanupStandaloneRoutes({ rootPath, appId }, mtaInstance, fs) {
     // Cleanup standalone xs-app.json to reflect new application
@@ -252,8 +258,9 @@ function cleanupStandaloneRoutes({ rootPath, appId }, mtaInstance, fs) {
 /**
  * Apply changes to mta.yaml, will retry if an exception is thrown.
  *
- * @param cfConfig writer configuration
+ * @param cfConfig Writer configuration
  * @param mtaInstance MTA configuration instance
+ * @throws {Error} If MTA extension configuration cannot be added for API Hub Enterprise
  */
 async function saveMta(cfConfig, mtaInstance) {
     try {
@@ -280,8 +287,8 @@ async function saveMta(cfConfig, mtaInstance) {
 /**
  * Appends the Cloud Foundry specific configurations to the project.
  *
- * @param cfConfig writer configuration
- * @param fs reference to a mem-fs editor
+ * @param cfConfig Writer configuration
+ * @param fs Reference to a mem-fs editor
  */
 async function appendCloudFoundryConfigurations(cfConfig, fs) {
     // When data source is none in app generator, it is not required to provide destination
@@ -308,8 +315,8 @@ async function appendCloudFoundryConfigurations(cfConfig, fs) {
  * Updates the manifest.json file with the cloud service name.
  * Preserves existing sap.cloud properties while updating public and service values.
  *
- * @param cfConfig writer configuration
- * @param fs reference to a mem-fs editor
+ * @param cfConfig Writer configuration
+ * @param fs Reference to a mem-fs editor
  */
 async function updateManifest(cfConfig, fs) {
     const webappPath = await (0, project_access_1.getWebappPath)(cfConfig.appPath, fs);
@@ -329,8 +336,8 @@ async function updateManifest(cfConfig, fs) {
 /**
  * Updates the package.json file with the necessary scripts and dependencies.
  *
- * @param cfConfig writer configuration
- * @param fs reference to a mem-fs editor
+ * @param cfConfig Writer configuration
+ * @param fs Reference to a mem-fs editor
  */
 async function updateHTML5AppPackage(cfConfig, fs) {
     let deployArgs = [];
@@ -356,9 +363,8 @@ async function updateHTML5AppPackage(cfConfig, fs) {
 /**
  * Generate UI5 deploy config.
  *
- * @param cfConfig - the deployment config
- * @param fs reference to a mem-fs editor
- * @returns the deploy config
+ * @param cfConfig The deployment configuration
+ * @param fs Reference to a mem-fs editor
  */
 async function generateUI5DeployConfig(cfConfig, fs) {
     const ui5BaseConfig = await (0, project_access_1.readUi5Yaml)(cfConfig.appPath, project_access_1.FileName.Ui5Yaml, fs);

package/dist/cf-writer/base-config.d.ts

@@ -4,10 +4,11 @@ import { type CFBaseConfig } from '../types';
 /**
  * Add a standalone | managed | frontend app router to an empty target folder.
  *
- * @param config writer configuration
- * @param fs an optional reference to a mem-fs editor
- * @param logger optional logger instance
- * @returns file system reference
+ * @param config Writer configuration
+ * @param fs An optional reference to a mem-fs editor
+ * @param logger Optional logger instance
+ * @returns File system reference
+ * @throws {Error} If MTA binary is not found, configuration is invalid, or mta.yaml already exists
  */
 export declare function generateBaseConfig(config: CFBaseConfig, fs?: Editor, logger?: Logger): Promise<Editor>;
 //# sourceMappingURL=base-config.d.ts.map

package/dist/cf-writer/base-config.js

@@ -14,10 +14,11 @@ const i18n_1 = require("../i18n");
 /**
  * Add a standalone | managed | frontend app router to an empty target folder.
  *
- * @param config writer configuration
- * @param fs an optional reference to a mem-fs editor
- * @param logger optional logger instance
- * @returns file system reference
+ * @param config Writer configuration
+ * @param fs An optional reference to a mem-fs editor
+ * @param logger Optional logger instance
+ * @returns File system reference
+ * @throws {Error} If MTA binary is not found, configuration is invalid, or mta.yaml already exists
  */
 async function generateBaseConfig(config, fs, logger) {
     fs ??= (0, mem_fs_editor_1.create)((0, mem_fs_1.create)());
@@ -26,8 +27,9 @@ async function generateBaseConfig(config, fs, logger) {
     }
     logger?.debug(`Generate base configuration using: \n ${JSON.stringify(config)}`);
     (0, mta_config_1.validateMtaConfig)(config);
+    // Check if mta.yaml already exists in the target directory
     if ((0, utils_1.fileExists)(fs, (0, node_path_1.join)(config.mtaPath, config.mtaId))) {
-        throw new Error((0, i18n_1.t)('error.mtaFolderAlreadyExists'));
+        throw new Error((0, i18n_1.t)('error.mtaAlreadyExists'));
     }
     (0, mta_config_1.createMTA)(config);
     await (0, mta_config_1.addRoutingConfig)(config, fs);

package/dist/cf-writer/cap-config.d.ts

@@ -4,10 +4,12 @@ import { type CAPConfig } from '../types';
 /**
  * Add a standalone | managed approuter to a CAP project.
  *
- * @param config writer configuration
- * @param fs an optional reference to a mem-fs editor
- * @param logger optional logger instance
- * @returns file system reference
+ * @param config Writer configuration
+ * @param fs An optional reference to a mem-fs editor
+ * @param logger Optional logger instance
+ * @returns File system reference
+ * @throws {Error} If target folder does not contain a Node.js CAP project
+ * @throws {Error} If mta.yaml already exists in the target directory
  */
 export declare function generateCAPConfig(config: CAPConfig, fs?: Editor, logger?: Logger): Promise<Editor>;
 //# sourceMappingURL=cap-config.d.ts.map

package/dist/cf-writer/cap-config.js

@@ -15,10 +15,12 @@ const constants_1 = require("../constants");
 /**
  * Add a standalone | managed approuter to a CAP project.
  *
- * @param config writer configuration
- * @param fs an optional reference to a mem-fs editor
- * @param logger optional logger instance
- * @returns file system reference
+ * @param config Writer configuration
+ * @param fs An optional reference to a mem-fs editor
+ * @param logger Optional logger instance
+ * @returns File system reference
+ * @throws {Error} If target folder does not contain a Node.js CAP project
+ * @throws {Error} If mta.yaml already exists in the target directory
  */
 async function generateCAPConfig(config, fs, logger) {
     fs ??= (0, mem_fs_editor_1.create)((0, mem_fs_1.create)());
@@ -38,7 +40,9 @@ async function generateCAPConfig(config, fs, logger) {
 /**
  * Ensure the configuration is valid, target folder exists and is a CAP Node.js app and mta.yaml does not already exist.
  *
- * @param config writer configuration
+ * @param config Writer configuration
+ * @throws {Error} If target folder does not contain a CAP Node.js project
+ * @throws {Error} If mta.yaml already exists in the target directory
  */
 async function validateConfig(config) {
     (0, mta_config_1.validateMtaConfig)(config);

package/dist/i18n.js

@@ -25,8 +25,7 @@ async function initI18n() {
         lng: 'en',
         fallbackLng: 'en',
         defaultNS: NS,
-        ns: [NS],
-        showSupportNotice: false
+        ns: [NS]
     });
 }
 /**

package/dist/mta-config/index.d.ts

@@ -19,6 +19,7 @@ export declare function getMtaConfig(rootPath: string): Promise<MtaConfig | unde
 /**
  * Generate an MTA ID that is suitable for CF deployment.
  * Removes special characters and restricts length to maximum allowed.
+ * Note: This delegates to the utility function and adds length restriction.
  *
  * @param appId Name of the app, like `sap.ux.app`
  * @returns Name that's acceptable for mta.yaml (sanitized and length-restricted)
@@ -43,22 +44,27 @@ export declare function doesCDSBinaryExist(): void;
 /**
  * Validate the writer configuration to ensure all required parameters are present.
  *
- * @param config writer configuration
- * @throws {Error} If validation fails
+ * @param config Writer configuration
+ * @throws {Error} If MTA binary is not found in system path
+ * @throws {Error} If required MTA parameters (routerType, mtaId, mtaPath) are missing
+ * @throws {Error} If MTA ID is invalid (too long, invalid characters, or doesn't start with letter/underscore)
+ * @throws {Error} If MTA version is invalid
+ * @throws {Error} If ABAP service binding details are incomplete
  */
 export declare function validateMtaConfig(config: CFBaseConfig): void;
 /**
  * Add standalone | managed | frontend app router to the target folder.
  *
- * @param config writer configuration
- * @param fs reference to a mem-fs editor
+ * @param config Writer configuration
+ * @param fs Reference to a mem-fs editor
  */
 export declare function addRoutingConfig(config: CFBaseConfig, fs: Editor): Promise<void>;
 /**
  * Create an MTA file in the target folder, needs to be written to disk as subsequent calls are dependent on it being on the file system i.e mta-lib.
  *
- * @param config writer configuration
- * @param fs reference to a mem-fs editor
+ * @param config Writer configuration
+ * @param fs Reference to a mem-fs editor
+ * @throws {Error} If CDS command execution fails when generating mta.yaml
  */
 export declare function generateCAPMTA(config: CAPConfig, fs: Editor): Promise<void>;
 export * from './mta';

package/dist/mta-config/index.js

@@ -76,15 +76,14 @@ async function getMtaConfig(rootPath) {
 /**
  * Generate an MTA ID that is suitable for CF deployment.
  * Removes special characters and restricts length to maximum allowed.
+ * Note: This delegates to the utility function and adds length restriction.
  *
  * @param appId Name of the app, like `sap.ux.app`
  * @returns Name that's acceptable for mta.yaml (sanitized and length-restricted)
  */
 function toMtaModuleName(appId) {
-    // Remove special characters not allowed in MTA module names
-    // MTA IDs must contain only alphanumeric characters, hyphens, underscores, and dots
-    // Using replaceAll for global replacement (Sonar S7781)
-    return appId.replaceAll(/[`~!@#$%^&*()_|+\-=?;:'",.<>]/gi, '').slice(0, constants_1.MAX_MTA_ID_LENGTH);
+    // Use the canonical implementation from utils and apply length restriction
+    return (0, utils_1.toMtaModuleName)(appId).slice(0, constants_1.MAX_MTA_ID_LENGTH);
 }
 /**
  * Create an MTA file in the target folder, needs to be written to disk as subsequent calls are dependent on it being on the file system i.e mta-lib.
@@ -127,8 +126,12 @@ function doesCDSBinaryExist() {
 /**
  * Validate the writer configuration to ensure all required parameters are present.
  *
- * @param config writer configuration
- * @throws {Error} If validation fails
+ * @param config Writer configuration
+ * @throws {Error} If MTA binary is not found in system path
+ * @throws {Error} If required MTA parameters (routerType, mtaId, mtaPath) are missing
+ * @throws {Error} If MTA ID is invalid (too long, invalid characters, or doesn't start with letter/underscore)
+ * @throws {Error} If MTA version is invalid
+ * @throws {Error} If ABAP service binding details are incomplete
  */
 function validateMtaConfig(config) {
     // We use mta-lib, which in turn relies on the mta executable being installed and available in the path
@@ -151,12 +154,11 @@ function validateMtaConfig(config) {
 }
 /**
  * Create an MTA file in the target folder, needs to be written to disk as subsequent calls are dependent on it being on the file system i.e mta-lib.
- *
  * Note: this function is deprecated and will be removed in future releases since the cds binary currently does not support app frontend services.
  *
- * @param config writer configuration
- * @param fs reference to a mem-fs editor
- * @deprecated this function is deprecated and will be removed in future releases
+ * @param config Writer configuration
+ * @param fs Reference to a mem-fs editor
+ * @deprecated This function is deprecated and will be removed in future releases
  */
 async function createCAPMTAAppFrontend(config, fs) {
     const mtaTemplate = (0, node_fs_1.readFileSync)((0, utils_1.getTemplatePath)(`frontend/${project_access_1.FileName.MtaYaml}`), 'utf-8');
@@ -172,11 +174,12 @@ async function createCAPMTAAppFrontend(config, fs) {
     logger_helper_1.default.logger?.debug((0, i18n_1.t)('debug.mtaCreated', { mtaPath: config.mtaPath }));
 }
 /**
- *  Add standalone app router to the target folder.
+ * Add standalone app router to the target folder.
  *
- * @param cfConfig writer configuration
+ * @param cfConfig Writer configuration
  * @param mtaInstance MTA configuration instance
- * @param fs reference to a mem-fs editor
+ * @param fs Reference to a mem-fs editor
+ * @throws {Error} If service key retrieval fails for ABAP service binding
  */
 async function addStandaloneRouter(cfConfig, mtaInstance, fs) {
     await mtaInstance.addStandaloneRouter(true);
@@ -208,8 +211,8 @@ async function addStandaloneRouter(cfConfig, mtaInstance, fs) {
 /**
  * Add standalone | managed | frontend app router to the target folder.
  *
- * @param config writer configuration
- * @param fs reference to a mem-fs editor
+ * @param config Writer configuration
+ * @param fs Reference to a mem-fs editor
  */
 async function addRoutingConfig(config, fs) {
     const mtaConfigInstance = await getMtaConfig(config.mtaPath);
@@ -227,8 +230,9 @@ async function addRoutingConfig(config, fs) {
 /**
  * Create an MTA file in the target folder, needs to be written to disk as subsequent calls are dependent on it being on the file system i.e mta-lib.
  *
- * @param config writer configuration
- * @param fs reference to a mem-fs editor
+ * @param config Writer configuration
+ * @param fs Reference to a mem-fs editor
+ * @throws {Error} If CDS command execution fails when generating mta.yaml
  */
 async function generateCAPMTA(config, fs) {
     if (config.routerType === types_1.RouterModuleType.AppFront) {

package/dist/mta-config/mta.d.ts

@@ -39,9 +39,9 @@ export declare class MtaConfig {
     /**
      * Determines if the MTA configuration contains a known resource or module.
      *
-     * @param requires resource to validate
-     * @param resourceType managed or existing service
-     * @returns true if the resource exists, false otherwise
+     * @param requires Resource requirements array to validate
+     * @param resourceType Managed or existing service type identifier
+     * @returns True if the resource exists, false otherwise
      * @private
      */
     private targetExists;
@@ -70,21 +70,21 @@ export declare class MtaConfig {
     /**
      * Add a destination service to the MTA.
      *
-     * @param isManagedApp - If the destination service is for a managed app
+     * @param isManagedApp If the destination service is for a managed app (default: false)
      */
     private addDestinationResource;
     /**
      * Update the destination service in the MTA if not already present.
      *
-     * @param isManagedApp - If the destination service is for a managed app, false by default
+     * @param isManagedApp If the destination service is for a managed app (default: false)
      */
     private updateDestinationResource;
     /**
      * Update the server module to include the required dependencies to ensure endpoints are secured.
      *
-     * @param moduleType known module type
-     * @param supportedResource selected resource to be added
-     * @param appendSrvApi if `srv-api` should be appended, typically used for CAP flows
+     * @param moduleType Known module type (e.g., 'nodejs', 'java')
+     * @param supportedResource Selected resource to be added (default: ManagedXSUAA)
+     * @param appendSrvApi If `srv-api` should be appended, typically used for CAP flows (default: true)
      */
     private updateServerModule;
     /**
@@ -96,66 +96,63 @@ export declare class MtaConfig {
     /**
      * Verify if the destination is valid and if WebIDEUsage is set to ODATA_GENERIC or ODATA_ABAP.
      *
-     * @param {MTADestinationType} destination - destination object
-     * @returns {boolean} - true if the destination is valid, false otherwise
+     * @param destination Destination object to validate
+     * @returns True if the destination is an OData destination (ODATA_GENERIC or ODATA_ABAP), false otherwise
      */
     private isODataDestination;
     /**
      * Cleanup missing content for Managed | Standalone router types.
      *
      * @private
-     * @returns {Promise<void>} A promise that resolves when the change request has been processed.
      */
     private cleanupMissingResources;
     private cleanupModules;
     /**
      * Returns the MTA prefix, read from the MTA ID.
      *
-     * @returns {string} the MTA ID
+     * @returns The MTA ID prefix
      */
     get prefix(): string;
     /**
      * Returns the path to the standalone approuter module.
      *
-     * @returns {string | undefined} the MTA ID
+     * @returns The path to the standalone approuter module, or undefined if not found
      */
     get standaloneRouterPath(): string | undefined;
     /**
      * Returns the cloud service name, read from the content module which contains destinations.
      *
-     * @returns {string | undefined} the cloud service name
+     * @returns The cloud service name, or undefined if not found
      */
     get cloudServiceName(): string | undefined;
     /**
      * Returns true if the MTA contains an approuter module of type App Frontend Service.
      *
-     * @returns {boolean} true if the mta contains an App Frontend Service
+     * @returns True if the MTA contains an App Frontend Service
      */
     hasAppFrontendRouter(): boolean;
     /**
-     * Returns the mta parameters.
+     * Returns the MTA parameters.
      *
-     * @returns {Promise<mta.Parameters>} the MTA parameters
+     * @returns The MTA parameters
      */
     getParameters(): Promise<mta.Parameters>;
     /**
-     * Returns the mta build parameters.
+     * Returns the MTA build parameters.
      *
-     * @returns {Promise<mta.Parameters>} the MTA build parameters
+     * @returns The MTA build parameters
      */
     getBuildParameters(): Promise<mta.ProjectBuildParameters>;
     /**
      * Update the MTA parameters.
      *
-     * @param parameters the MTA parameters being applied
-     * @returns {Promise<void>} A promise that resolves when the change request has been processed.
+     * @param parameters The MTA parameters being applied
      */
     updateParameters(parameters: mta.Parameters): Promise<void>;
     /**
      * Update the MTA build parameters i.e. build-parameters -> before-all.
      *
-     * @param parameters the MTA build parameters being applied
-     * @returns {Promise<void>} A promise that resolves when the change request has been processed.
+     * @param parameters The MTA build parameters being applied
      */
     updateBuildParams(parameters: mta.ProjectBuildParameters): Promise<void>;
     /**

package/dist/mta-config/mta.js

@@ -68,9 +68,9 @@ class MtaConfig {
     /**
      * Determines if the MTA configuration contains a known resource or module.
      *
-     * @param requires resource to validate
-     * @param resourceType managed or existing service
-     * @returns true if the resource exists, false otherwise
+     * @param requires Resource requirements array to validate
+     * @param resourceType Managed or existing service type identifier
+     * @returns True if the resource exists, false otherwise
      * @private
      */
     targetExists(requires, resourceType) {
@@ -251,7 +251,7 @@ class MtaConfig {
     /**
      * Add a destination service to the MTA.
      *
-     * @param isManagedApp - If the destination service is for a managed app
+     * @param isManagedApp If the destination service is for a managed app (default: false)
      */
     async addDestinationResource(isManagedApp = false) {
         const destinationName = `${this.prefix?.slice(0, constants_1.MAX_MTA_PREFIX_LENGTH)}-destination-service`;
@@ -275,7 +275,7 @@ class MtaConfig {
     /**
      * Update the destination service in the MTA if not already present.
      *
-     * @param isManagedApp - If the destination service is for a managed app, false by default
+     * @param isManagedApp If the destination service is for a managed app (default: false)
      */
     async updateDestinationResource(isManagedApp = false) {
         const resource = this.resources.get('destination');
@@ -307,9 +307,9 @@ class MtaConfig {
     /**
      * Update the server module to include the required dependencies to ensure endpoints are secured.
      *
-     * @param moduleType known module type
-     * @param supportedResource selected resource to be added
-     * @param appendSrvApi if `srv-api` should be appended, typically used for CAP flows
+     * @param moduleType Known module type (e.g., 'nodejs', 'java')
+     * @param supportedResource Selected resource to be added (default: ManagedXSUAA)
+     * @param appendSrvApi If `srv-api` should be appended, typically used for CAP flows (default: true)
      */
     async updateServerModule(moduleType, supportedResource = constants_1.ManagedXSUAA, appendSrvApi = true) {
         const mtaResource = this.resources.get(supportedResource);
@@ -358,8 +358,8 @@ class MtaConfig {
     /**
      * Verify if the destination is valid and if WebIDEUsage is set to ODATA_GENERIC or ODATA_ABAP.
      *
-     * @param {MTADestinationType} destination - destination object
-     * @returns {boolean} - true if the destination is valid, false otherwise
+     * @param destination Destination object to validate
+     * @returns True if the destination is an OData destination (ODATA_GENERIC or ODATA_ABAP), false otherwise
      */
     isODataDestination(destination) {
         return (0, btp_utils_1.isGenericODataDestination)(destination) || (0, btp_utils_1.isAbapEnvironmentOnBtp)(destination);
@@ -368,7 +368,6 @@ class MtaConfig {
      * Cleanup missing content for Managed | Standalone router types.
      *
      * @private
-     * @returns {Promise<void>} A promise that resolves when the change request has been processed.
      */
     async cleanupMissingResources() {
         this.log?.debug((0, i18n_1.t)('debug.addMissingModules'));
@@ -419,7 +418,7 @@ class MtaConfig {
     /**
      * Returns the MTA prefix, read from the MTA ID.
      *
-     * @returns {string} the MTA ID
+     * @returns The MTA ID prefix
      */
     get prefix() {
         return this.mtaId;
@@ -427,7 +426,7 @@ class MtaConfig {
     /**
      * Returns the path to the standalone approuter module.
      *
-     * @returns {string | undefined} the MTA ID
+     * @returns The path to the standalone approuter module, or undefined if not found
      */
     get standaloneRouterPath() {
         return this.modules.get('approuter.nodejs')?.path;
@@ -435,7 +434,7 @@ class MtaConfig {
     /**
      * Returns the cloud service name, read from the content module which contains destinations.
      *
-     * @returns {string | undefined} the cloud service name
+     * @returns The cloud service name, or undefined if not found
      */
     get cloudServiceName() {
         let cloudServiceName;
@@ -454,23 +453,23 @@ class MtaConfig {
     /**
      * Returns true if the MTA contains an approuter module of type App Frontend Service.
      *
-     * @returns {boolean} true if the mta contains an App Frontend Service
+     * @returns True if the MTA contains an App Frontend Service
      */
     hasAppFrontendRouter() {
         return this.modules.has('com.sap.application.content:appfront');
     }
     /**
-     * Returns the mta parameters.
+     * Returns the MTA parameters.
      *
-     * @returns {Promise<mta.Parameters>} the MTA parameters
+     * @returns The MTA parameters
      */
     async getParameters() {
         return this.mta.getParameters();
     }
     /**
-     * Returns the mta build parameters.
+     * Returns the MTA build parameters.
      *
-     * @returns {Promise<mta.Parameters>} the MTA build parameters
+     * @returns The MTA build parameters
      */
     async getBuildParameters() {
         return this.mta.getBuildParameters();
@@ -478,8 +477,7 @@ class MtaConfig {
     /**
      * Update the MTA parameters.
      *
-     * @param parameters the MTA parameters being applied
-     * @returns {Promise<void>} A promise that resolves when the change request has been processed.
+     * @param parameters The MTA parameters being applied
      */
     async updateParameters(parameters) {
         await this.mta?.updateParameters(parameters);
@@ -488,8 +486,7 @@ class MtaConfig {
     /**
      * Update the MTA build parameters i.e. build-parameters -> before-all.
      *
-     * @param parameters the MTA build parameters being applied
-     * @returns {Promise<void>} A promise that resolves when the change request has been processed.
+     * @param parameters The MTA build parameters being applied
      */
     async updateBuildParams(parameters) {
         await this.mta?.updateBuildParameters(parameters);

package/dist/translations/cf-deploy-config-writer.i18n.json

@@ -37,7 +37,8 @@
         "targetFolderDoesNotExist": "The target folder does not exist: {{targetFolder}}. Check the folder has the correct permissions.",
         "doesNotContainACapApp": "The target folder does not contain a Node.js CAP project. Please ensure the folder contains a Node.js CAP project.",
         "errorInstallingNodeModules": "An error occurred when installing node modules. Please check the logs.",
-        "errorGeneratingMtaYaml": "An error occurred when creating the mta.yaml file. Please check the logs."
+        "errorGeneratingMtaYaml": "An error occurred when creating the mta.yaml file. For more information, check the logs.",
+        "noUI5AppFound": "No SAPUI5 application found. Please ensure the manifest.json file contains a valid 'sap.app.id'."
     },
     "info": {
         "existingMTAExtensionNotFound": "Cannot find a valid existing MTA extension file. A new one will be created. Error: {{- error}}.",

package/dist/types/index.d.ts

@@ -54,6 +54,15 @@ export interface CFConfig extends CFAppConfig, CFBaseConfig {
     firstServicePathSegment?: string;
     isMtaRoot?: boolean;
 }
+/**
+ * Configuration for CAP (Cloud Application Programming) project deployments.
+ * Extends CFBaseConfig but excludes ABAP service provider properties since CAP projects
+ * don't support direct ABAP service binding. This interface provides semantic clarity
+ * and type safety by explicitly excluding properties that are not applicable to CAP deployments.
+ *
+ * @remarks This is an intentionally narrow interface that omits ABAP-specific properties
+ * while inheriting all standard Cloud Foundry base configuration properties.
+ */
 export interface CAPConfig extends Omit<CFBaseConfig, 'abapServiceProvider'> {
 }
 export declare const enum ApiHubType {

package/dist/utils.d.ts

@@ -6,21 +6,23 @@ import { type MTABaseConfig, type CFBaseConfig, type CFAppConfig } from './types
  * Read manifest file for processing.
  *
  * @param manifestPath Path to the manifest file
- * @param fs reference to a mem-fs editor
+ * @param fs Reference to a mem-fs editor
  * @returns Manifest object
+ * @throws {Error} If the manifest file cannot be read or parsed as valid JSON
  */
 export declare function readManifest(manifestPath: string, fs: Editor): Manifest;
 /**
  * Locates template files relative to the dist folder.
  * This helps to locate templates when this module is bundled and the dir structure is flattened, maintaining the relative paths.
  *
- * @param relativeTemplatePath - optional, the path of the required template relative to the ./templates folder. If not specified the root templates folder is returned.
- * @returns the path of the template specified or templates root folder
+ * @param relativeTemplatePath The path of the required template relative to the ./templates folder
+ * @returns The path of the template specified or templates root folder
  */
 export declare function getTemplatePath(relativeTemplatePath: string): string;
 /**
- * Convert an app name to an MTA ID that is suitable for CF deployment.
+ * Convert an app name to an MTA module name that is suitable for CF deployment.
  * Removes special characters that are not allowed in MTA module names.
+ * MTA module names can only contain: letters, numbers, dots (.), hyphens (-), and underscores (_).
  *
  * @param id Name of the app, like `sap.ux.app`
  * @returns Name that's acceptable in an mta.yaml (special characters removed)
@@ -35,9 +37,12 @@ export declare function toMtaModuleName(id: string): string;
 export declare function toPosixPath(dirPath: string): string;
 /**
  * Get the destination properties, based on the destination value.
+ * Retrieves destination configuration from SAP BTP when running in Business Application Studio.
  *
- * @param destination destination name
- * @returns Destination properties, default properties returned if not found
+ * @param destination The destination name to look up in BTP destination service
+ * @returns Object containing destination URL format flag and authentication type
+ * @returns {boolean} destinationIsFullUrl - True if destination uses full URL format
+ * @returns {Authentication | undefined} destinationAuthentication - Authentication type configured for the destination
  */
 export declare function getDestinationProperties(destination: string | undefined): Promise<{
     destinationIsFullUrl: boolean;
@@ -52,68 +57,66 @@ export declare function getBTPDestinations(): Promise<Destinations>;
 /**
  * Validates the MTA version passed in the config.
  *
- * @param mtaVersion MTA version
- * @returns true if the version is valid
+ * @param mtaVersion MTA version to validate
+ * @returns True if the version is valid
+ * @throws {Error} If the MTA version is invalid or below minimum required version (0.0.1)
  */
 export declare function validateVersion(mtaVersion?: string): boolean;
 /**
  * Appends xs-security.json to the project folder.
  *
- * @param {MTABaseConfig} config - MTA base configuration
- * @param {string} config.mtaPath - Path to the MTA project
- * @param {string} config.mtaId - MTA ID
- * @param {Editor} fs - Reference to a mem-fs editor
- * @param {boolean} [addTenant] - If true, append tenant to the xs-security.json file
- * @returns {void}
+ * @param config MTA base configuration
+ * @param config.mtaPath Path to the MTA project
+ * @param config.mtaId MTA ID used for security configuration
+ * @param fs Reference to a mem-fs editor
+ * @param addTenant If true, append tenant configuration to the xs-security.json file (default: true)
  */
 export declare function addXSSecurityConfig({ mtaPath, mtaId }: MTABaseConfig, fs: Editor, addTenant?: boolean): void;
 /**
- *  Append .gitignore to project folder.
+ * Appends .gitignore to project folder.
  *
  * @param targetPath Path to the project folder
- * @param fs reference to a mem-fs editor
+ * @param fs Reference to a mem-fs editor
  */
 export declare function addGitIgnore(targetPath: string, fs: Editor): void;
 /**
  * Appends server package.json to the project folder.
  *
- * @param {MTABaseConfig} config - MTA base configuration
- * @param {string} config.mtaPath - Path to the MTA project
- * @param {string} config.mtaId - MTA ID
- * @param {Editor} fs - Reference to a mem-fs editor
- * @returns {void}
+ * @param config MTA base configuration
+ * @param config.mtaPath Path to the MTA project
+ * @param config.mtaId MTA ID used in package.json
+ * @param fs Reference to a mem-fs editor
  */
 export declare function addRootPackage({ mtaPath, mtaId }: MTABaseConfig, fs: Editor): void;
 /**
  * Add common dependencies to the HTML5 app package.json.
  *
  * @param targetPath Path to the package.json file
- * @param fs reference to a mem-fs editor
+ * @param fs Reference to a mem-fs editor
  */
 export declare function addCommonPackageDependencies(targetPath: string, fs: Editor): Promise<void>;
 /**
  * Generate CF specific configurations to support deployment and undeployment.
  *
- * @param config writer configuration
- * @param fs reference to a mem-fs editor
- * @param addTenant If true, append tenant to the xs-security.json file
+ * @param config Writer configuration
+ * @param fs Reference to a mem-fs editor
+ * @param addTenant If true, append tenant configuration to the xs-security.json file (default: true)
  */
 export declare function generateSupportingConfig(config: MTABaseConfig, fs: Editor, addTenant?: boolean): Promise<void>;
 /**
  * Update the writer configuration with defaults.
  *
- * @param config writer configuration
+ * @param config Writer configuration to be updated with default values
  */
 export declare function setMtaDefaults(config: CFBaseConfig): void;
 /**
  * Update the root package.json with scripts to deploy the MTA.
- *
  * Note: The fs editor is not passed to `addPackageDevDependency` since the package.json could be updated by other third party tools.
  *
- * @param {object} Options Input params
- * @param {string} Options.mtaId - MTA ID to be written to package.json
- * @param {string} Options.rootPath - MTA project path
- * @param fs - optional reference to a mem-fs editor
+ * @param options Input parameters
+ * @param options.mtaId MTA ID to be written to package.json
+ * @param options.rootPath MTA project path
+ * @param fs Reference to a mem-fs editor
  */
 export declare function updateRootPackage({ mtaId, rootPath }: {
     mtaId: string;
@@ -129,18 +132,16 @@ export declare function enforceValidRouterConfig(config: CFAppConfig): void;
  * Append devDependency if missing, required by mta `cds build` step.
  *
  * @param rootPath Path to the project folder
- * @param fs reference to a mem-fs editor
+ * @param fs Reference to a mem-fs editor
  */
 export declare function alignCdsVersions(rootPath: string, fs: Editor): Promise<void>;
 /**
  * Executes a command in the specified project directory.
  *
- * @async
- * @param {string} cwd - Working directory where the command will be executed
- * @param {string} cmd - Command to execute
- * @param {string[]} args - Arguments to pass to the command
- * @param {string} errorMsg - Error message prefix to display if the command fails
- * @returns {Promise<void>} - A promise that resolves when the command completes successfully
+ * @param cwd Working directory where the command will be executed
+ * @param cmd Command to execute
+ * @param args Arguments to pass to the command
+ * @param errorMsg Error message prefix to display if the command fails
  * @throws {Error} Throws an error with the provided error message concatenated with the original error if execution fails
  * @example
  * // Execute npm install in the project directory
@@ -150,9 +151,9 @@ export declare function runCommand(cwd: string, cmd: string, args: string[], err
 /**
  * Check if a file exists in the file system.
  *
- * @param fs reference to a mem-fs editor
+ * @param fs Reference to a mem-fs editor
  * @param filePath Path to the file
- * @returns true if the file exists, false otherwise
+ * @returns True if the file exists, false otherwise
  */
 export declare function fileExists(fs: Editor, filePath: string): boolean;
 //# sourceMappingURL=utils.d.ts.map

package/dist/utils.js

@@ -29,8 +29,9 @@ let cachedDestinationsList = {};
  * Read manifest file for processing.
  *
  * @param manifestPath Path to the manifest file
- * @param fs reference to a mem-fs editor
+ * @param fs Reference to a mem-fs editor
  * @returns Manifest object
+ * @throws {Error} If the manifest file cannot be read or parsed as valid JSON
  */
 function readManifest(manifestPath, fs) {
     return fs.readJSON(manifestPath);
@@ -39,22 +40,24 @@ function readManifest(manifestPath, fs) {
  * Locates template files relative to the dist folder.
  * This helps to locate templates when this module is bundled and the dir structure is flattened, maintaining the relative paths.
  *
- * @param relativeTemplatePath - optional, the path of the required template relative to the ./templates folder. If not specified the root templates folder is returned.
- * @returns the path of the template specified or templates root folder
+ * @param relativeTemplatePath The path of the required template relative to the ./templates folder
+ * @returns The path of the template specified or templates root folder
  */
 function getTemplatePath(relativeTemplatePath) {
     return (0, node_path_1.join)(__dirname, '../templates', relativeTemplatePath);
 }
 /**
- * Convert an app name to an MTA ID that is suitable for CF deployment.
+ * Convert an app name to an MTA module name that is suitable for CF deployment.
  * Removes special characters that are not allowed in MTA module names.
+ * MTA module names can only contain: letters, numbers, dots (.), hyphens (-), and underscores (_).
  *
  * @param id Name of the app, like `sap.ux.app`
  * @returns Name that's acceptable in an mta.yaml (special characters removed)
  */
 function toMtaModuleName(id) {
     // Remove special characters not allowed in MTA module names
-    // Keep alphanumeric, underscore, hyphen, and dot
+    // Keep: alphanumeric, underscore, hyphen, and dot
+    // Remove: all other special characters including backticks, currency symbols, brackets, operators, etc.
     // Using replaceAll for global replacement (Sonar S7781)
     return id.replaceAll(/[`~!@#$%^&*£()|+=?;:'",.<>]/gi, '');
 }
@@ -69,9 +72,12 @@ function toPosixPath(dirPath) {
 }
 /**
  * Get the destination properties, based on the destination value.
+ * Retrieves destination configuration from SAP BTP when running in Business Application Studio.
  *
- * @param destination destination name
- * @returns Destination properties, default properties returned if not found
+ * @param destination The destination name to look up in BTP destination service
+ * @returns Object containing destination URL format flag and authentication type
+ * @returns {boolean} destinationIsFullUrl - True if destination uses full URL format
+ * @returns {Authentication | undefined} destinationAuthentication - Authentication type configured for the destination
  */
 async function getDestinationProperties(destination) {
     let destinationIsFullUrl = false;
@@ -99,8 +105,9 @@ async function getBTPDestinations() {
 /**
  * Validates the MTA version passed in the config.
  *
- * @param mtaVersion MTA version
- * @returns true if the version is valid
+ * @param mtaVersion MTA version to validate
+ * @returns True if the version is valid
+ * @throws {Error} If the MTA version is invalid or below minimum required version (0.0.1)
  */
 function validateVersion(mtaVersion) {
     const version = (0, semver_1.coerce)(mtaVersion);
@@ -112,12 +119,11 @@ function validateVersion(mtaVersion) {
 /**
  * Appends xs-security.json to the project folder.
  *
- * @param {MTABaseConfig} config - MTA base configuration
- * @param {string} config.mtaPath - Path to the MTA project
- * @param {string} config.mtaId - MTA ID
- * @param {Editor} fs - Reference to a mem-fs editor
- * @param {boolean} [addTenant] - If true, append tenant to the xs-security.json file
- * @returns {void}
+ * @param config MTA base configuration
+ * @param config.mtaPath Path to the MTA project
+ * @param config.mtaId MTA ID used for security configuration
+ * @param fs Reference to a mem-fs editor
+ * @param addTenant If true, append tenant configuration to the xs-security.json file (default: true)
  */
 function addXSSecurityConfig({ mtaPath, mtaId }, fs, addTenant = true) {
     fs.copyTpl(getTemplatePath(`common/${project_access_1.FileName.XSSecurityJson}`), (0, node_path_1.join)(mtaPath, project_access_1.FileName.XSSecurityJson), {
@@ -126,10 +132,10 @@ function addXSSecurityConfig({ mtaPath, mtaId }, fs, addTenant = true) {
     });
 }
 /**
- *  Append .gitignore to project folder.
+ * Appends .gitignore to project folder.
  *
  * @param targetPath Path to the project folder
- * @param fs reference to a mem-fs editor
+ * @param fs Reference to a mem-fs editor
  */
 function addGitIgnore(targetPath, fs) {
     fs.copyTpl(getTemplatePath('gitignore.tmpl'), (0, node_path_1.join)(targetPath, project_access_1.FileName.DotGitIgnore), {});
@@ -137,11 +143,10 @@ function addGitIgnore(targetPath, fs) {
 /**
  * Appends server package.json to the project folder.
  *
- * @param {MTABaseConfig} config - MTA base configuration
- * @param {string} config.mtaPath - Path to the MTA project
- * @param {string} config.mtaId - MTA ID
- * @param {Editor} fs - Reference to a mem-fs editor
- * @returns {void}
+ * @param config MTA base configuration
+ * @param config.mtaPath Path to the MTA project
+ * @param config.mtaId MTA ID used in package.json
+ * @param fs Reference to a mem-fs editor
  */
 function addRootPackage({ mtaPath, mtaId }, fs) {
     fs.copyTpl(getTemplatePath(project_access_1.FileName.Package), (0, node_path_1.join)(mtaPath, project_access_1.FileName.Package), {
@@ -152,7 +157,7 @@ function addRootPackage({ mtaPath, mtaId }, fs) {
  * Add common dependencies to the HTML5 app package.json.
  *
  * @param targetPath Path to the package.json file
- * @param fs reference to a mem-fs editor
+ * @param fs Reference to a mem-fs editor
  */
 async function addCommonPackageDependencies(targetPath, fs) {
     await (0, project_access_1.addPackageDevDependency)(targetPath, constants_1.UI5TaskZipperPackage, constants_1.UI5TaskZipperPackageVersion, fs);
@@ -161,9 +166,9 @@ async function addCommonPackageDependencies(targetPath, fs) {
 /**
  * Generate CF specific configurations to support deployment and undeployment.
  *
- * @param config writer configuration
- * @param fs reference to a mem-fs editor
- * @param addTenant If true, append tenant to the xs-security.json file
+ * @param config Writer configuration
+ * @param fs Reference to a mem-fs editor
+ * @param addTenant If true, append tenant configuration to the xs-security.json file (default: true)
  */
 async function generateSupportingConfig(config, fs, addTenant = true) {
     if (config.mtaId && !fs.exists((0, node_path_1.join)(config.mtaPath, 'package.json'))) {
@@ -180,7 +185,7 @@ async function generateSupportingConfig(config, fs, addTenant = true) {
 /**
  * Update the writer configuration with defaults.
  *
- * @param config writer configuration
+ * @param config Writer configuration to be updated with default values
  */
 function setMtaDefaults(config) {
     config.mtaPath = config.mtaPath.replace(/\/$/, '');
@@ -189,13 +194,12 @@ function setMtaDefaults(config) {
 }
 /**
  * Update the root package.json with scripts to deploy the MTA.
- *
  * Note: The fs editor is not passed to `addPackageDevDependency` since the package.json could be updated by other third party tools.
  *
- * @param {object} Options Input params
- * @param {string} Options.mtaId - MTA ID to be written to package.json
- * @param {string} Options.rootPath - MTA project path
- * @param fs - optional reference to a mem-fs editor
+ * @param options Input parameters
+ * @param options.mtaId MTA ID to be written to package.json
+ * @param options.rootPath MTA project path
+ * @param fs Reference to a mem-fs editor
  */
 async function updateRootPackage({ mtaId, rootPath }, fs) {
     const packageExists = fileExists(fs, (0, node_path_1.join)(rootPath, project_access_1.FileName.Package));
@@ -241,7 +245,7 @@ function enforceValidRouterConfig(config) {
  * Append devDependency if missing, required by mta `cds build` step.
  *
  * @param rootPath Path to the project folder
- * @param fs reference to a mem-fs editor
+ * @param fs Reference to a mem-fs editor
  */
 async function alignCdsVersions(rootPath, fs) {
     const filePath = (0, node_path_1.join)(rootPath, project_access_1.FileName.Package);
@@ -255,12 +259,10 @@ async function alignCdsVersions(rootPath, fs) {
 /**
  * Executes a command in the specified project directory.
  *
- * @async
- * @param {string} cwd - Working directory where the command will be executed
- * @param {string} cmd - Command to execute
- * @param {string[]} args - Arguments to pass to the command
- * @param {string} errorMsg - Error message prefix to display if the command fails
- * @returns {Promise<void>} - A promise that resolves when the command completes successfully
+ * @param cwd Working directory where the command will be executed
+ * @param cmd Command to execute
+ * @param args Arguments to pass to the command
+ * @param errorMsg Error message prefix to display if the command fails
  * @throws {Error} Throws an error with the provided error message concatenated with the original error if execution fails
  * @example
  * // Execute npm install in the project directory
@@ -279,9 +281,9 @@ async function runCommand(cwd, cmd, args, errorMsg) {
 /**
  * Check if a file exists in the file system.
  *
- * @param fs reference to a mem-fs editor
+ * @param fs Reference to a mem-fs editor
  * @param filePath Path to the file
- * @returns true if the file exists, false otherwise
+ * @returns True if the file exists, false otherwise
  */
 function fileExists(fs, filePath) {
     return fs.exists(filePath);

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@sap-ux/cf-deploy-config-writer",
   "description": "Add or amend Cloud Foundry and ABAP deployment configuration for SAP projects",
-  "version": "0.3.82",
+  "version": "0.3.83",
   "repository": {
     "type": "git",
     "url": "https://github.com/SAP/open-ux-tools.git",