@sap-ux/fiori-elements-writer 2.0.8 → 2.1.0

package/dist/data/templateAttributes.d.ts

@@ -37,6 +37,14 @@ type TemplateAttributes = {
         minimumUi5Version: {
             [V in OdataVersion]?: string;
         };
+        /**
+         * Checks whether annotations can be generated for a given template type and OData version.
+         * Annotation generation is supported for template types: lrop, worklist, or formEntryObject
+         * when using OData version 4.
+         */
+        annotationGenerationSupport?: {
+            [V in OdataVersion]?: boolean;
+        };
     };
 };
 export declare const TemplateTypeAttributes: TemplateAttributes;

package/dist/data/templateAttributes.js

@@ -116,6 +116,9 @@ exports.TemplateTypeAttributes = {
         minimumUi5Version: {
             [types_1.OdataVersion.v2]: exports.minSupportedUI5Version,
             [types_1.OdataVersion.v4]: '1.99.0'
+        },
+        annotationGenerationSupport: {
+            [types_1.OdataVersion.v4]: true
         }
     },
     [types_1.TemplateType.ListReportObjectPage]: {
@@ -123,6 +126,9 @@ exports.TemplateTypeAttributes = {
         minimumUi5Version: {
             [types_1.OdataVersion.v2]: exports.minSupportedUI5Version,
             [types_1.OdataVersion.v4]: '1.84.0'
+        },
+        annotationGenerationSupport: {
+            [types_1.OdataVersion.v4]: true
         }
     },
     [types_1.TemplateType.AnalyticalListPage]: {
@@ -143,6 +149,9 @@ exports.TemplateTypeAttributes = {
         supportedODataVersions: [types_1.OdataVersion.v4],
         minimumUi5Version: {
             [types_1.OdataVersion.v4]: '1.90.0'
+        },
+        annotationGenerationSupport: {
+            [types_1.OdataVersion.v4]: true
         }
     },
     [types_1.TemplateType.FlexibleProgrammingModel]: {

package/dist/index.d.ts

@@ -2,6 +2,7 @@ import type { Editor } from 'mem-fs-editor';
 import type { App } from '@sap-ux/ui5-application-writer';
 import type { FioriElementsApp } from './types';
 import { TemplateTypeAttributes, minSupportedUI5Version, minSupportedUI5VersionV4 } from './data/templateAttributes';
+import type { Logger } from '@sap-ux/logger';
 export declare const V2_FE_TYPES_AVAILABLE = "1.108.0";
 /**
  * Generate a UI5 application based on the specified Fiori Elements floorplan template.
@@ -9,9 +10,10 @@ export declare const V2_FE_TYPES_AVAILABLE = "1.108.0";
  * @param basePath - the absolute target path where the application will be generated
  * @param data - configuration to generate the Fiori elements application
  * @param fs - an optional reference to a mem-fs editor
+ * @param log - optional logger instance
  * @returns Reference to a mem-fs-editor
  */
-declare function generate<T extends {}>(basePath: string, data: FioriElementsApp<T>, fs?: Editor): Promise<Editor>;
+declare function generate<T extends {}>(basePath: string, data: FioriElementsApp<T>, fs?: Editor, log?: Logger): Promise<Editor>;
 export { generate, FioriElementsApp, App, TemplateTypeAttributes, minSupportedUI5Version, minSupportedUI5VersionV4 };
 export * from './types';
 //# sourceMappingURL=index.d.ts.map

package/dist/index.js

@@ -38,6 +38,7 @@ const i18n_1 = require("./i18n");
 const fiori_generator_shared_1 = require("@sap-ux/fiori-generator-shared");
 const fpmConfig_1 = require("./fpmConfig");
 const cap_config_writer_1 = require("@sap-ux/cap-config-writer");
+const writeAnnotations_1 = require("./writeAnnotations");
 exports.V2_FE_TYPES_AVAILABLE = '1.108.0';
 /**
  * Get TypeScript Ignore Glob Pattern.
@@ -73,9 +74,10 @@ function getTypeScriptIgnoreGlob(feApp, coercedUI5Version) {
  * @param basePath - the absolute target path where the application will be generated
  * @param data - configuration to generate the Fiori elements application
  * @param fs - an optional reference to a mem-fs editor
+ * @param log - optional logger instance
  * @returns Reference to a mem-fs-editor
  */
-async function generate(basePath, data, fs) {
+async function generate(basePath, data, fs, log) {
     // Load i18n translations asynchronously to ensure proper initialization.
     // This addresses occasional issues where i18n is not initialized in time, causing tests to fail.
     await (0, i18n_1.initI18n)();
@@ -192,6 +194,9 @@ async function generate(basePath, data, fs) {
         // apply cap updates when service is cap
         await (0, cap_config_writer_1.applyCAPUpdates)(fs, feApp.service.capService, settings);
     }
+    if (feApp.appOptions?.addAnnotations) {
+        await (0, writeAnnotations_1.writeAnnotations)(basePath, feApp, fs, log);
+    }
     return fs;
 }
 __exportStar(require("./types"), exports);

package/dist/translations/fiori-elements-writer.i18n.json

@@ -2,6 +2,9 @@
     "info": {
         "mockOnlyWarning": "This application was generated with a local metadata file and does not reference a live server. Please add the required server configuration or start this application with mock data using the target: npm run start-mock"
     },
+    "warn": {
+        "invalidTypeForAnnotationGeneration": "The provided option addAnnotations is not supported for the specified template '{{ templateType }}' and odata version '{{ odataVersion }}'. Generation will continue but additional annotations will not added."
+    },
     "error": {
         "unsupportedOdataVersion": "OData Version of the specified service: {{ serviceVersion }}, is not supported by the template type: {{ templateType }}",
         "unsupportedUI5Version": "Specified UI5 property '{{ versionProperty }}': {{ ui5Version }}, is not supported by the template type: {{ templateType }}. Please specify {{minRequiredUI5Version}} or above.",

package/dist/types.d.ts

@@ -100,6 +100,11 @@ export interface FioriElementsApp<T> extends Ui5App {
          * This will eventually move up to {@link Ui5App.appOptions}
          */
         addTests?: boolean;
+        /**
+         * If addAnnotations is true, annotations are enabled.
+         * However, annotations will only be written if the template type is lrop, worklist, or formEntryObject; annotation generation is unspported for other project types.
+         */
+        addAnnotations?: boolean;
     };
 }
 export { OdataVersion } from '@sap-ux/odata-service-writer';

package/dist/writeAnnotations.d.ts

@@ -0,0 +1,13 @@
+import { type FioriElementsApp } from './types';
+import type { Editor } from 'mem-fs-editor';
+import type { Logger } from '@sap-ux/logger';
+/**
+ * Writes annotation files for the given application configuration.
+ *
+ * @param basePath - The base directory path of the project.
+ * @param feApp -  to generate the Fiori elements application
+ * @param fs - The file system editor instance.
+ * @param log - The logger instance.
+ */
+export declare function writeAnnotations<T extends {}>(basePath: string, feApp: FioriElementsApp<T>, fs: Editor, log?: Logger): Promise<void>;
+//# sourceMappingURL=writeAnnotations.d.ts.map

package/dist/writeAnnotations.js

@@ -0,0 +1,66 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.writeAnnotations = writeAnnotations;
+const path_1 = require("path");
+const fiori_generator_shared_1 = require("@sap-ux/fiori-generator-shared");
+const types_1 = require("./types");
+const annotation_generator_1 = require("@sap-ux/annotation-generator");
+const templateAttributes_1 = require("./data/templateAttributes");
+const i18n_1 = require("./i18n");
+/**
+ * Generates the annotation file path based on whether the CAP service is available.
+ *
+ * @param {string} [appName] - The name of the application.
+ * @param {CapServiceCdsInfo} [capService] - The CAP service info.
+ * @returns {string} The annotation file path based on whether the CAP service is available.
+ */
+function getAnnotationFilePath(appName, capService) {
+    if (capService) {
+        const appPath = capService.appPath ?? (0, fiori_generator_shared_1.getCapFolderPathsSync)(capService.projectPath).app;
+        return `${appPath}${path_1.sep}${appName}${path_1.sep}annotations.cds`;
+    }
+    return `webapp${path_1.sep}annotations${path_1.sep}annotation.xml`;
+}
+/**
+ * Writes annotation files for the given application configuration.
+ *
+ * @param basePath - The base directory path of the project.
+ * @param feApp -  to generate the Fiori elements application
+ * @param fs - The file system editor instance.
+ * @param log - The logger instance.
+ */
+async function writeAnnotations(basePath, feApp, fs, log) {
+    if (templateAttributes_1.TemplateTypeAttributes[feApp.template.type]?.annotationGenerationSupport?.[feApp.service.version]) {
+        const { settings } = feApp.template;
+        const { capService } = feApp.service;
+        const { name: packageName } = feApp.package ?? {};
+        const entitySetName = settings?.entityConfig?.mainEntityName ?? '';
+        const addLineItems = feApp.template.type === types_1.TemplateType.ListReportObjectPage || feApp.template.type === types_1.TemplateType.Worklist;
+        let serviceName = 'mainService';
+        let projectPath = basePath;
+        if (capService) {
+            serviceName = capService.serviceName;
+            projectPath = capService.projectPath;
+        }
+        const options = {
+            entitySetName: entitySetName,
+            annotationFilePath: getAnnotationFilePath(packageName, capService),
+            addFacets: true,
+            addLineItems,
+            addValueHelps: !!capService
+        };
+        const serviceParameters = {
+            serviceName,
+            appName: packageName,
+            project: projectPath
+        };
+        await (0, annotation_generator_1.generateAnnotations)(fs, serviceParameters, options);
+    }
+    else {
+        log?.warn((0, i18n_1.t)('warn.invalidTypeForAnnotationGeneration', {
+            templateType: feApp.template.type,
+            odataVersion: feApp.service.version
+        }));
+    }
+}
+//# sourceMappingURL=writeAnnotations.js.map

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@sap-ux/fiori-elements-writer",
   "description": "SAP Fiori elements application writer",
-  "version": "2.0.8",
+  "version": "2.1.0",
   "repository": {
     "type": "git",
     "url": "https://github.com/SAP/open-ux-tools.git",
@@ -29,11 +29,13 @@
     "semver": "7.5.4",
     "@sap-ux/odata-service-writer": "0.25.5",
     "@sap-ux/ui5-application-writer": "1.2.9",
-    "@sap-ux/fe-fpm-writer": "0.32.2",
+    "@sap-ux/fe-fpm-writer": "0.32.3",
     "@sap-ux/ui5-config": "0.26.1",
     "@sap-ux/ui5-test-writer": "0.4.1",
-    "@sap-ux/fiori-generator-shared": "0.7.23",
-    "@sap-ux/cap-config-writer": "0.9.2"
+    "@sap-ux/fiori-generator-shared": "0.7.25",
+    "@sap-ux/cap-config-writer": "0.9.4",
+    "@sap-ux/annotation-generator": "0.3.3",
+    "@sap-ux/logger": "0.6.0"
   },
   "devDependencies": {
     "@types/ejs": "3.1.2",