@sap-ux/odata-service-inquirer 2.11.22 → 2.13.0

package/dist/prompts/datasources/sap-system/abap-on-prem/questions.js

@@ -30,7 +30,8 @@ function getAbapOnPremQuestions(promptOptions) {
     // Prompt options
     const requiredOdataVersion = promptOptions?.serviceSelection?.requiredOdataVersion;
     const questions = getAbapOnPremSystemQuestions(promptOptions?.userSystemName, connectValidator, requiredOdataVersion);
-    questions.push(...(0, service_selection_1.getSystemServiceQuestion)(connectValidator, abapOnPremPromptNamespace, promptOptions?.serviceSelection));
+    questions.push(...(0, service_selection_1.getSystemServiceQuestion)(connectValidator, abapOnPremPromptNamespace, promptOptions?.serviceSelection, false // Hide value help download prompt
+    ));
     return questions;
 }
 /**

package/dist/prompts/datasources/sap-system/external-services/value-help-download.d.ts

@@ -0,0 +1,16 @@
+import type { ConfirmQuestion } from '@sap-ux/inquirer-common';
+import type { ConnectionValidator } from '../../../connectionValidator';
+import type { ConvertedMetadata } from '@sap-ux/vocabularies-types';
+/**
+ * Get the value help download confirmation prompt.
+ *
+ * @param connectionValidator - connection validator instance
+ * @param promptNamespace - prompt namespace
+ * @param convertedMetadataRef - converted metadata reference
+ * @param convertedMetadataRef.convertedMetadata - converted metadata
+ * @returns value help download prompt
+ */
+export declare function getValueHelpDownloadPrompt(connectionValidator: ConnectionValidator, promptNamespace?: string, convertedMetadataRef?: {
+    convertedMetadata: ConvertedMetadata | undefined;
+}): ConfirmQuestion;
+//# sourceMappingURL=value-help-download.d.ts.map

package/dist/prompts/datasources/sap-system/external-services/value-help-download.js

