@sap-ux/cf-deploy-config-writer 0.2.10 → 0.2.12

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

@@ -157,8 +157,6 @@ async function generateDeployConfig(cfAppConfig, fs) {
     // Generate MTA Config, LCAP will generate the mta.yaml on the fly so we don't care about it!
     if (!config.lcapMode) {
         await generateMTAFile(config, fs);
-        await (0, utils_1.generateSupportingConfig)(config, fs);
-        await updateMtaConfig(config, fs);
     }
     // Generate HTML5 config
     await appendCloudFoundryConfigurations(config, fs);
@@ -175,6 +173,7 @@ async function generateDeployConfig(cfAppConfig, fs) {
  * @param fs reference to a mem-fs editor
  */
 async function generateMTAFile(cfConfig, fs) {
+    // Step1. Create mta.yaml
     if (!cfConfig.mtaId) {
         if (cfConfig.isCap) {
             await (0, mta_config_1.generateCAPMTA)({ ...cfConfig, mtaPath: cfConfig.rootPath }, fs);
@@ -185,14 +184,18 @@ async function generateMTAFile(cfConfig, fs) {
         cfConfig.mtaId = cfConfig.appId;
         cfConfig.mtaPath = cfConfig.rootPath;
     }
+    // Step2. Append the approuter and destination to mta.yaml
+    await appendAppRouter(cfConfig, fs);
+    // Step3. Create any missing resources like package.json / xs-security.json / .gitignore
+    await (0, utils_1.generateSupportingConfig)(cfConfig, fs);
 }
 /**
- * Updates the MTA configuration file.
+ * Updates the MTA configuration file with the app router and destination.
  *
  * @param cfConfig writer configuration
  * @param fs reference to a mem-fs editor
  */
-async function updateMtaConfig(cfConfig, fs) {
+async function appendAppRouter(cfConfig, fs) {
     const mtaInstance = await (0, mta_config_1.getMtaConfig)(cfConfig.rootPath);
     if (mtaInstance) {
         await mtaInstance.addRoutingModules({
@@ -203,23 +206,13 @@ async function updateMtaConfig(cfConfig, fs) {
         const appModule = cfConfig.appId;
         const appRelativePath = (0, utils_1.toPosixPath)((0, path_1.relative)(cfConfig.rootPath, cfConfig.appPath));
         await mtaInstance.addApp(appModule, appRelativePath ?? '.');
-        if (mtaInstance.hasAppFrontendRouter()) {
-            cfConfig.addAppFrontendRouter = true;
-        }
-        await (0, mta_config_1.addMtaDeployParameters)(mtaInstance);
         if ((cfConfig.addMtaDestination && cfConfig.isCap) || cfConfig.destinationName === constants_1.DefaultMTADestination) {
             // If the destination instance identifier is passed, create a destination instance
             cfConfig.destinationName =
                 cfConfig.destinationName === constants_1.DefaultMTADestination
                     ? mtaInstance.getFormattedPrefix(constants_1.ResourceMTADestination)
                     : cfConfig.destinationName;
-            if (cfConfig.addAppFrontendRouter) {
-                // Append destination directly to app frontend
-                await mtaInstance.appendAppfrontCAPDestination(cfConfig.destinationName);
-            }
-            else {
-                await mtaInstance.appendInstanceBasedDestination(cfConfig.destinationName);
-            }
+            await mtaInstance.addDestinationToAppRouter(cfConfig.destinationName);
             // This is required where a managed or standalone router hasn't been added yet to mta.yaml
             if (!mtaInstance.hasManagedXsuaaResource()) {
                 cfConfig.destinationAuthentication = btp_utils_1.Authentication.NO_AUTHENTICATION;
@@ -227,7 +220,9 @@ async function updateMtaConfig(cfConfig, fs) {
         }
         cleanupStandaloneRoutes(cfConfig, mtaInstance, fs);
         await saveMta(cfConfig, mtaInstance);
+        // Modify existing config, required in later steps
         cfConfig.cloudServiceName = mtaInstance.cloudServiceName;
+        cfConfig.addAppFrontendRouter = mtaInstance.hasAppFrontendRouter();
     }
 }
 /**

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

@@ -2,7 +2,7 @@ import { type Editor } from 'mem-fs-editor';
 import { type Logger } from '@sap-ux/logger';
 import { type CFBaseConfig } from '../types';
 /**
- * Add a standalone | managed | app frontend approuter to an empty target folder.
+ * 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

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

@@ -4,15 +4,15 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.generateBaseConfig = generateBaseConfig;
+const path_1 = require("path");
 const mem_fs_1 = require("mem-fs");
 const mem_fs_editor_1 = require("mem-fs-editor");
 const utils_1 = require("../utils");
 const logger_helper_1 = __importDefault(require("../logger-helper"));
 const mta_config_1 = require("../mta-config");
-const path_1 = require("path");
 const i18n_1 = require("../i18n");
 /**
- * Add a standalone | managed | app frontend approuter to an empty target folder.
+ * 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
@@ -33,7 +33,7 @@ async function generateBaseConfig(config, fs, logger) {
     }
     (0, mta_config_1.createMTA)(config);
     await (0, mta_config_1.addRoutingConfig)(config, fs);
-    (0, utils_1.addSupportingConfig)(config, fs);
+    await (0, utils_1.generateSupportingConfig)(config, fs);
     logger_helper_1.default.logger?.debug(`CF Config ${JSON.stringify(config, null, 2)}`);
     return fs;
 }

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

@@ -28,18 +28,6 @@ export declare function toMtaModuleName(appId: string): string;
  * @param config writer configuration
  */
 export declare function createMTA(config: MTABaseConfig): void;
-/**
- *  Add the build parameters to the MTA configuration.
- *
- * @param mtaInstance MTA instance
- */
-export declare function addMtaBuildParams(mtaInstance: MtaConfig): Promise<void>;
-/**
- * Add the deployment parameters to the MTA configuration.
- *
- * @param mtaInstance MTA instance
- */
-export declare function addMtaDeployParameters(mtaInstance: MtaConfig): Promise<void>;
 /**
  * Validate MTA binary is available.
  *
@@ -57,7 +45,7 @@ export declare function doesCDSBinaryExist(): void;
  */
 export declare function validateMtaConfig(config: CFBaseConfig): void;
 /**
- * Add standalone | managed | appfront approuter to the target folder.
+ * Add standalone | managed | frontend app router to the target folder.
  *
  * @param config writer configuration
  * @param fs reference to a mem-fs editor

package/dist/mta-config/index.js

@@ -21,8 +21,6 @@ exports.getMtaId = getMtaId;
 exports.getMtaConfig = getMtaConfig;
 exports.toMtaModuleName = toMtaModuleName;
 exports.createMTA = createMTA;
-exports.addMtaBuildParams = addMtaBuildParams;
-exports.addMtaDeployParameters = addMtaDeployParameters;
 exports.doesMTABinaryExist = doesMTABinaryExist;
 exports.doesCDSBinaryExist = doesCDSBinaryExist;
 exports.validateMtaConfig = validateMtaConfig;
@@ -87,41 +85,18 @@ function toMtaModuleName(appId) {
  * @param config writer configuration
  */
 function createMTA(config) {
+    const mtaId = `${config.mtaId.slice(0, 128)}`;
     const mtaTemplate = (0, fs_1.readFileSync)((0, utils_1.getTemplatePath)(`app/${project_access_1.FileName.MtaYaml}`), 'utf-8');
     const mtaContents = (0, ejs_1.render)(mtaTemplate, {
-        id: `${config.mtaId.slice(0, 128)}`,
+        id: mtaId,
         mtaDescription: config.mtaDescription ?? constants_1.MTADescription,
         mtaVersion: config.mtaVersion ?? constants_1.MTAVersion
     });
+    config.mtaId = mtaId;
     // Written to disk immediately! Subsequent calls are dependent on it being on the file system i.e mta-lib.
     (0, fs_1.writeFileSync)((0, path_1.join)(config.mtaPath, project_access_1.FileName.MtaYaml), mtaContents);
     logger_helper_1.default.logger?.debug((0, i18n_1.t)('debug.mtaCreated', { mtaPath: config.mtaPath }));
 }
-/**
- *  Add the build parameters to the MTA configuration.
- *
- * @param mtaInstance MTA instance
- */
-async function addMtaBuildParams(mtaInstance) {
-    let params = await mtaInstance.getBuildParameters();
-    params = { ...(params || {}), ...{} };
-    params['before-all'] ||= [];
-    const buildParams = { builder: 'custom', commands: ['npm install'] };
-    params['before-all'].push(buildParams);
-    await mtaInstance.updateBuildParams(params);
-}
-/**
- * Add the deployment parameters to the MTA configuration.
- *
- * @param mtaInstance MTA instance
- */
-async function addMtaDeployParameters(mtaInstance) {
-    let params = await mtaInstance.getParameters();
-    params = { ...(params || {}), ...{} };
-    params[constants_1.deployMode] = 'html5-repo';
-    params[constants_1.enableParallelDeployments] = true;
-    await mtaInstance.updateParameters(params);
-}
 /**
  * Validate MTA binary is available.
  *
@@ -189,7 +164,7 @@ async function createCAPMTAAppFrontend(config, fs) {
     logger_helper_1.default.logger?.debug((0, i18n_1.t)('debug.mtaCreated', { mtaPath: config.mtaPath }));
 }
 /**
- *  Add standalone approuter to the target folder.
+ *  Add standalone app router to the target folder.
  *
  * @param cfConfig writer configuration
  * @param mtaInstance MTA configuration instance
@@ -223,7 +198,7 @@ async function addStandaloneRouter(cfConfig, mtaInstance, fs) {
     }
 }
 /**
- * Add standalone | managed | appfront approuter to the target folder.
+ * Add standalone | managed | frontend app router to the target folder.
  *
  * @param config writer configuration
  * @param fs reference to a mem-fs editor
@@ -237,7 +212,6 @@ async function addRoutingConfig(config, fs) {
         else {
             await mtaConfigInstance.addRouterType({ routerType: config.routerType, addMissingModules: false });
         }
-        await addMtaDeployParameters(mtaConfigInstance);
         await mtaConfigInstance.save();
         logger_helper_1.default.logger?.debug((0, i18n_1.t)('debug.capMtaUpdated'));
     }

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

@@ -236,19 +236,26 @@ export declare class MtaConfig {
         key: string;
         value: string;
     }): Promise<void>;
+    /**
+     * Add a destination to the approuter.
+     *
+     * @param cfDestination The name of the destination to be appended
+     * @returns {void}
+     */
+    addDestinationToAppRouter(cfDestination: string | undefined): Promise<void>;
     /**
      *  Add destination to App Frontend router.
      *
      * @param cfDestination Then name of the destination to be appended
      */
-    appendAppfrontCAPDestination(cfDestination: string | undefined): Promise<void>;
+    private appendAppfrontCAPDestination;
     /**
      * Append a destination instance to the mta.yaml file, required by consumers of CAP services when using Standalone or Managed approuter.
      *
      * @param {string} cfDestination The new destination instance name
      * @returns {Promise<void>} A promise that resolves when the change request has been processed
      */
-    appendInstanceBasedDestination(cfDestination: string | undefined): Promise<void>;
+    private appendInstanceBasedDestination;
     /**
      * Save changes to the mta.yaml file.
      *
@@ -280,11 +287,21 @@ export declare class MtaConfig {
      */
     getFormattedPrefix(formatString: string): string;
     /**
-     * Retrieve the app-content module, different types can be found.
+     * Retrieve the app-content module, different types can be found depending on the router type configuration.
      *
      * @returns {mta.Module} return the app-content module
      */
     private getAppContentModule;
+    /**
+     *  Add the build parameters to the MTA configuration.
+     *
+     */
+    addMtaBuildParameters(): Promise<void>;
+    /**
+     * Add the deployment parameters to the MTA configuration.
+     *
+     */
+    addMtaDeployParameters(): Promise<void>;
 }
 /**
  * Returns true if there's an MTA configuration file in the supplied directory.

package/dist/mta-config/mta.js

@@ -520,6 +520,7 @@ class MtaConfig {
             this.log?.debug((0, i18n_1.t)('debug.html5AppAdded', { appName }));
         }
         await this.syncHtml5Apps();
+        await this.addMtaDeployParameters();
     }
     async syncHtml5Apps() {
         // Need to handle where existing HTML5 apps are added by `cds` which follow a different naming convention when added to mta
@@ -596,6 +597,7 @@ class MtaConfig {
             }
             await this.cleanupModules();
         }
+        await this.addMtaDeployParameters();
     }
     /**
      * Append different routers to mta configuration.
@@ -801,6 +803,21 @@ class MtaConfig {
             }
         }
     }
+    /**
+     * Add a destination to the approuter.
+     *
+     * @param cfDestination The name of the destination to be appended
+     * @returns {void}
+     */
+    async addDestinationToAppRouter(cfDestination) {
+        if (this.hasAppFrontendRouter()) {
+            // Append destination directly to app frontend
+            await this.appendAppfrontCAPDestination(cfDestination);
+        }
+        else {
+            await this.appendInstanceBasedDestination(cfDestination);
+        }
+    }
     /**
      *  Add destination to App Frontend router.
      *
@@ -1039,7 +1056,7 @@ class MtaConfig {
         return (0, util_1.format)(formatString, this.prefix).replace(/[^\w-]/g, '_');
     }
     /**
-     * Retrieve the app-content module, different types can be found.
+     * Retrieve the app-content module, different types can be found depending on the router type configuration.
      *
      * @returns {mta.Module} return the app-content module
      */
@@ -1048,6 +1065,30 @@ class MtaConfig {
         return (this.modules.get('com.sap.application.content:resource') ??
             this.modules.get('com.sap.application.content:appfront'));
     }
+    /**
+     *  Add the build parameters to the MTA configuration.
+     *
+     */
+    async addMtaBuildParameters() {
+        const params = (await this.getBuildParameters()) ?? {};
+        params['before-all'] ??= [];
+        params['before-all'].push({
+            builder: 'custom',
+            commands: ['npm install']
+        });
+        await this.updateBuildParams(params);
+    }
+    /**
+     * Add the deployment parameters to the MTA configuration.
+     *
+     */
+    async addMtaDeployParameters() {
+        let params = await this.getParameters();
+        params = { ...(params ?? {}), ...{} };
+        params[constants_1.deployMode] = 'html5-repo';
+        params[constants_1.enableParallelDeployments] = true;
+        await this.updateParameters(params);
+    }
 }
 exports.MtaConfig = MtaConfig;
 /**

package/dist/utils.d.ts

@@ -1,7 +1,7 @@
+import type { Editor } from 'mem-fs-editor';
 import { type Authentication, type Destinations } from '@sap-ux/btp-utils';
 import { type Manifest } from '@sap-ux/project-access';
-import type { Editor } from 'mem-fs-editor';
-import { type MTABaseConfig, type CFConfig, type CFBaseConfig, type CFAppConfig } from './types';
+import { type MTABaseConfig, type CFBaseConfig, type CFAppConfig } from './types';
 /**
  *  Read manifest file for processing.
  *
@@ -56,13 +56,14 @@ export declare function getBTPDestinations(): Promise<Destinations>;
  */
 export declare function validateVersion(mtaVersion?: string): boolean;
 /**
- *  Append xs-security.json to project folder.
+ * Appends xs-security.json to the project folder.
  *
- * @param root0 MTA base configuration
- * @param root0.mtaPath Path to the MTA project
- * @param root0.mtaId MTA ID
- * @param fs reference to a mem-fs editor
- * @param addTenant If true, append tenant to the xs-security.json file
+ * @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}
  */
 export declare function addXSSecurityConfig({ mtaPath, mtaId }: MTABaseConfig, fs: Editor, addTenant?: boolean): void;
 /**
@@ -73,12 +74,13 @@ export declare function addXSSecurityConfig({ mtaPath, mtaId }: MTABaseConfig, f
  */
 export declare function addGitIgnore(targetPath: string, fs: Editor): void;
 /**
- * Append server package.json to project folder.
+ * Appends server package.json to the project folder.
  *
- * @param root0 MTA base configuration
- * @param root0.mtaPath Path to the MTA project
- * @param root0.mtaId MTA ID
- * @param fs reference to a mem-fs editor
+ * @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}
  */
 export declare function addRootPackage({ mtaPath, mtaId }: MTABaseConfig, fs: Editor): void;
 /**
@@ -93,15 +95,9 @@ export declare function addCommonPackageDependencies(targetPath: string, fs: Edi
  *
  * @param config writer configuration
  * @param fs reference to a mem-fs editor
+ * @param addTenant If true, append tenant to the xs-security.json file
  */
-export declare function generateSupportingConfig(config: CFConfig, fs: Editor): Promise<void>;
-/**
- * Add supporting configuration to the target folder.
- *
- * @param config writer configuration
- * @param fs reference to a mem-fs editor
- */
-export declare function addSupportingConfig(config: MTABaseConfig, fs: Editor): void;
+export declare function generateSupportingConfig(config: MTABaseConfig, fs: Editor, addTenant?: boolean): Promise<void>;
 /**
  * Update the writer configuration with defaults.
  *

package/dist/utils.js

@@ -12,7 +12,6 @@ exports.addGitIgnore = addGitIgnore;
 exports.addRootPackage = addRootPackage;
 exports.addCommonPackageDependencies = addCommonPackageDependencies;
 exports.generateSupportingConfig = generateSupportingConfig;
-exports.addSupportingConfig = addSupportingConfig;
 exports.setMtaDefaults = setMtaDefaults;
 exports.updateRootPackage = updateRootPackage;
 exports.enforceValidRouterConfig = enforceValidRouterConfig;
@@ -21,10 +20,10 @@ exports.runCommand = runCommand;
 exports.fileExists = fileExists;
 const path_1 = require("path");
 const semver_1 = require("semver");
+const nodejs_utils_1 = require("@sap-ux/nodejs-utils");
 const btp_utils_1 = require("@sap-ux/btp-utils");
 const project_access_1 = require("@sap-ux/project-access");
 const constants_1 = require("./constants");
-const nodejs_utils_1 = require("@sap-ux/nodejs-utils");
 let cachedDestinationsList = {};
 /**
  *  Read manifest file for processing.
@@ -107,13 +106,14 @@ function validateVersion(mtaVersion) {
     return true;
 }
 /**
- *  Append xs-security.json to project folder.
+ * Appends xs-security.json to the project folder.
  *
- * @param root0 MTA base configuration
- * @param root0.mtaPath Path to the MTA project
- * @param root0.mtaId MTA ID
- * @param fs reference to a mem-fs editor
- * @param addTenant If true, append tenant to the xs-security.json file
+ * @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}
  */
 function addXSSecurityConfig({ mtaPath, mtaId }, fs, addTenant = true) {
     fs.copyTpl(getTemplatePath(`common/${project_access_1.FileName.XSSecurityJson}`), (0, path_1.join)(mtaPath, project_access_1.FileName.XSSecurityJson), {
@@ -131,16 +131,17 @@ function addGitIgnore(targetPath, fs) {
     fs.copyTpl(getTemplatePath('gitignore.tmpl'), (0, path_1.join)(targetPath, project_access_1.FileName.DotGitIgnore), {});
 }
 /**
- * Append server package.json to project folder.
+ * Appends server package.json to the project folder.
  *
- * @param root0 MTA base configuration
- * @param root0.mtaPath Path to the MTA project
- * @param root0.mtaId MTA ID
- * @param fs reference to a mem-fs editor
+ * @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}
  */
 function addRootPackage({ mtaPath, mtaId }, fs) {
     fs.copyTpl(getTemplatePath(project_access_1.FileName.Package), (0, path_1.join)(mtaPath, project_access_1.FileName.Package), {
-        mtaId: mtaId
+        mtaId
     });
 }
 /**
@@ -158,33 +159,20 @@ async function addCommonPackageDependencies(targetPath, fs) {
  *
  * @param config writer configuration
  * @param fs reference to a mem-fs editor
+ * @param addTenant If true, append tenant to the xs-security.json file
  */
-async function generateSupportingConfig(config, fs) {
-    const mtaConfig = { mtaId: config.mtaId, mtaPath: config.rootPath };
-    if (mtaConfig.mtaId && !fileExists(fs, (0, path_1.join)(config.rootPath, project_access_1.FileName.Package))) {
-        addRootPackage(mtaConfig, fs);
+async function generateSupportingConfig(config, fs, addTenant = true) {
+    if (config.mtaId && !fs.exists((0, path_1.join)(config.mtaPath, 'package.json'))) {
+        addRootPackage(config, fs);
     }
-    if ((config.addManagedAppRouter || config.addAppFrontendRouter) &&
-        mtaConfig.mtaId &&
-        !fileExists(fs, (0, path_1.join)(config.rootPath, project_access_1.FileName.XSSecurityJson))) {
-        addXSSecurityConfig(mtaConfig, fs, true);
+    if (config.mtaId && !fs.exists((0, path_1.join)(config.mtaPath, project_access_1.FileName.XSSecurityJson))) {
+        addXSSecurityConfig(config, fs, addTenant);
     }
     // Be a good citizen and add a .gitignore if missing from the existing project root
-    if (!fileExists(fs, (0, path_1.join)(config.rootPath, project_access_1.FileName.DotGitIgnore))) {
-        addGitIgnore(config.rootPath, fs);
+    if (!fs.exists((0, path_1.join)(config.mtaPath, '.gitignore'))) {
+        addGitIgnore(config.mtaPath, fs);
     }
 }
-/**
- * Add supporting configuration to the target folder.
- *
- * @param config writer configuration
- * @param fs reference to a mem-fs editor
- */
-function addSupportingConfig(config, fs) {
-    addRootPackage(config, fs);
-    addGitIgnore(config.mtaPath, fs);
-    addXSSecurityConfig(config, fs);
-}
 /**
  * Update the writer configuration with defaults.
  *

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.2.10",
+  "version": "0.2.12",
   "repository": {
     "type": "git",
     "url": "https://github.com/SAP/open-ux-tools.git",

package/templates/package.json

@@ -1,5 +1,5 @@
 {
-  "name": "mta-project",
+  "name": "<%- mtaId %>",
   "version": "0.0.1",
   "description": "Build and deployment scripts",
   "scripts": {