@sap-ux/inquirer-common 0.6.4 → 0.6.6

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

@@ -26,7 +26,8 @@ export declare enum ERROR_TYPE {
     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
+    BAD_GATEWAY = "BAD_GATEWAY",// Can be caused by either local issue or endpoint configuration,
+    GATEWAY_TIMEOUT = "GATEWAY_TIMEOUT",
     INTERNAL_SERVER_ERROR = "INTERNAL_SERVER_ERROR",
     DESTINATION_SERVICE_UNAVAILABLE = "DESTINATION_SERVICE_UNAVAILABLE",// Caused by endpoint using a firewall or proxy
     DESTINATION_UNAVAILABLE = "DESTINATION_UNAVAILABLE",
@@ -84,6 +85,14 @@ export declare class ErrorHandler {
      */
     static set guidedAnswersTrigger(value: string | undefined);
     private static readonly getMessageFromError;
+    /**
+     * Get the localized error message for the specified server error.
+     *
+     * @param error the error object or message that was returned from the server (5xx)
+     * @param subTextKey an i18next key used to provide additional context to the error message
+     * @returns the localized error message
+     */
+    private static readonly serverErrorMessage;
     private static readonly _errorTypeToMsg;
     /**
      *

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

@@ -37,6 +37,7 @@ var ERROR_TYPE;
     ERROR_TYPE["NOT_FOUND"] = "NOT_FOUND";
     ERROR_TYPE["ODATA_URL_NOT_FOUND"] = "ODATA_URL_NOT_FOUND";
     ERROR_TYPE["BAD_GATEWAY"] = "BAD_GATEWAY";
+    ERROR_TYPE["GATEWAY_TIMEOUT"] = "GATEWAY_TIMEOUT";
     ERROR_TYPE["INTERNAL_SERVER_ERROR"] = "INTERNAL_SERVER_ERROR";
     ERROR_TYPE["DESTINATION_SERVICE_UNAVAILABLE"] = "DESTINATION_SERVICE_UNAVAILABLE";
     ERROR_TYPE["DESTINATION_UNAVAILABLE"] = "DESTINATION_UNAVAILABLE";
@@ -86,6 +87,7 @@ exports.ERROR_MAP = {
     [ERROR_TYPE.ODATA_URL_NOT_FOUND]: [],
     [ERROR_TYPE.INTERNAL_SERVER_ERROR]: [/500/],
     [ERROR_TYPE.BAD_GATEWAY]: [/502/],
+    [ERROR_TYPE.GATEWAY_TIMEOUT]: [/504/],
     [ERROR_TYPE.DESTINATION_SERVICE_UNAVAILABLE]: [],
     [ERROR_TYPE.DESTINATION_UNAVAILABLE]: [],
     [ERROR_TYPE.DESTINATION_NOT_FOUND]: [],
@@ -153,6 +155,18 @@ class ErrorHandler {
             error?.response?.status?.toString() ||
             (typeof error === 'string' ? error : JSON.stringify(error)));
     };
+    /**
+     * Get the localized error message for the specified server error.
+     *
+     * @param error the error object or message that was returned from the server (5xx)
+     * @param subTextKey an i18next key used to provide additional context to the error message
+     * @returns the localized error message
+     */
+    static serverErrorMessage = (error, subTextKey) => (0, i18n_1.t)('errors.serverReturnedAnError', {
+        errorDesc: subTextKey
+            ? (0, i18n_1.t)(subTextKey, { errorMsg: ErrorHandler.getMessageFromError(error) })
+            : ErrorHandler.getMessageFromError(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) }),
@@ -182,24 +196,12 @@ class ErrorHandler {
             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', {
-            errorDesc: ErrorHandler.getMessageFromError(error)
-        }),
+        [ERROR_TYPE.SERVICE_UNAVAILABLE]: (error) => ErrorHandler.serverErrorMessage(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.INTERNAL_SERVER_ERROR]: (error) => ErrorHandler.serverErrorMessage(error, 'errors.internalServerError'),
         [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.BAD_GATEWAY]: (error) => ErrorHandler.serverErrorMessage(error, 'errors.badGateway'),
         [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', {
@@ -211,16 +213,10 @@ class ErrorHandler {
         [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.BAD_REQUEST]: (error) => ErrorHandler.serverErrorMessage(error, 'errors.badRequest'),
         [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)
-        })
+        [ERROR_TYPE.SERVER_HTTP_ERROR]: (error) => ErrorHandler.serverErrorMessage(error),
+        [ERROR_TYPE.GATEWAY_TIMEOUT]: (error) => ErrorHandler.serverErrorMessage(error)
     };
     /**
      *
@@ -238,10 +234,9 @@ class ErrorHandler {
      * @returns The Guided Answers node for the specified error type
      */
     static getHelpNode = (errorType) => {
+        const isBAS = (0, btp_utils_1.isAppStudio)();
         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.SERVICES_UNAVAILABLE]: isBAS ? 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,
@@ -253,6 +248,7 @@ class ErrorHandler {
             [ERROR_TYPE.BAD_GATEWAY]: guided_answers_helper_1.HELP_NODES.BAD_GATEWAY,
             [ERROR_TYPE.DESTINATION_SERVICE_UNAVAILABLE]: guided_answers_helper_1.HELP_NODES.DESTINATION_SERVICE_UNAVAILBLE,
             [ERROR_TYPE.NO_V4_SERVICES]: guided_answers_helper_1.HELP_NODES.NO_V4_SERVICES,
+            [ERROR_TYPE.GATEWAY_TIMEOUT]: isBAS ? guided_answers_helper_1.HELP_NODES.DESTINATION_GATEWAY_TIMEOUT : undefined,
             [ERROR_TYPE.AUTH]: undefined,
             [ERROR_TYPE.AUTH_TIMEOUT]: undefined,
             [ERROR_TYPE.REDIRECT]: undefined,

package/dist/types.d.ts

@@ -74,6 +74,7 @@ export interface ListQuestion<A extends Answers = Answers> extends BaseListQuest
 export interface ConfirmQuestion<A extends Answers = Answers> extends BaseConfirmQuestion<A> {
     name: YUIQuestion['name'];
     guiOptions?: YUIQuestion['guiOptions'];
+    additionalMessages?: PromptSeverityMessage;
 }
 export interface EditorQuestion<A extends Answers = Answers> extends BaseEditorQuestion<A> {
     name: YUIQuestion['name'];

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.6.4",
+  "version": "0.6.6",
   "repository": {
     "type": "git",
     "url": "https://github.com/SAP/open-ux-tools.git",
@@ -30,9 +30,9 @@
     "semver": "7.5.4",
     "@sap-ux/btp-utils": "0.17.2",
     "@sap-ux/feature-toggle": "0.2.3",
-    "@sap-ux/fiori-generator-shared": "0.7.19",
-    "@sap-ux/guided-answers-helper": "0.2.0",
-    "@sap-ux/telemetry": "0.5.51",
+    "@sap-ux/fiori-generator-shared": "0.7.20",
+    "@sap-ux/guided-answers-helper": "0.2.1",
+    "@sap-ux/telemetry": "0.5.52",
     "@sap-ux/logger": "0.6.0",
     "@sap-ux/ui5-info": "0.8.3"
   },