@sap-ux/odata-service-inquirer 0.8.8 → 1.0.0

package/README.md

@@ -1,9 +1,6 @@
 # @sap-ux/odata-service-inquirer
 
-Provides Inquirer based end-user prompting to allow selection of a service from multiple data source types. This involves acquiring a connection to backend systems and retrieving edmx metadata for services provided by the catalog, from a local file or CAP project.
-
-**Note:**
-Current implementation is limited to metadata file and Local Cap projects as datasources only.
+Provides Inquirer based end-user prompting to allow selection of a service from multiple data source types. This involves acquiring a connection to backend systems and retrieving edmx metadata for services provided by the catalog, from a local file or CAP project. This module also provides prompts that may be used to gather user selections to define the main and navigation entities and related prompts relating to application layout and annotation generation when creating a UI5 application using the `@sap-ux/fiori-freestyle-writer` and `@sap-ux/fiori-elements-writer` modules.
 
 ## Installation
 Npm

package/dist/index.d.ts

@@ -1,13 +1,14 @@
-import { type InquirerAdapter } from '@sap-ux/inquirer-common';
-import type { Question } from 'inquirer';
+import { type InquirerAdapter, ERROR_TYPE, ErrorHandler } 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 '@sap-ux/inquirer-common';
-import { type SystemSelectionAnswers, SystemSelectionAnswerType } from './prompts/datasources/sap-system/system-selection';
+import type { Question } from 'inquirer';
 import type { ServiceAnswer } from './prompts/datasources/sap-system/service-selection';
-import type { NewSystemChoice, CfAbapEnvServiceChoice } from './prompts/datasources/sap-system/system-selection/prompt-helpers';
-import { DatasourceType, promptNames, type CapRuntime, type CapService, type OdataServiceAnswers, type OdataServicePromptOptions, type OdataServiceQuestion, type SapSystemType } from './types';
+import { type SystemSelectionAnswers, SystemSelectionAnswerType } from './prompts/datasources/sap-system/system-selection';
+import type { CfAbapEnvServiceChoice, NewSystemChoice } from './prompts/datasources/sap-system/system-selection/prompt-helpers';
+import type { Annotations } from '@sap-ux/axios-extension';
+import type { TemplateType } from '@sap-ux/fiori-elements-writer';
+import { type CapRuntime, type CapService, type OdataServiceAnswers, type OdataServicePromptOptions, type OdataServiceQuestion, type SapSystemType, type EntityPromptOptions, DatasourceType, EntityRelatedAnswers, promptNames } from './types';
 /**
  * Get the inquirer prompts for odata service.
  *
@@ -32,6 +33,20 @@ declare function getSystemSelectionQuestions(promptOptions?: OdataServicePromptO
     prompts: Question<SystemSelectionAnswers & ServiceAnswer>[];
     answers: Partial<OdataServiceAnswers>;
 }>;
+/**
+ * Get the questions that may be used to prompt for entity selection, table configuration, annotation generation, and ALP specific table configuration.
+ * Since these are releated to service metadata processing and entity selection, they are grouped together.
+ *
+ * @param metadata the metadata (edmx) string from which to extract entity choices
+ * @param templateType the template type which will define the type of prompts and their choices
+ * @param isCapService if true, the service is a CAP service, some prompts will be adjusted accordingly
+ * @param promptOptions options that can control some of the prompt behavior. See {@link EntityPromptOptions} for details
+ * @param annotations annotations to be used for entity selection, only used for analytical list page presentation variant qualifier choices when the edmx odata version is `2`
+ * @param logger a logger compatible with the {@link Logger} interface
+ * @param isYUI if true, the prompt is being called from the Yeoman UI extension host
+ * @returns the prompts which may be used to prompt for entity selection, table configuration, annotation generation, and ALP specific table configuration
+ */
+declare function getEntityRelatedPrompts(metadata: string, templateType: TemplateType, isCapService?: boolean, promptOptions?: EntityPromptOptions, annotations?: Annotations, logger?: Logger, isYUI?: boolean): Question<EntityRelatedAnswers>[];
 /**
  * Prompt for odata service writer inputs.
  *
@@ -44,5 +59,5 @@ declare function getSystemSelectionQuestions(promptOptions?: OdataServicePromptO
  * @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, getPrompts, OdataVersion, prompt, promptNames, SystemSelectionAnswerType, type CapRuntime, type CapService, type InquirerAdapter, type OdataServiceAnswers, type OdataServicePromptOptions, type SapSystemType, NewSystemChoice, CfAbapEnvServiceChoice, getSystemSelectionQuestions };
+export { CfAbapEnvServiceChoice, DatasourceType, EntityRelatedAnswers, ERROR_TYPE, ErrorHandler, getEntityRelatedPrompts, getPrompts, getSystemSelectionQuestions, NewSystemChoice, 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

@@ -4,18 +4,20 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.promptNames = exports.OdataVersion = exports.ErrorHandler = exports.ERROR_TYPE = exports.DatasourceType = void 0;
+exports.getEntityRelatedPrompts = getEntityRelatedPrompts;
 exports.getPrompts = getPrompts;
-exports.prompt = prompt;
 exports.getSystemSelectionQuestions = getSystemSelectionQuestions;
-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"));
+exports.prompt = prompt;
 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 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 i18n_1 = require("./i18n");
 const prompts_1 = require("./prompts");
 const system_selection_1 = require("./prompts/datasources/sap-system/system-selection");
+const questions_1 = require("./prompts/edmx/questions");
 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; } });
@@ -62,6 +64,26 @@ async function getSystemSelectionQuestions(promptOptions) {
         answers: utils_1.PromptState.odataService
     };
 }
+/**
+ * Get the questions that may be used to prompt for entity selection, table configuration, annotation generation, and ALP specific table configuration.
+ * Since these are releated to service metadata processing and entity selection, they are grouped together.
+ *
+ * @param metadata the metadata (edmx) string from which to extract entity choices
+ * @param templateType the template type which will define the type of prompts and their choices
+ * @param isCapService if true, the service is a CAP service, some prompts will be adjusted accordingly
+ * @param promptOptions options that can control some of the prompt behavior. See {@link EntityPromptOptions} for details
+ * @param annotations annotations to be used for entity selection, only used for analytical list page presentation variant qualifier choices when the edmx odata version is `2`
+ * @param logger a logger compatible with the {@link Logger} interface
+ * @param isYUI if true, the prompt is being called from the Yeoman UI extension host
+ * @returns the prompts which may be used to prompt for entity selection, table configuration, annotation generation, and ALP specific table configuration
+ */
+function getEntityRelatedPrompts(metadata, templateType, isCapService = false, promptOptions, annotations, logger, isYUI = false) {
+    if (logger) {
+        logger_helper_1.default.logger = logger;
+    }
+    utils_1.PromptState.isYUI = isYUI;
+    return (0, questions_1.getEntitySelectionQuestions)(metadata, templateType, isCapService, promptOptions, annotations);
+}
 /**
  * Prompt for odata service writer inputs.
  *

package/dist/prompts/edmx/alp-questions.d.ts

@@ -0,0 +1,14 @@
+import type { Annotations } from '@sap-ux/axios-extension';
+import { OdataVersion } from '@sap-ux/odata-service-writer';
+import type { Question } from 'inquirer';
+import type { AlpTableConfigAnswers } from '../../types';
+/**
+ * Get questions that related to generation of Analytical List Page type applications.
+ *
+ * @param odataVersion odata version '2' or '4' will the table layout prompts to be shown
+ * @param annotations used to determine if the select presentation qualifier prompt should be shown
+ * @param hideTableLayoutPrompts hide the table layout prompts, certain consumers do not need these prompts
+ * @returns alp specific questions
+ */
+export declare function getAnalyticListPageQuestions(odataVersion: OdataVersion, annotations?: Annotations, hideTableLayoutPrompts?: boolean): Question<AlpTableConfigAnswers>[];
+//# sourceMappingURL=alp-questions.d.ts.map

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

