@sap-ux/odata-service-inquirer 0.5.59 → 0.6.0

package/dist/prompts/datasources/sap-system/system-selection/questions.js

@@ -0,0 +1,181 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.newSystemChoiceValue = void 0;
+exports.getSystemSelectionQuestions = getSystemSelectionQuestions;
+exports.getSystemConnectionQuestions = getSystemConnectionQuestions;
+const yeoman_ui_types_1 = require("@sap-devx/yeoman-ui-types");
+const btp_utils_1 = require("@sap-ux/btp-utils");
+const inquirer_common_1 = require("@sap-ux/inquirer-common");
+const i18n_1 = require("../../../../i18n");
+const types_1 = require("../../../../types");
+const utils_1 = require("../../../../utils");
+const connectionValidator_1 = require("../../../connectionValidator");
+const logger_helper_1 = __importDefault(require("../../../logger-helper"));
+const questions_1 = require("../credentials/questions");
+const questions_2 = require("../new-system/questions");
+const questions_3 = require("../service-selection/questions");
+const validators_1 = require("../validators");
+const prompt_helpers_1 = require("./prompt-helpers");
+// New system choice value is a hard to guess string to avoid conflicts with existing system names or user named systems
+// since it will be used as a new system value in the system selection prompt.
+exports.newSystemChoiceValue = '!@£*&937newSystem*X~qy^';
+const systemSelectionPromptNamespace = 'systemSelection';
+const usernamePromptName = `${systemSelectionPromptNamespace}:${questions_1.BasicCredentialsPromptNames.systemUsername}`;
+const passwordPromptName = `${systemSelectionPromptNamespace}:${questions_1.BasicCredentialsPromptNames.systemPassword}`;
+const systemSelectionPromptNames = {
+    systemSelectionCli: 'systemSelectionCli',
+    destinationServicePath: 'destinationServicePath'
+};
+/**
+ * Validates the system selection, connecting to the selected system and validating the connection.
+ *
+ * @param systemSelection
+ * @param connectionValidator
+ * @param requiredOdataVersion
+ * @returns the validation result of the selected system connection attempt
+ */
+async function validateSystemSelection(systemSelection, connectionValidator, requiredOdataVersion) {
+    utils_1.PromptState.reset();
+    if (systemSelection.type === 'newSystemChoice') {
+        return true;
+    }
+    let connectValResult = false;
+    if (systemSelection.type === 'backendSystem') {
+        connectValResult = await (0, prompt_helpers_1.connectWithBackendSystem)(systemSelection.system, connectionValidator, requiredOdataVersion);
+    }
+    else if (systemSelection.type === 'destination') {
+        // Partial URL destinations will require additional service path prompt input, so we skip the connection validation here by returning true
+        // The service URL connection will need to be validated by the service path prompt
+        if ((0, btp_utils_1.isPartialUrlDestination)(systemSelection.system)) {
+            // Reset the connection state as we are deferring the connection validation to the service path prompt, any existing connection state should be cleared
+            // connectionValidator.resetConnectionState(true);
+            return true;
+        }
+        connectValResult = await (0, prompt_helpers_1.connectWithDestination)(systemSelection.system, connectionValidator, requiredOdataVersion);
+    }
+    return connectValResult;
+}
+/**
+ * Returns a list of questions for creating a new system configuration or selecting an existing stored system.
+ *
+ * @param promptOptions prompt options that may be used to customize the questions
+ * @returns a list of questions for creating a new system configuration or selecting an existing stored system
+ */
+async function getSystemSelectionQuestions(promptOptions) {
+    utils_1.PromptState.reset();
+    const connectValidator = new connectionValidator_1.ConnectionValidator();
+    const questions = await getSystemConnectionQuestions(connectValidator, promptOptions);
+    // Existing system (BackendSystem or Destination) selected,
+    // In future, make the service prompt optional by wrapping in condition `[promptOptions?.serviceSelection?.hide]`
+    questions.push(...(0, inquirer_common_1.withCondition)((0, questions_3.getSystemServiceQuestion)(connectValidator, systemSelectionPromptNamespace, promptOptions), (answers) => answers.systemSelection?.type !== 'newSystemChoice'));
+    // Create new system connection for storage only supported on non-App Studio environments
+    if (!(0, btp_utils_1.isAppStudio)()) {
+        questions.push(...(0, inquirer_common_1.withCondition)((0, questions_2.getNewSystemQuestions)(promptOptions), (answers) => answers.systemSelection?.type === 'newSystemChoice'));
+    }
+    return questions;
+}
+/**
+ * Returns a list of existing systems, either destinations or backend systems from persistent store, depending on the environment.
+ * Note that destinations are only available in BAS environment and must include the destination attribute `WebIDEEnabled` to be listed.
+ * Additional destination attribute filters may be provided.
+ *
+ * @param connectionValidator A reference to the active connection validator, used to validate the service selection and retrieve service details.
+ * @param promptOptions
+ * @returns a list of existing systems
+ */
+async function getSystemConnectionQuestions(connectionValidator, promptOptions) {
+    const requiredOdataVersion = promptOptions?.serviceSelection?.requiredOdataVersion;
+    const destinationFilters = promptOptions?.systemSelection?.destinationFilters;
+    const systemChoices = await (0, prompt_helpers_1.createSystemChoices)(destinationFilters, promptOptions?.systemSelection?.includeCloudFoundryAbapEnvChoice);
+    const questions = [
+        {
+            type: promptOptions?.systemSelection?.useAutoComplete ? 'autocomplete' : 'list',
+            name: types_1.promptNames.systemSelection,
+            message: (0, i18n_1.t)('prompts.systemSelection.message'),
+            source: (prevAnswers, input) => (0, inquirer_common_1.searchChoices)(input, systemChoices),
+            choices: systemChoices,
+            validate: async (selectedSystem) => {
+                if (!selectedSystem) {
+                    return false;
+                }
+                let selectedSystemAnswer = selectedSystem;
+                // Autocomplete passes the entire choice object as the answer, so we need to extract the value
+                if (promptOptions?.systemSelection?.useAutoComplete && selectedSystem.value) {
+                    selectedSystemAnswer = selectedSystem.value;
+                }
+                return (validateSystemSelection(selectedSystemAnswer, connectionValidator, requiredOdataVersion) ?? false);
+            },
+            additionalMessages: async (selectedSystem) => {
+                // Backend systems credentials may need to be updated
+                if (selectedSystem.type === 'backendSystem' &&
+                    connectionValidator.systemAuthType === 'basic' &&
+                    (await connectionValidator.isAuthRequired())) {
+                    return {
+                        message: (0, i18n_1.t)('prompts.systemSelection.authenticationFailedUpdateCredentials'),
+                        severity: yeoman_ui_types_1.Severity.information
+                    };
+                }
+            }
+        }
+    ];
+    if ((0, btp_utils_1.isAppStudio)()) {
+        // Additional service path prompt for partial URL destinations
+        const servicePathPrompt = {
+            when: (answers) => {
+                const selectedSystem = answers?.[types_1.promptNames.systemSelection];
+                if (selectedSystem?.type === 'destination') {
+                    return (0, btp_utils_1.isPartialUrlDestination)(selectedSystem.system);
+                }
+                return false;
+            },
+            type: 'input',
+            name: systemSelectionPromptNames.destinationServicePath,
+            message: (0, i18n_1.t)('prompts.destinationServicePath.message'),
+            guiOptions: {
+                hint: (0, i18n_1.t)('prompts.destinationServicePath.hint'),
+                mandatory: true,
+                breadcrumb: true
+            },
+            validate: async (servicePath, answers) => {
+                if (!servicePath) {
+                    return (0, i18n_1.t)('prompts.destinationServicePath.invalidServicePathWarning');
+                }
+                // Validate format of the service path, note this relies on the assumption that the destination is correctly configured with a valid URL
+                const selectedDestination = answers?.[types_1.promptNames.systemSelection]?.system;
+                const valUrlResult = (0, validators_1.validateServiceUrl)(selectedDestination.Host, servicePath);
+                if (valUrlResult !== true) {
+                    return valUrlResult;
+                }
+                const connectValResult = await (0, prompt_helpers_1.connectWithDestination)(selectedDestination, connectionValidator, requiredOdataVersion, servicePath);
+                return connectValResult;
+            }
+        };
+        questions.push(servicePathPrompt);
+    }
+    // Only for CLI use as `list` prompt validation does not run on CLI unless autocomplete plugin is used
+    if ((0, utils_1.getHostEnvironment)() === types_1.hostEnvironment.cli && !promptOptions?.systemSelection?.useAutoComplete) {
+        questions.push({
+            when: async (answers) => {
+                const selectedSystem = answers?.[types_1.promptNames.systemSelection];
+                if (!selectedSystem) {
+                    return false;
+                }
+                const connectValResult = await validateSystemSelection(selectedSystem, connectionValidator, requiredOdataVersion);
+                // An issue occurred with the selected system, there is no need to continue on the CLI, log and exit
+                // Note that for connection authentication errors, the result will be true, the user will be prompted to update their credentials in the next prompt
+                if (connectValResult !== true) {
+                    logger_helper_1.default.logger.error(connectValResult.toString);
+                    throw new Error(connectValResult.toString());
+                }
+                return false;
+            },
+            name: `${systemSelectionPromptNames.systemSelectionCli}`
+        });
+    }
+    questions.push(...(0, questions_1.getCredentialsPrompts)(connectionValidator, systemSelectionPromptNamespace));
+    return questions;
+}
+//# sourceMappingURL=questions.js.map