@@ -0,0 +1,112 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getValueHelpDownloadPrompt = getValueHelpDownloadPrompt;
+const inquirer_common_1 = require("@sap-ux/inquirer-common");
+const types_1 = require("../../../../types");
+const axios_extension_1 = require("@sap-ux/axios-extension");
+const odata_service_writer_1 = require("@sap-ux/odata-service-writer");
+const logger_helper_1 = __importDefault(require("../../../logger-helper"));
+const i18n_1 = require("../../../../i18n");
+const utils_1 = require("../../../../utils");
+const fiori_generator_shared_1 = require("@sap-ux/fiori-generator-shared");
+const telemetry_1 = require("@sap-ux/telemetry");
+// Telemetry event names
+const telemEventValueHelpDownloadPrompted = 'VALUE_HELP_DOWNLOAD_PROMPTED';
+const telemEventValueHelpDownloadSuccess = 'VALUE_HELP_DOWNLOAD_SUCCESS';
+const telemEventValueHelpDownloadFailed = 'VALUE_HELP_DOWNLOAD_FAILED';
+/**
+ * Send telemetry event with optional measurements support.
+ *
+ * @param eventName - telemetry event name
+ * @param properties - telemetry properties (dimensions)
+ * @param measurements - optional telemetry measurements (numeric metrics)
+ */
+async function sendValueHelpTelemetry(eventName, properties, measurements) {
+    // Use TelemetryHelper to add standard properties (Platform, OperatingSystem, etc.)
+    const enrichedProperties = fiori_generator_shared_1.TelemetryHelper.createTelemetryData(properties) ?? {};
+    if (measurements && Object.keys(measurements).length > 0) {
+        // Use reportEvent for events with measurements
+        const telemetryClient = (0, inquirer_common_1.getTelemetryClient)();
+        if (telemetryClient) {
+            await telemetryClient.reportEvent({
+                eventName,
+                properties: enrichedProperties,
+                measurements
+            }, telemetry_1.SampleRate.NoSampling);
+        }
+    }
+    else {
+        // Use sendTelemetryEvent for simple events without measurements
+        (0, inquirer_common_1.sendTelemetryEvent)(eventName, enrichedProperties);
+    }
+}
+/**
+ * Get the value help download confirmation prompt.
+ *
+ * @param connectionValidator - connection validator instance
+ * @param promptNamespace - prompt namespace
+ * @param convertedMetadataRef - converted metadata reference
+ * @param convertedMetadataRef.convertedMetadata - converted metadata
+ * @returns value help download prompt
+ */
+function getValueHelpDownloadPrompt(connectionValidator, promptNamespace, convertedMetadataRef) {
+    const promptNamespacePart = `${promptNamespace ? promptNamespace + ':' : ''}`;
+    const promptName = `${promptNamespacePart}${types_1.promptNames.valueHelpDownload}`;
+    const servicePromptName = `${promptNamespacePart}${types_1.promptNames.serviceSelection}`;
+    let externalServiceRefs;
+    let externalServiceMetadata;
+    const question = {
+        when: (answers) => {
+            const service = answers?.[servicePromptName];
+            const servicePath = service?.servicePath;
+            if (servicePath && convertedMetadataRef?.convertedMetadata) {
+                externalServiceRefs = (0, odata_service_writer_1.getExternalServiceReferences)(servicePath, convertedMetadataRef?.convertedMetadata);
+                return externalServiceRefs.length > 0;
+            }
+            return false;
+        },
+        name: promptName,
+        type: 'confirm',
+        message: (0, i18n_1.t)('prompts.valueHelpDownload.message'),
+        validate: async (downloadMetadata) => {
+            delete utils_1.PromptState.odataService.valueListMetadata;
+            // Send telemetry when prompt is answered
+            await sendValueHelpTelemetry(telemEventValueHelpDownloadPrompted, {
+                userChoseToDownload: downloadMetadata
+            });
+            if (downloadMetadata && connectionValidator.serviceProvider instanceof axios_extension_1.AbapServiceProvider) {
+                const startTime = Date.now();
+                try {
+                    externalServiceMetadata = await connectionValidator.serviceProvider.fetchExternalServices(externalServiceRefs);
+                    const downloadTimeMs = Date.now() - startTime;
+                    if (externalServiceMetadata.length > 0) {
+                        utils_1.PromptState.odataService.valueListMetadata = externalServiceMetadata;
+                    }
+                    else {
+                        logger_helper_1.default.logger.info((0, i18n_1.t)('warnings.noExternalServiceMetdataFetched'));
+                    }
+                    // Send success telemetry with measurements
+                    await sendValueHelpTelemetry(telemEventValueHelpDownloadSuccess, {
+                        userChoseToDownload: true,
+                        valueHelpCount: externalServiceMetadata.length
+                    }, { downloadTimeMs });
+                }
+                catch (error) {
+                    const downloadTimeMs = Date.now() - startTime;
+                    logger_helper_1.default.logger.error(`Failed to fetch external service metadata: ${error}`);
+                    // Send failure telemetry with measurements
+                    await sendValueHelpTelemetry(telemEventValueHelpDownloadFailed, {
+                        userChoseToDownload: true,
+                        error: error instanceof Error ? error.message : 'Unknown error'
+                    }, { downloadTimeMs });
+                }
+            }
+            return true;
+        }
+    };
+    return question;
+}
+//# sourceMappingURL=value-help-download.js.map

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

@@ -5,11 +5,12 @@ import { type ServiceAnswer } from './types';
 /**
  * Get the service selection prompt for an Abap system connection (on-prem or on-btp). The service selection prompt is used to select a service from the system catalog.
  *
- * @param connectValidator A reference to the active connection validator, used to validate the service selection and retrieve service details.
- * @param promptNamespace The namespace for the prompt, used to identify the prompt instance and namespaced answers.
+ * @param connectValidator - A reference to the active connection validator, used to validate the service selection and retrieve service details.
+ * @param promptNamespace - The namespace for the prompt, used to identify the prompt instance and namespaced answers.
  *     This is used to avoid conflicts with other prompts of the same types.
- * @param promptOptions Options for the service selection prompt see {@link OdataServicePromptOptions}
+ * @param promptOptions - Options for the service selection prompt see {@link OdataServicePromptOptions}
+ * @param showValueHelpDownloadPrompt - If true the value help download confirm prompt will be included
  * @returns the service selection prompt
  */
