@sap-ux/odata-service-inquirer 2.11.5 → 2.11.7

package/dist/prompts/connectionValidator.d.ts

@@ -345,6 +345,14 @@ export declare class ConnectionValidator {
      * Reset the validity state.
      */
     private resetValidity;
+    /**
+     * Get the specific authorization reason user message. This may be catalog version specific.
+     *
+     * @param httpStatusCode the http error code returned from a request
+     * @param odataVersion optional, the odata version specific request, for example for specific catalog requests
+     * @returns the text message indicting the authentication or authorization failure speific to an odata catalog request
+     */
+    private getAuthFailureReasonText;
 }
 export {};
 //# sourceMappingURL=connectionValidator.d.ts.map

package/dist/prompts/connectionValidator.js

@@ -864,7 +864,10 @@ class ConnectionValidator {
                     return { valResult: true };
                 }
                 else if (this.validity.authenticated === false) {
-                    return { valResult: (0, i18n_1.t)('errors.authenticationFailed'), errorType: inquirer_common_1.ERROR_TYPE.AUTH };
+                    return {
+                        valResult: this.getAuthFailureReasonText(status, odataVersion),
+                        errorType: inquirer_common_1.ERROR_TYPE.AUTH
+                    };
                 }
             }
             return { valResult };
@@ -891,6 +894,33 @@ class ConnectionValidator {
         this._destinationUrl = undefined;
         this._destination = undefined;
     }
+    /**
+     * Get the specific authorization reason user message. This may be catalog version specific.
+     *
+     * @param httpStatusCode the http error code returned from a request
+     * @param odataVersion optional, the odata version specific request, for example for specific catalog requests
+     * @returns the text message indicting the authentication or authorization failure speific to an odata catalog request
+     */
+    getAuthFailureReasonText(httpStatusCode, odataVersion) {
+        let authFailType;
+        if ([403, '403'].includes(httpStatusCode)) {
+            authFailType = (0, i18n_1.t)('texts.authorizationFailed');
+        }
+        else if ([401, '401'].includes(httpStatusCode)) {
+            authFailType = (0, i18n_1.t)('texts.authenticationFailed');
+        }
+        let authFailureReason;
+        if (odataVersion) {
+            authFailureReason = (0, i18n_1.t)('errors.authenticationFailedSpecificCatalog', {
+                odataVersion,
+                authFailType
+            });
+        }
+        else {
+            authFailureReason = (0, i18n_1.t)('errors.authenticationFailedAllCatalogs', { authFailType });
+        }
+        return authFailureReason;
+    }
 }
 exports.ConnectionValidator = ConnectionValidator;
 //# sourceMappingURL=connectionValidator.js.map

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

@@ -1,6 +1,7 @@
 import type { InputQuestion, PasswordQuestion, ConfirmQuestion } from '@sap-ux/inquirer-common';
 import type { Answers } from 'inquirer';
 import type { ConnectionValidator } from '../../../connectionValidator';
+import type { OdataVersion } from '@sap-ux/odata-service-writer';
 export declare enum BasicCredentialsPromptNames {
     systemUsername = "systemUsername",
     systemPassword = "systemPassword",
@@ -14,10 +15,11 @@ export declare enum BasicCredentialsPromptNames {
  * @param sapClient
  * @param sapClient.sapClient the sapClient value to be used along with the credentials validation
  * @param sapClient.isValid validation of credentials is deferred until a valid sapClient is provided or undefined
+ * @param requiredOdataVersion
  * @returns the credentials prompts
  */
 export declare function getCredentialsPrompts<T extends Answers>(connectionValidator: ConnectionValidator, promptNamespace?: string, sapClient?: {
     sapClient: string | undefined;
     isValid: boolean;
-}): (InputQuestion<T> | PasswordQuestion<T> | ConfirmQuestion<T>)[];
+}, requiredOdataVersion?: OdataVersion): (InputQuestion<T> | PasswordQuestion<T> | ConfirmQuestion<T>)[];
 //# sourceMappingURL=questions.d.ts.map

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

@@ -21,9 +21,10 @@ var BasicCredentialsPromptNames;
  * @param sapClient
  * @param sapClient.sapClient the sapClient value to be used along with the credentials validation
  * @param sapClient.isValid validation of credentials is deferred until a valid sapClient is provided or undefined
+ * @param requiredOdataVersion
  * @returns the credentials prompts
  */
