@sap-ux/odata-service-inquirer 2.1.3 → 2.2.0

package/dist/prompts/connectionValidator.d.ts

@@ -1,8 +1,8 @@
-import type { IValidationLink } from '@sap-devx/yeoman-ui-types';
 import type { AxiosRequestConfig, CatalogService, ODataService, ServiceInfo, ServiceProvider } from '@sap-ux/axios-extension';
 import { ODataVersion } from '@sap-ux/axios-extension';
 import { type Destination } from '@sap-ux/btp-utils';
 import { ERROR_TYPE } from '@sap-ux/inquirer-common';
+import type { ValidationResult } from './types';
 /**
  * Structure to store validity information about url to be validated.
  */
@@ -13,7 +13,6 @@ interface Validity {
     authenticated?: boolean;
     canSkipCertError?: boolean;
 }
-export type ValidationResult = string | boolean | IValidationLink;
 export type SystemAuthType = 'serviceKey' | 'reentranceTicket' | 'basic' | 'unknown';
 /**
  * Class that can be used to determine the connectivity using a service url, system url, or service info (UAA Key details) or reentrance ticket.

package/dist/prompts/connectionValidator.js

@@ -6,8 +6,8 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.ConnectionValidator = void 0;
 const axios_extension_1 = require("@sap-ux/axios-extension");
 const btp_utils_1 = require("@sap-ux/btp-utils");
-const https_1 = __importDefault(require("https"));
 const inquirer_common_1 = require("@sap-ux/inquirer-common");
+const https_1 = __importDefault(require("https"));
 const i18n_1 = require("../i18n");
 const types_1 = require("../types");
 const logger_helper_1 = __importDefault(require("./logger-helper"));

package/dist/prompts/datasources/sap-system/abap-on-btp/questions.d.ts

@@ -1,3 +1,4 @@
+import type { OdataVersion } from '@sap-ux/odata-service-writer';
 import { type ServiceInstanceInfo } from '@sap/cf-tools';
 import type { Question } from 'inquirer';
 import { type OdataServiceAnswers, type OdataServicePromptOptions } from '../../../../types';
@@ -17,7 +18,7 @@ interface AbapOnBtpAnswers extends Partial<OdataServiceAnswers> {
     [abapOnBtpPromptNames.cloudFoundryAbapSystem]?: ServiceInstanceInfo;
 }
 /**
- * Get the questions for the ABAP on BTP system. The questions will prompt the user for the system type (Cloud Foundry, Service Key, Re-entrance Ticket).
+ * Get the questions for the ABAP on BTP system within the VSCode platform. The questions will prompt the user for the system type (Cloud Foundry, Service Key, Re-entrance Ticket).
  *
  * @param promptOptions The prompt options which control the service selection and system name]
  * @returns The list of questions for the ABAP on BTP system
@@ -28,8 +29,10 @@ export declare function getAbapOnBTPSystemQuestions(promptOptions?: OdataService
  * If the Cloud Foundry connection fails, a warning message will be displayed.
  *
  * @param connectionValidator The connection validator
+ * @param promptNamespace
+ * @param requiredOdataVersion
  * @returns The Cloud Foundry ABAP system discovery prompt
  */
-export declare function getCFDiscoverPrompts(connectionValidator: ConnectionValidator): Question[];
+export declare function getCFDiscoverPrompts(connectionValidator: ConnectionValidator, promptNamespace?: string, requiredOdataVersion?: OdataVersion): Question[];
 export {};
 //# sourceMappingURL=questions.d.ts.map

package/dist/prompts/datasources/sap-system/abap-on-btp/questions.js

@@ -5,6 +5,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.getAbapOnBTPSystemQuestions = getAbapOnBTPSystemQuestions;
 exports.getCFDiscoverPrompts = getCFDiscoverPrompts;
+const btp_utils_1 = require("@sap-ux/btp-utils");
 const fiori_generator_shared_1 = require("@sap-ux/fiori-generator-shared");
 const inquirer_common_1 = require("@sap-ux/inquirer-common");
 const cf_tools_1 = require("@sap/cf-tools");
@@ -16,6 +17,7 @@ const prompt_helpers_1 = require("../../../prompt-helpers");
 const questions_1 = require("../new-system/questions");
 const types_1 = require("../new-system/types");
 const service_selection_1 = require("../service-selection");
+const prompt_helpers_2 = require("../system-selection/prompt-helpers");
 const validators_1 = require("../validators");
 const abapOnBtpPromptNamespace = 'abapOnBtp';
 const systemUrlPromptName = `${abapOnBtpPromptNamespace}:${types_1.newSystemPromptNames.newSystemUrl}`;
