@sap-ux/odata-service-inquirer 0.4.9 → 0.5.0

package/dist/prompts/datasources/service-url/questions.js

@@ -9,7 +9,7 @@ const i18n_1 = require("../../../i18n");
 const types_1 = require("../../../types");
 const utils_1 = require("../../../utils");
 const logger_helper_1 = __importDefault(require("../../logger-helper"));
-const connectionValidator_1 = require("./connectionValidator");
+const connectionValidator_1 = require("../../connectionValidator");
 const types_2 = require("./types");
 const validators_1 = require("./validators");
 /**
@@ -71,7 +71,10 @@ function getIgnoreCertErrorsPrompt(connectValidator, requiredVersion) {
             if (ignoreCertError) {
                 logger_helper_1.default.logger.warn((0, i18n_1.t)('prompts.validationMessages.warningCertificateValidationDisabled'));
             }
-            const validUrl = await connectValidator.validateUrl(serviceUrl, ignoreCertError, true);
+            const validUrl = await connectValidator.validateUrl(serviceUrl, {
+                ignoreCertError,
+                forceReValidation: true
+            });
             if (validUrl === true) {
                 if (!connectValidator.validity.authRequired) {
                     return (0, validators_1.validateService)(serviceUrl, connectValidator, requiredVersion, ignoreCertError);
@@ -103,7 +106,10 @@ function getCliIgnoreCertValidatePrompt(connectValidator, requiredVersion) {
                 // If the user choose to ignore cert errors, we need to re-validate
                 logger_helper_1.default.logger.warn((0, i18n_1.t)('prompts.validationMessages.warningCertificateValidationDisabled'));
                 // Re-check if auth required as the cert error would have prevented this check earlier
-                const validUrl = await connectValidator.validateUrl(serviceUrl, ignoreCertError, true);
+                const validUrl = await connectValidator.validateUrl(serviceUrl, {
+                    ignoreCertError,
+                    forceReValidation: true
+                });
                 if (validUrl !== true) {
                     throw new Error(validUrl.toString()); // exit
                 }
@@ -157,11 +163,14 @@ function getPasswordPrompt(connectValidator, requiredVersion) {
         message: (0, i18n_1.t)('prompts.servicePassword.message'),
         guiType: 'login',
         mask: '*',
-        validate: async (password, { username, serviceUrl, ignoreCertError }) => {
+        validate: async (password, { username, serviceUrl, ignoreCertError, sapClient }) => {
             if (!serviceUrl || !username || !password) {
                 return false;
             }
-            const validAuth = await connectValidator.validateAuth(serviceUrl, username, password, ignoreCertError);
+            const validAuth = await connectValidator.validateAuth(serviceUrl, username, password, {
+                ignoreCertError,
+                sapClient
+            });
             if (validAuth === true) {
                 return (0, validators_1.validateService)(serviceUrl, connectValidator, requiredVersion, ignoreCertError);
             }

package/dist/prompts/datasources/service-url/validators.d.ts

@@ -1,7 +1,7 @@
 import { type AxiosRequestConfig, type ODataService } from '@sap-ux/axios-extension';
 import type { OdataVersion } from '@sap-ux/odata-service-writer';
 /**
- * Validates that a service specified by the odata service is accessible, has the required version and returns valid metadata.
+ * Validates that a service specified by the service url is accessible, has the required version and returns valid metadata.
  * Retrieves annotations (from Abap backends) if available and stores them in the PromptState.
  *
  * @param url the full odata service url including query parameters

package/dist/prompts/datasources/service-url/validators.js

@@ -11,9 +11,9 @@ const types_1 = require("../../../types");
 const utils_1 = require("../../../utils");
 const logger_helper_1 = __importDefault(require("../../logger-helper"));
 const prompt_helpers_1 = require("../../prompt-helpers");
-const connectionValidator_1 = require("./connectionValidator");
+const connectionValidator_1 = require("../../connectionValidator");
 /**
- * Validates that a service specified by the odata service is accessible, has the required version and returns valid metadata.
+ * Validates that a service specified by the service url is accessible, has the required version and returns valid metadata.
  * Retrieves annotations (from Abap backends) if available and stores them in the PromptState.
  *
  * @param url the full odata service url including query parameters

package/dist/prompts/logger-helper.js

@@ -54,17 +54,18 @@ class LoggerHelper {
      * @param interceptors.response the axios response interceptor
      */
     static attachAxiosLogger(interceptors) {
+        const debugLogger = LoggerHelper.logger.debug.bind(LoggerHelper.logger);
         interceptors.request.use((request) => {
             return AxiosLogger.requestLogger(request, {
                 url: true,
                 data: true,
                 prefixText: '@sap-ux/odata-service-inquirer',
                 headers: true,
-                logger: LoggerHelper.logger.debug.bind(this)
+                logger: debugLogger
             });
         }, (error) => {
             return AxiosLogger.errorLogger(error, {
-                logger: LoggerHelper.logger.debug
+                logger: debugLogger
             });
         });
         interceptors.response.use((response) => {
@@ -73,11 +74,11 @@ class LoggerHelper {
                 prefixText: '@sap-ux/odata-service-inquirer',
                 status: true,
                 headers: true,
-                logger: LoggerHelper.logger.debug
+                logger: debugLogger
             });
         }, (err) => {
             return AxiosLogger.errorLogger(err, {
-                logger: LoggerHelper.logger.debug
+                logger: debugLogger
             });
         });
     }

