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

package/dist/error-handler/error-handler.d.ts

@@ -1,3 +1,4 @@
+import type { Destination } from '@sap-ux/btp-utils';
 import { type Logger } from '@sap-ux/logger';
 import { ValidationLink } from '../types';
 /**
@@ -17,7 +18,7 @@ export declare enum ERROR_TYPE {
     TIMEOUT = "TIMEOUT",
     CONNECTION = "CONNECTION",
     SERVICES_UNAVAILABLE = "SERVICES_UNAVAILABLE",// All services
-    SERVICE_UNAVAILABLE = "SERVICE_UNAVAILABLE",// Specific service
+    SERVICE_UNAVAILABLE = "SERVICE_UNAVAILABLE",// HTTP 503 Not related to odata services
     NO_ABAP_ENVS = "NO_ABAP_ENVS",
     CATALOG_SERVICE_NOT_ACTIVE = "CATALOG_SERVICE_NOT_ACTIVE",
     NO_SUCH_HOST = "NO_SUCH_HOST",
@@ -30,7 +31,10 @@ export declare enum ERROR_TYPE {
     DESTINATION_NOT_FOUND = "DESTINATION_NOT_FOUND",
     DESTINATION_MISCONFIGURED = "DESTINATION_MISCONFIGURED",
     NO_V2_SERVICES = "NO_V2_SERVICES",
-    NO_V4_SERVICES = "NO_V4_SERVICES"
+    NO_V4_SERVICES = "NO_V4_SERVICES",
+    BAD_REQUEST = "BAD_REQUEST",
+    DESTINATION_CONNECTION_ERROR = "DESTINATION_CONNECTION_ERROR",// General destination connection error where a specific root cause cannot be determined e.g. In the case of an internal server error
+    SERVER_HTTP_ERROR = "SERVER_HTTP_ERROR"
 }
 export declare const ERROR_MAP: Record<ERROR_TYPE, RegExp[]>;
 type ValidationLinkOrString = string | ValidationLink;
@@ -45,6 +49,14 @@ export declare class ErrorHandler {
     private currentErrorType;
     private static _guidedAnswersEnabled;
     private static _logger;
+    private static readonly getMessageFromError;
+    private static readonly _errorTypeToMsg;
+    /**
+     *
+     * @param errorType
+     * @param error can be any object that will get stringified and passed to the specific error message for the error type entry, e.g. where the error message is parameterized
+     * @returns an error message for the specified error type
+     */
     private static readonly _errorMsg;
     /**
      * Get the Guided Answers (help) node for the specified error type.
@@ -134,12 +146,22 @@ export declare class ErrorHandler {
      * Used by validate functions to report in-line user friendly errors messages with help links.
      * If the error type is unknown, this will find a mapped error type and return the help (ValidationLink) if it exists.
      * If an error is not provided the current error state will be used. This does not log the message to the console.
+     * If a system is provided, the error type may be refined to provide a more specific error message for the system which generatd the error.
      *
      * @param error optional, if provided get the help link message that it maps to, otherwise get the previously logged error message help link
      * @param reset optional, resets the previous error state if true
+     * @param destination optional, if provided the destination may be used to determine a more relevant error message, specific to the system properties
      * @returns An instance of @see {ValidationLink}
      */
-    getValidationErrorHelp(error?: any, reset?: boolean): ValidationLinkOrString | undefined;
+    getValidationErrorHelp(error?: any, reset?: boolean, destination?: Destination): ValidationLinkOrString | undefined;
+    /**
+     * Get a more specific error type for the specified destination.
+     *
+     * @param errorType
+     * @param destination
+     * @returns
+     */
+    private static getDestinationSpecificError;
     /**
      * Get the error message for the specified error type.
      *

package/dist/error-handler/error-handler.js

@@ -2,12 +2,14 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ErrorHandler = exports.ERROR_MAP = exports.ERROR_TYPE = void 0;
 const btp_utils_1 = require("@sap-ux/btp-utils");
+const guided_answers_helper_1 = require("@sap-ux/guided-answers-helper");
 const logger_1 = require("@sap-ux/logger");
 const i18n_1 = require("../i18n");
 const types_1 = require("../types");
 const utils_1 = require("../utils");
-const guided_answers_helper_1 = require("@sap-ux/guided-answers-helper");
-const teleEventGALinkCreated = 'GA_LINK_CREATED';
+// Telemetry event names specific to odata service error handling
+const telemEventGALinkCreated = 'GA_LINK_CREATED';
+const telemBasError = 'SERVICE_INQUIRER_BAS_ERROR';
 /**
  * Constants specific to error handling
  */