@@ -26,7 +28,7 @@ const abapOnBtpPromptNames = {
     'cloudFoundryAbapSystem': 'cloudFoundryAbapSystem'
 };
 /**
- * Get the questions for the ABAP on BTP system. The questions will prompt the user for the system type (Cloud Foundry, Service Key, Re-entrance Ticket).
+ * Get the questions for the ABAP on BTP system within the VSCode platform. The questions will prompt the user for the system type (Cloud Foundry, Service Key, Re-entrance Ticket).
  *
  * @param promptOptions The prompt options which control the service selection and system name]
  * @returns The list of questions for the ABAP on BTP system
@@ -75,17 +77,33 @@ function getAbapOnBTPSystemQuestions(promptOptions) {
     return questions;
 }
 /**
- * Validate the service info for the ABAP on BTP system. This function will validate the service key file and the connection to the ABAP system.
- * Updates the prompt state with the connected system.
+ * Validate the service info (returned from cf-tools APIs) for an ABAP on BTP system. This function will validate the service key file, or on BAS will create a new destination,
+ * and validate the connection to the ABAP system. Updates the prompt state with the connected system to be later used for catalog service selection.
  *
- * @param abapService the abap service as provided by CF tools
+ * @param abapService the abap service as provided by CF tools {@link ServiceInstanceInfo}
  * @param connectionValidator connection validator instance
+ * @param requiredOdataVersion
  * @param isCli validation on CLI ill throw rather than returning a validation message as users cannot change previous answers on CLI
  * @returns true if the service info is valid, a validation message if the service info is invalid, or a validation link if the service info is not validated but some help is available
  */
