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

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

@@ -4,14 +4,13 @@ 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");
 const utils_1 = require("../../../utils");
+const connectionValidator_1 = require("../../connectionValidator");
 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 service url is accessible, has the required version and returns valid metadata.
  * Retrieves annotations (from Abap backends) if available and stores them in the PromptState.
@@ -19,12 +18,12 @@ const connectionValidator_1 = require("../../connectionValidator");
  * @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
  */
-async function validateService(url, { odataService, axiosConfig }, requiredVersion = undefined, ignoreCertError = false) {
+async function validateService(url, { odataService, abapServiceProvider }, requiredVersion = undefined, ignoreCertError = false) {
     try {
         if (ignoreCertError === true) {
             connectionValidator_1.ConnectionValidator.setGlobalRejectUnauthorized(!ignoreCertError);
@@ -50,8 +49,7 @@ async function validateService(url, { odataService, axiosConfig }, requiredVersi
         // 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);
+            const catalogService = abapServiceProvider.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/prompts/prompts.js

@@ -10,9 +10,8 @@ const i18n_1 = require("../i18n");
 const types_1 = require("../types");
 const questions_1 = require("./datasources/cap-project/questions");
 const metadata_file_1 = require("./datasources/metadata-file");
-const questions_2 = require("./datasources/sap-system/abap-on-prem/questions");
-const questions_3 = require("./datasources/sap-system/new-system/questions");
-const questions_4 = require("./datasources/service-url/questions");
+const questions_2 = require("./datasources/sap-system/new-system/questions");
+const questions_3 = require("./datasources/service-url/questions");
 const logger_helper_1 = __importDefault(require("./logger-helper"));
 const prompt_helpers_1 = require("./prompt-helpers");
 /**
@@ -61,7 +60,7 @@ function getDatasourceTypeQuestion(options) {
             if (source === types_1.DatasourceType.businessHub) {
                 return {
                     message: (0, i18n_1.t)('prompts.nonUIServiceTypeWarningMessage', {
-                        serviceTypeDesc: (0, i18n_1.t)('prompts.datasourceType.businessHubName')
+                        serviceType: (0, i18n_1.t)('prompts.datasourceType.businessHubName')
                     }),
                     severity: yeoman_ui_types_1.Severity.warning
                 };
@@ -79,11 +78,9 @@ async function getDatasourceTypeConditionalQuestions(promptOptions) {
     const conditionalQuestions = [];
     conditionalQuestions.push(...(0, inquirer_common_1.withCondition)([(0, metadata_file_1.getMetadataFileQuestion)(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_4.getServiceUrlQuestions)(promptOptions), (answers) => answers.datasourceType === types_1.DatasourceType.odataServiceUrl));
-    // Temp integration into Service Inquirer new system questions
-    conditionalQuestions.push(...(0, inquirer_common_1.withCondition)((0, questions_2.getAbapOnPremQuestions)(promptOptions), (answers) => answers.datasourceType === types_1.DatasourceType.sapSystem &&
-        answers.system === questions_3.newSystemChoiceValue &&
-        answers.newSystemType === 'abapOnPrem'));
+    conditionalQuestions.push(...(0, inquirer_common_1.withCondition)((0, questions_3.getServiceUrlQuestions)(promptOptions), (answers) => answers.datasourceType === types_1.DatasourceType.odataServiceUrl));
+    conditionalQuestions.push(...(0, inquirer_common_1.withCondition)((0, questions_2.getNewSystemQuestions)(promptOptions), (answers) => answers.datasourceType === types_1.DatasourceType.sapSystem &&
+        answers.system === questions_2.newSystemChoiceValue));
     //...further data sources to be added here
     return conditionalQuestions;
 }

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

@@ -85,7 +85,7 @@
             "breadcrumb": "Service",
             "noServicesWarning": "No services available for the selected system, see logs for further details."
         },
-        "systemType": {
+        "newSystemType": {
             "choiceAbapOnPrem": "ABAP On Premise",
             "choiceAbapOnBtp": "ABAP Environment on SAP Business Technology Platform",
             "message": "System type",
@@ -100,6 +100,22 @@
         },
         "systemSelection": {
             "newSystemChoiceLabel": "New system"
+        },
+        "abapOnBTPType": {
+            "message": "ABAP environment definition source",
+            "choiceReentranceTicket": "Use Reentrance Ticket",
+            "choiceServiceKey": "Upload a Service Key File",
+            "choiceCloudFoundry": "Discover a Cloud Foundry Service"
+        },
+        "serviceKey": {
+            "message": "Service key file path",
+            "hint": "Select a local file that defines the service connection for an ABAP Environment on SAP Business Technology Platform",
+            "incompleteServiceKeyInfo": "Service keys file does not contain the required information",
+            "unparseableServiceKey": "Service keys file contents are not a valid JSON format"
+        },
+        "cloudFoundryAbapSystem": {
+            "message": "ABAP environment",
+            "hint": "Enter the name of the Cloud Foundry service that contains the ABAP Environment instance"
         }
     },
     "errors": {
@@ -129,14 +145,17 @@
         "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",
-        "systemOrserviceUrlNotFound": "Please verify the url: {{- url}}, target system configuration and network connectivity",
+        "systemOrServiceUrlNotFound": "Please verify the 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}}",
         "serviceMetadataError": "An error occurred reading service metadata for service: {{- servicePath}}",
         "serviceMetadataErrorUI": "$t(errors.serviceMetadataError, {\"servicePath\": \"{{- servicePath}}\" }). $t(texts.seeLogForDetails)",
         "serviceMetadataErrorLog": "$t(errors.serviceMetadataError, {\"servicePath\": \"{{- servicePath}}\" }). {{error}}",
-        "serviceTypeRequestError": "Error retrieving service type: {{- error}}"
+        "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."
     },
     "texts": {
         "anExpiredCert": "an expired",
@@ -144,7 +163,8 @@
         "anUnknownOrInvalidCert": "an unknown or invalid",
         "anUntrustedRootCert": "an untrusted root",
         "suggestedSystemNameClient": ", client {{client}}",
-        "seeLogForDetails": "See log for more details."
+        "seeLogForDetails": "See log for more details.",
+        "forUserName": "(for user [{{username}}])"
     },
     "guidedAnswers": {
         "validationErrorHelpText": "Need help with this error?"

package/dist/types.d.ts

@@ -4,7 +4,7 @@ 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';
-import type { BackendSystem } from '../../store/src';
+import type { BackendSystem } from '@sap-ux/store';
 /**
  * This file contains types that are exported by the module and are needed for consumers using the APIs `prompt` and `getPrompts`.
  */
@@ -17,7 +17,11 @@ export declare enum DatasourceType {
     metadataFile = "metadataFile",
     projectSpecificDestination = "projectSpecificDestination"
 }
-export type SapSystemType = 'abapOnPrem' | 'abapOnBtp';
+export declare const SapSystemTypes: {
+    readonly abapOnPrem: "abapOnPrem";
+    readonly abapOnBtp: "abapOnBtp";
+};
+export type SapSystemType = keyof typeof SapSystemTypes;
 /**
  * Answers returned by the OdataServiceInquirer prompt API.
  * These values may be used to write an OData service and may be derived from the user's input rather than direct answers.
@@ -175,6 +179,12 @@ export type DatasourceTypePromptOptions = {
      * Include the `projectSpecificDestination` option in the datasource type prompt
      */
     includeProjectSpecificDest?: boolean;
+    /**
+     * Limit the offered datasource types to the specified types. Note that if `default` is also provided and not included in the choices, the default will be ignored.
+     * If `includeNone` is set to true, the `none` option will always be included.
+     *
+     */
+    choices?: DatasourceType[];
 };
 export type MetadataPromptOptions = {
     /**
@@ -198,7 +208,7 @@ export type SystemNamePromptOptions = {
      * This option allows the prompt to be excluded where later storage of the system with the provided name is not required.
      * If this propmt is not included then a BackendSystem will not be returned for the connected system.
      */
-    exclude?: boolean;
+    hide?: boolean;
 };
 export type OdataServiceUrlPromptOptions = {
     /**

package/dist/types.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.SAP_CLIENT_KEY = exports.hostEnvironment = exports.ValidationLink = exports.promptNames = exports.DatasourceType = void 0;
+exports.SAP_CLIENT_KEY = exports.hostEnvironment = exports.ValidationLink = exports.promptNames = exports.SapSystemTypes = exports.DatasourceType = void 0;
 /**
  * This file contains types that are exported by the module and are needed for consumers using the APIs `prompt` and `getPrompts`.
  */
@@ -14,6 +14,10 @@ var DatasourceType;
     DatasourceType["metadataFile"] = "metadataFile";
     DatasourceType["projectSpecificDestination"] = "projectSpecificDestination";
 })(DatasourceType || (exports.DatasourceType = DatasourceType = {}));
+exports.SapSystemTypes = {
+    abapOnPrem: 'abapOnPrem',
+    abapOnBtp: 'abapOnBtp'
+};
 /**
  * Enumeration of prompt names used by OdataServiceInquirerPromptOptions
  */

package/dist/utils/index.d.ts

@@ -1,6 +1,8 @@
 import type { TelemetryProperties, ToolsSuiteTelemetryClient } from '@sap-ux/telemetry';
 import { PromptState } from './prompt-state';
 import { OdataVersion } from '@sap-ux/odata-service-writer';
+import { ODataVersion } from '@sap-ux/axios-extension';
+import type { ListChoiceOptions } from 'inquirer';
 /**
  * Determine if the current prompting environment is cli or a hosted extension (app studio or vscode).
  *
@@ -39,5 +41,20 @@ export declare function parseOdataVersion(metadata: string): OdataVersion;
  * @returns the metadata string with URIs replaced with relative paths
  */
 export declare function originToRelative(metadata: string): string;
+/**
+ * Convert the odata version type from the prompt (odata-service-writer) type to the axios-extension type.
+ *
+ * @param odataVersion The odata version to convert
+ * @returns The converted odata version
+ */
+export declare function convertODataVersionType(odataVersion?: OdataVersion): ODataVersion | undefined;
+/**
+ * Gets the default index for a list of items, used to default list prompts to the first item if only one item is available.
+ * If list is undefined or has more than one, returns undefined which will default to the 'please select' message.
+ *
+ * @param list the list of choices
+ * @returns the default index if only one item is available, otherwise undefined
+ */
+export declare function getDefaultChoiceIndex(list: ListChoiceOptions[]): number | undefined;
 export { PromptState };
 //# sourceMappingURL=index.d.ts.map

package/dist/utils/index.js

@@ -3,7 +3,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.PromptState = exports.originToRelative = exports.parseOdataVersion = exports.sendTelemetryEvent = exports.setTelemetryClient = exports.getHostEnvironment = void 0;
+exports.PromptState = exports.getDefaultChoiceIndex = exports.convertODataVersionType = exports.originToRelative = exports.parseOdataVersion = exports.sendTelemetryEvent = exports.setTelemetryClient = exports.getHostEnvironment = void 0;
 const btp_utils_1 = require("@sap-ux/btp-utils");
 const telemetry_1 = require("@sap-ux/telemetry");
 const os_name_1 = __importDefault(require("os-name"));
@@ -14,6 +14,7 @@ const fast_xml_parser_1 = require("fast-xml-parser");
 const odata_service_writer_1 = require("@sap-ux/odata-service-writer");
 const logger_helper_1 = __importDefault(require("../prompts/logger-helper"));
 const i18n_1 = require("../i18n");
+const axios_extension_1 = require("@sap-ux/axios-extension");
 const osVersionName = (0, os_name_1.default)();
 /**
  * Determine if the current prompting environment is cli or a hosted extension (app studio or vscode).
@@ -117,4 +118,31 @@ function originToRelative(metadata) {
     (match, ...patterns) => `${patterns[0]}./${patterns[4]}`);
 }
 exports.originToRelative = originToRelative;
+/**
+ * Convert the odata version type from the prompt (odata-service-writer) type to the axios-extension type.
+ *
+ * @param odataVersion The odata version to convert
+ * @returns The converted odata version
+ */
+function convertODataVersionType(odataVersion) {
+    if (!odataVersion) {
+        return undefined;
+    }
+    return odataVersion === odata_service_writer_1.OdataVersion.v2 ? axios_extension_1.ODataVersion.v2 : axios_extension_1.ODataVersion.v4;
+}
+exports.convertODataVersionType = convertODataVersionType;
+/**
+ * Gets the default index for a list of items, used to default list prompts to the first item if only one item is available.
+ * If list is undefined or has more than one, returns undefined which will default to the 'please select' message.
+ *
+ * @param list the list of choices
+ * @returns the default index if only one item is available, otherwise undefined
+ */
+function getDefaultChoiceIndex(list) {
+    if (list?.length === 1) {
+        return 0;
+    }
+    return undefined;
+}
+exports.getDefaultChoiceIndex = getDefaultChoiceIndex;
 //# sourceMappingURL=index.js.map

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.28",
+  "version": "0.5.29",
   "repository": {
     "type": "git",
     "url": "https://github.com/SAP/open-ux-tools.git",
@@ -19,6 +19,7 @@
     "!dist/**/*.map"
   ],
   "dependencies": {
+    "@sap/cf-tools": "3.2.0",
     "axios": "1.7.4",
     "axios-logger": "2.8.0",
     "fast-xml-parser": "4.4.1",