@sap-ux/odata-service-inquirer 0.5.28 → 0.5.29

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

@@ -3,29 +3,47 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getUserSystemNameQuestion = exports.getNewSystemQuestions = exports.newSystemChoiceValue = void 0;
-/**
- * New system prompting questions for re-use in multiple sap-system datasource prompt sets.
- */
+exports.getSystemServiceQuestion = exports.getSelectedServiceLabel = exports.getUserSystemNameQuestion = exports.getSystemUrlQuestion = exports.getNewSystemQuestions = exports.newSystemChoiceValue = void 0;
 const yeoman_ui_types_1 = require("@sap-devx/yeoman-ui-types");
+const axios_extension_1 = require("@sap-ux/axios-extension");
 const inquirer_common_1 = require("@sap-ux/inquirer-common");
 const store_1 = require("@sap-ux/store");
 const i18n_1 = require("../../../../i18n");
 const types_1 = require("../../../../types");
 const utils_1 = require("../../../../utils");
-const logger_helper_1 = __importDefault(require("../../../logger-helper"));
-const questions_1 = require("../abap-on-prem/questions");
 const prompt_helpers_1 = require("../prompt-helpers");
 const validators_1 = require("../validators");
+const service_helper_1 = require("./service-helper");
+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"));
 // 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^';
-const newSystemPromptNames = {
-    newSystemType: 'newSystemType'
-};
+const cliServicePromptName = 'cliServiceSelection';
 const systemSelectionPromptNames = {
     system: 'system'
 };
+/**
+ * Convert the system connection scheme (Service Key, Rentrance Ticket, etc) to the store specific authentication type.
+ * Note the absence of CF Discovery, in this case the service key file (UAA) is also used for the Abap connectivity.
+ *
+ * @param systemAuthType The system authentication type
+ * @returns The store specific authentication type
+ */
+function systemAuthTypeToAuthenticationType(systemAuthType) {
+    switch (systemAuthType) {
+        case 'serviceKey':
+            return store_1.AuthenticationType.OAuth2RefreshToken;
+        case 'reentranceTicket':
+            return store_1.AuthenticationType.ReentranceTicket;
+        case 'basic':
+            return store_1.AuthenticationType.Basic;
+        default:
+            return undefined;
+    }
+}
 /**
  * Provides prompts that allow the creation of a new system connection.
  *
@@ -36,52 +54,91 @@ function getNewSystemQuestions(promptOptions) {
     const questions = [
         {
             type: 'list',
-            name: newSystemPromptNames.newSystemType,
+            name: types_2.newSystemPromptNames.newSystemType,
             choices: [
                 { name: (0, i18n_1.t)('prompts.newSystemType.choiceAbapOnBtp'), value: 'abapOnBtp' },
                 { name: (0, i18n_1.t)('prompts.newSystemType.choiceAbapOnPrem'), value: 'abapOnPrem' }
             ],
-            message: (0, i18n_1.t)('prompts.newSystemType.message'),
-            additionalMessages: (systemType) => {
-                if (['abapOnBtp'].includes(systemType)) {
-                    logger_helper_1.default.logger?.warn((0, i18n_1.t)('prompts.systemType.notYetImplementedWarningMessage', { systemType }));
-                    return {
-                        message: (0, i18n_1.t)('prompts.systemType.notYetImplementedWarningMessage', { systemType }),
-                        severity: yeoman_ui_types_1.Severity.warning
-                    };
-                }
-            }
+            message: (0, i18n_1.t)('prompts.newSystemType.message')
         }
     ];
     questions.push(...(0, inquirer_common_1.withCondition)((0, questions_1.getAbapOnPremQuestions)(promptOptions), (answers) => answers.newSystemType === 'abapOnPrem'));
+    questions.push(...(0, inquirer_common_1.withCondition)((0, questions_2.getAbapOnBTPSystemQuestions)(promptOptions), (answers) => answers.newSystemType === 'abapOnBtp'));
     return questions;
 }
 exports.getNewSystemQuestions = getNewSystemQuestions;
+/**
+ * Get the system url prompt. The system url prompt is used to connect to a new system using the user input system url.
+ *
+ * @param connectValidator a connection validator instance used to validate the system url
+ * @param promptNamespace The namespace for the prompt, used to identify the prompt instance and namespaced answers.
+ * @param requiredOdataVersion The required OData version for the system connection, only catalogs supporting the specifc odata version will be used.
+ * @returns the system url prompt
+ */
+function getSystemUrlQuestion(connectValidator, promptNamespace, requiredOdataVersion) {
+    const promptName = `${promptNamespace ? promptNamespace + ':' : ''}${types_2.newSystemPromptNames.newSystemUrl}`;
+    const newSystemUrlQuestion = {
+        type: 'input',
+        name: promptName,
+        message: (0, i18n_1.t)('prompts.systemUrl.message'),
+        guiOptions: {
+            hint: (0, i18n_1.t)('prompts.systemUrl.description'),
+            mandatory: true,
+            breadcrumb: true
+        },
+        validate: async (url) => {
+            const valResult = await connectValidator.validateUrl(url, {
+                isSystem: true,
+                odataVersion: (0, utils_1.convertODataVersionType)(requiredOdataVersion)
+            });
+            // If basic auth not required we should have an active connection
+            if (valResult === true && !connectValidator.validity.authRequired && connectValidator.serviceProvider) {
+                utils_1.PromptState.odataService.connectedSystem = {
+                    serviceProvider: connectValidator.serviceProvider
+                };
+            }
+            return valResult;
+        }
+    };
+    return newSystemUrlQuestion;
+}
+exports.getSystemUrlQuestion = getSystemUrlQuestion;
 /**
  * Get a prompt for new system name.
  *
+ * @param connectValidator A reference to the active connection validator,
+ *     at prompt execution time the connection properties will be used to create a new BackendSystem, set into the PromptState.odataService.connectedSystem
+ * @param promptNamespace The namespace for the prompt, used to identify the prompt instance and namespaced answers.
+ *     This prevents conflicts with other prompts of the same types where the same prompt is used by multiple other prompts but cannot share the name.
  * @returns the new system name prompt
  */