package/dist/prompts/prompts.js

@@ -8,11 +8,13 @@ const yeoman_ui_types_1 = require("@sap-devx/yeoman-ui-types");
 const inquirer_common_1 = require("@sap-ux/inquirer-common");
 const i18n_1 = require("../i18n");
 const types_1 = require("../types");
-const metadata_file_1 = require("./datasources/metadata-file");
-const prompt_helpers_1 = require("./prompt-helpers");
 const questions_1 = require("./datasources/cap-project/questions");
+const metadata_file_1 = require("./datasources/metadata-file");
+const questions_2 = require("./datasources/sap-system/abap-on-prem/questions");
+const questions_3 = require("./datasources/sap-system/new-system/questions");
+const questions_4 = require("./datasources/service-url/questions");
 const logger_helper_1 = __importDefault(require("./logger-helper"));
-const questions_2 = require("./datasources/service-url/questions");
+const prompt_helpers_1 = require("./prompt-helpers");
 /**
  * Get the prompts for the OData service inquirer.
  *
@@ -77,7 +79,11 @@ async function getDatasourceTypeConditionalQuestions(promptOptions) {
     const conditionalQuestions = [];
     conditionalQuestions.push(...(0, inquirer_common_1.withCondition)([(0, metadata_file_1.getMetadataFileQuestion)(promptOptions?.metadataFilePath)], (answers) => answers.datasourceType === types_1.DatasourceType.metadataFile));
     conditionalQuestions.push(...(0, inquirer_common_1.withCondition)((0, questions_1.getLocalCapProjectPrompts)(promptOptions), (answers) => answers.datasourceType === types_1.DatasourceType.capProject));
-    conditionalQuestions.push(...(0, inquirer_common_1.withCondition)((0, questions_2.getServiceUrlQuestions)(promptOptions), (answers) => answers.datasourceType === types_1.DatasourceType.odataServiceUrl));
+    conditionalQuestions.push(...(0, inquirer_common_1.withCondition)((0, questions_4.getServiceUrlQuestions)(promptOptions), (answers) => answers.datasourceType === types_1.DatasourceType.odataServiceUrl));
+    // Temp integration into Service Inquirer new system questions
+    conditionalQuestions.push(...(0, inquirer_common_1.withCondition)((0, questions_2.getAbapOnPremQuestions)(promptOptions), (answers) => answers.datasourceType === types_1.DatasourceType.sapSystem &&
+        answers.system === questions_3.newSystemChoiceValue &&
+        answers.newSystemType === 'abapOnPrem'));
     //...further data sources to be added here
     return conditionalQuestions;
 }

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

@@ -60,7 +60,46 @@
             "warningCertificateValidationDisabled": "User has disabled certificate validation",
             "annotationsNotFound": "Annotations not found for specified service"
         },
-        "nonUIServiceTypeWarningMessage": "Please note that {{serviceTypeDesc}} services are not intended to be used for the generation of SAP Fiori UI applications"
+        "warnings": {
+            "nonUIServiceTypeWarningMessage": "Please note that {{serviceType}} 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"
+        },
+        "systemUrl": {
+            "message": "System URL",
+            "description": "Enter the URL of the SAP System",
+            "placeholder": "https://<host>:<port>"
+        },
+        "sapClient": {
+            "message": "SAP client (leave empty for default)",
+            "breadcrumb": "SAP Client"
+        },
+        "systemUsername": {
+            "message": "Username"
+        },
+        "systemPassword": {
+            "message": "Password"
+        },
+        "systemService": {
+            "message": "Service name",
+            "breadcrumb": "Service",
+            "noServicesWarning": "No services available for the selected system, see logs for further details."
+        },
+        "systemType": {
+            "choiceAbapOnPrem": "ABAP On Premise",
+            "choiceAbapOnBtp": "ABAP Environment on SAP Business Technology Platform",
+            "message": "System type",
+            "notYetImplementedWarningMessage": "The selected system type: {{ systemType }} is not yet implemented."
+        },
+        "systemName": {
+            "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."
+        },
+        "systemSelection": {
+            "newSystemChoiceLabel": "New system"
+        }
     },
     "errors": {
         "cannotReadCapServiceMetadata": "An error occurred reading CAP service metadata: {{serviceName}}. See log for more details.",
@@ -92,13 +131,19 @@
         "serviceUrlNotFound": "Please verify the service 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}}"
+        "exitingGeneration": "Exiting generation. {{exitReason}}",
+        "serviceMetadataError": "An error occurred reading service metadata for service: {{- servicePath}}",
+        "serviceMetadataErrorUI": "$t(errors.serviceMetadataError, {\"servicePath\": \"{{- servicePath}}\" }). $t(texts.seeLogForDetails)",
+        "serviceMetadataErrorLog": "$t(errors.serviceMetadataError, {\"servicePath\": \"{{- servicePath}}\" }). {{error}}",
+        "serviceTypeRequestError": "Error retrieving service type: {{- error}}"
     },
     "texts": {
         "anExpiredCert": "an expired",
         "aSelfSignedCert": "a self-signed",
         "anUnknownOrInvalidCert": "an unknown or invalid",
-        "anUntrustedRootCert": "an untrusted root"
+        "anUntrustedRootCert": "an untrusted root",
+        "suggestedSystemNameClient": ", client {{client}}",
+        "seeLogForDetails": "See log for more details."
     },
     "guidedAnswers": {
         "validationErrorHelpText": "Need help with this error?"

package/dist/types.d.ts

@@ -1,9 +1,10 @@
 import type { IValidationLink } from '@sap-devx/yeoman-ui-types';
-import type { Annotations } from '@sap-ux/axios-extension';
+import type { Annotations, ServiceProvider } from '@sap-ux/axios-extension';
 import type { CommonPromptOptions, YUIQuestion } from '@sap-ux/inquirer-common';
 import type { OdataVersion } from '@sap-ux/odata-service-writer';
 import type { CdsVersionInfo } from '@sap-ux/project-access';
 import type { ListChoiceOptions } from 'inquirer';
+import type { BackendSystem } from '../../store/src';
 /**
  * This file contains types that are exported by the module and are needed for consumers using the APIs `prompt` and `getPrompts`.
  */