package/dist/prompts/datasources/sap-system/validators.d.ts

@@ -13,4 +13,12 @@ export declare function validateSystemName(systemName: string): Promise<boolean
  * @returns the service key info if the file is valid, otherwise an error message
  */
 export declare function validateServiceKey(path: string): string | ServiceInfo | boolean;
+/**
+ * Validates the specified origin and service path can be used to form a valid URL.
+ *
+ * @param origin the origin of the service
+ * @param servicePath the path to the service
+ * @returns true if a URL can be created from the specified parameters, otherwise an error message
+ */
+export declare function validateServiceUrl(origin: string, servicePath: string): string | boolean;
 //# sourceMappingURL=validators.d.ts.map

package/dist/prompts/datasources/sap-system/validators.js

@@ -5,6 +5,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.validateSystemName = validateSystemName;
 exports.validateServiceKey = validateServiceKey;
+exports.validateServiceUrl = validateServiceUrl;
 const i18n_1 = require("../../../i18n");
 const store_1 = require("@sap-ux/store");
 const logger_helper_1 = __importDefault(require("../../logger-helper"));
@@ -59,4 +60,20 @@ function validateServiceKey(path) {
         return error.name === 'SyntaxError' ? (0, i18n_1.t)('prompts.serviceKey.unparseableServiceKey') : error.message;
     }
 }
