@sap-ux/odata-service-inquirer 0.6.8 → 0.6.10

package/dist/index.d.ts

@@ -4,6 +4,7 @@ import { OdataVersion } from '@sap-ux/odata-service-writer';
 import { type ToolsSuiteTelemetryClient } from '@sap-ux/telemetry';
 import { ERROR_TYPE, ErrorHandler } from '@sap-ux/inquirer-common';
 import { SystemSelectionAnswerType } from './prompts/datasources/sap-system/system-selection';
+import type { NewSystemChoice, CfAbapEnvServiceChoice } from './prompts/datasources/sap-system/system-selection/prompt-helpers';
 import { DatasourceType, promptNames, type CapRuntime, type CapService, type OdataServiceAnswers, type OdataServicePromptOptions, type OdataServiceQuestion, type SapSystemType } from './types';
 /**
  * Get the inquirer prompts for odata service.
@@ -31,5 +32,5 @@ declare function getPrompts(promptOptions?: OdataServicePromptOptions, logger?:
  * @returns the prompt answers
  */
 declare function prompt(adapter: InquirerAdapter, promptOptions?: OdataServicePromptOptions, logger?: Logger, enableGuidedAnswers?: boolean, telemetryClient?: ToolsSuiteTelemetryClient, isYUI?: boolean): Promise<OdataServiceAnswers>;
-export { DatasourceType, ERROR_TYPE, ErrorHandler, getPrompts, OdataVersion, prompt, promptNames, SystemSelectionAnswerType, type CapRuntime, type CapService, type InquirerAdapter, type OdataServiceAnswers, type OdataServicePromptOptions, type SapSystemType };
+export { DatasourceType, ERROR_TYPE, ErrorHandler, getPrompts, OdataVersion, prompt, promptNames, SystemSelectionAnswerType, type CapRuntime, type CapService, type InquirerAdapter, type OdataServiceAnswers, type OdataServicePromptOptions, type SapSystemType, NewSystemChoice, CfAbapEnvServiceChoice };
 //# sourceMappingURL=index.d.ts.map

package/dist/prompts/connectionValidator.js

