mongoose-adapter

Mongoose adapter

@kavo/mongoose adapts Kavo to a Mongoose connection. The engine, routes, query grammar, and DTO slots are identical to every other adapter — the differences below come from MongoDB itself, not from Kavo.

npm install @kavo/core @kavo/nest @kavo/mongoose

mongoose (^7.0.0 || ^8.0.0) is a peer dependency.

The model is the entity identity

Unlike Prisma, there is nothing to declare twice. A Mongoose model is already a constructor, so it is the identity @Kavo() wants — no marker class, no entity list (ADR-0018).

// book.model.ts
import mongoose, { Schema } from "mongoose";

const bookSchema = new Schema({
  title: { type: String, required: true },
});

export const Book = mongoose.model("Book", bookSchema);

@Kavo(Book) // the model itself
@Controller("books")
export class BookController {}

Wiring

// app.module.ts
import { Module } from "@nestjs/common";
import { KavoModule } from "@kavo/nest";
import { createInfrastructure } from "@kavo/mongoose";
import mongoose from "mongoose";
import { BookController } from "./book.controller.js";

await mongoose.connect(process.env.MONGO_URL!);

@Module({
  imports: [
    KavoModule.forRoot({
      infrastructure: createInfrastructure(mongoose.connection),
    }),
  ],
  controllers: [BookController],
})
export class AppModule {}

createInfrastructure(connection) derives both the entity metadata and the repository adapter from the connection's own registered models.

Define models at module scope, before connecting. @Kavo() generates its routes at class-decoration time, and Mongoose buffers commands until connect() resolves — a model created after the decorator runs is not registered in time.

Ids are strings, and the field is _id

MongoDB's primary key is _id, and the adapter renders every ObjectId as a hex string at the boundary. So responses are keyed by _id, not by a numeric id, and a DTO declares it as a string:

export class BookItemDto {
  _id = "";
  title = "";
}