-function getCredentialsPrompts(connectionValidator, promptNamespace, sapClient) {
+function getCredentialsPrompts(connectionValidator, promptNamespace, sapClient, requiredOdataVersion) {
     const usernamePromptName = `${promptNamespace ? promptNamespace + ':' : ''}${BasicCredentialsPromptNames.systemUsername}`;
     const passwordPromptName = `${promptNamespace ? promptNamespace + ':' : ''}${BasicCredentialsPromptNames.systemPassword}`;
     const storeCredentialsPromptName = `${promptNamespace ? promptNamespace + ':' : ''}${BasicCredentialsPromptNames.storeSystemCredentials}`;
@@ -79,7 +80,8 @@ function getCredentialsPrompts(connectionValidator, promptNamespace, sapClient)
                 }
                 const { valResult } = await connectionValidator.validateAuth(connectionValidator.validatedUrl, answers?.[usernamePromptName], password, {
                     sapClient: sapClient?.sapClient || selectedSystemClient,
-                    isSystem
+                    isSystem,
+                    odataVersion: (0, utils_1.convertODataVersionType)(requiredOdataVersion)
                 });
                 if (valResult === true && connectionValidator.serviceProvider) {
                     updatePromptStateWithConnectedSystem(connectionValidator.serviceProvider, selectedSystem, {

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

@@ -178,8 +178,7 @@ async function createSystemChoices(destinationFilters, includeCloudFoundryAbapEn
         }
     }
     else {
-        const backendService = await (0, store_1.getBackendSystemService)();
-        const backendSystems = await backendService.getAll({ includeSensitiveData: false });
+        const backendSystems = await (0, store_1.getAllBackendSystems)(false);
         // Cache the backend systems
         utils_1.PromptState.backendSystemsCache = backendSystems;
         systemChoices = backendSystems.map((system) => {

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

@@ -202,7 +202,7 @@ async function getSystemConnectionQuestions(connectionValidator, promptOptions,
             name: `${systemSelectionPromptNames.systemSelectionCli}`
         });
     }
-    questions.push(...(0, questions_2.getCredentialsPrompts)(connectionValidator, systemSelectionPromptNamespace));
+    questions.push(...(0, questions_2.getCredentialsPrompts)(connectionValidator, systemSelectionPromptNamespace, undefined, requiredOdataVersion));
     return questions;
 }
 //# sourceMappingURL=questions.js.map

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

@@ -13,10 +13,7 @@ const store_1 = require("../../../utils/store");
  * @returns true if the system name is already in use, otherwise false
  */
 async function isSystemNameInUse(systemName) {
-    const backendService = await (0, store_1.getBackendSystemService)();
-    const backendSystems = await backendService.getAll({
-        includeSensitiveData: false
-    });
+    const backendSystems = await (0, store_1.getAllBackendSystems)(false);
     return !!backendSystems.find((system) => system.name === systemName);
 }
 /**

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

@@ -111,7 +111,7 @@
             "newSystemChoiceLabel": "New System",
             "hint": "Select a system configuration.",
             "message": "System",
-            "authenticationFailedUpdateCredentials": "Authentication failed. Please try updating the credentials."
+            "authenticationFailedUpdateCredentials": "$t(texts.authenticationFailed). Please try updating the credentials."
         },
         "abapOnBTPType": {
             "message": "ABAP environment definition source",
@@ -217,7 +217,9 @@
         "capModelAndServicesLoadError": "An error occurred loading the CAP model and services: {{- error, addMsgWithColonFormatter}}.",
         "capServiceUrlPathNotDefined": "An error occurred reading CAP service metadata: {{serviceName}}. The CAP service property: `urlPath` is not defined but it is required.",
         "unknownError": "An error occurred: {{- error, addMsgWithColonFormatter}}.",
-        "authenticationFailed": "Authentication incorrect: {{error}}.",
+        "authenticationFailed": "$t(texts.authenticationFailed): {{error}}.",
+        "authenticationFailedSpecificCatalog": "{{authFailType}}: Unable to access the OData V{{odataVersion}} service catalog",
+        "authenticationFailedAllCatalogs": "{{authFailType}}: Unable to access any service catalogs",
         "invalidUrl": "Invalid URL: {{-input, addMsgWithColonFormatter}}.",
         "connectionError": "A connection error occurred. Ensure the target host is available on the network: {{- error}}",
         "urlNotFound": "URL not found.",
@@ -241,7 +243,8 @@
         "unparseableXML": "Unparseable XML was specified: {{-error}}.",
         "noRelevantEntities": "The template and service selected have no relevant entities that you can use.",
         "cfInstanceCredentialsNotReturned": "Cannot not retrieve credentials to access: {{serviceInstanceName}}.",
-        "v2CatalogServiceNoAnnotations": "An error occurred when creating an OData V2 catalog service object. Annotations will not be available: {{-error}}"
+        "v2CatalogServiceNoAnnotations": "An error occurred when creating an OData V2 catalog service object. Annotations will not be available: {{-error}}",
+        "backendSystemRetrieval": "An error occurred when retrieving the backend systems from the store: {{-error}}"
     },
     "warnings": {
         "largeMetadataDocument": "The metadata for this OData service is very large. It may take some time before this operation completes.",
@@ -262,6 +265,8 @@
         "httpStatus": "HTTP Status {{httpStatus}}",
         "checkDestinationAuthConfig": "Please check the SAP BTP destination authentication configuration.",
         "choiceNameNone": "None",
-        "passwordStoreWarning": "Passwords are stored in your operating system's credential manager and are protected by its security policies."
+        "passwordStoreWarning": "Passwords are stored in your operating system's credential manager and are protected by its security policies.",
+        "authorizationFailed": "Authorization failed",
+        "authenticationFailed": "Authentication failed"
     }
 }

package/dist/utils/store.d.ts

@@ -5,4 +5,11 @@ import { type BackendSystem, type BackendSystemKey, type Service } from '@sap-ux
  * @returns the backend system service instance
  */
 export declare function getBackendSystemService(): Promise<Service<BackendSystem, BackendSystemKey>>;
+/**
+ * Fetch all backend systems.
+ *
+ * @param includeSensitiveData - whether to include sensitive data
+ * @returns backened systems
+ */
+export declare function getAllBackendSystems(includeSensitiveData?: boolean): Promise<BackendSystem[] | []>;
 //# sourceMappingURL=store.d.ts.map

package/dist/utils/store.js

@@ -1,7 +1,13 @@
 "use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.getBackendSystemService = getBackendSystemService;
+exports.getAllBackendSystems = getAllBackendSystems;
 const store_1 = require("@sap-ux/store");
+const logger_helper_1 = __importDefault(require("../prompts/logger-helper"));
+const i18n_1 = require("../i18n");
 /**
  *  Get the backend system service instance.
  *
@@ -13,4 +19,23 @@ async function getBackendSystemService() {
     });
     return backendService;
 }
+/**
+ * Fetch all backend systems.
+ *
+ * @param includeSensitiveData - whether to include sensitive data
+ * @returns backened systems
+ */
+async function getAllBackendSystems(includeSensitiveData = false) {
+    let backendSystems = [];
+    try {
+        const backendService = await getBackendSystemService();
+        backendSystems = await backendService.getAll({
+            includeSensitiveData
+        });
+    }
+    catch (error) {
+        logger_helper_1.default.logger.error((0, i18n_1.t)('errors.backendSystemRetrieval', { error: error.message }));
+    }
+    return backendSystems;
+}
 //# sourceMappingURL=store.js.map

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.11.5",
+  "version": "2.11.7",
   "repository": {
     "type": "git",
     "url": "https://github.com/SAP/open-ux-tools.git",
@@ -30,8 +30,8 @@
     "inquirer-autocomplete-prompt": "2.0.1",
     "os-name": "4.0.1",
     "@sap-ux/axios-extension": "1.24.2",
-    "@sap-ux/btp-utils": "1.1.5",
     "@sap-ux/fiori-generator-shared": "0.13.33",
+    "@sap-ux/btp-utils": "1.1.5",
     "@sap-ux/guided-answers-helper": "0.4.1",
     "@sap-ux/telemetry": "0.6.38",
     "@sap-ux/inquirer-common": "0.9.3",
@@ -49,11 +49,11 @@
     "@types/lodash": "4.14.202",
     "jest-extended": "6.0.0",
     "@sap-ux/fiori-generator-shared": "0.13.33",
-    "@sap-ux/fiori-elements-writer": "2.8.0",
-    "@sap-ux/fiori-freestyle-writer": "2.5.0",
-    "@sap-ux/feature-toggle": "0.3.4",
+    "@sap-ux/fiori-elements-writer": "2.8.3",
+    "@sap-ux/fiori-freestyle-writer": "2.5.1",
     "@sap-ux/odata-service-writer": "0.27.29",
-    "@sap-ux/cap-config-writer": "0.12.24"
+    "@sap-ux/cap-config-writer": "0.12.24",
+    "@sap-ux/feature-toggle": "0.3.4"
   },
   "engines": {
     "node": ">=20.x"