@sap/ux-cds-compiler-facade
Wraps the CAP CDS compiler behind one set of APIs for annotation handling, so tooling reads a model without tracking which compiler version is installed.
Tooling that works on the annotations in a CAP project has to compile the model first, and what the compiler hands back differs between versions. This is the wrapper SAP Fiori tools uses for that: createCdsCompilerFacade takes a compile model that already exists, createCdsCompilerFacadeForRoot compiles a project's .cds files from a root folder, and the facade then answers for metadata, the annotation index, compiler messages, the source URIs and the annotation propagation map, in a form its own documentation calls compiler version agnostic. Its stated coverage is all the officially supported CAP CDS compiler versions. It reads a model rather than writing one: @sap-ux/cds-annotation-parser@sap-ux/cds-annotation-parserParses annotations out of CDS source, so tooling can read what a model says about its UI without compiling it.sap official, cap is the sibling that reads annotations out of CDS source without compiling at all.
Facts
Where it sits
Who is behind it
In the atlas: maintains 137, wrote 14@SAPmaintainer
What it declares
Every artifact
- Type
- Package
- Origin
- By SAP
- Runtime
- Node.js
As a package
- Where it runs
- does not say
- Distributed through
- npm
Connections
Describing a service so a Fiori client renders it without UI code
Download
Install
npm add @sap/ux-cds-compiler-facadeDerived from the package name. No recipe recorded; the README has the configuration.
README
quoted from @sap/ux-cds-compiler-facade@1.25.0, read@sap/ux-cds-compiler-facade
The SAP Fiori Tools - CDS Compiler Facade is a wrapper module for CAP CDS compiler. It contains a set of specific APIs needed for annotation handling in CAP CDS projects.
Compiler facade provides various API methods that allows the user to extract data from the CAP CDS compile model such as metadata, annotation index, compiler messages, annotation propagation map and others (see usage example below) in a compiler version agnostic way.
It supports all the officially supported CAP CDS compiler versions.
History
Others providing
Compare all 15 on the Fiori annotations page →- rap-extrap-extFloorplan classes that read a CDS entity's UI annotations at runtime and render a list report, worklist, tree, object page, overview page, value help or action dialog as an abap2UI5 app.community org, abapFloorplans rendered from CDS UI annotations as abap2UI5 appsfrom ABAP
- com.sap.cds:cds-services-bomcom.sap.cds:cds-services-bomThe Maven bill of materials for CAP Java, pinning every com.sap.cds module in a release, from the API and core runtime to the Spring Boot starters and the CQN engine, to the same version.sap official, capMaven bill of materials pinning CAP Java module versionsfrom CAP
- urp-vocaburp-vocabA CDS vocabulary for User-Rendered Patterns, with @urp.display annotations describing views, card templates, layouts and sections on an entity, consumed by the author's own matching renderer.independent, capCDS vocabulary for User-Rendered Patterns display annotationsfrom CAP
- @mpah/enum-value-help@mpah/enum-value-helpA CAP plugin that generates value help for enum fields from an @enumValueHelp annotation, serving the enum's values from one generated entity instead of hand-written OData annotations.independent, capCAP plugin generating value help for enum fields from an annotationfrom CAP
- @sap/cds-fiori@sap/cds-fioriFiori draft handling and UI-facing behaviour for CAP services.sap official, capFiori draft handling and UI-facing behaviour for CAP servicesfrom CAP
- @sap/cds@sap/cdsThe CAP Node.js runtime, which compiles the CDS model, serves the services declared in it, answers generic requests before any handler runs, and loads every cds-plugin.sap official, capCAP Node.js runtimefrom CAP
- @sap/generator-fiori@sap/generator-fioriThe single entry point for generating a Fiori application — the user picks a template and the generator produces the project around it.sap official, capEntry point for generating a Fiori application from a templatefrom CAP
- @sap-ux/cds-annotation-parser@sap-ux/cds-annotation-parserParses annotations out of CDS source, so tooling can read what a model says about its UI without compiling it.sap official, capParser for annotations in CDS sourcefrom CAP
- @sap-ux/cds-odata-annotation-converter@sap-ux/cds-odata-annotation-converterConverts CDS annotations into their OData form, which is the translation Fiori tooling needs to reason about a service the way a client sees it.sap official, capConverter from CDS annotations to their OData formfrom CAP
- @sap/ux-cds-odata-language-server-extension@sap/ux-cds-odata-language-server-extensionAdds the OData annotation features to @sap/vscode-cds, the CDS plug-in for Visual Studio Code: completion, micro-snippets, diagnostics, vocabulary documentation, Go to Definition and an i18n check inside a .cds file.sap official, capOData annotation features for the @sap/vscode-cds extensionfrom CAP
- @sap-ux/fiori-annotation-api@sap-ux/fiori-annotation-apiThe programmatic API Fiori tooling uses to read and write annotations on a project, rather than editing the files as text.sap official, capProgrammatic API for reading and writing project annotationsfrom CAP
- @sap-ux/odata-vocabularies@sap-ux/odata-vocabulariesCarries the OASIS and SAP OData vocabularies as a package, with a VocabularyService for asking which terms exist, where they apply and what their types and properties are.sap official, ui5OASIS and SAP OData vocabularies with a VocabularyServicefrom UI5
- cap-js-geoloc-plugincap-js-geoloc-pluginA CAP plugin for geocoding, address correction and route calculation, driven by three annotations on the model, with the geocoder and router chosen in configuration from providers such as OSRM and Nominatim.independent, capAnnotation-driven geocoding, address correction and routing for CAPfrom CAP
- cap-user-infocap-user-infoResolves the createdBy and modifiedBy of a managed entity to a stored user record of email, given name and family name, and renders the two fields as links with a quickview.independent, capUser details and quickview links for createdBy and modifiedByfrom CAP
Details
Sources
Sources are graph entities: the same page may back several entries, and an unreachable source flags every row that rests on it.
Compatibility and provenance
History in the atlas
- First seen.
For your agent
- Ref
artifact:sap-ux-cds-compiler-facade- JSON
- /artifacts/sap-ux-cds-compiler-facade.json
- MCP
- Connecting an agent