Writing a package that extends the CAP runtime rather than an application that uses it — the mechanism underneath every cds-plugin in this atlas, and the question you arrive at once solving a problem twice makes you want to solve it once for everyone.
@sap/cds-dk The command line client and development toolkit for CAP projects, with the commands cds build, cds deploy, cds watch and cds add among them.
com.sap.cds:cds-services-bom Extension points for CAP Java plugins: CDS models shared as Maven artifacts and resolved into the project, and event handlers registered for custom types and annotations.
Not covered: It stops at loading. What a plugin may safely do once loaded — which lifecycle events to attach to, how to avoid colliding with another plugin's handlers, how to version against a runtime that moves — is convention rather than contract, and is learned from reading other plugins. The design-time half of a plugin, cds add and cds build, is @sap/cds-dk, a dependency that runs locally or in a pipeline and must not be loaded at application runtime.
No community artifact is documented here.
The agreement expressly includes plug-ins among the SAP materials and section 2 addresses making APIs and tools available to third parties. A plugin's own open-source licence does not erase those separate use terms.
SAP Developer License Agreement 3.2 CAP →Its own readme carries a caution: this is a sample, not intended for production use. It exists to demonstrate the plugin mechanism, and the bookstore sample is where it is used.
Not in production. SAP states it is just a sample, not optimised for performance or security.
Not in production. SAP states it is just a sample, not optimised for performance or security.
Not in production. SAP states it is just a sample, not optimised for performance or security.
Not in production. SAP states it is just a sample, not optimised for performance or security.
Not in production. SAP states it is just a sample, not optimised for performance or security.
Not in production. SAP states it is just a sample, not optimised for performance or security.
A plugin can implement a build plugin, registered with cds.build in its cds-plugin.js and run by cds build to write its own deployment artifacts; 7.6.0 on 2024-01-31 added contributing the build task type to the cds schema for code completion. Dated from npm.
Advice that deployment artifacts a plugin needs must be produced by a script outside cds build.
capability:plugin-authoring