@sap-ux/odata-service-inquirer 0.2.3 → 0.3.1

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

@@ -0,0 +1,216 @@
+"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.getServiceUrlQuestions = void 0;
+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 types_2 = require("./types");
+const validators_1 = require("./validators");
+/**
+ * Prompt for the service URL.
+ *
+ * @param connectValidator Connection validator instance
+ * @param requiredVersion The required OData version of the service
+ * @returns the service URL prompt
+ */
+function getServiceUrlPrompt(connectValidator, requiredVersion) {
+    return {
+        type: 'input',
+        name: types_1.promptNames.serviceUrl,
+        guiOptions: {
+            hint: 'https://<hostname>:<port>/path/to/odata/service/',
+            mandatory: true,
+            breadcrumb: true
+        },
+        message: (0, i18n_1.t)('prompts.odataServiceUrl.message', { odataVersion: requiredVersion }),
+        validate: (url) => __awaiter(this, void 0, void 0, function* () {
+            const urlValidationState = yield connectValidator.validateUrl(url);
+            // Check if we have a cert error, the user will be prompted to ignore it later
+            if (connectValidator.validity.canSkipCertError) {
+                return true;
+            }
+            if (urlValidationState === true) {
+                if (!connectValidator.validity.authRequired) {
+                    return (0, validators_1.validateService)(url, connectValidator, requiredVersion);
+                }
+                return true;
+            }
+            return urlValidationState;
+        })
+    };
+}
+/**
+ * Prompt to ignore cert errors.
+ *
+ * @param connectValidator Connection validator instance
+ * @param requiredVersion The required OData version of the service
+ * @returns the ignore cert errors prompt
+ */
+function getIgnoreCertErrorsPrompt(connectValidator, requiredVersion) {
+    return {
+        when: ({ serviceUrl }) => {
+            if (serviceUrl && connectValidator.validity.canSkipCertError) {
+                return true;
+            }
+            return false;
+        },
+        type: 'confirm',
+        name: types_2.serviceUrlInternalPromptNames.ignoreCertError,
+        message: (0, i18n_1.t)('prompts.ignoreCertErrors.message'),
+        default: false,
+        validate: (ignoreCertError, { serviceUrl }) => __awaiter(this, void 0, void 0, function* () {
+            if (!serviceUrl) {
+                return false;
+            }
+            if (ignoreCertError) {
+                logger_helper_1.default.logger.warn((0, i18n_1.t)('prompts.validationMessages.warningCertificateValidationDisabled'));
+            }
+            const validUrl = yield connectValidator.validateUrl(serviceUrl, ignoreCertError, true);
+            if (validUrl === true) {
+                if (!connectValidator.validity.authRequired) {
+                    return (0, validators_1.validateService)(serviceUrl, connectValidator, requiredVersion, ignoreCertError);
+                }
+                return true;
+            }
+            return validUrl;
+        })
+    };
+}
+/**
+ * Prompt used to validate the service based on ignoring cert errors since 'confirm' prompt validators don't run on CLI.
+ *
+ * @param connectValidator Connection validator instance
+ * @param requiredVersion The required OData version of the service
+ * @returns the ignore cert errors cli only prompt
+ */
+function getCliIgnoreCertValidatePrompt(connectValidator, requiredVersion) {
+    return {
+        // Add dummy prompt for CLI to revalidate since "confirm" prompt validators don't run on CLI
+        // The `when` condition should never return true (so it does not get rendered in GUI prompts) but will throw an error to exit generation
+        // if the user chooses to not ignore cert errors or if the odata service is not valid
+        when: ({ serviceUrl, ignoreCertError }) => __awaiter(this, void 0, void 0, function* () {
+            if (serviceUrl && connectValidator.validity.canSkipCertError) {
+                // If the user choose to not ignore cert errors, we cannot continue
+                if (!ignoreCertError) {
+                    throw new Error((0, i18n_1.t)('errors.exitingGeneration', { exitReason: (0, i18n_1.t)('errors.certValidationRequired') }));
+                }
+                // If the user choose to ignore cert errors, we need to re-validate
+                logger_helper_1.default.logger.warn((0, i18n_1.t)('prompts.validationMessages.warningCertificateValidationDisabled'));
+                // Re-check if auth required as the cert error would have prevented this check earlier
+                const validUrl = yield connectValidator.validateUrl(serviceUrl, ignoreCertError, true);
+                if (validUrl !== true) {
+                    throw new Error(validUrl.toString()); // exit
+                }
+                if (!connectValidator.validity.authRequired) {
+                    // Will log on CLI
+                    const validService = yield (0, validators_1.validateService)(serviceUrl, connectValidator, requiredVersion, true);
+                    if (validService !== true) {
+                        throw new Error((0, i18n_1.t)('errors.exitingGeneration', { exitReason: validService.toString() }));
+                    }
+                }
+            }
+            return false;
+        }),
+        name: types_2.serviceUrlInternalPromptNames.cliIgnoreCertValidate
+    };
+}
+/**
+ * Prompt for the username.
+ *
+ * @param connectValidator Connection validator instance
+ * @returns the username prompt
+ */
+function getUsernamePrompt(connectValidator) {
+    return {
+        when: () => (connectValidator.validity.reachable ? connectValidator.validity.authRequired === true : false),
+        type: 'input',
+        name: types_2.serviceUrlInternalPromptNames.username,
+        message: (0, i18n_1.t)('prompts.serviceUsername.message'),
+        guiOptions: {
+            mandatory: true
+        },
+        validate: (user) => (user === null || user === void 0 ? void 0 : user.length) > 0
+    };
+}
+/**
+ * Prompt for the password.
+ *
+ * @param connectValidator Connection validator instance
+ * @param requiredVersion The required OData version of the service
+ * @returns the password prompt
+ */
+function getPasswordPrompt(connectValidator, requiredVersion) {
+    return {
+        when: () => (connectValidator.validity.reachable ? connectValidator.validity.authRequired === true : false),
+        type: 'password',
+        guiOptions: {
+            applyDefaultWhenDirty: true,
+            mandatory: true
+        },
+        name: types_1.promptNames.serviceUrlPassword,
+        message: (0, i18n_1.t)('prompts.servicePassword.message'),
+        guiType: 'login',
+        mask: '*',
+        validate: (password, { username, serviceUrl, ignoreCertError }) => __awaiter(this, void 0, void 0, function* () {
+            if (!serviceUrl || !username || !password) {
+                return false;
+            }
+            const validAuth = yield connectValidator.validateAuth(serviceUrl, username, password, ignoreCertError);
+            if (validAuth === true) {
+                return (0, validators_1.validateService)(serviceUrl, connectValidator, requiredVersion, ignoreCertError);
+            }
+            return validAuth;
+        })
+    };
+}
+/**
+ * Get the service URL questions.
+ *
+ * @param promptOptions prompt options that can be passed to the service URL questions to configure behaviour
+ * @param promptOptions.serviceUrl see {@link OdataServicePromptOptions}
+ * @param promptOptions.serviceUrlPassword see {@link OdataServicePromptOptions}
+ * @returns the odata service URL questions
+ */
+function getServiceUrlQuestions({ serviceUrl: serviceUrlOpts, serviceUrlPassword: passwordOpts } = {}) {
+    // Connection validator maintains connection state and validity across multiple prompts
+    const connectValidator = new connectionValidator_1.ConnectionValidator();
+    const requiredVersion = serviceUrlOpts === null || serviceUrlOpts === void 0 ? void 0 : serviceUrlOpts.requiredOdataVersion;
+    utils_1.PromptState.reset();
+    let questions = [
+        getServiceUrlPrompt(connectValidator, requiredVersion),
+        getIgnoreCertErrorsPrompt(connectValidator, requiredVersion)
+    ];
+    if ((0, utils_1.getHostEnvironment)() === types_1.hostEnvironment.cli) {
+        questions.push(getCliIgnoreCertValidatePrompt(connectValidator, requiredVersion));
+    }
+    questions.push(getUsernamePrompt(connectValidator), getPasswordPrompt(connectValidator, requiredVersion));
+    // Add additional messages to prompts if specified in the prompt options
+    let promptsOptToExtend = {};
+    if (serviceUrlOpts === null || serviceUrlOpts === void 0 ? void 0 : serviceUrlOpts.additionalMessages) {
+        promptsOptToExtend = { serviceUrl: serviceUrlOpts };
+    }
+    if (passwordOpts === null || passwordOpts === void 0 ? void 0 : passwordOpts.additionalMessages) {
+        promptsOptToExtend = Object.assign(Object.assign({}, promptsOptToExtend), { serviceUrlPassword: passwordOpts });
+    }
+    if (promptsOptToExtend) {
+        questions = (0, inquirer_common_1.extendWithOptions)(questions, promptsOptToExtend, utils_1.PromptState.odataService);
+    }
+    return questions;
+}
+exports.getServiceUrlQuestions = getServiceUrlQuestions;
+//# sourceMappingURL=questions.js.map

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

