@sap-ux/odata-service-inquirer 0.5.33 → 0.5.35

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

@@ -14,6 +14,7 @@ export declare enum ERROR_TYPE {
     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
@@ -32,7 +33,7 @@ export declare enum ERROR_TYPE {
     NO_V4_SERVICES = "NO_V4_SERVICES"
 }
 export declare const ERROR_MAP: Record<ERROR_TYPE, RegExp[]>;
-type ValidationLinkOrString = string | ValidationLink | undefined;
+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.
@@ -138,7 +139,7 @@ export declare class ErrorHandler {
      * @param reset optional, resets the previous error state if true
      * @returns An instance of @see {ValidationLink}
      */
-    getValidationErrorHelp(error?: any, reset?: boolean): ValidationLinkOrString;
+    getValidationErrorHelp(error?: any, reset?: boolean): ValidationLinkOrString | undefined;
     /**
      * Get the error message for the specified error type.
      *
@@ -177,7 +178,7 @@ export declare class ErrorHandler {
      * @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;
+    static getHelpForError(errorType: ERROR_TYPE, errorMsg?: string): ValidationLinkOrString | undefined;
 }
 export {};
 //# sourceMappingURL=error-handler.d.ts.map

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

@@ -23,6 +23,7 @@ var ERROR_TYPE;
     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";
@@ -50,6 +51,7 @@ exports.ERROR_MAP = {
         /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/,
@@ -60,7 +62,7 @@ exports.ERROR_MAP = {
     [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.CONNECTION]: [/ENOTFOUND/, /ECONNRESET/, /ECONNREFUSED/, /ConnectionError/],
     [ERROR_TYPE.SERVICES_UNAVAILABLE]: [],
     [ERROR_TYPE.SERVICE_UNAVAILABLE]: [/503/],
     [ERROR_TYPE.INVALID_URL]: [/Invalid URL/, /ERR_INVALID_URL/],
@@ -111,6 +113,7 @@ class ErrorHandler {
         }),
         [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)
@@ -170,7 +173,8 @@ class ErrorHandler {
             [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.NO_V2_SERVICES]: undefined,
+            [ERROR_TYPE.TIMEOUT]: undefined
         };
         return errorToHelp[errorType];
     };

package/dist/prompts/connectionValidator.d.ts

@@ -39,7 +39,7 @@ export declare class ConnectionValidator {
      *
      * @returns the axios configuration
      */
-    get axiosConfig(): AxiosRequestConfig | undefined;
+    get axiosConfig(): AxiosRequestConfig;
     /**
      * Get the odata service instance.
      *

package/dist/prompts/datasources/sap-system/new-system/questions.js

@@ -18,6 +18,8 @@ const types_2 = require("./types");
 const questions_1 = require("../abap-on-prem/questions");
 const questions_2 = require("../abap-on-btp/questions");
 const logger_helper_1 = __importDefault(require("../../../logger-helper"));
+const prompt_helpers_2 = require("../../../prompt-helpers");
+const error_handler_1 = require("../../../../error-handler/error-handler");
 // New system choice value is a hard to guess string to avoid conflicts with existing system names or user named systems
 // since it will be used as a new system value in the system selection prompt.
 exports.newSystemChoiceValue = '!@£*&937newSystem*X~qy^';
@@ -233,6 +235,10 @@ function getSystemServiceQuestion(connectValidator, promptNamespace, promptOptio
             if (!connectValidator.validatedUrl) {
                 return false;
             }
+            // if no choices are available and an error is present, return the error message
+            if (serviceChoices.length === 0 && prompt_helpers_2.errorHandler.hasError()) {
+                return error_handler_1.ErrorHandler.getHelpForError(error_handler_1.ERROR_TYPE.SERVICES_UNAVAILABLE) ?? false;
+            }
             // Dont re-request the same service details
             if (service && previousService?.servicePath !== service.servicePath) {
                 previousService = service;
@@ -254,6 +260,10 @@ function getSystemServiceQuestion(connectValidator, promptNamespace, promptOptio
                         throw new Error(result);
                     }
                 }
+                if (serviceChoices.length === 0 && prompt_helpers_2.errorHandler.hasError()) {
+                    const noServicesError = error_handler_1.ErrorHandler.getHelpForError(error_handler_1.ERROR_TYPE.SERVICES_UNAVAILABLE).toString();
+                    throw new Error(noServicesError);
+                }
                 return false;
             },
             name: `${promptNamespace}:${cliServicePromptName}`

package/dist/prompts/datasources/sap-system/new-system/service-helper.d.ts

@@ -1,4 +1,4 @@
-import { ServiceType, type Annotations, type CatalogService, type V2CatalogService, type ServiceProvider } from '@sap-ux/axios-extension';
+import { type CatalogService, ServiceType, V2CatalogService, type Annotations, type ServiceProvider } from '@sap-ux/axios-extension';
 import type { ListChoiceOptions } from 'inquirer';
 import type { ServiceAnswer } from './types';
 import type { ConnectionValidator } from '../../../connectionValidator';

package/dist/prompts/datasources/sap-system/new-system/service-helper.js

@@ -9,6 +9,7 @@ const i18n_1 = require("../../../../i18n");
 const logger_helper_1 = __importDefault(require("../../../logger-helper"));
 const utils_1 = require("../../../../utils");
 const odata_service_writer_1 = require("@sap-ux/odata-service-writer");
+const prompt_helpers_1 = require("../../../prompt-helpers");
 // Service ids continaining these paths should not be offered as UI compatible services
 const nonUIServicePaths = ['/IWBEP/COMMON/'];
 /**
@@ -47,6 +48,18 @@ const createServiceChoices = (serviceInfos) => {
     });
     return choices.sort((a, b) => (a.name ? a.name.localeCompare(b.name ?? '') : 0));
 };
+/**
+ * Logs the catalog reuest errors.
+ *
+ * @param requestErrors catalog request errors
+ */
+function logErrorsForHelp(requestErrors) {
+    // Log the first error only
+    const catalogErrors = Object.values(requestErrors);
+    if (catalogErrors.length > 0) {
+        catalogErrors.forEach((error) => prompt_helpers_1.errorHandler.logErrorMsgs(error));
+    }
+}
 /**
  * Get the service choices from the specified catalogs.
  *
@@ -54,18 +67,30 @@ const createServiceChoices = (serviceInfos) => {
  * @returns service choices based on the provided catalogs
  */
 async function getServiceChoices(catalogs) {
+    const requestErrors = {};
     const listServicesRequests = catalogs.map(async (catalog) => {
         try {
             return await catalog.listServices();
         }
         catch (error) {
-            logger_helper_1.default.logger.error(`An error occurred requesting services from: ${catalog.entitySet}. Some services may not be listed.`);
+            logger_helper_1.default.logger.error((0, i18n_1.t)('errors.serviceCatalogRequest', {
+                catalogRequestUri: catalog.getUri(),
+                entitySet: catalog.entitySet,
+                error
+            }));
+            // Save any errors for processing later as we may show more useful message to the user
+            Object.assign(requestErrors, {
+                [catalog instanceof axios_extension_1.V2CatalogService ? axios_extension_1.ODataVersion.v2 : axios_extension_1.ODataVersion.v4]: error
+            });
             return [];
         }
     });
     const serviceInfos = await Promise.all(listServicesRequests);
     const flatServices = serviceInfos?.flat() ?? [];
     logger_helper_1.default.logger.debug(`Number of services available: ${flatServices.length}`);
+    if (flatServices.length === 0) {
+        logErrorsForHelp(requestErrors);
+    }
     return createServiceChoices(flatServices);
 }
 exports.getServiceChoices = getServiceChoices;

package/dist/prompts/datasources/service-url/questions.js

@@ -8,8 +8,8 @@ const inquirer_common_1 = require("@sap-ux/inquirer-common");
 const i18n_1 = require("../../../i18n");
 const types_1 = require("../../../types");
 const utils_1 = require("../../../utils");
-const logger_helper_1 = __importDefault(require("../../logger-helper"));
 const connectionValidator_1 = require("../../connectionValidator");
+const logger_helper_1 = __importDefault(require("../../logger-helper"));
 const types_2 = require("./types");
 const validators_1 = require("./validators");
 /**
@@ -39,7 +39,7 @@ function getServiceUrlPrompt(connectValidator, requiredVersion) {
                 if (!connectValidator.validity.authRequired && connectValidator.odataService) {
                     return (0, validators_1.validateService)(url, {
                         odataService: connectValidator.odataService,
-                        abapServiceProvider: connectValidator.serviceProvider
+                        axiosConfig: connectValidator.axiosConfig
                     }, requiredVersion);
                 }
                 return true;
@@ -82,7 +82,7 @@ function getIgnoreCertErrorsPrompt(connectValidator, requiredVersion) {
                 if (!connectValidator.validity.authRequired && connectValidator.odataService) {
                     return (0, validators_1.validateService)(serviceUrl, {
                         odataService: connectValidator.odataService,
-                        abapServiceProvider: connectValidator.serviceProvider
+                        axiosConfig: connectValidator.axiosConfig
                     }, requiredVersion, ignoreCertError);
                 }
                 return true;
@@ -123,7 +123,7 @@ function getCliIgnoreCertValidatePrompt(connectValidator, requiredVersion) {
                     // Will log on CLI
                     const validService = await (0, validators_1.validateService)(serviceUrl, {
                         odataService: connectValidator.odataService,
-                        abapServiceProvider: connectValidator.serviceProvider
+                        axiosConfig: connectValidator.axiosConfig
                     }, requiredVersion, true);
                     if (validService !== true) {
                         throw new Error((0, i18n_1.t)('errors.exitingGeneration', { exitReason: validService.toString() }));
@@ -183,7 +183,7 @@ function getPasswordPrompt(connectValidator, requiredVersion) {
             if (validAuth === true && connectValidator.odataService) {
                 return (0, validators_1.validateService)(serviceUrl, {
                     odataService: connectValidator.odataService,
-                    abapServiceProvider: connectValidator.serviceProvider
+                    axiosConfig: connectValidator.axiosConfig
                 }, requiredVersion, ignoreCertError);
             }
             return validAuth;

package/dist/prompts/datasources/service-url/validators.d.ts

@@ -1,4 +1,4 @@
-import type { AbapServiceProvider, ODataService } from '@sap-ux/axios-extension';
+import { type AxiosRequestConfig, type ODataService } from '@sap-ux/axios-extension';
 import type { OdataVersion } from '@sap-ux/odata-service-writer';
 /**
  * Validates that a service specified by the service url is accessible, has the required version and returns valid metadata.
@@ -7,13 +7,13 @@ import type { OdataVersion } from '@sap-ux/odata-service-writer';
  * @param url the full odata service url including query parameters
  * @param connectionConfig the connection configuration to use for the validation, a subset of the ConnectionValidator properties
  * @param connectionConfig.odataService the odata service instance used to retrieve the metadata (as used by ConnectionValidator)
- * @param connectionConfig.abapServiceProvider the abap service provider instance used to retrieve annotations (as used by ConnectionValidator)
+ * @param connectionConfig.axiosConfig the axios config to use for the annotations request (as used by ConnectionValidator)
  * @param requiredVersion if specified and the service odata version does not match this version, an error is returned
  * @param ignoreCertError if true some certificate errors are ignored
  * @returns true if a valid odata service was returned, false or an error message string otherwise
  */
-export declare function validateService(url: string, { odataService, abapServiceProvider }: {
+export declare function validateService(url: string, { odataService, axiosConfig }: {
     odataService: ODataService;
-    abapServiceProvider: AbapServiceProvider;
+    axiosConfig: AxiosRequestConfig;
 }, requiredVersion?: OdataVersion | undefined, ignoreCertError?: boolean): Promise<boolean | string>;
 //# sourceMappingURL=validators.d.ts.map

package/dist/prompts/datasources/service-url/validators.js

@@ -4,6 +4,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.validateService = void 0;
+const axios_extension_1 = require("@sap-ux/axios-extension");
 const error_handler_1 = require("../../../error-handler/error-handler");
 const i18n_1 = require("../../../i18n");
 const types_1 = require("../../../types");
@@ -18,12 +19,12 @@ const prompt_helpers_1 = require("../../prompt-helpers");
  * @param url the full odata service url including query parameters
  * @param connectionConfig the connection configuration to use for the validation, a subset of the ConnectionValidator properties
  * @param connectionConfig.odataService the odata service instance used to retrieve the metadata (as used by ConnectionValidator)
- * @param connectionConfig.abapServiceProvider the abap service provider instance used to retrieve annotations (as used by ConnectionValidator)
+ * @param connectionConfig.axiosConfig the axios config to use for the annotations request (as used by ConnectionValidator)
  * @param requiredVersion if specified and the service odata version does not match this version, an error is returned
  * @param ignoreCertError if true some certificate errors are ignored
  * @returns true if a valid odata service was returned, false or an error message string otherwise
  */
-async function validateService(url, { odataService, abapServiceProvider }, requiredVersion = undefined, ignoreCertError = false) {
+async function validateService(url, { odataService, axiosConfig }, requiredVersion = undefined, ignoreCertError = false) {
     try {
         if (ignoreCertError === true) {
             connectionValidator_1.ConnectionValidator.setGlobalRejectUnauthorized(!ignoreCertError);
@@ -49,7 +50,8 @@ async function validateService(url, { odataService, abapServiceProvider }, requi
         // Best effort attempt to get annotations but dont throw an error if it fails as this may not even be an Abap system
         try {
             // Create an abap provider instance to get the annotations using the same request config
-            const catalogService = abapServiceProvider.catalog(serviceOdataVersion);
+            const abapProvider = (0, axios_extension_1.createForAbap)(axiosConfig);
+            const catalogService = abapProvider.catalog(serviceOdataVersion);
             logger_helper_1.default.attachAxiosLogger(catalogService.interceptors);
             logger_helper_1.default.logger.debug('Getting annotations for service');
             const annotations = await catalogService.getAnnotations({ path: fullUrl.pathname });

package/dist/translations/odata-service-inquirer.i18n.json

@@ -130,6 +130,7 @@
         "authenticationTimeout": "Authorization was not verified within the allowed time. Please ensure you have authenticated using the associated browser window.",
         "invalidUrl": "Not a valid URL",
         "connectionError": "A connection error occurred, please ensure the target host is available on the network: {{- error}}",
+        "timeout": "A connection timeout error occurred: {{- error}}",
         "serviceUnavailable": "Selected service is returning an error.",
         "catalogServiceNotActive": "Catalog service is not active",
         "internalServerError": "The URL you have provided cannot be accessed and is returning: '{{- error}}'. Please ensure that the URL is accessible externally.",
@@ -155,7 +156,8 @@
         "serviceTypeRequestError": "Error retrieving service type: {{- error}}",
         "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).",
-        "abapServiceAuthenticationFailed": "ABAP environment authentication using UAA failed."
+        "abapServiceAuthenticationFailed": "ABAP environment authentication using UAA failed.",
+        "serviceCatalogRequest": "An error occurred requesting services from: {{- catalogRequestUri }} and entity set: {{entitySet}}. {{error}}"
     },
     "texts": {
         "anExpiredCert": "an expired",

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@sap-ux/odata-service-inquirer",
   "description": "Prompts module that can prompt users for inputs required for odata service writing",
-  "version": "0.5.33",
+  "version": "0.5.35",
   "repository": {
     "type": "git",
     "url": "https://github.com/SAP/open-ux-tools.git",