@prismakit/core

Framework-agnostic Prisma repository factory with cache-aside, auto-compose, and row locks.

Not a Prisma fork — wrap your existing PrismaClient.

Status: pre-stable (4.0).

Documentation · Getting started · Migrate to 4.0 · GitHub

Install

pnpm add @prismakit/core
# peer: @prisma/client

Quick start

import {
  createRepository,
  loadPrismaMetaFromSchema,
} from '@prismakit/core';
import { PrismaClient } from '@prisma/client';

loadPrismaMetaFromSchema('prisma/schema.prisma');
// Prisma 5/6: loadPrismaMetaFromDmmf(Prisma.dmmf)

const prisma = new PrismaClient();

const UserRepository = createRepository({
  model: 'user',
  cache: { ttl: 86400 }, // or `cache: true`
  lock: true,            // table + columns from Prisma meta
});

const users = new UserRepository({ prisma /*, cache */ });

const user = await users.getThrowById({
  id,
  select: { id: true, email: true, name: true },
  setCache: true,
});

Only public option: createRepository. Meta (scalars, PK, relations) comes from loadPrismaMetaFromSchema / loadPrismaMetaFromDmmf.

Repository options

| Option | Description | |--------|-------------| | model | Prisma client key ('user' → prisma.user). Required. | | cache | CacheOptions or true for defaults | | lock | true (from meta) or { tableName, columns? } | | toPayload | Optional payload mapper (defaults to identity) |

Main methods

| Method | Purpose | |--------|---------| | getById / getThrowById | Read by id (setCache?, lock?, tx?) | | getFirst / getMany / getManyPaginate | Queries | | getManyCursor | Cursor pagination (CursorPage<T>) | | count / exists | { count } / { exists } | | aggregate / groupBy | Prisma aggregate delegates | | create / updateById / deleteById | Writes by id (invalidate, optional tags) | | updateMany / deleteMany | Bulk writes by where | | invalidateCache | Manual cache clear |

Cache runs only when you pass setCache: true (or defaultSetCache) and the repo has cache config. Never cache auth / uniqueness lookups.

NestJS

Prefer @prismakit/nestjs:

• PrismaKitModule
• createDefineRepo / app defineAppRepo (default)
• createInjectableRepository (low-level escape hatch)
• TransactionService

Related packages

| Package | Role | |---------|------| | @prismakit/redis | Redis CacheAdapter | | @prismakit/memory | In-memory CacheAdapter (tests) | | @prismakit/nestjs | NestJS integration | | @prismakit/opentelemetry | OpenTelemetry metrics/spans | | @prismakit/cli | Scaffold / validate / skills | | @prismakit/eslint-plugin | Repository-only ESLint rules |

Docs

• Documentation index
• Repository guide
• Cache
• Auto-compose
• Locks
• Rules

License

Apache-2.0