@sap-ux/odata-service-inquirer 2.10.0 → 2.11.1

package/README.md

@@ -1,4 +1,6 @@
-# @sap-ux/odata-service-inquirer
+[![Changelog](https://img.shields.io/badge/changelog-8A2BE2)](https://github.com/SAP/open-ux-tools/blob/main/packages/odata-service-inquirer/CHANGELOG.md) [![Github repo](https://img.shields.io/badge/github-repo-blue)](https://github.com/SAP/open-ux-tools/tree/main/packages/odata-service-inquirer)
+
+# [`@sap-ux/odata-service-inquirer`](https://github.com/SAP/open-ux-tools/tree/main/packages/odata-service-inquirer)
 
 Provides Inquirer based end-user prompting to allow selection of a service from multiple data source types. This involves acquiring a connection to backend systems and retrieving edmx metadata for services provided by the catalog, from a local file or CAP project. This module also provides prompts that may be used to gather user selections to define the main and navigation entities and related prompts relating to application layout and annotation generation when creating a UI5 application using the `@sap-ux/fiori-freestyle-writer` and `@sap-ux/fiori-elements-writer` modules.
 
@@ -81,4 +83,4 @@ Read [License](./LICENSE).
 SAP UI5 Application
 Inquirer
 Prompting
-Generator
+Generator

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

@@ -1,9 +1,10 @@
-import type { InputQuestion, PasswordQuestion } from '@sap-ux/inquirer-common';
+import type { InputQuestion, PasswordQuestion, ConfirmQuestion } from '@sap-ux/inquirer-common';
 import type { Answers } from 'inquirer';
 import type { ConnectionValidator } from '../../../connectionValidator';
 export declare enum BasicCredentialsPromptNames {
     systemUsername = "systemUsername",
-    systemPassword = "systemPassword"
+    systemPassword = "systemPassword",
+    storeSystemCredentials = "storeSystemCredentials"
 }
 /**
  * Re-usable credentials prompts for connection to systems using basic auth.
@@ -18,5 +19,5 @@ export declare enum BasicCredentialsPromptNames {
 export declare function getCredentialsPrompts<T extends Answers>(connectionValidator: ConnectionValidator, promptNamespace?: string, sapClient?: {
     sapClient: string | undefined;
     isValid: boolean;
-}): (InputQuestion<T> | PasswordQuestion<T>)[];
+}): (InputQuestion<T> | PasswordQuestion<T> | ConfirmQuestion<T>)[];
 //# sourceMappingURL=questions.d.ts.map

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

@@ -11,6 +11,7 @@ var BasicCredentialsPromptNames;
 (function (BasicCredentialsPromptNames) {
     BasicCredentialsPromptNames["systemUsername"] = "systemUsername";
     BasicCredentialsPromptNames["systemPassword"] = "systemPassword";
+    BasicCredentialsPromptNames["storeSystemCredentials"] = "storeSystemCredentials";
 })(BasicCredentialsPromptNames || (exports.BasicCredentialsPromptNames = BasicCredentialsPromptNames = {}));
 /**
  * Re-usable credentials prompts for connection to systems using basic auth.
@@ -25,9 +26,10 @@ var BasicCredentialsPromptNames;
 function getCredentialsPrompts(connectionValidator, promptNamespace, sapClient) {
     const usernamePromptName = `${promptNamespace ? promptNamespace + ':' : ''}${BasicCredentialsPromptNames.systemUsername}`;
     const passwordPromptName = `${promptNamespace ? promptNamespace + ':' : ''}${BasicCredentialsPromptNames.systemPassword}`;
+    const storeCredentialsPromptName = `${promptNamespace ? promptNamespace + ':' : ''}${BasicCredentialsPromptNames.storeSystemCredentials}`;
     // Optimization to prevent re-checking of auth
     let authRequired;
-    return [
+    const credentialsPrompts = [
         {
             when: async () => {
                 authRequired = await connectionValidator.isAuthRequired();
@@ -83,7 +85,7 @@ function getCredentialsPrompts(connectionValidator, promptNamespace, sapClient)
                     updatePromptStateWithConnectedSystem(connectionValidator.serviceProvider, selectedSystem, {
                         username: answers?.[usernamePromptName],
                         password: password
-                    });
+                    }); // Store credentials temporarily - will be conditionally kept/removed in store credentials prompt
                     return true;
                 }
                 return valResult;
@@ -100,9 +102,42 @@ function getCredentialsPrompts(connectionValidator, promptNamespace, sapClient)
                         severity: yeoman_ui_types_1.Severity.warning
                     };
                 }
+                // Lower priority than the cert error warning - we can only show one at a time, hence this should always be last
+                if (utils_1.PromptState.odataService.connectedSystem?.backendSystem) {
+                    return {
+                        message: (0, i18n_1.t)('texts.passwordStoreWarning'),
+                        severity: yeoman_ui_types_1.Severity.warning
+                    };
+                }
             }
         }
     ];
+    const confirmCredentialStoragePrompt = {
+        when: (answers) => !!(connectionValidator.systemAuthType === 'basic' &&
+            authRequired &&
+            connectionValidator.validity.authenticated &&
+            answers[passwordPromptName]),
+        type: 'confirm',
+        name: storeCredentialsPromptName,
+        message: (0, i18n_1.t)('prompts.storeSystemCredentials.message'),
+        default: false,
+        guiOptions: {
+            breadcrumb: (0, i18n_1.t)('prompts.storeSystemCredentials.breadcrumb')
+        },
+        validate: async (storeCredentials) => {
+            if (utils_1.PromptState.odataService.connectedSystem?.backendSystem) {
+                const backendSystem = utils_1.PromptState.odataService.connectedSystem.backendSystem;
+                utils_1.PromptState.odataService.connectedSystem.backendSystem = Object.assign(backendSystem, {
+                    newOrUpdated: storeCredentials
+                });
+            }
+            return true;
+        }
+    };
+    if (!(0, btp_utils_1.isAppStudio)()) {
+        credentialsPrompts.push(confirmCredentialStoragePrompt);
+    }
+    return credentialsPrompts;
 }
 /**
  * Updates the prompt state with the connected system.
@@ -120,13 +155,12 @@ function updatePromptStateWithConnectedSystem(serviceProvider, selectedSystem, {
     // Update the existing backend system with the new credentials that may be used to update in the store.
     if (selectedSystem?.type === 'backendSystem') {
         const backendSystem = selectedSystem.system;
-        // Have the credentials changed..
+        // Have the credentials changed..?
         if (backendSystem.username !== username || backendSystem.password !== password) {
             utils_1.PromptState.odataService.connectedSystem.backendSystem = Object.assign(backendSystem, {
                 username: username,
-                password,
-                userDisplayName: username,
-                newOrUpdated: true
+                password: password,
+                userDisplayName: username
             });
         }
         // If the connection is successful and a destination was selected, assign the connected destination to the prompt state.

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

@@ -7,6 +7,8 @@ import type { Answers } from 'inquirer';
 import type { ConnectedSystem } from '../../../../types';
 import type { ConnectionValidator } from '../../../connectionValidator';
 import { type NewSystemAnswers } from '../new-system/types';
+import type { SystemSelectionAnswers } from '../system-selection/questions';
+import type { AbapOnPremAnswers } from '../abap-on-prem/questions';
 /**
  * Get the system url prompt. The system url prompt is used to connect to a new system using the user input system url.
  *
@@ -27,5 +29,5 @@ export declare function getSystemUrlQuestion<T extends Answers>(connectValidator
  *     This prevents conflicts with other prompts of the same types where the same prompt is used by multiple other prompts but cannot share the name.
  * @returns the new system name prompt
  */
-export declare function getUserSystemNameQuestion(connectValidator: ConnectionValidator, promptNamespace?: string): InputQuestion<Partial<NewSystemAnswers>>;
+export declare function getUserSystemNameQuestion(connectValidator: ConnectionValidator, promptNamespace?: string): InputQuestion<Partial<NewSystemAnswers & AbapOnPremAnswers & SystemSelectionAnswers>>;
 //# sourceMappingURL=shared-prompts.d.ts.map

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

@@ -10,6 +10,7 @@ const types_2 = require("../new-system/types");
 const prompt_helpers_1 = require("../prompt-helpers");
 const validators_1 = require("../validators");
 const yeoman_ui_types_1 = require("@sap-devx/yeoman-ui-types");
+const questions_1 = require("../credentials/questions");
 /**
  * Convert the system connection scheme (Service Key, Rentrance Ticket, etc) to the store specific authentication type.
  * Note the absence of CF Discovery, in this case the service key file (UAA) is also used for the Abap connectivity.
@@ -129,7 +130,7 @@ function getUserSystemNameQuestion(connectValidator, promptNamespace) {
             }
             return defaultSystemName;
         },
-        validate: async (systemName) => {
+        validate: async (systemName, previousAnswers) => {
             if (!systemName) {
                 return false;
             }
@@ -143,6 +144,7 @@ function getUserSystemNameQuestion(connectValidator, promptNamespace) {
                 defaultSystemName = systemName;
                 isValid = await (0, validators_1.validateSystemName)(systemName);
             }
+            const shouldStoreCreds = !!previousAnswers?.[`${promptNamespacePart}${questions_1.BasicCredentialsPromptNames.storeSystemCredentials}`];
             if (isValid === true) {
                 // Update or create the BackendSystem with the new system details for persistent storage
                 if (connectValidator.validatedUrl && utils_1.PromptState.odataService.connectedSystem) {
@@ -151,8 +153,8 @@ function getUserSystemNameQuestion(connectValidator, promptNamespace) {
                         name: systemName,
                         url: connectValidator.validatedUrl,
                         client: connectValidator.validatedClient,
-                        username: connectValidator.axiosConfig?.auth?.username,
-                        password: connectValidator.axiosConfig?.auth?.password,
+                        username: shouldStoreCreds ? connectValidator.axiosConfig?.auth?.username : undefined,
+                        password: shouldStoreCreds ? connectValidator.axiosConfig?.auth?.password : undefined,
                         serviceKeys: connectValidator.serviceInfo, // This will not be persisted and is only used to determine cached connection equality for CF provided uaa keys
                         userDisplayName: connectValidator.connectedUserName,
                         systemType: (0, store_1.getBackendSystemType)({

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

@@ -125,7 +125,6 @@ async function getSystemConnectionQuestions(connectionValidator, promptOptions,
                 return (validateSystemSelection(selectedSystemAnswer, connectionValidator, requiredOdataVersion, cachedConnectedSystem) ?? false);
             },
             additionalMessages: async (selectedSystem) => {
-                // Backend systems credentials may need to be updated
                 if (selectedSystem.type === 'backendSystem' &&
                     connectionValidator.systemAuthType === 'basic' &&
                     (await connectionValidator.isAuthRequired())) {

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

@@ -84,6 +84,10 @@
         "systemPassword": {
             "message": "Password"
         },
+        "storeSystemCredentials": {
+            "message": "Do you want to store the system credentials?",
+            "breadcrumb": "Store Credentials"
+        },
         "systemService": {
             "message": "Service",
             "breadcrumb": "Service",
@@ -257,6 +261,7 @@
         "forUserName": "(for user [{{username}}])",
         "httpStatus": "HTTP Status {{httpStatus}}",
         "checkDestinationAuthConfig": "Please check the SAP BTP destination authentication configuration.",
-        "choiceNameNone": "None"
+        "choiceNameNone": "None",
+        "passwordStoreWarning": "Passwords are stored in your operating system's credential manager and are protected by its security policies."
     }
 }

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.10.0",
+  "version": "2.11.1",
   "repository": {
     "type": "git",
     "url": "https://github.com/SAP/open-ux-tools.git",
@@ -29,17 +29,17 @@
     "i18next": "25.3.0",
     "inquirer-autocomplete-prompt": "2.0.1",
     "os-name": "4.0.1",
-    "@sap-ux/axios-extension": "1.24.1",
-    "@sap-ux/btp-utils": "1.1.4",
-    "@sap-ux/fiori-generator-shared": "0.13.31",
-    "@sap-ux/guided-answers-helper": "0.4.0",
-    "@sap-ux/telemetry": "0.6.36",
-    "@sap-ux/inquirer-common": "0.9.0",
-    "@sap-ux/logger": "0.7.0",
-    "@sap-ux/nodejs-utils": "0.2.7",
-    "@sap-ux/project-access": "1.32.7",
-    "@sap-ux/project-input-validator": "0.6.29",
-    "@sap-ux/store": "1.3.2"
+    "@sap-ux/axios-extension": "1.24.2",
+    "@sap-ux/btp-utils": "1.1.5",
+    "@sap-ux/fiori-generator-shared": "0.13.32",
+    "@sap-ux/guided-answers-helper": "0.4.1",
+    "@sap-ux/telemetry": "0.6.37",
+    "@sap-ux/inquirer-common": "0.9.1",
+    "@sap-ux/logger": "0.7.1",
+    "@sap-ux/nodejs-utils": "0.2.8",
+    "@sap-ux/project-access": "1.32.8",
+    "@sap-ux/project-input-validator": "0.6.30",
+    "@sap-ux/store": "1.3.3"
   },
   "devDependencies": {
     "@sap-ux/vocabularies-types": "0.13.0",
@@ -48,12 +48,12 @@
     "@types/inquirer": "8.2.6",
     "@types/lodash": "4.14.202",
     "jest-extended": "6.0.0",
-    "@sap-ux/fiori-generator-shared": "0.13.31",
-    "@sap-ux/fiori-elements-writer": "2.7.34",
-    "@sap-ux/fiori-freestyle-writer": "2.4.59",
-    "@sap-ux/feature-toggle": "0.3.3",
-    "@sap-ux/odata-service-writer": "0.27.28",
-    "@sap-ux/cap-config-writer": "0.12.22"
+    "@sap-ux/fiori-generator-shared": "0.13.32",
+    "@sap-ux/fiori-elements-writer": "2.7.36",
+    "@sap-ux/fiori-freestyle-writer": "2.4.60",
+    "@sap-ux/feature-toggle": "0.3.4",
+    "@sap-ux/odata-service-writer": "0.27.29",
+    "@sap-ux/cap-config-writer": "0.12.23"
   },
   "engines": {
     "node": ">=20.x"