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

package/dist/i18n.js

@@ -14,7 +14,6 @@ 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',
@@ -34,8 +33,6 @@ async function initI18nOdataServiceInquirer() {
         }
     });
     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/prompts/connectionValidator.d.ts

@@ -165,8 +165,9 @@ export declare class ConnectionValidator {
      */
     private createOdataServiceConnection;
     /**
+     * Resets any connection state and validity information.
      *
-     * @param resetValidity
+     * @param resetValidity if true, the validity information will be reset also
      */
     resetConnectionState(resetValidity?: boolean): void;
     /**

package/dist/prompts/connectionValidator.js

@@ -273,8 +273,9 @@ class ConnectionValidator {
         await this._odataService.get('');
     }
     /**
+     * Resets any connection state and validity information.
      *
-     * @param resetValidity
+     * @param resetValidity if true, the validity information will be reset also
      */
     resetConnectionState(resetValidity = false) {
         this._serviceProvider = undefined;

package/dist/prompts/datasources/sap-system/service-selection/service-helper.d.ts

@@ -46,7 +46,7 @@ export declare function getServiceType(servicePath: string, serviceType: string
  *
  * @param service the specific service to get details for
  * @param connectionValidator a reference to the connection validator which has an active connection to the backend
- * @param requiredOdataVersion
+ * @param requiredOdataVersion the required OData version used to validate the service
  * @returns true if successful, setting the PromptState.odataService properties, or an error message indicating why the service details could not be retrieved.
  */
 export declare function getServiceDetails(service: ServiceAnswer, connectionValidator: ConnectionValidator, requiredOdataVersion?: OdataVersion): Promise<string | boolean>;

package/dist/prompts/datasources/sap-system/service-selection/service-helper.js

@@ -64,7 +64,7 @@ const createServiceChoices = (serviceInfos) => {
  * Logs the catalog request errors using the error handler.
  *
  * @param requestErrors catalog request errors, keyed by the OData version of the catalog service, with the error, status code number or error message as the value
- * @param numOfRequests
+ * @param numOfRequests the number of catalog service requests made
  */
 function logServiceCatalogErrorsForHelp(requestErrors, numOfRequests) {
     const catalogRequesErrors = Object.values(requestErrors);
@@ -189,7 +189,7 @@ async function getServiceType(servicePath, serviceType, catalog) {
  *
  * @param service the specific service to get details for
  * @param connectionValidator a reference to the connection validator which has an active connection to the backend
- * @param requiredOdataVersion
+ * @param requiredOdataVersion the required OData version used to validate the service
  * @returns true if successful, setting the PromptState.odataService properties, or an error message indicating why the service details could not be retrieved.
  */
 async function getServiceDetails(service, connectionValidator, requiredOdataVersion) {

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

@@ -36,8 +36,8 @@ export declare function getBackendSystemDisplayName(system: BackendSystem): stri
 /**
  * Creates a list of choices for the system selection prompt using destinations or stored backend systems, depending on the environment.
  *
- * @param destinationFilters
- * @param includeCloudFoundryAbapEnvChoice
+ * @param destinationFilters the filters to apply to the destination choices
+ * @param includeCloudFoundryAbapEnvChoice whether to include the Cloud Foundry ABAP environment choice in the list
  * @returns a list of choices for the system selection prompt
  */
 export declare function createSystemChoices(destinationFilters?: Partial<DestinationFilters>, includeCloudFoundryAbapEnvChoice?: boolean): Promise<ListChoiceOptions<SystemSelectionAnswers>[]>;

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

@@ -109,8 +109,8 @@ function getBackendSystemDisplayName(system) {
 /**
  * Matches the destination against the provided filters. Returns true if the destination matches any filters, false otherwise.
  *
- * @param destination
- * @param filters
+ * @param destination the destination to match against the filters
+ * @param filters the filters to match against
  * @returns true if the destination matches any filters, false otherwise
  */
 function matchesFilters(destination, filters) {
@@ -135,8 +135,8 @@ function matchesFilters(destination, filters) {
 /**
  * Creates a list of choices for the system selection prompt using destinations or stored backend systems, depending on the environment.
  *
- * @param destinationFilters
- * @param includeCloudFoundryAbapEnvChoice
+ * @param destinationFilters the filters to apply to the destination choices
+ * @param includeCloudFoundryAbapEnvChoice whether to include the Cloud Foundry ABAP environment choice in the list
  * @returns a list of choices for the system selection prompt
  */
 async function createSystemChoices(destinationFilters, includeCloudFoundryAbapEnvChoice = false) {

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

@@ -32,7 +32,7 @@ export declare function getSystemSelectionQuestions(promptOptions?: OdataService
  * Additional destination attribute filters may be provided.
  *
  * @param connectionValidator A reference to the active connection validator, used to validate the service selection and retrieve service details.
- * @param promptOptions
+ * @param promptOptions prompt options that may be used to customize the questions
  * @returns a list of existing systems
  */
 export declare function getSystemConnectionQuestions(connectionValidator: ConnectionValidator, promptOptions?: OdataServicePromptOptions): Promise<Question<SystemSelectionAnswers>[]>;

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

@@ -33,9 +33,9 @@ const systemSelectionPromptNames = {
 /**
  * Validates the system selection, connecting to the selected system and validating the connection.
  *
- * @param systemSelection
- * @param connectionValidator
- * @param requiredOdataVersion
+ * @param systemSelection the selected system to validate
+ * @param connectionValidator the active connection validator to use for the connection attempt
+ * @param requiredOdataVersion the required OData version for the selected system, only the specified version will be used to request a service catalog
  * @returns the validation result of the selected system connection attempt
  */
 async function validateSystemSelection(systemSelection, connectionValidator, requiredOdataVersion) {
@@ -84,7 +84,7 @@ async function getSystemSelectionQuestions(promptOptions) {
  * Additional destination attribute filters may be provided.
  *
  * @param connectionValidator A reference to the active connection validator, used to validate the service selection and retrieve service details.
- * @param promptOptions
+ * @param promptOptions prompt options that may be used to customize the questions
  * @returns a list of existing systems
  */
 async function getSystemConnectionQuestions(connectionValidator, promptOptions) {

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.6.1",
+  "version": "0.6.3",
   "repository": {
     "type": "git",
     "url": "https://github.com/SAP/open-ux-tools.git",
@@ -26,7 +26,7 @@
     "i18next": "23.5.1",
     "inquirer-autocomplete-prompt": "2.0.1",
     "os-name": "4.0.1",
-    "@sap-ux/axios-extension": "1.17.2",
+    "@sap-ux/axios-extension": "1.17.3",
     "@sap-ux/btp-utils": "0.16.0",
     "@sap-ux/fiori-generator-shared": "0.7.7",
     "@sap-ux/guided-answers-helper": "0.1.0",
@@ -45,7 +45,7 @@
     "jest-extended": "3.2.4",
     "@sap-ux/fiori-generator-shared": "0.7.7",
     "@sap-ux/feature-toggle": "0.2.2",
-    "@sap-ux/odata-service-writer": "0.23.1"
+    "@sap-ux/odata-service-writer": "0.23.2"
   },
   "engines": {
     "node": ">=18.x"