@@ -16,6 +17,7 @@ export declare enum DatasourceType {
     metadataFile = "metadataFile",
     projectSpecificDestination = "projectSpecificDestination"
 }
+export type SapSystemType = 'abapOnPrem' | 'abapOnBtp';
 /**
  * Answers returned by the OdataServiceInquirer prompt API.
  * These values may be used to write an OData service and may be derived from the user's input rather than direct answers.
@@ -53,18 +55,24 @@ export interface OdataServiceAnswers {
      * The 'sap-client' value for the service.
      */
     sapClient?: string;
-    /**
-     * User name for the service where basic authentication is required.
-     */
-    username?: string;
-    /**
-     * Password for the service where basic authentication is required.
-     */
-    password?: string;
     /**
      * Metadata file path
      */
     metadataFilePath?: string;
+    /**
+     * The connected system will allow downstream consumers to access the connected system without creating new connections.
+     *
+     */
+    connectedSystem?: {
+        /**
+         * Convienence property to pass the connected system
+         */
+        serviceProvider: ServiceProvider;
+        /**
+         * The persistable backend system representation of the connected service provider
+         */
+        backendSystem?: BackendSystem;
+    };
 }
 /**
  * Enumeration of prompt names used by OdataServiceInquirerPromptOptions
@@ -93,7 +101,15 @@ export declare enum promptNames {
     /**
      * password
      */
