@prisma-next/sql-contract-emitter

@prisma-next/sql-contract-emitter

SQL emitter hook for Prisma Next.

Overview

This package provides the SQL-specific emitter hook implementation for the Prisma Next emitter. It validates SQL contracts and generates TypeScript type definitions for SQL contracts. It's part of the SQL tooling layer (migration plane) and implements the TargetFamilyHook interface.

Responsibilities

• Contract Validation: Validates SQL contract structure and types

  • validateTypes(): Validates type IDs against referenced extensions (receives ValidationContext with extensionIds)
  • validateStructure(): Validates SQL-specific logical consistency (foreign key references, model-to-table mappings, constraint consistency). Note: Structural properties (required fields, types) are validated by Arktype schema validation - this function focuses on logical validation that schema validators can't perform.

• Type Generation: Generates TypeScript type definitions for SQL contracts

  • generateContractTypes(): Generates contract.d.ts file content (receives a codecTypeImports array)

Dependencies

• Depends on:
  • @prisma-next/contract (contract IR, TargetFamilyHook SPI, ValidationContext, TypesImportSpec - types moved to shared plane)
  • @prisma-next/emitter (emitter core, EmitOptions, EmitResult)
  • @prisma-next/sql-contract (SQL contract type definitions)
• Depended on by:
  • @prisma-next/cli (uses for contract emission)
  • @prisma-next/integration-tests (uses for contract emission tests)

Architecture

flowchart TD
    subgraph "Framework Tooling Layer"
        EMITTER[@prisma-next/emitter]
        CLI[@prisma-next/cli]
    end

    subgraph "SQL Tooling Layer"
        SQL_EMITTER[@prisma-next/sql-contract-emitter]
    end

    subgraph "SQL Core Layer (Shared Plane)"
        CT[@prisma-next/sql-contract]
    end

    EMITTER --> SQL_EMITTER
    CT --> SQL_EMITTER
    SQL_EMITTER --> CLI

Usage

Using the SQL Emitter Hook

import { emit } from '@prisma-next/emitter';
import { sqlEmission } from '@prisma-next/sql-contract-emitter';

const result = await emit(contractIR, options, sqlEmission);

// result.contractDts contains generated TypeScript types
// result.contractJson contains validated contract JSON

Related Documentation

• [Package Layering](../../../../docs/architecture docs/Package-Layering.md)
• [ADR 140 - Package Layering & Target-Family Namespacing](../../../../docs/architecture docs/adrs/ADR 140 - Package Layering & Target-Family Namespacing.md)