@@ -40,6 +42,9 @@ var ERROR_TYPE;
     ERROR_TYPE["DESTINATION_MISCONFIGURED"] = "DESTINATION_MISCONFIGURED";
     ERROR_TYPE["NO_V2_SERVICES"] = "NO_V2_SERVICES";
     ERROR_TYPE["NO_V4_SERVICES"] = "NO_V4_SERVICES";
+    ERROR_TYPE["BAD_REQUEST"] = "BAD_REQUEST";
+    ERROR_TYPE["DESTINATION_CONNECTION_ERROR"] = "DESTINATION_CONNECTION_ERROR";
+    ERROR_TYPE["SERVER_HTTP_ERROR"] = "SERVER_HTTP_ERROR";
 })(ERROR_TYPE || (exports.ERROR_TYPE = ERROR_TYPE = {}));
 // Used to match regex expressions to error messages, etc. providing a way to return a consistent
 // single error and error msg for multiple errors
@@ -83,7 +88,10 @@ exports.ERROR_MAP = {
     [ERROR_TYPE.DESTINATION_NOT_FOUND]: [],
     [ERROR_TYPE.DESTINATION_MISCONFIGURED]: [],
     [ERROR_TYPE.NO_V2_SERVICES]: [],
-    [ERROR_TYPE.NO_V4_SERVICES]: []
+    [ERROR_TYPE.NO_V4_SERVICES]: [],
+    [ERROR_TYPE.BAD_REQUEST]: [/400/],
+    [ERROR_TYPE.DESTINATION_CONNECTION_ERROR]: [],
+    [ERROR_TYPE.SERVER_HTTP_ERROR]: [/5\d\d/] // catch all for 5xx server errors
 };
 /**
  * Maps errors to end-user messages using some basic root cause analysis based on regex matching.
@@ -96,48 +104,87 @@ class ErrorHandler {
     currentErrorType;
     static _guidedAnswersEnabled;
     static _logger;
-    // Get the required localized parameterized error message
-    // Note that these are general fallback end-user error messages.
-    // More specific error messages can be used at the point of error generation.
-    static _errorMsg = (error) => ({
-        [ERROR_TYPE.CERT]: (0, i18n_1.t)('errors.certificateError', { error }),
-        [ERROR_TYPE.CERT_EXPIRED]: (0, i18n_1.t)('errors.urlCertValidationError', { certErrorReason: (0, i18n_1.t)('texts.anExpiredCert') }),
-        [ERROR_TYPE.CERT_SELF_SIGNED]: (0, i18n_1.t)('errors.urlCertValidationError', {
+    static getMessageFromError = (error) => {
+        return (error?.message ||
+            error?.status?.toString() ||
+            error?.response?.status?.toString() ||
+            (typeof error === 'string' ? error : JSON.stringify(error)));
+    };
+    // Get the localized parameterized error message for the specified error type
+    static _errorTypeToMsg = {
+        [ERROR_TYPE.CERT]: (error) => (0, i18n_1.t)('errors.certificateError', { error: typeof error === 'string' ? error : JSON.stringify(error) }),
+        [ERROR_TYPE.CERT_EXPIRED]: () => (0, i18n_1.t)('errors.urlCertValidationError', { certErrorReason: (0, i18n_1.t)('texts.anExpiredCert') }),
+        [ERROR_TYPE.CERT_SELF_SIGNED]: () => (0, i18n_1.t)('errors.urlCertValidationError', {
             certErrorReason: (0, i18n_1.t)('texts.aSelfSignedCert')
         }),
-        [ERROR_TYPE.CERT_UKNOWN_OR_INVALID]: (0, i18n_1.t)('errors.urlCertValidationError', {
+        [ERROR_TYPE.CERT_UKNOWN_OR_INVALID]: () => (0, i18n_1.t)('errors.urlCertValidationError', {
             certErrorReason: (0, i18n_1.t)('texts.anUnknownOrInvalidCert')
         }),
-        [ERROR_TYPE.CERT_SELF_SIGNED_CERT_IN_CHAIN]: (0, i18n_1.t)('errors.urlCertValidationError', {
+        [ERROR_TYPE.CERT_SELF_SIGNED_CERT_IN_CHAIN]: () => (0, i18n_1.t)('errors.urlCertValidationError', {
             certErrorReason: (0, i18n_1.t)('texts.anUntrustedRootCert')
         }),
-        [ERROR_TYPE.AUTH]: (0, i18n_1.t)('errors.authenticationFailed', { error }),
-        [ERROR_TYPE.AUTH_TIMEOUT]: (0, i18n_1.t)('errors.authenticationTimeout'),
-        [ERROR_TYPE.TIMEOUT]: (0, i18n_1.t)('errors.timeout, { error }'),
-        [ERROR_TYPE.INVALID_URL]: (0, i18n_1.t)('errors.invalidUrl'),
-        [ERROR_TYPE.CONNECTION]: (0, i18n_1.t)('errors.connectionError', {
-            error: error?.message || JSON.stringify(error)
+        [ERROR_TYPE.AUTH]: (error) => (0, i18n_1.t)('errors.authenticationFailed', {
+            error: ErrorHandler.getMessageFromError(error)
+        }),
+        [ERROR_TYPE.AUTH_TIMEOUT]: () => (0, i18n_1.t)('errors.authenticationTimeout'),
+        [ERROR_TYPE.TIMEOUT]: (error) => (0, i18n_1.t)('errors.timeout', { error: typeof error === 'string' ? error : JSON.stringify(error) }),
+        [ERROR_TYPE.INVALID_URL]: () => (0, i18n_1.t)('errors.invalidUrl'),
+        [ERROR_TYPE.CONNECTION]: (error) => (0, i18n_1.t)('errors.connectionError', {
+            error: ErrorHandler.getMessageFromError(error)
         }),
-        [ERROR_TYPE.UNKNOWN]: (0, i18n_1.t)('errors.unknownError', {
-            error: error?.message || JSON.stringify(error)
+        [ERROR_TYPE.UNKNOWN]: (error) => (0, i18n_1.t)('errors.unknownError', {
+            error: ErrorHandler.getMessageFromError(error)
+        }),
+        [ERROR_TYPE.SERVICES_UNAVAILABLE]: () => (0, i18n_1.t)('errors.servicesUnavailable'),
+        [ERROR_TYPE.SERVICE_UNAVAILABLE]: (error) => (0, i18n_1.t)('errors.serverReturnedAnError', {
+            errorMsg: ErrorHandler.getMessageFromError(error)
+        }),
+        [ERROR_TYPE.CATALOG_SERVICE_NOT_ACTIVE]: () => (0, i18n_1.t)('errors.catalogServiceNotActive'),
+        [ERROR_TYPE.INTERNAL_SERVER_ERROR]: (error) => {
+            const errorMsg = ErrorHandler.getMessageFromError(error);
+            return (0, i18n_1.t)('errors.serverReturnedAnError', {
+                errorDesc: (0, i18n_1.t)('errors.internalServerError', { errorMsg })
+            });
+        },
+        [ERROR_TYPE.NOT_FOUND]: () => (0, i18n_1.t)('errors.urlNotFound'),
+        [ERROR_TYPE.ODATA_URL_NOT_FOUND]: () => (0, i18n_1.t)('errors.odataServiceUrlNotFound'),
+        [ERROR_TYPE.BAD_GATEWAY]: (error) => {
+            const errorMsg = ErrorHandler.getMessageFromError(error);
+            return (0, i18n_1.t)('errors.serverReturnedAnError', {
+                errorDesc: (0, i18n_1.t)('errors.badGateway', { errorMsg })
+            });
+        },
+        [ERROR_TYPE.DESTINATION_UNAVAILABLE]: () => (0, i18n_1.t)('errors.destination.unavailable'),
+        [ERROR_TYPE.DESTINATION_NOT_FOUND]: () => (0, i18n_1.t)('errors.destination.notFound'),
+        [ERROR_TYPE.DESTINATION_MISCONFIGURED]: (error) => (0, i18n_1.t)('errors.destination.misconfigured', {
+            destinationProperty: typeof error === 'string' ? error : JSON.stringify(error)
         }),
-        [ERROR_TYPE.SERVICES_UNAVAILABLE]: (0, i18n_1.t)('errors.servicesUnavailable'),
-        [ERROR_TYPE.SERVICE_UNAVAILABLE]: (0, i18n_1.t)('errors.serviceUnavailable'),
-        [ERROR_TYPE.CATALOG_SERVICE_NOT_ACTIVE]: (0, i18n_1.t)('errors.catalogServiceNotActive'),
-        [ERROR_TYPE.INTERNAL_SERVER_ERROR]: (0, i18n_1.t)('errors.internalServerError', { error: error?.message }),
-        [ERROR_TYPE.NOT_FOUND]: (0, i18n_1.t)('errors.urlNotFound'),
-        [ERROR_TYPE.ODATA_URL_NOT_FOUND]: (0, i18n_1.t)('errors.odataServiceUrlNotFound'),
-        [ERROR_TYPE.BAD_GATEWAY]: (0, i18n_1.t)('errors.badGateway'),
-        [ERROR_TYPE.DESTINATION_UNAVAILABLE]: (0, i18n_1.t)('errors.destinationUnavailable'),
-        [ERROR_TYPE.DESTINATION_NOT_FOUND]: (0, i18n_1.t)('errors.destinationNotFound'),
-        [ERROR_TYPE.DESTINATION_MISCONFIGURED]: (0, i18n_1.t)('errors.destinationMisconfigured'),
-        [ERROR_TYPE.NO_V2_SERVICES]: (0, i18n_1.t)('errors.noServicesAvailable', { version: '2' }),
-        [ERROR_TYPE.NO_V4_SERVICES]: (0, i18n_1.t)('errors.noServicesAvailable', { version: '4' }),
-        [ERROR_TYPE.DESTINATION_BAD_GATEWAY_503]: (0, i18n_1.t)('errors.destinationUnavailable'),
-        [ERROR_TYPE.REDIRECT]: (0, i18n_1.t)('errors.redirectError'),
-        [ERROR_TYPE.NO_SUCH_HOST]: (0, i18n_1.t)('errors.noSuchHostError'),
-        [ERROR_TYPE.NO_ABAP_ENVS]: (0, i18n_1.t)('errors.abapEnvsUnavailable')
-    });
+        [ERROR_TYPE.NO_V2_SERVICES]: () => (0, i18n_1.t)('errors.noServicesAvailable', { version: '2' }),
+        [ERROR_TYPE.NO_V4_SERVICES]: () => (0, i18n_1.t)('errors.noServicesAvailable', { version: '4' }),
+        [ERROR_TYPE.DESTINATION_BAD_GATEWAY_503]: () => (0, i18n_1.t)('errors.destination.unavailable'),
+        [ERROR_TYPE.REDIRECT]: () => (0, i18n_1.t)('errors.redirectError'),
+        [ERROR_TYPE.NO_SUCH_HOST]: () => (0, i18n_1.t)('errors.noSuchHostError'),
+        [ERROR_TYPE.NO_ABAP_ENVS]: () => (0, i18n_1.t)('errors.abapEnvsUnavailable'),
+        [ERROR_TYPE.BAD_REQUEST]: (error) => {
+            const errorMsg = ErrorHandler.getMessageFromError(error);
+            return (0, i18n_1.t)('errors.serverReturnedAnError', {
+                errorDesc: (0, i18n_1.t)('errors.badRequest', { errorMsg })
+            });
+        },
+        [ERROR_TYPE.DESTINATION_CONNECTION_ERROR]: () => (0, i18n_1.t)('errors.systemConnectionValidationFailed'),
+        [ERROR_TYPE.SERVER_HTTP_ERROR]: (error) => (0, i18n_1.t)('errors.serverReturnedAnError', {
+            errorDesc: ErrorHandler.getMessageFromError(error)
+        })
+    };
+    /**
+     *
+     * @param errorType
+     * @param error can be any object that will get stringified and passed to the specific error message for the error type entry, e.g. where the error message is parameterized
+     * @returns an error message for the specified error type
+     */
+    static _errorMsg = (errorType, error) => {
+        return ErrorHandler._errorTypeToMsg[errorType](error);
+    };
     /**
      * Get the Guided Answers (help) node for the specified error type.
      *
@@ -174,7 +221,10 @@ class ErrorHandler {
             [ERROR_TYPE.ODATA_URL_NOT_FOUND]: undefined,
             [ERROR_TYPE.INTERNAL_SERVER_ERROR]: undefined,
             [ERROR_TYPE.NO_V2_SERVICES]: undefined,
-            [ERROR_TYPE.TIMEOUT]: undefined
+            [ERROR_TYPE.TIMEOUT]: undefined,
+            [ERROR_TYPE.BAD_REQUEST]: undefined,
+            [ERROR_TYPE.DESTINATION_CONNECTION_ERROR]: guided_answers_helper_1.HELP_NODES.DESTINATION_CONNECTION_ERRORS,
+            [ERROR_TYPE.SERVER_HTTP_ERROR]: undefined
         };
         return errorToHelp[errorType];
     };
@@ -310,7 +360,7 @@ class ErrorHandler {
             errorType = ErrorHandler.getErrorType(this.findErrorValueForMapping(error)) ?? ERROR_TYPE.UNKNOWN;
         }
         return {
-            errorMsg: ErrorHandler._errorMsg(error)[errorType],
+            errorMsg: ErrorHandler._errorMsg(errorType, error),
             errorType
         };
     }
@@ -342,31 +392,83 @@ class ErrorHandler {
      * Used by validate functions to report in-line user friendly errors messages with help links.
      * If the error type is unknown, this will find a mapped error type and return the help (ValidationLink) if it exists.
      * If an error is not provided the current error state will be used. This does not log the message to the console.
+     * If a system is provided, the error type may be refined to provide a more specific error message for the system which generatd the error.
      *
      * @param error optional, if provided get the help link message that it maps to, otherwise get the previously logged error message help link
      * @param reset optional, resets the previous error state if true
+     * @param destination optional, if provided the destination may be used to determine a more relevant error message, specific to the system properties
      * @returns An instance of @see {ValidationLink}
      */