-    serviceUrlPassword = "serviceUrlPassword"
+    serviceUrlPassword = "serviceUrlPassword",
+    /**
+     * Service selection
+     */
+    serviceSelection = "serviceSelection",
+    /**
+     * Newly created systems can be named for storage
+     */
+    userSystemName = "userSystemName"
 }
 export type CapRuntime = 'Node.js' | 'Java';
 export interface CapService {
@@ -166,6 +182,24 @@ export type MetadataPromptOptions = {
      */
     requiredOdataVersion?: OdataVersion;
 };
+export type ServiceSelectionPromptOptions = {
+    /**
+     * Determines if the service selection prompt should use auto complete prompt for service names.
+     * Note that the auto-complete module must be registered with the inquirer instance to use this feature.
+     */
+    useAutoComplete?: boolean;
+    /**
+     * Used to validate the selected service is of the required odata version
+     */
+    requiredOdataVersion?: OdataVersion;
+} & Pick<CommonPromptOptions, 'additionalMessages'>;
+export type SystemNamePromptOptions = {
+    /**
+     * This option allows the prompt to be excluded where later storage of the system with the provided name is not required.
+     * If this propmt is not included then a BackendSystem will not be returned for the connected system.
+     */
+    exclude?: boolean;
+};
 export type OdataServiceUrlPromptOptions = {
     /**
      * Used to validate the service specified by the url is of the required odata version edmx
@@ -176,7 +210,7 @@ export type OdataServiceUrlPasswordOptions = Pick<CommonPromptOptions, 'addition
 /**
  * Provide the correct type checking for prompt options
  */
-type odataServiceInquirerPromptOptions = Record<promptNames.datasourceType, DatasourceTypePromptOptions> & Record<promptNames.metadataFilePath, MetadataPromptOptions> & Record<promptNames.capProject, CapProjectPromptOptions> & Record<promptNames.capService, CapServicePromptOptions> & Record<promptNames.serviceUrl, OdataServiceUrlPromptOptions> & Record<promptNames.serviceUrlPassword, OdataServiceUrlPasswordOptions>;
+type odataServiceInquirerPromptOptions = Record<promptNames.datasourceType, DatasourceTypePromptOptions> & Record<promptNames.metadataFilePath, MetadataPromptOptions> & Record<promptNames.capProject, CapProjectPromptOptions> & Record<promptNames.capService, CapServicePromptOptions> & Record<promptNames.serviceUrl, OdataServiceUrlPromptOptions> & Record<promptNames.serviceUrlPassword, OdataServiceUrlPasswordOptions> & Record<promptNames.serviceSelection, ServiceSelectionPromptOptions> & Record<promptNames.userSystemName, SystemNamePromptOptions>;
 export type OdataServiceQuestion = YUIQuestion<OdataServiceAnswers>;
 export type OdataServicePromptOptions = Partial<odataServiceInquirerPromptOptions>;
 /**

package/dist/types.js

@@ -43,6 +43,14 @@ var promptNames;
      * password
      */
     promptNames["serviceUrlPassword"] = "serviceUrlPassword";
+    /**
+     * Service selection
+     */
+    promptNames["serviceSelection"] = "serviceSelection";
+    /**
+     * Newly created systems can be named for storage
+     */
+    promptNames["userSystemName"] = "userSystemName";
 })(promptNames || (exports.promptNames = promptNames = {}));
 /**
  * Implementation of IValidationLink interface.

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.4.9",
+  "version": "0.5.0",
   "repository": {
     "type": "git",
     "url": "https://github.com/SAP/open-ux-tools.git",
@@ -23,13 +23,16 @@
     "axios-logger": "2.8.0",
     "fast-xml-parser": "4.2.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/btp-utils": "0.15.0",
     "@sap-ux/telemetry": "0.5.7",
-    "@sap-ux/inquirer-common": "0.4.0",
+    "@sap-ux/inquirer-common": "0.4.1",
     "@sap-ux/logger": "0.6.0",
-    "@sap-ux/project-access": "1.25.5"
+    "@sap-ux/project-access": "1.25.5",
+    "@sap-ux/project-input-validator": "0.3.1",
+    "@sap-ux/store": "0.7.0"
   },
   "devDependencies": {
     "@sap-devx/yeoman-ui-types": "1.14.4",

package/dist/prompts/datasources/service-url/connectionValidator.d.ts

@@ -1,99 +0,0 @@
-import type { IValidationLink } from '@sap-devx/yeoman-ui-types';
-import type { AxiosRequestConfig, ODataService } from '@sap-ux/axios-extension';
-/**
- * Structure to store validity information about url to be validated.
- */
-interface Validity {
-    urlFormat?: boolean;
-    reachable?: boolean;
-    authRequired?: boolean;
-    authenticated?: boolean;
-    canSkipCertError?: boolean;
-}
-/**
- * Class that validates the connection to a service url or catalog url.
- * This will determine if authentication is required and if the service/catalog is reachable, generating messages to guide the user.
- * It is optimized for re-validation of the same url, so that the validation is not repeated if not required.
- *
- */
-export declare class ConnectionValidator {
-    readonly validity: Validity;
-    private _validatedUrl;
-    private _odataService;
-    private _axiosConfig;
-    /**
-     * Getter for the axios configuration.
-     *
-     * @returns the axios configuration
-     */
-    get axiosConfig(): AxiosRequestConfig;
-    /**
-     * Get the odata service instance.
-     *
-     * @returns the odata service instance
-     */
-    get odataService(): ODataService;
-    /**
-     * Calls a given service url to test its reachability and authentication requirements.
-     *
-     * @param url a service url (<protocol://<host>:<port>/<service-path>)
-     * @param username optional username
-     * @param password optional password
-     * @param [ignoreCertError] optional, ignore some certificate errors
-     * @returns the status code or error returned by the connection attempt
-     */
-    private checkSapService;
-    /**
-     * Validates the service url format as well as its reachability.
-     *
-     * @param serviceUrl the odata service url to validate
-     * @param ignoreCertError ignore some certificate errors
-     * @param forceReValidation force re-validation of the url
-     * @returns true if the url is reachable, false if not, or an error message string
-     */
-    validateUrl(serviceUrl: string, ignoreCertError?: boolean, forceReValidation?: boolean): Promise<boolean | string | IValidationLink>;
-    /**
-     * Translate the status code into a validation result.
-     * Sets the instance validity state based on the status code.
-     *
-     * @param status a http request status code used to determine the validation result
-     * @returns
-     */
-    private getValidationResultFromStatusCode;
-    /**
-     * Is a string nil or whitespace only.
-     *
-     * @param url the string to test
-     * @returns true if the string is nil or whitespace
-     */
-    private isEmptyString;
-    /**
-     * Tests if the url has already been validated.
-     *
-     * @param url the full url to test for previous validation
-     * @returns true if the url has already been validated
-     */
-    private isUrlValidated;
-    /**
-     * Test the connectivity with the specified service url using the provided credentials.
-     *
-     * @param serviceUrl optional, the service url to validate
-     * @param username user name
-     * @param password password
-     * @param ignoreCertError optional, ignore some certificate errors
-     * @returns true if the authentication is successful, false if not, or an error message string
-     */
-    validateAuth(serviceUrl: string, username: string, password: string, ignoreCertError?: boolean): Promise<boolean | string>;
-    /**
-     * Reset the validity state.
-     */
-    private resetValidity;
-    /**
-     * Set the rejectUnauthorized option of the global https agent.
-     *
-     * @param rejectUnauthorized - true to reject unauthorized certificates, false to accept them
-     */
-    static setGlobalRejectUnauthorized(rejectUnauthorized: boolean): void;
-}
-export {};
-//# sourceMappingURL=connectionValidator.d.ts.map