-export declare function getSystemServiceQuestion(connectValidator: ConnectionValidator, promptNamespace: string, promptOptions?: ServiceSelectionPromptOptions): Question<ServiceAnswer>[];
+export declare function getSystemServiceQuestion(connectValidator: ConnectionValidator, promptNamespace: string, promptOptions?: ServiceSelectionPromptOptions, showValueHelpDownloadPrompt?: boolean): Question<ServiceAnswer>[];
 //# sourceMappingURL=questions.d.ts.map

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

@@ -4,6 +4,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.getSystemServiceQuestion = getSystemServiceQuestion;
+const axios_extension_1 = require("@sap-ux/axios-extension");
 const fiori_generator_shared_1 = require("@sap-ux/fiori-generator-shared");
 const inquirer_common_1 = require("@sap-ux/inquirer-common");
 const odata_service_writer_1 = require("@sap-ux/odata-service-writer");
@@ -13,17 +14,19 @@ const utils_1 = require("../../../../utils");
 const logger_helper_1 = __importDefault(require("../../../logger-helper"));
 const prompt_helpers_1 = require("../../../prompt-helpers");
 const service_helper_1 = require("../service-selection/service-helper");
+const value_help_download_1 = require("../external-services/value-help-download");
 const cliServicePromptName = 'cliServiceSelection';
 /**
  * Get the service selection prompt for an Abap system connection (on-prem or on-btp). The service selection prompt is used to select a service from the system catalog.
  *
- * @param connectValidator A reference to the active connection validator, used to validate the service selection and retrieve service details.
- * @param promptNamespace The namespace for the prompt, used to identify the prompt instance and namespaced answers.
+ * @param connectValidator - A reference to the active connection validator, used to validate the service selection and retrieve service details.
+ * @param promptNamespace - The namespace for the prompt, used to identify the prompt instance and namespaced answers.
  *     This is used to avoid conflicts with other prompts of the same types.
- * @param promptOptions Options for the service selection prompt see {@link OdataServicePromptOptions}
+ * @param promptOptions - Options for the service selection prompt see {@link OdataServicePromptOptions}
+ * @param showValueHelpDownloadPrompt - If true the value help download confirm prompt will be included
  * @returns the service selection prompt
  */
