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

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

@@ -1,184 +0,0 @@
-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",// Specific service
-    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"
-}
-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;
-    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 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.
-     *
-     * @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
-     * @returns An instance of @see {ValidationLink}
-     */
-    getValidationErrorHelp(error?: any, reset?: boolean): ValidationLinkOrString | undefined;
-    /**
-     * 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

@@ -1,465 +0,0 @@
-"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 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';
-/**
- * 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 || (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]: []
-};
-/**
- * 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;
-    // 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', {
-            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]: (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.UNKNOWN]: (0, i18n_1.t)('errors.unknownError', {
-            error: error?.message || 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')
-    });
-    /**
-     * 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
-        };
-        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(error)[errorType],
-            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.
-     *
-     * @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
-     * @returns An instance of @see {ValidationLink}
-     */
-    getValidationErrorHelp(error, reset = false) {
-        let errorHelp;
-        let errorMsg;
-        if (error) {
-            const resolvedError = ErrorHandler.mapErrorToMsg(error);
-            if (resolvedError.errorType !== ERROR_TYPE.UNKNOWN) {
-                errorHelp = ErrorHandler.getHelpForError(resolvedError.errorType, resolvedError.errorMsg);
-            }
-        }
-        else if (!error) {
-            errorMsg = this.currentErrorMsg ?? '';
-            if (this.currentErrorType) {
-                errorHelp = ErrorHandler.getHelpForError(this.currentErrorType, errorMsg);
-            }
-        }
-        if (reset) {
-            this.currentErrorMsg = null;
-            this.currentErrorType = null;
-        }
-        return errorHelp ?? errorMsg;
-    }
-    /**
-     * 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)[ERROR_TYPE[errorType]];
-        }
-        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)[ERROR_TYPE[errorType]];
-        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: '@sap-ux/odata-service-inquirer'
-                    }
-                };
-            }
-            // Report the GA link created event
-            (0, utils_1.sendTelemetryEvent)(teleEventGALinkCreated, {
-                errorType,
-                isGuidedAnswersEnabled: this.guidedAnswersEnabled,
-                nodeIdPath: `${helpNode}`
-            });
-            return new types_1.ValidationLink(valLink);
-        }
-        return mappedErrorMsg;
-    }
-}
-exports.ErrorHandler = ErrorHandler;
-//# sourceMappingURL=error-handler.js.map

package/dist/prompts/datasources/sap-system/abap-on-btp/cf-helper.d.ts

@@ -1,9 +0,0 @@
-import type { ServiceInstanceInfo } from '@sap/cf-tools';
-import type { ListChoiceOptions } from 'inquirer';
-/**
- * Get the name sorted list of ABAP instance choices from an active CF login. If not logged in, an error message is logged.
- *
- * @returns The list of ABAP instance choices
- */
-export declare function getABAPInstanceChoices(): Promise<ListChoiceOptions<ServiceInstanceInfo>[]>;
-//# sourceMappingURL=cf-helper.d.ts.map