@sap-ux/inquirer-common 0.4.9 → 0.5.0

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

@@ -0,0 +1,239 @@
+import { type Destination } from '@sap-ux/btp-utils';
+import { type HostEnvironmentId } from '@sap-ux/fiori-generator-shared/src/types';
+import { type Logger } from '@sap-ux/logger';
+import { ValidationLink } from '../types';
+/**
+ * Constants specific to error handling
+ */
+export declare enum ERROR_TYPE {
+    AUTH = "AUTH",
+    AUTH_TIMEOUT = "AUTH_TIMEOUT",
+    REDIRECT = "REDIRECT",
+    CERT = "CERT",// General cert error
+    CERT_SELF_SIGNED = "CERT_SELF_SIGNED",
+    CERT_UKNOWN_OR_INVALID = "CERT_UKNOWN_OR_INVALID",
+    CERT_EXPIRED = "CERT_EXPIRED",
+    CERT_SELF_SIGNED_CERT_IN_CHAIN = "CERT_SELF_SIGNED_CERT_IN_CHAIN",
+    UNKNOWN = "UNKNOWN",
+    INVALID_URL = "INVALID_URL",
+    TIMEOUT = "TIMEOUT",
+    CONNECTION = "CONNECTION",
+    SERVICES_UNAVAILABLE = "SERVICES_UNAVAILABLE",// All services
+    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",
+    NOT_FOUND = "NOT_FOUND",
+    ODATA_URL_NOT_FOUND = "ODATA_URL_NOT_FOUND",
+    BAD_GATEWAY = "BAD_GATEWAY",// Can be caused by either local issue or endpoint configuration
+    INTERNAL_SERVER_ERROR = "INTERNAL_SERVER_ERROR",
+    DESTINATION_BAD_GATEWAY_503 = "DESTINATION_BAD_GATEWAY_503",// Caused by endpoint using a firewall or proxy
+    DESTINATION_UNAVAILABLE = "DESTINATION_UNAVAILABLE",
+    DESTINATION_NOT_FOUND = "DESTINATION_NOT_FOUND",
+    DESTINATION_MISCONFIGURED = "DESTINATION_MISCONFIGURED",
+    NO_V2_SERVICES = "NO_V2_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;
+/**
+ * Maps errors to end-user messages using some basic root cause analysis based on regex matching.
+ * This class will also log errors and provide help links for validation errors in some limited use cases.
+ */
+export declare class ErrorHandler {
+    /** The last error message generated */
+    private currentErrorMsg;
+    /** The last error message type generated if determined */
+    private currentErrorType;
+    private static _guidedAnswersEnabled;
+    private static _logger;
+    /**
+     * The current platform string to be reported in telemetry events. If not provided it will be determined from the environment.
+     */
+    private static _platform;
+    /**
+     * Get the current platform string that would be used by the error handler.
+     *
+     * @returns the platform string as defined by `HostEnvironmentId` or the value set by the user
+     */
+    static get platform(): HostEnvironmentId | undefined;
+    /**
+     * Set platform string usually defined by `HostEnvironmentId`
+     *
+     * @param value the platform string to set
+     */
+    static set platform(value: HostEnvironmentId | undefined);
+    /**
+     * The Guided Answers (help) trigger property sent with some telemetry events.
+     */
+    private static _guidedAnswersTrigger;
+    /**
+     * Get the Guided Answers (help) trigger property.
+     *
+     * @returns the Guided Answers trigger property
+     */
+    static get guidedAnswersTrigger(): string | undefined;
+    /**
+     * Set the Guided Answers (help) trigger property.
+     *
+     * @param value the Guided Answers trigger property
+     */
+    static set guidedAnswersTrigger(value: string | undefined);
+    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.
+     *
+     * @param errorType The error type for which a help node (help content id) may be returned
+     * @returns The Guided Answers node for the specified error type
+     */
+    private static readonly getHelpNode;
+    /**
+     * Find an error property for mapping to a general error type from most to least significant.
+     *
+     * @param error any type of error or object that has an error code, status, name or message
+     * @returns a value that can be used to look up a general error type
+     */
+    private static readonly findErrorValueForMapping;
+    /**
+     * Create an instance of the ErrorHandler.
+     *
+     * @param logger the logger instance to use
+     * @param enableGuidedAnswers if true, the end user validation errors will include guided answers to provide help
+     */
+    constructor(logger?: Logger, enableGuidedAnswers?: boolean);
+    /**
+     * Get Guided Answers (context help) enabled value.
+     *
+     * @returns true if Guided Answers is enabled
+     */
+    static get guidedAnswersEnabled(): boolean;
+    /**
+     * Toggle Guided Answers (context help) for validation errors.
+     */
+    static set guidedAnswersEnabled(value: boolean);
+    /**
+     * Set the logger to be used for error messages.
+     *
+     * @param logger the logger instance to use
+     */
+    static set logger(logger: Logger);
+    /**
+     * Get the logger used for error messages.
+     *
+     * @returns the logger instance
+     */
+    static get logger(): Logger;
+    /**
+     * Tests if the error is a general certificate error.
+     *
+     * @param status the error type
+     * @returns true if the error is a general certificate error
+     */
+    static isCertError(status: string | number): boolean;
+    /**
+     * Get the error type for the specified error, mapping status code, error code, error name, error message to a few general error types.
+     *
+     * @param error the error, string or status code to get the type for
+     * @returns the error type
+     */
+    static getErrorType(error: string | number | Error): ERROR_TYPE;
+    /**
+     * Maps errors to a few generic types, log a detailed error.
+     *
+     * @param error If the error is a string this will be logged as is. Otherwise it will be mapped to a general error internally, possibly retained and logged.
+     * @param userMsg If provided this will be set as the userErrorMsg instead of an error to msg map
+     *  this allows a message more relevant to the context of where the error was generated to be used.
+     * @param retainError Defaults to true to retain the error state.
+     * @returns A user-friendly message for display in-line
+     */
+    logErrorMsgs(error: unknown, userMsg?: string, retainError?: boolean): string;
+    /**
+     * Maps an error to a user-friendly message. The specified error may by a string (e.g. error message), number (e.g. status code), Error, or Axios error.
+     *
+     * @param error The error to map
+     * @returns The mapped error message and error type
+     */
+    private static mapErrorToMsg;
+    /**
+     * Used by validate functions to report in-line user friendly errors.
+     * Checks if there is an existing error.
+     *
+     * @param error optional, if provided get the end user message that it maps to, otherwise get the previous error message, if a boolean is passed it will be interpreted as `reset`.
+     * @param reset optional, resets the previous error state if true, if error is omitted reset may be passed as the first argument
+     * @param fallback optional, return the message of the specified ERROR_TYPE if no previous end user message and no error specified
+     * @returns The error message
+     */
+    getErrorMsg(error?: any, reset?: boolean, fallback?: ERROR_TYPE): string | undefined;
+    /**
+     * 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, 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.
+     *
+     * @param errorType The error type for which the message may be returned
+     * @param error optional, if provided may be used to get generate a more specific error message, or be included in the message
+     * @returns The error message for the specified error type
+     */
+    static getErrorMsgFromType(errorType: ERROR_TYPE, error?: any): string | undefined;
+    /**
+     * Checks if there is an existing error.
+     *
+     * @param reset - resets the current error state
+     * @returns true if there is an existing error
+     */
+    hasError(reset?: boolean): boolean;
+    /**
+     * Sets the current error state.
+     *
+     * @param errorType - the error type
+     * @param error - the original error, if any
+     */
+    setCurrentError(errorType: ERROR_TYPE, error?: any): void;
+    /**
+     * Gets the current error type state.
+     *
+     * @param reset - resets the current error state
+     * @returns The current error type
+     */
+    getCurrentErrorType(reset?: boolean): ERROR_TYPE | null;
+    /**
+     * Maps an error type to a validation link if help (Guided Answers topic) is available for the specified error.
+     * Otherwise the specified error message is returned. To retrieve the previous error state @see getValidationErrorHelp.
+     * Use this (getHelpForError) if the error type is known.
+     *
+     * @param errorType - the error type to be mapped to help link
+     * @param errorMsg - the message to appear with the help link
+     * @returns A validation help link or help link message
+     */
+    static getHelpForError(errorType: ERROR_TYPE, errorMsg?: string): ValidationLinkOrString | undefined;
+}
+export {};
+//# sourceMappingURL=error-handler.d.ts.map

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

@@ -0,0 +1,610 @@
+"use strict";
+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 fiori_generator_shared_1 = require("@sap-ux/fiori-generator-shared");
+const guided_answers_helper_1 = require("@sap-ux/guided-answers-helper");
+const logger_1 = require("@sap-ux/logger");
+const i18n_1 = require("../i18n");
+const telemetry_1 = require("../telemetry/telemetry");
+const types_1 = require("../types");
+// 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
+ */
+var ERROR_TYPE;
+(function (ERROR_TYPE) {
+    ERROR_TYPE["AUTH"] = "AUTH";
+    ERROR_TYPE["AUTH_TIMEOUT"] = "AUTH_TIMEOUT";
+    ERROR_TYPE["REDIRECT"] = "REDIRECT";
+    ERROR_TYPE["CERT"] = "CERT";
+    ERROR_TYPE["CERT_SELF_SIGNED"] = "CERT_SELF_SIGNED";
+    ERROR_TYPE["CERT_UKNOWN_OR_INVALID"] = "CERT_UKNOWN_OR_INVALID";
+    ERROR_TYPE["CERT_EXPIRED"] = "CERT_EXPIRED";
+    ERROR_TYPE["CERT_SELF_SIGNED_CERT_IN_CHAIN"] = "CERT_SELF_SIGNED_CERT_IN_CHAIN";
+    ERROR_TYPE["UNKNOWN"] = "UNKNOWN";
+    ERROR_TYPE["INVALID_URL"] = "INVALID_URL";
+    ERROR_TYPE["TIMEOUT"] = "TIMEOUT";
+    ERROR_TYPE["CONNECTION"] = "CONNECTION";
+    ERROR_TYPE["SERVICES_UNAVAILABLE"] = "SERVICES_UNAVAILABLE";
+    ERROR_TYPE["SERVICE_UNAVAILABLE"] = "SERVICE_UNAVAILABLE";
+    ERROR_TYPE["NO_ABAP_ENVS"] = "NO_ABAP_ENVS";
+    ERROR_TYPE["CATALOG_SERVICE_NOT_ACTIVE"] = "CATALOG_SERVICE_NOT_ACTIVE";
+    ERROR_TYPE["NO_SUCH_HOST"] = "NO_SUCH_HOST";
+    ERROR_TYPE["NOT_FOUND"] = "NOT_FOUND";
+    ERROR_TYPE["ODATA_URL_NOT_FOUND"] = "ODATA_URL_NOT_FOUND";
+    ERROR_TYPE["BAD_GATEWAY"] = "BAD_GATEWAY";
+    ERROR_TYPE["INTERNAL_SERVER_ERROR"] = "INTERNAL_SERVER_ERROR";
+    ERROR_TYPE["DESTINATION_BAD_GATEWAY_503"] = "DESTINATION_BAD_GATEWAY_503";
+    ERROR_TYPE["DESTINATION_UNAVAILABLE"] = "DESTINATION_UNAVAILABLE";
+    ERROR_TYPE["DESTINATION_NOT_FOUND"] = "DESTINATION_NOT_FOUND";
+    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
+exports.ERROR_MAP = {
+    [ERROR_TYPE.AUTH]: [
+        /401/,
+        /403/,
+        /Incorrect credentials were provided to login/, // API Hub error msg
+        /Unable to retrieve SAP Business Accelerator Hub key/ // API Hub error msg
+    ],
+    [ERROR_TYPE.AUTH_TIMEOUT]: [/UAATimeoutError/],
+    [ERROR_TYPE.TIMEOUT]: [/Timeout/],
+    [ERROR_TYPE.CERT]: [], // General cert error, unspecified root cause
+    [ERROR_TYPE.CERT_UKNOWN_OR_INVALID]: [
+        /UNABLE_TO_GET_ISSUER_CERT/,
+        /UNABLE_TO_GET_ISSUER_CERT_LOCALLY/,
+        /unable to get local issuer certificate/
+    ],
+    [ERROR_TYPE.CERT_EXPIRED]: [/CERT_HAS_EXPIRED/],
+    [ERROR_TYPE.CERT_SELF_SIGNED]: [/DEPTH_ZERO_SELF_SIGNED_CERT/],
+    [ERROR_TYPE.CERT_SELF_SIGNED_CERT_IN_CHAIN]: [/SELF_SIGNED_CERT_IN_CHAIN/],
+    [ERROR_TYPE.UNKNOWN]: [],
+    [ERROR_TYPE.CONNECTION]: [/ENOTFOUND/, /ECONNRESET/, /ECONNREFUSED/, /ConnectionError/],
+    [ERROR_TYPE.SERVICES_UNAVAILABLE]: [],
+    [ERROR_TYPE.SERVICE_UNAVAILABLE]: [/503/],
+    [ERROR_TYPE.INVALID_URL]: [/Invalid URL/, /ERR_INVALID_URL/],
+    [ERROR_TYPE.REDIRECT]: [/3\d\d/],
+    [ERROR_TYPE.NO_ABAP_ENVS]: [],
+    [ERROR_TYPE.CATALOG_SERVICE_NOT_ACTIVE]: [
+        /\/IWBEP\/CM_V4_COS\/014/,
+        /\/IWFND\/CM_V4_COS\/021/,
+        /Service group '\/IWFND\/CONFIG' not published/
+    ],
+    [ERROR_TYPE.NO_SUCH_HOST]: [/no such host/],
+    [ERROR_TYPE.NOT_FOUND]: [/404/],
+    [ERROR_TYPE.ODATA_URL_NOT_FOUND]: [],
+    [ERROR_TYPE.INTERNAL_SERVER_ERROR]: [/500/],
+    [ERROR_TYPE.BAD_GATEWAY]: [/502/],
+    [ERROR_TYPE.DESTINATION_BAD_GATEWAY_503]: [],
+    [ERROR_TYPE.DESTINATION_UNAVAILABLE]: [],
+    [ERROR_TYPE.DESTINATION_NOT_FOUND]: [],
+    [ERROR_TYPE.DESTINATION_MISCONFIGURED]: [],
+    [ERROR_TYPE.NO_V2_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.
+ * This class will also log errors and provide help links for validation errors in some limited use cases.
+ */
+class ErrorHandler {
+    /** The last error message generated */
+    currentErrorMsg;
+    /** The last error message type generated if determined */
+    currentErrorType;
+    static _guidedAnswersEnabled;
+    static _logger;
+    /**
+     * The current platform string to be reported in telemetry events. If not provided it will be determined from the environment.
+     */
+    static _platform;
+    /**
+     * Get the current platform string that would be used by the error handler.
+     *
+     * @returns the platform string as defined by `HostEnvironmentId` or the value set by the user
+     */
+    static get platform() {
+        return ErrorHandler._platform;
+    }
+    /**
+     * Set platform string usually defined by `HostEnvironmentId`
+     *
+     * @param value the platform string to set
+     */
+    static set platform(value) {
+        ErrorHandler._platform = value;
+    }
+    /**
+     * The Guided Answers (help) trigger property sent with some telemetry events.
+     */
+    static _guidedAnswersTrigger;
+    /**
+     * Get the Guided Answers (help) trigger property.
+     *
+     * @returns the Guided Answers trigger property
+     */
+    static get guidedAnswersTrigger() {
+        return ErrorHandler._guidedAnswersTrigger;
+    }
+    /**
+     * Set the Guided Answers (help) trigger property.
+     *
+     * @param value the Guided Answers trigger property
+     */
+    static set guidedAnswersTrigger(value) {
+        ErrorHandler._guidedAnswersTrigger = value;
+    }
+    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', { errorMsg: ErrorHandler.getMessageFromError(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', {
+            certErrorReason: (0, i18n_1.t)('texts.anUnknownOrInvalidCert')
+        }),
+        [ERROR_TYPE.CERT_SELF_SIGNED_CERT_IN_CHAIN]: () => (0, i18n_1.t)('errors.urlCertValidationError', {
+            certErrorReason: (0, i18n_1.t)('texts.anUntrustedRootCert')
+        }),
+        [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', { errorMsg: ErrorHandler.getMessageFromError(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]: (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 : ''
+        }),
+        [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.
+     *
+     * @param errorType The error type for which a help node (help content id) may be returned
+     * @returns The Guided Answers node for the specified error type
+     */
+    static getHelpNode = (errorType) => {
+        const errorToHelp = {
+            [ERROR_TYPE.SERVICES_UNAVAILABLE]: (0, btp_utils_1.isAppStudio)()
+                ? guided_answers_helper_1.HELP_NODES.BAS_CATALOG_SERVICES_REQUEST_FAILED
+                : undefined,
+            [ERROR_TYPE.CERT]: guided_answers_helper_1.HELP_NODES.CERTIFICATE_ERROR,
+            [ERROR_TYPE.CERT_SELF_SIGNED]: guided_answers_helper_1.HELP_NODES.CERTIFICATE_ERROR,
+            [ERROR_TYPE.CERT_UKNOWN_OR_INVALID]: guided_answers_helper_1.HELP_NODES.CERTIFICATE_ERROR,
+            [ERROR_TYPE.CERT_SELF_SIGNED_CERT_IN_CHAIN]: guided_answers_helper_1.HELP_NODES.CERTIFICATE_ERROR,
+            [ERROR_TYPE.DESTINATION_MISCONFIGURED]: guided_answers_helper_1.HELP_NODES.DESTINATION_MISCONFIGURED,
+            [ERROR_TYPE.DESTINATION_UNAVAILABLE]: guided_answers_helper_1.HELP_NODES.DESTINATION_UNAVAILABLE,
+            [ERROR_TYPE.DESTINATION_NOT_FOUND]: guided_answers_helper_1.HELP_NODES.DESTINATION_NOT_FOUND,
+            [ERROR_TYPE.BAD_GATEWAY]: guided_answers_helper_1.HELP_NODES.BAD_GATEWAY,
+            [ERROR_TYPE.DESTINATION_BAD_GATEWAY_503]: guided_answers_helper_1.HELP_NODES.DESTINATION_BAD_GATEWAY_503,
+            [ERROR_TYPE.NO_V4_SERVICES]: guided_answers_helper_1.HELP_NODES.NO_V4_SERVICES,
+            [ERROR_TYPE.AUTH]: undefined,
+            [ERROR_TYPE.AUTH_TIMEOUT]: undefined,
+            [ERROR_TYPE.REDIRECT]: undefined,
+            [ERROR_TYPE.CERT_EXPIRED]: undefined,
+            [ERROR_TYPE.UNKNOWN]: undefined,
+            [ERROR_TYPE.INVALID_URL]: undefined,
+            [ERROR_TYPE.CONNECTION]: undefined,
+            [ERROR_TYPE.SERVICE_UNAVAILABLE]: undefined,
+            [ERROR_TYPE.NO_ABAP_ENVS]: undefined,
+            [ERROR_TYPE.CATALOG_SERVICE_NOT_ACTIVE]: undefined,
+            [ERROR_TYPE.NO_SUCH_HOST]: undefined,
+            [ERROR_TYPE.NOT_FOUND]: undefined,
+            [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.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];
+    };
+    /**
+     * Find an error property for mapping to a general error type from most to least significant.
+     *
+     * @param error any type of error or object that has an error code, status, name or message
+     * @returns a value that can be used to look up a general error type
+     */
+    static findErrorValueForMapping = (error) => error.response?.data?.error?.code ||
+        error.response?.status ||
+        error.response?.data ||
+        error.code ||
+        (['TypeError', 'Error'].includes(error.name) ? error.message : error.name) || // For generic error types use the message otherwise the name is more relevant
+        error.message ||
+        error;
+    /**
+     * Create an instance of the ErrorHandler.
+     *
+     * @param logger the logger instance to use
+     * @param enableGuidedAnswers if true, the end user validation errors will include guided answers to provide help
+     */
+    constructor(logger, enableGuidedAnswers = false) {
+        ErrorHandler._logger = logger ?? new logger_1.ToolsLogger({ logPrefix: '@sap-ux/odata-service-inquirer' });
+        ErrorHandler.guidedAnswersEnabled = enableGuidedAnswers;
+    }
+    /**
+     * Get Guided Answers (context help) enabled value.
+     *
+     * @returns true if Guided Answers is enabled
+     */
+    static get guidedAnswersEnabled() {
+        return ErrorHandler._guidedAnswersEnabled;
+    }
+    /**
+     * Toggle Guided Answers (context help) for validation errors.
+     */
+    static set guidedAnswersEnabled(value) {
+        ErrorHandler._guidedAnswersEnabled = value;
+    }
+    /**
+     * Set the logger to be used for error messages.
+     *
+     * @param logger the logger instance to use
+     */
+    static set logger(logger) {
+        ErrorHandler._logger = logger;
+    }
+    /**
+     * Get the logger used for error messages.
+     *
+     * @returns the logger instance
+     */
+    static get logger() {
+        return ErrorHandler._logger;
+    }
+    /**
+     * Tests if the error is a general certificate error.
+     *
+     * @param status the error type
+     * @returns true if the error is a general certificate error
+     */
+    static isCertError(status) {
+        return [
+            ERROR_TYPE.CERT,
+            ERROR_TYPE.CERT_EXPIRED,
+            ERROR_TYPE.CERT_SELF_SIGNED,
+            ERROR_TYPE.CERT_UKNOWN_OR_INVALID,
+            ERROR_TYPE.CERT_SELF_SIGNED_CERT_IN_CHAIN
+        ].includes(ErrorHandler.getErrorType(status));
+    }
+    /**
+     * Get the error type for the specified error, mapping status code, error code, error name, error message to a few general error types.
+     *
+     * @param error the error, string or status code to get the type for
+     * @returns the error type
+     */
+    static getErrorType(error) {
+        let errorValueToFind = error;
+        if (error instanceof Error) {
+            errorValueToFind = ErrorHandler.findErrorValueForMapping(error);
+        }
+        return Object.keys(ERROR_TYPE).find((errorCodeType) => {
+            return exports.ERROR_MAP[errorCodeType].find((exp) => exp.test(errorValueToFind.toString()));
+        }, {});
+    }
+    /**
+     * Maps errors to a few generic types, log a detailed error.
+     *
+     * @param error If the error is a string this will be logged as is. Otherwise it will be mapped to a general error internally, possibly retained and logged.
+     * @param userMsg If provided this will be set as the userErrorMsg instead of an error to msg map
+     *  this allows a message more relevant to the context of where the error was generated to be used.
+     * @param retainError Defaults to true to retain the error state.
+     * @returns A user-friendly message for display in-line
+     */
+    logErrorMsgs(error, userMsg, retainError = true) {
+        let resolvedError = {
+            errorMsg: '',
+            errorType: ERROR_TYPE.UNKNOWN
+        };
+        // Overloaded to allow ERROR_TYPE for convenience
+        if (Object.values(ERROR_TYPE).includes(error)) {
+            const errorType = error;
+            resolvedError.errorMsg = ErrorHandler.getErrorMsgFromType(errorType) ?? errorType.toString();
+            resolvedError.errorType = errorType;
+        }
+        else if (typeof error === 'string') {
+            resolvedError.errorMsg = error;
+        }
+        else {
+            resolvedError = ErrorHandler.mapErrorToMsg(error);
+        }
+        ErrorHandler._logger.error(userMsg ? `${userMsg} ${resolvedError.errorMsg}` : resolvedError.errorMsg);
+        if (retainError) {
+            this.currentErrorMsg = userMsg ?? resolvedError.errorMsg;
+            this.currentErrorType = resolvedError.errorType;
+        }
+        return resolvedError.errorMsg;
+    }
+    /**
+     * Maps an error to a user-friendly message. The specified error may by a string (e.g. error message), number (e.g. status code), Error, or Axios error.
+     *
+     * @param error The error to map
+     * @returns The mapped error message and error type
+     */
+    static mapErrorToMsg(error) {
+        let errorType;
+        if (Object.values(ERROR_TYPE).includes(error)) {
+            errorType = error;
+        }
+        else {
+            // Map error type using more to less specific information if available
+            errorType = ErrorHandler.getErrorType(this.findErrorValueForMapping(error)) ?? ERROR_TYPE.UNKNOWN;
+        }
+        return {
+            errorMsg: ErrorHandler._errorMsg(errorType, error),
+            errorType
+        };
+    }
+    /**
+     * Used by validate functions to report in-line user friendly errors.
+     * Checks if there is an existing error.
+     *
+     * @param error optional, if provided get the end user message that it maps to, otherwise get the previous error message, if a boolean is passed it will be interpreted as `reset`.
+     * @param reset optional, resets the previous error state if true, if error is omitted reset may be passed as the first argument
+     * @param fallback optional, return the message of the specified ERROR_TYPE if no previous end user message and no error specified
+     * @returns The error message
+     */
+    getErrorMsg(error, reset, fallback) {
+        let errorMsg;
+        if (error && typeof error !== 'boolean') {
+            errorMsg = ErrorHandler.mapErrorToMsg(error).errorMsg;
+        }
+        // Get previous error message
+        if (!errorMsg) {
+            errorMsg = this.currentErrorMsg ?? (fallback ? ErrorHandler.getErrorMsgFromType(fallback) : undefined);
+        }
+        if (error === true || reset) {
+            this.currentErrorMsg = null;
+            this.currentErrorType = null;
+        }
+        return errorMsg;
+    }
+    /**
+     * 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, destination) {
+        let errorHelp;
+        let resolvedErrorMsg;
+        let resolvedErrorType;
+        if (error) {
+            ({ errorMsg: resolvedErrorMsg, errorType: resolvedErrorType } = ErrorHandler.mapErrorToMsg(error));
+        }
+        else {
+            // Use the existing error if we have it
+            resolvedErrorMsg = this.currentErrorMsg ?? undefined;
+            if (this.currentErrorType) {
+                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 ?? 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, telemetry_1.sendTelemetryEvent)(telemBasError, {
+            basErrorType: destErrorType ?? errorType,
+            destODataType: (0, telemetry_1.getTelemPropertyDestinationType)(destination),
+            Platform: this._platform ?? (0, fiori_generator_shared_1.getHostEnvironment)().technical
+        });
+        return {
+            errorType: destErrorType ?? errorType,
+            errorMsg: destErrorMsg
+        };
+    }
+    /**
+     * Get the error message for the specified error type.
+     *
+     * @param errorType The error type for which the message may be returned
+     * @param error optional, if provided may be used to get generate a more specific error message, or be included in the message
+     * @returns The error message for the specified error type
+     */
+    static getErrorMsgFromType(errorType, error) {
+        if (ERROR_TYPE[errorType]) {
+            return ErrorHandler._errorMsg(ERROR_TYPE[errorType], error);
+        }
+        return undefined;
+    }
+    /**
+     * Checks if there is an existing error.
+     *
+     * @param reset - resets the current error state
+     * @returns true if there is an existing error
+     */
+    hasError(reset = false) {
+        const hasError = !!this.currentErrorMsg;
+        if (reset) {
+            this.currentErrorMsg = null;
+            this.currentErrorType = null;
+        }
+        return hasError;
+    }
+    /**
+     * Sets the current error state.
+     *
+     * @param errorType - the error type
+     * @param error - the original error, if any
+     */
+    setCurrentError(errorType, error) {
+        this.currentErrorMsg = ErrorHandler._errorMsg(ERROR_TYPE[errorType], error);
+        this.currentErrorType = errorType;
+    }
+    /**
+     * Gets the current error type state.
+     *
+     * @param reset - resets the current error state
+     * @returns The current error type
+     */
+    getCurrentErrorType(reset = false) {
+        const currentErrorType = this.currentErrorType;
+        if (reset) {
+            this.currentErrorMsg = null;
+            this.currentErrorType = null;
+        }
+        return currentErrorType;
+    }
+    /**
+     * Maps an error type to a validation link if help (Guided Answers topic) is available for the specified error.
+     * Otherwise the specified error message is returned. To retrieve the previous error state @see getValidationErrorHelp.
+     * Use this (getHelpForError) if the error type is known.
+     *
+     * @param errorType - the error type to be mapped to help link
+     * @param errorMsg - the message to appear with the help link
+     * @returns A validation help link or help link message
+     */
+    static getHelpForError(errorType, errorMsg) {
+        const helpNode = ErrorHandler.getHelpNode(errorType);
+        const mappedErrorMsg = errorMsg ?? ErrorHandler.getErrorMsgFromType(errorType);
+        if (helpNode) {
+            const valLink = {
+                message: mappedErrorMsg ?? '',
+                link: {
+                    text: (0, i18n_1.t)('guidedAnswers.validationErrorHelpText'),
+                    icon: guided_answers_helper_1.GUIDED_ANSWERS_ICON,
+                    url: (0, guided_answers_helper_1.getHelpUrl)(guided_answers_helper_1.HELP_TREE.FIORI_TOOLS, [helpNode])
+                }
+            };
+            if (this.guidedAnswersEnabled) {
+                valLink.link.command = {
+                    id: guided_answers_helper_1.GUIDED_ANSWERS_LAUNCH_CMD_ID,
+                    params: {
+                        treeId: guided_answers_helper_1.HELP_TREE.FIORI_TOOLS,
+                        nodeIdPath: [helpNode],
+                        trigger: this.guidedAnswersTrigger
+                    }
+                };
+            }
+            // Report the GA link created event
+            (0, telemetry_1.sendTelemetryEvent)(telemEventGALinkCreated, {
+                errorType,
+                isGuidedAnswersEnabled: this.guidedAnswersEnabled,
+                nodeIdPath: `${helpNode}`,
+                Platform: this.platform ?? (0, fiori_generator_shared_1.getHostEnvironment)().technical
+            });
+            return new types_1.ValidationLink(valLink);
+        }
+        return mappedErrorMsg;
+    }
+}
+exports.ErrorHandler = ErrorHandler;
+//# sourceMappingURL=error-handler.js.map

package/dist/i18n.js

@@ -20,7 +20,21 @@ function addi18nResourceBundle() {
  * Initialize i18next with the translations for this module.
  */
 async function initI18nInquirerCommon() {
-    await i18next_1.default.init({ lng: 'en', fallbackLng: 'en' }, () => addi18nResourceBundle());
+    await i18next_1.default.init({
+        lng: 'en',
+        fallbackLng: 'en',
+        missingInterpolationHandler: () => '',
+        interpolation: {
+            format: function (value, format) {
+                // If we have a value add a colon before outputting
+                if (format === 'addMsgWithColonFormatter') {
+                    return value ? `: ${value}` : '';
+                }
+                return value;
+            }
+        }
+    });
+    addi18nResourceBundle();
 }
 /**
  * Helper function facading the call to i18next. Unless a namespace option is provided the local namespace will be used.

package/dist/index.d.ts

@@ -1,5 +1,8 @@
 export * from './prompts/utility';
 export * from './types';
 export * from './prompts/helpers';
+export * from './error-handler/error-handler';
+export * from './prompts/cf-helper';
+export * from './telemetry/telemetry';
 export { addi18nResourceBundle } from './i18n';
 //# sourceMappingURL=index.d.ts.map

package/dist/index.js

@@ -18,6 +18,9 @@ exports.addi18nResourceBundle = void 0;
 __exportStar(require("./prompts/utility"), exports);
 __exportStar(require("./types"), exports);
 __exportStar(require("./prompts/helpers"), exports);
+__exportStar(require("./error-handler/error-handler"), exports);
+__exportStar(require("./prompts/cf-helper"), exports);
+__exportStar(require("./telemetry/telemetry"), exports);
 var i18n_1 = require("./i18n");
 Object.defineProperty(exports, "addi18nResourceBundle", { enumerable: true, get: function () { return i18n_1.addi18nResourceBundle; } });
 //# sourceMappingURL=index.js.map

package/dist/prompts/cf-helper.d.ts

@@ -0,0 +1,11 @@
+import type { ServiceInstanceInfo } from '@sap/cf-tools';
+import type { ListChoiceOptions } from 'inquirer';
+import { type ErrorHandler } from '../error-handler/error-handler';
+/**
+ * Get the name sorted list of ABAP instance choices from an active CF login. If not logged in, an error message is logged.
+ *
+ * @param errorHandler The error handler instance used to log and retain messages for use in prompts
+ * @returns The list of ABAP instance choices
+ */
+export declare function getCFAbapInstanceChoices(errorHandler: ErrorHandler): Promise<ListChoiceOptions<ServiceInstanceInfo>[]>;
+//# sourceMappingURL=cf-helper.d.ts.map

package/dist/prompts/cf-helper.js

@@ -0,0 +1,54 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getCFAbapInstanceChoices = getCFAbapInstanceChoices;
+const cf_tools_1 = require("@sap/cf-tools");
+const error_handler_1 = require("../error-handler/error-handler");
+const i18n_1 = require("../i18n");
+const AbapEnvType = {
+    ABAP: 'abap',
+    ABAP_TRIAL: 'abap-trial',
+    ABAP_CANARY: 'abap-canary',
+    ABAP_OEM: 'abap-oem',
+    ABAP_OEM_CANARY: 'abap-oem-canary',
+    ABAP_HAAS: 'abap-haas',
+    ABAP_STAGING: 'abap-staging',
+    ABAP_INTERNAL_STAGING: 'abap-internal-staging',
+    DESTINATION: 'destination'
+};
+/**
+ * Get the name sorted list of ABAP instance choices from an active CF login. If not logged in, an error message is logged.
+ *
+ * @param errorHandler The error handler instance used to log and retain messages for use in prompts
+ * @returns The list of ABAP instance choices
+ */
+async function getCFAbapInstanceChoices(errorHandler) {
+    const choices = [];
+    try {
+        const filteredInstances = [
+            AbapEnvType.ABAP,
+            AbapEnvType.ABAP_TRIAL,
+            AbapEnvType.ABAP_CANARY,
+            AbapEnvType.ABAP_OEM,
+            AbapEnvType.ABAP_OEM_CANARY,
+            AbapEnvType.ABAP_HAAS,
+            AbapEnvType.ABAP_STAGING,
+            AbapEnvType.ABAP_INTERNAL_STAGING
+        ];
+        const serviceInstanceInfo = await (0, cf_tools_1.apiGetServicesInstancesFilteredByType)(filteredInstances);
+        if (serviceInstanceInfo.length > 0) {
+            serviceInstanceInfo.forEach((service) => {
+                choices.push({ name: service['label'], value: service });
+            });
+        }
+        else {
+            // No envs found
+            errorHandler.logErrorMsgs(error_handler_1.ERROR_TYPE.NO_ABAP_ENVS, (0, i18n_1.t)('errors.noAbapEnvsInCFSpace'));
+        }
+    }
+    catch (error) {
+        // Cannot connect to CF
+        errorHandler.logErrorMsgs(error_handler_1.ERROR_TYPE.NO_ABAP_ENVS, (0, i18n_1.t)('errors.abapEnvsCFDiscoveryFailed'));
+    }
+    return choices.sort((a, b) => (a.name ? a.name.localeCompare(b.name ?? '') : 0));
+}
+//# sourceMappingURL=cf-helper.js.map

package/dist/telemetry/telemetry.d.ts

@@ -0,0 +1,30 @@
+import { type Destination } from '@sap-ux/btp-utils';
+import type { TelemetryProperties, ToolsSuiteTelemetryClient } from '@sap-ux/telemetry';
+import type { TelemPropertyDestinationType } from '../types';
+/**
+ * Set the telemetry client for use with sending telemetry events.
+ *
+ * @param toolsSuiteTelemetryClient the telemetry client instance to use when sending telemetry events
+ */
+export declare function setTelemetryClient(toolsSuiteTelemetryClient: ToolsSuiteTelemetryClient | undefined): void;
+/**
+ * Get the telemetry client if set.
+ *
+ * @returns the telemetry client instance if previously set.
+ */
+export declare function getTelemetryClient(): ToolsSuiteTelemetryClient | undefined;
+/**
+ * Send telemetry event.
+ *
+ * @param eventName the name of the telemetry event
+ * @param telemetryData the telemetry values to report
+ */
+export declare function sendTelemetryEvent(eventName: string, telemetryData: TelemetryProperties): void;
+/**
+ * Used only to generate telemetry events in the case of destination errors.
+ *
+ * @param destination
+ * @returns the telemetry property destination type
+ */
+export declare function getTelemPropertyDestinationType(destination: Destination): TelemPropertyDestinationType;
+//# sourceMappingURL=telemetry.d.ts.map

package/dist/telemetry/telemetry.js

@@ -0,0 +1,84 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.setTelemetryClient = setTelemetryClient;
+exports.getTelemetryClient = getTelemetryClient;
+exports.sendTelemetryEvent = sendTelemetryEvent;
+exports.getTelemPropertyDestinationType = getTelemPropertyDestinationType;
+const btp_utils_1 = require("@sap-ux/btp-utils");
+const telemetry_1 = require("@sap-ux/telemetry");
+const os_name_1 = __importDefault(require("os-name"));
+const fiori_generator_shared_1 = require("@sap-ux/fiori-generator-shared");
+let telemetryClient;
+const osVersionName = (0, os_name_1.default)();
+/**
+ * Set the telemetry client for use with sending telemetry events.
+ *
+ * @param toolsSuiteTelemetryClient the telemetry client instance to use when sending telemetry events
+ */
+function setTelemetryClient(toolsSuiteTelemetryClient) {
+    telemetryClient = toolsSuiteTelemetryClient;
+}
+/**
+ * Get the telemetry client if set.
+ *
+ * @returns the telemetry client instance if previously set.
+ */
+function getTelemetryClient() {
+    return telemetryClient;
+}
+/**
+ * Send telemetry event.
+ *
+ * @param eventName the name of the telemetry event
+ * @param telemetryData the telemetry values to report
+ */
+function sendTelemetryEvent(eventName, telemetryData) {
+    const telemetryEvent = createTelemetryEvent(eventName, telemetryData);
+    if (telemetryClient) {
+        // Do not wait for the telemetry event to be sent, it cannot be recovered if it fails, do not block the process
+        /* eslint-disable @typescript-eslint/no-floating-promises */
+        telemetryClient.reportEvent(telemetryEvent, telemetry_1.SampleRate.NoSampling);
+    }
+}
+/**
+ * Create telemetry event.
+ *
+ * @param eventName the name of the telemetry event
+ * @param telemetryData the telemetry values to add to he returned telemetry event
+ * @returns the telemetry event
+ */
+function createTelemetryEvent(eventName, telemetryData) {
+    const telemProps = Object.assign(telemetryData, {
+        OperatingSystem: osVersionName,
+        Platform: telemetryData.Platform || (0, fiori_generator_shared_1.getHostEnvironment)().technical
+    });
+    return {
+        eventName,
+        properties: telemProps,
+        measurements: {}
+    };
+}
+/**
+ * Used only to generate telemetry events in the case of destination errors.
+ *
+ * @param destination
+ * @returns the telemetry property destination type
+ */
+function getTelemPropertyDestinationType(destination) {
+    if ((0, btp_utils_1.isAbapODataDestination)(destination)) {
+        return 'AbapODataCatalogDest';
+    }
+    else if ((0, btp_utils_1.isFullUrlDestination)(destination)) {
+        return 'GenericODataFullUrlDest';
+    }
+    else if ((0, btp_utils_1.isPartialUrlDestination)(destination)) {
+        return 'GenericODataPartialUrlDest';
+    }
+    else {
+        return 'Unknown';
+    }
+}
+//# sourceMappingURL=telemetry.js.map

package/dist/translations/inquirer-common.i18n.json

@@ -4,5 +4,53 @@
         "outOfMaintenance": "Out of maintenance",
         "version_one": "version",
         "version_other": "versions"
+    },
+    "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.",
+            "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}}. $t(texts.seeLogForDetails)"
+        },
+        "cannotReadCapServiceMetadata": "An error occurred reading CAP service metadata: {{serviceName}}. $t(texts.seeLogForDetails).",
+        "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, addMsgWithColonFormatter}}",
+        "servicesUnavailable": "An error occurred retrieving service(s) for SAP System.",
+        "certificateError": "A certificate error has occurred{{- errorMsg, addMsgWithColonFormatter}}",
+        "urlCertValidationError": "The system URL is using {{certErrorReason}} security certificate.",
+        "authenticationFailed": "Authentication incorrect. {{- error}}",
+        "authenticationTimeout": "Authorization was not verified within the allowed time. Please ensure you have authenticated using the associated browser window.",
+        "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{{- errorMsg, addMsgWithColonFormatter}}",
+        "serverReturnedAnError": "The server returned an error. {{errorDesc}}",
+        "serverUnableToCompleteRequest": "The server was unable to complete the request",
+        "catalogServiceNotActive": "Catalog service is not active",
+        "urlNotFound": "URL not found",
+        "odataServiceUrlNotFound": "The service URL you have provided is not a valid OData Service. SAP Fiori applications require an OData service as the data source.",
+        "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",
+        "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).",
+        "systemConnectionValidationFailed": "A connection to the selected system could not be established.",
+        "internalServerError": "Internal server error{{-errorMsg, addMsgWithColonFormatter}}",
+        "badGateway": "Bad gateway{{- errorMsg, addMsgWithColonFormatter}}",
+        "badRequest": "Bad request{{- errorMsg, addMsgWithColonFormatter}}"
+    },
+    "guidedAnswers": {
+        "validationErrorHelpText": "Need help with this error?"
+    },
+    "texts": {
+        "anExpiredCert": "an expired",
+        "aSelfSignedCert": "a self-signed",
+        "anUnknownOrInvalidCert": "an unknown or invalid",
+        "anUntrustedRootCert": "an untrusted root",
+        "suggestedSystemNameClient": ", client {{client}}",
+        "seeLogForDetails": "See log for more details."
     }
 }

package/dist/types.d.ts

@@ -1,4 +1,4 @@
-import { type IMessageSeverity } from '@sap-devx/yeoman-ui-types';
+import type { IValidationLink, IMessageSeverity } from '@sap-devx/yeoman-ui-types';
 import type { Answers, ConfirmQuestion as BaseConfirmQuestion, InputQuestion as BaseInputQuestion, ListQuestion as BaseListQuestion, CheckboxQuestion as BaseCheckBoxQuestion, NumberQuestion as BaseNumberQuestion, EditorQuestion as BaseEditorQuestion, ListChoiceOptions, PromptFunction, PromptModule, Question, Validator, AsyncDynamicQuestionProperty } from 'inquirer';
 export interface UI5VersionChoice extends ListChoiceOptions {
     /**
@@ -86,4 +86,25 @@ export type CommonPromptOptions<T extends Answers = Answers> = {
 export type PromptDefaultValue<T> = {
     default?: AsyncDynamicQuestionProperty<T>;
 };
+export type TelemPropertyDestinationType = 'AbapODataCatalogDest' | 'GenericODataFullUrlDest' | 'GenericODataPartialUrlDest' | 'Unknown';
+/**
+ * Implementation of IValidationLink interface.
+ * Provides a toString() for serialization on CLI since IValidationLink rendering is only supported by YeomanUI.
+ */
+export declare class ValidationLink implements IValidationLink {
+    message: IValidationLink['message'];
+    link: IValidationLink['link'];
+    /**
+     * Constructor for ValidationLink.
+     *
+     * @param validationLink The validation link object to be used for serialization
+     */
+    constructor(validationLink: IValidationLink);
+    /**
+     * Serialize the validation link object to a string.
+     *
+     * @returns The validation link object as a string
+     */
+    toString(): string;
+}
 //# sourceMappingURL=types.d.ts.map

package/dist/types.js

@@ -1,3 +1,30 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.ValidationLink = void 0;
+/**
+ * Implementation of IValidationLink interface.
+ * Provides a toString() for serialization on CLI since IValidationLink rendering is only supported by YeomanUI.
+ */
+class ValidationLink {
+    // Having to redeclare properties from an interface should not be required see: https://github.com/Microsoft/TypeScript/issues/5326
+    message;
+    link;
+    /**
+     * Constructor for ValidationLink.
+     *
+     * @param validationLink The validation link object to be used for serialization
+     */
+    constructor(validationLink) {
+        Object.assign(this, validationLink);
+    }
+    /**
+     * Serialize the validation link object to a string.
+     *
+     * @returns The validation link object as a string
+     */
+    toString() {
+        return `${this.message} ${this.link.text}${this.link.url ? ' : ' + this.link.url : ''}`;
+    }
+}
+exports.ValidationLink = ValidationLink;
 //# sourceMappingURL=types.js.map

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@sap-ux/inquirer-common",
   "description": "Commonly used shared functionality and types to support inquirer modules.",
-  "version": "0.4.9",
+  "version": "0.5.0",
   "repository": {
     "type": "git",
     "url": "https://github.com/SAP/open-ux-tools.git",
@@ -19,19 +19,29 @@
     "!dist/**/*.map"
   ],
   "dependencies": {
-    "fuzzy": "0.1.3",
-    "i18next": "23.5.1",
+    "@sap/cf-tools": "3.2.0",
+    "axios": "1.7.4",
     "chalk": "4.1.2",
     "figures": "3.2.0",
-    "semver": "7.5.4",
+    "fuzzy": "0.1.3",
+    "i18next": "23.5.1",
     "lodash": "4.17.21",
-    "@sap-ux/ui5-info": "0.8.2"
+    "os-name": "4.0.1",
+    "semver": "7.5.4",
+    "@sap-ux/btp-utils": "0.16.0",
+    "@sap-ux/feature-toggle": "0.2.2",
+    "@sap-ux/fiori-generator-shared": "0.7.7",
+    "@sap-ux/guided-answers-helper": "0.1.0",
+    "@sap-ux/telemetry": "0.5.42",
+    "@sap-ux/logger": "0.6.0",
+    "@sap-ux/ui5-info": "0.8.3"
   },
   "devDependencies": {
     "@sap-devx/yeoman-ui-types": "1.14.4",
     "@types/inquirer": "8.2.6",
     "@types/semver": "7.5.4",
-    "@types/lodash": "4.14.202"
+    "@types/lodash": "4.14.202",
+    "jest-extended": "3.2.4"
   },
   "engines": {
     "node": ">=18.x"