@sap-ux/odata-service-inquirer 0.1.1

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

@@ -0,0 +1,450 @@
+"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 help_topics_1 = require("./help/help-topics");
+const images_1 = require("./help/images");
+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["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.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/],
+    [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 {
+    /**
+     * 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 !== null && logger !== void 0 ? 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) {
+        return Object.keys(ERROR_TYPE).find((errorCodeType) => {
+            return exports.ERROR_MAP[errorCodeType].find((exp) => exp.test(error.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) {
+        var _a;
+        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 = (_a = ErrorHandler.getErrorMsgFromType(errorType)) !== null && _a !== void 0 ? _a : 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 !== null && userMsg !== void 0 ? 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) {
+        var _a, _b, _c, _d, _e, _f;
+        let errorType;
+        if (Object.values(ERROR_TYPE).includes(error)) {
+            errorType = error;
+        }
+        else {
+            // Map error type using more to less specific information if available
+            errorType =
+                (_f = ErrorHandler.getErrorType(((_c = (_b = (_a = error.response) === null || _a === void 0 ? void 0 : _a.data) === null || _b === void 0 ? void 0 : _b.error) === null || _c === void 0 ? void 0 : _c.code) ||
+                    ((_d = error.response) === null || _d === void 0 ? void 0 : _d.status) ||
+                    ((_e = error.response) === null || _e === void 0 ? void 0 : _e.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)) !== null && _f !== void 0 ? _f : 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
+     * @param reset optional, resets the previous error state if true
+     * @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) {
+        var _a;
+        let errorMsg;
+        if (error) {
+            errorMsg = ErrorHandler.mapErrorToMsg(error).errorMsg;
+        }
+        // Get previous error message
+        if (!errorMsg) {
+            errorMsg = (_a = this.currentErrorMsg) !== null && _a !== void 0 ? _a : (fallback ? ErrorHandler.getErrorMsgFromType(fallback) : undefined);
+        }
+        if (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) {
+        var _a;
+        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 = (_a = this.currentErrorMsg) !== null && _a !== void 0 ? _a : '';
+            if (this.currentErrorType) {
+                errorHelp = ErrorHandler.getHelpForError(this.currentErrorType, errorMsg);
+            }
+        }
+        if (reset) {
+            this.currentErrorMsg = null;
+            this.currentErrorType = null;
+        }
+        return errorHelp !== null && errorHelp !== void 0 ? 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 !== null && errorMsg !== void 0 ? errorMsg : ErrorHandler.getErrorMsgFromType(errorType);
+        if (helpNode) {
+            const valLink = {
+                message: mappedErrorMsg !== null && mappedErrorMsg !== void 0 ? mappedErrorMsg : '',
+                link: {
+                    text: (0, i18n_1.t)('guidedAnswers.validationErrorHelpText'),
+                    icon: images_1.GUIDED_ANSWERS_ICON,
+                    url: (0, help_topics_1.getHelpUrl)(3046 /* HELP_TREE.FIORI_TOOLS */, [helpNode])
+                }
+            };
+            if (this.guidedAnswersEnabled) {
+                valLink.link.command = {
+                    id: help_topics_1.GUIDED_ANSWERS_LAUNCH_CMD_ID,
+                    params: {
+                        treeId: 3046 /* 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;
+// 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.
+ErrorHandler._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.INVALID_URL]: (0, i18n_1.t)('errors.invalidUrl'),
+    [ERROR_TYPE.CONNECTION]: (0, i18n_1.t)('errors.connectionError', {
+        error: (error === null || error === void 0 ? void 0 : error.message) || JSON.stringify(error)
+    }),
+    [ERROR_TYPE.UNKNOWN]: (0, i18n_1.t)('errors.unknownError', {
+        error: (error === null || error === void 0 ? void 0 : 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 === null || error === void 0 ? void 0 : 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.destinationUnavailable'),
+    [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.noServicesAvailabl', { 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)('error.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
+ */
+ErrorHandler.getHelpNode = (errorType) => {
+    const errorToHelp = {
+        [ERROR_TYPE.SERVICES_UNAVAILABLE]: (0, btp_utils_1.isAppStudio)()
+            ? help_topics_1.HELP_NODES.BAS_CATALOG_SERVICES_REQUEST_FAILED
+            : undefined,
+        [ERROR_TYPE.CERT]: help_topics_1.HELP_NODES.CERTIFICATE_ERROR,
+        [ERROR_TYPE.CERT_SELF_SIGNED]: help_topics_1.HELP_NODES.CERTIFICATE_ERROR,
+        [ERROR_TYPE.CERT_UKNOWN_OR_INVALID]: help_topics_1.HELP_NODES.CERTIFICATE_ERROR,
+        [ERROR_TYPE.CERT_SELF_SIGNED_CERT_IN_CHAIN]: help_topics_1.HELP_NODES.CERTIFICATE_ERROR,
+        [ERROR_TYPE.DESTINATION_MISCONFIGURED]: help_topics_1.HELP_NODES.DESTINATION_MISCONFIGURED,
+        [ERROR_TYPE.DESTINATION_UNAVAILABLE]: help_topics_1.HELP_NODES.DESTINATION_UNAVAILABLE,
+        [ERROR_TYPE.DESTINATION_NOT_FOUND]: help_topics_1.HELP_NODES.DESTINATION_NOT_FOUND,
+        [ERROR_TYPE.BAD_GATEWAY]: help_topics_1.HELP_NODES.BAD_GATEWAY,
+        [ERROR_TYPE.DESTINATION_BAD_GATEWAY_503]: help_topics_1.HELP_NODES.DESTINATION_BAD_GATEWAY_503,
+        [ERROR_TYPE.NO_V4_SERVICES]: help_topics_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
+    };
+    return errorToHelp[errorType];
+};
+//# sourceMappingURL=error-handler.js.map

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

@@ -0,0 +1,37 @@
+/**
+ * Mapping of human readable help topic to implementation specific ids
+ * Help items are nodes under a root tree item. A node may have n additonal nodes.
+ *
+ */
+export declare const enum HELP_TREE {
+    FIORI_TOOLS = 3046
+}
+/**
+ * Individual help topics which are mapped to node ids
+ */
+export declare const HELP_NODES: {
+    FIORI_TOOLS: number;
+    DEV_PLATFORM: number;
+    FIORI_APP_GENERATOR: number;
+    BAS_CATALOG_SERVICES_REQUEST_FAILED: number;
+    APPLICATION_PREVIEW: number;
+    CERTIFICATE_ERROR: number;
+    DESTINATION_MISCONFIGURED: number;
+    DESTINATION_UNAVAILABLE: number;
+    DESTINATION_NOT_FOUND: number;
+    BAD_GATEWAY: number;
+    DESTINATION_BAD_GATEWAY_503: number;
+    NO_V4_SERVICES: number;
+};
+export declare const GUIDED_ANSWERS_EXTENSION_ID = "saposs.sap-guided-answers-extension";
+export declare const GUIDED_ANSWERS_LAUNCH_CMD_ID = "sap.ux.guidedAnswer.openGuidedAnswer";
+/**
+ * Creates a help url for the specified tree and node ids. If node ids are not specified the root tree path
+ * will be returned, which may not be a valid help page.
+ *
+ * @param treeId The tree id of the help content system (Guided Answers context)
+ * @param nodeIds The node ids of the help content page (Guided Answers specific page)
+ * @returns The help url
+ */
+export declare function getHelpUrl(treeId: number, nodeIds: number[]): string;
+//# sourceMappingURL=help-topics.d.ts.map

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

@@ -0,0 +1,40 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getHelpUrl = exports.GUIDED_ANSWERS_LAUNCH_CMD_ID = exports.GUIDED_ANSWERS_EXTENSION_ID = exports.HELP_NODES = void 0;
+/**
+ * Individual help topics which are mapped to node ids
+ */
+exports.HELP_NODES = {
+    FIORI_TOOLS: 45995, // The root of all Fiori Tools help
+    DEV_PLATFORM: 45996, // Environment specific selection, vscode or BAS
+    FIORI_APP_GENERATOR: 48363, // Fiori application generator
+    BAS_CATALOG_SERVICES_REQUEST_FAILED: 48366, // BAS specific catalog service request failure
+    APPLICATION_PREVIEW: 52881, // App preview failure
+    CERTIFICATE_ERROR: 53643,
+    DESTINATION_MISCONFIGURED: 54336, // Missing additional property
+    DESTINATION_UNAVAILABLE: 51208, // Launchpad service is not subscribed to
+    DESTINATION_NOT_FOUND: 51208, // Destination URL is returning an empty response
+    BAD_GATEWAY: 48366, // Bad gateway 502
+    DESTINATION_BAD_GATEWAY_503: 52526, // Destination Service Unavailable 503
+    NO_V4_SERVICES: 57573 // No V4 OData services available
+};
+exports.GUIDED_ANSWERS_EXTENSION_ID = 'saposs.sap-guided-answers-extension';
+exports.GUIDED_ANSWERS_LAUNCH_CMD_ID = 'sap.ux.guidedAnswer.openGuidedAnswer';
+const GUIDED_ANSWERS_SUPPORT_BASE_URL = 'https://ga.support.sap.com/dtp/viewer/index.html';
+/**
+ * Creates a help url for the specified tree and node ids. If node ids are not specified the root tree path
+ * will be returned, which may not be a valid help page.
+ *
+ * @param treeId The tree id of the help content system (Guided Answers context)
+ * @param nodeIds The node ids of the help content page (Guided Answers specific page)
+ * @returns The help url
+ */
+function getHelpUrl(treeId, nodeIds) {
+    let actions = '';
+    if (nodeIds.length > 0) {
+        actions = `/actions/${nodeIds.join(':')}`;
+    }
+    return `${GUIDED_ANSWERS_SUPPORT_BASE_URL}#/tree/${treeId}${actions}`;
+}
+exports.getHelpUrl = getHelpUrl;
+//# sourceMappingURL=help-topics.js.map

package/dist/error-handler/help/images/guidedAnswersIcon_svg_base64.d.ts

@@ -0,0 +1,2 @@
+export declare const GUIDED_ANSWERS_ICON = "data:image/svg+xml;base64,PHN2ZyB3aWR0aD0iMTIiIGhlaWdodD0iMTIiIHZpZXdCb3g9IjAgMCAxMiAxMiIgZmlsbD0ibm9uZSIgeG1sbnM9Imh0dHA6Ly93d3cudzMub3JnLzIwMDAvc3ZnIj4KPGcgY2xpcC1wYXRoPSJ1cmwoI2NsaXAwXzM0NTRfMTc4MDUpIj4KPHBhdGggZmlsbC1ydWxlPSJldmVub2RkIiBjbGlwLXJ1bGU9ImV2ZW5vZGQiIGQ9Ik0xMSA3LjI0MjIzVjkuNUMxMSA5LjY4OTM5IDEwLjg5MyA5Ljg2MjUyIDEwLjcyMzYgOS45NDcyMUw3LjcyMzYxIDExLjQ0NzJDNy41OTkyNSAxMS41MDk0IDcuNDU0NjIgMTEuNTE3IDcuMzI0NDQgMTEuNDY4MkwzLjQ5MDE4IDEwLjAzMDNMMC42NTgxMTQgMTAuOTc0M0MwLjUwNTY0IDExLjAyNTIgMC4zMzgwMjkgMTAuOTk5NiAwLjIwNzY0NSAxMC45MDU2QzAuMDc3MjYwNiAxMC44MTE2IDAgMTAuNjYwNyAwIDEwLjVWMi41QzAgMi4yODQ3OCAwLjEzNzcxNSAyLjA5MzcyIDAuMzQxODg2IDIuMDI1NjZMMy4zNDE4OSAxLjAyNTY2QzMuNDQ3OTcgMC45OTAyOTYgMy41NjI4NiAwLjk5MTUxNyAzLjY2ODE3IDEuMDI5MTNMNC41NDkyNSAxLjM0MzhDNC4zOTAxOSAxLjYzNDYzIDQuMjYyMyAxLjk0NDk0IDQuMTcwMDkgMi4yNzAyNUw0IDIuMjA5NVY5LjE1MzVMNyAxMC4yNzg1VjcuNzQzOTRDNy4zMTg0MSA3Ljg1NjQ4IDcuNjUzMjcgNy45MzQyMSA4IDcuOTcyNTRWMTAuMTkxTDEwIDkuMTkwOThWNy43NDM5NEMxMC4zNTYgNy42MTgxIDEwLjY5MTUgNy40NDg3MyAxMSA3LjI0MjIzWk0xIDkuODA2MjlWMi44NjAzOEwzIDIuMTkzNzFWOS4xMzk2MkwxIDkuODA2MjlaIiBmaWxsPSIjQzVDNUM1Ii8+CjxwYXRoIGZpbGwtcnVsZT0iZXZlbm9kZCIgY2xpcC1ydWxlPSJldmVub2RkIiBkPSJNNSAzLjQ2NjIyQzUgNC4yNTM4IDUuMjYyNjcgNC45ODAwMyA1LjcwNTE4IDUuNTYyMDlMNS4zNzc1OCA3LjQyTDcuMjg0NzEgNi43MjU4NkM3LjY1MzQ1IDYuODU5NTUgOC4wNTEzMiA2LjkzMjQ0IDguNDY2MjIgNi45MzI0NEMxMC4zODA2IDYuOTMyNDQgMTEuOTMyNCA1LjM4MDU2IDExLjkzMjQgMy40NjYyMkMxMS45MzI0IDEuNTUxODggMTAuMzgwNiAwIDguNDY2MjIgMEM2LjU1MTg4IDAgNSAxLjU1MTg4IDUgMy40NjYyMlpNOCAxLjVDOCAxLjIyMzg2IDguMjIzODYgMSA4LjUgMUM4Ljc3NjE0IDEgOSAxLjIyMzg2IDkgMS41QzkgMS43NzYxNCA4Ljc3NjE0IDIgOC41IDJDOC4yMjM4NiAyIDggMS43NzYxNCA4IDEuNVpNOC41IDNDOC4yMjM4NiAzIDggMy4yMjM4NiA4IDMuNVY1LjVDOCA1Ljc3NjE0IDguMjIzODYgNiA4LjUgNkM4Ljc3NjE0IDYgOSA1Ljc3NjE0IDkgNS41VjMuNUM5IDMuMjIzODYgOC43NzYxNCAzIDguNSAzWiIgZmlsbD0iI0M1QzVDNSIvPgo8L2c+CjxkZWZzPgo8Y2xpcFBhdGggaWQ9ImNsaXAwXzM0NTRfMTc4MDUiPgo8cmVjdCB3aWR0aD0iMTIiIGhlaWdodD0iMTIiIGZpbGw9IndoaXRlIi8+CjwvY2xpcFBhdGg+CjwvZGVmcz4KPC9zdmc+Cg==";
+//# sourceMappingURL=guidedAnswersIcon_svg_base64.d.ts.map

package/dist/error-handler/help/images/guidedAnswersIcon_svg_base64.js

@@ -0,0 +1,5 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.GUIDED_ANSWERS_ICON = void 0;
+exports.GUIDED_ANSWERS_ICON = 'data:image/svg+xml;base64,PHN2ZyB3aWR0aD0iMTIiIGhlaWdodD0iMTIiIHZpZXdCb3g9IjAgMCAxMiAxMiIgZmlsbD0ibm9uZSIgeG1sbnM9Imh0dHA6Ly93d3cudzMub3JnLzIwMDAvc3ZnIj4KPGcgY2xpcC1wYXRoPSJ1cmwoI2NsaXAwXzM0NTRfMTc4MDUpIj4KPHBhdGggZmlsbC1ydWxlPSJldmVub2RkIiBjbGlwLXJ1bGU9ImV2ZW5vZGQiIGQ9Ik0xMSA3LjI0MjIzVjkuNUMxMSA5LjY4OTM5IDEwLjg5MyA5Ljg2MjUyIDEwLjcyMzYgOS45NDcyMUw3LjcyMzYxIDExLjQ0NzJDNy41OTkyNSAxMS41MDk0IDcuNDU0NjIgMTEuNTE3IDcuMzI0NDQgMTEuNDY4MkwzLjQ5MDE4IDEwLjAzMDNMMC42NTgxMTQgMTAuOTc0M0MwLjUwNTY0IDExLjAyNTIgMC4zMzgwMjkgMTAuOTk5NiAwLjIwNzY0NSAxMC45MDU2QzAuMDc3MjYwNiAxMC44MTE2IDAgMTAuNjYwNyAwIDEwLjVWMi41QzAgMi4yODQ3OCAwLjEzNzcxNSAyLjA5MzcyIDAuMzQxODg2IDIuMDI1NjZMMy4zNDE4OSAxLjAyNTY2QzMuNDQ3OTcgMC45OTAyOTYgMy41NjI4NiAwLjk5MTUxNyAzLjY2ODE3IDEuMDI5MTNMNC41NDkyNSAxLjM0MzhDNC4zOTAxOSAxLjYzNDYzIDQuMjYyMyAxLjk0NDk0IDQuMTcwMDkgMi4yNzAyNUw0IDIuMjA5NVY5LjE1MzVMNyAxMC4yNzg1VjcuNzQzOTRDNy4zMTg0MSA3Ljg1NjQ4IDcuNjUzMjcgNy45MzQyMSA4IDcuOTcyNTRWMTAuMTkxTDEwIDkuMTkwOThWNy43NDM5NEMxMC4zNTYgNy42MTgxIDEwLjY5MTUgNy40NDg3MyAxMSA3LjI0MjIzWk0xIDkuODA2MjlWMi44NjAzOEwzIDIuMTkzNzFWOS4xMzk2MkwxIDkuODA2MjlaIiBmaWxsPSIjQzVDNUM1Ii8+CjxwYXRoIGZpbGwtcnVsZT0iZXZlbm9kZCIgY2xpcC1ydWxlPSJldmVub2RkIiBkPSJNNSAzLjQ2NjIyQzUgNC4yNTM4IDUuMjYyNjcgNC45ODAwMyA1LjcwNTE4IDUuNTYyMDlMNS4zNzc1OCA3LjQyTDcuMjg0NzEgNi43MjU4NkM3LjY1MzQ1IDYuODU5NTUgOC4wNTEzMiA2LjkzMjQ0IDguNDY2MjIgNi45MzI0NEMxMC4zODA2IDYuOTMyNDQgMTEuOTMyNCA1LjM4MDU2IDExLjkzMjQgMy40NjYyMkMxMS45MzI0IDEuNTUxODggMTAuMzgwNiAwIDguNDY2MjIgMEM2LjU1MTg4IDAgNSAxLjU1MTg4IDUgMy40NjYyMlpNOCAxLjVDOCAxLjIyMzg2IDguMjIzODYgMSA4LjUgMUM4Ljc3NjE0IDEgOSAxLjIyMzg2IDkgMS41QzkgMS43NzYxNCA4Ljc3NjE0IDIgOC41IDJDOC4yMjM4NiAyIDggMS43NzYxNCA4IDEuNVpNOC41IDNDOC4yMjM4NiAzIDggMy4yMjM4NiA4IDMuNVY1LjVDOCA1Ljc3NjE0IDguMjIzODYgNiA4LjUgNkM4Ljc3NjE0IDYgOSA1Ljc3NjE0IDkgNS41VjMuNUM5IDMuMjIzODYgOC43NzYxNCAzIDguNSAzWiIgZmlsbD0iI0M1QzVDNSIvPgo8L2c+CjxkZWZzPgo8Y2xpcFBhdGggaWQ9ImNsaXAwXzM0NTRfMTc4MDUiPgo8cmVjdCB3aWR0aD0iMTIiIGhlaWdodD0iMTIiIGZpbGw9IndoaXRlIi8+CjwvY2xpcFBhdGg+CjwvZGVmcz4KPC9zdmc+Cg==';
+//# sourceMappingURL=guidedAnswersIcon_svg_base64.js.map

package/dist/error-handler/help/images/index.d.ts

@@ -0,0 +1,2 @@
+export * from './guidedAnswersIcon_svg_base64';
+//# sourceMappingURL=index.d.ts.map

package/dist/error-handler/help/images/index.js

@@ -0,0 +1,18 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./guidedAnswersIcon_svg_base64"), exports);
+//# sourceMappingURL=index.js.map

package/dist/i18n.d.ts

@@ -0,0 +1,15 @@
+import type { TOptions } from 'i18next';
+export declare const defaultProjectNumber = 1;
+/**
+ * Initialize i18next with the translations for this module.
+ */
+export declare function initI18nOdataServiceInquirer(): Promise<void>;
+/**
+ * Helper function facading the call to i18next. Unless a namespace option is provided the local namespace will be used.
+ *
+ * @param key i18n key
+ * @param options additional options
+ * @returns {string} localized string stored for the given key
+ */
+export declare function t(key: string, options?: TOptions): string;
+//# sourceMappingURL=i18n.d.ts.map

package/dist/i18n.js

@@ -0,0 +1,50 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.t = exports.initI18nOdataServiceInquirer = exports.defaultProjectNumber = void 0;
+const i18next_1 = __importDefault(require("i18next"));
+const odata_service_inquirer_i18n_json_1 = __importDefault(require("./translations/odata-service-inquirer.i18n.json"));
+const odataServiceInquirerNamespace = 'odata-service-inquirer';
+exports.defaultProjectNumber = 1;
+/**
+ * Initialize i18next with the translations for this module.
+ */
+function initI18nOdataServiceInquirer() {
+    return __awaiter(this, void 0, void 0, function* () {
+        yield i18next_1.default.init({
+            lng: 'en',
+            fallbackLng: 'en',
+            missingInterpolationHandler: () => ''
+        }, () => i18next_1.default.addResourceBundle('en', odataServiceInquirerNamespace, odata_service_inquirer_i18n_json_1.default));
+    });
+}
+exports.initI18nOdataServiceInquirer = initI18nOdataServiceInquirer;
+/**
+ * Helper function facading the call to i18next. Unless a namespace option is provided the local namespace will be used.
+ *
+ * @param key i18n key
+ * @param options additional options
+ * @returns {string} localized string stored for the given key
+ */
+function t(key, options) {
+    if (!(options === null || options === void 0 ? void 0 : options.ns)) {
+        options = Object.assign(options !== null && options !== void 0 ? options : {}, { ns: odataServiceInquirerNamespace });
+    }
+    return i18next_1.default.t(key, options);
+}
+exports.t = t;
+initI18nOdataServiceInquirer().catch(() => {
+    // Needed for lint
+});
+//# sourceMappingURL=i18n.js.map