import type { ExportResults, File, GenerateSchemaParameters, ExportConfigParameters, ImportConfigParameters, ImportProjectParameters, ApiVersion, GenerateCustomExtensionParams, ExportConfigWithPath } from '@sap/ux-specification-types'; import type { Editor } from 'mem-fs-editor'; import { PromptsAPI, PromptsType } from '@sap-ux/fe-fpm-writer'; export { readApp } from './ftfs'; /** * Return the generic (project independent) JSON schema. * * @param specification - reference to spec * @param version - Fiori elements version (v2 or v4) * @param schemaType - type of the schema, e.g. ListReport, ObjectPage * @returns the generic schema for the given Fiori Elements version and schema type */ export { getGenericSchema } from './specification/schemaAccess'; /** * API class to request and handle prompts for fpm-writer features. */ export declare const prompts: { api: typeof PromptsAPI; types: typeof PromptsType; }; /** * Generate JSON schema for a given Fiori elements version and page type. * * @param generateParameters the input structure that contains the version, schema type, and parameters * @returns the app-specific schema for the given schema type and page */ export declare function generateSchema(generateParameters: GenerateSchemaParameters): object; /** * Exports the whole config (src/*.json, src/pages/*.json) to flex changes and/or manifest settings. * * @param exportParameters - parameters to control the export * @returns a bundle of all actual objects of any artifact type */ export declare function exportConfig(exportParameters: ExportConfigParameters): ExportResults; /** * Exports a part of the config, specified by a propertyPath, to flex changes and/or manifest settings. * * @param exportParameters - parameters to control the export * @returns a bundle of all changed objects of any artifact type */ export declare function exportConfigEntityByPath(exportParameters: ExportConfigWithPath): ExportResults; /** * Exports a part of the config, specified by a propertyPath, to flex changes and/or manifest settings. * * @param exportParameters - parameters to control the export * @returns a bundle of all changed objects of any artifact type */ export declare function deleteConfigEntityByPath(exportParameters: ExportConfigWithPath): ExportResults; /** * Imports manifest settings and flex changes to a config (src/*.json, src/pages/*.json). * * @param importParameters - parameters to control the import * @returns the generated config json file */ export declare function importConfig(importParameters: ImportConfigParameters): object | undefined; /** * Evaluates all project files and generates app schemas and configs out of it. * * @param importParameters - parameters to control the import; here: all relevant project files * @returns a list of files, comprising app schemas and configs */ export declare function importProject(importParameters: ImportProjectParameters): Promise; /** * Evaluates all project files and generates app schemas out of it, but no configs. * * @param importParameters - parameters to control the import; here: all relevant project files * @returns a list of files, comprising all app schemas */ export declare function importProjectSchema(importParameters: ImportProjectParameters): Promise; /** * Returns specification API version. * * @returns {ApiVersion} Object of API version. */ export declare function getApiVersion(): ApiVersion; /** * Calls the FPM Writer for generating a custom extension. * * @param customExtensionParams parameters for generating the custom extension * @returns Instance of mem-fs-editor */ export declare function generateCustomExtension(customExtensionParams: GenerateCustomExtensionParams): Promise; //# sourceMappingURL=api.d.ts.map