@sap-ux/odata-service-inquirer 0.5.60 → 0.6.1

package/dist/i18n.js

@@ -14,16 +14,28 @@ exports.defaultProjectNumber = 1;
  * Initialize i18next with the translations for this module.
  */
 async function initI18nOdataServiceInquirer() {
+    const t0 = performance.now();
     await i18next_1.default.init({
         lng: 'en',
         fallbackLng: 'en',
         missingInterpolationHandler: () => '',
         interpolation: {
-            format: function odataVersionFormatter(odataVersion) {
-                return odataVersion ? ` V${odataVersion}` : '';
+            format: function (value, format) {
+                // OData version formatter
+                if (format === 'odataVersionFormatter') {
+                    return value ? ` V${value}` : '';
+                }
+                // If we have a value add a colon before outputting
+                if (format === 'addMsgWithColonFormatter') {
+                    return value ? `: ${value}` : '';
+                }
+                return value;
             }
         }
-    }, () => i18next_1.default.addResourceBundle('en', odataServiceInquirerNamespace, odata_service_inquirer_i18n_json_1.default));
+    });
+    i18next_1.default.addResourceBundle('en', odataServiceInquirerNamespace, odata_service_inquirer_i18n_json_1.default);
+    const t1 = performance.now();
+    console.log(`i18n load time: ${Math.round(t1 - t0)} milliseconds`);
 }
 /**
  * Helper function facading the call to i18next. Unless a namespace option is provided the local namespace will be used.

package/dist/index.d.ts

@@ -2,8 +2,8 @@ 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 { ERROR_TYPE, ErrorHandler } from './error-handler/error-handler';
-import { newSystemChoiceValue } from './prompts/datasources/sap-system/new-system/questions';
+import { ERROR_TYPE, ErrorHandler } from '@sap-ux/inquirer-common';
+import { SystemSelectionAnswerType } from './prompts/datasources/sap-system/system-selection';
 import { DatasourceType, promptNames, type CapRuntime, type CapService, type OdataServiceAnswers, type OdataServicePromptOptions, type OdataServiceQuestion, type SapSystemType } from './types';
 /**
  * Get the inquirer prompts for odata service.
@@ -31,5 +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>;
-export { DatasourceType, ERROR_TYPE, ErrorHandler, OdataVersion, getPrompts, newSystemChoiceValue, prompt, promptNames, type CapRuntime, type CapService, type InquirerAdapter, type OdataServiceAnswers, type OdataServicePromptOptions, type SapSystemType };
+export { DatasourceType, ERROR_TYPE, ErrorHandler, getPrompts, OdataVersion, prompt, promptNames, SystemSelectionAnswerType, type CapRuntime, type CapService, type InquirerAdapter, type OdataServiceAnswers, type OdataServicePromptOptions, type SapSystemType };
 //# sourceMappingURL=index.d.ts.map

package/dist/index.js

@@ -3,19 +3,17 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.promptNames = exports.newSystemChoiceValue = exports.OdataVersion = exports.ErrorHandler = exports.ERROR_TYPE = exports.DatasourceType = void 0;
+exports.promptNames = exports.OdataVersion = exports.ErrorHandler = exports.ERROR_TYPE = exports.DatasourceType = void 0;
 exports.getPrompts = getPrompts;
 exports.prompt = prompt;
 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"));
-const error_handler_1 = require("./error-handler/error-handler");
-Object.defineProperty(exports, "ERROR_TYPE", { enumerable: true, get: function () { return error_handler_1.ERROR_TYPE; } });
-Object.defineProperty(exports, "ErrorHandler", { enumerable: true, get: function () { return error_handler_1.ErrorHandler; } });
+const inquirer_common_1 = require("@sap-ux/inquirer-common");
+Object.defineProperty(exports, "ERROR_TYPE", { enumerable: true, get: function () { return inquirer_common_1.ERROR_TYPE; } });
+Object.defineProperty(exports, "ErrorHandler", { enumerable: true, get: function () { return inquirer_common_1.ErrorHandler; } });
 const i18n_1 = require("./i18n");
 const prompts_1 = require("./prompts");
-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; } });
@@ -37,10 +35,13 @@ async function getPrompts(promptOptions, logger, enableGuidedAnswers = false, te
     if (logger) {
         logger_helper_1.default.logger = logger;
     }
-    error_handler_1.ErrorHandler.logger = logger_helper_1.default.logger;
-    error_handler_1.ErrorHandler.guidedAnswersEnabled = enableGuidedAnswers;
+    inquirer_common_1.ErrorHandler.logger = logger_helper_1.default.logger;
+    inquirer_common_1.ErrorHandler.guidedAnswersEnabled = enableGuidedAnswers;
+    // Sets the platform for error handler telem reporting, based on the `isYUI` option
+    inquirer_common_1.ErrorHandler.platform = (0, utils_1.getPromptHostEnvironment)().technical;
+    inquirer_common_1.ErrorHandler.guidedAnswersTrigger = '@sap-ux/odata-service-inquirer';
     utils_1.PromptState.isYUI = isYUI;
-    (0, utils_1.setTelemetryClient)(telemetryClient);
+    (0, inquirer_common_1.setTelemetryClient)(telemetryClient);
     return {
         prompts: await (0, prompts_1.getQuestions)(promptOptions),
         // Return reference to derived answers object that will be populated with user responses (after prompting is complete)

package/dist/prompts/connectionValidator.d.ts

@@ -1,6 +1,8 @@
 import type { IValidationLink } from '@sap-devx/yeoman-ui-types';
 import type { AxiosRequestConfig, CatalogService, ODataService, ServiceInfo, ServiceProvider } from '@sap-ux/axios-extension';
 import { ODataVersion } from '@sap-ux/axios-extension';
+import { type Destination } from '@sap-ux/btp-utils';
+import { ERROR_TYPE } from '@sap-ux/inquirer-common';
 /**
  * Structure to store validity information about url to be validated.
  */
