Reference for Kavo's six optional DTO slots (create/update/patch/query/item/list) — entity-derived defaults, the dtoShapeKeys narrowing rule, and serialization order. Use when registering a DTO class on @Kavo's dto option, or answering "why isn't my field showing/hiding" or "what shape does this response have"…
Reference for Kavo's exception hierarchy, KAVO error-code catalog, and the RFC 9457 problem-details wire shape every generated route returns on failure. Use when handling/mapping a Kavo error, deciding which exception to throw from a custom handler/@Override, or answering "what does the error response look like"…
Reference for Kavo's global configuration — the KavoSettings precedence chain, built-in defaults table, KavoModule.forRoot/forRootAsync options, and the operations. global-default caveat (ADR-0015). Use when wiring createKavo/KavoModule.forRoot, setting app-wide defaults, or answering "what can I configure globally"…
Reference for @kavo/graphql and its Nest binding — building a schema over an existing createCrud service, the raw-AST filter/sort args, multi-entity merging, the process-wide type registry, and the zero-code KavoModule graphql option. Use when exposing an entity over GraphQL, or answering "how do I add GraphQL to this…
Reference for what @Kavo(Entity, config?) generates and how to configure/override it — routes table, EntityConfig shape (dto/allowlists/operations), manual-method-wins, @Override, and fully custom routes. Use when writing or reviewing a @Kavo-decorated controller, or answering "how do I configure/override this route"…
Reference for @kavo/mcp and its Nest binding — the standard per-entity toolset, findMany's raw-AST filter/sort args, flat update/patch args, isError result mapping, the zero-config KavoModule mcp option, and the fact that the default MCP route carries no auth guard. Use when exposing entities to an MCP client, or…
Wiring @kavo/mikroorm into a Nest app — passing the MikroORM instance rather than an EntityManager, why no RequestContext middleware is needed, opt-in case-insensitive filtering, declared soft delete, and native cross-relation filtering. Use when adding Kavo to a MikroORM project, or answering "how do I use Kavo with…
Wiring @kavo/mongoose into a Nest app — models as entity identities, ObjectId rendered as hex strings and id-keyed DTOs, declared soft delete, ref paths as relation and foreign key at once, and the cross-relation filter that is refused. Use when adding Kavo to a Mongoose/MongoDB project, or answering "how do I use…
Reference for Kavo's policy authorization DSL — permission()/role()/owner()/authenticated()/filtered()/when() composed with and()/or()/not(), config placement, entity-aware nodes, enforcement order, and the authorization.required default-deny switch. Use when gating an operation on the caller (403 KAVOFORBIDDEN)…
Wiring @kavo/prisma into a Nest app — the marker classes Prisma entities need, createInfrastructure's datamodel/entities options, case-insensitive filtering per database, and how the setup differs from the TypeORM path. Use when adding Kavo to a Prisma project, or answering "how do I use Kavo with Prisma" and "why…
Reference for the query-string grammar every generated Kavo route understands — filter operators, sort, field selection (fields/fields[relation]), pagination strategies, includes, withDeleted, and the security/coercion rules behind them. Use when writing API-consumer docs, constructing a request against a Kavo…
Fastest path to a working Kavo API in a brand-new project, using TypeORM and SQLite specifically — npm install list, minimal tsconfig, a single plain entity (no DTOs), and a zero-config @Kavo controller. Use when scaffolding a new Kavo app from scratch or answering "how do I get started with Kavo" questions. For a…
Reference for Kavo's soft delete, restore, and purge behavior — strategy resolution (auto/soft/hard), enabling restoreOne/purgeOne, read semantics and withDeleted, and edge cases (unique constraints, cascades). Use when configuring softDelete, wiring restore/purge routes, or answering "what happens to a deleted row"…
Reference for Kavo's optional Swagger/OpenAPI integration — installing @nestjs/swagger, what generated routes document automatically, and what's still a manual addition. Use when adding API docs to a Kavo app, or answering "how do I get OpenAPI docs for these routes" questions.