@@ -0,0 +1,9 @@
+/**
+ * Enumeration of internal prompt names used internally and not supported for modification using OdataServiceInquirerPromptOptions
+ */
+export declare enum serviceUrlInternalPromptNames {
+    ignoreCertError = "ignoreCertError",
+    username = "username",
+    cliIgnoreCertValidate = "cliIgnoreCertValidate"
+}
+//# sourceMappingURL=types.d.ts.map

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

@@ -0,0 +1,13 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.serviceUrlInternalPromptNames = void 0;
+/**
+ * Enumeration of internal prompt names used internally and not supported for modification using OdataServiceInquirerPromptOptions
+ */
+var serviceUrlInternalPromptNames;
+(function (serviceUrlInternalPromptNames) {
+    serviceUrlInternalPromptNames["ignoreCertError"] = "ignoreCertError";
+    serviceUrlInternalPromptNames["username"] = "username";
+    serviceUrlInternalPromptNames["cliIgnoreCertValidate"] = "cliIgnoreCertValidate";
+})(serviceUrlInternalPromptNames || (exports.serviceUrlInternalPromptNames = serviceUrlInternalPromptNames = {}));
+//# sourceMappingURL=types.js.map

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

@@ -0,0 +1,19 @@
+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 odata service is accessible, has the required version and returns valid metadata.
+ * Retrieves annotations (from Abap backends) if available and stores them in the PromptState.
+ *
+ * @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.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, axiosConfig }: {
+    odataService: ODataService;
+    axiosConfig: AxiosRequestConfig;
+}, requiredVersion?: OdataVersion | undefined, ignoreCertError?: boolean): Promise<boolean | string>;
+//# sourceMappingURL=validators.d.ts.map

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