@@ -11,7 +13,7 @@ interface Validity {
     authenticated?: boolean;
     canSkipCertError?: boolean;
 }
-type ValidationResult = string | boolean | IValidationLink;
+export type ValidationResult = string | boolean | IValidationLink;
 export type SystemAuthType = 'serviceKey' | 'reentranceTicket' | 'basic' | 'unknown';
 /**
  * Class that can be used to determine the connectivity using a service url, system url, or service info (UAA Key details) or reentrance ticket.
@@ -23,6 +25,8 @@ export type SystemAuthType = 'serviceKey' | 'reentranceTicket' | 'basic' | 'unkn
 export declare class ConnectionValidator {
     readonly validity: Validity;
     private _validatedUrl;
+    private _destinationUrl;
+    private _destination;
     private _validatedClient;
     private _odataService;
     private _serviceProvider;
@@ -105,6 +109,18 @@ export declare class ConnectionValidator {
      * @returns the refresh token
      */
     get refreshToken(): string | undefined;
+    /**
+     * Get the full expanded destination url as defined in the destination configuration. This should not be used to connect from App Studio (use the .dest form).
+     *
+     * @returns the connected destination 'URL' attribute value
+     */
+    get destinationUrl(): string | undefined;
+    /**
+     * Get the  destination.
+     *
+     * @returns the connected destination 'URL' attribute value
+     */
+    get destination(): Destination | 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.
@@ -128,8 +144,9 @@ export declare class ConnectionValidator {
      * @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 the status code or error returned by the connection attempt
+     * @throws an error if the connection attempt fails and the error is a 500 on App Studio or a non-axios error is caught
      */
-    private checkSapServiceUrl;
+    private checkUrl;
     /**
      * Create the axios configuration object for the service or system connection.
      *
@@ -147,7 +164,11 @@ export declare class ConnectionValidator {
      * @param servicePath the service path without the origin
      */
     private createOdataServiceConnection;
-    resetConnectionState(): void;
+    /**
+     *
+     * @param resetValidity
+     */
+    resetConnectionState(resetValidity?: boolean): void;
     /**
      * Create the connection for a system url, the specified axios config or the specified service info.
      *
@@ -156,6 +177,8 @@ export declare class ConnectionValidator {
      * @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
+     * @param connectConfig.destination the destination to connect with
+     * @throws an error if the connection attempt fails, callers should handle the error
      */
     private createSystemConnection;
     /**
@@ -166,7 +189,7 @@ export declare class ConnectionValidator {
      */
     private shouldAttemptV4Catalog;
     /**
-     * Callback for when the refresh token changes.
+     * Callback for when the Abap cloud system refresh token changes.
      *
      * @param refreshToken the new refresh token
      */
@@ -181,14 +204,38 @@ export declare class ConnectionValidator {
     private getAbapOnCloudServiceProvider;
     /**
      * Validate the system connectivity with the specified service info (containing UAA details).
+     * This will create a connection to the system, updating the service provider reference.
+     * The connected user name will be cached for later use.
      *
      * @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
+     * @returns true if the system is reachable and authenticated, if required, 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.
+     * Validate the specified destination connectivity, determining if authentication is required or if the destination is misconfigured.
+     *
+     * @param destination the destination to validate
+     * @param odataVersion the odata version to restrict the catalog requests if only a specific version is required
+     * @param servicePath the service path to validate, if specified will be appended to the destination URL for validation, if not specified the destination url will be used
+     * @returns true if the system is reachable and authenticated, if required, false if not, or an error message string
+     */
+    validateDestination(destination: Destination, odataVersion?: ODataVersion, servicePath?: string): Promise<{
+        valResult: ValidationResult;
+        errorType?: ERROR_TYPE;
+    }>;
+    /**
+     * Validate the connectivity to a destination odata service (for generic odata service destinations), determining, for example, if authentication is required.
+     *
+     * @param destination a destination that is a generic odata service destination
+     * @param servicePath additional service path to append to the destination URL
+     * @param requiredOdataVersion the required odata version, if specified will validate the odata service version satisfies the specified version
+     * @returns validation result and error type if validation fails
+     */
+    private validateOdataServiceDestination;
+    /**
+     * Validates an odata service url format as well as its reachability. Note if this function returns true, this is only an indication that the system is reachable
+     * not that a connection has been established. The connection may require separate authentication or other steps (it may be reachable but a cert error was returned).
      *
      * @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)
@@ -197,17 +244,18 @@ export declare class ConnectionValidator {
      * @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
+     * @param options.systemAuthType the system auth type used to create system connections, if not specified or `isSystem` is false or undefined, `basic` is assumed
      * @returns true if the url is reachable, false if not, or an error message string
      */
-    validateUrl(serviceUrl: string, { ignoreCertError, forceReValidation, isSystem, odataVersion }?: {
+    validateUrl(serviceUrl: string, { ignoreCertError, forceReValidation, isSystem, odataVersion, systemAuthType }?: {
         ignoreCertError?: boolean;
         forceReValidation?: boolean;
         isSystem?: boolean;
         odataVersion?: ODataVersion;
+        systemAuthType?: SystemAuthType;
     }): Promise<ValidationResult>;
     /**
-     * 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.
+     * Sets the instance validity state based on the status code and returns true if the status code indicates that the URL was reachable.
      *
      * @param status a http request status code used to determine the validation result
      * @returns true, if the status code indicates the url is reachable, false if not, or an error message string
@@ -229,7 +277,7 @@ export declare class ConnectionValidator {
     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.
+     * This will also set the validity state for 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
@@ -250,12 +298,15 @@ 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, sapClient, odataVersion, isSystem }?: {
+    validateAuth(url: string, username?: string, password?: string, { ignoreCertError, sapClient, odataVersion, isSystem }?: {
         ignoreCertError?: boolean;
         odataVersion?: ODataVersion;
         sapClient?: string;
         isSystem?: boolean;
-    }): Promise<ValidationResult>;
+    }): Promise<{
+        valResult: ValidationResult;
+        errorType?: ERROR_TYPE;
+    }>;
     /**
      * Reset the validity state.
      */