-    getValidationErrorHelp(error, reset = false) {
+    getValidationErrorHelp(error, reset = false, destination) {
         let errorHelp;
-        let errorMsg;
+        let resolvedErrorMsg;
+        let resolvedErrorType;
         if (error) {
-            const resolvedError = ErrorHandler.mapErrorToMsg(error);
-            if (resolvedError.errorType !== ERROR_TYPE.UNKNOWN) {
-                errorHelp = ErrorHandler.getHelpForError(resolvedError.errorType, resolvedError.errorMsg);
-            }
+            ({ errorMsg: resolvedErrorMsg, errorType: resolvedErrorType } = ErrorHandler.mapErrorToMsg(error));
         }
-        else if (!error) {
-            errorMsg = this.currentErrorMsg ?? '';
+        else {
+            // Use the existing error if we have it
+            resolvedErrorMsg = this.currentErrorMsg ?? undefined;
             if (this.currentErrorType) {
-                errorHelp = ErrorHandler.getHelpForError(this.currentErrorType, errorMsg);
+                resolvedErrorType = this.currentErrorType;
+            }
+        }
+        if (resolvedErrorType) {
+            // If the destination is provided, we can refine the error type and therefore the generated help message, to be more specific
+            if (destination) {
+                const { errorType: destErrorType, errorMsg: destErrorMsg } = ErrorHandler.getDestinationSpecificError(resolvedErrorType, destination);
+                resolvedErrorMsg = destErrorMsg ?? resolvedErrorMsg;
+                resolvedErrorType = destErrorType ?? resolvedErrorType;
+            }
+            if (resolvedErrorType) {
+                errorHelp = ErrorHandler.getHelpForError(resolvedErrorType, resolvedErrorMsg);
             }
         }
         if (reset) {
             this.currentErrorMsg = null;
             this.currentErrorType = null;
         }
-        return errorHelp ?? errorMsg;
+        return errorHelp ?? resolvedErrorMsg; // We mau not have a help link, so return the resolvedend user message
+    }
+    /**
+     * Get a more specific error type for the specified destination.
+     *
+     * @param errorType
+     * @param destination
+     * @returns
+     */
+    static getDestinationSpecificError(errorType, destination) {
+        let destErrorType;
+        let destErrorMsg;
+        // Add more specific error types for destinations here
+        if (!(0, btp_utils_1.isHTML5DynamicConfigured)(destination)) {
+            destErrorType = ERROR_TYPE.DESTINATION_MISCONFIGURED;
+            destErrorMsg = this.getErrorMsgFromType(destErrorType, 'HTML5.DynamicDestination');
+        }
+        else if (errorType === ERROR_TYPE.SERVICE_UNAVAILABLE) {
+            if ((0, btp_utils_1.isOnPremiseDestination)(destination)) {
+                destErrorType = ERROR_TYPE.DESTINATION_BAD_GATEWAY_503; // Remap to specific gateway to allow GA link to be associated
+            }
+            else {
+                destErrorType = ERROR_TYPE.DESTINATION_CONNECTION_ERROR; // General destination connection error, GA link to connection page
+            }
+        }
+        else if (errorType === ERROR_TYPE.NOT_FOUND) {
+            destErrorType = ERROR_TYPE.DESTINATION_NOT_FOUND;
+        }
+        else if (ERROR_TYPE.INTERNAL_SERVER_ERROR === errorType || ERROR_TYPE.SERVER_HTTP_ERROR === errorType) {
+            // We cannot tell in BAS what this means, so we will just say the connection failed
+            destErrorType = ERROR_TYPE.DESTINATION_CONNECTION_ERROR;
+        }
+        // Always raise a telemetry event for destination related errors
+        (0, utils_1.sendTelemetryEvent)(telemBasError, {
+            basErrorType: destErrorType ?? errorType,
+            destODataType: (0, utils_1.getTelemPropertyDestinationType)(destination)
+        });
+        return {
+            errorType: destErrorType ?? errorType,
+            errorMsg: destErrorMsg
+        };
     }
     /**
      * Get the error message for the specified error type.
@@ -377,7 +479,7 @@ class ErrorHandler {
      */
     static getErrorMsgFromType(errorType, error) {
         if (ERROR_TYPE[errorType]) {
-            return ErrorHandler._errorMsg(error)[ERROR_TYPE[errorType]];
+            return ErrorHandler._errorMsg(ERROR_TYPE[errorType], error);
         }
         return undefined;
     }
@@ -402,7 +504,7 @@ class ErrorHandler {
      * @param error - the original error, if any
      */
     setCurrentError(errorType, error) {
-        this.currentErrorMsg = ErrorHandler._errorMsg(error)[ERROR_TYPE[errorType]];
+        this.currentErrorMsg = ErrorHandler._errorMsg(ERROR_TYPE[errorType], error);
         this.currentErrorType = errorType;
     }
     /**
@@ -451,7 +553,7 @@ class ErrorHandler {
                 };
             }
             // Report the GA link created event
-            (0, utils_1.sendTelemetryEvent)(teleEventGALinkCreated, {
+            (0, utils_1.sendTelemetryEvent)(telemEventGALinkCreated, {
                 errorType,
                 isGuidedAnswersEnabled: this.guidedAnswersEnabled,
                 nodeIdPath: `${helpNode}`

package/dist/i18n.js

@@ -14,16 +14,28 @@ exports.defaultProjectNumber = 1;
  * Initialize i18next with the translations for this module.
  */
 async function initI18nOdataServiceInquirer() {
+    const t0 = performance.now();
     await i18next_1.default.init({
         lng: 'en',
         fallbackLng: 'en',
         missingInterpolationHandler: () => '',
         interpolation: {
-            format: function odataVersionFormatter(odataVersion) {
-                return odataVersion ? ` V${odataVersion}` : '';
+            format: function (value, format) {
+                // OData version formatter
+                if (format === 'odataVersionFormatter') {
+                    return value ? ` V${value}` : '';
+                }
+                // If we have a value add a colon before outputting
+                if (format === 'addMsgWithColonFormatter') {
+                    return value ? `: ${value}` : '';
+                }
+                return value;
             }
         }
-    }, () => i18next_1.default.addResourceBundle('en', odataServiceInquirerNamespace, odata_service_inquirer_i18n_json_1.default));
+    });
+    i18next_1.default.addResourceBundle('en', odataServiceInquirerNamespace, odata_service_inquirer_i18n_json_1.default);
+    const t1 = performance.now();
+    console.log(`i18n load time: ${Math.round(t1 - t0)} milliseconds`);
 }
 /**
  * Helper function facading the call to i18next. Unless a namespace option is provided the local namespace will be used.

package/dist/index.d.ts

@@ -3,7 +3,7 @@ import { type Logger } from '@sap-ux/logger';
 import { OdataVersion } from '@sap-ux/odata-service-writer';
 import { type ToolsSuiteTelemetryClient } from '@sap-ux/telemetry';
 import { ERROR_TYPE, ErrorHandler } from './error-handler/error-handler';
-import { newSystemChoiceValue } from './prompts/datasources/sap-system/new-system/questions';
+import { SystemSelectionAnswerType } from './prompts/datasources/sap-system/system-selection';
 import { DatasourceType, promptNames, type CapRuntime, type CapService, type OdataServiceAnswers, type OdataServicePromptOptions, type OdataServiceQuestion, type SapSystemType } from './types';
 /**
  * Get the inquirer prompts for odata service.
@@ -31,5 +31,5 @@ declare function getPrompts(promptOptions?: OdataServicePromptOptions, logger?:
  * @returns the prompt answers
  */
 declare function prompt(adapter: InquirerAdapter, promptOptions?: OdataServicePromptOptions, logger?: Logger, enableGuidedAnswers?: boolean, telemetryClient?: ToolsSuiteTelemetryClient, isYUI?: boolean): Promise<OdataServiceAnswers>;
-export { DatasourceType, ERROR_TYPE, ErrorHandler, OdataVersion, getPrompts, newSystemChoiceValue, prompt, promptNames, type CapRuntime, type CapService, type InquirerAdapter, type OdataServiceAnswers, type OdataServicePromptOptions, type SapSystemType };
+export { DatasourceType, ERROR_TYPE, ErrorHandler, getPrompts, OdataVersion, prompt, promptNames, SystemSelectionAnswerType, type CapRuntime, type CapService, type InquirerAdapter, type OdataServiceAnswers, type OdataServicePromptOptions, type SapSystemType };
 //# sourceMappingURL=index.d.ts.map

package/dist/index.js

@@ -3,7 +3,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.promptNames = exports.newSystemChoiceValue = exports.OdataVersion = exports.ErrorHandler = exports.ERROR_TYPE = exports.DatasourceType = void 0;
+exports.promptNames = exports.OdataVersion = exports.ErrorHandler = exports.ERROR_TYPE = exports.DatasourceType = void 0;
 exports.getPrompts = getPrompts;
 exports.prompt = prompt;
 const odata_service_writer_1 = require("@sap-ux/odata-service-writer");
@@ -14,8 +14,6 @@ Object.defineProperty(exports, "ERROR_TYPE", { enumerable: true, get: function (
 Object.defineProperty(exports, "ErrorHandler", { enumerable: true, get: function () { return error_handler_1.ErrorHandler; } });
 const i18n_1 = require("./i18n");
 const prompts_1 = require("./prompts");
-const questions_1 = require("./prompts/datasources/sap-system/new-system/questions");
-Object.defineProperty(exports, "newSystemChoiceValue", { enumerable: true, get: function () { return questions_1.newSystemChoiceValue; } });
 const logger_helper_1 = __importDefault(require("./prompts/logger-helper"));
 const types_1 = require("./types");
 Object.defineProperty(exports, "DatasourceType", { enumerable: true, get: function () { return types_1.DatasourceType; } });

package/dist/prompts/connectionValidator.d.ts

@@ -1,6 +1,8 @@
 import type { IValidationLink } from '@sap-devx/yeoman-ui-types';
 import type { AxiosRequestConfig, CatalogService, ODataService, ServiceInfo, ServiceProvider } from '@sap-ux/axios-extension';
 import { ODataVersion } from '@sap-ux/axios-extension';
+import { type Destination } from '@sap-ux/btp-utils';
+import { ERROR_TYPE } from '../error-handler/error-handler';
 /**
  * Structure to store validity information about url to be validated.
  */
@@ -11,7 +13,7 @@ interface Validity {
     authenticated?: boolean;
     canSkipCertError?: boolean;
 }
-type ValidationResult = string | boolean | IValidationLink;
+export type ValidationResult = string | boolean | IValidationLink;
 export type SystemAuthType = 'serviceKey' | 'reentranceTicket' | 'basic' | 'unknown';
 /**
  * Class that can be used to determine the connectivity using a service url, system url, or service info (UAA Key details) or reentrance ticket.
@@ -23,6 +25,8 @@ export type SystemAuthType = 'serviceKey' | 'reentranceTicket' | 'basic' | 'unkn
 export declare class ConnectionValidator {
     readonly validity: Validity;
     private _validatedUrl;
+    private _destinationUrl;
+    private _destination;
     private _validatedClient;
     private _odataService;
     private _serviceProvider;
@@ -105,6 +109,18 @@ export declare class ConnectionValidator {
      * @returns the refresh token
      */
     get refreshToken(): string | undefined;
+    /**
+     * Get the full expanded destination url as defined in the destination configuration. This should not be used to connect from App Studio (use the .dest form).
+     *
+     * @returns the connected destination 'URL' attribute value
+     */
+    get destinationUrl(): string | undefined;
+    /**
+     * Get the  destination.
+     *
+     * @returns the connected destination 'URL' attribute value
+     */
+    get destination(): Destination | undefined;
     /**
      * Get the connected system name. If previously set this will be used, otherwise the name is determined
      * by the system auth type, or the validated url.
@@ -128,8 +144,9 @@ export declare class ConnectionValidator {
      * @param options.isSystem if true, the url will be treated as a system url rather than a service url
      * @param options.odataVersion if specified will restrict catalog requests to only the specified odata version
      * @returns the status code or error returned by the connection attempt
+     * @throws an error if the connection attempt fails and the error is a 500 on App Studio or a non-axios error is caught
      */
-    private checkSapServiceUrl;
+    private checkUrl;
     /**
      * Create the axios configuration object for the service or system connection.
      *
@@ -147,7 +164,11 @@ export declare class ConnectionValidator {
      * @param servicePath the service path without the origin
      */
     private createOdataServiceConnection;
-    resetConnectionState(): void;
+    /**
+     *
+     * @param resetValidity
+     */
+    resetConnectionState(resetValidity?: boolean): void;
     /**
      * Create the connection for a system url, the specified axios config or the specified service info.
      *
@@ -156,6 +177,8 @@ export declare class ConnectionValidator {
      * @param connectConfig.url the system url
      * @param connectConfig.serviceInfo the service info
      * @param connectConfig.odataVersion the odata version to restrict the catalog requests if only a specific version is required
+     * @param connectConfig.destination the destination to connect with
+     * @throws an error if the connection attempt fails, callers should handle the error
      */
     private createSystemConnection;
     /**
@@ -166,7 +189,7 @@ export declare class ConnectionValidator {
      */
     private shouldAttemptV4Catalog;
     /**
-     * Callback for when the refresh token changes.
+     * Callback for when the Abap cloud system refresh token changes.
      *
      * @param refreshToken the new refresh token
      */
@@ -181,14 +204,38 @@ export declare class ConnectionValidator {
     private getAbapOnCloudServiceProvider;
     /**
      * Validate the system connectivity with the specified service info (containing UAA details).
+     * This will create a connection to the system, updating the service provider reference.
+     * The connected user name will be cached for later use.
      *
      * @param serviceInfo the service info containing the UAA details
      * @param odataVersion the odata version to restrict the catalog requests if only a specific version is required
-     * @returns true if the system is reachable, false if not, or an error message string
+     * @returns true if the system is reachable and authenticated, if required, false if not, or an error message string
      */
     validateServiceInfo(serviceInfo: ServiceInfo, odataVersion?: ODataVersion): Promise<ValidationResult>;
     /**
-     * Validates the system or service url format as well as its reachability.
+     * Validate the specified destination connectivity, determining if authentication is required or if the destination is misconfigured.
+     *
+     * @param destination the destination to validate
+     * @param odataVersion the odata version to restrict the catalog requests if only a specific version is required
+     * @param servicePath the service path to validate, if specified will be appended to the destination URL for validation, if not specified the destination url will be used
+     * @returns true if the system is reachable and authenticated, if required, false if not, or an error message string
+     */
+    validateDestination(destination: Destination, odataVersion?: ODataVersion, servicePath?: string): Promise<{
+        valResult: ValidationResult;
+        errorType?: ERROR_TYPE;
+    }>;
+    /**
+     * Validate the connectivity to a destination odata service (for generic odata service destinations), determining, for example, if authentication is required.
+     *
+     * @param destination a destination that is a generic odata service destination
+     * @param servicePath additional service path to append to the destination URL
+     * @param requiredOdataVersion the required odata version, if specified will validate the odata service version satisfies the specified version
+     * @returns validation result and error type if validation fails
+     */
+    private validateOdataServiceDestination;
+    /**
+     * Validates an odata service url format as well as its reachability. Note if this function returns true, this is only an indication that the system is reachable
+     * not that a connection has been established. The connection may require separate authentication or other steps (it may be reachable but a cert error was returned).
      *
      * @param serviceUrl the url to validate, may be a system or service url.
      *     Note that if systemAuthType is specified, the url will be treated as a system url (only the origin will be considered)
@@ -197,17 +244,18 @@ export declare class ConnectionValidator {
      * @param options.forceReValidation force re-validation of the url
      * @param options.isSystem if true, the url will be treated as a system url rather than a service url, this value is retained for subsequent calls
      * @param options.odataVersion if specified will restrict catalog requests to only the specified odata version
+     * @param options.systemAuthType the system auth type used to create system connections, if not specified or `isSystem` is false or undefined, `basic` is assumed
      * @returns true if the url is reachable, false if not, or an error message string
      */
-    validateUrl(serviceUrl: string, { ignoreCertError, forceReValidation, isSystem, odataVersion }?: {
+    validateUrl(serviceUrl: string, { ignoreCertError, forceReValidation, isSystem, odataVersion, systemAuthType }?: {
         ignoreCertError?: boolean;
         forceReValidation?: boolean;
         isSystem?: boolean;
         odataVersion?: ODataVersion;
+        systemAuthType?: SystemAuthType;
     }): Promise<ValidationResult>;
     /**
-     * Converts the http status code into 'validty' and returns true if the status code indicates that the URL was reachable.
-     * Sets the instance validity state based on the status code.
+     * Sets the instance validity state based on the status code and returns true if the status code indicates that the URL was reachable.
      *
      * @param status a http request status code used to determine the validation result
      * @returns true, if the status code indicates the url is reachable, false if not, or an error message string
@@ -229,7 +277,7 @@ export declare class ConnectionValidator {
     private isUrlValidated;
     /**
      * Check whether basic auth is required for the given url, or for the previously validated url if none specified.
-     * This will also set the validity state for the url. This will not validate the URL.
+     * This will also set the validity state for the url.
      *
      * @param urlString the url to validate, if not provided the previously validated url will be used
      * @param client optional, sap client code, if not provided the previously validated client will be used
@@ -250,12 +298,15 @@ export declare class ConnectionValidator {
      * @param options.odataVersion if specified will restrict catalog requests to only the specified odata version
      * @returns true if the authentication is successful, false if not, or an error message string
      */
-    validateAuth(url: string, username: string, password: string, { ignoreCertError, sapClient, odataVersion, isSystem }?: {
+    validateAuth(url: string, username?: string, password?: string, { ignoreCertError, sapClient, odataVersion, isSystem }?: {
         ignoreCertError?: boolean;
         odataVersion?: ODataVersion;
         sapClient?: string;
         isSystem?: boolean;
-    }): Promise<ValidationResult>;
+    }): Promise<{
+        valResult: ValidationResult;
+        errorType?: ERROR_TYPE;
+    }>;
     /**
      * Reset the validity state.
      */