@@ -0,0 +1,95 @@
+"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.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");
+const utils_1 = require("../../../utils");
+const logger_helper_1 = __importDefault(require("../../logger-helper"));
+const prompt_helpers_1 = require("../../prompt-helpers");
+const connectionValidator_1 = require("./connectionValidator");
+/**
+ * Validates that a service specified by the odata service is accessible, has the required version and returns valid metadata.
+ * Retrieves annotations (from Abap backends) if available and stores them in the PromptState.
+ *
+ * @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.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
+ */
+function validateService(url, { odataService, axiosConfig }, requiredVersion = undefined, ignoreCertError = false) {
+    var _a, _b;
+    return __awaiter(this, void 0, void 0, function* () {
+        try {
+            if (ignoreCertError === true) {
+                connectionValidator_1.ConnectionValidator.setGlobalRejectUnauthorized(!ignoreCertError);
+            }
+            const metadata = yield odataService.metadata();
+            const serviceOdataVersion = (0, utils_1.parseOdataVersion)(metadata);
+            if (requiredVersion && requiredVersion !== serviceOdataVersion) {
+                return `${(0, i18n_1.t)('errors.odataServiceVersionMismatch', {
+                    serviceVersion: serviceOdataVersion,
+                    requiredVersion
+                })}`;
+            }
+            // Remove all occurrences of the origin from the metadata to make backend uris relative
+            utils_1.PromptState.odataService.metadata = (0, utils_1.originToRelative)(metadata);
+            utils_1.PromptState.odataService.odataVersion = serviceOdataVersion;
+            // Extract sap-client and keep the rest of the query params as part of the url
+            const fullUrl = new URL(url);
+            const sapClient = (_a = fullUrl.searchParams.get(types_1.SAP_CLIENT_KEY)) !== null && _a !== void 0 ? _a : undefined;
+            fullUrl.searchParams.delete(types_1.SAP_CLIENT_KEY);
+            utils_1.PromptState.odataService.servicePath = `${fullUrl.pathname}${fullUrl.search}`;
+            utils_1.PromptState.odataService.origin = fullUrl.origin;
+            utils_1.PromptState.odataService.sapClient = sapClient;
+            // 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 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 = yield catalogService.getAnnotations({ path: fullUrl.pathname });
+                logger_helper_1.default.logger.debug(`Annotations array of length: ${annotations === null || annotations === void 0 ? void 0 : annotations.length} returned`);
+                if ((annotations === null || annotations === void 0 ? void 0 : annotations.length) === 0 || !annotations) {
+                    logger_helper_1.default.logger.info((0, i18n_1.t)('prompts.validationMessages.annotationsNotFound'));
+                }
+                utils_1.PromptState.odataService.annotations = annotations;
+            }
+            catch (err) {
+                logger_helper_1.default.logger.info((0, i18n_1.t)('prompts.validationMessages.annotationsNotFound'));
+            }
+            return true;
+        }
+        catch (error) {
+            delete utils_1.PromptState.odataService.metadata;
+            // Provide a more specific error message if the metadata service URL is not found
+            if (error_handler_1.ErrorHandler.getErrorType(error) === error_handler_1.ERROR_TYPE.NOT_FOUND) {
+                // No metadata implies not a valid odata service
+                return (_b = error_handler_1.ErrorHandler.getErrorMsgFromType(error_handler_1.ERROR_TYPE.ODATA_URL_NOT_FOUND)) !== null && _b !== void 0 ? _b : false;
+            }
+            return prompt_helpers_1.errorHandler.logErrorMsgs(error);
+        }
+        finally {
+            connectionValidator_1.ConnectionValidator.setGlobalRejectUnauthorized(true);
+        }
+    });
+}
+exports.validateService = validateService;
+//# sourceMappingURL=validators.js.map

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

