import type { Project } from '@sap-ux/project-access'; import type { Editor } from 'mem-fs-editor'; export type AnnotationServiceParameters = { /** * Path to project root folder or project instance. */ project: string | Project; /** * Name of the service. */ serviceName: string; /** * Name of the app. */ appName?: string; /** * Only applicable for CAP CDS projects. * When set to true SAP annotations will be created instead of OData annotations. * File provided via "annotationPath" is assumed to be empty and it's content is not evaluated by the generator. * Currently only supports insert changes for the following annotations: * - UI.LineItem * - UI.Facets * - UI.FieldGroup * * @experimental */ writeSapAnnotations?: boolean; }; /** * Generate annotations options. */ export type GenerateAnnotationsOptions = { /** * Name of entity set which is the basis for List Report/Object Page. */ entitySetName: string; /** * Relative path (from project root) to the local annotation file, where annotations should be generated. */ annotationFilePath: string; /** * Generate default facets (UI.Facets and UI.FieldGroup annotations for Object Page). */ addFacets?: boolean; /** * Generate default line items (UI.LineItem annotation for List Report). */ addLineItems?: boolean; /** * Generate value helps (Common.ValueList annotation for Value Helps). */ addValueHelps?: boolean; }; /** * Generate annotations - for usage during app generation. * * @param fs - In memory file system editor. * @param annotationServiceParams - Parameters for creating annotation service instance. * @param options - Annotation generation options. * @returns true if annotations were generated. */ export declare function generateAnnotations(fs: Editor, annotationServiceParams: AnnotationServiceParameters, options: GenerateAnnotationsOptions): Promise; //# sourceMappingURL=generation.d.ts.map