@sap-ux/odata-service-inquirer 2.0.1 → 2.1.0

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

@@ -29,6 +29,9 @@ function getSystemServiceQuestion(connectValidator, promptNamespace, promptOptio
     let previousSystemUrl;
     let previousClient;
     let previousService;
+    // State shared across validate and additionalMessages functions
+    let hasBackendAnnotations;
+    let convertedMetadata;
     const requiredOdataVersion = promptOptions?.requiredOdataVersion;
     const serviceSelectionPromptName = `${promptNamespace}:${types_1.promptNames.serviceSelection}`;
     let systemServiceQuestion = {
@@ -81,15 +84,16 @@ function getSystemServiceQuestion(connectValidator, promptNamespace, promptOptio
             }
             return serviceChoices;
         },
-        additionalMessages: (selectedService) => {
-            // Additional messages is executed after validation, so we can assume the PromptState has been updated
-            let hasBackendAnnotations = false;
-            if (selectedService && utils_1.PromptState.odataService.servicePath === selectedService.servicePath) {
-                hasBackendAnnotations =
-                    !!utils_1.PromptState.odataService.annotations && utils_1.PromptState.odataService.annotations.length > 0;
-            }
-            return (0, service_helper_1.getSelectedServiceMessage)(serviceChoices, selectedService, connectValidator, requiredOdataVersion, hasBackendAnnotations);
-        },
+        additionalMessages: (selectedService) => (0, service_helper_1.getSelectedServiceMessage)(serviceChoices, selectedService, connectValidator, {
+            requiredOdataVersion,
+            hasAnnotations: hasBackendAnnotations,
+            showCollabDraftWarnOptions: convertedMetadata
+                ? {
+                    showCollabDraftWarning: !!promptOptions?.showCollaborativeDraftWarning,
+                    edmx: convertedMetadata
+                }
+                : undefined
+        }),
         default: () => (0, utils_1.getDefaultChoiceIndex)(serviceChoices),
         // Warning: only executes in YUI and cli when automcomplete is used
         validate: async (service) => {
@@ -107,8 +111,13 @@ function getSystemServiceQuestion(connectValidator, promptNamespace, promptOptio
             }
             // Dont re-request the same service details
             if (serviceAnswer && previousService?.servicePath !== serviceAnswer.servicePath) {
+                hasBackendAnnotations = undefined;
+                convertedMetadata = undefined;
                 previousService = serviceAnswer;
-                return await (0, service_helper_1.getServiceDetails)(serviceAnswer, connectValidator, requiredOdataVersion);
+                const validationResult = await (0, service_helper_1.validateService)(serviceAnswer, connectValidator, requiredOdataVersion);
+                hasBackendAnnotations = validationResult.hasAnnotations;
+                convertedMetadata = validationResult.convertedMetadata;
+                return validationResult.validationResult;
             }
             return true;
         }
@@ -127,10 +136,10 @@ function getSystemServiceQuestion(connectValidator, promptNamespace, promptOptio
             when: async (answers) => {
                 const selectedService = answers?.[`${promptNamespace}:${types_1.promptNames.serviceSelection}`];
                 if (selectedService && connectValidator.validatedUrl) {
-                    const result = await (0, service_helper_1.getServiceDetails)(selectedService, connectValidator);
-                    if (typeof result === 'string') {
-                        logger_helper_1.default.logger.error(result);
-                        throw new Error(result);
+                    const { validationResult } = await (0, service_helper_1.validateService)(selectedService, connectValidator);
+                    if (typeof validationResult === 'string') {
+                        logger_helper_1.default.logger.error(validationResult);
+                        throw new Error(validationResult);
                     }
                 }
                 if (serviceChoices.length === 0 && prompt_helpers_1.errorHandler.hasError()) {

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

@@ -5,6 +5,7 @@ import { OdataVersion } from '@sap-ux/odata-service-writer';
 import type { ListChoiceOptions } from 'inquirer';
 import type { ConnectionValidator } from '../../../connectionValidator';
 import type { ServiceAnswer } from './types';
+import type { ConvertedMetadata } from '@sap-ux/vocabularies-types';
 export declare const telemEventBASServiceSuccess = "SERVICE_INQUIRER_BAS_SUCCESS";
 /**
  * Refines the error type and logs based on the specified options. This should log more precise error messages based on inputs
@@ -40,6 +41,11 @@ export declare function sendDestinationServiceSuccessTelemetryEvent(destination:
  * @returns service type
  */
 export declare function getServiceType(servicePath: string, serviceType: string | undefined, catalog: V2CatalogService): Promise<ServiceType | undefined>;
+type ValidateServiceResult = {
+    validationResult: boolean | string;
+    hasAnnotations?: boolean;
+    convertedMetadata?: ConvertedMetadata;
+};
 /**
  * Requests and sets the service details to the PromptState.odataService properties.
  * If an error occurs, the error message is returned for use in validators.
@@ -49,7 +55,7 @@ export declare function getServiceType(servicePath: string, serviceType: string
  * @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>;
+export declare function validateService(service: ServiceAnswer, connectionValidator: ConnectionValidator, requiredOdataVersion?: OdataVersion): Promise<ValidateServiceResult>;
 /**
  * Create a value for the service selection prompt message, which may include thge active connected user name.
  *
@@ -57,6 +63,10 @@ export declare function getServiceDetails(service: ServiceAnswer, connectionVali
  * @returns The service selection prompt message
  */
 export declare function getSelectedServiceLabel(username: string | undefined): string;
+type ShowCollabDraftWarnOptions = {
+    edmx: ConvertedMetadata;
+    showCollabDraftWarning: boolean;
+};
 /**
  * Get the service selection prompt additional message. This prompt will make an additional call to the system backend
  * to retrieve the service type and display a warning message if the service type is not UI.
@@ -64,9 +74,17 @@ export declare function getSelectedServiceLabel(username: string | undefined): s
  * @param serviceChoices a list of service choices
  * @param selectedService the selected service
  * @param connectValidator the connection validator
- * @param requiredOdataVersion the required OData version for the service
- * @param hasAnnotations used to determine whether to show a warning message that annotations could not be retrieved
+ * @param options additional options
+ * @param options.requiredOdataVersion the required OData version for the service
+ * @param options.hasAnnotations used to determine whether to show a warning message that annotations could not be retrieved
+ * @param options.showCollabDraftWarnOptions to show the collaborative draft warning, the option `showCollabDraftWarning` must be true
+ *  and the edmx metadata must be provided
  * @returns the service selection prompt additional message
  */
-export declare function getSelectedServiceMessage(serviceChoices: ListChoiceOptions<ServiceAnswer>[], selectedService: ServiceAnswer, connectValidator: ConnectionValidator, requiredOdataVersion?: OdataVersion, hasAnnotations?: boolean): Promise<IMessageSeverity | undefined>;
+export declare function getSelectedServiceMessage(serviceChoices: ListChoiceOptions<ServiceAnswer>[], selectedService: ServiceAnswer, connectValidator: ConnectionValidator, { requiredOdataVersion, hasAnnotations, showCollabDraftWarnOptions }: {
+    requiredOdataVersion?: OdataVersion;
+    hasAnnotations?: boolean;
+    showCollabDraftWarnOptions?: ShowCollabDraftWarnOptions;
+}): Promise<IMessageSeverity | undefined>;
+export {};
 //# sourceMappingURL=service-helper.d.ts.map

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

@@ -7,7 +7,7 @@ exports.telemEventBASServiceSuccess = void 0;
 exports.getServiceChoices = getServiceChoices;
 exports.sendDestinationServiceSuccessTelemetryEvent = sendDestinationServiceSuccessTelemetryEvent;
 exports.getServiceType = getServiceType;
-exports.getServiceDetails = getServiceDetails;
+exports.validateService = validateService;
 exports.getSelectedServiceLabel = getSelectedServiceLabel;
 exports.getSelectedServiceMessage = getSelectedServiceMessage;
 const yeoman_ui_types_1 = require("@sap-devx/yeoman-ui-types");
@@ -20,6 +20,7 @@ const utils_1 = require("../../../../utils");
 const logger_helper_1 = __importDefault(require("../../../logger-helper"));
 const prompt_helpers_1 = require("../../../prompt-helpers");
 const validators_1 = require("../../../validators");
+const service_helpers_1 = require("../../service-helpers/service-helpers");
 // Service ids continaining these paths should not be offered as UI compatible services
 const nonUIServicePaths = ['/IWBEP/COMMON/'];
 // Telemetry event name for successful service validation on BAS, note: legacy event names should not be changed
@@ -192,11 +193,11 @@ async function getServiceType(servicePath, serviceType, catalog) {
  * @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) {
+async function validateService(service, connectionValidator, requiredOdataVersion) {
     const serviceCatalog = connectionValidator.catalogs?.[service.serviceODataVersion];
     if (!connectionValidator.serviceProvider) {
         logger_helper_1.default.logger.error('ConnectionValidator connection is not initialized');
-        return false;
+        return { validationResult: false };
     }
     // We may already have an odata service endpoint connection
     let odataService = connectionValidator.odataService;
@@ -205,11 +206,11 @@ async function getServiceDetails(service, connectionValidator, requiredOdataVers
     }
     const serviceResult = await getServiceMetadata(service.servicePath, odataService, serviceCatalog);
     if (typeof serviceResult === 'string') {
-        return serviceResult;
+        return { validationResult: serviceResult };
     }
-    const { validationMsg, version } = (0, validators_1.validateODataVersion)(serviceResult.metadata, requiredOdataVersion);
+    const { validationMsg, version, convertedMetadata } = (0, validators_1.validateODataVersion)(serviceResult.metadata, requiredOdataVersion);
     if (validationMsg) {
-        return validationMsg;
+        return { validationResult: validationMsg };
     }
     // If destinationUrl is available, use it, as validatedUrl may be in the form <protocal>:<destinationName>.dest
     const url = connectionValidator.destinationUrl ?? connectionValidator.validatedUrl;
@@ -224,7 +225,11 @@ async function getServiceDetails(service, connectionValidator, requiredOdataVers
     utils_1.PromptState.odataService.servicePath = service.servicePath;
     utils_1.PromptState.odataService.origin = origin;
     utils_1.PromptState.odataService.sapClient = connectionValidator.validatedClient;
-    return true;
+    return {
+        validationResult: true,
+        hasAnnotations: !!utils_1.PromptState.odataService.annotations && utils_1.PromptState.odataService.annotations.length > 0,
+        convertedMetadata
+    };
 }
 /**
  * Create a value for the service selection prompt message, which may include thge active connected user name.
@@ -246,11 +251,14 @@ function getSelectedServiceLabel(username) {
  * @param serviceChoices a list of service choices
  * @param selectedService the selected service
  * @param connectValidator the connection validator
- * @param requiredOdataVersion the required OData version for the service
- * @param hasAnnotations used to determine whether to show a warning message that annotations could not be retrieved
+ * @param options additional options
+ * @param options.requiredOdataVersion the required OData version for the service
+ * @param options.hasAnnotations used to determine whether to show a warning message that annotations could not be retrieved
+ * @param options.showCollabDraftWarnOptions to show the collaborative draft warning, the option `showCollabDraftWarning` must be true
+ *  and the edmx metadata must be provided
  * @returns the service selection prompt additional message
  */
-async function getSelectedServiceMessage(serviceChoices, selectedService, connectValidator, requiredOdataVersion, hasAnnotations = true) {
+async function getSelectedServiceMessage(serviceChoices, selectedService, connectValidator, { requiredOdataVersion, hasAnnotations = true, showCollabDraftWarnOptions }) {
     if (serviceChoices?.length === 0) {
         if (requiredOdataVersion) {
             return {
@@ -279,6 +287,16 @@ async function getSelectedServiceMessage(serviceChoices, selectedService, connec
             }
             serviceType = await getServiceType(selectedService.servicePath, selectedService.serviceType, connectValidator.catalogs[axios_extension_1.ODataVersion.v2]);
         }
+        else if (showCollabDraftWarnOptions?.showCollabDraftWarning &&
+            selectedService.serviceODataVersion === axios_extension_1.ODataVersion.v4) {
+            const result = (0, service_helpers_1.showCollabDraftWarning)(showCollabDraftWarnOptions.edmx);
+            if (result) {
+                return {
+                    message: (0, i18n_1.t)('prompts.warnings.collaborativeDraftMessage'),
+                    severity: yeoman_ui_types_1.Severity.warning
+                };
+            }
+        }
         if (serviceType && serviceType !== axios_extension_1.ServiceType.UI) {
             return {
                 message: (0, i18n_1.t)('prompts.warnings.nonUIServiceTypeWarningMessage', { serviceType: 'A2X' }),

package/dist/prompts/datasources/service-helpers/service-helpers.d.ts

@@ -0,0 +1,9 @@
+import type { ConvertedMetadata } from '@sap-ux/vocabularies-types';
+/**
+ * Determines if the collaborative draft warning should be shown.
+ *
+ * @param edmx metadata string or converted metadata can also be provided to prevent re-parsing
+ * @returns true if the warning should be shown
+ */
+export declare function showCollabDraftWarning(edmx: string | ConvertedMetadata): boolean;
+//# sourceMappingURL=service-helpers.d.ts.map

package/dist/prompts/datasources/service-helpers/service-helpers.js

@@ -0,0 +1,48 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.showCollabDraftWarning = showCollabDraftWarning;
+const annotation_converter_1 = require("@sap-ux/annotation-converter");
+const edmx_parser_1 = require("@sap-ux/edmx-parser");
+const entity_helper_1 = require("../../edmx/entity-helper");
+const logger_helper_1 = __importDefault(require("../../logger-helper"));
+const i18n_1 = require("../../../i18n");
+/**
+ * If any of the draft root annotated entity sets have the share action property, then collaborative draft is enabled.
+ *
+ * @param draftEnabledEntitySets entity sets with draft enabled property `HasDraftEntity`
+ * @returns
+ */
+function hasCollaborativeDraft(draftEnabledEntitySets) {
+    const entitySetWithDraftRootAndShareAction = draftEnabledEntitySets.find((entitySet) => entitySet.annotations?.Common?.DraftRoot ? !!entitySet.annotations.Common.DraftRoot.ShareAction : false);
+    return !!entitySetWithDraftRootAndShareAction;
+}
+/**
+ * Determines if the collaborative draft warning should be shown.
+ *
+ * @param edmx metadata string or converted metadata can also be provided to prevent re-parsing
+ * @returns true if the warning should be shown
+ */
+function showCollabDraftWarning(edmx) {
+    let showWarning = false;
+    try {
+        let convertedMetadata;
+        if (typeof edmx === 'string') {
+            convertedMetadata = (0, annotation_converter_1.convert)((0, edmx_parser_1.parse)(edmx));
+        }
+        else {
+            convertedMetadata = edmx;
+        }
+        const draftEnabledEntitySets = (0, entity_helper_1.filterDraftEnabledEntities)(convertedMetadata.entitySets) ?? [];
+        if (draftEnabledEntitySets?.length > 0) {
+            showWarning = !hasCollaborativeDraft(draftEnabledEntitySets);
+        }
+    }
+    catch (err) {
+        logger_helper_1.default.logger.error((0, i18n_1.t)('errors.unparseableMetadata', { error: err.message }));
+    }
+    return showWarning;
+}
+//# sourceMappingURL=service-helpers.js.map

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

@@ -1,12 +1,10 @@
 import type { Question } from 'inquirer';
-import type { OdataServiceAnswers, OdataServicePromptOptions } from '../../../types';
+import type { OdataServiceAnswers, OdataServiceUrlPromptOptions } from '../../../types';
 /**
  * Get the service URL questions.
  *
- * @param promptOptions prompt options that can be passed to the service URL questions to configure behaviour
- * @param promptOptions.serviceUrl see {@link OdataServicePromptOptions}
- * @param promptOptions.serviceUrlPassword see {@link OdataServicePromptOptions}
+ * @param serviceUrlPromptOptions Options used to control prompt behaviour, see {@link OdataServiceUrlPromptOptions} for details
  * @returns the odata service URL questions
  */
-export declare function getServiceUrlQuestions({ serviceUrl: serviceUrlOpts, serviceUrlPassword: passwordOpts }?: OdataServicePromptOptions): Question<OdataServiceAnswers>[];
+export declare function getServiceUrlQuestions(serviceUrlPromptOptions?: OdataServiceUrlPromptOptions): Question<OdataServiceAnswers>[];
 //# sourceMappingURL=questions.d.ts.map

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

@@ -4,23 +4,28 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.getServiceUrlQuestions = getServiceUrlQuestions;
+const yeoman_ui_types_1 = require("@sap-devx/yeoman-ui-types");
+const fiori_generator_shared_1 = require("@sap-ux/fiori-generator-shared");
 const inquirer_common_1 = require("@sap-ux/inquirer-common");
 const i18n_1 = require("../../../i18n");
 const types_1 = require("../../../types");
 const utils_1 = require("../../../utils");
 const connectionValidator_1 = require("../../connectionValidator");
 const logger_helper_1 = __importDefault(require("../../logger-helper"));
+const service_helpers_1 = require("../service-helpers/service-helpers");
 const types_2 = require("./types");
 const validators_1 = require("./validators");
-const fiori_generator_shared_1 = require("@sap-ux/fiori-generator-shared");
 /**
  * Prompt for the service URL.
  *
  * @param connectValidator Connection validator instance
  * @param requiredVersion The required OData version of the service
+ * @param showCollabDraftWarn
  * @returns the service URL prompt
  */
-function getServiceUrlPrompt(connectValidator, requiredVersion) {
+function getServiceUrlPrompt(connectValidator, requiredVersion, showCollabDraftWarn) {
+    let showAnnotationWarning = false;
+    let convertedMetadata;
     return {
         type: 'input',
         name: types_1.promptNames.serviceUrl,
@@ -31,6 +36,7 @@ function getServiceUrlPrompt(connectValidator, requiredVersion) {
         },
         message: (0, i18n_1.t)('prompts.odataServiceUrl.message', { odataVersion: requiredVersion }),
         validate: async (url) => {
+            showAnnotationWarning = false;
             const urlValidationState = await connectValidator.validateUrl(url);
             // Check if we have a cert error, the user will be prompted to ignore it later
             if (connectValidator.validity.canSkipCertError) {
@@ -38,25 +44,57 @@ function getServiceUrlPrompt(connectValidator, requiredVersion) {
             }
             if (urlValidationState === true) {
                 if (!connectValidator.validity.authRequired && connectValidator.odataService) {
-                    return (0, validators_1.validateService)(url, {
+                    showAnnotationWarning = false;
+                    convertedMetadata = undefined;
+                    const valResult = await (0, validators_1.validateService)(url, {
                         odataService: connectValidator.odataService,
                         axiosConfig: connectValidator.axiosConfig
                     }, requiredVersion);
+                    showAnnotationWarning = !!valResult.showAnnotationWarning;
+                    convertedMetadata = valResult.convertedMetadata;
+                    return valResult.validationResult;
                 }
                 return true;
             }
             return urlValidationState;
-        }
+        },
+        additionalMessages: () => getAdditionalMessages(showAnnotationWarning, showCollabDraftWarn, convertedMetadata)
     };
 }
+/**
+ * Get an additional message (IMessageSeverity) based on the specified parameters.
+ *
+ * @param showAnnotationWarning true to show annotation warning, this will take precedence over collaborative draft warning
+ * @param showCollabDraftWarn true to show collaborative draft warning, this will be shown only if `showAnnotationWarning` is false
+ *  and determines that collaborative draft is not enabled
+ * @param convertedMetadata provided to avoid reparsing the metadata
+ * @returns
+ */
+function getAdditionalMessages(showAnnotationWarning, showCollabDraftWarn, convertedMetadata) {
+    if (showAnnotationWarning) {
+        return {
+            message: (0, i18n_1.t)('prompts.warnings.noAnnotations'),
+            severity: yeoman_ui_types_1.Severity.warning
+        };
+    }
+    if (convertedMetadata && showCollabDraftWarn && (0, service_helpers_1.showCollabDraftWarning)(convertedMetadata)) {
+        return {
+            message: (0, i18n_1.t)('prompts.warnings.collaborativeDraftMessage'),
+            severity: yeoman_ui_types_1.Severity.warning
+        };
+    }
+}
 /**
  * Prompt to ignore cert errors.
  *
  * @param connectValidator Connection validator instance
  * @param requiredVersion The required OData version of the service
+ * @param showCollabDraftWarn
  * @returns the ignore cert errors prompt
  */
-function getIgnoreCertErrorsPrompt(connectValidator, requiredVersion) {
+function getIgnoreCertErrorsPrompt(connectValidator, requiredVersion, showCollabDraftWarn) {
+    let showAnnotationWarning = false;
+    let convertedMetadata;
     return {
         when: ({ serviceUrl }) => {
             if (serviceUrl && connectValidator.validity.canSkipCertError) {
@@ -69,6 +107,7 @@ function getIgnoreCertErrorsPrompt(connectValidator, requiredVersion) {
         message: (0, i18n_1.t)('prompts.ignoreCertErrors.message'),
         default: false,
         validate: async (ignoreCertError, { serviceUrl }) => {
+            showAnnotationWarning = false;
             if (!serviceUrl) {
                 return false;
             }
@@ -81,15 +120,19 @@ function getIgnoreCertErrorsPrompt(connectValidator, requiredVersion) {
             });
             if (validUrl === true) {
                 if (!connectValidator.validity.authRequired && connectValidator.odataService) {
-                    return (0, validators_1.validateService)(serviceUrl, {
+                    const valResult = await (0, validators_1.validateService)(serviceUrl, {
                         odataService: connectValidator.odataService,
                         axiosConfig: connectValidator.axiosConfig
                     }, requiredVersion, ignoreCertError);
+                    showAnnotationWarning = !!valResult.showAnnotationWarning;
+                    convertedMetadata = valResult.convertedMetadata;
+                    return valResult.validationResult;
                 }
                 return true;
             }
             return validUrl;
-        }
+        },
+        additionalMessages: () => getAdditionalMessages(showAnnotationWarning, showCollabDraftWarn, convertedMetadata)
     };
 }
 /**
@@ -122,12 +165,12 @@ function getCliIgnoreCertValidatePrompt(connectValidator, requiredVersion) {
                 }
                 if (!connectValidator.validity.authRequired && connectValidator.odataService) {
                     // Will log on CLI
-                    const validService = await (0, validators_1.validateService)(serviceUrl, {
+                    const { validationResult } = await (0, validators_1.validateService)(serviceUrl, {
                         odataService: connectValidator.odataService,
                         axiosConfig: connectValidator.axiosConfig
                     }, requiredVersion, true);
-                    if (validService !== true) {
-                        throw new Error((0, i18n_1.t)('errors.exitingGeneration', { exitReason: validService.toString() }));
+                    if (validationResult !== true) {
+                        throw new Error((0, i18n_1.t)('errors.exitingGeneration', { exitReason: validationResult.toString() }));
                     }
                 }
             }
@@ -159,9 +202,12 @@ function getUsernamePrompt(connectValidator) {
  *
  * @param connectValidator Connection validator instance
  * @param requiredVersion The required OData version of the service
+ * @param showCollabDraftWarn
  * @returns the password prompt
  */
-function getPasswordPrompt(connectValidator, requiredVersion) {
+function getPasswordPrompt(connectValidator, requiredVersion, showCollabDraftWarn) {
+    let showAnnotationWarning = false;
+    let convertedMetadata;
     return {
         when: () => (connectValidator.validity.reachable ? connectValidator.validity.authRequired === true : false),
         type: 'password',
@@ -182,43 +228,54 @@ function getPasswordPrompt(connectValidator, requiredVersion) {
                 sapClient
             });
             if (validAuth === true && connectValidator.odataService) {
-                return (0, validators_1.validateService)(serviceUrl, {
+                showAnnotationWarning = false;
+                convertedMetadata = undefined;
+                const valResult = await (0, validators_1.validateService)(serviceUrl, {
                     odataService: connectValidator.odataService,
                     axiosConfig: connectValidator.axiosConfig
                 }, requiredVersion, ignoreCertError);
+                showAnnotationWarning = !!valResult.showAnnotationWarning;
+                convertedMetadata = valResult.convertedMetadata;
+                return valResult.validationResult;
             }
             return validAuth;
-        }
+        },
+        additionalMessages: () => getAdditionalMessages(showAnnotationWarning, showCollabDraftWarn, convertedMetadata)
     };
 }
 /**
  * Get the service URL questions.
  *
- * @param promptOptions prompt options that can be passed to the service URL questions to configure behaviour
- * @param promptOptions.serviceUrl see {@link OdataServicePromptOptions}
- * @param promptOptions.serviceUrlPassword see {@link OdataServicePromptOptions}
+ * @param serviceUrlPromptOptions Options used to control prompt behaviour, see {@link OdataServiceUrlPromptOptions} for details
  * @returns the odata service URL questions
  */
-function getServiceUrlQuestions({ serviceUrl: serviceUrlOpts, serviceUrlPassword: passwordOpts } = {}) {
+function getServiceUrlQuestions(serviceUrlPromptOptions = {}) {
     // Connection validator maintains connection state and validity across multiple prompts
     const connectValidator = new connectionValidator_1.ConnectionValidator();
-    const requiredVersion = serviceUrlOpts?.requiredOdataVersion;
+    const requiredVersion = serviceUrlPromptOptions?.requiredOdataVersion;
     utils_1.PromptState.reset();
     let questions = [
-        getServiceUrlPrompt(connectValidator, requiredVersion),
-        getIgnoreCertErrorsPrompt(connectValidator, requiredVersion)
+        getServiceUrlPrompt(connectValidator, requiredVersion, serviceUrlPromptOptions?.showCollaborativeDraftWarning),
+        getIgnoreCertErrorsPrompt(connectValidator, requiredVersion, serviceUrlPromptOptions?.showCollaborativeDraftWarning)
     ];
     if ((0, utils_1.getPromptHostEnvironment)() === fiori_generator_shared_1.hostEnvironment.cli) {
         questions.push(getCliIgnoreCertValidatePrompt(connectValidator, requiredVersion));
     }
-    questions.push(getUsernamePrompt(connectValidator), getPasswordPrompt(connectValidator, requiredVersion));
-    // Add additional messages to prompts if specified in the prompt options
+    questions.push(getUsernamePrompt(connectValidator), getPasswordPrompt(connectValidator, requiredVersion, serviceUrlPromptOptions?.showCollaborativeDraftWarning));
+    // Add additional messages to prompts if specified in the prompt options.
+    // Note that the additional messages specified for the service URL prompt will also be added to the ignore cert errors prompt and password prompt
+    // this is to ensure that the messages are rendered in YUI regardless of authorization or cert prompts being displayed.
     let promptsOptToExtend = {};
-    if (serviceUrlOpts?.additionalMessages) {
-        promptsOptToExtend = { serviceUrl: serviceUrlOpts };
-    }
-    if (passwordOpts?.additionalMessages) {
-        promptsOptToExtend = { ...promptsOptToExtend, serviceUrlPassword: passwordOpts };
+    if (serviceUrlPromptOptions?.additionalMessages) {
+        promptsOptToExtend = {
+            [types_1.promptNames.serviceUrl]: serviceUrlPromptOptions,
+            [types_1.promptNames.serviceUrlPassword]: {
+                additionalMessages: serviceUrlPromptOptions?.additionalMessages
+            },
+            [types_2.serviceUrlInternalPromptNames.ignoreCertError]: {
+                additionalMessages: serviceUrlPromptOptions?.additionalMessages
+            }
+        };
     }
     if (promptsOptToExtend) {
         questions = (0, inquirer_common_1.extendWithOptions)(questions, promptsOptToExtend, utils_1.PromptState.odataService);

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

@@ -1,5 +1,11 @@
 import { type AxiosRequestConfig, type ODataService } from '@sap-ux/axios-extension';
-import type { OdataVersion } from '@sap-ux/odata-service-writer';
+import { OdataVersion } from '@sap-ux/odata-service-writer';
+import type { ConvertedMetadata } from '@sap-ux/vocabularies-types';
+type ValidateServiceUrlResult = {
+    validationResult: boolean | string;
+    showAnnotationWarning?: boolean;
+    convertedMetadata?: ConvertedMetadata;
+};
 /**
  * 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.
@@ -15,5 +21,6 @@ import type { OdataVersion } from '@sap-ux/odata-service-writer';
 export declare function validateService(url: string, { odataService, axiosConfig }: {
     odataService: ODataService;
     axiosConfig: AxiosRequestConfig;
-}, requiredVersion?: OdataVersion | undefined, ignoreCertError?: boolean): Promise<boolean | string>;
+}, requiredVersion?: OdataVersion | undefined, ignoreCertError?: boolean): Promise<ValidateServiceUrlResult>;
+export {};
 //# sourceMappingURL=validators.d.ts.map

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

@@ -6,6 +6,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.validateService = validateService;
 const axios_extension_1 = require("@sap-ux/axios-extension");
 const inquirer_common_1 = require("@sap-ux/inquirer-common");
+const odata_service_writer_1 = require("@sap-ux/odata-service-writer");
 const i18n_1 = require("../../../i18n");
 const types_1 = require("../../../types");
 const utils_1 = require("../../../utils");
@@ -33,7 +34,9 @@ async function validateService(url, { odataService, axiosConfig }, requiredVersi
         const metadata = await odataService.metadata();
         const odataVersionValResult = (0, validators_1.validateODataVersion)(metadata, requiredVersion);
         if (odataVersionValResult.validationMsg) {
-            return odataVersionValResult.validationMsg;
+            return {
+                validationResult: odataVersionValResult.validationMsg
+            };
         }
         const serviceOdataVersion = odataVersionValResult.version;
         // Remove all occurrences of the origin from the metadata to make backend uris relative
@@ -46,6 +49,7 @@ async function validateService(url, { odataService, axiosConfig }, requiredVersi
         utils_1.PromptState.odataService.servicePath = `${fullUrl.pathname}${fullUrl.search}`;
         utils_1.PromptState.odataService.origin = fullUrl.origin;
         utils_1.PromptState.odataService.sapClient = sapClient;
+        let showAnnotationWarning = false;
         // Best effort attempt to get annotations but dont throw an error if it fails as this may not even be an Abap system
         try {
             // Create an abap provider instance to get the annotations using the same request config
@@ -57,22 +61,34 @@ async function validateService(url, { odataService, axiosConfig }, requiredVersi
             logger_helper_1.default.logger.debug(`Annotations array of length: ${annotations?.length} returned`);
             if (annotations?.length === 0 || !annotations) {
                 logger_helper_1.default.logger.info((0, i18n_1.t)('prompts.validationMessages.annotationsNotFound'));
+                // Only show the warning if the service is v2, since these are backend annotations
+                showAnnotationWarning = odataVersionValResult.version === odata_service_writer_1.OdataVersion.v2;
             }
             utils_1.PromptState.odataService.annotations = annotations;
         }
         catch (err) {
             logger_helper_1.default.logger.info((0, i18n_1.t)('prompts.validationMessages.annotationsNotFound'));
+            // Only show the warning if the service is v2, since these are backend annotations
+            showAnnotationWarning = odataVersionValResult.version === odata_service_writer_1.OdataVersion.v2;
         }
-        return true;
+        return {
+            validationResult: true,
+            showAnnotationWarning,
+            convertedMetadata: odataVersionValResult.convertedMetadata
+        };
     }
     catch (error) {
         delete utils_1.PromptState.odataService.metadata;
         // Provide a more specific error message if the metadata service URL is not found
         if (inquirer_common_1.ErrorHandler.getErrorType(error) === inquirer_common_1.ERROR_TYPE.NOT_FOUND) {
             // No metadata implies not a valid odata service
-            return inquirer_common_1.ErrorHandler.getErrorMsgFromType(inquirer_common_1.ERROR_TYPE.ODATA_URL_NOT_FOUND) ?? false;
+            return {
+                validationResult: inquirer_common_1.ErrorHandler.getErrorMsgFromType(inquirer_common_1.ERROR_TYPE.ODATA_URL_NOT_FOUND) ?? false
+            };
         }
-        return prompt_helpers_1.errorHandler.logErrorMsgs(error);
+        return {
+            validationResult: prompt_helpers_1.errorHandler.logErrorMsgs(error)
+        };
     }
     finally {
         connectionValidator_1.ConnectionValidator.setGlobalRejectUnauthorized(true);

package/dist/prompts/edmx/alp-questions.js

@@ -13,7 +13,7 @@ const utils_1 = require("../../utils");
  * @returns the matching `UI.selectionPresentationVariant` qualifers as prompt choices
  */
 function getQualifierChoices(annotations, entityType) {
-    const qualifierChoices = [{ name: (0, i18n_1.t)('texts.choiceNameNone'), value: undefined }];
+    const qualifierChoices = [{ name: (0, i18n_1.t)('texts.choiceNameNone'), value: '' }];
     const parsedDefinitions = (0, utils_1.xmlToJson)(annotations?.Definitions) || {};
     const parsedAnnotations = parsedDefinitions.Edmx.DataServices.Schema?.Annotations;
     let filteredAnnotations = [];
@@ -56,11 +56,11 @@ function getQualifierChoices(annotations, entityType) {
 function getAnalyticListPageQuestions(odataVersion, annotations, hideTableLayoutPrompts = false) {
     const alpQuestions = [];
     if (annotations && odataVersion === odata_service_writer_1.OdataVersion.v2) {
-        const qualifierChoices = [];
+        let qualifierChoices = [];
         alpQuestions.push({
             when: (answers) => {
                 if (answers.mainEntity) {
-                    qualifierChoices.push(...getQualifierChoices(annotations, answers.mainEntity?.entitySetType));
+                    qualifierChoices = getQualifierChoices(annotations, answers.mainEntity?.entitySetType);
                 }
                 return qualifierChoices.length > 1;
             },

package/dist/prompts/edmx/entity-helper.d.ts

@@ -1,5 +1,5 @@
 import { OdataVersion } from '@sap-ux/odata-service-writer';
-import type { ConvertedMetadata } from '@sap-ux/vocabularies-types';
+import type { ConvertedMetadata, EntitySet } from '@sap-ux/vocabularies-types';
 import type { ListChoiceOptions } from 'inquirer';
 export type EntityAnswer = {
     entitySetName: string;
@@ -44,4 +44,11 @@ export declare function getEntityChoices(edmx: string, { useEntityTypeAsName, en
  * @returns the navigation entity choices
  */
 export declare function getNavigationEntityChoices(metadata: ConvertedMetadata, odataVersion: OdataVersion, mainEntityName: string): ListChoiceOptions<NavigationEntityAnswer>[];
+/**
+ * Returns only entities that have a type property of 'HasDraftEnabled'.
+ *
+ * @param entitySets the entity sets to filter by draft enabled entities
+ * @returns the filtered entity sets
+ */
+export declare function filterDraftEnabledEntities(entitySets: EntitySet[]): EntitySet[] | undefined;
 //# sourceMappingURL=entity-helper.d.ts.map

package/dist/prompts/edmx/entity-helper.js

@@ -5,6 +5,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.getEntityChoices = getEntityChoices;
 exports.getNavigationEntityChoices = getNavigationEntityChoices;
+exports.filterDraftEnabledEntities = filterDraftEnabledEntities;
 const annotation_converter_1 = require("@sap-ux/annotation-converter");
 const edmx_parser_1 = require("@sap-ux/edmx-parser");
 const odata_service_writer_1 = require("@sap-ux/odata-service-writer");

package/dist/prompts/prompts.js

@@ -51,7 +51,7 @@ async function getDatasourceTypeConditionalQuestions(promptOptions) {
     conditionalQuestions.push(...(0, inquirer_common_1.withCondition)((await (0, system_selection_1.getSystemSelectionQuestions)(promptOptions)), (answers) => answers.datasourceType === types_1.DatasourceType.sapSystem));
     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_2.getServiceUrlQuestions)(promptOptions?.serviceUrl), (answers) => answers.datasourceType === types_1.DatasourceType.odataServiceUrl));
     return conditionalQuestions;
 }
 //# sourceMappingURL=prompts.js.map

package/dist/prompts/validators.d.ts

@@ -1,6 +1,9 @@
 import type { OdataVersion } from '@sap-ux/odata-service-writer';
+import type { ConvertedMetadata } from '@sap-ux/vocabularies-types';
 /**
  * Validator function to verify if the specified metadata edmx version matches the specified required odata version.
+ * Note that this parses the edmx to determine the odata version and also returns the converted metadata as a side effect to
+ * avoid consumers having to parse the edmx again.
  *
  * @param edmx the edmx to validate
  * @param requiredVersion the required odata version to validate against
@@ -9,5 +12,6 @@ import type { OdataVersion } from '@sap-ux/odata-service-writer';
 export declare function validateODataVersion(edmx: string, requiredVersion?: OdataVersion): {
     validationMsg?: string;
     version?: OdataVersion;
+    convertedMetadata?: ConvertedMetadata;
 };
 //# sourceMappingURL=validators.d.ts.map

package/dist/prompts/validators.js

@@ -9,6 +9,8 @@ const logger_helper_1 = __importDefault(require("./logger-helper"));
 const utils_1 = require("../utils");
 /**
  * Validator function to verify if the specified metadata edmx version matches the specified required odata version.
+ * Note that this parses the edmx to determine the odata version and also returns the converted metadata as a side effect to
+ * avoid consumers having to parse the edmx again.
  *
  * @param edmx the edmx to validate
  * @param requiredVersion the required odata version to validate against
@@ -16,10 +18,10 @@ const utils_1 = require("../utils");
  */
 function validateODataVersion(edmx, requiredVersion) {
     try {
-        const serviceOdataVersion = (0, utils_1.parseOdataVersion)(edmx);
-        if (requiredVersion && requiredVersion !== serviceOdataVersion) {
+        const { convertedMetadata, odataVersion } = (0, utils_1.parseOdataVersion)(edmx);
+        if (requiredVersion && requiredVersion !== odataVersion) {
             const odataErrorMsg = (0, i18n_1.t)('prompts.validationMessages.odataVersionMismatch', {
-                providedOdataVersion: serviceOdataVersion,
+                providedOdataVersion: odataVersion,
                 requiredOdataVersion: requiredVersion
             });
             logger_helper_1.default.logger.error(odataErrorMsg);
@@ -28,7 +30,8 @@ function validateODataVersion(edmx, requiredVersion) {
             };
         }
         return {
-            version: serviceOdataVersion
+            version: odataVersion,
+            convertedMetadata: convertedMetadata
         };
     }
     catch (err) {

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

@@ -64,7 +64,8 @@
             "nonUIServiceTypeWarningMessage": "Please note that {{serviceType}} services, or not classified 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",
-            "noAnnotations": "No backend annotations associated with this service were retrieved and may result in an invalid application being created"
+            "noAnnotations": "No backend annotations associated with this service were retrieved and may result in an invalid application being created",
+            "collaborativeDraftMessage": "The selected service is draft enabled but does not support collaborative draft."
         },
         "systemUrl": {
             "message": "System URL",

package/dist/types.d.ts

@@ -283,6 +283,11 @@ export type ServiceSelectionPromptOptions = {
      * If the service selection prompt is hidden then the odata service related answer properties will not be returned.
      */
     hide?: boolean;
+    /**
+     * If true, warn the user if the selected service has draft root annotated entity sets but does not have the share action property set.
+     * This is used to indicate that the service does not support collaborative draft.
+     */
+    showCollaborativeDraftWarning?: boolean;
 } & Pick<CommonPromptOptions, 'additionalMessages'>;
 export type SystemNamePromptOptions = {
     /**
@@ -296,12 +301,16 @@ export type OdataServiceUrlPromptOptions = {
      * Used to validate the service specified by the url is of the required odata version edmx
      */
     requiredOdataVersion?: OdataVersion;
+    /**
+     * If true, warn the user if the selected service has draft root annotated entity sets but does not have the share action property set.
+     * This is used to indicate that the service does not support collaborative draft.
+     */
+    showCollaborativeDraftWarning?: boolean;
 } & Pick<CommonPromptOptions, 'additionalMessages'>;
-export type OdataServiceUrlPasswordOptions = Pick<CommonPromptOptions, 'additionalMessages'>;
 /**
  * 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> & 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>;
 export type OdataServiceQuestion = YUIQuestion<OdataServiceAnswers>;
 export type OdataServicePromptOptions = Partial<odataServiceInquirerPromptOptions>;
 /**

package/dist/utils/index.d.ts

@@ -3,6 +3,7 @@ import { type HostEnvironmentId } from '@sap-ux/fiori-generator-shared';
 import { OdataVersion } from '@sap-ux/odata-service-writer';
 import type { ListChoiceOptions } from 'inquirer';
 import { PromptState } from './prompt-state';
+import type { ConvertedMetadata } from '@sap-ux/vocabularies-types';
 /**
  * Determine if the current prompting environment is cli or a hosted extension (app studio or vscode).
  *
@@ -16,9 +17,13 @@ export declare function getPromptHostEnvironment(): {
  * Validate xml and parse the odata version from the metadata xml.
  *
  * @param metadata a metadata string
- * @returns the odata version of the specified metadata, throws an error if the metadata is invalid
+ * @returns the odata version of the specified metadata, along with the converted metadata in case further processing may be required to avoid re-parsing.
+ *  Throws an error if the metadata or odata version is invalid.
  */
-export declare function parseOdataVersion(metadata: string): OdataVersion;
+export declare function parseOdataVersion(metadata: string): {
+    odataVersion: OdataVersion;
+    convertedMetadata: ConvertedMetadata;
+};
 /**
  * Convert specified xml string to JSON.
  *

package/dist/utils/index.js

@@ -19,6 +19,8 @@ const i18n_1 = require("../i18n");
 const logger_helper_1 = __importDefault(require("../prompts/logger-helper"));
 const prompt_state_1 = require("./prompt-state");
 Object.defineProperty(exports, "PromptState", { enumerable: true, get: function () { return prompt_state_1.PromptState; } });
+const annotation_converter_1 = require("@sap-ux/annotation-converter");
+const edmx_parser_1 = require("@sap-ux/edmx-parser");
 /**
  * Determine if the current prompting environment is cli or a hosted extension (app studio or vscode).
  *
@@ -36,13 +38,23 @@ function getPromptHostEnvironment() {
  * Validate xml and parse the odata version from the metadata xml.
  *
  * @param metadata a metadata string
- * @returns the odata version of the specified metadata, throws an error if the metadata is invalid
+ * @returns the odata version of the specified metadata, along with the converted metadata in case further processing may be required to avoid re-parsing.
+ *  Throws an error if the metadata or odata version is invalid.
  */
 function parseOdataVersion(metadata) {
     try {
-        const parsed = xmlToJson(metadata);
-        const odataVersion = parsed['Edmx']['Version'] === 1 ? odata_service_writer_1.OdataVersion.v2 : odata_service_writer_1.OdataVersion.v4;
-        return odataVersion;
+        const convertedMetadata = (0, annotation_converter_1.convert)((0, edmx_parser_1.parse)(metadata));
+        const parsedOdataVersion = parseInt(convertedMetadata?.version, 10);
+        if (Number.isNaN(parsedOdataVersion)) {
+            logger_helper_1.default.logger.error((0, i18n_1.t)('errors.unparseableOdataVersion'));
+            throw new Error((0, i18n_1.t)('errors.unparseableOdataVersion'));
+        }
+        // Note that odata version > `4` e.g. `4.1`, is not currently supported by `@sap-ux/edmx-converter`
+        const odataVersion = parsedOdataVersion === 4 ? odata_service_writer_1.OdataVersion.v4 : odata_service_writer_1.OdataVersion.v2;
+        return {
+            odataVersion,
+            convertedMetadata
+        };
     }
     catch (error) {
         logger_helper_1.default.logger.error(error);

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.0.1",
+  "version": "2.1.0",
   "repository": {
     "type": "git",
     "url": "https://github.com/SAP/open-ux-tools.git",
@@ -33,7 +33,7 @@
     "@sap-ux/fiori-generator-shared": "0.7.22",
     "@sap-ux/guided-answers-helper": "0.2.1",
     "@sap-ux/telemetry": "0.5.54",
-    "@sap-ux/inquirer-common": "0.6.8",
+    "@sap-ux/inquirer-common": "0.6.9",
     "@sap-ux/logger": "0.6.0",
     "@sap-ux/project-access": "1.29.2",
     "@sap-ux/project-input-validator": "0.3.4",