@@ -1,4 +1,5 @@
 import { type Logger } from '@sap-ux/logger';
+import type { AxiosInterceptorManager, AxiosResponse, InternalAxiosRequestConfig } from 'axios';
 /**
  * Static logger prevents passing of logger references through all functions, as this is a cross-cutting concern.
  */
@@ -16,5 +17,16 @@ export default class LoggerHelper {
      * @param value the logger to set
      */
     static set logger(value: Logger);
+    /**
+     * Attach the Axios logger to the request and response interceptors.
+     *
+     * @param interceptors the axios interceptors
+     * @param interceptors.request the axios request interceptor
+     * @param interceptors.response the axios response interceptor
+     */
+    static attachAxiosLogger(interceptors: {
+        request: AxiosInterceptorManager<InternalAxiosRequestConfig>;
+        response: AxiosInterceptorManager<AxiosResponse>;
+    }): void;
 }
 //# sourceMappingURL=logger-helper.d.ts.map

package/dist/prompts/logger-helper.js

@@ -1,6 +1,30 @@
 "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 __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
 Object.defineProperty(exports, "__esModule", { value: true });
 const logger_1 = require("@sap-ux/logger");
+const AxiosLogger = __importStar(require("axios-logger"));
 /**
  * Static logger prevents passing of logger references through all functions, as this is a cross-cutting concern.
  */
