Internal package. This package is an implementation detail of prisma-next and is published only to support its runtime. Its API is unstable and may change without notice. Do not depend on this package directly; install prisma-next instead.

Core contract data types and JSON schemas for Prisma Next.

Overview

This package provides the foundational type definitions for Prisma Next data contracts:

Contract data types: The canonical description of an application's data model and storage layout (ContractBase, DocumentContract, Source, FieldType)
Plan types: Target-family-agnostic execution plan types (ExecutionPlan, PlanMeta, ParamDescriptor)
Hash types: Branded hash types for storage, execution, and profile hashing (StorageHashBase, ExecutionHashBase, ProfileHashBase)
JSON Schemas: Validation schemas for contract files
Type guards: Runtime type guards for narrowing contract types (isDocumentContract)

This package is a foundation-layer leaf — it has no framework-domain dependencies and is consumed by all layers above it.

Usage

import type {
  Contract,
  ContractMarkerRecord,
  DocumentContract,
  ExecutionPlan,
  PlanMeta,
} from '@prisma-next/contract/types';
import { isDocumentContract, coreHash, profileHash } from '@prisma-next/contract/types';

if (isDocumentContract(contract)) {
  const collections = contract.storage.document.collections;
}

JSON Schema Validation

Reference the appropriate JSON schema in your contract.json files to enable IDE validation:

{
  "$schema": "node_modules/@prisma-next/contract/schemas/data-contract-document-v1.json",
  "schemaVersion": "1",
  "target": "mongodb",
  "targetFamily": "document",
  "storageHash": "sha256:..."
}

For SQL contracts, use @prisma-next/sql-contract-ts/schema-sql instead.

Exports

./types: Contract data types, hash types, plan types, type guards
./hashing: Contract hashing utilities
./testing: Test helpers for creating contract fixtures
./validate-contract: Contract structure validation
./validate-domain: Domain model validation

Type System

Plan Types

ParamDescriptor describes a single parameter in an execution plan:

source: Origin of the parameter ('dsl', 'raw', or 'lane')
index (optional): 1-based position into plan.params
name (optional): Parameter name for codec resolution
codecId, nativeType, nullable (optional): Type metadata from contract
refs (optional): { table, column } when the param is used against a known column

Column Defaults

When adding column defaults, re-emit the contract and verify the emitted JSON includes the full default payload.
Keep nullable: false explicit for columns with defaults in emitted contracts.
Add the corresponding defaults.* capability when using function defaults like autoincrement() or now().

Dependencies

@prisma-next/utils: Shared utility functions

FAQs

What is @prisma-next/contract?

Is @prisma-next/contract popular?

Is @prisma-next/contract well maintained?

Package last updated on 24 Apr 2026

Did you know?

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

@prisma-next/contract