prisma-adapter

Prisma adapter

@kavo/prisma adapts Kavo to a Prisma Client. The engine, routes, query grammar, DTO slots, and error shapes are identical to every other adapter — only the wiring below differs.

npm install @kavo/core @kavo/nest @kavo/prisma

@prisma/client (^5.0.0 || ^6.0.0) is a peer dependency.

The one thing that is not like TypeORM: marker classes

Prisma generates no runtime class for a model. prisma generate produces types and a client with delegates (prisma.book), but nothing that survives to runtime as a constructor — and @Kavo(Entity) needs a stable runtime identity to key an entity by.

So each model needs a small marker class: an empty class whose name matches the Prisma model exactly.

// book.entity.ts
export class Book {
  id!: number;
  title!: string;
}

This is the shape of the trap. The natural guess — passing the delegate, the way you would pass an entity class with TypeORM — does not work:

@Kavo(prisma.book)        // ✗ wrong — a delegate is not an identity
@Kavo(Book)               // ✓ the marker class

Declare the fields anyway — they are what gives you type safety. At runtime @kavo/prisma reads only .name off the class and takes all real metadata from Prisma's DMMF, so an empty class Book {} still produces working routes. But the declared fields are what type createCrud's generic parameters, so an empty marker class collapses Entity to {} and every typed surface built on it silently stops checking anything: allowed.filterable/sortable/selectable, query.defaultSort, and the DTO slot generics all stop rejecting misspelled field names at compile time.

Name-matching is what binds class to model, so a marker class named Books for a model named Book will not resolve — that one fails loudly, as a bootstrap ConfigurationException rather than a silent no-op. See ADR-0017 for the full rationale.

Wiring

// app.module.ts
import { Module } from "@nestjs/common";
import { KavoModule } from "@kavo/nest";
import { createInfrastructure } from "@kavo/prisma";
import { PrismaClient, Prisma } from "@prisma/client";
import { Book } from "./book.entity.js";
import { BookController } from "./book.controller.js";

const prisma = new PrismaClient();

@Module({
  imports: [
    KavoModule.forRoot({
      infrastructure: createInfrastructure(prisma, {
        datamodel: Prisma.dmmf.datamodel,
        entities: [Book],
      }),
    }),
  ],
  controllers: [BookController],
})
export class AppModule {}