@@ -21,6 +45,41 @@ class LoggerHelper {
     static set logger(value) {
         LoggerHelper._logger = value;
     }
+    /**
+     * Attach the Axios logger to the request and response interceptors.
+     *
+     * @param interceptors the axios interceptors
+     * @param interceptors.request the axios request interceptor
+     * @param interceptors.response the axios response interceptor
+     */
+    static attachAxiosLogger(interceptors) {
+        interceptors.request.use((request) => {
+            return AxiosLogger.requestLogger(request, {
+                url: true,
+                data: true,
+                prefixText: '@sap-ux/odata-service-inquirer',
+                headers: true,
+                logger: LoggerHelper.logger.debug.bind(this)
+            });
+        }, (error) => {
+            return AxiosLogger.errorLogger(error, {
+                logger: LoggerHelper.logger.debug
+            });
+        });
+        interceptors.response.use((response) => {
+            return AxiosLogger.responseLogger(response, {
+                data: true,
+                prefixText: '@sap-ux/odata-service-inquirer',
+                status: true,
+                headers: true,
+                logger: LoggerHelper.logger.debug
+            });
+        }, (err) => {
+            return AxiosLogger.errorLogger(err, {
+                logger: LoggerHelper.logger.debug
+            });
+        });
+    }
 }
 LoggerHelper._logger = new logger_1.ToolsLogger({ logPrefix: '@sap-ux/odata-service-inquirer' });
 exports.default = LoggerHelper;

package/dist/prompts/prompts.js

@@ -21,6 +21,7 @@ const metadata_file_1 = require("./datasources/metadata-file");
 const prompt_helpers_1 = require("./prompt-helpers");
 const questions_1 = require("./datasources/cap-project/questions");
 const logger_helper_1 = __importDefault(require("./logger-helper"));
+const questions_2 = require("./datasources/service-url/questions");
 /**
  * Get the prompts for the OData service inquirer.
  *
@@ -91,6 +92,7 @@ function getDatasourceTypeConditionalQuestions(promptOptions) {
         const conditionalQuestions = [];
         conditionalQuestions.push(...(0, inquirer_common_1.withCondition)([(0, metadata_file_1.getMetadataFileQuestion)(promptOptions === null || promptOptions === void 0 ? void 0 : promptOptions.metadataFilePath)], (answers) => answers.datasourceType === types_1.DatasourceType.metadataFile));
         conditionalQuestions.push(...(0, inquirer_common_1.withCondition)((0, questions_1.getLocalCapProjectPrompts)(promptOptions), (answers) => answers.datasourceType === types_1.DatasourceType.capProject));
+        conditionalQuestions.push(...(0, inquirer_common_1.withCondition)((0, questions_2.getServiceUrlQuestions)(promptOptions), (answers) => answers.datasourceType === types_1.DatasourceType.odataServiceUrl));
         //...further data sources to be added here
         return conditionalQuestions;
     });

package/dist/prompts/validators.d.ts

@@ -1,4 +1,4 @@
-import { OdataVersion } from '@sap-ux/odata-service-writer';
+import type { OdataVersion } from '@sap-ux/odata-service-writer';
 /**
  * Validator function to verify if the specified metadata edmx version matches the specified required odata version.
  *

package/dist/prompts/validators.js

@@ -5,9 +5,8 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.validateODataVersion = void 0;
 const i18n_1 = require("../i18n");
-const odata_service_writer_1 = require("@sap-ux/odata-service-writer");
-const wing_service_explorer_1 = require("@sap/wing-service-explorer");
 const logger_helper_1 = __importDefault(require("./logger-helper"));
+const utils_1 = require("../utils");
 /**
  * Validator function to verify if the specified metadata edmx version matches the specified required odata version.
  *
@@ -16,14 +15,11 @@ const logger_helper_1 = __importDefault(require("./logger-helper"));
  * @returns version and/or validation error message
  */
 function validateODataVersion(edmx, requiredVersion) {
-    const metadataFactory = wing_service_explorer_1.MetadataFactory.getMetadataFactory();
     try {
-        const explorer = metadataFactory.getMetadataExplorer(edmx);
-        // Wing service explorer does not export the type of the protocol, so we need to check the string
-        const version = explorer.getProtocolType().indexOf('v4') > 0 ? odata_service_writer_1.OdataVersion.v4 : odata_service_writer_1.OdataVersion.v2;
-        if (requiredVersion && requiredVersion !== version) {
+        const serviceOdataVersion = (0, utils_1.parseOdataVersion)(edmx);
+        if (requiredVersion && requiredVersion !== serviceOdataVersion) {
             const odataErrorMsg = (0, i18n_1.t)('prompts.validationMessages.odataVersionMismatch', {
-                providedOdataVersion: version,
+                providedOdataVersion: serviceOdataVersion,
                 requiredOdataVersion: requiredVersion
             });
             logger_helper_1.default.logger.error(odataErrorMsg);
@@ -32,12 +28,12 @@ function validateODataVersion(edmx, requiredVersion) {
             };
         }
         return {
-            version
+            version: serviceOdataVersion
         };
     }
     catch (err) {
         return {
-            validationMsg: (0, i18n_1.t)('prompts.validationMessages.metadataInvalid')
+            validationMsg: err.message
         };
     }
 }

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

@@ -40,11 +40,25 @@
             "breadcrumb": "CAP Service",
             "enterCapPathChoiceName": "Manually select CAP service folder path"
         },
