@sap-ux/odata-service-inquirer 0.6.9 → 0.6.11

package/dist/prompts/connectionValidator.d.ts

@@ -179,6 +179,7 @@ export declare class ConnectionValidator {
      * @param connectConfig.serviceInfo the service info
      * @param connectConfig.odataVersion the odata version to restrict the catalog requests if only a specific version is required
      * @param connectConfig.destination the destination to connect with
+     * @param connectConfig.refreshToken
      * @throws an error if the connection attempt fails, callers should handle the error
      */
     private createSystemConnection;
@@ -200,6 +201,7 @@ export declare class ConnectionValidator {
      *
      * @param url the system url
      * @param serviceInfo the service info
+     * @param refreshToken
      * @returns the service provider
      */
     private getAbapOnCloudServiceProvider;
@@ -210,9 +212,10 @@ export declare class ConnectionValidator {
      *
      * @param serviceInfo the service info containing the UAA details
      * @param odataVersion the odata version to restrict the catalog requests if only a specific version is required
+     * @param refreshToken the refresh token for the Abap on Cloud environment, will be used to avoid re-authentication while the token is valid
      * @returns true if the system is reachable and authenticated, if required, false if not, or an error message string
      */
-    validateServiceInfo(serviceInfo: ServiceInfo, odataVersion?: ODataVersion): Promise<ValidationResult>;
+    validateServiceInfo(serviceInfo: ServiceInfo, odataVersion?: ODataVersion, refreshToken?: string): Promise<ValidationResult>;
     /**
      * Validate the specified destination connectivity, determining if authentication is required or if the destination is misconfigured.
      *

package/dist/prompts/connectionValidator.js

@@ -299,13 +299,14 @@ class ConnectionValidator {
      * @param connectConfig.serviceInfo the service info
      * @param connectConfig.odataVersion the odata version to restrict the catalog requests if only a specific version is required
      * @param connectConfig.destination the destination to connect with
+     * @param connectConfig.refreshToken
      * @throws an error if the connection attempt fails, callers should handle the error
      */
-    async createSystemConnection({ axiosConfig, url, serviceInfo, destination, odataVersion }) {
+    async createSystemConnection({ axiosConfig, url, serviceInfo, destination, odataVersion, refreshToken }) {
         this.resetConnectionState();
         this.resetValidity();
         if (this.systemAuthType === 'reentranceTicket' || this.systemAuthType === 'serviceKey') {
-            this._serviceProvider = this.getAbapOnCloudServiceProvider(url, serviceInfo);
+            this._serviceProvider = this.getAbapOnCloudServiceProvider(url, serviceInfo, refreshToken);
         }
         else if (destination) {
             // Assumption: the destination configured URL is a valid URL, will be needed later for basic auth error handling
@@ -378,9 +379,10 @@ class ConnectionValidator {
      *
      * @param url the system url
      * @param serviceInfo the service info
+     * @param refreshToken
      * @returns the service provider
      */
-    getAbapOnCloudServiceProvider(url, serviceInfo) {
+    getAbapOnCloudServiceProvider(url, serviceInfo, refreshToken) {
         if (this.systemAuthType === 'reentranceTicket' && url) {
             return (0, axios_extension_1.createForAbapOnCloud)({
                 environment: axios_extension_1.AbapCloudEnvironment.EmbeddedSteampunk,
@@ -391,6 +393,7 @@ class ConnectionValidator {
             return (0, axios_extension_1.createForAbapOnCloud)({
                 environment: axios_extension_1.AbapCloudEnvironment.Standalone,
                 service: serviceInfo,
+                refreshToken,
                 refreshTokenChangedCb: this.refreshTokenChangedCb.bind(this)
             });
         }
@@ -403,15 +406,16 @@ class ConnectionValidator {
      *
      * @param serviceInfo the service info containing the UAA details
      * @param odataVersion the odata version to restrict the catalog requests if only a specific version is required
+     * @param refreshToken the refresh token for the Abap on Cloud environment, will be used to avoid re-authentication while the token is valid
      * @returns true if the system is reachable and authenticated, if required, false if not, or an error message string
      */
-    async validateServiceInfo(serviceInfo, odataVersion) {
+    async validateServiceInfo(serviceInfo, odataVersion, refreshToken) {
         if (!serviceInfo) {
             return false;
         }
         try {
             this.systemAuthType = 'serviceKey';
-            await this.createSystemConnection({ serviceInfo, odataVersion });
+            await this.createSystemConnection({ serviceInfo, odataVersion, refreshToken });
             // Cache the user info
             this._connectedUserName = await this.serviceProvider.user();
             this._serviceInfo = serviceInfo;
@@ -476,15 +480,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.js

@@ -41,7 +41,7 @@ async function connectWithBackendSystem(backendSystem, connectionValidator, requ
             });
         }
         else if (backendSystem.serviceKeys) {
-            connectValResult = await connectionValidator.validateServiceInfo(backendSystem.serviceKeys);
+            connectValResult = await connectionValidator.validateServiceInfo(backendSystem.serviceKeys, (0, utils_1.convertODataVersionType)(requiredOdataVersion), backendSystem.refreshToken);
         }
         else if (backendSystem.authenticationType === 'basic' || !backendSystem.authenticationType) {
             let errorType;

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

@@ -93,7 +93,10 @@ async function getSystemConnectionQuestions(connectionValidator, promptOptions)
             type: promptOptions?.systemSelection?.useAutoComplete ? 'autocomplete' : 'list',
             name: types_1.promptNames.systemSelection,
             message: (0, i18n_1.t)('prompts.systemSelection.message'),
-            hint: (0, i18n_1.t)('prompts.systemSelection.hint'),
+            guiOptions: {
+                breadcrumb: true,
+                hint: (0, i18n_1.t)('prompts.systemSelection.hint')
+            },
             source: (prevAnswers, input) => (0, inquirer_common_1.searchChoices)(input, systemChoices),
             choices: systemChoices,
             default: defaultChoiceIndex,
@@ -137,16 +140,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/translations/odata-service-inquirer.i18n.json

@@ -61,7 +61,7 @@
             "annotationsNotFound": "Annotations not found for specified service"
         },
         "warnings": {
-            "nonUIServiceTypeWarningMessage": "Please note that {{serviceType}} services are not intended to be used for the generation of SAP Fiori UI applications",
+            "nonUIServiceTypeWarningMessage": "Please note that {{serviceType}} services, or not classified services, are not intended to be used for the generation of SAP Fiori UI applications",
             "noServicesAvailable": "No services available for the selected system, see logs for further details.",
             "noServicesAvailableForOdataVersion": "There are no V{{odataVersion}} OData services available from the selected system and the template you have chosen supports V{{odataVersion}} OData services only"
         },

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.9",
+  "version": "0.6.11",
   "repository": {
     "type": "git",
     "url": "https://github.com/SAP/open-ux-tools.git",
@@ -26,15 +26,15 @@
     "i18next": "23.5.1",
     "inquirer-autocomplete-prompt": "2.0.1",
     "os-name": "4.0.1",
-    "@sap-ux/axios-extension": "1.17.4",
-    "@sap-ux/fiori-generator-shared": "0.7.10",
     "@sap-ux/btp-utils": "0.17.0",
     "@sap-ux/guided-answers-helper": "0.1.0",
-    "@sap-ux/inquirer-common": "0.5.4",
     "@sap-ux/telemetry": "0.5.44",
-    "@sap-ux/logger": "0.6.0",
+    "@sap-ux/axios-extension": "1.17.4",
+    "@sap-ux/fiori-generator-shared": "0.7.10",
+    "@sap-ux/inquirer-common": "0.5.4",
     "@sap-ux/project-access": "1.28.7",
     "@sap-ux/project-input-validator": "0.3.3",
+    "@sap-ux/logger": "0.6.0",
     "@sap-ux/store": "0.9.3"
   },
   "devDependencies": {