@sap-ux/cf-deploy-config-sub-generator 0.1.9 → 0.1.11

package/generators/app/index.d.ts

@@ -2,8 +2,8 @@ import { DeploymentGenerator } from '@sap-ux/deploy-config-generator-shared';
 import { DESTINATION_AUTHTYPE_NOTFOUND, API_BUSINESS_HUB_ENTERPRISE_PREFIX } from '../utils';
 import { loadManifest } from './utils';
 import { getCFQuestions } from './questions';
-import type { CfDeployConfigOptions } from './types';
-import type { CfDeployConfigAnswers } from '@sap-ux/cf-deploy-config-inquirer';
+import { CfDeployConfigOptions } from './types';
+import { CfDeployConfigAnswers } from '@sap-ux/cf-deploy-config-inquirer';
 /**
  * Cloud Foundry deployment configuration generator.
  */
@@ -18,6 +18,7 @@ export default class extends DeploymentGenerator {
     private readonly cloudServiceName?;
     private readonly serviceBase?;
     private answers;
+    private appRouterAnswers;
     private projectRoot;
     private mtaPath?;
     private isCap;
@@ -47,6 +48,7 @@ export default class extends DeploymentGenerator {
      */
     private _processProjectConfigs;
     prompting(): Promise<void>;
+    private _prompting;
     /**
      * Handles specific logic for api hub configurations.
      */

package/generators/app/index.js

@@ -19,6 +19,7 @@ const project_access_1 = require("@sap-ux/project-access");
 const telemetryEvents_1 = require("../telemetryEvents");
 const questions_1 = require("./questions");
 Object.defineProperty(exports, "getCFQuestions", { enumerable: true, get: function () { return questions_1.getCFQuestions; } });
+const inquirer_common_1 = require("@sap-ux/inquirer-common");
 /**
  * Cloud Foundry deployment configuration generator.
  */
@@ -33,6 +34,7 @@ class default_1 extends deploy_config_generator_shared_1.DeploymentGenerator {
     cloudServiceName;
     serviceBase;
     answers = {};
+    appRouterAnswers;
     projectRoot;
     mtaPath;
     isCap = false;
@@ -56,7 +58,7 @@ class default_1 extends deploy_config_generator_shared_1.DeploymentGenerator {
         this.vscode = opts.vscode;
         this.options = opts;
         this.destinationName = opts.destinationName ?? '';
-        this.addMtaDestination = opts.addMTADestination ?? false; // by default it's false unless passed in i.e. headless flow
+        this.addMtaDestination = opts.addMTADestination ?? false; // by default, it's false unless passed in i.e. headless flow
         this.lcapModeOnly = opts.lcapModeOnly ?? false;
         this.cloudServiceName = opts.cloudServiceName || undefined;
         this.apiHubConfig = opts.apiHubConfig;
@@ -83,6 +85,9 @@ class default_1 extends deploy_config_generator_shared_1.DeploymentGenerator {
         if (!this.launchDeployConfigAsSubGenerator) {
             await this._init();
         }
+        else {
+            await this._processProjectConfigs();
+        }
     }
     async _init() {
         // mta executable is required as mta-lib is used
@@ -105,7 +110,7 @@ class default_1 extends deploy_config_generator_shared_1.DeploymentGenerator {
     async _processProjectPaths() {
         const mtaPathResult = await (0, project_access_1.getMtaPath)(this.appPath);
         this.mtaPath = mtaPathResult?.mtaPath;
-        const capRoot = await (0, project_access_1.findCapProjectRoot)(this.appPath);
+        const capRoot = await (0, project_access_1.findCapProjectRoot)(this.appPath, true, this.fs);
         if (capRoot) {
             if (!hasbin.sync(deploy_config_generator_shared_1.cdsExecutable)) {
                 (0, deploy_config_generator_shared_1.bail)(deploy_config_generator_shared_1.ErrorHandler.getErrorMsgFromType(deploy_config_generator_shared_1.ERROR_TYPE.NO_CDS_BIN));
@@ -133,18 +138,38 @@ class default_1 extends deploy_config_generator_shared_1.DeploymentGenerator {
         if (this.abort) {
             return;
         }
-        if (this.isCap && this.projectRoot && !this.mtaPath) {
-            // if the user is adding deploy config to a CAP project and there is no mta.yaml in the root, then log error and exit
-            this.abort = true;
-            (0, deploy_config_generator_shared_1.handleErrorMessage)(this.appWizard, { errorType: deploy_config_generator_shared_1.ERROR_TYPE.CAP_DEPLOYMENT_NO_MTA });
-            return;
-        }
         if (!this.launchDeployConfigAsSubGenerator) {
+            await this._prompting();
+        }
+        await this._reconcileAnswersWithOptions();
+    }
+    async _prompting() {
+        const isCAPMissingMTA = this.isCap && this.projectRoot && !this.mtaPath;
+        if (isCAPMissingMTA) {
+            deploy_config_generator_shared_1.DeploymentGenerator.logger?.debug((0, utils_1.t)('cfGen.debug.capMissingMTA'));
+            // If launched as root generator, add a prompt to allow user decide if they want to add an MTA config
+            let questions = (await (0, questions_1.getCFApprouterQuestionsForCap)({
+                projectRoot: this.projectRoot ?? process.cwd()
+            }));
+            questions = (0, inquirer_common_1.withCondition)(questions, (answers) => answers.addCapMtaContinue === true);
+            questions.unshift(...(0, deploy_config_generator_shared_1.getConfirmMtaContinuePrompt)());
+            this.appRouterAnswers = (await this.prompt(questions));
+            if (this.appRouterAnswers.addCapMtaContinue !== true) {
+                this.abort = true;
+                return;
+            }
+            // Configure defaults
+            this.destinationName = cf_deploy_config_writer_1.DefaultMTADestination;
+            this.options.overwrite = true; // Don't prompt the user to overwrite files we've just written!
+            this.answers = {};
+            this.answers.destinationName = this.destinationName;
+            this.answers.addManagedAppRouter = false;
+        }
+        else {
             await this._handleApiHubConfig();
             const questions = await this._getCFQuestions();
             this.answers = await this.prompt(questions);
         }
-        await this._reconcileAnswersWithOptions();
     }
     /**
      * Handles specific logic for api hub configurations.
@@ -203,8 +228,12 @@ class default_1 extends deploy_config_generator_shared_1.DeploymentGenerator {
     }
     async _writing() {
         try {
-            const appConfig = this._getAppConfig();
-            await (0, cf_deploy_config_writer_1.generateAppConfig)(appConfig, this.fs, deploy_config_generator_shared_1.DeploymentGenerator.logger);
+            // Step1. (Optional) Generate CAP MTA with specific approuter type managed | standalone
+            if (this.appRouterAnswers) {
+                await (0, cf_deploy_config_writer_1.generateCAPConfig)(this.appRouterAnswers, this.fs, deploy_config_generator_shared_1.DeploymentGenerator.logger);
+            }
+            // Step2. Append HTML5 app to MTA
+            await (0, cf_deploy_config_writer_1.generateAppConfig)(this._getAppConfig(), this.fs, deploy_config_generator_shared_1.DeploymentGenerator.logger);
         }
         catch (error) {
             this.abort = true;

package/generators/app/questions.d.ts

@@ -1,5 +1,5 @@
+import { type CfAppRouterDeployConfigQuestions, type CfDeployConfigQuestions } from '@sap-ux/cf-deploy-config-inquirer';
 import type { ApiHubConfig } from '@sap-ux/cf-deploy-config-writer';
-import type { CfDeployConfigQuestions } from '@sap-ux/cf-deploy-config-inquirer';
 /**
  * Fetches the Cloud Foundry deployment configuration questions.
  *
@@ -20,4 +20,14 @@ export declare function getCFQuestions({ projectRoot, isAbapDirectServiceBinding
     addOverwrite: boolean;
     apiHubConfig?: ApiHubConfig;
 }): Promise<CfDeployConfigQuestions[]>;
+/**
+ * Retrieve the CF Approuter questions, certain prompts are restricted to support CAP project.
+ *
+ * @param options - the options required for retrieving the prompts.
+ * @param options.projectRoot - the root path of the project.
+ * @returns the cf approuter config questions.
+ */
+export declare function getCFApprouterQuestionsForCap({ projectRoot }: {
+    projectRoot: string;
+}): Promise<CfAppRouterDeployConfigQuestions[]>;
 //# sourceMappingURL=questions.d.ts.map

package/generators/app/questions.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getCFQuestions = void 0;
+exports.getCFApprouterQuestionsForCap = exports.getCFQuestions = void 0;
 const btp_utils_1 = require("@sap-ux/btp-utils");
 const deploy_config_generator_shared_1 = require("@sap-ux/deploy-config-generator-shared");
 const project_access_1 = require("@sap-ux/project-access");
@@ -45,4 +45,25 @@ async function getCFQuestions({ projectRoot, isAbapDirectServiceBinding, cfDesti
     return (0, cf_deploy_config_inquirer_1.getPrompts)(options);
 }
 exports.getCFQuestions = getCFQuestions;
+/**
+ * Retrieve the CF Approuter questions, certain prompts are restricted to support CAP project.
+ *
+ * @param options - the options required for retrieving the prompts.
+ * @param options.projectRoot - the root path of the project.
+ * @returns the cf approuter config questions.
+ */
+async function getCFApprouterQuestionsForCap({ projectRoot }) {
+    // Disable some prompts, not required for CAP flow
+    const appRouterPromptOptions = {
+        [cf_deploy_config_inquirer_1.appRouterPromptNames.mtaPath]: projectRoot,
+        [cf_deploy_config_inquirer_1.appRouterPromptNames.mtaId]: true,
+        [cf_deploy_config_inquirer_1.appRouterPromptNames.mtaDescription]: false,
+        [cf_deploy_config_inquirer_1.appRouterPromptNames.mtaVersion]: false,
+        [cf_deploy_config_inquirer_1.appRouterPromptNames.routerType]: true,
+        [cf_deploy_config_inquirer_1.appRouterPromptNames.addConnectivityService]: true,
+        [cf_deploy_config_inquirer_1.appRouterPromptNames.addABAPServiceBinding]: false
+    };
+    return (0, cf_deploy_config_inquirer_1.getAppRouterPrompts)(appRouterPromptOptions);
+}
+exports.getCFApprouterQuestionsForCap = getCFApprouterQuestionsForCap;
 //# sourceMappingURL=questions.js.map

package/generators/app/types.d.ts

@@ -1,5 +1,5 @@
 import type { AppWizard } from '@sap-devx/yeoman-ui-types';
-import type { CfDeployConfigAnswers } from '@sap-ux/cf-deploy-config-inquirer';
+import { type CfDeployConfigAnswers } from '@sap-ux/cf-deploy-config-inquirer';
 import type { ApiHubConfig } from '@sap-ux/cf-deploy-config-writer';
 import type { TelemetryData } from '@sap-ux/fiori-generator-shared';
 export interface CfDeployConfigOptions extends CfDeployConfigAnswers {
@@ -83,5 +83,9 @@ export interface CfDeployConfigOptions extends CfDeployConfigAnswers {
      * Telemetry data to be send after deployment configuration has been added
      */
     telemetryData?: TelemetryData;
+    /**
+     * Option to invoke the getConfirmMtaContinue prompt
+     */
+    addCapMtaContinue?: boolean;
 }
 //# sourceMappingURL=types.d.ts.map

package/generators/translations/cf-deploy-config-sub-generator.i18n.json

@@ -26,7 +26,8 @@
         },
         "debug": {
             "promptOptions": "Retrieving CF prompts using: \n {{- options}}",
-            "initTelemetry": "Initializing telemetry in CF deployment configuration generator"
+            "initTelemetry": "Initializing telemetry in CF deployment configuration generator",
+            "capMissingMTA": "CAP project detected with no MTA configuration"
         }
     },
     "appRouterGen": {

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@sap-ux/cf-deploy-config-sub-generator",
   "description": "Generators for configuring Cloud Foundry deployment configuration",
-  "version": "0.1.9",
+  "version": "0.1.11",
   "repository": {
     "type": "git",
     "url": "https://github.com/SAP/open-ux-tools.git",
@@ -24,13 +24,13 @@
     "i18next": "23.5.1",
     "yeoman-generator": "5.10.0",
     "@sap-ux/btp-utils": "1.0.1",
-    "@sap-ux/cf-deploy-config-writer": "0.1.11",
-    "@sap-ux/cf-deploy-config-inquirer": "0.2.6",
-    "@sap-ux/deploy-config-generator-shared": "0.0.25",
+    "@sap-ux/cf-deploy-config-writer": "0.1.12",
+    "@sap-ux/cf-deploy-config-inquirer": "0.2.8",
+    "@sap-ux/deploy-config-generator-shared": "0.0.27",
     "@sap-ux/feature-toggle": "0.2.3",
-    "@sap-ux/fiori-generator-shared": "0.8.1",
+    "@sap-ux/fiori-generator-shared": "0.9.0",
     "@sap-ux/i18n": "0.2.1",
-    "@sap-ux/inquirer-common": "0.6.18",
+    "@sap-ux/inquirer-common": "0.6.19",
     "@sap-ux/project-access": "1.29.8",
     "@sap-ux/ui5-config": "0.26.2"
   },