@sap-ux/odata-service-inquirer 0.5.3 → 0.5.5

package/dist/prompts/connectionValidator.d.ts

@@ -21,6 +21,7 @@ type ValidationResult = string | boolean | IValidationLink;
 export declare class ConnectionValidator {
     readonly validity: Validity;
     private _validatedUrl;
+    private _validatedClient;
     private _odataService;
     private _serviceProvider;
     private _axiosConfig;
@@ -93,7 +94,7 @@ export declare class ConnectionValidator {
      * @param serviceUrl the odata service url to validate
      * @param options options for the connection validation
      * @param options.ignoreCertError ignore some certificate errors
-     * @param options.forceReValidation force re-validation of the url
+     * @param options.forceReValidation force re-validation of the url even if the same url has been prevously validated
      * @param options.isSystem if true, the url will be treated as a system url rather than a service url
      * @param options.odataVersion if specified will restrict catalog requests to only the specified odata version
      * @returns true if the url is reachable, false if not, or an error message string
@@ -126,6 +127,16 @@ export declare class ConnectionValidator {
      * @returns true if the url has already been validated
      */
     private isUrlValidated;
+    /**
+     * Check whether basic auth is required for the given url, or for the previously validated url if none specified.
+     * This will also set the validity state for the url. This will not validate the URL.
+     *
+     * @param urlString - the url to validate, if not provided the previously validated url will be used
+     * @param client - optional, sap client code, if not provided the previously validated client will be used
+     * @param ignoreCertError
+     * @returns true if basic auth is required, false if not
+     */
+    isAuthRequired(urlString?: string | undefined, client?: string | undefined, ignoreCertError?: boolean): Promise<boolean>;
     /**
      * Test the connectivity with the specified service url using the provided credentials.
      *

package/dist/prompts/connectionValidator.js

@@ -22,7 +22,10 @@ const ignorableCertErrors = [error_handler_1.ERROR_TYPE.CERT_SELF_SIGNED, error_
  */
 class ConnectionValidator {
     validity = {};
+    // The current valid url (not necessarily authenticated but the url is in a valid format)
     _validatedUrl;
+    // The current client code used for requests, the client code has been validated by a successful request
+    _validatedClient;
     _odataService;
     _serviceProvider;
     _axiosConfig;
@@ -97,6 +100,7 @@ class ConnectionValidator {
                 // Full service URL
                 await this.createServiceConnection(axiosConfig, url.pathname);
             }
+            this._validatedClient = url.searchParams.get(types_1.SAP_CLIENT_KEY) ?? undefined;
             return 200;
         }
         catch (e) {
@@ -191,7 +195,7 @@ class ConnectionValidator {
      * @param serviceUrl the odata service url to validate
      * @param options options for the connection validation
      * @param options.ignoreCertError ignore some certificate errors
-     * @param options.forceReValidation force re-validation of the url
+     * @param options.forceReValidation force re-validation of the url even if the same url has been prevously validated
      * @param options.isSystem if true, the url will be treated as a system url rather than a service url
      * @param options.odataVersion if specified will restrict catalog requests to only the specified odata version
      * @returns true if the url is reachable, false if not, or an error message string
@@ -224,7 +228,7 @@ class ConnectionValidator {
             // More helpful context specific error
             if (error_handler_1.ErrorHandler.getErrorType(error) === error_handler_1.ERROR_TYPE.CONNECTION) {
                 this.validity.reachable = false;
-                return prompt_helpers_1.errorHandler.logErrorMsgs((0, i18n_1.t)('errors.serviceUrlNotFound', { url: serviceUrl }));
+                return prompt_helpers_1.errorHandler.logErrorMsgs((0, i18n_1.t)('errors.systemOrserviceUrlNotFound', { url: serviceUrl }));
             }
             this.resetValidity();
             const errorMsg = prompt_helpers_1.errorHandler.getErrorMsg(error);
@@ -240,10 +244,10 @@ class ConnectionValidator {
      */
     getValidationResultFromStatusCode(status) {
         if (status === 200) {
+            this.validity.reachable = true;
             this.validity.authenticated = true;
-            this.validity.authRequired = false;
         }
-        else if (status === 404) {
+        else if (error_handler_1.ErrorHandler.getErrorType(status) === error_handler_1.ERROR_TYPE.NOT_FOUND) {
             this.validity.reachable = false;
             return error_handler_1.ErrorHandler.getErrorMsgFromType(error_handler_1.ERROR_TYPE.NOT_FOUND) ?? false;
         }
@@ -255,12 +259,13 @@ class ConnectionValidator {
         else if (error_handler_1.ErrorHandler.getErrorType(status) === error_handler_1.ERROR_TYPE.AUTH) {
             this.validity.reachable = true;
             this.validity.authRequired = true;
+            this.validity.authenticated = false;
         }
         else if (error_handler_1.ErrorHandler.getErrorType(status) === error_handler_1.ERROR_TYPE.REDIRECT) {
             this.validity.reachable = true;
             return (0, i18n_1.t)('errors.urlRedirect');
         }
-        else if (status !== 404) {
+        else if (error_handler_1.ErrorHandler.getErrorType(status) === error_handler_1.ERROR_TYPE.CONNECTION) {
             this.validity.reachable = false;
             return error_handler_1.ErrorHandler.getErrorMsgFromType(error_handler_1.ERROR_TYPE.CONNECTION, `http code: ${status}`) ?? false;
         }
@@ -289,6 +294,40 @@ class ConnectionValidator {
         this.resetValidity();
         return false;
     }
+    /**
+     * Check whether basic auth is required for the given url, or for the previously validated url if none specified.
+     * This will also set the validity state for the url. This will not validate the URL.
+     *
+     * @param urlString - the url to validate, if not provided the previously validated url will be used
+     * @param client - optional, sap client code, if not provided the previously validated client will be used
+     * @param ignoreCertError
+     * @returns true if basic auth is required, false if not
+     */
+    async isAuthRequired(urlString = this._validatedUrl, client = this._validatedClient, ignoreCertError = false) {
+        if (!urlString) {
+            return false;
+        }
+        // Dont re-request if already validated
+        if (this._validatedUrl === urlString &&
+            this._validatedClient === client &&
+            this.validity.authRequired !== undefined) {
+            return this.validity.authRequired;
+        }
+        // New URL or client so we need to re-request
+        try {
+            const url = new URL(urlString);
+            if (client) {
+                url.searchParams.append(types_1.SAP_CLIENT_KEY, client);
+            }
+            this.validity.authRequired = this.validity.reachable =
+                error_handler_1.ErrorHandler.getErrorType(await this.checkSapService(url, undefined, undefined, { ignoreCertError })) === error_handler_1.ERROR_TYPE.AUTH;
+            return this.validity.authRequired;
+        }
+        catch (error) {
+            prompt_helpers_1.errorHandler.logErrorMsgs(error);
+            return false; // Cannot determine if auth required
+        }
+    }
     /**
      * Test the connectivity with the specified service url using the provided credentials.
      *
@@ -316,9 +355,18 @@ class ConnectionValidator {
                 isSystem,
                 odataVersion
             });
+            logger_helper_1.default.logger.debug(`ConnectionValidator.validateUrl() - status: ${status}; url: ${url}`);
+            // Since an exception was not thrown, this is a valid url
+            this.validity.urlFormat = true;
+            this._validatedUrl = url;
             const valResult = this.getValidationResultFromStatusCode(status);
-            if (valResult === true && this.validity.authenticated === true) {
-                return true;
+            if (valResult === true) {
+                if (this.validity.authenticated === true) {
+                    return true;
+                }
+                else if (this.validity.authenticated === false) {
+                    return (0, i18n_1.t)('errors.authenticationFailed');
+                }
             }
             return valResult;
         }

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

@@ -149,6 +149,7 @@ exports.getAbapOnPremQuestions = getAbapOnPremQuestions;
  */
 function getAbapOnPremSystemQuestions(systemNamePromptOptions, connectionValidator, requiredOdataVersion) {
     const connectValidator = connectionValidator ?? new connectionValidator_1.ConnectionValidator();
+    let validClient = true;
     const questions = [
         {
             type: 'input',
@@ -179,10 +180,18 @@ function getAbapOnPremSystemQuestions(systemNamePromptOptions, connectionValidat
             guiOptions: {
                 breadcrumb: (0, i18n_1.t)('prompts.sapClient.breadcrumb')
             },
-            validate: project_input_validator_1.validateClient
+            validate: (client) => {
+                const valRes = (0, project_input_validator_1.validateClient)(client);
+                if (valRes === true) {
+                    validClient = true;
+                    return true;
+                }
+                validClient = false;
+                return valRes;
+            }
         },
         {
-            when: () => (connectValidator.validity.reachable ? connectValidator.validity.authRequired === true : false),
+            when: () => connectValidator.isAuthRequired(),
             type: 'input',
             name: abapOnPremInternalPromptNames.systemUsername,
             message: (0, i18n_1.t)('prompts.systemUsername.message'),
@@ -192,7 +201,7 @@ function getAbapOnPremSystemQuestions(systemNamePromptOptions, connectionValidat
             validate: (user) => user?.length > 0
         },
         {
-            when: () => (connectValidator.validity.reachable ? connectValidator.validity.authRequired === true : false),
+            when: () => connectValidator.isAuthRequired(),
             type: 'password',
             guiOptions: {
                 mandatory: true
@@ -202,7 +211,7 @@ function getAbapOnPremSystemQuestions(systemNamePromptOptions, connectionValidat
             guiType: 'login',
             mask: '*',
             validate: async (password, { systemUrl, abapSystemUsername, sapClient }) => {
-                if (!(systemUrl && abapSystemUsername && password)) {
+                if (!(systemUrl && abapSystemUsername && password && validClient)) {
                     return false;
                 }
                 const valResult = await connectValidator.validateAuth(systemUrl, abapSystemUsername, password, {

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

@@ -64,6 +64,7 @@ exports.getNewSystemQuestions = getNewSystemQuestions;
  */
 function getUserSystemNameQuestion() {
     let defaultSystemName;
+    let userModifiedSystemName = false;
     const newSystemNamePrompt = {
         type: 'input',
         guiOptions: {
@@ -74,19 +75,21 @@ function getUserSystemNameQuestion() {
         name: types_1.promptNames.userSystemName,
         message: (0, i18n_1.t)('prompts.systemName.message'),
         default: async (answers) => {
-            if (answers.newSystemType === 'abapOnPrem' && answers.systemUrl) {
+            if (answers.newSystemType === 'abapOnPrem' && answers.systemUrl && !userModifiedSystemName) {
                 defaultSystemName = await (0, prompt_helpers_1.suggestSystemName)(answers.systemUrl, answers.sapClient);
+                return defaultSystemName;
             }
-            return defaultSystemName;
+            return answers.userSystemName;
         },
         validate: async (systemName, answers) => {
-            let validationResult = false;
             // Dont validate the suggested default system name
             if (systemName === defaultSystemName) {
-                validationResult = true;
+                return true;
             }
-            validationResult = await (0, validators_1.validateSystemName)(systemName);
+            const validationResult = await (0, validators_1.validateSystemName)(systemName);
             if (validationResult === true) {
+                // Not the default system name, so the user modified
+                userModifiedSystemName = true;
                 const backendSystem = new store_1.BackendSystem({
                     name: systemName,
                     url: answers.systemUrl,

package/dist/prompts/datasources/sap-system/validators.d.ts

@@ -3,6 +3,5 @@
  *
  * @param systemName a system name to validate
  * @returns true if the name is valid, otherwise an error message
- */
-export declare function validateSystemName(systemName: string): Promise<boolean | string>;
+ */ export declare function validateSystemName(systemName: string): Promise<boolean | string>;
 //# sourceMappingURL=validators.d.ts.map

package/dist/prompts/datasources/sap-system/validators.js

@@ -22,8 +22,10 @@ async function isSystemNameInUse(systemName) {
  *
  * @param systemName a system name to validate
  * @returns true if the name is valid, otherwise an error message
- */
-async function validateSystemName(systemName) {
+ */ async function validateSystemName(systemName) {
+    if (!systemName) {
+        return (0, i18n_1.t)('prompts.systemName.emptySystemNameWarning');
+    }
     const systemExists = await isSystemNameInUse(systemName);
     if (systemExists) {
         return (0, i18n_1.t)('prompts.systemName.systemNameExistsWarning');

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

@@ -95,7 +95,8 @@
             "message": "System name",
             "hint": "Entering a system name will save the connection for re-use.",
             "systemNameExistsWarning": "A system with that name already exists in the secure storage. Please try a different name.",
-            "reservedSystemNameWarning": "'{{ systemName }}' is a reserved system name. Please try a different name."
+            "reservedSystemNameWarning": "'{{ systemName }}' is a reserved system name. Please try a different name.",
+            "emptySystemNameWarning": "System name cannot be empty."
         },
         "systemSelection": {
             "newSystemChoiceLabel": "New system"
@@ -128,7 +129,7 @@
         "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",
-        "serviceUrlNotFound": "Please verify the service 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}}",

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.3",
+  "version": "0.5.5",
   "repository": {
     "type": "git",
     "url": "https://github.com/SAP/open-ux-tools.git",
@@ -25,7 +25,7 @@
     "i18next": "23.5.1",
     "inquirer-autocomplete-prompt": "2.0.1",
     "os-name": "4.0.1",
-    "@sap-ux/axios-extension": "1.16.0",
+    "@sap-ux/axios-extension": "1.16.1",
     "@sap-ux/btp-utils": "0.15.0",
     "@sap-ux/telemetry": "0.5.9",
     "@sap-ux/inquirer-common": "0.4.2",