@sap-ux/odata-service-inquirer 2.4.23 → 2.5.0

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

@@ -4,6 +4,13 @@ import type { ListChoiceOptions } from 'inquirer';
 export type EntityAnswer = {
     entitySetName: string;
     entitySetType: string;
+    /**
+     * Represents a parameter used along with the main entity to query data.
+     * When this parameter is set, the prompt for selecting navigation properties is skipped
+     * This property is populated only if the metadata entity set includes a `Common.ResultContext` annotation,
+     * indicating that the entity set requires additional parameters for querying.
+     */
+    mainEntityParameterName?: string;
 };
 export type NavigationEntityAnswer = {
     navigationPropertyName: string;

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

@@ -11,6 +11,46 @@ 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"));
+/**
+ * Finds the navigation property name that links a parameterised entity set to its target entity set.
+ *
+ * This function checks if the given entity set has the `Common.ResultContext` annotation, indicating
+ * that it is a parameterised entity. It then searches for a navigation property that:
+ * - Points to a target entity (`containsTarget === true`).
+ * - Has a partner navigation property named `Parameters` (linking back to the parameters entity).
+ *
+ * If such a navigation property is found, its name is returned and skips navigation entity selection prompt
+ * Otherwise, `null` is returned.
+ *
+ * @param entitySet - The entity set to search for navigation properties.
+ * @param entityTypes - The list of entity types to search for matching navigation properties.
+ * @returns The name of the matching navigation property, or `null` if no match is found.
+ */
+function getNavigationPropertyForParameterisedEntity(entitySet, entityTypes) {
+    // Check if the entity type has the Common.ResultContext annotation
+    const hasResultContextAnnotation = Boolean(entitySet?.entityType?.annotations?.Common?.ResultContext);
+    if (!hasResultContextAnnotation) {
+        // If the entity set is not parameterised, no parametrised navigation is expected
+        return undefined;
+    }
+    // Get all navigation properties of the parameterised entity type
+    const navigationProperties = entitySet?.entityType?.navigationProperties ?? [];
+    // Find the first navigation property that meets the criteria.
+    for (const navigationProperty of navigationProperties) {
+        if (navigationProperty.containsTarget === true && // Points to a target entity
+            navigationProperty.partner // The partner navigation property name is defined
+        ) {
+            const isMatchingEntitySet = entityTypes?.filter((entityType) => entityType.fullyQualifiedName === navigationProperty.targetTypeName);
+            // Check if the target type name matches the provided entity type name
+            if (isMatchingEntitySet) {
+                // Return the navigation property name
+                return navigationProperty.name;
+            }
+        }
+    }
+    // If no matching navigation property is found, return undefined
+    return undefined;
+}
 /**
  * Returns the entity choice options for use in a list inquirer prompt.
  *
@@ -50,11 +90,15 @@ function getEntityChoices(edmx, { entitySetFilter, defaultMainEntityName } = {})
             entitySets = convertedMetadata.entitySets;
         }
         entitySets.forEach((entitySet, index) => {
+            const mainEntityParameterName = getNavigationPropertyForParameterisedEntity(entitySet, convertedMetadata?.entityTypes);
             const choice = {
                 name: entitySet.name,
                 value: {
                     entitySetName: entitySet.name,
-                    entitySetType: entitySet.entityTypeName // Fully qualified entity type name
+                    entitySetType: entitySet.entityTypeName, // Fully qualified entity type name
+                    ...(mainEntityParameterName && {
+                        mainEntityParameterName
+                    }) // parameterised navigation property name
                 }
             };
             choices.push(choice);

package/dist/prompts/edmx/questions.js

@@ -88,13 +88,20 @@ function getEntitySelectionQuestions(metadata, templateType, isCapService = fals
         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: () => {
+        additionalMessages: (answers) => {
             if (promptOptions?.defaultMainEntityName && entityChoices.defaultMainEntityIndex === undefined) {
                 return {
                     message: (0, i18n_1.t)('prompts.mainEntitySelection.defaultEntityNameNotFoundWarning'),
                     severity: yeoman_ui_types_1.Severity.warning
                 };
             }
+            if (answers.mainEntity?.mainEntityParameterName) {
+                // display a warning if the main entity has a mainEntityParameterName
+                return {
+                    message: (0, i18n_1.t)('prompts.mainEntitySelection.mainEntityParameterFoundInfo'),
+                    severity: yeoman_ui_types_1.Severity.information
+                };
+            }
         }
     });
     const convertedMetadata = entityChoices.convertedMetadata;
@@ -103,7 +110,8 @@ function getEntitySelectionQuestions(metadata, templateType, isCapService = fals
         let navigationEntityChoices;
         entityQuestions.push({
             when: (answers) => {
-                if (answers.mainEntity) {
+                // Skip navigation entity selection if the selected main entity has mainEntityParameterName.
+                if (answers.mainEntity && !answers.mainEntity.mainEntityParameterName) {
                     navigationEntityChoices = (0, entity_helper_1.getNavigationEntityChoices)(convertedMetadata, odataVersion, answers.mainEntity.entitySetName);
                     return navigationEntityChoices.length > 0;
                 }

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

@@ -123,6 +123,7 @@
         "mainEntitySelection": {
             "message": "Main entity",
             "defaultEntityNameNotFoundWarning": "The supplied entity cannot be found in the service. Please choose from the list above.",
+            "mainEntityParameterFoundInfo": "The selected entity '{{entityName}}' requires a parameter which is set by the application filters. Navigation entities are not supported.",
             "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 entities for this template."

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.4.23",
+  "version": "2.5.0",
   "repository": {
     "type": "git",
     "url": "https://github.com/SAP/open-ux-tools.git",
@@ -48,7 +48,7 @@
     "@types/lodash": "4.14.202",
     "jest-extended": "3.2.4",
     "@sap-ux/fiori-generator-shared": "0.12.8",
-    "@sap-ux/fiori-elements-writer": "2.4.19",
+    "@sap-ux/fiori-elements-writer": "2.5.0",
     "@sap-ux/fiori-freestyle-writer": "2.4.11",
     "@sap-ux/feature-toggle": "0.3.0",
     "@sap-ux/odata-service-writer": "0.27.5",