@@ -476,15 +476,20 @@ class ConnectionValidator {
         this.resetValidity();
         // Get the destination URL in the BAS specific form <protocol>://<destinationName>.dest
         const destUrl = (0, btp_utils_1.getDestinationUrlForAppStudio)(destination.Name, servicePath);
-        // Get the destination URL in the portable form <protocol>://<host>:<port>
-        this._destinationUrl = servicePath ? new URL(`${destination.Host}${servicePath}`).toString() : destination.Host;
+        // Get the destination URL in the portable form <protocol>://<host>:<port>.
+        // We remove trailing slashes (up to 10, infinite would allow DOS attack) from the host to avoid double slashes when appending the service path.
+        this._destinationUrl = servicePath
+            ? destUrl.replace(`https://${destination.Name}.dest`, destination.Host.replace(/\/{1,10}$/, ''))
+            : destination.Host;
         this._destination = destination;
         // No need to apply sap-client as this happens automatically (from destination config) when going through the BAS proxy
         const status = await this.checkUrl(new URL(destUrl), undefined, undefined, {
             odataVersion: requiredOdataVersion
         });
-        this._validatedUrl = destUrl;
         const validationResult = this.getValidationResultFromStatusCode(status);
+        if (this.validity.reachable && (!this.validity.authRequired || this.validity.authenticated)) {
+            this._validatedUrl = destUrl;
+        }
         if (!this.validity.reachable) {
             // Log the error
             const errorLog = prompt_helpers_1.errorHandler.logErrorMsgs(status);

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

@@ -4,7 +4,11 @@ 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 SystemSelectionAnswers } from './questions';
+import { type SystemSelectionAnswerType } from './questions';
+export declare const NewSystemChoice = "!@\u00A3*&937newSystem*X~qy^";
+export type NewSystemChoice = typeof NewSystemChoice;
+export declare const CfAbapEnvServiceChoice = "cfAbapEnvService";
+export type CfAbapEnvServiceChoice = typeof CfAbapEnvServiceChoice;
 /**
  * Connects to the specified backend system and validates the connection.
  * Note this will return true in the case of basic auth validation failure to defer validation to the credentials prompt.
@@ -40,5 +44,13 @@ export declare function getBackendSystemDisplayName(system: BackendSystem): stri
  * @param includeCloudFoundryAbapEnvChoice whether to include the Cloud Foundry ABAP environment choice in the list
  * @returns a list of choices for the system selection prompt
  */
-export declare function createSystemChoices(destinationFilters?: Partial<DestinationFilters>, includeCloudFoundryAbapEnvChoice?: boolean): Promise<ListChoiceOptions<SystemSelectionAnswers>[]>;
+export declare function createSystemChoices(destinationFilters?: Partial<DestinationFilters>, includeCloudFoundryAbapEnvChoice?: boolean): Promise<ListChoiceOptions<SystemSelectionAnswerType>[]>;
+/**
+ * Find the default selection index based on the default choice value.
+ *
+ * @param systemChoices the list of system choices
+ * @param defaultChoice the default choice value
+ * @returns the index of the default choice in the system choices list
+ */
+export declare function findDefaultSystemSelectionIndex(systemChoices: ListChoiceOptions<SystemSelectionAnswerType>[], defaultChoice: string | undefined): number;
 //# sourceMappingURL=prompt-helpers.d.ts.map

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

@@ -3,17 +3,22 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.CfAbapEnvServiceChoice = exports.NewSystemChoice = void 0;
 exports.connectWithBackendSystem = connectWithBackendSystem;
 exports.connectWithDestination = connectWithDestination;
 exports.getBackendSystemDisplayName = getBackendSystemDisplayName;
 exports.createSystemChoices = createSystemChoices;
+exports.findDefaultSystemSelectionIndex = findDefaultSystemSelectionIndex;
 const btp_utils_1 = require("@sap-ux/btp-utils");
 const store_1 = require("@sap-ux/store");
 const inquirer_common_1 = require("@sap-ux/inquirer-common");
 const i18n_1 = require("../../../../i18n");
 const utils_1 = require("../../../../utils");
 const logger_helper_1 = __importDefault(require("../../../logger-helper"));
-const questions_1 = require("./questions");
+// 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.NewSystemChoice = '!@£*&937newSystem*X~qy^';
+exports.CfAbapEnvServiceChoice = 'cfAbapEnvService';
 /**
  * Connects to the specified backend system and validates the connection.
  * Note this will return true in the case of basic auth validation failure to defer validation to the credentials prompt.
@@ -161,7 +166,10 @@ async function createSystemChoices(destinationFilters, includeCloudFoundryAbapEn
         if (includeCloudFoundryAbapEnvChoice) {
             newSystemChoice = {
                 name: (0, i18n_1.t)('prompts.newSystemType.choiceCFAbapEnvServiceOnBtp'),
-                value: { type: 'cfAbapEnvService', system: 'cfAbapEnvService' }
+                value: {
+                    type: exports.CfAbapEnvServiceChoice,
+                    system: exports.CfAbapEnvServiceChoice
+                }
             };
         }
     }
@@ -178,7 +186,7 @@ async function createSystemChoices(destinationFilters, includeCloudFoundryAbapEn
         });
         newSystemChoice = {
             name: (0, i18n_1.t)('prompts.systemSelection.newSystemChoiceLabel'),
-            value: { system: questions_1.newSystemChoiceValue, type: 'newSystemChoice' }
+            value: { type: 'newSystemChoice', system: exports.NewSystemChoice }
         };
     }
     systemChoices.sort(({ name: nameA }, { name: nameB }) => nameA.localeCompare(nameB, undefined, { numeric: true, caseFirst: 'lower' }));
@@ -187,4 +195,32 @@ async function createSystemChoices(destinationFilters, includeCloudFoundryAbapEn
     }
     return systemChoices;
 }
+/**
+ * Find the default selection index based on the default choice value.
+ *
+ * @param systemChoices the list of system choices
+ * @param defaultChoice the default choice value
+ * @returns the index of the default choice in the system choices list
+ */
+function findDefaultSystemSelectionIndex(systemChoices, defaultChoice) {
+    if (!defaultChoice) {
+        return -1;
+    }
+    const defaultChoiceIndex = systemChoices.findIndex((choice) => {
+        const { type: systemType, system } = choice.value;
+        if (systemType === 'destination') {
+            return system.Name === defaultChoice;
+        }
+        if (systemType === 'backendSystem') {
+            return system.name === defaultChoice;
+        }
+        if (systemType === 'newSystemChoice') {
+            return defaultChoice === exports.NewSystemChoice;
+        }
+        if (systemType === 'cfAbapEnvService') {
+            return defaultChoice === exports.CfAbapEnvServiceChoice;
+        }
+    });
+    return defaultChoiceIndex;
+}
 //# sourceMappingURL=prompt-helpers.js.map

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

@@ -1,16 +1,15 @@
 import type { Destination } from '@sap-ux/btp-utils';
 import type { BackendSystem } from '@sap-ux/store';
 import type { Question } from 'inquirer';
-import { promptNames, type OdataServicePromptOptions } from '../../../../types';
+import { type OdataServicePromptOptions, promptNames } from '../../../../types';
 import { ConnectionValidator } from '../../../connectionValidator';
 import type { ServiceAnswer } from '../service-selection';
-export declare const newSystemChoiceValue = "!@\u00A3*&937newSystem*X~qy^";
-type NewSystemChoice = typeof newSystemChoiceValue;
+import { type CfAbapEnvServiceChoice, type NewSystemChoice } from './prompt-helpers';
 declare const usernamePromptName: "systemSelection:systemUsername";
 declare const passwordPromptName: "systemSelection:systemPassword";
 export type SystemSelectionAnswerType = {
-    type: 'destination' | 'backendSystem' | 'newSystemChoice' | 'cfAbapEnvService';
-    system: Destination | BackendSystem | NewSystemChoice | 'cfAbapEnvService';
+    type: 'destination' | 'backendSystem' | 'newSystemChoice' | CfAbapEnvServiceChoice;
+    system: Destination | BackendSystem | NewSystemChoice | CfAbapEnvServiceChoice;
 };
 interface SystemSelectionCredentialsAnswers {
     [usernamePromptName]?: string;

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

@@ -3,11 +3,11 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.newSystemChoiceValue = void 0;
 exports.getSystemSelectionQuestions = getSystemSelectionQuestions;
 exports.getSystemConnectionQuestions = getSystemConnectionQuestions;
 const yeoman_ui_types_1 = require("@sap-devx/yeoman-ui-types");
 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 i18n_1 = require("../../../../i18n");
 const types_1 = require("../../../../types");
@@ -19,10 +19,6 @@ const questions_2 = require("../new-system/questions");
 const questions_3 = require("../service-selection/questions");
 const validators_1 = require("../validators");
 const prompt_helpers_1 = require("./prompt-helpers");
-const fiori_generator_shared_1 = require("@sap-ux/fiori-generator-shared");
-// 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 systemSelectionPromptNamespace = 'systemSelection';
 const usernamePromptName = `${systemSelectionPromptNamespace}:${questions_1.BasicCredentialsPromptNames.systemUsername}`;
 const passwordPromptName = `${systemSelectionPromptNamespace}:${questions_1.BasicCredentialsPromptNames.systemPassword}`;
@@ -91,6 +87,7 @@ async function getSystemConnectionQuestions(connectionValidator, promptOptions)
     const requiredOdataVersion = promptOptions?.serviceSelection?.requiredOdataVersion;
     const destinationFilters = promptOptions?.systemSelection?.destinationFilters;
     const systemChoices = await (0, prompt_helpers_1.createSystemChoices)(destinationFilters, promptOptions?.systemSelection?.includeCloudFoundryAbapEnvChoice);
+    const defaultChoiceIndex = (0, prompt_helpers_1.findDefaultSystemSelectionIndex)(systemChoices, promptOptions?.systemSelection?.defaultChoice);
     const questions = [
         {
             type: promptOptions?.systemSelection?.useAutoComplete ? 'autocomplete' : 'list',
@@ -99,6 +96,7 @@ async function getSystemConnectionQuestions(connectionValidator, promptOptions)
             hint: (0, i18n_1.t)('prompts.systemSelection.hint'),
             source: (prevAnswers, input) => (0, inquirer_common_1.searchChoices)(input, systemChoices),
             choices: systemChoices,
+            default: defaultChoiceIndex,
             validate: async (selectedSystem) => {
                 if (!selectedSystem) {
                     return false;
@@ -139,16 +137,22 @@ async function getSystemConnectionQuestions(connectionValidator, promptOptions)
             guiOptions: {
                 hint: (0, i18n_1.t)('prompts.destinationServicePath.hint'),
                 mandatory: true,
-                breadcrumb: true
+                breadcrumb: true,
+                applyDefaultWhenDirty: true
             },
+            default: '',
             validate: async (servicePath, answers) => {
-                if (!servicePath) {
+                // @sap-ux/btp-utils getDestinationUrlForAppStudio() enforces a path length of > 1, even though it could be a valid path
+                // Double slashes are not allowed at the start of the path as they break URL construction
+                if (!servicePath || servicePath.trim().length < 2 || servicePath.startsWith('//')) {
+                    connectionValidator.resetConnectionState(true);
                     return (0, i18n_1.t)('prompts.destinationServicePath.invalidServicePathWarning');
                 }
                 // Validate format of the service path, note this relies on the assumption that the destination is correctly configured with a valid URL
                 const selectedDestination = answers?.[types_1.promptNames.systemSelection]?.system;
                 const valUrlResult = (0, validators_1.validateServiceUrl)(selectedDestination.Host, servicePath);
                 if (valUrlResult !== true) {
+                    connectionValidator.resetConnectionState(true);
                     return valUrlResult;
                 }
                 const connectValResult = await (0, prompt_helpers_1.connectWithDestination)(selectedDestination, connectionValidator, requiredOdataVersion, servicePath);

package/dist/types.d.ts

@@ -231,6 +231,13 @@ export type SystemSelectionPromptOptions = {
      * Note that there is no implementation for this option in this module and handling of the prompt optin and subsequent prompting must be implemented by the consumer.
      */
     includeCloudFoundryAbapEnvChoice?: boolean;
+    /**
+     * Provide a default choice for the system selection prompt, this is used to pre-select a system based on the system name.
+     * Set as string literal types `NewSystemChoice` or `CfAbapEnvServiceChoice` to specify the default choice to create a new system connection config in VSCode
+     * or to select the Cloud Foundry Abap environments service discovery choice in BAS respectively.
+     *
+     */
+    defaultChoice?: string;
 };
 export type MetadataPromptOptions = {
     /**

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.6.8",
+  "version": "0.6.10",
   "repository": {
     "type": "git",
     "url": "https://github.com/SAP/open-ux-tools.git",
@@ -28,13 +28,13 @@
     "os-name": "4.0.1",
     "@sap-ux/axios-extension": "1.17.4",
     "@sap-ux/btp-utils": "0.17.0",
-    "@sap-ux/fiori-generator-shared": "0.7.10",
     "@sap-ux/guided-answers-helper": "0.1.0",
-    "@sap-ux/telemetry": "0.5.44",
+    "@sap-ux/fiori-generator-shared": "0.7.10",
     "@sap-ux/inquirer-common": "0.5.4",
-    "@sap-ux/logger": "0.6.0",
     "@sap-ux/project-access": "1.28.7",
+    "@sap-ux/telemetry": "0.5.44",
     "@sap-ux/project-input-validator": "0.3.3",
+    "@sap-ux/logger": "0.6.0",
     "@sap-ux/store": "0.9.3"
   },
   "devDependencies": {
@@ -43,9 +43,9 @@
     "@types/inquirer": "8.2.6",
     "@types/lodash": "4.14.202",
     "jest-extended": "3.2.4",
-    "@sap-ux/fiori-generator-shared": "0.7.10",
     "@sap-ux/feature-toggle": "0.2.2",
-    "@sap-ux/odata-service-writer": "0.23.3"
+    "@sap-ux/odata-service-writer": "0.23.3",
+    "@sap-ux/fiori-generator-shared": "0.7.10"
   },
   "engines": {
     "node": ">=18.x"