@sap-ux/odata-service-inquirer 2.5.21 → 2.5.23

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

@@ -22,7 +22,7 @@ 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/'];
+const nonUIServicePaths = ['/IWBEP/COMMON'];
 // Telemetry event name for successful service validation on BAS, note: legacy event names should not be changed
 exports.telemEventBASServiceSuccess = 'SERVICE_INQUIRER_BAS_SUCCESS';
 /**
@@ -41,7 +41,7 @@ const createServiceChoices = (serviceInfos) => {
     }
     serviceInfos
         // Exclude non-UI compatible services
-        ?.filter((service) => !nonUIServicePaths.some((path) => service.path.includes(path)))
+        ?.filter((service) => !nonUIServicePaths.some((path) => service.id.includes(path)))
         .forEach((service) => {
         let serviceName = service.name;
         const servicePath = service.path;
@@ -60,6 +60,7 @@ const createServiceChoices = (serviceInfos) => {
             }
         });
     });
+    logger_helper_1.default.logger.debug(`Number of unique service choices: ${choices.length}`);
     return choices.sort((a, b) => (a.name ? a.name.localeCompare(b.name ?? '') : 0));
 };
 /**
@@ -87,9 +88,22 @@ function logServiceCatalogErrorsForHelp(requestErrors, numOfRequests) {
  */
 async function getServiceChoices(catalogs, serviceFilter) {
     const requestErrors = {};
-    const listServicesRequests = catalogs.map(async (catalog) => {
+    // Performance tracking for the requests
+    const requestTimes = {}; // [v2, v4] request times in ms
+    const listServicesRequests = [];
+    for (const catalog of catalogs) {
+        const catalogVer = catalog instanceof axios_extension_1.V2CatalogService ? axios_extension_1.ODataVersion.v2 : axios_extension_1.ODataVersion.v4;
         try {
-            return await catalog.listServices();
+            const startTime = Date.now();
+            const res = await catalog.listServices();
+            const endTime = Date.now();
+            const duration = endTime - startTime === 0 ? '<1 ms' : `${endTime - startTime}ms`;
+            requestTimes[`v${catalogVer}`] = {
+                serviceCount: res.length,
+                duration
+            };
+            logger_helper_1.default.logger.debug(`Number of service${catalogVer === axios_extension_1.ODataVersion.v4 ? ' groups' : 's'}: ${res.length} returned in: ${duration}}`);
+            listServicesRequests.push(res);
         }
         catch (error) {
             logger_helper_1.default.logger.error((0, i18n_1.t)('errors.serviceCatalogRequest', {
@@ -99,13 +113,15 @@ async function getServiceChoices(catalogs, serviceFilter) {
             }));
             // Save any errors for processing later as we may show more useful message to the user
             Object.assign(requestErrors, {
-                [catalog instanceof axios_extension_1.V2CatalogService ? axios_extension_1.ODataVersion.v2 : axios_extension_1.ODataVersion.v4]: error
+                [catalogVer]: error
             });
-            return [];
+            listServicesRequests.push([]);
         }
-    });
-    const serviceInfos = await Promise.all(listServicesRequests);
-    let flatServices = serviceInfos?.flat() ?? [];
+    }
+    // Log the request times for debugging purposes
+    logger_helper_1.default.logger.debug(`Service catalog request times: ${JSON.stringify(requestTimes, undefined, '    ')}`);
+    // Flatten the array of arrays
+    let flatServices = listServicesRequests?.flat() ?? [];
     logger_helper_1.default.logger.debug(`Number of services available: ${flatServices.length}`);
     if (flatServices.length === 0) {
         logServiceCatalogErrorsForHelp(requestErrors, catalogs.length);

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

@@ -49,6 +49,14 @@ export declare function getEntityChoices(edmx: string, { entitySetFilter, defaul
  * @returns the navigation entity choices
  */
 export declare function getNavigationEntityChoices(metadata: ConvertedMetadata, odataVersion: OdataVersion, mainEntityName: string): ListChoiceOptions<NavigationEntityAnswer>[];
+/**
+ * Returns only entity sets that have the `Aggregation.ApplySupported` annotation term with the `Transformations` property.
+ * This can be found within the entity set annotations or the entity type annotations.
+ *
+ * @param entitySets the entity sets to filter
+ * @returns the filtered entity sets
+ */
+export declare function filterAggregateTransformations(entitySets: EntitySet[]): EntitySet[];
 /**
  * Returns only entities that have a type property of 'HasDraftEnabled'.
  *

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.filterAggregateTransformations = filterAggregateTransformations;
 exports.filterDraftEnabledEntities = filterDraftEnabledEntities;
 const annotation_converter_1 = require("@sap-ux/annotation-converter");
 const edmx_parser_1 = require("@sap-ux/edmx-parser");

package/dist/prompts/edmx/questions.js

@@ -131,7 +131,7 @@ function getEntitySelectionQuestions(metadata, templateType, isCapService = fals
     }
     entityQuestions.push(...getAddAnnotationQuestions(metadata, templateType, odataVersion, isCapService));
     if (!promptOptions?.hideTableLayoutPrompts) {
-        entityQuestions.push(...getTableLayoutQuestions(templateType, odataVersion, isCapService));
+        entityQuestions.push(...getTableLayoutQuestions(templateType, odataVersion, isCapService, convertedMetadata));
     }
     if (templateType === 'alp') {
         entityQuestions.push(...(0, alp_questions_1.getAnalyticListPageQuestions)(odataVersion, annotations, promptOptions?.hideTableLayoutPrompts));
@@ -144,9 +144,10 @@ function getEntitySelectionQuestions(metadata, templateType, isCapService = fals
  * @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
+ * @param metadata the metadata (edmx) string of the service
  * @returns the table layout questions
  */
-function getTableLayoutQuestions(templateType, odataVersion, isCapService) {
+function getTableLayoutQuestions(templateType, odataVersion, isCapService, metadata) {
     const tableTypeChoices = [
         { name: (0, i18n_1.t)('prompts.tableType.choiceAnalytical'), value: 'AnalyticalTable' },
         { name: (0, i18n_1.t)('prompts.tableType.choiceGrid'), value: 'GridTable' },
@@ -157,7 +158,7 @@ function getTableLayoutQuestions(templateType, odataVersion, isCapService) {
     }
     const tableLayoutQuestions = [];
     if (templateType === 'lrop' || templateType === 'worklist' || templateType === 'alp') {
-        const tableTypeDefault = templateType === 'alp' ? 'AnalyticalTable' : 'ResponsiveTable';
+        let setAnalyticalTableDefault = false;
         tableLayoutQuestions.push({
             when: (prevAnswers) => !!prevAnswers.mainEntity,
             type: 'list',
@@ -165,10 +166,23 @@ function getTableLayoutQuestions(templateType, odataVersion, isCapService) {
             message: (0, i18n_1.t)('prompts.tableType.message'),
             guiOptions: {
                 hint: (0, i18n_1.t)('prompts.tableType.hint'),
-                breadcrumb: true
+                breadcrumb: true,
+                applyDefaultWhenDirty: true // set table type on entity selection change
             },
             choices: tableTypeChoices,
-            default: tableTypeDefault
+            default: (prevAnswers) => {
+                const tableTypeDefault = getDefaultTableType(templateType, metadata, odataVersion, prevAnswers?.mainEntity?.entitySetName, prevAnswers?.tableType);
+                setAnalyticalTableDefault = tableTypeDefault.setAnalyticalTableDefault;
+                return tableTypeDefault.tableType;
+            },
+            additionalMessages: (tableType) => {
+                if (tableType === 'AnalyticalTable' && setAnalyticalTableDefault) {
+                    return {
+                        message: (0, i18n_1.t)('prompts.tableType.analyticalTableDefault'),
+                        severity: yeoman_ui_types_1.Severity.information
+                    };
+                }
+            }
         });
         tableLayoutQuestions.push({
             when: (prevAnswers) => prevAnswers?.tableType === 'TreeTable' && odataVersion === odata_service_writer_1.OdataVersion.v4,
@@ -204,6 +218,56 @@ function getEdmxSizeInKb(edmx) {
     }
     return 0;
 }
+/**
+ * Get the default table type based on the template type and previous answers.
+ *
+ * @param templateType the template type of the application to be generated from the prompt answers
+ * @param metadata the metadata (edmx) string of the service
+ * @param odataVersion the OData version of the service
+ * @param mainEntitySetName the name of the main entity set
+ * @param currentTableType the current table type selected by the user
+ * @returns the default table type and a boolean indicating if AnalyticalTable should be set as default
+ */
+function getDefaultTableType(templateType, metadata, odataVersion, mainEntitySetName, currentTableType) {
+    let tableType;
+    let setAnalyticalTableDefault = false;
+    if ((templateType === 'lrop' || templateType === 'worklist') &&
+        odataVersion === odata_service_writer_1.OdataVersion.v4 &&
+        hasAggregateTransformationsForEntity(metadata, mainEntitySetName)) {
+        // For V4, if the selected entity has aggregate transformations, use AnalyticalTable as default
+        tableType = 'AnalyticalTable';
+        setAnalyticalTableDefault = true;
+    }
+    else if (templateType === 'alp') {
+        // For ALP, use AnalyticalTable as default
+        tableType = 'AnalyticalTable';
+    }
+    else if (currentTableType) {
+        // If the user has already selected a table type use it
+        tableType = currentTableType;
+    }
+    else {
+        // Default to ResponsiveTable for other cases
+        tableType = 'ResponsiveTable';
+    }
+    return {
+        tableType,
+        setAnalyticalTableDefault
+    };
+}
+/**
+ * Checks if the given entity set name has aggregate transformations in the metadata.
+ *
+ * @param metadata The metadata (edmx) string of the service.
+ * @param entitySetName The entity set name to check for aggregate transformations.
+ * @returns true if the entity set has aggregate transformations, false otherwise.
+ */
+function hasAggregateTransformationsForEntity(metadata, entitySetName) {
+    if (!entitySetName) {
+        return false;
+    }
+    return (0, entity_helper_1.filterAggregateTransformations)(metadata.entitySets).some((entitySet) => entitySet.name === entitySetName);
+}
 /**
  * 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.
  *

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

@@ -151,7 +151,8 @@
             "choiceGrid": "Grid",
             "choiceAnalytical": "Analytical",
             "choiceResponsive": "Responsive",
-            "choiceTree": "Tree"
+            "choiceTree": "Tree",
+            "analyticalTableDefault": "The 'Analytical' table type is chosen by default because the selected entity supports it."
         },
         "hierarchyQualifier": {
             "message": "Hierarchy Qualifier",

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.5.21",
+  "version": "2.5.23",
   "repository": {
     "type": "git",
     "url": "https://github.com/SAP/open-ux-tools.git",
@@ -28,7 +28,7 @@
     "i18next": "25.3.0",
     "inquirer-autocomplete-prompt": "2.0.1",
     "os-name": "4.0.1",
-    "@sap-ux/axios-extension": "1.22.3",
+    "@sap-ux/axios-extension": "1.22.4",
     "@sap-ux/btp-utils": "1.1.0",
     "@sap-ux/fiori-generator-shared": "0.13.3",
     "@sap-ux/guided-answers-helper": "0.3.1",
@@ -43,13 +43,13 @@
   "devDependencies": {
     "@sap-ux/vocabularies-types": "0.13.0",
     "@sap-devx/yeoman-ui-types": "1.14.4",
-    "@types/inquirer-autocomplete-prompt": "2.0.1",
+    "@types/inquirer-autocomplete-prompt": "2.0.2",
     "@types/inquirer": "8.2.6",
     "@types/lodash": "4.14.202",
-    "jest-extended": "3.2.4",
+    "jest-extended": "6.0.0",
     "@sap-ux/fiori-generator-shared": "0.13.3",
-    "@sap-ux/fiori-elements-writer": "2.5.14",
-    "@sap-ux/fiori-freestyle-writer": "2.4.25",
+    "@sap-ux/fiori-elements-writer": "2.5.15",
+    "@sap-ux/fiori-freestyle-writer": "2.4.26",
     "@sap-ux/feature-toggle": "0.3.0",
     "@sap-ux/odata-service-writer": "0.27.12",
     "@sap-ux/cap-config-writer": "0.10.21"
@@ -63,7 +63,7 @@
     "watch": "tsc --watch",
     "lint": "eslint . --ext .ts",
     "lint:fix": "eslint . --ext .ts --fix",
-    "test": "jest --ci --forceExit --detectOpenHandles --colors --passWithNoTests",
+    "test": "jest --ci --forceExit --detectOpenHandles --colors",
     "test-u": "jest --ci --forceExit --detectOpenHandles --colors -u",
     "link": "pnpm link --global",
     "unlink": "pnpm unlink --global"