@sap-ux/inquirer-common 0.7.28 → 0.7.30

package/dist/prompts/helpers.d.ts

@@ -1,5 +1,6 @@
 import type { Answers, Question, Validator } from 'inquirer';
 import type { CommonPromptOptions, PromptDefaultValue, PromptSeverityMessage, YUIQuestion } from '../types';
+import type { ConvertedMetadata, EntitySet } from '@sap-ux/vocabularies-types';
 /**
  * Extends an additionalMessages function.
  *
@@ -45,4 +46,28 @@ export declare function withCondition(questions: Question[], condition: (answers
  * @returns - the extended questions
  */
 export declare function extendWithOptions<T extends YUIQuestion = YUIQuestion>(questions: T[], promptOptions: Record<string, Omit<CommonPromptOptions, 'hide'> & PromptDefaultValue<string | boolean>>, promptState?: Answers): YUIQuestion[];
+/**
+ * Checks if the given entity set name has aggregate transformations in the metadata.
+ *
+ * @param metadata The metadata (edmx) 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.
+ */
+export declare function hasAggregateTransformationsForEntity(metadata: ConvertedMetadata, entitySetName?: string): boolean;
+/**
+ * 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[];
+/**
+ * Converts an EDMX string to a ConvertedMetadata object.
+ *
+ * @param edmx - The EDMX string to convert.
+ * @returns The converted metadata object.
+ * @throws If the EDMX cannot be parsed or the OData version is unparseable.
+ */
+export declare function convertEdmxToConvertedMetadata(edmx: string): ConvertedMetadata;
 //# sourceMappingURL=helpers.d.ts.map

package/dist/prompts/helpers.js

@@ -8,7 +8,13 @@ exports.extendValidate = extendValidate;
 exports.applyExtensionFunction = applyExtensionFunction;
 exports.withCondition = withCondition;
 exports.extendWithOptions = extendWithOptions;
+exports.hasAggregateTransformationsForEntity = hasAggregateTransformationsForEntity;
+exports.filterAggregateTransformations = filterAggregateTransformations;
+exports.convertEdmxToConvertedMetadata = convertEdmxToConvertedMetadata;
 const cloneDeep_1 = __importDefault(require("lodash/cloneDeep"));
+const annotation_converter_1 = require("@sap-ux/annotation-converter");
+const edmx_parser_1 = require("@sap-ux/edmx-parser");
+const i18n_1 = require("../i18n");
 /**
  * Extends an additionalMessages function.
  *
@@ -133,4 +139,50 @@ function extendWithOptions(questions, promptOptions, promptState) {
     });
     return questions;
 }
+/**
+ * Checks if the given entity set name has aggregate transformations in the metadata.
+ *
+ * @param metadata The metadata (edmx) 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 filterAggregateTransformations(metadata.entitySets).some((entitySet) => entitySet.name === entitySetName);
+}
+/**
+ * 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
+ */
+function filterAggregateTransformations(entitySets) {
+    return entitySets.filter((entitySet) => {
+        return (!!entitySet.annotations?.Aggregation?.ApplySupported?.Transformations ||
+            !!entitySet.entityType?.annotations?.Aggregation?.ApplySupported?.Transformations);
+    });
+}
+/**
+ * Converts an EDMX string to a ConvertedMetadata object.
+ *
+ * @param edmx - The EDMX string to convert.
+ * @returns The converted metadata object.
+ * @throws If the EDMX cannot be parsed or the OData version is unparseable.
+ */
+function convertEdmxToConvertedMetadata(edmx) {
+    try {
+        const convertedMetadata = (0, annotation_converter_1.convert)((0, edmx_parser_1.parse)(edmx));
+        const parsedOdataVersion = parseInt(convertedMetadata?.version, 10);
+        if (Number.isNaN(parsedOdataVersion)) {
+            throw new Error((0, i18n_1.t)('errors.unparseableOdataVersion'));
+        }
+        return convertedMetadata;
+    }
+    catch (error) {
+        throw new Error((0, i18n_1.t)('errors.unparseableMetadata', { error: error.message }));
+    }
+}
 //# sourceMappingURL=helpers.js.map

package/dist/translations/inquirer-common.i18n.json

@@ -46,7 +46,9 @@
         "internalServerError": "Internal server error{{-errorMsg, addMsgWithColonFormatter}}",
         "badGateway": "Bad gateway{{- errorMsg, addMsgWithColonFormatter}}",
         "badRequest": "Bad request{{- errorMsg, addMsgWithColonFormatter}}",
-        "cannotBeEmpty": "{{- field}} cannot be empty."
+        "cannotBeEmpty": "{{- field}} cannot be empty.",
+        "unparseableMetadata": "Unable to parse entities from the metadata document: {{-error}}.",
+        "unparseableOdataVersion": "Unable to parse the OData version from the metadata."
     },
     "guidedAnswers": {
         "validationErrorHelpText": "Need help with this error?"

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@sap-ux/inquirer-common",
   "description": "Commonly used shared functionality and types to support inquirer modules.",
-  "version": "0.7.28",
+  "version": "0.7.30",
   "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.10.2",
+    "@sap-ux/edmx-parser": "0.9.1",
     "axios": "1.8.2",
     "chalk": "4.1.2",
     "figures": "3.2.0",
@@ -30,13 +32,14 @@
     "semver": "7.5.4",
     "@sap-ux/btp-utils": "1.1.0",
     "@sap-ux/feature-toggle": "0.3.0",
-    "@sap-ux/fiori-generator-shared": "0.13.4",
+    "@sap-ux/fiori-generator-shared": "0.13.5",
     "@sap-ux/guided-answers-helper": "0.3.1",
-    "@sap-ux/telemetry": "0.6.11",
+    "@sap-ux/telemetry": "0.6.12",
     "@sap-ux/logger": "0.7.0",
     "@sap-ux/ui5-info": "0.12.1"
   },
   "devDependencies": {
+    "@sap-ux/vocabularies-types": "0.13.0",
     "@sap-devx/yeoman-ui-types": "1.14.4",
     "@types/inquirer": "8.2.6",
     "@types/semver": "7.5.4",