@sap-ux/odata-service-inquirer 0.5.27 → 0.5.29

package/dist/error-handler/error-handler.d.ts

@@ -123,8 +123,8 @@ export declare class ErrorHandler {
      * Used by validate functions to report in-line user friendly errors.
      * Checks if there is an existing error.
      *
-     * @param error optional, if provided get the end user message that it maps to, otherwise get the previous error message
-     * @param reset optional, resets the previous error state if true
+     * @param error optional, if provided get the end user message that it maps to, otherwise get the previous error message, if a boolean is passed it will be interpreted as `reset`.
+     * @param reset optional, resets the previous error state if true, if error is omitted reset may be passed as the first argument
      * @param fallback optional, return the message of the specified ERROR_TYPE if no previous end user message and no error specified
      * @returns The error message
      */

package/dist/error-handler/error-handler.js

@@ -314,21 +314,21 @@ class ErrorHandler {
      * Used by validate functions to report in-line user friendly errors.
      * Checks if there is an existing error.
      *
-     * @param error optional, if provided get the end user message that it maps to, otherwise get the previous error message
-     * @param reset optional, resets the previous error state if true
+     * @param error optional, if provided get the end user message that it maps to, otherwise get the previous error message, if a boolean is passed it will be interpreted as `reset`.
+     * @param reset optional, resets the previous error state if true, if error is omitted reset may be passed as the first argument
      * @param fallback optional, return the message of the specified ERROR_TYPE if no previous end user message and no error specified
      * @returns The error message
      */
     getErrorMsg(error, reset, fallback) {
         let errorMsg;
-        if (error) {
+        if (error && typeof error !== 'boolean') {
             errorMsg = ErrorHandler.mapErrorToMsg(error).errorMsg;
         }
         // Get previous error message
         if (!errorMsg) {
             errorMsg = this.currentErrorMsg ?? (fallback ? ErrorHandler.getErrorMsgFromType(fallback) : undefined);
         }
-        if (reset) {
+        if (error === true || reset) {
             this.currentErrorMsg = null;
             this.currentErrorType = null;
         }

package/dist/index.d.ts

@@ -2,11 +2,9 @@ import { type InquirerAdapter } from '@sap-ux/inquirer-common';
 import { type Logger } from '@sap-ux/logger';
 import { OdataVersion } from '@sap-ux/odata-service-writer';
 import { type ToolsSuiteTelemetryClient } from '@sap-ux/telemetry';
-import type { Question } from 'inquirer';
 import { ERROR_TYPE, ErrorHandler } from './error-handler/error-handler';
-import type { AbapOnPremAnswers } from './prompts/datasources/sap-system/abap-on-prem/questions';
 import { newSystemChoiceValue } from './prompts/datasources/sap-system/new-system/questions';
-import { DatasourceType, promptNames, type CapRuntime, type CapService, type OdataServiceAnswers, type OdataServicePromptOptions, type OdataServiceQuestion, type SapSystemType, type SystemNamePromptOptions } from './types';
+import { DatasourceType, promptNames, type CapRuntime, type CapService, type OdataServiceAnswers, type OdataServicePromptOptions, type OdataServiceQuestion, type SapSystemType } from './types';
 /**
  * Get the inquirer prompts for odata service.
  *
@@ -33,13 +31,5 @@ declare function getPrompts(promptOptions?: OdataServicePromptOptions, logger?:
  * @returns the prompt answers
  */
 declare function prompt(adapter: InquirerAdapter, promptOptions?: OdataServicePromptOptions, logger?: Logger, enableGuidedAnswers?: boolean, telemetryClient?: ToolsSuiteTelemetryClient, isYUI?: boolean): Promise<OdataServiceAnswers>;
-/**
- * Get the prompts for an abap on premise system. This can be used to create a new system connection.
- *
- * @param systemNamePromptOptions options for the system name prompt see {@link SystemNamePromptOptions}
- * @param logger a logger compatible with the {@link Logger} interface
- * @returns questions for creating a new abap on prem system connection
- */
-declare function getAbapOnPremSystemPrompts(systemNamePromptOptions: SystemNamePromptOptions, logger?: Logger): Promise<Question<AbapOnPremAnswers>[]>;
-export { DatasourceType, OdataVersion, getAbapOnPremSystemPrompts, getPrompts, prompt, promptNames, type CapRuntime, type CapService, type InquirerAdapter, type OdataServiceAnswers, type OdataServicePromptOptions, type SapSystemType, newSystemChoiceValue, ERROR_TYPE, ErrorHandler };
+export { DatasourceType, ERROR_TYPE, ErrorHandler, OdataVersion, getPrompts, newSystemChoiceValue, prompt, promptNames, type CapRuntime, type CapService, type InquirerAdapter, type OdataServiceAnswers, type OdataServicePromptOptions, type SapSystemType };
 //# sourceMappingURL=index.d.ts.map

package/dist/index.js

@@ -3,7 +3,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ErrorHandler = exports.ERROR_TYPE = exports.newSystemChoiceValue = exports.promptNames = exports.prompt = exports.getPrompts = exports.getAbapOnPremSystemPrompts = exports.OdataVersion = exports.DatasourceType = void 0;
+exports.promptNames = exports.prompt = exports.newSystemChoiceValue = exports.getPrompts = exports.OdataVersion = exports.ErrorHandler = exports.ERROR_TYPE = exports.DatasourceType = void 0;
 const odata_service_writer_1 = require("@sap-ux/odata-service-writer");
 Object.defineProperty(exports, "OdataVersion", { enumerable: true, get: function () { return odata_service_writer_1.OdataVersion; } });
 const inquirer_autocomplete_prompt_1 = __importDefault(require("inquirer-autocomplete-prompt"));
@@ -12,9 +12,8 @@ Object.defineProperty(exports, "ERROR_TYPE", { enumerable: true, get: function (
 Object.defineProperty(exports, "ErrorHandler", { enumerable: true, get: function () { return error_handler_1.ErrorHandler; } });
 const i18n_1 = require("./i18n");
 const prompts_1 = require("./prompts");
-const questions_1 = require("./prompts/datasources/sap-system/abap-on-prem/questions");
-const questions_2 = require("./prompts/datasources/sap-system/new-system/questions");
-Object.defineProperty(exports, "newSystemChoiceValue", { enumerable: true, get: function () { return questions_2.newSystemChoiceValue; } });
+const questions_1 = require("./prompts/datasources/sap-system/new-system/questions");
+Object.defineProperty(exports, "newSystemChoiceValue", { enumerable: true, get: function () { return questions_1.newSystemChoiceValue; } });
 const logger_helper_1 = __importDefault(require("./prompts/logger-helper"));
 const types_1 = require("./types");
 Object.defineProperty(exports, "DatasourceType", { enumerable: true, get: function () { return types_1.DatasourceType; } });
@@ -71,20 +70,4 @@ async function prompt(adapter, promptOptions, logger, enableGuidedAnswers, telem
     return answers;
 }
 exports.prompt = prompt;
-/**
- * Get the prompts for an abap on premise system. This can be used to create a new system connection.
- *
- * @param systemNamePromptOptions options for the system name prompt see {@link SystemNamePromptOptions}
- * @param logger a logger compatible with the {@link Logger} interface
- * @returns questions for creating a new abap on prem system connection
- */
-async function getAbapOnPremSystemPrompts(systemNamePromptOptions, logger) {
-    if (logger) {
-        logger_helper_1.default.logger = logger;
-    }
-    // prompt texts must be loaded before the prompts are created, wait for the i18n bundle to be initialized
-    await (0, i18n_1.initI18nOdataServiceInquirer)();
-    return (0, questions_1.getAbapOnPremSystemQuestions)(systemNamePromptOptions);
-}
-exports.getAbapOnPremSystemPrompts = getAbapOnPremSystemPrompts;
 //# sourceMappingURL=index.js.map

package/dist/prompts/connectionValidator.d.ts

@@ -1,5 +1,5 @@
 import type { IValidationLink } from '@sap-devx/yeoman-ui-types';
-import type { AxiosRequestConfig, CatalogService, ODataService, ServiceProvider } from '@sap-ux/axios-extension';
+import type { AxiosRequestConfig, CatalogService, ODataService, ServiceInfo, ServiceProvider } from '@sap-ux/axios-extension';
 import { ODataVersion } from '@sap-ux/axios-extension';
 /**
  * Structure to store validity information about url to be validated.
@@ -12,11 +12,13 @@ interface Validity {
     canSkipCertError?: boolean;
 }
 type ValidationResult = string | boolean | IValidationLink;
+export type SystemAuthType = 'serviceKey' | 'reentranceTicket' | 'basic' | 'unknown';
 /**
- * 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.
- *
+ * Class that can be used to determine the connectivity using a service url, system url, or service info (UAA Key details) or reentrance ticket.
+ * This will determine if if the service/catalog is reachable, authentication is required and generates ting messages to guide the user.
+ * Certain types of certificate errors can be ignored if required. However, the end-user should be warned about the risks using a prompt message.
+ * Catalog requests may be made multiple times for the same url, but the underlying connectivity module (@sap-ux/axios-extension) will cache the results to avoid repeated network requests.
+ * The class also stores the current connection state, including the service provider, odata service, and catalog services.
  */
 export declare class ConnectionValidator {
     readonly validity: Validity;
@@ -27,29 +29,87 @@ export declare class ConnectionValidator {
     private _axiosConfig;
     private _catalogV2;
     private _catalogV4;
+    private _systemAuthType;
+    private _serviceInfo;
+    private _connectedUserName;
+    private _connectedSystemName;
+    private _refreshToken;
     /**
      * Getter for the axios configuration.
      *
      * @returns the axios configuration
      */
-    get axiosConfig(): AxiosRequestConfig;
+    get axiosConfig(): AxiosRequestConfig | undefined;
     /**
      * Get the odata service instance.
      *
      * @returns the odata service instance
      */
-    get odataService(): ODataService;
+    get odataService(): ODataService | undefined;
     /**
      * Get the catalogs for the odata versions. Note that one of these may not be defined where a specific odata version is required.
      *
      * @returns the catalog services for each the odata versions
      */
-    get catalogs(): Record<ODataVersion, CatalogService>;
+    get catalogs(): Record<ODataVersion, CatalogService | undefined>;
     /**
      *
      * @returns the current connections service provider
      */
-    get serviceProvider(): ServiceProvider;
+    get serviceProvider(): ServiceProvider | undefined;
+    /**
+     * The auth type used to create an authenticated connection to the system.
+     *
+     * @returns the system auth type
+     */
+    get systemAuthType(): SystemAuthType | undefined;
+    /**
+     * The auth type used to create an authenticated connection to the system.
+     *
+     * @param value the system auth type
+     */
+    set systemAuthType(value: SystemAuthType);
+    /**
+     * Get the validated url. This is the url that has been successfully validated (not necessarily connected). Use validity to check if the url is reachable.
+     *
+     * @returns the validated url
+     */
+    get validatedUrl(): string | undefined;
+    /**
+     * Get the service info used to connect to the system.
+     *
+     * @returns the service info
+     */
+    get serviceInfo(): ServiceInfo | undefined;
+    /**
+     * Set the service info used to connect to the system.
+     *
+     * @param serviceInfo the service info
+     */
+    set serviceInfo(serviceInfo: ServiceInfo);
+    /**
+     * Get the connected user name.
+     *
+     * @returns the connected user name
+     */
+    get connectedUserName(): string | undefined;
+    /**
+     * Get the refresh token.
+     *
+     * @returns the refresh token
+     */
+    get refreshToken(): string | undefined;
+    /**
+     * Get the connected system name. If previously set this will be used, otherwise the name is determined
+     * by the system auth type, or the validated url.
+     *
+     * @returns the connected system name
+     */
+    get connectedSystemName(): string | undefined;
+    /**
+     *
+     */
+    set connectedSystemName(value: string | undefined);
     /**
      * Calls a given service or system url to test its reachability and authentication requirements.
      * If the url is a system url, it will attempt to use the catalog service to get the service info.
@@ -63,7 +123,7 @@ export declare class ConnectionValidator {
      * @param options.odataVersion if specified will restrict catalog requests to only the specified odata version
      * @returns the status code or error returned by the connection attempt
      */
-    private checkSapService;
+    private checkSapServiceUrl;
     /**
      * Create the axios configuration object for the service or system connection.
      *
@@ -80,22 +140,49 @@ export declare class ConnectionValidator {
      * @param axiosConfig the axios request configuration
      * @param servicePath the service path without the origin
      */
-    private createServiceConnection;
+    private createOdataServiceConnection;
+    resetConnectionState(): void;
     /**
-     * Create the connection for a system url. The system url should be provided as a base url axios config property.
+     * Create the connection for a system url, the specified axios config or the specified service info.
      *
-     * @param axiosConfig the axios request configuration
-     * @param odataVersion the odata version to restrict the catalog requests if only a specific version is required
+     * @param connectConfig the connection configuration
+     * @param connectConfig.axiosConfig the axios request configuration
+     * @param connectConfig.url the system url
+     * @param connectConfig.serviceInfo the service info
+     * @param connectConfig.odataVersion the odata version to restrict the catalog requests if only a specific version is required
      */
     private createSystemConnection;
     /**
-     * Validates the service url format as well as its reachability.
+     * Callback for when the refresh token changes.
      *
-     * @param serviceUrl the odata service url to validate
+     * @param refreshToken the new refresh token
+     */
+    private refreshTokenChangedCb;
+    /**
+     * Get the service provider for the Abap on Cloud environment.
+     *
+     * @param url the system url
+     * @param serviceInfo the service info
+     * @returns the service provider
+     */
+    private getAbapOnCloudServiceProvider;
+    /**
+     * Validate the system connectivity with the specified service info (containing UAA details).
+     *
+     * @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
+     * @returns true if the system is reachable, false if not, or an error message string
+     */
+    validateServiceInfo(serviceInfo: ServiceInfo, odataVersion?: ODataVersion): Promise<ValidationResult>;
+    /**
+     * Validates the system or service url format as well as its reachability.
+     *
+     * @param serviceUrl the url to validate, may be a system or service url.
+     *     Note that if systemAuthType is specified, the url will be treated as a system url (only the origin will be considered)
      * @param options options for the connection validation
      * @param options.ignoreCertError ignore some certificate errors
-     * @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.forceReValidation force re-validation of the url
+     * @param options.isSystem if true, the url will be treated as a system url rather than a service url, this value is retained for subsequent calls
      * @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
      */
@@ -106,11 +193,11 @@ export declare class ConnectionValidator {
         odataVersion?: ODataVersion;
     }): Promise<ValidationResult>;
     /**
-     * Translate the status code into a validation result.
+     * Converts the http status code into 'validty' and returns true if the status code indicates that the URL was reachable.
      * Sets the instance validity state based on the status code.
      *
      * @param status a http request status code used to determine the validation result
-     * @returns true if the url is reachable, false if not, or an error message string
+     * @returns true, if the status code indicates the url is reachable, false if not, or an error message string
      */
     private getValidationResultFromStatusCode;
     /**
@@ -131,14 +218,14 @@ export declare class ConnectionValidator {
      * 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
+     * @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 ignore some certificate errors
      * @returns true if basic auth is required, false if not
      */
-    isAuthRequired(urlString?: string | undefined, client?: string | undefined, ignoreCertError?: boolean): Promise<boolean>;
+    isAuthRequired(urlString?: string | undefined, client?: string | undefined, ignoreCertError?: boolean): Promise<boolean | undefined>;
     /**
-     * Test the connectivity with the specified service url using the provided credentials.
+     * Test the connectivity with the specified service url using the provided credentials (basic authentication).
      *
      * @param url the url to validate
      * @param username user name
@@ -150,11 +237,11 @@ export declare class ConnectionValidator {
      * @param options.odataVersion if specified will restrict catalog requests to only the specified odata version
      * @returns true if the authentication is successful, false if not, or an error message string
      */
-    validateAuth(url: string, username: string, password: string, { ignoreCertError, isSystem, sapClient, odataVersion }?: {
+    validateAuth(url: string, username: string, password: string, { ignoreCertError, sapClient, odataVersion, isSystem }?: {
         ignoreCertError?: boolean;
-        isSystem?: boolean;
         odataVersion?: ODataVersion;
         sapClient?: string;
+        isSystem?: boolean;
     }): Promise<ValidationResult>;
     /**
      * Reset the validity state.