@@ -0,0 +1,135 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getAnalyticListPageQuestions = getAnalyticListPageQuestions;
+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");
+/**
+ * Return the annotation `UI.selectionPresentationVariant.qualifier` properties as prompt choices for the specified annotations and entityType.
+ *
+ * @param annotations the annotations in which to search for the annotation: `UI.selectionPresentationVariant.qualifier`
+ * @param entityType the entityType of the annotations target in which to search for the annotation: `UI.selectionPresentationVariant.qualifier`
+ * @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 parsedDefinitions = (0, utils_1.xmlToJson)(annotations?.Definitions) || {};
+    const parsedAnnotations = parsedDefinitions.Edmx.DataServices.Schema?.Annotations;
+    let filteredAnnotations = [];
+    if (Array.isArray(parsedAnnotations)) {
+        filteredAnnotations = parsedAnnotations;
+    }
+    else if (typeof parsedAnnotations === 'object') {
+        filteredAnnotations.push(parsedAnnotations);
+    }
+    filteredAnnotations = filteredAnnotations.filter((a) => {
+        return a.Target === entityType;
+    });
+    if (filteredAnnotations.length > 0) {
+        const selectionPresentationTerm = 'UI.SelectionPresentationVariant';
+        let filterQualifiers = filteredAnnotations[0]?.Annotation;
+        if (Array.isArray(filterQualifiers)) {
+            filterQualifiers
+                .filter((a) => a.Term === selectionPresentationTerm)
+                .forEach((a) => {
+                if (a.Qualifier) {
+                    qualifierChoices.push({ name: a.Qualifier, value: a.Qualifier });
+                }
+            });
+        }
+        else if (filterQualifiers.Term === selectionPresentationTerm) {
+            filterQualifiers = [];
+            qualifierChoices.push({ name: filterQualifiers.Qualifier, value: filterQualifiers.Qualifier });
+        }
+    }
+    return qualifierChoices;
+}
+/**
+ * Get questions that related to generation of Analytical List Page type applications.
+ *
+ * @param odataVersion odata version '2' or '4' will the table layout prompts to be shown
+ * @param annotations used to determine if the select presentation qualifier prompt should be shown
+ * @param hideTableLayoutPrompts hide the table layout prompts, certain consumers do not need these prompts
+ * @returns alp specific questions
+ */
+function getAnalyticListPageQuestions(odataVersion, annotations, hideTableLayoutPrompts = false) {
+    const alpQuestions = [];
+    if (annotations && odataVersion === odata_service_writer_1.OdataVersion.v2) {
+        const qualifierChoices = [];
+        alpQuestions.push({
+            when: (answers) => {
+                if (answers.mainEntity) {
+                    qualifierChoices.push(...getQualifierChoices(annotations, answers.mainEntity?.entitySetType));
+                }
+                return qualifierChoices.length > 1;
+            },
+            type: 'list',
+            name: types_1.EntityPromptNames.presentationQualifier,
+            message: (0, i18n_1.t)('prompts.presentationQualifier.message'),
+            guiOptions: {
+                hint: (0, i18n_1.t)('prompts.presentationQualifier.hint'),
+                breadcrumb: true
+            },
+            choices: () => qualifierChoices,
+            default: 0
+        });
+    }
+    // Layout prompts
+    if (!hideTableLayoutPrompts) {
+        // v4 specific options
+        if (odataVersion === odata_service_writer_1.OdataVersion.v4) {
+            alpQuestions.push({
+                when: (prevAnswers) => {
+                    return !!prevAnswers.mainEntity;
+                },
+                type: 'list',
+                name: types_1.EntityPromptNames.tableSelectionMode,
+                message: (0, i18n_1.t)('prompts.tableSelectionMode.message'),
+                guiOptions: {
+                    hint: (0, i18n_1.t)('prompts.tableSelectionMode.hint'),
+                    breadcrumb: true
+                },
+                choices: () => [
+                    { name: (0, i18n_1.t)('prompts.tableSelectionMode.choiceNone'), value: 'None' },
+                    { name: (0, i18n_1.t)('prompts.tableSelectionMode.choiceAuto'), value: 'Auto' },
+                    { name: (0, i18n_1.t)('prompts.tableSelectionMode.choiceMulti'), value: 'Multi' },
+                    { name: (0, i18n_1.t)('prompts.tableSelectionMode.choiceSingle'), value: 'Single' }
+                ]
+            });
+        }
+        else {
+            // v2 specific options
+            alpQuestions.push({
+                type: 'confirm',
+                name: types_1.EntityPromptNames.tableMultiSelect,
+                message: (0, i18n_1.t)('prompts.tableMultiSelect.message'),
+                guiOptions: {
+                    hint: (0, i18n_1.t)('prompts.tableMultiSelect.hint'),
+                    breadcrumb: true
+                },
+                default: false
+            }, {
+                type: 'confirm',
+                name: types_1.EntityPromptNames.tableAutoHide,
+                message: (0, i18n_1.t)('prompts.tableAutoHide.message'),
+                guiOptions: {
+                    hint: (0, i18n_1.t)('prompts.tableAutoHide.hint'),
+                    breadcrumb: true
+                },
+                default: true
+            }, {
+                type: 'confirm',
+                name: types_1.EntityPromptNames.smartVariantManagement,
+                message: (0, i18n_1.t)('prompts.smartVariantManagement.message'),
+                guiOptions: {
+                    hint: (0, i18n_1.t)('prompts.smartVariantManagement.hint'),
+                    breadcrumb: true
+                },
+                default: false
+            });
+        }
+    }
+    return alpQuestions;
+}
+//# sourceMappingURL=alp-questions.js.map

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

