@sap-ux/cf-deploy-config-inquirer 0.2.21 → 0.2.23

package/dist/index.d.ts

@@ -1,4 +1,4 @@
-import type { CfDeployConfigPromptOptions, CfDeployConfigQuestions, CfSystemChoice, CfDeployConfigAnswers, CfAppRouterDeployConfigPromptOptions, CfAppRouterDeployConfigQuestions, CfAppRouterDeployConfigAnswers } from './types';
+import type { CfDeployConfigPromptOptions, CfDeployConfigQuestions, CfSystemChoice, CfDeployConfigAnswers, CfAppRouterDeployConfigPromptOptions, CfAppRouterDeployConfigQuestions, CfAppRouterDeployConfigAnswers, CfDeployConfigRouterAnswers, CfDeployConfigRouterQuestions } from './types';
 import { promptNames, appRouterPromptNames, RouterModuleType } from './types';
 import type { InquirerAdapter } from '@sap-ux/inquirer-common';
 import type { Logger } from '@sap-ux/logger';
@@ -30,5 +30,5 @@ declare function getAppRouterPrompts(promptOptions: CfAppRouterDeployConfigPromp
  * @returns the prompt answers
  */
 declare function prompt(adapter: InquirerAdapter, promptOptions: CfDeployConfigPromptOptions, logger?: Logger): Promise<CfDeployConfigAnswers>;
-export { getPrompts, type CfDeployConfigPromptOptions, type CfSystemChoice, promptNames, prompt, appRouterPromptNames, getAppRouterPrompts, type CfAppRouterDeployConfigPromptOptions, RouterModuleType, type CfDeployConfigQuestions, type CfDeployConfigAnswers, type CfAppRouterDeployConfigAnswers, type CfAppRouterDeployConfigQuestions };
+export { getPrompts, type CfDeployConfigPromptOptions, type CfSystemChoice, promptNames, prompt, appRouterPromptNames, getAppRouterPrompts, type CfAppRouterDeployConfigPromptOptions, RouterModuleType, type CfDeployConfigQuestions, type CfDeployConfigAnswers, type CfAppRouterDeployConfigAnswers, type CfAppRouterDeployConfigQuestions, type CfDeployConfigRouterAnswers, type CfDeployConfigRouterQuestions };
 //# sourceMappingURL=index.d.ts.map

package/dist/prompts/app-router-prompts.js

@@ -72,8 +72,8 @@ function getMtaVersionPrompt() {
 /**
  * Generates a prompt for selecting the router type.
  *
- * This prompt allows users to choose between a standalone app router or a managed app router for deployment.
- * The prompt is mandatory, with a default selection of the "standard" router type.
+ * This prompt allows users to choose between a standalone | managed | app frontend router for deployment.
+ * The prompt is mandatory, with a default selection of the "managed" router type.
  *
  * @returns {CfAppRouterDeployConfigQuestions} - The prompt configuration object for selecting the router type.
  */
@@ -89,6 +89,7 @@ function getRouterTypePrompt() {
         message: (0, i18n_1.t)('prompts.routerTypeMessage'),
         choices: [
             { name: (0, i18n_1.t)('routerType.managedAppRouter'), value: types_1.RouterModuleType.Managed },
+            { name: (0, i18n_1.t)('routerType.appFrontAppService'), value: types_1.RouterModuleType.AppFront },
             { name: (0, i18n_1.t)('routerType.standaloneAppRouter'), value: types_1.RouterModuleType.Standard }
         ]
     };
@@ -103,7 +104,7 @@ function getRouterTypePrompt() {
  */
 function getConnectivityServicePrompt() {
     return {
-        when: (previousAnswers) => previousAnswers.routerType !== types_1.RouterModuleType.Managed,
+        when: (previousAnswers) => previousAnswers.routerType === types_1.RouterModuleType.Standard,
         type: 'confirm',
         name: types_1.appRouterPromptNames.addConnectivityService,
         guiOptions: {
@@ -125,7 +126,7 @@ function getConnectivityServicePrompt() {
  */
 function getDestinationService() {
     return {
-        when: (previousAnswers) => previousAnswers.routerType !== types_1.RouterModuleType.Managed,
+        when: (previousAnswers) => previousAnswers.routerType === types_1.RouterModuleType.Standard,
         type: 'confirm',
         name: types_1.appRouterPromptNames.addABAPServiceBinding,
         message: (0, i18n_1.t)('prompts.serviceAdvancedOptionMessage'),
@@ -145,7 +146,7 @@ function getServiceProvider() {
     const errorHandler = new inquirer_common_1.ErrorHandler();
     return {
         when: (previousAnswers) => {
-            return !!previousAnswers.addABAPServiceBinding && previousAnswers.routerType !== types_1.RouterModuleType.Managed;
+            return !!previousAnswers.addABAPServiceBinding && previousAnswers.routerType === types_1.RouterModuleType.Standard;
         },
         type: 'list',
         name: types_1.appRouterPromptNames.abapServiceProvider,

package/dist/prompts/prompts.d.ts

@@ -1,4 +1,4 @@
-import type { CfDeployConfigPromptOptions, CfDeployConfigQuestions } from '../types';
+import { type CfDeployConfigPromptOptions, type CfDeployConfigQuestions } from '../types';
 import type { Logger } from '@sap-ux/logger';
 /**
  * Retrieves a list of deployment questions based on the application root and prompt options.

package/dist/prompts/prompts.js

@@ -15,13 +15,23 @@ var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (
 }) : function(o, v) {
     o["default"] = v;
 });
-var __importStar = (this && this.__importStar) || function (mod) {
-    if (mod && mod.__esModule) return mod;
-    var result = {};
-    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
-    __setModuleDefault(result, mod);
-    return result;
-};
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.getQuestions = getQuestions;
 const inquirer_common_1 = require("@sap-ux/inquirer-common");
@@ -30,6 +40,7 @@ const types_1 = require("../types");
 const validators = __importStar(require("./validators"));
 const btp_utils_1 = require("@sap-ux/btp-utils");
 const prompt_helpers_1 = require("./prompt-helpers");
+const yeoman_ui_types_1 = require("@sap-devx/yeoman-ui-types");
 /**
  * Retrieves the prompt configuration for selecting a Cloud Foundry destination name.
  *
@@ -118,6 +129,37 @@ function getOverwritePrompt() {
         message: () => (0, i18n_1.t)('prompts.overwriteMessage')
     };
 }
+/**
+ *
+ * @returns A list question object with the available router options, defaulting to `None`.
+ */
+function getRouterOptionsPrompt() {
+    return {
+        type: 'list',
+        name: types_1.promptNames.routerType,
+        guiOptions: {
+            mandatory: true,
+            breadcrumb: (0, i18n_1.t)('prompts.generateDeploymentRouterOptionsMessage')
+        },
+        default: () => types_1.RouterModuleType.None, // Should always be the preferred choice
+        message: () => (0, i18n_1.t)('prompts.generateDeploymentRouterOptionsMessage'),
+        additionalMessages: (selectedRouter) => {
+            let additionalMessage;
+            if (selectedRouter && selectedRouter === types_1.RouterModuleType.AppFront) {
+                additionalMessage = {
+                    message: (0, i18n_1.t)('warnings.appFrontendServiceRouterChoice'),
+                    severity: yeoman_ui_types_1.Severity.warning
+                };
+            }
+            return additionalMessage;
+        },
+        choices: [
+            { name: (0, i18n_1.t)('prompts.routerType.none'), value: types_1.RouterModuleType.None },
+            { name: (0, i18n_1.t)('prompts.routerType.managedAppRouter'), value: types_1.RouterModuleType.Managed },
+            { name: (0, i18n_1.t)('prompts.routerType.appFrontAppService'), value: types_1.RouterModuleType.AppFront }
+        ]
+    };
+}
 /**
  * Retrieves a list of deployment questions based on the application root and prompt options.
  *
@@ -129,6 +171,7 @@ async function getQuestions(promptOptions, log) {
     const destinationOptions = promptOptions[types_1.promptNames.destinationName];
     const addOverwriteQuestion = promptOptions[types_1.promptNames.overwrite] ?? false;
     const addManagedAppRouter = promptOptions[types_1.promptNames.addManagedAppRouter] ?? false;
+    const showRouterOptions = promptOptions[types_1.promptNames.showRouterOptions] ?? false;
     const questions = [];
     // Collect questions into an array
     questions.push(await getDestinationNamePrompt(destinationOptions));
@@ -140,6 +183,10 @@ async function getQuestions(promptOptions, log) {
         log?.info((0, i18n_1.t)('info.overwriteDestination'));
         questions.push(getOverwritePrompt());
     }
+    if (showRouterOptions) {
+        log?.info((0, i18n_1.t)('info.routerOptions'));
+        questions.push(getRouterOptionsPrompt());
+    }
     return questions;
 }
 //# sourceMappingURL=prompts.js.map

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

@@ -1,8 +1,9 @@
 {
     "prompts": {
-        "destinationNameMessage": "Destination name",
+        "destinationNameMessage": "Destination Name",
         "addApplicationRouterBreadcrumbMessage": "Add to Router",
         "generateManagedApplicationToRouterMessage": "Add application to managed application router?",
+        "generateDeploymentRouterOptionsMessage": "Add Router Module",
         "directBindingDestinationHint": "Destination name - The app router is configured to use direct service binding",
         "overwriteMessage": "Editing the deployment configuration will overwrite existing configuration, are you sure you want to continue?",
         "overwriteHintMessage": "Deployment configuration will abort if you choose no. Click Finish to abort.",
@@ -15,11 +16,17 @@
         "serviceAdvancedOptionMessage": "Configure advanced options",
         "abapEnvBindingBreadcrumbMessage": "ABAP Env. Binding",
         "selectServiceMessage": "ABAP Environment for direct service binding",
-        "routerTypeMessage": "Add router module"
+        "routerTypeMessage": "Add Router Module",
+        "routerType": {
+            "managedAppRouter": "Add application to managed application router",
+            "appFrontAppService": "Add application to application front-end service",
+            "none": "None"
+        }
     },
     "routerType": {
         "standaloneAppRouter": "Standalone Approuter",
-        "managedAppRouter": "Managed Approuter"
+        "managedAppRouter": "Managed Approuter",
+        "appFrontAppService": "Application Front-End Service"
     },
     "errors": {
         "emptyDestinationNameError": "You must provide a destination name in order to continue.",
@@ -33,12 +40,14 @@
         "errorScpAbapSourceDiscoveryCheckLog": "Check the Application Wizard console output view for details."
     },
     "warning": {
-        "btpDestinationListWarning": "BTP destinations are only retrieved on BAS"
+        "btpDestinationListWarning": "BTP destinations are only retrieved on BAS.",
+        "appFrontendServiceRouterChoice": "You need to have the Application Front-End service enabled for your subaccount."
     },
     "info": {
         "addManagedAppRouter": "Add managed application router is enabled",
         "overwriteDestination": "Overwriting destination is enabled",
-        "addConnectivityService": "Add connectivity service is enabled in cf application router",
-        "addABAPServiceBinding": "Abap service binding is enabled in cf application router"
+        "routerOptions": "Router options is enabled",
+        "addConnectivityService": "Add connectivity service is enabled in CF application router",
+        "addABAPServiceBinding": "Abap service binding is enabled in CF application router"
     }
 }

package/dist/types.d.ts

@@ -9,7 +9,11 @@ export declare enum promptNames {
     /** The prompt to specify if a managed app router should be added to the deployment. */
     addManagedAppRouter = "addManagedAppRouter",
     /** The prompt for confirming destination overwrite. */
-    overwrite = "overwriteDestinationName"
+    overwrite = "overwriteDestinationName",
+    /** The prompt for confirming the router type. */
+    routerType = "routerType",
+    /** The prompt for confirming if the router options should be displayed */
+    showRouterOptions = "showRouterOptions"
 }
 /**
  * Enum defining prompt names for Application Router configuration.
@@ -22,7 +26,9 @@ export declare enum appRouterPromptNames {
     routerType = "routerType",
     addConnectivityService = "addConnectivityService",
     addABAPServiceBinding = "addABAPServiceBinding",
-    abapServiceProvider = "abapServiceProvider"
+    abapServiceProvider = "abapServiceProvider",
+    /** The prompt for confirming if the router options should be displayed */
+    showRouterOptions = "showRouterOptions"
 }
 /**
  * Configuration options for the 'destinationName' prompt used in deployment settings.
@@ -50,27 +56,42 @@ export type DestinationNamePromptOptions = {
      */
     useAutocomplete?: boolean;
 };
+/**
+ * Configuration options for the 'destinationName' prompt used in deployment settings.
+ */
+export type DestinationRouterPromptOptions = {
+    /** Default value */
+    defaultValue: string;
+    /** Flag to indicate if a hint message should be shown to indicate the app router is configured.*/
+    hint?: boolean;
+    routerType?: RouterModuleType[];
+};
 /**
  * Defines options for boolean-type prompts in CF deployment configuration.
  */
-export type booleanPromptOptions = Partial<Record<promptNames.overwrite | promptNames.addManagedAppRouter | appRouterPromptNames.mtaId | appRouterPromptNames.mtaDescription | appRouterPromptNames.mtaVersion | appRouterPromptNames.routerType | appRouterPromptNames.addABAPServiceBinding | appRouterPromptNames.addConnectivityService, boolean>>;
+export type booleanPromptOptions = Partial<Record<promptNames.overwrite | promptNames.addManagedAppRouter | appRouterPromptNames.mtaId | appRouterPromptNames.mtaDescription | appRouterPromptNames.mtaVersion | appRouterPromptNames.routerType | appRouterPromptNames.addABAPServiceBinding | appRouterPromptNames.addConnectivityService | appRouterPromptNames.showRouterOptions, boolean>>;
 /**
  * Defines options for string-type prompts in CF deployment configuration.
  */
-type stringPromptOptions = Partial<Record<promptNames.destinationName, DestinationNamePromptOptions>>;
+type destinationNamePromptOptions = Partial<Record<promptNames.destinationName, DestinationNamePromptOptions>>;
 /**
  * Configuration options for CF deployment prompts.
  */
-export type CfDeployConfigPromptOptions = Partial<stringPromptOptions & booleanPromptOptions>;
+export type CfDeployConfigPromptOptions = Partial<destinationNamePromptOptions & booleanPromptOptions>;
 /**
  * Configuration options for CF App Router deployment prompts.
  */
-export type CfAppRouterDeployConfigPromptOptions = Partial<stringPromptOptions & booleanPromptOptions> & Record<appRouterPromptNames.mtaPath, string>;
+export type CfAppRouterDeployConfigPromptOptions = Partial<destinationNamePromptOptions & booleanPromptOptions> & Record<appRouterPromptNames.mtaPath, string>;
 /**
  * Represents a question in the CF deployment configuration.
  * Extends `YUIQuestion` with optional autocomplete functionality.
  */
 export type CfDeployConfigQuestions = YUIQuestion<CfDeployConfigAnswers> & Partial<Pick<AutocompleteQuestionOptions, 'source'>>;
+/**
+ * Represents a question in the CF deployment configuration.
+ * Extends `YUIQuestion` with optional autocomplete functionality.
+ */
+export type CfDeployConfigRouterQuestions = YUIQuestion<CfDeployConfigRouterAnswers> & Partial<Pick<AutocompleteQuestionOptions, 'source'>>;
 export type CfAppRouterDeployConfigQuestions = YUIQuestion<CfAppRouterDeployConfigAnswers>;
 /**
  * User responses for CF deployment configuration.
@@ -83,12 +104,20 @@ export interface CfDeployConfigAnswers {
     /** Indicates whether the user opted to overwrite the destination. */
     overwrite?: boolean;
 }
+/**
+ * User responses for CF deployment configuration with Router type.
+ */
+export interface CfDeployConfigRouterAnswers extends Omit<CfDeployConfigAnswers, 'addManagedAppRouter'> {
+    routerType?: RouterModuleType;
+}
 /**
  * Defines the types of router modules for the Application Router configuration.
  */
 export declare const RouterModuleType: {
     readonly Standard: "standard";
     readonly Managed: "managed";
+    readonly AppFront: "appFront";
+    readonly None: "none";
 };
 export type RouterModuleType = (typeof RouterModuleType)[keyof typeof RouterModuleType];
 /**

package/dist/types.js

@@ -12,6 +12,10 @@ var promptNames;
     promptNames["addManagedAppRouter"] = "addManagedAppRouter";
     /** The prompt for confirming destination overwrite. */
     promptNames["overwrite"] = "overwriteDestinationName";
+    /** The prompt for confirming the router type. */
+    promptNames["routerType"] = "routerType";
+    /** The prompt for confirming if the router options should be displayed */
+    promptNames["showRouterOptions"] = "showRouterOptions";
 })(promptNames || (exports.promptNames = promptNames = {}));
 /**
  * Enum defining prompt names for Application Router configuration.
@@ -34,12 +38,16 @@ var appRouterPromptNames;
     appRouterPromptNames["addABAPServiceBinding"] = "addABAPServiceBinding";
     /* Prompt for selecting the ABAP environments */
     appRouterPromptNames["abapServiceProvider"] = "abapServiceProvider";
+    /** The prompt for confirming if the router options should be displayed */
+    appRouterPromptNames["showRouterOptions"] = "showRouterOptions";
 })(appRouterPromptNames || (exports.appRouterPromptNames = appRouterPromptNames = {}));
 /**
  * Defines the types of router modules for the Application Router configuration.
  */
 exports.RouterModuleType = {
     Standard: 'standard',
-    Managed: 'managed'
+    Managed: 'managed',
+    AppFront: 'appFront',
+    None: 'none'
 };
 //# sourceMappingURL=types.js.map

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@sap-ux/cf-deploy-config-inquirer",
   "description": "Prompts module that can provide prompts for cf deployment config writer",
-  "version": "0.2.21",
+  "version": "0.2.23",
   "repository": {
     "type": "git",
     "url": "https://github.com/SAP/open-ux-tools.git",
@@ -21,7 +21,7 @@
   "dependencies": {
     "i18next": "23.5.1",
     "inquirer-autocomplete-prompt": "2.0.1",
-    "@sap-ux/inquirer-common": "0.6.31",
+    "@sap-ux/inquirer-common": "0.6.32",
     "@sap-ux/btp-utils": "1.0.2",
     "@sap-ux/logger": "0.6.0"
   },