-function getSystemServiceQuestion(connectValidator, promptNamespace, promptOptions) {
+function getSystemServiceQuestion(connectValidator, promptNamespace, promptOptions, showValueHelpDownloadPrompt = false) {
     let serviceChoices = [];
     // Prevent re-requesting services repeatedly by only requesting them once and when the system or client is changed
     let previousSystemUrl;
@@ -31,7 +34,10 @@ function getSystemServiceQuestion(connectValidator, promptNamespace, promptOptio
     let previousService;
     // State shared across validate and additionalMessages functions
     let hasBackendAnnotations;
-    let convertedMetadata;
+    // Wrap to allow pass by ref to nested prompts
+    const convertedMetadataRef = {
+        convertedMetadata: undefined
+    };
     const requiredOdataVersion = promptOptions?.requiredOdataVersion;
     const serviceSelectionPromptName = `${promptNamespace}:${types_1.promptNames.serviceSelection}`;
     let systemServiceQuestion = {
@@ -87,10 +93,10 @@ function getSystemServiceQuestion(connectValidator, promptNamespace, promptOptio
         additionalMessages: (selectedService) => (0, service_helper_1.getSelectedServiceMessage)(serviceChoices, selectedService, connectValidator, {
             requiredOdataVersion,
             hasAnnotations: hasBackendAnnotations,
-            showCollabDraftWarnOptions: convertedMetadata
+            showCollabDraftWarnOptions: convertedMetadataRef.convertedMetadata
                 ? {
                     showCollabDraftWarning: !!promptOptions?.showCollaborativeDraftWarning,
-                    edmx: convertedMetadata
+                    edmx: convertedMetadataRef.convertedMetadata
                 }
                 : undefined
         }),
@@ -112,11 +118,11 @@ function getSystemServiceQuestion(connectValidator, promptNamespace, promptOptio
             // Dont re-request the same service details
             if (serviceAnswer && previousService?.servicePath !== serviceAnswer.servicePath) {
                 hasBackendAnnotations = undefined;
-                convertedMetadata = undefined;
+                convertedMetadataRef.convertedMetadata = undefined;
                 previousService = serviceAnswer;
                 const validationResult = await (0, service_helper_1.validateService)(serviceAnswer, connectValidator, requiredOdataVersion);
                 hasBackendAnnotations = validationResult.hasAnnotations;
-                convertedMetadata = validationResult.convertedMetadata;
+                convertedMetadataRef.convertedMetadata = validationResult.convertedMetadata;
                 return validationResult.validationResult;
             }
             return true;
@@ -136,11 +142,13 @@ function getSystemServiceQuestion(connectValidator, promptNamespace, promptOptio
             when: async (answers) => {
                 const selectedService = answers?.[`${promptNamespace}:${types_1.promptNames.serviceSelection}`];
                 if (selectedService && connectValidator.validatedUrl) {
-                    const { validationResult } = await (0, service_helper_1.validateService)(selectedService, connectValidator);
+                    const { validationResult, hasAnnotations, convertedMetadata } = await (0, service_helper_1.validateService)(selectedService, connectValidator);
                     if (typeof validationResult === 'string') {
                         logger_helper_1.default.logger.error(validationResult);
                         throw new Error(validationResult);
                     }
+                    hasBackendAnnotations = hasAnnotations;
+                    convertedMetadataRef.convertedMetadata = convertedMetadata;
                 }
                 if (serviceChoices.length === 0 && prompt_helpers_1.errorHandler.hasError()) {
                     const noServicesError = inquirer_common_1.ErrorHandler.getHelpForError(inquirer_common_1.ERROR_TYPE.SERVICES_UNAVAILABLE).toString();
@@ -151,6 +159,14 @@ function getSystemServiceQuestion(connectValidator, promptNamespace, promptOptio
             name: `${promptNamespace}:${cliServicePromptName}`
         });
     }
+    if (showValueHelpDownloadPrompt) {
+        /**
+         * Only show the value help download prompt when a service has been validated (convertedMetadata is set), is odata version v4 and is an abap connection
+         */
+        questions.push(...(0, inquirer_common_1.withCondition)([(0, value_help_download_1.getValueHelpDownloadPrompt)(connectValidator, promptNamespace, convertedMetadataRef)], (answers) => !!(connectValidator.serviceProvider instanceof axios_extension_1.AbapServiceProvider) &&
+            !!convertedMetadataRef.convertedMetadata &&
+            answers?.[serviceSelectionPromptName]?.serviceODataVersion === axios_extension_1.ODataVersion.v4));
+    }
     return questions;
 }
 /**

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

@@ -74,7 +74,8 @@ async function getSystemSelectionQuestions(promptOptions, connectedSystem) {
     const questions = await getSystemConnectionQuestions(connectValidator, promptOptions, connectedSystem);
     // Existing system (BackendSystem or Destination) selected,
     if (!promptOptions?.serviceSelection?.hide) {
-        questions.push(...(0, inquirer_common_1.withCondition)((0, questions_4.getSystemServiceQuestion)(connectValidator, systemSelectionPromptNamespace, promptOptions?.serviceSelection), (answers) => answers.systemSelection?.type !== 'newSystemChoice'));
+        questions.push(...(0, inquirer_common_1.withCondition)((0, questions_4.getSystemServiceQuestion)(connectValidator, systemSelectionPromptNamespace, promptOptions?.serviceSelection, false // Hide value help download prompt
+        ), (answers) => answers.systemSelection?.type !== 'newSystemChoice'));
     }
     // Create new system connection for storage only supported on non-App Studio environments
     if (!(0, btp_utils_1.isAppStudio)()) {

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

@@ -206,6 +206,10 @@
         "smartVariantManagement": {
             "message": "Enable Smart Variant Management",
             "hint": "Enables page level variant."
+        },
+        "valueHelpDownload": {
+            "message": "The service contains references to value help services. Do you want to download the associated metadata during generation? This may increase generation time.",
+            "hint": "Download metadata for value help to improve the user experience with dropdowns and search."
         }
     },
     "errors": {
@@ -256,7 +260,8 @@
         "collaborativeDraftMessage": "The selected service is draft enabled but does not support collaborative draft.",
         "certificateErrors": "A certificate error occurred when connecting to the host: {{-url}}. Certificate error: {{error}}.",
         "allowingUnauthorizedCertsNode": "Setting the `NODE_TLS_REJECT_UNAUTHORIZED` environment variable to `0` makes TLS connections and HTTPS requests insecure by disabling certificate verification. It is important to understand the security risks when using this setting.",
-        "certErrorIgnoredByNodeSetting": "An SSL certificate error is being ignored by the 'NODE_TLS_REJECT_UNAUTHORIZED=0' Node.js setting. This makes TLS connections and HTTPS requests insecure by disabling certificate verification. For details of the certification error, see the logs."
+        "certErrorIgnoredByNodeSetting": "An SSL certificate error is being ignored by the 'NODE_TLS_REJECT_UNAUTHORIZED=0' Node.js setting. This makes TLS connections and HTTPS requests insecure by disabling certificate verification. For details of the certification error, see the logs.",
+        "noExternalServiceMetdataFetched": "No external service metadata were fetched. $t(texts.seeLogForDetails)."
     },
     "texts": {
         "suggestedSystemNameClient": ", client {{client}}",

package/dist/types.d.ts

@@ -1,4 +1,4 @@
-import type { Annotations, ServiceProvider } from '@sap-ux/axios-extension';
+import type { Annotations, ServiceProvider, ExternalService } from '@sap-ux/axios-extension';
 import type { Destination } from '@sap-ux/btp-utils';
 import type { CommonPromptOptions, YUIQuestion } from '@sap-ux/inquirer-common';
 import type { OdataVersion } from '@sap-ux/odata-service-writer';
@@ -84,6 +84,10 @@ export interface OdataServiceAnswers {
      * If the user chose to ignore the certificate error when connecting to the service the value will be true.
      */
     [serviceUrlInternalPromptNames.ignoreCertError]?: boolean;
+    /**
+     * Value list metdata related to the main odata service
+     */
+    valueListMetadata?: ExternalService[];
 }
 export interface ConnectedSystem {
     /**
@@ -141,7 +145,11 @@ export declare enum promptNames {
     /**
      * System selection
      */
-    systemSelection = "systemSelection"
+    systemSelection = "systemSelection",
+    /**
+     * Value Help download confirm prompt
+     */
+    valueHelpDownload = "valueHelpDownload"
 }
 /**
  * Prompt names for entity related prompts. These indirectly define the properties of the answers object returned by the entity related prompts.
@@ -335,7 +343,7 @@ export type OdataServiceUrlPromptOptions = {
 /**
  * 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.serviceSelection, ServiceSelectionPromptOptions> & Record<promptNames.userSystemName, SystemNamePromptOptions> & Record<promptNames.systemSelection, SystemSelectionPromptOptions>;
+type odataServiceInquirerPromptOptions = Record<promptNames.datasourceType, DatasourceTypePromptOptions> & Record<promptNames.metadataFilePath, MetadataPromptOptions> & Record<promptNames.capProject, CapProjectPromptOptions> & Record<promptNames.capService, CapServicePromptOptions> & Record<promptNames.serviceUrl, OdataServiceUrlPromptOptions> & Record<promptNames.serviceSelection, ServiceSelectionPromptOptions> & Record<promptNames.userSystemName, SystemNamePromptOptions> & Record<promptNames.systemSelection, SystemSelectionPromptOptions> & Record<promptNames.valueHelpDownload, ValueHelpDownloadPromptOptions>;
 export type OdataServiceQuestion = YUIQuestion<OdataServiceAnswers>;
 export type OdataServicePromptOptions = Partial<odataServiceInquirerPromptOptions>;
 /**
@@ -360,5 +368,10 @@ export type EntityPromptOptions = {
      */
     displayPageBuildingBlockPrompt?: boolean;
 };
+/**
+ * Support hiding of the value help download prompt, default is true - hidden.
+ * Note that this prompt is dependant on service metdata being provided, usually by the service selection prompt.
+ */
+export type ValueHelpDownloadPromptOptions = Pick<CommonPromptOptions, 'hide'>;
 export {};
 //# sourceMappingURL=types.d.ts.map

package/dist/types.js

@@ -66,6 +66,10 @@ var promptNames;
      * System selection
      */
     promptNames["systemSelection"] = "systemSelection";
+    /**
+     * Value Help download confirm prompt
+     */
+    promptNames["valueHelpDownload"] = "valueHelpDownload";
 })(promptNames || (exports.promptNames = promptNames = {}));
 /**
  * Prompt names for entity related prompts. These indirectly define the properties of the answers object returned by the entity related prompts.

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.11.22",
+  "version": "2.13.0",
   "repository": {
     "type": "git",
     "url": "https://github.com/SAP/open-ux-tools.git",
@@ -20,7 +20,7 @@
   ],
   "dependencies": {
     "@sap/cf-tools": "3.2.2",
-    "@sap-ux/annotation-converter": "0.10.8",
+    "@sap-ux/annotation-converter": "0.10.9",
     "@sap-ux/edmx-parser": "0.9.1",
     "axios": "1.12.2",
     "axios-logger": "2.8.0",
@@ -29,12 +29,12 @@
     "i18next": "25.3.0",
     "inquirer-autocomplete-prompt": "2.0.1",
     "os-name": "4.0.1",
-    "@sap-ux/axios-extension": "1.24.6",
+    "@sap-ux/axios-extension": "1.25.0",
     "@sap-ux/btp-utils": "1.1.6",
     "@sap-ux/fiori-generator-shared": "0.13.44",
     "@sap-ux/guided-answers-helper": "0.4.2",
     "@sap-ux/telemetry": "0.6.48",
-    "@sap-ux/inquirer-common": "0.9.17",
+    "@sap-ux/inquirer-common": "0.10.1",
     "@sap-ux/logger": "0.7.2",
     "@sap-ux/nodejs-utils": "0.2.10",
     "@sap-ux/project-access": "1.32.16",
@@ -42,17 +42,17 @@
     "@sap-ux/store": "1.4.0"
   },
   "devDependencies": {
-    "@sap-ux/vocabularies-types": "0.13.1",
+    "@sap-ux/vocabularies-types": "0.13.2",
     "@sap-devx/yeoman-ui-types": "1.14.4",
     "@types/inquirer-autocomplete-prompt": "2.0.2",
     "@types/inquirer": "8.2.6",
     "@types/lodash": "4.14.202",
     "jest-extended": "6.0.0",
     "@sap-ux/fiori-generator-shared": "0.13.44",
-    "@sap-ux/fiori-elements-writer": "2.8.21",
-    "@sap-ux/fiori-freestyle-writer": "2.5.13",
+    "@sap-ux/fiori-elements-writer": "2.8.24",
+    "@sap-ux/fiori-freestyle-writer": "2.5.16",
     "@sap-ux/feature-toggle": "0.3.5",
-    "@sap-ux/odata-service-writer": "0.27.38",
+    "@sap-ux/odata-service-writer": "0.29.0",
     "@sap-ux/cap-config-writer": "0.12.35"
   },
   "engines": {