@sap-ux/odata-service-inquirer 2.7.3 → 2.8.0

package/dist/index.d.ts

@@ -18,7 +18,7 @@ import { type EntityPromptOptions, type OdataServiceAnswers, type OdataServicePr
  * @param enableGuidedAnswers - if true, the prompts will use guided answers to help users with validation errors
  * @param telemetryClient - the telemetry client to use for sending telemetry data
  * @param isYUI - if true, the prompt is being called from the Yeoman UI extension host
- * @param connectedSystem - if available passing an already connected system connection will prevent re-authentication for re-entrance ticket connection types
+ * @param connectedSystem - if available passing an already connected system connection will prevent re-authentication for re-entrance ticket and service keys connection types
  * @returns the prompts used to provide input for odata service generation and a reference to the answers object which will be populated with the user's responses once `inquirer.prompt` returns
  */
 declare function getPrompts(promptOptions?: OdataServicePromptOptions, logger?: Logger, enableGuidedAnswers?: boolean, telemetryClient?: ToolsSuiteTelemetryClient, isYUI?: boolean, connectedSystem?: ConnectedSystem): Promise<{
@@ -59,7 +59,7 @@ declare function getEntityRelatedPrompts(metadata: string, templateType: Templat
  * @param enableGuidedAnswers - if true, the prompts will use guided answers to help users with validation errors
  * @param telemetryClient - the telemetry client to use for sending telemetry data
  * @param isYUI - if true, the prompt is being called from the Yeoman UI extension host
- * @param connectedSystem - if available passing an already connected system connection will prevent re-authentication for re-entrance ticket connection types
+ * @param connectedSystem - if available passing an already connected system connection will prevent re-authentication for re-entrance ticket and service keys connection types
  * @returns the prompt answers
  */
 declare function prompt(adapter: InquirerAdapter, promptOptions?: OdataServicePromptOptions, logger?: Logger, enableGuidedAnswers?: boolean, telemetryClient?: ToolsSuiteTelemetryClient, isYUI?: boolean, connectedSystem?: ConnectedSystem): Promise<OdataServiceAnswers>;

package/dist/index.js

@@ -31,7 +31,7 @@ const utils_1 = require("./utils");
  * @param enableGuidedAnswers - if true, the prompts will use guided answers to help users with validation errors
  * @param telemetryClient - the telemetry client to use for sending telemetry data
  * @param isYUI - if true, the prompt is being called from the Yeoman UI extension host
- * @param connectedSystem - if available passing an already connected system connection will prevent re-authentication for re-entrance ticket connection types
+ * @param connectedSystem - if available passing an already connected system connection will prevent re-authentication for re-entrance ticket and service keys connection types
  * @returns the prompts used to provide input for odata service generation and a reference to the answers object which will be populated with the user's responses once `inquirer.prompt` returns
  */
 async function getPrompts(promptOptions, logger, enableGuidedAnswers = false, telemetryClient, isYUI = false, connectedSystem) {
@@ -98,7 +98,7 @@ function getEntityRelatedPrompts(metadata, templateType, isCapService = false, p
  * @param enableGuidedAnswers - if true, the prompts will use guided answers to help users with validation errors
  * @param telemetryClient - the telemetry client to use for sending telemetry data
  * @param isYUI - if true, the prompt is being called from the Yeoman UI extension host
- * @param connectedSystem - if available passing an already connected system connection will prevent re-authentication for re-entrance ticket connection types
+ * @param connectedSystem - if available passing an already connected system connection will prevent re-authentication for re-entrance ticket and service keys connection types
  * @returns the prompt answers
  */
 async function prompt(adapter, promptOptions, logger, enableGuidedAnswers, telemetryClient, isYUI = false, connectedSystem) {

package/dist/prompts/connectionValidator.js

@@ -392,8 +392,7 @@ class ConnectionValidator {
     async createSystemConnection({ axiosConfig, url, serviceInfo, destination, odataVersion, refreshToken }) {
         this.resetConnectionState();
         this.resetValidity();
-        // Handle existing stored service keys for backward compatibility
-        if (this.systemAuthType === 'reentranceTicket' || serviceInfo) {
+        if (this.systemAuthType === 'reentranceTicket' || this.systemAuthType === 'serviceKey') {
             this._serviceProvider = this.getAbapOnCloudServiceProvider(url, serviceInfo, refreshToken);
         }
         else if (destination) {
@@ -508,7 +507,6 @@ class ConnectionValidator {
                 url: new URL(url.pathname, url.origin).toString()
             });
         }
-        // Remains for existing stored service keys (backward compatibility)
         if (this.systemAuthType === 'serviceKey' && serviceInfo) {
             return (0, axios_extension_1.createForAbapOnCloud)({
                 environment: axios_extension_1.AbapCloudEnvironment.Standalone,
@@ -539,7 +537,6 @@ class ConnectionValidator {
             return this.getValidationResultFromStatusCode(200);
         }
         try {
-            // Remains for backwards compatibility with existing systems
             this.systemAuthType = 'serviceKey';
             await this.createSystemConnection({ serviceInfo, odataVersion, refreshToken });
             // Cache the user info

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

@@ -7,22 +7,25 @@ import { type ServiceAnswer } from '../service-selection';
 declare const systemUrlPromptName: "abapOnBtp:newSystemUrl";
 declare const abapOnBtpPromptNames: {
     readonly abapOnBtpAuthType: "abapOnBtpAuthType";
+    readonly serviceKey: "serviceKey";
     readonly cloudFoundryAbapSystem: "cloudFoundryAbapSystem";
 };
-export type AbapOnBTPType = 'cloudFoundry' | 'reentranceTicket';
+export type AbapOnBTPType = 'cloudFoundry' | 'serviceKey' | 'reentranceTicket';
 interface AbapOnBtpAnswers extends Partial<OdataServiceAnswers> {
     [abapOnBtpPromptNames.abapOnBtpAuthType]?: AbapOnBTPType;
     [systemUrlPromptName]?: string;
+    [abapOnBtpPromptNames.serviceKey]?: string;
     [abapOnBtpPromptNames.cloudFoundryAbapSystem]?: ServiceInstanceInfo;
 }
 /**
- * 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, 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]
- * @param cachedConnectedSystem if available passing an already connected system connection will prevent re-authentication for re-entrance ticket connection types
+ * @param cachedConnectedSystem if available passing an already connected system connection will prevent re-authentication for re-entrance ticket and service keys connection types
+ * @param serviceKeyToggle Feature toggle to enable/disable the BTP service key option - enabled by default
  * @returns The list of questions for the ABAP on BTP system
  */
-export declare function getAbapOnBTPSystemQuestions(promptOptions?: OdataServicePromptOptions, cachedConnectedSystem?: ConnectedSystem): Question<AbapOnBtpAnswers & ServiceAnswer>[];
+export declare function getAbapOnBTPSystemQuestions(promptOptions?: OdataServicePromptOptions, cachedConnectedSystem?: ConnectedSystem, serviceKeyToggle?: boolean): Question<AbapOnBtpAnswers & ServiceAnswer>[];
 /**
  * Get the Cloud Foundry Abap system discovery prompt. This prompt will list all available ABAP environments in the connected Cloud Foundry space.
  * If the Cloud Foundry connection fails, a warning message will be displayed.
@@ -30,7 +33,7 @@ export declare function getAbapOnBTPSystemQuestions(promptOptions?: OdataService
  * @param connectionValidator The connection validator
  * @param promptNamespace
  * @param requiredOdataVersion
- * @param cachedConnectedSystem if available passing an already connected system connection will prevent re-authentication for re-entrance ticket connection types
+ * @param cachedConnectedSystem if available passing an already connected system connection will prevent re-authentication for re-entrance ticket and service keys connection types
  * @returns The Cloud Foundry ABAP system discovery prompt
  */
 export declare function getCFDiscoverPrompts(connectionValidator: ConnectionValidator, promptNamespace?: string, requiredOdataVersion?: OdataVersion, cachedConnectedSystem?: ConnectedSystem): Question[];

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

@@ -18,21 +18,26 @@ const types_1 = require("../new-system/types");
 const service_selection_1 = require("../service-selection");
 const shared_prompts_1 = require("../shared-prompts/shared-prompts");
 const prompt_helpers_2 = require("../system-selection/prompt-helpers");
+const validators_1 = require("../validators");
+const feature_toggle_1 = require("@sap-ux/feature-toggle");
 const abapOnBtpPromptNamespace = 'abapOnBtp';
 const systemUrlPromptName = `${abapOnBtpPromptNamespace}:${types_1.newSystemPromptNames.newSystemUrl}`;
 const cliCfAbapServicePromptName = 'cliCfAbapService';
 const abapOnBtpPromptNames = {
     'abapOnBtpAuthType': 'abapOnBtpAuthType',
+    'serviceKey': 'serviceKey',
     'cloudFoundryAbapSystem': 'cloudFoundryAbapSystem'
 };
+const SERVICE_KEY_FEATURE_TOGGLE = 'sap.ux.appGenerator.testBetaFeatures.disableBtpServiceKeyAuth';
 /**
- * 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, 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]
- * @param cachedConnectedSystem if available passing an already connected system connection will prevent re-authentication for re-entrance ticket connection types
+ * @param cachedConnectedSystem if available passing an already connected system connection will prevent re-authentication for re-entrance ticket and service keys connection types
+ * @param serviceKeyToggle Feature toggle to enable/disable the BTP service key option - enabled by default
  * @returns The list of questions for the ABAP on BTP system
  */
-function getAbapOnBTPSystemQuestions(promptOptions, cachedConnectedSystem) {
+function getAbapOnBTPSystemQuestions(promptOptions, cachedConnectedSystem, serviceKeyToggle = (0, feature_toggle_1.isFeatureEnabled)(SERVICE_KEY_FEATURE_TOGGLE)) {
     utils_1.PromptState.reset();
     const connectValidator = new connectionValidator_1.ConnectionValidator();
     const questions = [];
@@ -41,6 +46,15 @@ function getAbapOnBTPSystemQuestions(promptOptions, cachedConnectedSystem) {
         name: abapOnBtpPromptNames.abapOnBtpAuthType,
         choices: [
             { name: (0, i18n_1.t)('prompts.abapOnBTPType.choiceCloudFoundry'), value: 'cloudFoundry' },
+            // Feature toggle the service key option - enabled by default, can be disabled via VS Code settings or ENV
+            ...(!serviceKeyToggle
+                ? [
+                    {
+                        name: (0, i18n_1.t)('prompts.abapOnBTPType.choiceServiceKey'),
+                        value: 'serviceKey'
+                    }
+                ]
+                : []),
             { name: (0, i18n_1.t)('prompts.abapOnBTPType.choiceReentranceTicket'), value: 'reentranceTicket' }
         ],
         message: (0, i18n_1.t)('prompts.abapOnBTPType.message'),
@@ -60,6 +74,10 @@ function getAbapOnBTPSystemQuestions(promptOptions, cachedConnectedSystem) {
         }
         return false;
     })[0]);
+    // Service Key file prompt - enabled by default
+    if (!serviceKeyToggle) {
+        questions.push((0, inquirer_common_1.withCondition)([getServiceKeyPrompt(connectValidator, cachedConnectedSystem)], (answers) => answers?.abapOnBtpAuthType === 'serviceKey')[0]);
+    }
     questions.push(...(0, inquirer_common_1.withCondition)([...getCFDiscoverPrompts(connectValidator, undefined, undefined, cachedConnectedSystem)], (answers) => answers?.abapOnBtpAuthType === 'cloudFoundry'));
     // New system store name propmt
     if (promptOptions?.userSystemName?.hide !== true) {
@@ -73,8 +91,8 @@ function getAbapOnBTPSystemQuestions(promptOptions, cachedConnectedSystem) {
     return questions;
 }
 /**
- * Validate the service info (returned from cf-tools APIs) for an ABAP on BTP system. This function will validate the connection to the ABAP system and on BAS will create a new destination.
- * Updates the prompt state with the connected system to be later used for catalog service selection.
+ * 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 {@link ServiceInstanceInfo}
  * @param connectionValidator connection validator instance
@@ -147,7 +165,7 @@ async function validateCFServiceInfo(abapService, connectionValidator, requiredO
  * @param connectionValidator The connection validator
  * @param promptNamespace
  * @param requiredOdataVersion
- * @param cachedConnectedSystem if available passing an already connected system connection will prevent re-authentication for re-entrance ticket connection types
+ * @param cachedConnectedSystem if available passing an already connected system connection will prevent re-authentication for re-entrance ticket and service keys connection types
  * @returns The Cloud Foundry ABAP system discovery prompt
  */
 function getCFDiscoverPrompts(connectionValidator, promptNamespace, requiredOdataVersion, cachedConnectedSystem) {
@@ -202,4 +220,46 @@ function getCFDiscoverPrompts(connectionValidator, promptNamespace, requiredOdat
     }
     return questions;
 }
+/**
+ * Get the service key prompt for the ABAP on BTP system. This prompt will allow the user to select a service key file from the file system.
+ *
+ * @param connectionValidator a connection validator instance
+ * @param cachedConnectedSystem if available passing an already connected system connection will prevent re-authentication for re-entrance ticket and service keys connection types
+ * @returns The service key prompt
+ */
+function getServiceKeyPrompt(connectionValidator, cachedConnectedSystem) {
+    const question = {
+        type: 'input',
+        name: abapOnBtpPromptNames.serviceKey,
+        message: (0, i18n_1.t)('prompts.serviceKey.message'),
+        guiType: 'file-browser',
+        guiOptions: {
+            hint: (0, i18n_1.t)('prompts.serviceKey.hint'),
+            mandatory: true
+        },
+        validate: async (keyPath) => {
+            utils_1.PromptState.resetConnectedSystem();
+            const serviceKeyValResult = (0, validators_1.validateServiceKey)(keyPath);
+            if (typeof serviceKeyValResult === 'string' || typeof serviceKeyValResult === 'boolean') {
+                return serviceKeyValResult;
+            }
+            // Backend systems validation supports using a cached connections from a previous step execution to prevent re-authentication (e.g. re-opening a browser window)
+            // In case the user has changed the URL, do not use the cached connection.
+            if (cachedConnectedSystem &&
+                cachedConnectedSystem.backendSystem?.url === serviceKeyValResult.url &&
+                JSON.stringify(cachedConnectedSystem.backendSystem.serviceKeys.uaa) ===
+                    JSON.stringify(serviceKeyValResult.uaa)) {
+                connectionValidator.setConnectedSystem(cachedConnectedSystem);
+            }
+            const connectValResult = await connectionValidator.validateServiceInfo(serviceKeyValResult);
+            if (connectValResult === true && connectionValidator.serviceProvider) {
+                utils_1.PromptState.odataService.connectedSystem = {
+                    serviceProvider: (0, utils_1.removeCircularFromServiceProvider)(connectionValidator.serviceProvider)
+                };
+            }
+            return connectValResult;
+        }
+    };
+    return question;
+}
 //# sourceMappingURL=questions.js.map

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

@@ -49,7 +49,6 @@ async function connectWithBackendSystem(backendKey, connectionValidator, require
             });
         }
         else if (backendSystem.serviceKeys) {
-            // Handle existing stored service keys for backward compatibility
             connectValResult = await connectionValidator.validateServiceInfo(backendSystem.serviceKeys, (0, utils_1.convertODataVersionType)(requiredOdataVersion), backendSystem.refreshToken);
         }
         else if (backendSystem.authenticationType === 'basic' || !backendSystem.authenticationType) {

package/dist/prompts/prompts.d.ts

@@ -3,7 +3,7 @@ import { type ConnectedSystem, type OdataServicePromptOptions, type OdataService
  * Get the prompts for the OData service inquirer.
  *
  * @param promptOptions - options that can control some of the prompt behavior. See {@link OdataServicePromptOptions} for details
- * @param connectedSystem - if available passing an already connected system connection will prevent re-authentication for re-entrance ticket connection types
+ * @param connectedSystem - if available passing an already connected system connection will prevent re-authentication for re-entrance ticket and service keys connection types
  * @returns the prompts used to provide input for OData service generation
  */
 export declare function getQuestions(promptOptions?: OdataServicePromptOptions, connectedSystem?: ConnectedSystem): Promise<OdataServiceQuestion[]>;

package/dist/prompts/prompts.js

@@ -13,7 +13,7 @@ const prompt_helpers_1 = require("./prompt-helpers");
  * Get the prompts for the OData service inquirer.
  *
  * @param promptOptions - options that can control some of the prompt behavior. See {@link OdataServicePromptOptions} for details
- * @param connectedSystem - if available passing an already connected system connection will prevent re-authentication for re-entrance ticket connection types
+ * @param connectedSystem - if available passing an already connected system connection will prevent re-authentication for re-entrance ticket and service keys connection types
  * @returns the prompts used to provide input for OData service generation
  */
 async function getQuestions(promptOptions, connectedSystem) {

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

@@ -110,8 +110,15 @@
         "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": "The service keys file does not contain the required information. Check the file is valid and try again.",
+            "unparseableServiceKey": "The service keys file does not contain a valid JSON format. Check the formatting and try again."
+        },
         "cloudFoundryAbapSystem": {
             "message": "ABAP environment",
             "hint": "Enter the name of the Cloud Foundry service that contains the ABAP Environment instance."

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.7.3",
+  "version": "2.8.0",
   "repository": {
     "type": "git",
     "url": "https://github.com/SAP/open-ux-tools.git",
@@ -29,12 +29,12 @@
     "i18next": "25.3.0",
     "inquirer-autocomplete-prompt": "2.0.1",
     "os-name": "4.0.1",
-    "@sap-ux/axios-extension": "1.22.6",
+    "@sap-ux/axios-extension": "1.22.7",
     "@sap-ux/btp-utils": "1.1.1",
     "@sap-ux/fiori-generator-shared": "0.13.12",
     "@sap-ux/guided-answers-helper": "0.4.0",
     "@sap-ux/telemetry": "0.6.19",
-    "@sap-ux/inquirer-common": "0.7.38",
+    "@sap-ux/inquirer-common": "0.7.39",
     "@sap-ux/logger": "0.7.0",
     "@sap-ux/nodejs-utils": "0.2.3",
     "@sap-ux/project-access": "1.30.13",
@@ -51,7 +51,7 @@
     "@sap-ux/fiori-generator-shared": "0.13.12",
     "@sap-ux/fiori-elements-writer": "2.6.5",
     "@sap-ux/fiori-freestyle-writer": "2.4.40",
-    "@sap-ux/feature-toggle": "0.3.0",
+    "@sap-ux/feature-toggle": "0.3.1",
     "@sap-ux/odata-service-writer": "0.27.18",
     "@sap-ux/cap-config-writer": "0.12.3"
   },