Skip to content

Main Navigation Getting started

Appearance

Sidebar Navigation

Getting Started

Introduction

Requirements

Installation

Quick Start

Core

Entities

CRUD Operations

Schemas

Services

Routes & Controllers

Custom Operations

Querying

Filtering

Search

Sorting

Pagination

Field Selection

Includes

Features

Relations

Soft Delete

Realtime Events

Caching & ETags

Result Cache

Allowed

Virtual Fields

Policy

Apply

Composite Primary Keys

Integrations

ORMs

TypeORM

Prisma

Mongoose

MikroORM

Protocols

GraphQL

MCP

Frameworks

Next.js

Guides

Configuration

Module setup

Settings

ETag overrides and redaction

Entity config

Operations

Wiring Your Own Auth

Error Handling

Custom Adapter

Benchmarks

Migrating Relations Config (pre-v0.10)

Using the API

Reference

Config Keys

Errors

Decorators

Peer Dependencies

For contributors

Blueprint

System architecture

Monorepo and packages

Core contracts and type system

Walking skeleton

Schema system

Query grammar

Error handling

CRUD engine

Configuration

TypeORM adapter

NestJS integration

Next.js integration

Core features

Soft delete

Relations and includes

GraphQL binding

Prisma adapter

Mongoose adapter

MCP binding

MikroORM adapter

Realtime

ADRs

0001 — Clean architecture, core owns contracts

0002 — Package topology

0003 — pnpm, plain scripts, tsc build

0004 — Lockstep versioning

0005 — Core zero runtime dependencies

0006 — Registry-driven operations

0007 — Module-augmentable operation metadata

0008 — Field-path recursion cap

0009 — Problem-details error shape

0010 — Explicit named barrel

0011 — Entity-metadata infrastructure seam

0012 — Decoration-time route generation

0013 — Config-declared soft-delete operations

0014 — Associate by id, not deep writes

0015 — Global operation defaults are engine-only

0016 — GraphQL protocols package

0017 — Prisma marker classes and entity registry

0018 — Mongoose models are entity identities

0019 — Computed fields are serializer-evaluated

0020 — Content-hash ETags and the engine read seam

0021 — Cursor pagination is an opaque keyset union

0022 — Since pagination composes a value|id keyset

0023 — Realtime transports are resolved config, not settings

0024 — Collection channels reuse the filter grammar and vocabulary

0025 — Handlers reach persistence through the request context

0026 — selectable narrows the response projection

0027 — An @Override inherits the ETag, but not the precondition

0028 — Relation inclusion permission moves into the allowed.includable allowlist

0029 — Array relations may opt into replace writes

0030 — 'none' pagination strategy opts a resource out entirely

0031 — Result cache is a live per-entity store

0032 — Policy authorization DSL

0033 — Policy moves to operation scope only

0034 — when() predicate takes a single object argument

0036 — policy gains entity- and global-scope defaults

0037 — policy collapses to a single predicate function, at three scopes

0038 — Declaring operations at all makes it an exclusive whitelist

0039 — Composite primary keys, @kavo/typeorm only

0040 — Composite primary keys extend to @kavo/prisma

0041 — Releases are cut by release-please

0042 — Filter and Query are documented-only aggregate component schemas

0044 — A relation-dotted allowed.selectable allowlist entry caps an included relation's projection

0045 — The allowed.selectable allowlist takes root paths only; the relation-dotted ceiling is removed

0046 — A defaults block covers what a request looks like when the client asks for nothing

0047 — The settings tree groups limits and lifts search to top level

0048 — apply adds an unconditional, per-axis server-side query constraint

0049 — set forces write-body values

0050 — Derived fields come from ORM metadata; core stays expression-agnostic

0051 — FieldPath's default recursion cap raised from 3 to 5

On this page

ADR-0034 — `when(predicate)` takes a single object argument

Status: superseded by ADR-0037 — when/PolicyNode are gone; policy is now a single plain function taking one object argument. See ADR-0037 for the current design.

Pager

Previous page0033 — Policy moves to operation scope only

Next page0036 — policy gains entity- and global-scope defaults

Built by the Kavo community