@@ -0,0 +1,47 @@
+import { OdataVersion } from '@sap-ux/odata-service-writer';
+import type { ConvertedMetadata } from '@sap-ux/vocabularies-types';
+import type { ListChoiceOptions } from 'inquirer';
+export type EntityAnswer = {
+    entitySetName: string;
+    entitySetType: string;
+};
+export type NavigationEntityAnswer = {
+    navigationPropertyName: string;
+    entitySetName: string;
+};
+export interface EntityChoiceOptions {
+    choices: ListChoiceOptions<EntityAnswer>[];
+    draftRootIndex?: number;
+    defaultMainEntityIndex?: number;
+    convertedMetadata?: ConvertedMetadata;
+    odataVersion?: OdataVersion;
+}
+export type EntitySetFilter = 'filterDraftEnabled' | 'filterAggregateTransformationsOnly';
+/**
+ * Returns the entity choice options for use in a list inquirer prompt.
+ *
+ * @param edmx metadata string
+ * @param options
+ * @param options.useEntityTypeAsName Choice options will use the non-namepspaced entity set type as the choice name (label) and value property `entitySetName` when true, otherwise the entity set name will be used.
+ * @param options.entitySetFilter
+ *     `filterDraftEnabled` : Only draft enabled entities wil be returned when true, useful for Form Object Page app generation.
+ *     `filterAggregateTransformationsOnly` : Only return entity choices that have an aggregate annotation (Aggregation.ApplySupported) with the `Transformations` property set,
+ *  specifically used for ALP V4 app generation. If this option is set and the specified metadata is not V4, the option will be ignored.
+ * @param options.defaultMainEntityName The default selected entity set name
+ * @returns entity options
+ */
+export declare function getEntityChoices(edmx: string, { useEntityTypeAsName, entitySetFilter, defaultMainEntityName }?: {
+    useEntityTypeAsName?: boolean;
+    entitySetFilter?: EntitySetFilter;
+    defaultMainEntityName?: string;
+}): EntityChoiceOptions;
+/**
+ * Get the navigation entity choices for a main entity.
+ *
+ * @param metadata the converted metadata (edmx)
+ * @param odataVersion the odata version, which will determine the navigation properties to return
+ * @param mainEntityName the main entity name to get the navigation properties for
+ * @returns the navigation entity choices
+ */
+export declare function getNavigationEntityChoices(metadata: ConvertedMetadata, odataVersion: OdataVersion, mainEntityName: string): ListChoiceOptions<NavigationEntityAnswer>[];
+//# sourceMappingURL=entity-helper.d.ts.map

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