+/**
+ * Validates the specified origin and service path can be used to form a valid URL.
+ *
+ * @param origin the origin of the service
+ * @param servicePath the path to the service
+ * @returns true if a URL can be created from the specified parameters, otherwise an error message
+ */
+function validateServiceUrl(origin, servicePath) {
+    try {
+        new URL(servicePath, origin);
+        return true;
+    }
+    catch (error) {
+        return (0, i18n_1.t)('errors.invalidUrl', { input: `${origin}${servicePath}` });
+    }
+}
 //# sourceMappingURL=validators.js.map

package/dist/prompts/datasources/service-url/questions.js

@@ -168,15 +168,15 @@ function getPasswordPrompt(connectValidator, requiredVersion) {
             applyDefaultWhenDirty: true,
             mandatory: true
         },
+        guiType: 'login',
         name: types_1.promptNames.serviceUrlPassword,
         message: (0, i18n_1.t)('prompts.servicePassword.message'),
-        guiType: 'login',
         mask: '*',
         validate: async (password, { username, serviceUrl, ignoreCertError, sapClient }) => {
             if (!serviceUrl || !username || !password) {
                 return false;
             }
-            const validAuth = await connectValidator.validateAuth(serviceUrl, username, password, {
+            const { valResult: validAuth } = await connectValidator.validateAuth(serviceUrl, username, password, {
                 ignoreCertError,
                 sapClient
             });

package/dist/prompts/datasources/service-url/validators.js

@@ -12,6 +12,7 @@ const utils_1 = require("../../../utils");
 const connectionValidator_1 = require("../../connectionValidator");
 const logger_helper_1 = __importDefault(require("../../logger-helper"));
 const prompt_helpers_1 = require("../../prompt-helpers");
+const validators_1 = require("../../validators");
 /**
  * Validates that a service specified by the service url is accessible, has the required version and returns valid metadata.
  * Retrieves annotations (from Abap backends) if available and stores them in the PromptState.
@@ -30,13 +31,11 @@ async function validateService(url, { odataService, axiosConfig }, requiredVersi
             connectionValidator_1.ConnectionValidator.setGlobalRejectUnauthorized(!ignoreCertError);
         }
         const metadata = await odataService.metadata();
-        const serviceOdataVersion = (0, utils_1.parseOdataVersion)(metadata);
-        if (requiredVersion && requiredVersion !== serviceOdataVersion) {
-            return `${(0, i18n_1.t)('errors.odataServiceVersionMismatch', {
-                serviceVersion: serviceOdataVersion,
-                requiredVersion
-            })}`;
+        const odataVersionValResult = (0, validators_1.validateODataVersion)(metadata, requiredVersion);
+        if (odataVersionValResult.validationMsg) {
+            return odataVersionValResult.validationMsg;
         }
+        const serviceOdataVersion = odataVersionValResult.version;
         // Remove all occurrences of the origin from the metadata to make backend uris relative
         utils_1.PromptState.odataService.metadata = (0, utils_1.originToRelative)(metadata);
         utils_1.PromptState.odataService.odataVersion = serviceOdataVersion;

package/dist/prompts/prompt-helpers.d.ts

@@ -7,8 +7,7 @@ export declare const errorHandler: ErrorHandler;
  *
  * @param options - optionally include some of the supported datasource type choices
  * @param options.includeNone - Include the `NONE` option in the datasource type prompt
- * @param options.includeProjectSpecificDest - Include the `projectSpecificDestination` option in the datasource type prompt
  * @returns The datasource type choices
  */
-export declare function getDatasourceTypeChoices({ includeNone, includeProjectSpecificDest }?: DatasourceTypePromptOptions): ListChoiceOptions[];
+export declare function getDatasourceTypeChoices({ includeNone }?: DatasourceTypePromptOptions): ListChoiceOptions[];
 //# sourceMappingURL=prompt-helpers.d.ts.map

package/dist/prompts/prompt-helpers.js

@@ -2,7 +2,6 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.errorHandler = void 0;
 exports.getDatasourceTypeChoices = getDatasourceTypeChoices;
-const btp_utils_1 = require("@sap-ux/btp-utils");
 const error_handler_1 = require("../error-handler/error-handler");
 const i18n_1 = require("../i18n");
 const types_1 = require("../types");
@@ -13,10 +12,9 @@ exports.errorHandler = new error_handler_1.ErrorHandler();
  *
  * @param options - optionally include some of the supported datasource type choices
  * @param options.includeNone - Include the `NONE` option in the datasource type prompt
- * @param options.includeProjectSpecificDest - Include the `projectSpecificDestination` option in the datasource type prompt
  * @returns The datasource type choices
  */
-function getDatasourceTypeChoices({ includeNone = false, includeProjectSpecificDest = false } = {}) {
+function getDatasourceTypeChoices({ includeNone = false } = {}) {
     const choices = [
         {
             name: (0, i18n_1.t)('prompts.datasourceType.sapSystemChoiceText'),
@@ -25,15 +23,8 @@ function getDatasourceTypeChoices({ includeNone = false, includeProjectSpecificD
         {
             name: (0, i18n_1.t)('prompts.datasourceType.odataServiceUrlChoiceText'),
             value: types_1.DatasourceType.odataServiceUrl
-        },
-        { name: (0, i18n_1.t)('prompts.datasourceType.businessHubChoiceText'), value: types_1.DatasourceType.businessHub }
+        }
     ];
-    if ((0, btp_utils_1.isAppStudio)() && includeProjectSpecificDest) {
-        choices.push({
-            name: (0, i18n_1.t)('prompts.datasourceType.projectSpecificDestChoiceText'),
-            value: types_1.DatasourceType.projectSpecificDestination
-        });
-    }
     choices.push({ name: (0, i18n_1.t)('prompts.datasourceType.capProjectChoiceText'), value: types_1.DatasourceType.capProject });
     choices.push({ name: (0, i18n_1.t)('prompts.datasourceType.metadataFileChoiceText'), value: types_1.DatasourceType.metadataFile });
     if (includeNone) {

package/dist/prompts/prompts.js

@@ -1,18 +1,13 @@
 "use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.getQuestions = getQuestions;
-const yeoman_ui_types_1 = require("@sap-devx/yeoman-ui-types");
 const inquirer_common_1 = require("@sap-ux/inquirer-common");
 const i18n_1 = require("../i18n");
 const types_1 = require("../types");
 const questions_1 = require("./datasources/cap-project/questions");
 const metadata_file_1 = require("./datasources/metadata-file");
-const questions_2 = require("./datasources/sap-system/new-system/questions");
-const questions_3 = require("./datasources/service-url/questions");
-const logger_helper_1 = __importDefault(require("./logger-helper"));
+const system_selection_1 = require("./datasources/sap-system/system-selection");
+const questions_2 = require("./datasources/service-url/questions");
 const prompt_helpers_1 = require("./prompt-helpers");
 /**
  * Get the prompts for the OData service inquirer.
@@ -42,29 +37,7 @@ function getDatasourceTypeQuestion(options) {
         },
         default: options?.default ?? -1,
         message: (0, i18n_1.t)('prompts.datasourceType.message'),
-        choices,
-        additionalMessages: (source) => {
-            if ([
-                types_1.DatasourceType.businessHub,
-                types_1.DatasourceType.none,
-                types_1.DatasourceType.projectSpecificDestination,
-                types_1.DatasourceType.sapSystem
-            ].includes(source)) {
-                logger_helper_1.default.logger?.warn((0, i18n_1.t)('prompts.datasourceType.notYetImplementedWarningMessage', { datasourceType: source }));
-                return {
-                    message: (0, i18n_1.t)('prompts.datasourceType.notYetImplementedWarningMessage', { datasourceType: source }),
-                    severity: yeoman_ui_types_1.Severity.warning
-                };
-            }
-            if (source === types_1.DatasourceType.businessHub) {
-                return {
-                    message: (0, i18n_1.t)('prompts.nonUIServiceTypeWarningMessage', {
-                        serviceType: (0, i18n_1.t)('prompts.datasourceType.businessHubName')
-                    }),
-                    severity: yeoman_ui_types_1.Severity.warning
-                };
-            }
-        }
+        choices
     };
 }
 /**
@@ -75,12 +48,10 @@ function getDatasourceTypeQuestion(options) {
  */
 async function getDatasourceTypeConditionalQuestions(promptOptions) {
     const conditionalQuestions = [];
+    conditionalQuestions.push(...(0, inquirer_common_1.withCondition)((await (0, system_selection_1.getSystemSelectionQuestions)(promptOptions)), (answers) => answers.datasourceType === types_1.DatasourceType.sapSystem));
     conditionalQuestions.push(...(0, inquirer_common_1.withCondition)([(0, metadata_file_1.getMetadataFileQuestion)(promptOptions?.metadataFilePath)], (answers) => answers.datasourceType === types_1.DatasourceType.metadataFile));
     conditionalQuestions.push(...(0, inquirer_common_1.withCondition)((0, questions_1.getLocalCapProjectPrompts)(promptOptions), (answers) => answers.datasourceType === types_1.DatasourceType.capProject));
-    conditionalQuestions.push(...(0, inquirer_common_1.withCondition)((0, questions_3.getServiceUrlQuestions)(promptOptions), (answers) => answers.datasourceType === types_1.DatasourceType.odataServiceUrl));
-    conditionalQuestions.push(...(0, inquirer_common_1.withCondition)((0, questions_2.getNewSystemQuestions)(promptOptions), (answers) => answers.datasourceType === types_1.DatasourceType.sapSystem &&
-        answers.system === questions_2.newSystemChoiceValue));
-    //...further data sources to be added here
+    conditionalQuestions.push(...(0, inquirer_common_1.withCondition)((0, questions_2.getServiceUrlQuestions)(promptOptions), (answers) => answers.datasourceType === types_1.DatasourceType.odataServiceUrl));
     return conditionalQuestions;
 }
 //# sourceMappingURL=prompts.js.map

package/dist/prompts/validators.d.ts

@@ -4,7 +4,7 @@ import type { OdataVersion } from '@sap-ux/odata-service-writer';
  *
  * @param edmx the edmx to validate
  * @param requiredVersion the required odata version to validate against
- * @returns version and/or validation error message
+ * @returns the version only if odata version of the specified edmx matches otherwises the validation error message
  */
 export declare function validateODataVersion(edmx: string, requiredVersion?: OdataVersion): {
     validationMsg?: string;

package/dist/prompts/validators.js

@@ -12,7 +12,7 @@ const utils_1 = require("../utils");
  *
  * @param edmx the edmx to validate
  * @param requiredVersion the required odata version to validate against
- * @returns version and/or validation error message
+ * @returns the version only if odata version of the specified edmx matches otherwises the validation error message
  */
 function validateODataVersion(edmx, requiredVersion) {
     try {

package/dist/translations/odata-service-inquirer.i18n.json

@@ -81,13 +81,14 @@
             "message": "Password"
         },
         "systemService": {
-            "message": "Service name",
+            "message": "Service",
             "breadcrumb": "Service",
             "noServicesWarning": "No services available for the selected system, see logs for further details."
         },
         "newSystemType": {
             "choiceAbapOnPrem": "ABAP On Premise",
             "choiceAbapOnBtp": "ABAP Environment on SAP Business Technology Platform",
+            "choiceCFAbapEnvServiceOnBtp": "Cloud Foundry ABAP environment on SAP Business Technology Platform",
             "message": "System type",
             "notYetImplementedWarningMessage": "The selected system type: {{ systemType }} is not yet implemented."
         },
@@ -99,7 +100,9 @@
             "emptySystemNameWarning": "System name cannot be empty."
         },
         "systemSelection": {
-            "newSystemChoiceLabel": "New system"
+            "newSystemChoiceLabel": "New system",
+            "message": "Select a system configuration",
+            "authenticationFailedUpdateCredentials": "Authentication failed. Please try updating the credentials."
         },
         "abapOnBTPType": {
             "message": "ABAP environment definition source",
@@ -116,36 +119,44 @@
         "cloudFoundryAbapSystem": {
             "message": "ABAP environment",
             "hint": "Enter the name of the Cloud Foundry service that contains the ABAP Environment instance"
+        },
+        "destinationServicePath": {
+            "message": "Service path",
+            "hint": "Enter the path to the OData service, relative to the selected destination URL",
+            "invalidServicePathWarning": "Please enter a valid service path"
         }
     },
     "errors": {
+        "destination": {
+            "unavailable": "The selected destination references an instance that is not available. Please check your destination configuration and try again.",
+            "notFound": "The destination is misconfigured, HTTP Error 404 returned, the requested resource could not be found.",
+            "authError": "The selected system is returning an authentication error. System name: {{systemName}}, error: {{- error}}",
+            "notReachable": "The selected system is not reachable. System name: {{systemName}}, error: {{- error}}",
+            "misconfigured": "The destination is misconfigured. $t(errors.destination.missingPropMsg, {\"destinationProperty\": \"{{destinationProperty}}\" })",
+            "missingPropMsg": "The property: `{{destinationProperty}}` is missing.",
+            "httpConnectionError": "A connection error occurred with the selected destination. Http code: {{- code}}. See log for more details."
+        },
         "cannotReadCapServiceMetadata": "An error occurred reading CAP service metadata: {{serviceName}}. See log for more details.",
         "capModelAndServicesLoadError": "An error occurred loading the CAP model and services. {{- error}}",
         "capServiceUrlPathNotDefined": "An error occurred reading CAP service metadata: {{serviceName}}. CAP service property `urlPath` is not defined but is required.",
-        "unknownError": "An error occurred: {{- error}}",
+        "unknownError": "An error occurred{{- error, addMsgWithColonFormatter}}",
         "servicesUnavailable": "An error occurred retrieving service(s) for SAP System.",
         "certificateError": "A certificate error has occurred: {{- error}}",
         "urlCertValidationError": "The system URL is using {{certErrorReason}} security certificate.",
-        "authenticationFailed": "Authentication incorrect {{error}}",
+        "authenticationFailed": "Authentication incorrect. {{error}}",
         "authenticationTimeout": "Authorization was not verified within the allowed time. Please ensure you have authenticated using the associated browser window.",
-        "invalidUrl": "Not a valid URL",
+        "invalidUrl": "Invalid URL{{-input, addMsgWithColonFormatter}}",
         "connectionError": "A connection error occurred, please ensure the target host is available on the network: {{- error}}",
         "timeout": "A connection timeout error occurred: {{- error}}",
-        "serviceUnavailable": "Selected service is returning an error.",
+        "serverReturnedAnError": "The server returned an error. {{errorDesc}}",
+        "serverUnableToCompleteRequest": "The server was unable to complete the request",
         "catalogServiceNotActive": "Catalog service is not active",
-        "internalServerError": "The URL you have provided cannot be accessed and is returning: '{{- error}}'. Please ensure that the URL is accessible externally.",
         "urlNotFound": "URL not found",
         "odataServiceUrlNotFound": "The service URL you have provided is not a valid OData Service. Fiori applications require an OData service as the data source.",
-        "badGateway": "The server returned an error: bad gateway, please check the URL and try again.",
-        "destinationUnavailable": "The selected destination references an instance that is not available. Please check your destination configuration and try again.",
-        "destinationNotFound": "The destination is mis-configured, HTTP Error 404 returned, the requested resource could not be found.",
-        "destinationMisconfigured": "The destination is mis-configured, HTML5.DynamicDestination property is missing.",
         "noServicesAvailable": "There are no V{{version}} OData services available from the selected system and the template you have chosen supports V{{version}} OData services only",
         "redirectError": "A redirect response was received from the server",
         "abapEnvsUnavailable": "ABAP environments unavailable",
         "noSuchHostError": "No such host is known",
-        "odataServiceVersionMismatch": "The template you have chosen supports V{{requiredVersion}} OData services only. The provided version is V{{serviceVersion}}.",
-        "destinationAuthError": "The selected system is returning an authentication error. Please verify the destination configuration",
         "systemOrServiceUrlNotFound": "Please verify the url: {{- url}}, target system configuration and network connectivity",
         "urlRedirect": "The service URL is redirecting",
         "certValidationRequired": "Certificate validation is required to continue.",
@@ -157,7 +168,14 @@
         "noAbapEnvsInCFSpace": "No ABAP environments in CF space found.",
         "abapEnvsCFDiscoveryFailed": "Discovering ABAP Environments failed. Please ensure you are logged into Cloud Foundry (see https://docs.cloudfoundry.org/cf-cli/getting-started.html#login).",
         "abapServiceAuthenticationFailed": "ABAP environment authentication using UAA failed.",
-        "serviceCatalogRequest": "An error occurred requesting services from: {{- catalogRequestUri }} and entity set: {{entitySet}}. {{error}}"
+        "serviceCatalogRequest": "An error occurred requesting services from: {{- catalogRequestUri }} and entity set: {{entitySet}}. {{error}}",
+        "storedSystemConnectionError": "An error occurred while validating the stored system connection info. System name: {{-systemName}}, error: {{- error}}",
+        "noCatalogOrServiceAvailable": "No active system or OData service endpoint connection available to retrieve service(s).",
+        "systemConnectionValidationFailed": "A connection to the selected system could not be established.",
+        "allCatalogServiceRequestsFailed": "All catalog service requests failed for the selected system. OData version(s): V{{version}}.",
+        "internalServerError": "Internal server error{{-errorMsg, addMsgWithColonFormatter}}",
+        "badGateway": "Bad gateway{{- errorMsg, addMsgWithColonFormatter}}",
+        "badRequest": "Bad request{{- errorMsg, addMsgWithColonFormatter}}"
     },
     "texts": {
         "anExpiredCert": "an expired",
@@ -166,7 +184,10 @@
         "anUntrustedRootCert": "an untrusted root",
         "suggestedSystemNameClient": ", client {{client}}",
         "seeLogForDetails": "See log for more details.",
-        "forUserName": "(for user [{{username}}])"
+        "forUserName": "(for user [{{username}}])",
+        "systemTypeBTP": "BTP",
+        "systemTypeS4HC": "S4HC",
+        "httpStatus": "http status {{httpStatus}}"
     },
     "guidedAnswers": {
         "validationErrorHelpText": "Need help with this error?"

package/dist/types.d.ts

@@ -1,21 +1,22 @@
 import type { IValidationLink } from '@sap-devx/yeoman-ui-types';
 import type { Annotations, ServiceProvider } from '@sap-ux/axios-extension';
+import type { Destination } from '@sap-ux/btp-utils';
 import type { CommonPromptOptions, YUIQuestion } from '@sap-ux/inquirer-common';
 import type { OdataVersion } from '@sap-ux/odata-service-writer';
 import type { CdsVersionInfo } from '@sap-ux/project-access';
-import type { ListChoiceOptions } from 'inquirer';
 import type { BackendSystem } from '@sap-ux/store';
+import type { ListChoiceOptions } from 'inquirer';
 /**
  * This file contains types that are exported by the module and are needed for consumers using the APIs `prompt` and `getPrompts`.
  */
 export declare enum DatasourceType {
     sapSystem = "sapSystem",
-    businessHub = "businessHub",
     capProject = "capProject",
     odataServiceUrl = "odataServiceUrl",
     none = "none",
     metadataFile = "metadataFile",
-    projectSpecificDestination = "projectSpecificDestination"
+    projectSpecificDestination = "projectSpecificDestination",
+    businessHub = "businessHub"
 }
 export declare const SapSystemTypes: {
     readonly abapOnPrem: "abapOnPrem";
@@ -74,8 +75,15 @@ export interface OdataServiceAnswers {
         serviceProvider: ServiceProvider;
         /**
          * The persistable backend system representation of the connected service provider
+         * `newOrUpdated` is set to true if the system was newly created or updated during the connection validation process and should be considered for storage.
+         */
+        backendSystem?: BackendSystem & {
+            newOrUpdated?: boolean;
+        };
+        /**
+         * The destination information for the connected system
          */
-        backendSystem?: BackendSystem;
+        destination?: Destination;
     };
 }
 /**
@@ -113,7 +121,11 @@ export declare enum promptNames {
     /**
      * Newly created systems can be named for storage
      */
-    userSystemName = "userSystemName"
+    userSystemName = "userSystemName",
+    /**
+     * System selection
+     */
+    systemSelection = "systemSelection"
 }
 export type CapRuntime = 'Node.js' | 'Java';
 export interface CapService {
@@ -175,10 +187,6 @@ export type DatasourceTypePromptOptions = {
      * Include the no datasource option in the datasource type prompt
      */
     includeNone?: boolean;
-    /**
-     * Include the `projectSpecificDestination` option in the datasource type prompt
-     */
-    includeProjectSpecificDest?: boolean;
     /**
      * Limit the offered datasource types to the specified types. Note that if `default` is also provided and not included in the choices, the default will be ignored.
      * If `includeNone` is set to true, the `none` option will always be included.
@@ -186,6 +194,45 @@ export type DatasourceTypePromptOptions = {
      */
     choices?: DatasourceType[];
 };
+export type DestinationFilters = {
+    /**
+     * 'WebIDEUsage' property is defined and includes the value 'odata_abap'. If this matches, the destination will be included regardless of other matches.
+     */
+    odata_abap: boolean;
+    /**
+     * 'WebIDEUsage' property is defined and includes the value 'odata_gen' and does not includes the value 'odata_abap'. If this matches, the destination will be included regardless of other matches.
+     */
+    odata_generic: boolean;
+    /**
+     * 'WebIDEAdditionalData' property is defined and includes the value 'full_url' and
+     * 'WebIDEUsage' property is defined and includes the value 'odata_gen' and does not includes the value 'odata_abap'. If this matches, the destination will be included regardless of other matches.
+     */
+    full_service_url: boolean;
+    /**
+     * 'WebIDEAdditionalData' property is defined and does not include the value 'full_url' and
+     * 'WebIDEUsage' property is defined and includes the value 'odata_gen' and does not includes the value 'odata_abap'. If this matches, the destination will be included regardless of other matches.
+     */
+    partial_service_url: boolean;
+};
+export type SystemSelectionPromptOptions = {
+    /**
+     * Set the specific filter option(s) to true to include only the destinatons that have matching configuration attributes.
+     * If no filter is set, all destinations will be included. If multiple filters are set, the destination will be included if it matches any of the filters.
+     * i.e. if both `abap_cloud` and `abap_on_premise` are set to true, the destination will be included if it has either 'abap_cloud' or 'abap_on_premise' matching configuration.
+     */
+    destinationFilters?: Partial<DestinationFilters>;
+    /**
+     * Determines if the system selection prompt should use auto complete prompt for system names.
+     * Note that the auto-complete module must be registered with the inquirer instance to use this feature.
+     */
+    useAutoComplete?: boolean;
+    /**
+     * Include the Cloud Foundry Abap environments service in the system selection prompt, note this option is only supported on Business Application Studio.
+     * Even if this option is set to true, the choice will only be included if the prompts are executed in the Business Application Studio.
+     * Note that there is no implementation for this option in this module and handling of the prompt optin and subsequent prompting must be implemented by the consumer.
+     */
+    includeCloudFoundryAbapEnvChoice?: boolean;
+};
 export type MetadataPromptOptions = {
     /**
      * Used to validate the metadata file contains the required odata version edmx
@@ -220,7 +267,7 @@ export type OdataServiceUrlPasswordOptions = Pick<CommonPromptOptions, 'addition
 /**
  * Provide the correct type checking for prompt options
  */
-type odataServiceInquirerPromptOptions = Record<promptNames.datasourceType, DatasourceTypePromptOptions> & Record<promptNames.metadataFilePath, MetadataPromptOptions> & Record<promptNames.capProject, CapProjectPromptOptions> & Record<promptNames.capService, CapServicePromptOptions> & Record<promptNames.serviceUrl, OdataServiceUrlPromptOptions> & Record<promptNames.serviceUrlPassword, OdataServiceUrlPasswordOptions> & Record<promptNames.serviceSelection, ServiceSelectionPromptOptions> & Record<promptNames.userSystemName, SystemNamePromptOptions>;
+type odataServiceInquirerPromptOptions = Record<promptNames.datasourceType, DatasourceTypePromptOptions> & Record<promptNames.metadataFilePath, MetadataPromptOptions> & Record<promptNames.capProject, CapProjectPromptOptions> & Record<promptNames.capService, CapServicePromptOptions> & Record<promptNames.serviceUrl, OdataServiceUrlPromptOptions> & Record<promptNames.serviceUrlPassword, OdataServiceUrlPasswordOptions> & Record<promptNames.serviceSelection, ServiceSelectionPromptOptions> & Record<promptNames.userSystemName, SystemNamePromptOptions> & Record<promptNames.systemSelection, SystemSelectionPromptOptions>;
 export type OdataServiceQuestion = YUIQuestion<OdataServiceAnswers>;
 export type OdataServicePromptOptions = Partial<odataServiceInquirerPromptOptions>;
 /**