-async function validateServiceInfo(abapService, connectionValidator, isCli = false) {
-    const uaaCreds = await (0, cf_tools_1.apiGetInstanceCredentials)(abapService.label);
-    const valResult = await connectionValidator.validateServiceInfo(uaaCreds.credentials);
+async function validateCFServiceInfo(abapService, connectionValidator, requiredOdataVersion, isCli = false) {
+    const cfAbapServiceName = abapService.label;
+    const uaaCreds = await (0, cf_tools_1.apiGetInstanceCredentials)(cfAbapServiceName); // should be abapService.serviceName in BAS?
+    if (!uaaCreds?.credentials?.uaa) {
+        return (0, i18n_1.t)('errors.cfInstanceCredentialsNotReturned', { serviceInstanceName: cfAbapServiceName });
+    }
+    let valResult = true;
+    let destination;
+    if ((0, utils_1.getPromptHostEnvironment)() === fiori_generator_shared_1.hostEnvironment.bas) {
+        destination = await (0, btp_utils_1.createOAuth2UserTokenExchangeDest)(cfAbapServiceName, {
+            uaaCredentials: uaaCreds.credentials.uaa,
+            hostUrl: uaaCreds.credentials.url
+        }, logger_helper_1.default.logger);
+        valResult = await (0, prompt_helpers_2.connectWithDestination)(destination, connectionValidator, requiredOdataVersion);
+    }
+    else {
+        valResult = await connectionValidator.validateServiceInfo(uaaCreds.credentials);
+    }
     if (!isCli && valResult !== true) {
         return valResult;
     }
@@ -101,15 +119,9 @@ async function validateServiceInfo(abapService, connectionValidator, isCli = fal
         throw new Error((0, i18n_1.t)('errors.abapServiceAuthenticationFailed'));
     }
     // CLI only ^^^
-    if (connectionValidator.serviceProvider) {
-        // Create a unique connected system name based on the selected ABAP service
-        const cfTarget = await (0, cf_tools_1.cfGetTarget)(true);
-        connectionValidator.connectedSystemName = `abap-cloud-${abapService.label}-${cfTarget.org}-${cfTarget.space}`
-            .replace(/[^\w]/gi, '-')
-            .toLowerCase();
-        utils_1.PromptState.odataService.connectedSystem = {
-            serviceProvider: connectionValidator.serviceProvider
-        };
+    if (connectionValidator.serviceProvider && (0, utils_1.getPromptHostEnvironment)() !== fiori_generator_shared_1.hostEnvironment.bas) {
+        // Connected system name is only used for VSCode as a default stored system name
+        connectionValidator.connectedSystemName = await (0, btp_utils_1.generateABAPCloudDestinationName)(cfAbapServiceName);
     }
     return true;
 }
@@ -118,14 +130,17 @@ async function validateServiceInfo(abapService, connectionValidator, isCli = fal
  * If the Cloud Foundry connection fails, a warning message will be displayed.
  *
  * @param connectionValidator The connection validator
+ * @param promptNamespace
+ * @param requiredOdataVersion
  * @returns The Cloud Foundry ABAP system discovery prompt
  */
-function getCFDiscoverPrompts(connectionValidator) {
+function getCFDiscoverPrompts(connectionValidator, promptNamespace, requiredOdataVersion) {
     let choices = [];
+    const promptName = `${promptNamespace ? promptNamespace + ':' : ''}${abapOnBtpPromptNames.cloudFoundryAbapSystem}`;
     const questions = [
         {
             type: 'list',
-            name: abapOnBtpPromptNames.cloudFoundryAbapSystem,
+            name: promptName,
             guiOptions: {
                 breadcrumb: true,
                 applyDefaultWhenDirty: true
@@ -144,7 +159,7 @@ function getCFDiscoverPrompts(connectionValidator) {
             message: (0, i18n_1.t)('prompts.cloudFoundryAbapSystem.message'),
             validate: async (abapService) => {
                 if (abapService) {
-                    return await validateServiceInfo(abapService, connectionValidator);
+                    return await validateCFServiceInfo(abapService, connectionValidator, requiredOdataVersion, (0, utils_1.getPromptHostEnvironment)() === fiori_generator_shared_1.hostEnvironment.cli);
                 }
                 const errorType = prompt_helpers_1.errorHandler.getCurrentErrorType();
                 if (errorType === inquirer_common_1.ERROR_TYPE.NO_ABAP_ENVS) {
@@ -162,7 +177,7 @@ function getCFDiscoverPrompts(connectionValidator) {
             when: async (answers) => {
                 const abapService = answers?.[abapOnBtpPromptNames.cloudFoundryAbapSystem];
                 if (abapService) {
-                    await validateServiceInfo(abapService, connectionValidator, true);
+                    await validateCFServiceInfo(abapService, connectionValidator, requiredOdataVersion, true);
                 }
                 return false;
             },

package/dist/prompts/datasources/sap-system/cf-abap/questions.d.ts

@@ -0,0 +1,13 @@
+import type { Question } from 'inquirer';
+import type { ServiceSelectionPromptOptions } from '../../../../types';
+import type { ServiceAnswer } from '../service-selection/types';
+/**
+ * Cloud Foundry ABAP system prompts specifically for BAS environment since it requires additional destination configuration.
+ * These will call out to cf tools to discover the available abap systems and services, and create a new destination if necessary,
+ * to allow apps to access these cf hosted services.
+ *
+ * @param promptOptions prompt options to control some prompt behavior see {@link ServiceSelectionPromptOptions}
+ * @returns the prompt questions
+ */
+export declare function getCfAbapBASQuestions(promptOptions?: ServiceSelectionPromptOptions): Question<ServiceAnswer>[];
+//# sourceMappingURL=questions.d.ts.map

package/dist/prompts/datasources/sap-system/cf-abap/questions.js

@@ -0,0 +1,24 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getCfAbapBASQuestions = getCfAbapBASQuestions;
+const connectionValidator_1 = require("../../../connectionValidator");
+const questions_1 = require("../abap-on-btp/questions");
+const questions_2 = require("../service-selection/questions");
+/**
+ * Cloud Foundry ABAP system prompts specifically for BAS environment since it requires additional destination configuration.
+ * These will call out to cf tools to discover the available abap systems and services, and create a new destination if necessary,
+ * to allow apps to access these cf hosted services.
+ *
+ * @param promptOptions prompt options to control some prompt behavior see {@link ServiceSelectionPromptOptions}
+ * @returns the prompt questions
+ */
+function getCfAbapBASQuestions(promptOptions) {
+    // Using a prompt namespace allows re-use of system service (catalog based) selection prompt
+    const cfAbapBasPromptNamespace = 'cfAbapBas';
+    const connectionValidator = new connectionValidator_1.ConnectionValidator();
+    return [
+        ...(0, questions_1.getCFDiscoverPrompts)(connectionValidator, cfAbapBasPromptNamespace, promptOptions?.requiredOdataVersion),
+        ...(0, questions_2.getSystemServiceQuestion)(connectionValidator, cfAbapBasPromptNamespace, promptOptions)
+    ];
+}
+//# sourceMappingURL=questions.js.map

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

@@ -3,8 +3,9 @@ import type { OdataVersion } from '@sap-ux/odata-service-writer';
 import type { BackendSystem } from '@sap-ux/store';
 import type { ListChoiceOptions } from 'inquirer';
 import { type DestinationFilters } from '../../../../types';
-import type { ConnectionValidator, ValidationResult } from '../../../connectionValidator';
+import type { ConnectionValidator } from '../../../connectionValidator';
 import { type SystemSelectionAnswerType } from './questions';
+import type { ValidationResult } from '../../../types';
 export declare const NewSystemChoice = "!@\u00A3*&937newSystem*X~qy^";
 export type NewSystemChoice = typeof NewSystemChoice;
 export declare const CfAbapEnvServiceChoice = "cfAbapEnvService";

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

@@ -17,6 +17,7 @@ const logger_helper_1 = __importDefault(require("../../../logger-helper"));
 const questions_1 = require("../credentials/questions");
 const questions_2 = require("../new-system/questions");
 const questions_3 = require("../service-selection/questions");
+const questions_4 = require("../cf-abap/questions");
 const validators_1 = require("../validators");
 const prompt_helpers_1 = require("./prompt-helpers");
 const systemSelectionPromptNamespace = 'systemSelection';
@@ -75,6 +76,9 @@ async function getSystemSelectionQuestions(promptOptions) {
     if (!(0, btp_utils_1.isAppStudio)()) {
         questions.push(...(0, inquirer_common_1.withCondition)((0, questions_2.getNewSystemQuestions)(promptOptions), (answers) => answers.systemSelection?.type === 'newSystemChoice'));
     }
+    else {
+        questions.push(...(0, inquirer_common_1.withCondition)((0, questions_4.getCfAbapBASQuestions)(promptOptions?.serviceSelection), (answers) => answers.systemSelection?.type === 'cfAbapEnvService'));
+    }
     return questions;
 }
 /**

package/dist/prompts/types.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Internal types for prompts
+ */
+import type { IValidationLink } from '@sap-devx/yeoman-ui-types';
+/**
+ * Result of running a prompt `validate` function, including a string message, a boolean, or a validation link for Guided Answer help link support.
+ */
+export type ValidationResult = string | boolean | IValidationLink;
+//# sourceMappingURL=types.d.ts.map

package/dist/prompts/types.js

@@ -0,0 +1,6 @@
+"use strict";
+/**
+ * Internal types for prompts
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=types.js.map

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

@@ -223,7 +223,8 @@
         "unparseableMetadata": "Unable to parse entities from metadata document. {{-error}}",
         "unparseableOdataVersion": "Unable to parse the odata version from the metadata.",
         "unparseableXML": "Unparseable XML was specified: {{-error}}",
-        "noRelevantEntities": "The template and service selected have no relevant entities that you can use."
+        "noRelevantEntities": "The template and service selected have no relevant entities that you can use.",
+        "cfInstanceCredentialsNotReturned": "Could not retrieve credentials to access: {{serviceInstanceName}}"
     },
     "warnings": {
         "largeMetadataDocument": "The metadata for this OData service is significantly large. It may take some time before this operation completes."

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": "2.1.3",
+  "version": "2.2.0",
   "repository": {
     "type": "git",
     "url": "https://github.com/SAP/open-ux-tools.git",
@@ -28,12 +28,12 @@
     "i18next": "23.5.1",
     "inquirer-autocomplete-prompt": "2.0.1",
     "os-name": "4.0.1",
-    "@sap-ux/axios-extension": "1.18.4",
-    "@sap-ux/btp-utils": "1.0.0",
-    "@sap-ux/fiori-generator-shared": "0.7.25",
+    "@sap-ux/axios-extension": "1.18.5",
+    "@sap-ux/btp-utils": "1.0.1",
+    "@sap-ux/fiori-generator-shared": "0.7.26",
     "@sap-ux/guided-answers-helper": "0.2.1",
-    "@sap-ux/telemetry": "0.5.57",
-    "@sap-ux/inquirer-common": "0.6.12",
+    "@sap-ux/telemetry": "0.5.58",
+    "@sap-ux/inquirer-common": "0.6.13",
     "@sap-ux/logger": "0.6.0",
     "@sap-ux/project-access": "1.29.4",
     "@sap-ux/project-input-validator": "0.3.4",
@@ -46,12 +46,12 @@
     "@types/inquirer": "8.2.6",
     "@types/lodash": "4.14.202",
     "jest-extended": "3.2.4",
-    "@sap-ux/fiori-generator-shared": "0.7.25",
-    "@sap-ux/fiori-elements-writer": "2.1.0",
-    "@sap-ux/fiori-freestyle-writer": "2.0.8",
+    "@sap-ux/fiori-generator-shared": "0.7.26",
+    "@sap-ux/fiori-elements-writer": "2.1.2",
+    "@sap-ux/fiori-freestyle-writer": "2.0.10",
     "@sap-ux/feature-toggle": "0.2.3",
-    "@sap-ux/odata-service-writer": "0.25.5",
-    "@sap-ux/cap-config-writer": "0.9.4"
+    "@sap-ux/odata-service-writer": "0.25.6",
+    "@sap-ux/cap-config-writer": "0.9.5"
   },
   "engines": {
     "node": ">=18.x"