Nest + TypeORM

Kavo's engine (@kavo/core) is ORM-agnostic — it talks to your data through a small adapter seam. @kavo/nest generates the routes; @kavo/typeorm adapts Kavo to a TypeORM DataSource. This is the complete, minimal wiring for that combination.

If you haven't yet, read Getting started first — this page assumes you already know what @Kavo() does and just needs the app-wiring.

pnpm

pnpm add @kavo/core @kavo/nest @kavo/typeorm

npm

npm install @kavo/core @kavo/nest @kavo/typeorm

yarn

yarn add @kavo/core @kavo/nest @kavo/typeorm

bun

bun add @kavo/core @kavo/nest @kavo/typeorm

@kavo/typeorm expects typeorm (^0.3.20 || ^1.0.0) as a peer — add it to the command above if your app doesn't already have it — and @kavo/nest expects the Nest runtime your app already has. See Peer dependencies for the full list with versions, and Requirements for the Node and TypeScript prerequisites.

Zero-config wiring

A plain TypeORM entity:

// book.entity.ts
import { Entity, PrimaryGeneratedColumn, Column } from "typeorm";

@Entity()
export class Book {
  @PrimaryGeneratedColumn()
  id!: number;

  @Column()
  title!: string;
}

@Kavo(Book) with no config object — zero-config, the full CRUD surface for free:

// book.controller.ts
import { Controller } from "@nestjs/common";
import { Kavo } from "@kavo/nest";
import { Book } from "./book.entity.js";

@Kavo(Book)
@Controller("books")
export class BookController {}

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

const dataSource = await new DataSource({
  type: "postgres",
  url: process.env.DATABASE_URL,
  entities: [Book],
}).initialize();

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

createInfrastructure(dataSource) derives both Kavo's entity metadata and its repository adapter from the DataSource's own TypeORM metadata — nothing to declare twice.

A complete, runnable app using all of the above lives in examples/nest-typeorm.