@@ -0,0 +1,154 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getEntityChoices = getEntityChoices;
+exports.getNavigationEntityChoices = getNavigationEntityChoices;
+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");
+const i18n_1 = require("../../i18n");
+const logger_helper_1 = __importDefault(require("../logger-helper"));
+/**
+ * Returns the entity choice options for use in a list inquirer prompt.
+ *
+ * @param edmx metadata string
+ * @param options
+ * @param options.useEntityTypeAsName Choice options will use the non-namepspaced entity set type as the choice name (label) and value property `entitySetName` when true, otherwise the entity set name will be used.
+ * @param options.entitySetFilter
+ *     `filterDraftEnabled` : Only draft enabled entities wil be returned when true, useful for Form Object Page app generation.
+ *     `filterAggregateTransformationsOnly` : Only return entity choices that have an aggregate annotation (Aggregation.ApplySupported) with the `Transformations` property set,
+ *  specifically used for ALP V4 app generation. If this option is set and the specified metadata is not V4, the option will be ignored.
+ * @param options.defaultMainEntityName The default selected entity set name
+ * @returns entity options
+ */
+function getEntityChoices(edmx, { useEntityTypeAsName = false, entitySetFilter, defaultMainEntityName } = {}) {
+    const choices = [];
+    let draftRootIndex;
+    let defaultMainEntityIndex;
+    let convertedMetadata;
+    let odataVersion;
+    try {
+        convertedMetadata = (0, annotation_converter_1.convert)((0, edmx_parser_1.parse)(edmx));
+        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`
+        odataVersion = parsedOdataVersion === 4 ? odata_service_writer_1.OdataVersion.v4 : odata_service_writer_1.OdataVersion.v2;
+        let entitySets = [];
+        if (entitySetFilter === 'filterDraftEnabled') {
+            entitySets = filterDraftEnabledEntities(convertedMetadata.entitySets) ?? [];
+        }
+        else if (entitySetFilter === 'filterAggregateTransformationsOnly' && odataVersion === odata_service_writer_1.OdataVersion.v4) {
+            // Only for v4 odata version, if a v2 metadata is passed, this will be ignored
+            entitySets = filterAggregateTransformations(convertedMetadata.entitySets);
+        }
+        else {
+            entitySets = convertedMetadata.entitySets;
+        }
+        entitySets.forEach((entitySet, index) => {
+            // Determine whether to use the entity set type name or the entity set name as the choice name.
+            // Note that in the case of the entity type name, the namespace will be removed.
+            const entitySetChoiceName = useEntityTypeAsName
+                ? entitySet.entityTypeName.substring(entitySet.entityTypeName.lastIndexOf('.') + 1)
+                : entitySet.name;
+            const choice = {
+                name: entitySetChoiceName,
+                value: {
+                    entitySetName: entitySetChoiceName,
+                    entitySetType: entitySet.entityTypeName // Fully qualified entity type name
+                }
+            };
+            choices.push(choice);
+            // Select the first found draft root index
+            if (!draftRootIndex && entitySet.annotations?.Common?.DraftRoot) {
+                draftRootIndex = index;
+            }
+            if (defaultMainEntityName && entitySet.name === defaultMainEntityName) {
+                defaultMainEntityIndex = index;
+            }
+        });
+    }
+    catch (err) {
+        logger_helper_1.default.logger.log((0, i18n_1.t)('errors.unparseableMetadata', { error: err.message }));
+    }
+    return {
+        choices,
+        draftRootIndex,
+        defaultMainEntityIndex,
+        convertedMetadata,
+        odataVersion
+    };
+}
+/**
+ * Get the entity set name from its type name.
+ *
+ * @param entitySets the entity sets to search
+ * @param entityType the entity type name to search for
+ * @returns the entity set name if found, otherwise undefined
+ */
+function findEntitySetName(entitySets, entityType) {
+    const foundEntitySet = entitySets.find((entitySet) => {
+        return entitySet.entityTypeName === entityType;
+    });
+    return foundEntitySet ? foundEntitySet.name : undefined;
+}
+/**
+ * Get the navigation entity choices for a main entity.
+ *
+ * @param metadata the converted metadata (edmx)
+ * @param odataVersion the odata version, which will determine the navigation properties to return
+ * @param mainEntityName the main entity name to get the navigation properties for
+ * @returns the navigation entity choices
+ */
+function getNavigationEntityChoices(metadata, odataVersion, mainEntityName) {
+    const choices = [];
+    const mainEntitySet = metadata.entitySets.find((entitySet) => entitySet.name === mainEntityName);
+    let navProps = [];
+    if (odataVersion === odata_service_writer_1.OdataVersion.v4) {
+        navProps = mainEntitySet?.entityType.navigationProperties.filter((navProp) => navProp.isCollection) ?? [];
+    }
+    else {
+        navProps = mainEntitySet?.entityType.navigationProperties ?? [];
+    }
+    navProps.forEach((navProp) => {
+        choices.push({
+            name: navProp.name,
+            value: {
+                navigationPropertyName: navProp.name,
+                entitySetName: findEntitySetName(metadata.entitySets, navProp.targetTypeName)
+            }
+        });
+    });
+    if (choices.length > 0) {
+        choices.unshift({ name: (0, i18n_1.t)('prompts.navigationEntitySelection.choiceNone'), value: {} });
+    }
+    return choices;
+}
+/**
+ * Returns only entity sets that have the `Aggregation.ApplySupported` annotation term with the `Transformations` property.
+ *
+ * @param entitySets the entity sets to filter
+ * @returns the filtered entity sets
+ */
+function filterAggregateTransformations(entitySets) {
+    return entitySets.filter((entitySet) => {
+        return !!entitySet.annotations?.Aggregation?.ApplySupported?.Transformations;
+    });
+}
+/**
+ * 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
+ */
+function filterDraftEnabledEntities(entitySets) {
+    return entitySets.filter((entitySet) => {
+        const entitySetTypeProperties = entitySet.entityType.entityProperties;
+        return !!entitySetTypeProperties.find((property) => property.name === 'HasDraftEntity');
+    });
+}
+//# sourceMappingURL=entity-helper.js.map

package/dist/prompts/edmx/questions.d.ts

@@ -0,0 +1,17 @@
+import type { Annotations } from '@sap-ux/axios-extension';
+import type { TemplateType } from '@sap-ux/fiori-elements-writer';
+import type { Question } from 'inquirer';
+import type { AlpTableConfigAnswers, AnnotationGenerationAnswers, EntityPromptOptions, EntitySelectionAnswers, TableConfigAnswers } from '../../types';
+/**
+ * Get the questions that may be used to prompt for entity selection and related information, table types, layout options and annotation generation.
+ *
+ * @param metadata the metadata (edmx) string of the service
+ * @param templateType the template type of the application to be generated from the prompt answers
+ * @param isCapService whether the service is a CAP service or not
+ * @param promptOptions options that can control some of the prompt behavior. See {@link EntityPromptOptions} for details
+ * @param annotations annotations should be provided when the specified template type is analytic list page, and the metadata odata version is '2', in order to determine the presentation variant qualifiers.
+ *  If none are provided, or the odata version is not '2', the presentation variant qualifier prompt will not be shown.
+ * @returns the prompts used to provide input for system selection and a reference to the answers object which will be populated with the user's responses once `inquirer.prompt` returns
+ */
+export declare function getEntitySelectionQuestions(metadata: string, templateType: TemplateType, isCapService?: boolean, promptOptions?: EntityPromptOptions, annotations?: Annotations): Question<EntitySelectionAnswers & TableConfigAnswers & AnnotationGenerationAnswers & AlpTableConfigAnswers>[];
+//# sourceMappingURL=questions.d.ts.map

package/dist/prompts/edmx/questions.js

@@ -0,0 +1,283 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getEntitySelectionQuestions = getEntitySelectionQuestions;
+const yeoman_ui_types_1 = require("@sap-devx/yeoman-ui-types");
+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");
+const logger_helper_1 = __importDefault(require("../logger-helper"));
+const alp_questions_1 = require("./alp-questions");
+const entity_helper_1 = require("./entity-helper");
+/**
+ * Validate the entity choice options. If the entity choice options are empty, a validation message will be returned.
+ *
+ * @param entityChoiceOptions the entity choice options to validate
+ * @param templateType the template type, the validation message may vary based on the template type
+ * @param odataVersion the OData version, used to generate a specific validation message for ALP V4
+ * @param isCapService whether the service is a CAP service or not
+ * @returns true is validation passes, otherwise a string with the validation message
+ */
+function validateEntityChoices(entityChoiceOptions, templateType, odataVersion, isCapService) {
+    let validationMsg;
+    if (entityChoiceOptions.length === 0) {
+        if (templateType === 'feop' && isCapService) {
+            validationMsg = (0, i18n_1.t)('prompts.mainEntitySelection.noDraftEnabledEntitiesError');
+        }
+        else if (templateType === 'alp' && odataVersion === odata_service_writer_1.OdataVersion.v4) {
+            validationMsg = (0, i18n_1.t)('prompts.mainEntitySelection.noEntitiesAlpV4Error');
+        }
+        else {
+            validationMsg = (0, i18n_1.t)('prompts.mainEntitySelection.noEntitiesError');
+        }
+    }
+    if (!utils_1.PromptState.isYUI && validationMsg) {
+        logger_helper_1.default.logger.debug(`Exiting due to validation error: ${validationMsg}`);
+        throw new Error((0, i18n_1.t)('errors.exitingGeneration', { exitReason: validationMsg }));
+    }
+    return validationMsg ?? true;
+}
+/**
+ * Get the questions that may be used to prompt for entity selection and related information, table types, layout options and annotation generation.
+ *
+ * @param metadata the metadata (edmx) string of the service
+ * @param templateType the template type of the application to be generated from the prompt answers
+ * @param isCapService whether the service is a CAP service or not
+ * @param promptOptions options that can control some of the prompt behavior. See {@link EntityPromptOptions} for details
+ * @param annotations annotations should be provided when the specified template type is analytic list page, and the metadata odata version is '2', in order to determine the presentation variant qualifiers.
+ *  If none are provided, or the odata version is not '2', the presentation variant qualifier prompt will not be shown.
+ * @returns the prompts used to provide input for system selection and a reference to the answers object which will be populated with the user's responses once `inquirer.prompt` returns
+ */
+function getEntitySelectionQuestions(metadata, templateType, isCapService = false, promptOptions, annotations) {
+    const useAutoComplete = promptOptions?.useAutoComplete;
+    let entitySetFilter;
+    if (templateType === 'feop' && !!isCapService) {
+        entitySetFilter = 'filterDraftEnabled';
+    }
+    else if (templateType === 'alp') {
+        entitySetFilter = 'filterAggregateTransformationsOnly';
+    }
+    const entityChoices = (0, entity_helper_1.getEntityChoices)(metadata, {
+        useEntityTypeAsName: templateType === 'ovp',
+        defaultMainEntityName: promptOptions?.defaultMainEntityName,
+        entitySetFilter
+    });
+    if (!entityChoices.convertedMetadata || !entityChoices.odataVersion) {
+        // getEntityChoiceOptions will log an error if the metadata or its odata version are unparseable
+        return [];
+    }
+    const odataVersion = entityChoices.odataVersion;
+    const entityQuestions = [];
+    // OVP only has filter entity, does not use tables and we do not add annotations
+    if (templateType === 'ovp') {
+        entityQuestions.push(getFilterEntityTypeQuestions(entityChoices, useAutoComplete));
+        // Return early since OVP does not have table layout prompts
+        return entityQuestions;
+    }
+    entityQuestions.push({
+        type: useAutoComplete ? 'autocomplete' : 'list',
+        name: types_1.EntityPromptNames.mainEntity,
+        message: (0, i18n_1.t)('prompts.mainEntitySelection.message'),
+        guiOptions: {
+            breadcrumb: true
+        },
+        choices: entityChoices.choices,
+        source: (prevAnswers, input) => (0, inquirer_common_1.searchChoices)(input, entityChoices.choices),
+        default: entityChoices.defaultMainEntityIndex ?? entityChoices.draftRootIndex ?? 0,
+        validate: () => validateEntityChoices(entityChoices.choices, templateType, odataVersion, isCapService),
+        additionalMessages: () => {
+            if (promptOptions?.defaultMainEntityName && entityChoices.defaultMainEntityIndex === undefined) {
+                return {
+                    message: (0, i18n_1.t)('prompts.mainEntitySelection.defaultEntityNameNotFoundWarning'),
+                    severity: yeoman_ui_types_1.Severity.warning
+                };
+            }
+        }
+    });
+    const convertedMetadata = entityChoices.convertedMetadata;
+    // No nav entity for FPM
+    if (templateType !== 'fpm') {
+        let navigationEntityChoices;
+        entityQuestions.push({
+            when: (answers) => {
+                if (answers.mainEntity) {
+                    navigationEntityChoices = (0, entity_helper_1.getNavigationEntityChoices)(convertedMetadata, odataVersion, answers.mainEntity.entitySetName);
+                    return navigationEntityChoices.length > 0;
+                }
+                return false;
+            },
+            type: useAutoComplete ? 'autocomplete' : 'list',
+            name: types_1.EntityPromptNames.navigationEntity,
+            message: (0, i18n_1.t)('prompts.navigationEntitySelection.message'),
+            guiOptions: {
+                applyDefaultWhenDirty: true, // Selected nav entity may no longer be present if main entity changes
+                breadcrumb: true
+            },
+            choices: () => navigationEntityChoices,
+            source: (preAnswers, input) => (0, inquirer_common_1.searchChoices)(input, navigationEntityChoices),
+            default: 0
+        });
+    }
+    entityQuestions.push(...getAddAnnotationQuestions(metadata, templateType, odataVersion, isCapService));
+    if (!promptOptions?.hideTableLayoutPrompts) {
+        entityQuestions.push(...getTableLayoutQuestions(templateType, odataVersion, isCapService));
+    }
+    if (templateType === 'alp') {
+        entityQuestions.push(...(0, alp_questions_1.getAnalyticListPageQuestions)(odataVersion, annotations, promptOptions?.hideTableLayoutPrompts));
+    }
+    return entityQuestions;
+}
+/**
+ * Get the questions that may be used to prompt for table layout options.
+ *
+ * @param templateType used to determine if the tree table option should be included
+ * @param odataVersion used to determine if the hierarchy qualifier is required when the selected table type is TreeTable
+ * @param isCapService used to determine if the tree table option should be included
+ * @returns the table layout questions
+ */
+function getTableLayoutQuestions(templateType, odataVersion, isCapService) {
+    const tableTypeChoices = [
+        { name: (0, i18n_1.t)('prompts.tableType.choiceAnalytical'), value: 'AnalyticalTable' },
+        { name: (0, i18n_1.t)('prompts.tableType.choiceGrid'), value: 'GridTable' },
+        { name: (0, i18n_1.t)('prompts.tableType.choiceResponsive'), value: 'ResponsiveTable' }
+    ];
+    if (templateType !== 'alp' && !isCapService) {
+        tableTypeChoices.push({ name: (0, i18n_1.t)('prompts.tableType.choiceTree'), value: 'TreeTable' });
+    }
+    const tableLayoutQuestions = [];
+    if (templateType === 'lrop' || templateType === 'worklist' || templateType === 'alp') {
+        const tableTypeDefault = templateType === 'alp' ? 'AnalyticalTable' : 'ResponsiveTable';
+        tableLayoutQuestions.push({
+            when: (prevAnswers) => !!prevAnswers.mainEntity,
+            type: 'list',
+            name: types_1.EntityPromptNames.tableType,
+            message: (0, i18n_1.t)('prompts.tableType.message'),
+            guiOptions: {
+                hint: (0, i18n_1.t)('prompts.tableType.hint'),
+                breadcrumb: true
+            },
+            choices: tableTypeChoices,
+            default: tableTypeDefault
+        });
+        tableLayoutQuestions.push({
+            when: (prevAnswers) => prevAnswers?.tableType === 'TreeTable' && odataVersion === odata_service_writer_1.OdataVersion.v4,
+            type: 'input',
+            name: types_1.EntityPromptNames.hierarchyQualifier,
+            message: (0, i18n_1.t)('prompts.hierarchyQualifier.message'),
+            guiOptions: {
+                hint: (0, i18n_1.t)('prompts.hierarchyQualifier.hint'),
+                breadcrumb: true,
+                mandatory: true
+            },
+            default: '',
+            validate: (input) => {
+                if (!input) {
+                    return (0, i18n_1.t)('prompts.hierarchyQualifier.qualifierRequiredForV4Warning');
+                }
+                return true;
+            }
+        });
+    }
+    return tableLayoutQuestions;
+}
+/**
+ * Returns the size of an EDMX string in kilobytes.
+ *
+ * @param {string} edmx The EDMX string to measure.
+ * @returns {number} The size of the EDMX string in kilobytes. Returns 0 if the input is null, undefined, or an empty string.
+ */
+function getEdmxSizeInKb(edmx) {
+    if (edmx) {
+        const sizeInBytes = Buffer.byteLength(edmx);
+        return sizeInBytes / 1024;
+    }
+    return 0;
+}
+/**
+ * Get the questions that may be used to prompt for adding annotations. Only a subset of the questions will be returned based on the template type and OData version.
+ *
+ * @param metadata the metadata (edmx) string of the service, used to determine if the metadata is large and the user should be warned about processing time
+ * @param templateType only specific template types will have line item annotations
+ * @param odataVersion only specific OData versions will have line item annotations
+ * @param isCapService whether the service is a CAP service or not
+ * @returns the annotation generation questions
+ */
+function getAddAnnotationQuestions(metadata, templateType, odataVersion, isCapService) {
+    const largeEdmxDataset = getEdmxSizeInKb(metadata) > types_1.MetadataSizeWarningLimitKb;
+    const annotationQuestions = [];
+    if (templateType === 'feop') {
+        annotationQuestions.push({
+            type: 'confirm',
+            name: types_1.EntityPromptNames.addFEOPAnnotations,
+            guiOptions: {
+                breadcrumb: (0, i18n_1.t)('prompts.addFEOPAnnotations.breadcrumb')
+            },
+            message: (0, i18n_1.t)('prompts.addFEOPAnnotations.message'),
+            additionalMessages: (addFEOPAnnotations) => {
+                if (addFEOPAnnotations && largeEdmxDataset) {
+                    return {
+                        message: (0, i18n_1.t)('warnings.largeMetadataDocument'),
+                        severity: yeoman_ui_types_1.Severity.warning
+                    };
+                }
+            },
+            default: !largeEdmxDataset
+        });
+        // Return early since FEOP does not have line item annotations
+        return annotationQuestions;
+    }
+    if ((templateType === 'lrop' || templateType === 'worklist') && odataVersion === odata_service_writer_1.OdataVersion.v4) {
+        annotationQuestions.push({
+            type: 'confirm',
+            name: types_1.EntityPromptNames.addLineItemAnnotations,
+            guiOptions: {
+                breadcrumb: (0, i18n_1.t)('prompts.addLineItemAnnotations.breadcrumb')
+            },
+            message: (0, i18n_1.t)('prompts.addLineItemAnnotations.message'),
+            additionalMessages: (answer) => {
+                if (answer) {
+                    if (largeEdmxDataset) {
+                        return {
+                            message: (0, i18n_1.t)('warnings.largeMetadataDocument'),
+                            severity: yeoman_ui_types_1.Severity.warning
+                        };
+                    }
+                    else if (isCapService) {
+                        return {
+                            message: (0, i18n_1.t)('prompts.addLineItemAnnotations.valueHelpsAnnotationsInfoMessage'),
+                            severity: yeoman_ui_types_1.Severity.information
+                        };
+                    }
+                }
+            },
+            default: !largeEdmxDataset
+        });
+    }
+    return annotationQuestions;
+}
+/**
+ * Get the questions that may be used to prompt for filter entity selection for the OVP template type.
+ *
+ * @param entityChoices Filter entity type prompt choices
+ * @param useAutoComplete Determines if entity related prompts should use auto complete on user input
+ * @returns the ovp specific filter entity type selection question
+ */
+function getFilterEntityTypeQuestions(entityChoices, useAutoComplete = false) {
+    return {
+        type: useAutoComplete ? 'autocomplete' : 'list',
+        name: types_1.EntityPromptNames.filterEntityType,
+        message: (0, i18n_1.t)('prompts.filterEntityType.message'),
+        guiOptions: {
+            breadcrumb: true
+        },
+        choices: entityChoices.choices,
+        source: (preAnswers, input) => (0, inquirer_common_1.searchChoices)(input, entityChoices.choices),
+        default: entityChoices.defaultMainEntityIndex ?? entityChoices.draftRootIndex ?? 0,
+        validate: () => (entityChoices.choices.length === 0 ? (0, i18n_1.t)('prompts.filterEntityType.noEntitiesError') : true)
+    };
+}
+//# sourceMappingURL=questions.js.map

package/dist/prompts/prompt-helpers.js

@@ -28,7 +28,7 @@ function getDatasourceTypeChoices({ includeNone = false } = {}) {
     choices.push({ name: (0, i18n_1.t)('prompts.datasourceType.capProjectChoiceText'), value: types_1.DatasourceType.capProject });
     choices.push({ name: (0, i18n_1.t)('prompts.datasourceType.metadataFileChoiceText'), value: types_1.DatasourceType.metadataFile });
     if (includeNone) {
-        choices.unshift({ name: (0, i18n_1.t)('prompts.datasourceType.noneName'), value: types_1.DatasourceType.none });
+        choices.unshift({ name: (0, i18n_1.t)('prompts.datasourceType.choiceNone'), value: types_1.DatasourceType.none });
     }
     return choices;
 }

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

@@ -8,7 +8,7 @@
             "odataServiceUrlName": "OData Service",
             "capProjectName": "Local CAP Project",
             "metadataFileName": "Metadata Document",
-            "noneName": "None",
+            "choiceNone": "$t(texts.choiceNameNone)",
             "projectSpecificDestChoiceText": "Connect to a $t(prompts.datasourceType.projectSpecificDestName)",
             "businessHubChoiceText": "Connect to $t(prompts.datasourceType.businessHubName)",
             "sapSystemChoiceText": "Connect to a $t(prompts.datasourceType.sapSystemName)",
@@ -101,7 +101,7 @@
         },
         "systemSelection": {
             "newSystemChoiceLabel": "New system",
-            "hint": "Select a system configuration",
+            "hint": "Select a system configuration.",
             "message": "System",
             "authenticationFailedUpdateCredentials": "Authentication failed. Please try updating the credentials."
         },
@@ -113,18 +113,82 @@
         },
         "serviceKey": {
             "message": "Service key file path",
-            "hint": "Select a local file that defines the service connection for an ABAP Environment on SAP Business Technology Platform",
+            "hint": "Select a local file that defines the service connection for an ABAP Environment on SAP Business Technology Platform.",
             "incompleteServiceKeyInfo": "Service keys file does not contain the required information",
             "unparseableServiceKey": "Service keys file contents are not a valid JSON format"
         },
         "cloudFoundryAbapSystem": {
             "message": "ABAP environment",
-            "hint": "Enter the name of the Cloud Foundry service that contains the ABAP Environment instance"
+            "hint": "Enter the name of the Cloud Foundry service that contains the ABAP Environment instance."
         },
         "destinationServicePath": {
             "message": "Service path",
-            "hint": "Enter the path to the OData service, relative to the selected destination URL",
+            "hint": "Enter the path to the OData service, relative to the selected destination URL.",
             "invalidServicePathWarning": "Please enter a valid service path"
+        },
+        "mainEntitySelection": {
+            "message": "Main entity",
+            "defaultEntityNameNotFoundWarning": "The supplied entity cannot be found in the service. Please choose from the list above.",
+            "noDraftEnabledEntitiesError": "The CAP service you have chosen does not have any entities that are draft enabled. In order to generate a V4 Fiori application using this floor plan for a CAP project, the entity selected must be draft enabled.",
+            "noEntitiesError": "$t(errors.noRelevantEntities)",
+            "noEntitiesAlpV4Error": "The OData V4 service you have provided is not suitable for use in an Analytical List Page application. The service must contain aggregate based entity sets for this template."
+        },
+        "navigationEntitySelection": {
+            "message": "Navigation entity",
+            "choiceNone": "$t(texts.choiceNameNone)"
+        },
+        "filterEntityType": {
+            "message": "Filter entity",
+            "noEntitiesError": "$t(errors.noRelevantEntities)"
+        },
+        "tableType": {
+            "message": "Table type",
+            "hint": "Defines the table type for the List Report Page.",
+            "choiceNone": "$t(texts.choiceNameNone)",
+            "choiceGrid": "Grid",
+            "choiceAnalytical": "Analytical",
+            "choiceResponsive": "Responsive",
+            "choiceTree": "Tree"
+        },
+        "hierarchyQualifier": {
+            "message": "Hierarchy qualifier",
+            "hint": "Leading property that decides between either a recursive hierarchy or data aggregation.",
+            "qualifierRequiredForV4Warning": "Hierarchy qualifier is required for V4 OData services"
+        },
+        "addFEOPAnnotations": {
+            "message": "Automatically add a form to the generated application if none already exists?",
+            "hint": "Choose the annotation generation method.",
+            "breadcrumb": "Generate Annotations"
+        },
+        "addLineItemAnnotations": {
+            "message": "Automatically add table columns to the list page and a section to the object page if none already exists?",
+            "hint": "Choose the annotation generation method.",
+            "breadcrumb": "Generate Annotations",
+            "valueHelpsAnnotationsInfoMessage": "Basic value helps will also be created."
+        },
+        "presentationQualifier": {
+            "message": "Qualifier",
+            "hint": "Represents the qualifier of the SelectionPresentationVariant. Analytical List Page looks for SelectionPresentationVariant with this qualifier and if not found, it looks for PresentationVariant with this qualifier."
+        },
+        "tableSelectionMode": {
+            "message": "Selection mode",
+            "hint": "Defines different selection modes for the SmartTable in Analytical List Page.",
+            "choiceNone": "$t(texts.choiceNameNone)",
+            "choiceSingle": "Single",
+            "choiceAuto": "Auto",
+            "choiceMulti": "Multi"
+        },
+        "tableMultiSelect": {
+            "message": "Allow multi select",
+            "hint": "Allows you to show a checkbox for selecting multiple items in a table. This setting comes into effect only if there are actions defined either through annotation or manifest."
+        },
+        "tableAutoHide": {
+            "message": "Auto hide",
+            "hint": "Determines chart/table interaction. If set to true, the chart acts as a filter for the table. If set to false, the matching table rows are highlighted but the table is not filtered."
+        },
+        "smartVariantManagement": {
+            "message": "Enable smart variant management",
+            "hint": "Enables page level variant."
         }
     },
     "errors": {
@@ -153,7 +217,14 @@
         "serviceCatalogRequest": "An error occurred requesting services from: {{- catalogRequestUri }} and entity set: {{entitySet}}. {{error}}",
         "storedSystemConnectionError": "An error occurred while validating the stored system connection info. System name: {{-systemName}}, error: {{- error}}",
         "noCatalogOrServiceAvailable": "No active system or OData service endpoint connection available to retrieve service(s).",
-        "allCatalogServiceRequestsFailed": "All catalog service requests failed for the selected system. OData version(s): V{{version}}."
+        "allCatalogServiceRequestsFailed": "All catalog service requests failed for the selected system. OData version(s): V{{version}}.",
+        "unparseableMetadata": "Unable to parse entities from metadata document. {{-error}}",
+        "unparseableOdataVersion": "Unable to parse the odata version from the metadata.",
+        "unparseableXML": "Unparseable XML was specified: {{-error}}",
+        "noRelevantEntities": "The template and service selected have no relevant entities that you can use."
+    },
+    "warnings": {
+        "largeMetadataDocument": "The metadata for this OData service is significantly large. It may take some time before this operation completes."
     },
     "texts": {
         "suggestedSystemNameClient": ", client {{client}}",
@@ -162,6 +233,7 @@
         "systemTypeBTP": "BTP",
         "systemTypeS4HC": "S4HC",
         "httpStatus": "http status {{httpStatus}}",
-        "checkDestinationAuthConfig": "Please check the SAP BTP destination authentication configuration."
+        "checkDestinationAuthConfig": "Please check the SAP BTP destination authentication configuration.",
+        "choiceNameNone": "None"
     }
 }

package/dist/types.d.ts

@@ -5,6 +5,8 @@ import type { OdataVersion } from '@sap-ux/odata-service-writer';
 import type { CdsVersionInfo } from '@sap-ux/project-access';
 import type { BackendSystem } from '@sap-ux/store';
 import type { ListChoiceOptions } from 'inquirer';
+import type { EntityAnswer, NavigationEntityAnswer } from './prompts/edmx/entity-helper';
+import type { TableSelectionMode, TableType } from '@sap-ux/fiori-elements-writer';
 /**
  * This file contains types that are exported by the module and are needed for consumers using the APIs `prompt` and `getPrompts`.
  */
@@ -22,6 +24,11 @@ export declare const SapSystemTypes: {
     readonly abapOnBtp: "abapOnBtp";
 };
 export type SapSystemType = keyof typeof SapSystemTypes;
+export declare const SAP_CLIENT_KEY = "sap-client";
+/**
+ * The limit for the metadata file size in KB above which a warning will be displayed to the user regarding processing time.
+ */
+export declare const MetadataSizeWarningLimitKb = 1000;
 /**
  * Answers returned by the OdataServiceInquirer prompt API.
  * These values may be used to write an OData service and may be derived from the user's input rather than direct answers.
@@ -126,6 +133,48 @@ export declare enum promptNames {
      */
     systemSelection = "systemSelection"
 }
+/**
+ * Prompt names for entity related prompts. These indirectly define the properties of the answers object returned by the entity related prompts.
+ */
+export declare const EntityPromptNames: {
+    readonly mainEntity: "mainEntity";
+    readonly navigationEntity: "navigationEntity";
+    readonly filterEntityType: "filterEntityType";
+    readonly tableType: "tableType";
+    readonly hierarchyQualifier: "hierarchyQualifier";
+    readonly addFEOPAnnotations: "addFEOPAnnotations";
+    readonly addLineItemAnnotations: "addLineItemAnnotations";
+    readonly presentationQualifier: "presentationQualifier";
+    readonly tableSelectionMode: "tableSelectionMode";
+    readonly tableMultiSelect: "tableMultiSelect";
+    readonly tableAutoHide: "tableAutoHide";
+    readonly smartVariantManagement: "smartVariantManagement";
+};
+export type EntityPromptNames = (typeof EntityPromptNames)[keyof typeof EntityPromptNames];
+export interface EntitySelectionAnswers {
+    [EntityPromptNames.mainEntity]?: EntityAnswer;
+    [EntityPromptNames.navigationEntity]?: NavigationEntityAnswer;
+    [EntityPromptNames.filterEntityType]?: EntityAnswer;
+}
+export interface TableConfigAnswers {
+    [EntityPromptNames.tableType]: TableType;
+    [EntityPromptNames.hierarchyQualifier]: string;
+}
+export interface AnnotationGenerationAnswers {
+    [EntityPromptNames.addFEOPAnnotations]?: boolean;
+    [EntityPromptNames.addLineItemAnnotations]?: boolean;
+}
+export interface AlpTableConfigAnswers {
+    [EntityPromptNames.tableAutoHide]: boolean;
+    [EntityPromptNames.tableMultiSelect]: boolean;
+    [EntityPromptNames.tableSelectionMode]: TableSelectionMode;
+    [EntityPromptNames.presentationQualifier]: string;
+    [EntityPromptNames.smartVariantManagement]: boolean;
+}
+/**
+ * Convienience alias type for the entity related answers
+ */
+export type EntityRelatedAnswers = EntitySelectionAnswers & TableConfigAnswers & AnnotationGenerationAnswers & AlpTableConfigAnswers;
 export type CapRuntime = 'Node.js' | 'Java';
 export interface CapService {
     /**
@@ -287,6 +336,23 @@ export type OdataServiceUrlPasswordOptions = Pick<CommonPromptOptions, 'addition
 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>;
 export type OdataServiceQuestion = YUIQuestion<OdataServiceAnswers>;
 export type OdataServicePromptOptions = Partial<odataServiceInquirerPromptOptions>;
-export declare const SAP_CLIENT_KEY = "sap-client";
+/**
+ * The entity related prompt options. These options are used to configure the entity related prompts.
+ */
+export type EntityPromptOptions = {
+    /**
+     * Determines if entity related prompts should use auto complete on user input.
+     * Note that the auto-complete module must be registered with the inquirer instance to use this feature.
+     */
+    useAutoComplete?: boolean;
+    /**
+     * Provide an entity name that will be preselected as the default option for the prompt.
+     */
+    defaultMainEntityName?: string;
+    /**
+     * Hides the table layout related prompts when true, default is false.
+     */
+    hideTableLayoutPrompts?: boolean;
+};
 export {};
 //# sourceMappingURL=types.d.ts.map

package/dist/types.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.SAP_CLIENT_KEY = exports.promptNames = exports.SapSystemTypes = exports.DatasourceType = void 0;
+exports.EntityPromptNames = exports.promptNames = exports.MetadataSizeWarningLimitKb = exports.SAP_CLIENT_KEY = exports.SapSystemTypes = exports.DatasourceType = void 0;
 /**
  * This file contains types that are exported by the module and are needed for consumers using the APIs `prompt` and `getPrompts`.
  */
@@ -20,6 +20,11 @@ exports.SapSystemTypes = {
     abapOnPrem: 'abapOnPrem',
     abapOnBtp: 'abapOnBtp'
 };
+exports.SAP_CLIENT_KEY = 'sap-client';
+/**
+ * The limit for the metadata file size in KB above which a warning will be displayed to the user regarding processing time.
+ */
+exports.MetadataSizeWarningLimitKb = 1000;
 /**
  * Enumeration of prompt names used by OdataServiceInquirerPromptOptions
  */
@@ -62,5 +67,21 @@ var promptNames;
      */
     promptNames["systemSelection"] = "systemSelection";
 })(promptNames || (exports.promptNames = promptNames = {}));
-exports.SAP_CLIENT_KEY = 'sap-client';
+/**
+ * Prompt names for entity related prompts. These indirectly define the properties of the answers object returned by the entity related prompts.
+ */
+exports.EntityPromptNames = {
+    mainEntity: 'mainEntity',
+    navigationEntity: 'navigationEntity',
+    filterEntityType: 'filterEntityType',
+    tableType: 'tableType',
+    hierarchyQualifier: 'hierarchyQualifier',
+    addFEOPAnnotations: 'addFEOPAnnotations',
+    addLineItemAnnotations: 'addLineItemAnnotations',
+    presentationQualifier: 'presentationQualifier',
+    tableSelectionMode: 'tableSelectionMode',
+    tableMultiSelect: 'tableMultiSelect',
+    tableAutoHide: 'tableAutoHide',
+    smartVariantManagement: 'smartVariantManagement'
+};
 //# sourceMappingURL=types.js.map

package/dist/utils/index.d.ts

@@ -1,8 +1,8 @@
 import { ODataVersion } from '@sap-ux/axios-extension';
+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 HostEnvironmentId } from '@sap-ux/fiori-generator-shared';
 /**
  * Determine if the current prompting environment is cli or a hosted extension (app studio or vscode).
  *
@@ -19,6 +19,13 @@ export declare function getPromptHostEnvironment(): {
  * @returns the odata version of the specified metadata, throws an error if the metadata is invalid
  */
 export declare function parseOdataVersion(metadata: string): OdataVersion;
+/**
+ * Convert specified xml string to JSON.
+ *
+ * @param xml - the schema to parse
+ * @returns parsed object representation of passed XML
+ */
+export declare function xmlToJson(xml: string): any;
 /**
  * Replaces the origin in the metadata URIs with a relative path.
  * The path will be tested for '/sap/opu/odata/' and if found, the origin will be replaced with './'.

package/dist/utils/index.js

@@ -6,18 +6,19 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.PromptState = void 0;
 exports.getPromptHostEnvironment = getPromptHostEnvironment;
 exports.parseOdataVersion = parseOdataVersion;
+exports.xmlToJson = xmlToJson;
 exports.originToRelative = originToRelative;
 exports.convertODataVersionType = convertODataVersionType;
 exports.getDefaultChoiceIndex = getDefaultChoiceIndex;
 const axios_extension_1 = require("@sap-ux/axios-extension");
 const btp_utils_1 = require("@sap-ux/btp-utils");
+const fiori_generator_shared_1 = require("@sap-ux/fiori-generator-shared");
 const odata_service_writer_1 = require("@sap-ux/odata-service-writer");
 const fast_xml_parser_1 = require("fast-xml-parser");
 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 fiori_generator_shared_1 = require("@sap-ux/fiori-generator-shared");
 /**
  * Determine if the current prompting environment is cli or a hosted extension (app studio or vscode).
  *
@@ -38,6 +39,23 @@ function getPromptHostEnvironment() {
  * @returns the odata version of the specified metadata, throws an error if the metadata 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;
+    }
+    catch (error) {
+        logger_helper_1.default.logger.error(error);
+        throw new Error((0, i18n_1.t)('prompts.validationMessages.metadataInvalid'));
+    }
+}
+/**
+ * Convert specified xml string to JSON.
+ *
+ * @param xml - the schema to parse
+ * @returns parsed object representation of passed XML
+ */
+function xmlToJson(xml) {
     const options = {
         attributeNamePrefix: '',
         ignoreAttributes: false,
@@ -45,15 +63,12 @@ function parseOdataVersion(metadata) {
         parseAttributeValue: true,
         removeNSPrefix: true
     };
-    const parser = new fast_xml_parser_1.XMLParser(options);
     try {
-        const parsed = parser.parse(metadata, true);
-        const odataVersion = parsed['Edmx']['Version'] === 1 ? odata_service_writer_1.OdataVersion.v2 : odata_service_writer_1.OdataVersion.v4;
-        return odataVersion;
+        const parser = new fast_xml_parser_1.XMLParser(options);
+        return parser.parse(xml, true);
     }
     catch (error) {
-        logger_helper_1.default.logger.error(error);
-        throw new Error((0, i18n_1.t)('prompts.validationMessages.metadataInvalid'));
+        throw new Error((0, i18n_1.t)('error.unparseableXML', { 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": "0.8.8",
+  "version": "1.0.0",
   "repository": {
     "type": "git",
     "url": "https://github.com/SAP/open-ux-tools.git",
@@ -20,6 +20,8 @@
   ],
   "dependencies": {
     "@sap/cf-tools": "3.2.2",
+    "@sap-ux/annotation-converter": "0.9.10",
+    "@sap-ux/edmx-parser": "0.9.0",
     "axios": "1.7.4",
     "axios-logger": "2.8.0",
     "fast-xml-parser": "4.4.1",
@@ -27,25 +29,28 @@
     "inquirer-autocomplete-prompt": "2.0.1",
     "os-name": "4.0.1",
     "@sap-ux/axios-extension": "1.18.1",
-    "@sap-ux/btp-utils": "0.17.2",
     "@sap-ux/fiori-generator-shared": "0.7.19",
     "@sap-ux/guided-answers-helper": "0.2.0",
     "@sap-ux/telemetry": "0.5.51",
     "@sap-ux/inquirer-common": "0.6.4",
     "@sap-ux/logger": "0.6.0",
+    "@sap-ux/btp-utils": "0.17.2",
     "@sap-ux/project-access": "1.29.0",
     "@sap-ux/project-input-validator": "0.3.4",
     "@sap-ux/store": "1.0.0"
   },
   "devDependencies": {
+    "@sap-ux/vocabularies-types": "0.11.7",
     "@sap-devx/yeoman-ui-types": "1.14.4",
     "@types/inquirer-autocomplete-prompt": "2.0.1",
     "@types/inquirer": "8.2.6",
     "@types/lodash": "4.14.202",
     "jest-extended": "3.2.4",
     "@sap-ux/fiori-generator-shared": "0.7.19",
+    "@sap-ux/fiori-elements-writer": "2.0.0",
+    "@sap-ux/fiori-freestyle-writer": "2.0.0",
     "@sap-ux/feature-toggle": "0.2.3",
-    "@sap-ux/odata-service-writer": "0.25.2"
+    "@sap-ux/odata-service-writer": "0.25.3"
   },
   "engines": {
     "node": ">=18.x"