-function getUserSystemNameQuestion() {
+function getUserSystemNameQuestion(connectValidator, promptNamespace) {
     let defaultSystemName;
     let userModifiedSystemName = false;
+    const promptNamespacePart = `${promptNamespace ? promptNamespace + ':' : ''}`;
+    const promptName = `${promptNamespacePart}${types_1.promptNames.userSystemName}`;
     const newSystemNamePrompt = {
         type: 'input',
         guiOptions: {
             hint: (0, i18n_1.t)('prompts.systemName.hint'),
             applyDefaultWhenDirty: true,
-            breadcrumb: true
+            breadcrumb: true,
+            mandatory: true
         },
-        name: types_1.promptNames.userSystemName,
+        name: promptName,
         message: (0, i18n_1.t)('prompts.systemName.message'),
-        default: async (answers) => {
-            if (answers.newSystemType === 'abapOnPrem' && answers.systemUrl && !userModifiedSystemName) {
-                defaultSystemName = await (0, prompt_helpers_1.suggestSystemName)(answers.systemUrl, answers.sapClient);
+        default: async () => {
+            const systemName = connectValidator.connectedSystemName;
+            if (systemName && !userModifiedSystemName) {
+                defaultSystemName = await (0, prompt_helpers_1.suggestSystemName)(systemName, connectValidator.axiosConfig?.params?.sapClient);
                 return defaultSystemName;
             }
-            return answers.userSystemName;
+            return defaultSystemName;
         },
-        validate: async (systemName, answers) => {
+        validate: async (systemName) => {
+            if (!systemName) {
+                return false;
+            }
             let isValid = false;
             // Dont validate the suggested default system name
             if (systemName === defaultSystemName) {
@@ -89,18 +146,23 @@ function getUserSystemNameQuestion() {
             }
             else {
                 userModifiedSystemName = true;
+                defaultSystemName = systemName;
                 isValid = await (0, validators_1.validateSystemName)(systemName);
             }
             if (isValid === true) {
-                // Not the default system name, so the user modified
-                const backendSystem = new store_1.BackendSystem({
-                    name: systemName,
-                    url: answers.systemUrl,
-                    client: answers.sapClient,
-                    username: answers.abapSystemUsername,
-                    password: answers.abapSystemPassword
-                });
-                if (utils_1.PromptState.odataService.connectedSystem) {
+                // Update or create the BackendSystem with the new system details for persistent storage
+                if (connectValidator.validatedUrl && utils_1.PromptState.odataService.connectedSystem) {
+                    const backendSystem = new store_1.BackendSystem({
+                        authenticationType: systemAuthTypeToAuthenticationType(connectValidator.systemAuthType),
+                        name: systemName,
+                        url: connectValidator.validatedUrl,
+                        client: connectValidator.axiosConfig?.params?.[types_1.SAP_CLIENT_KEY],
+                        username: connectValidator.axiosConfig?.auth?.username,
+                        password: connectValidator.axiosConfig?.auth?.password,
+                        serviceKeys: connectValidator.serviceInfo,
+                        userDisplayName: connectValidator.connectedUserName,
+                        refreshToken: connectValidator.refreshToken
+                    });
                     utils_1.PromptState.odataService.connectedSystem.backendSystem = backendSystem;
                 }
             }
@@ -110,4 +172,134 @@ function getUserSystemNameQuestion() {
     return newSystemNamePrompt;
 }
 exports.getUserSystemNameQuestion = getUserSystemNameQuestion;
+/**
+ * Create a value for the service selection prompt message, which may include thge active connected user name.
+ *
+ * @param username The connected user name
+ * @returns The service selection prompt message
+ */
+function getSelectedServiceLabel(username) {
+    let message = (0, i18n_1.t)('prompts.systemService.message');
+    if (username) {
+        message = message.concat(` ${(0, i18n_1.t)('texts.forUserName', { username })}`);
+    }
+    return message;
+}
+exports.getSelectedServiceLabel = getSelectedServiceLabel;
+/**
+ * Get the service selection prompt for a system connection. The service selection prompt is used to select a service from the system catalog.
+ *
+ * @param connectValidator A reference to the active connection validator, used to validate the service selection and retrieve service details.
+ * @param promptNamespace The namespace for the prompt, used to identify the prompt instance and namespaced answers.
+ *     This is used to avoid conflicts with other prompts of the same types.
+ * @param promptOptions Options for the service selection prompt see {@link OdataServicePromptOptions}
+ * @returns the service selection prompt
+ */
+function getSystemServiceQuestion(connectValidator, promptNamespace, promptOptions) {
+    let serviceChoices = [];
+    // Prevent re-requesting services repeatedly by only requesting them once and when the system is changed
+    let previousSystemUrl;
+    let previousService;
+    const requiredOdataVersion = promptOptions?.serviceSelection?.requiredOdataVersion;
+    const newSystemServiceQuestion = {
+        when: () => connectValidator.validity.authenticated || connectValidator.validity.authRequired === false,
+        name: `${promptNamespace}:${types_1.promptNames.serviceSelection}`,
+        type: promptOptions?.serviceSelection?.useAutoComplete ? 'autocomplete' : 'list',
+        message: () => getSelectedServiceLabel(connectValidator.connectedUserName),
+        guiOptions: {
+            breadcrumb: (0, i18n_1.t)('prompts.systemService.breadcrumb'),
+            mandatory: true,
+            applyDefaultWhenDirty: true
+        },
+        source: (prevAnswers, input) => (0, inquirer_common_1.searchChoices)(input, serviceChoices),
+        choices: async () => {
+            if (serviceChoices.length === 0 || previousSystemUrl !== connectValidator.validatedUrl) {
+                let catalogs = [];
+                if (requiredOdataVersion && connectValidator.catalogs[requiredOdataVersion]) {
+                    catalogs.push(connectValidator.catalogs[requiredOdataVersion]);
+                }
+                else {
+                    catalogs = Object.values(connectValidator.catalogs).filter((cat) => cat !== undefined);
+                }
+                previousSystemUrl = connectValidator.validatedUrl;
+                serviceChoices = await (0, service_helper_1.getServiceChoices)(catalogs);
+            }
+            return serviceChoices;
+        },
+        additionalMessages: (selectedService) => getSelectedServiceMessage(serviceChoices, selectedService, connectValidator, requiredOdataVersion),
+        default: () => (0, utils_1.getDefaultChoiceIndex)(serviceChoices),
+        // Warning: only executes in YUI not cli
+        validate: async (service) => {
+            if (!connectValidator.validatedUrl) {
+                return false;
+            }
+            // Dont re-request the same service details
+            if (service && previousService?.servicePath !== service.servicePath) {
+                previousService = service;
+                return (0, service_helper_1.getServiceDetails)(service, connectValidator);
+            }
+            return true;
+        }
+    };
+    const questions = [newSystemServiceQuestion];
+    // Only for CLI use as `list` prompt validation does not run on CLI
+    if ((0, utils_1.getHostEnvironment)() === types_1.hostEnvironment.cli) {
+        questions.push({
+            when: async (answers) => {
+                const selectedService = answers?.[`${promptNamespace}:${types_1.promptNames.serviceSelection}`];
+                if (selectedService && connectValidator.validatedUrl) {
+                    const result = await (0, service_helper_1.getServiceDetails)(selectedService, connectValidator);
+                    if (typeof result === 'string') {
+                        logger_helper_1.default.logger.error(result);
+                        throw new Error(result);
+                    }
+                }
+                return false;
+            },
+            name: `${promptNamespace}:${cliServicePromptName}`
+        });
+    }
+    return questions;
+}
+exports.getSystemServiceQuestion = getSystemServiceQuestion;
+/**
+ * Get the service selection prompt additional message. This prompt will make an additional call to the system backend
+ * to retrieve the service type and display a warning message if the service type is not UI.
+ *
+ * @param serviceChoices a list of service choices
+ * @param selectedService the selected service
+ * @param connectValidator the connection validator
+ * @param requiredOdataVersion the required OData version for the service
+ * @returns the service selection prompt additional message
+ */
+async function getSelectedServiceMessage(serviceChoices, selectedService, connectValidator, requiredOdataVersion) {
+    if (serviceChoices?.length === 0) {
+        if (requiredOdataVersion) {
+            return {
+                message: (0, i18n_1.t)('prompts.warnings.noServicesAvailableForOdataVersion', {
+                    odataVersion: requiredOdataVersion
+                }),
+                severity: yeoman_ui_types_1.Severity.warning
+            };
+        }
+        else {
+            return {
+                message: (0, i18n_1.t)('prompts.warnings.noServicesAvailable'),
+                severity: yeoman_ui_types_1.Severity.warning
+            };
+        }
+    }
+    if (selectedService) {
+        let serviceType = selectedService.serviceType;
+        if (selectedService.serviceODataVersion === axios_extension_1.ODataVersion.v2) {
+            serviceType = await (0, service_helper_1.getServiceType)(selectedService.servicePath, selectedService.serviceType, connectValidator.catalogs[axios_extension_1.ODataVersion.v2]);
+        }
+        if (serviceType && serviceType !== axios_extension_1.ServiceType.UI) {
+            return {
+                message: (0, i18n_1.t)('prompts.warnings.nonUIServiceTypeWarningMessage', { serviceType: 'A2X' }),
+                severity: yeoman_ui_types_1.Severity.warning
+            };
+        }
+    }
+}
 //# sourceMappingURL=questions.js.map

package/dist/prompts/datasources/sap-system/{abap-on-prem → new-system}/service-helper.d.ts

@@ -1,6 +1,7 @@
 import { ServiceType, type Annotations, type CatalogService, type V2CatalogService, type ServiceProvider } from '@sap-ux/axios-extension';
 import type { ListChoiceOptions } from 'inquirer';
-import type { ServiceAnswer } from './questions';
+import type { ServiceAnswer } from './types';
+import type { ConnectionValidator } from '../../../connectionValidator';
 /**
  * Get the service choices from the specified catalogs.
  *
@@ -30,4 +31,13 @@ export declare function getServiceMetadata(servicePath: string, catalog: Catalog
  * @returns service type
  */
 export declare function getServiceType(servicePath: string, serviceType: string | undefined, catalog: V2CatalogService): Promise<ServiceType | undefined>;
+/**
+ * Requests and sets the service details to the PromptState.odataService properties.
+ * If an error occurs, the error message is returned for use in validators.
+ *
+ * @param service the specific service to get details for
+ * @param connectionValidator a reference to the connection validator which has an active connection to the backend
+ * @returns true if successful, setting the PromptState.odataService properties, or an error message indicating why the service details could not be retrieved.
+ */
+export declare function getServiceDetails(service: ServiceAnswer, connectionValidator: ConnectionValidator): Promise<string | boolean>;
 //# sourceMappingURL=service-helper.d.ts.map

package/dist/prompts/datasources/sap-system/{abap-on-prem → new-system}/service-helper.js

@@ -3,10 +3,12 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getServiceType = exports.getServiceMetadata = exports.getServiceChoices = void 0;
+exports.getServiceDetails = exports.getServiceType = exports.getServiceMetadata = exports.getServiceChoices = void 0;
 const axios_extension_1 = require("@sap-ux/axios-extension");
 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");
 // Service ids continaining these paths should not be offered as UI compatible services
 const nonUIServicePaths = ['/IWBEP/COMMON/'];
 /**
@@ -119,4 +121,31 @@ async function getServiceType(servicePath, serviceType, catalog) {
     return resolvedServiceType ?? serviceType;
 }
 exports.getServiceType = getServiceType;
+/**
+ * Requests and sets the service details to the PromptState.odataService properties.
+ * If an error occurs, the error message is returned for use in validators.
+ *
+ * @param service the specific service to get details for
+ * @param connectionValidator a reference to the connection validator which has an active connection to the backend
+ * @returns true if successful, setting the PromptState.odataService properties, or an error message indicating why the service details could not be retrieved.
+ */
+async function getServiceDetails(service, connectionValidator) {
+    const serviceCatalog = connectionValidator.catalogs[service.serviceODataVersion];
+    if (!serviceCatalog || !connectionValidator.serviceProvider) {
+        logger_helper_1.default.logger.error('ConenctionValidator is not initialized');
+        return false;
+    }
+    const serviceResult = await getServiceMetadata(service.servicePath, serviceCatalog, connectionValidator.serviceProvider);
+    if (typeof serviceResult === 'string') {
+        return serviceResult;
+    }
+    utils_1.PromptState.odataService.annotations = serviceResult?.annotations;
+    utils_1.PromptState.odataService.metadata = serviceResult?.metadata;
+    utils_1.PromptState.odataService.odataVersion =
+        service.serviceODataVersion === axios_extension_1.ODataVersion.v2 ? odata_service_writer_1.OdataVersion.v2 : odata_service_writer_1.OdataVersion.v4;
+    utils_1.PromptState.odataService.servicePath = service.servicePath;
+    utils_1.PromptState.odataService.origin = connectionValidator.validatedUrl;
+    return true;
+}
+exports.getServiceDetails = getServiceDetails;
 //# sourceMappingURL=service-helper.js.map

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

@@ -0,0 +1,16 @@
+import type { ODataVersion } from '@sap-ux/axios-extension';
+/**
+ * Sap System service answer
+ */
+export type ServiceAnswer = {
+    servicePath: string;
+    serviceODataVersion: ODataVersion;
+    toString: () => string;
+    serviceType?: string;
+};
+export declare const newSystemPromptNames: {
+    readonly newSystemType: "newSystemType";
+    readonly newSystemUrl: "newSystemUrl";
+    readonly newSystemAuthType: "newSystemAuthType";
+};
+//# sourceMappingURL=types.d.ts.map

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

@@ -0,0 +1,9 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.newSystemPromptNames = void 0;
+exports.newSystemPromptNames = {
+    newSystemType: 'newSystemType',
+    newSystemUrl: 'newSystemUrl',
+    newSystemAuthType: 'newSystemAuthType'
+};
+//# sourceMappingURL=types.js.map

package/dist/prompts/datasources/sap-system/prompt-helpers.d.ts

@@ -1,9 +1,9 @@
 /**
- * Provides a system name suggestion based on the system URL, system ID, and client, validating the name is unique against the secure store.
+ * Provides a system name suggestion based on the passed system name and client, validating the name is unique against the secure store.
  *
- * @param systemUrl the system URL origin
+ * @param systemName the system name to use as a base for the suggestion
  * @param client the sap client to use for the system
  * @returns a unique system name suggestion
  */
-export declare function suggestSystemName(systemUrl: string, client?: string): Promise<string>;
+export declare function suggestSystemName(systemName: string, client?: string): Promise<string>;
 //# sourceMappingURL=prompt-helpers.d.ts.map

package/dist/prompts/datasources/sap-system/prompt-helpers.js

@@ -4,14 +4,14 @@ exports.suggestSystemName = void 0;
 const i18n_1 = require("../../../i18n");
 const validators_1 = require("./validators");
 /**
- * Provides a system name suggestion based on the system URL, system ID, and client, validating the name is unique against the secure store.
+ * Provides a system name suggestion based on the passed system name and client, validating the name is unique against the secure store.
  *
- * @param systemUrl the system URL origin
+ * @param systemName the system name to use as a base for the suggestion
  * @param client the sap client to use for the system
  * @returns a unique system name suggestion
  */
-async function suggestSystemName(systemUrl, client) {
-    const initialSystemName = systemUrl + (client ? (0, i18n_1.t)('texts.suggestedSystemNameClient', { client }) : '');
+async function suggestSystemName(systemName, client) {
+    const initialSystemName = systemName + (client ? (0, i18n_1.t)('texts.suggestedSystemNameClient', { client }) : '');
     if ((await (0, validators_1.validateSystemName)(initialSystemName)) === true) {
         return initialSystemName;
     }

package/dist/prompts/datasources/sap-system/validators.d.ts

@@ -1,7 +1,16 @@
+import type { ServiceInfo } from '@sap-ux/btp-utils';
 /**
  * Validates that the system name does not exist yet.
  *
  * @param systemName a system name to validate
  * @returns true if the name is valid, otherwise an error message
- */ export declare function validateSystemName(systemName: string): Promise<boolean | string>;
+ */
+export declare function validateSystemName(systemName: string): Promise<boolean | string>;
+/**
+ * Validates the existence and content of the file at the given path and returns the service key info if valid.
+ *
+ * @param path path to a service key file
+ * @returns the service key info if the file is valid, otherwise an error message
+ */
+export declare function validateServiceKey(path: string): string | ServiceInfo | boolean;
 //# sourceMappingURL=validators.d.ts.map

package/dist/prompts/datasources/sap-system/validators.js

@@ -3,10 +3,11 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.validateSystemName = void 0;
+exports.validateServiceKey = exports.validateSystemName = void 0;
 const i18n_1 = require("../../../i18n");
 const store_1 = require("@sap-ux/store");
 const logger_helper_1 = __importDefault(require("../../logger-helper"));
+const fs_1 = require("fs");
 /**
  * Check if the system name is already in use.
  *
@@ -22,7 +23,8 @@ async function isSystemNameInUse(systemName) {
  *
  * @param systemName a system name to validate
  * @returns true if the name is valid, otherwise an error message
- */ async function validateSystemName(systemName) {
+ */
+async function validateSystemName(systemName) {
     if (!systemName) {
         return (0, i18n_1.t)('prompts.systemName.emptySystemNameWarning');
     }
@@ -35,4 +37,27 @@ async function isSystemNameInUse(systemName) {
     }
 }
 exports.validateSystemName = validateSystemName;
+/**
+ * Validates the existence and content of the file at the given path and returns the service key info if valid.
+ *
+ * @param path path to a service key file
+ * @returns the service key info if the file is valid, otherwise an error message
+ */
+function validateServiceKey(path) {
+    if (!path) {
+        return false;
+    }
+    try {
+        const serviceKeys = (0, fs_1.readFileSync)(path, 'utf8');
+        const serviceInfo = JSON.parse(serviceKeys);
+        if (!serviceInfo.url || !serviceInfo.uaa || !serviceInfo.catalogs) {
+            return (0, i18n_1.t)('prompts.serviceKey.incompleteServiceKeyInfo');
+        }
+        return serviceInfo;
+    }
+    catch (error) {
+        return error.name === 'SyntaxError' ? (0, i18n_1.t)('prompts.serviceKey.unparseableServiceKey') : error.message;
+    }
+}
+exports.validateServiceKey = validateServiceKey;
 //# sourceMappingURL=validators.js.map

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

@@ -36,8 +36,11 @@ function getServiceUrlPrompt(connectValidator, requiredVersion) {
                 return true;
             }
             if (urlValidationState === true) {
-                if (!connectValidator.validity.authRequired) {
-                    return (0, validators_1.validateService)(url, connectValidator, requiredVersion);
+                if (!connectValidator.validity.authRequired && connectValidator.odataService) {
+                    return (0, validators_1.validateService)(url, {
+                        odataService: connectValidator.odataService,
+                        abapServiceProvider: connectValidator.serviceProvider
+                    }, requiredVersion);
                 }
                 return true;
             }
@@ -76,8 +79,11 @@ function getIgnoreCertErrorsPrompt(connectValidator, requiredVersion) {
                 forceReValidation: true
             });
             if (validUrl === true) {
-                if (!connectValidator.validity.authRequired) {
-                    return (0, validators_1.validateService)(serviceUrl, connectValidator, requiredVersion, ignoreCertError);
+                if (!connectValidator.validity.authRequired && connectValidator.odataService) {
+                    return (0, validators_1.validateService)(serviceUrl, {
+                        odataService: connectValidator.odataService,
+                        abapServiceProvider: connectValidator.serviceProvider
+                    }, requiredVersion, ignoreCertError);
                 }
                 return true;
             }
@@ -113,9 +119,12 @@ function getCliIgnoreCertValidatePrompt(connectValidator, requiredVersion) {
                 if (validUrl !== true) {
                     throw new Error(validUrl.toString()); // exit
                 }
-                if (!connectValidator.validity.authRequired) {
+                if (!connectValidator.validity.authRequired && connectValidator.odataService) {
                     // Will log on CLI
-                    const validService = await (0, validators_1.validateService)(serviceUrl, connectValidator, requiredVersion, true);
+                    const validService = await (0, validators_1.validateService)(serviceUrl, {
+                        odataService: connectValidator.odataService,
+                        abapServiceProvider: connectValidator.serviceProvider
+                    }, requiredVersion, true);
                     if (validService !== true) {
                         throw new Error((0, i18n_1.t)('errors.exitingGeneration', { exitReason: validService.toString() }));
                     }
@@ -171,8 +180,11 @@ function getPasswordPrompt(connectValidator, requiredVersion) {
                 ignoreCertError,
                 sapClient
             });
-            if (validAuth === true) {
-                return (0, validators_1.validateService)(serviceUrl, connectValidator, requiredVersion, ignoreCertError);
+            if (validAuth === true && connectValidator.odataService) {
+                return (0, validators_1.validateService)(serviceUrl, {
+                    odataService: connectValidator.odataService,
+                    abapServiceProvider: connectValidator.serviceProvider
+                }, requiredVersion, ignoreCertError);
             }
             return validAuth;
         }

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

@@ -1,4 +1,4 @@
-import { type AxiosRequestConfig, type ODataService } from '@sap-ux/axios-extension';
+import type { AbapServiceProvider, 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.axiosConfig the axios config to use for the annotations request (as used by ConnectionValidator)
+ * @param connectionConfig.abapServiceProvider the abap service provider instance used to retrieve annotations (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 }: {
+export declare function validateService(url: string, { odataService, abapServiceProvider }: {
     odataService: ODataService;
-    axiosConfig: AxiosRequestConfig;
+    abapServiceProvider: AbapServiceProvider;
 }, requiredVersion?: OdataVersion | undefined, ignoreCertError?: boolean): Promise<boolean | string>;
 //# sourceMappingURL=validators.d.ts.map