+        "odataServiceUrl": {
+            "message": "OData{{odataVersion, odataVersionFormatter}} service URL"
+        },
+        "ignoreCertErrors": {
+            "message": "Do you want to continue generation with the untrusted certificate?"
+        },
+        "serviceUsername": {
+            "message": "Service username"
+        },
+        "servicePassword": {
+            "message": "Service password"
+        },
         "validationMessages": {
             "odataVersionMismatch": "The template you have chosen supports V{{requiredOdataVersion}} OData services only. The provided version is V{{providedOdataVersion}}.",
             "metadataInvalid": "The service metadata is invalid.",
             "metadataFilePathNotValid": "Metadata file does not exist or is not accessible. Please specify a valid file path.",
-            "capProjectNotFound": "The folder you have selected does not seem to contain a valid CAP project. Please check and try again."
+            "capProjectNotFound": "The folder you have selected does not seem to contain a valid CAP project. Please check and try again.",
+            "warningCertificateValidationDisabled": "User has disabled certificate validation",
+            "annotationsNotFound": "Annotations not found for specified service"
         },
         "nonUIServiceTypeWarningMessage": "Please note that {{serviceTypeDesc}} services are not intended to be used for the generation of SAP Fiori UI applications"
     },
@@ -65,13 +79,20 @@
         "internalServerError": "The URL you have provided cannot be accessed and is returning: '{{- error}}'. Please ensure that the URL is accessible externally.",
         "urlNotFound": "URL not found",
         "odataServiceUrlNotFound": "The service URL you have provided is not a valid OData Service. Fiori applications require an OData service as the data source.",
+        "badGateway": "The server returned an error: bad gateway, please check the URL and try again.",
         "destinationUnavailable": "The selected destination references an instance that is not available. Please check your destination configuration and try again.",
         "destinationNotFound": "The destination is mis-configured, HTTP Error 404 returned, the requested resource could not be found.",
         "destinationMisconfigured": "The destination is mis-configured, HTML5.DynamicDestination property is missing.",
         "noServicesAvailable": "There are no V{{version}} OData services available from the selected system and the template you have chosen supports V{{version}} OData services only",
         "redirectError": "A redirect response was received from the server",
         "abapEnvsUnavailable": "ABAP environments unavailable",
