FEATURE - Add an option to open source FEwriter generate to enable writing annotations.

[kjose90]

Extend the open-source Fiori Elements/ Fiori Freesryle writer's generate method to support annotation writing as part of the app generation process. This can be done by -

1. Adding an optional property writeAnnotations to the appOptions of the FioriElementsApp interface here.

packages/fiori-elements-writer/src/types.ts

import { type GenerateAnnotationsOptions } from '@sap-ux/annotation-generator';

interface WriteAnnotationsConfig extends GenerateAnnotationsOptions {
    /* The name of the service, CAP service name or 'mainService' by default. */
    serviceName: string;
}

export interface FioriElementsApp<T> extends Ui5App {
    template: Template<T>;
    service: Omit<OdataService, 'model'>; // Model name will use defaults
    app: FioriApp;
    appOptions: Partial<AppOptions> & {
        ....
        addTests?: boolean;
        writeAnnotations?: WriteAnnotationsConfig;
    };
}

2. Update the generate Method of the Fiori Elements Writer. Check if writeAnnotations is provided in appOptions. If it's present, the annotation writing logic will be invoked during the app generation.
   packages/fiori-elements-writer/src/index.ts

import {
    generateAnnotations,
    type AnnotationServiceParameters
} from '@sap-ux/annotation-generator';

export async function generate<T>(
    destinationPath: string,
    app: FioriElementsApp<T>,
    fs: Editor
): Promise<void> {
    // Existing logic for file generation
    ...

       // Handle annotation writing if configuration is provided
    if (app.appOptions.writeAnnotations) {
        const { serviceName, ...annotationOptions } = feApp.appOptions.writeAnnotations;
        const annoServiceParams: AnnotationServiceParameters = { 
            serviceName, 
            appName: feApp.package.name, 
            project: // get project path from annotationFilePath 
        };

        await generateAnnotations(fs, annoServiceParams, annotationOptions);
    }

    ...
}

Architecture Elaboration

Does it requires architecture elaboration?

Notes

Tasks

• Adding an optional property writeAnnotations to the appOptions of the FioriElementsApp interface
• Update the generate Method of the Fiori Elements Writer