@prisma-idb/family-idb

The IndexedDB family for Prisma 8, used at build time. It reads your Prisma schema into an IndexedDB contract, plugs IndexedDB into the prisma CLI, and provides the prisma-idb CLI for migrations.

npm install --save-dev @prisma-idb/family-idb

The prisma-idb CLI

IndexedDB only exists in the browser, so three migration jobs need their own commands:

| Command | Does | | ------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------ | | prisma-idb migration plan | Plans the next migration from the newest one on disk. Warns if it deletes data. | | prisma-idb migration contract-space | Bundles the migrations into a module the browser imports. | | prisma-idb migration preflight | Replays migrations in memory, verifies the schema against the head snapshot, and checks that the emitted contract is the head. |

All three read prisma.config.ts. See Migrations.

Entry points

| Import | Contains | | ------------------------------------- | -------------------------------------------------------------------- | | @prisma-idb/family-idb/control | The family descriptor for prisma.config.ts. | | @prisma-idb/family-idb/config-types | defineConfig for prisma.config.ts. | | @prisma-idb/family-idb/contract-psl | prismaIdbContract(path, { projection }): reads a .prisma schema. | | @prisma-idb/family-idb/contract-ts | defineContract(): write a contract in TypeScript instead. | | @prisma-idb/family-idb/cli | The prisma-idb commands, for embedding in another CLI. |

Contract authoring

Author a contract in PSL with prismaIdbContract(path, options?), or in TypeScript with defineContract(input, options?). Both surfaces lower into one internal IdbContractDefinition and use the same validation and hash builder. Equivalent definitions produce the same storage, profile, and execution hashes.

For Prisma VS Code extension hints, put // use prisma-8 on the first line of the .prisma file, before other comments. This selects the Prisma 8 language server, which uses the project's local prisma CLI and prisma.config.ts to discover IDB scalar types, attribute signatures, hover descriptions, and diagnostics. Without the directive, the extension uses the legacy server. Run Prisma: Restart Language Server after changing the directive or rebuilding workspace packages. See Editor Setup.

TypeScript models use a defaults map for create-time literals and helpers: autoincrement(), now(), uuidv4(), uuidv7(), cuid2(), and updatedAt(). Import the helpers from @prisma-idb/family-idb/contract-ts. The older fieldDefaults map only supplies values for the setDefault referential action.

Both surfaces index each foreign-key field by default. TypeScript relations can set index: false to opt out. Existing TypeScript contracts may get a new storageHash and need an index migration. See Adopt Foreign-Key Indexes.

Invalid shared definitions throw IdbContractError from the TypeScript entry point. Its diagnostics array lists IDB_* codes, messages, and definition paths. PSL reports the corresponding diagnostics with source spans. See Contract Authoring for attribute mappings, defaults, indexes, and diagnostic codes.

Documentation

• Quick Start
• Schema & Config
• Migrations

License

MIT