-        "noSuchHostError": "No such host is known"
+        "noSuchHostError": "No such host is known",
+        "odataServiceVersionMismatch": "The template you have chosen supports V{{requiredVersion}} OData services only. The provided version is V{{serviceVersion}}.",
+        "destinationAuthError": "The selected system is returning an authentication error. Please verify the destination configuration",
+        "serviceUrlNotFound": "Please verify the service url: {{- url}}, target system configuration and network connectivity",
+        "urlRedirect": "The service URL is redirecting",
+        "certValidationRequired": "Certificate validation is required to continue.",
+        "exitingGeneration": "Exiting generation. {{exitReason}}"
     },
     "texts": {
         "anExpiredCert": "an expired",

package/dist/types.d.ts

@@ -1,5 +1,6 @@
 import type { IValidationLink } from '@sap-devx/yeoman-ui-types';
-import type { YUIQuestion } from '@sap-ux/inquirer-common';
+import type { Annotations } from '@sap-ux/axios-extension';
+import type { CommonPromptOptions, YUIQuestion } from '@sap-ux/inquirer-common';
 import type { OdataVersion } from '@sap-ux/odata-service-writer';
 import type { CdsVersionInfo } from '@sap-ux/project-access';
 import type { ListChoiceOptions } from 'inquirer';
@@ -28,6 +29,10 @@ export interface OdataServiceAnswers {
      * The odata service metadata (edmx) document.
      */
     metadata?: string;
+    /**
+     * The annotations document for the service.
+     */
+    annotations?: Annotations[];
     /**
      * The selected CAP service.
      */
@@ -37,9 +42,25 @@ export interface OdataServiceAnswers {
      */
     odataVersion?: OdataVersion;
     /**
-     * The relative path of the selected service.
+     * The url origin (scheme, domain and port) of the service.
+     */
+    origin?: string;
+    /**
+     * The relative url path of the selected service. This coupled with the origin forms the full service url.
      */
     servicePath?: string;
+    /**
+     * The 'sap-client' value for the service.
+     */
+    sapClient?: string;
+    /**
+     * User name for the service where basic authentication is required.
+     */
+    username?: string;
+    /**
+     * Password for the service where basic authentication is required.
+     */
+    password?: string;
     /**
      * Metadata file path
      */
@@ -64,7 +85,15 @@ export declare enum promptNames {
     /**
      * Cap service
      */
-    capService = "capService"
+    capService = "capService",
+    /**
+     * Odata service URL
+     */
+    serviceUrl = "serviceUrl",
+    /**
+     * password
+     */
+    serviceUrlPassword = "serviceUrlPassword"
 }
 export type CapRuntime = 'Node.js' | 'Java';
 export interface CapService {
@@ -137,10 +166,17 @@ export type MetadataPromptOptions = {
      */
     requiredOdataVersion?: OdataVersion;
 };
+export type OdataServiceUrlPromptOptions = {
+    /**
+     * Used to validate the service specified by the url is of the required odata version edmx
+     */
+    requiredOdataVersion?: OdataVersion;
+} & Pick<CommonPromptOptions, 'additionalMessages'>;
+export type OdataServiceUrlPasswordOptions = Pick<CommonPromptOptions, 'additionalMessages'>;
 /**
- * Provide the correct type checking for object value prompt options
+ * Provide the correct type checking for prompt options
  */
-type odataServiceInquirerPromptOptions = Record<promptNames.datasourceType, DatasourceTypePromptOptions> & Record<promptNames.metadataFilePath, MetadataPromptOptions> & Record<promptNames.capProject, CapProjectPromptOptions> & Record<promptNames.capService, CapServicePromptOptions>;
+type odataServiceInquirerPromptOptions = Record<promptNames.datasourceType, DatasourceTypePromptOptions> & Record<promptNames.metadataFilePath, MetadataPromptOptions> & Record<promptNames.capProject, CapProjectPromptOptions> & Record<promptNames.capService, CapServicePromptOptions> & Record<promptNames.serviceUrl, OdataServiceUrlPromptOptions> & Record<promptNames.serviceUrlPassword, OdataServiceUrlPasswordOptions>;
 export type OdataServiceQuestion = YUIQuestion<OdataServiceAnswers>;
 export type OdataServicePromptOptions = Partial<odataServiceInquirerPromptOptions>;
 /**
@@ -177,5 +213,6 @@ export declare const hostEnvironment: {
         technical: string;
     };
 };
+export declare const SAP_CLIENT_KEY = "sap-client";
 export {};
 //# sourceMappingURL=types.d.ts.map