Prisma IndexedDB Client Generator

A Prisma generator that creates a familiar, type-safe client for IndexedDB with optional bidirectional synchronization to a remote server. Define your data model once in Prisma schema, and get both a local-first IndexedDB client and a complete sync engine built for conflict resolution and authorization.

📖 Documentation • 🚀 Live Demo • 📦 npm Package • 🏗️ GitHub Repository

Features

• Prisma-like API: Use the syntax you already know. CRUD operations feel exactly like Prisma Client.
• Type Safety: Fully typed operations generated directly from your Prisma schema.
• Local-First: All data lives in IndexedDB. Works offline, syncs when ready.
• Optional Sync Engine: Bidirectional sync with authoritative DAG-based conflict resolution.
• Authorization & Ownership: Built-in ownership invariants ensure users can only modify their data.
• Outbox Pattern: Reliable push operations with automatic retry and batch support.
• Changelog Materialization: Efficient pull operations that materialize server state for clients.

Quick Start

Get Prisma IDB up and running in just a few steps.

1. Install Dependencies

pnpm add idb
pnpm add @prisma-idb/idb-client-generator --save-dev

Optionally, for auto-generated IDs:

pnpm add @paralleldrive/cuid2 uuid

2. Configure Generator

Add the generator to your prisma/schema.prisma:

generator prismaIDB {
  provider = "idb-client-generator"
  output   = "./prisma-idb"
  
  // Optional: Enable sync engine
  outboxSync = true
  rootModel  = "User"
  exclude    = ["Changelog", "Session"]
}

3. Define Your Schema

model User {
  id    String  @id @default(cuid())  // Client-generated IDs required for sync
  name  String
  email String  @unique
  
  todos Todo[]
}

model Todo {
  id    String  @id @default(cuid())
  title String
  done  Boolean @default(false)
  
  userId String
  user   User    @relation(fields: [userId], references: [id], onDelete: Cascade)
}

4. Generate & Use

Generate the client:

pnpm exec prisma generate

Use it in your code:

import { PrismaIDBClient } from "./prisma-idb";

const client = await PrismaIDBClient.createClient();

// Create
await client.user.create({
  data: { name: "Alice", email: "alice@example.com" }
});

// Read
const todos = await client.todo.findMany({
  where: { userId: userId, done: false }
});

// Update
await client.todo.update({
  where: { id: todoId },
  data: { done: true }
});

// Delete
await client.todo.delete({
  where: { id: todoId }
});

Installation

pnpm add @prisma-idb/idb-client-generator --save-dev

Development Setup

This project uses pnpm workspaces and includes a devcontainer configuration for a consistent development environment.

Using DevContainer (Recommended)

1. Open the project in VS Code
2. Install the "Dev Containers" extension if you haven't already
3. Click "Reopen in Container" when prompted, or use the command palette: Dev Containers: Reopen in Container
4. The container will automatically install dependencies using pnpm

Local Development

If you prefer to develop locally:

1. Install pnpm: corepack enable (Node.js 16.13+) or npm install -g pnpm
2. Install dependencies: pnpm install
3. Run development server: pnpm dev
4. Run tests: pnpm test

Usage

The API mimics Prisma Client's API for ease of use:

create

Insert a new record:

idbClient.modelName.create({
  data: {
    field: value,
  },
});

findMany

Retrieve all records:

idbClient.modelName.findMany();

findUnique

Retrieve a single record by unique key:

idbClient.modelName.findUnique({
  where: { key: value },
});

update

Update a record:

idbClient.modelName.update({
  where: { key: value },
  data: { key: newValue },
});

delete

Delete a record:

idbClient.modelName.delete({
  where: { key: value },
});

Resources

• 📖 Full Documentation - Complete API reference and guides
• 🚀 Live Kanban Demo - See the sync engine in action
• 📦 npm Package - Install from npm
• 🏗️ GitHub Repository - Source code and issue tracking
• Example App Source - Real-world implementation reference

Contributing

We welcome contributions! Please see our CONTRIBUTING.md for guidelines on how to contribute to this project.

Security

If you discover a security vulnerability, please follow our SECURITY.md guidelines on reporting issues responsibly.

License

This project is licensed under the GNU Affero General Public License v3.0. See the LICENSE file for more details.

Disclaimer

Prisma is a trademark of Prisma.

Prisma IDB is an independent open-source project and is not affiliated with, endorsed by, or sponsored by Prisma. This library is a generator built on top of Prisma to extend its functionality.