@prisma-next/contract 0.3.0-dev.14 → 0.3.0-dev.140

package/src/types.ts

@@ -1,16 +1,88 @@
 import type { OperationRegistry } from '@prisma-next/operations';
-import type { ContractIR } from './ir';
+import type { Contract } from './contract-types';
+import type { DomainModel } from './domain-types';
 
-export interface ContractBase {
+/**
+ * Unique symbol used as the key for branding types.
+ */
+export const $: unique symbol = Symbol('__prisma_next_brand__');
+
+/**
+ * A helper type to brand a given type with a unique identifier.
+ *
+ * @template TKey Text used as the brand key.
+ * @template TValue Optional value associated with the brand key. Defaults to `true`.
+ */
+export type Brand<TKey extends string | number | symbol, TValue = true> = {
+  [$]: {
+    [K in TKey]: TValue;
+  };
+};
+
+/**
+ * Context passed to type renderers during contract.d.ts generation.
+ */
+export interface RenderTypeContext {
+  /** The name of the CodecTypes type alias (typically 'CodecTypes') */
+  readonly codecTypesName: string;
+}
+
+/**
+ * Base type for storage contract hashes.
+ * Emitted contract.d.ts files use this with the hash value as a type parameter:
+ * `type StorageHash = StorageHashBase<'sha256:abc123...'>`
+ */
+export type StorageHashBase<THash extends string> = THash & Brand<'StorageHash'>;
+
+/**
+ * Base type for execution contract hashes.
+ * Emitted contract.d.ts files use this with the hash value as a type parameter:
+ * `type ExecutionHash = ExecutionHashBase<'sha256:def456...'>`
+ */
+export type ExecutionHashBase<THash extends string> = THash & Brand<'ExecutionHash'>;
+
+export function coreHash<const T extends string>(value: T): StorageHashBase<T> {
+  return value as StorageHashBase<T>;
+}
+
+/**
+ * Base type for profile contract hashes.
+ * Emitted contract.d.ts files use this with the hash value as a type parameter:
+ * `type ProfileHash = ProfileHashBase<'sha256:def456...'>`
+ */
+export type ProfileHashBase<THash extends string> = THash & Brand<'ProfileHash'>;
+
+export function profileHash<const T extends string>(value: T): ProfileHashBase<T> {
+  return value as ProfileHashBase<T>;
+}
+
+/**
+ * Base type for family-specific storage blocks.
+ * Family storage types (SqlStorage, MongoStorage, etc.) extend this to carry the
+ * storage hash alongside family-specific data (tables, collections, etc.).
+ */
+export interface StorageBase<THash extends string = string> {
+  readonly storageHash: StorageHashBase<THash>;
+}
+
+export interface ContractBase<
+  TStorageHash extends StorageHashBase<string> = StorageHashBase<string>,
+  TExecutionHash extends ExecutionHashBase<string> = ExecutionHashBase<string>,
+  TProfileHash extends ProfileHashBase<string> = ProfileHashBase<string>,
+> {
   readonly schemaVersion: string;
   readonly target: string;
   readonly targetFamily: string;
-  readonly coreHash: string;
-  readonly profileHash?: string;
+  readonly storageHash: TStorageHash;
+  readonly executionHash?: TExecutionHash | undefined;
+  readonly profileHash?: TProfileHash | undefined;
   readonly capabilities: Record<string, Record<string, boolean>>;
   readonly extensionPacks: Record<string, unknown>;
   readonly meta: Record<string, unknown>;
   readonly sources: Record<string, Source>;
+  readonly execution?: ExecutionSection;
+  readonly roots: Record<string, string>;
+  readonly models: Record<string, DomainModel>;
 }
 
 export interface FieldType {
@@ -20,6 +92,78 @@ export interface FieldType {
   readonly properties?: Record<string, FieldType>;
 }
 
+export type GeneratedValueSpec = {
+  readonly id: string;
+  readonly params?: Record<string, unknown>;
+};
+
+export type JsonPrimitive = string | number | boolean | null;
+
+export type JsonValue =
+  | JsonPrimitive
+  | { readonly [key: string]: JsonValue }
+  | readonly JsonValue[];
+
+export type TaggedBigInt = { readonly $type: 'bigint'; readonly value: string };
+
+export function isTaggedBigInt(value: unknown): value is TaggedBigInt {
+  return (
+    typeof value === 'object' &&
+    value !== null &&
+    (value as { $type?: unknown }).$type === 'bigint' &&
+    typeof (value as { value?: unknown }).value === 'string'
+  );
+}
+
+export function bigintJsonReplacer(_key: string, value: unknown): unknown {
+  if (typeof value === 'bigint') {
+    return { $type: 'bigint', value: value.toString() } satisfies TaggedBigInt;
+  }
+  return value;
+}
+
+export type TaggedRaw = { readonly $type: 'raw'; readonly value: JsonValue };
+
+export function isTaggedRaw(value: unknown): value is TaggedRaw {
+  return (
+    typeof value === 'object' &&
+    value !== null &&
+    (value as { $type?: unknown }).$type === 'raw' &&
+    'value' in (value as object)
+  );
+}
+
+export type TaggedLiteralValue = TaggedBigInt | TaggedRaw;
+
+export type ColumnDefaultLiteralValue = JsonValue | TaggedLiteralValue;
+
+export type ColumnDefaultLiteralInputValue = ColumnDefaultLiteralValue | bigint | Date;
+
+export type ColumnDefault =
+  | {
+      readonly kind: 'literal';
+      readonly value: ColumnDefaultLiteralInputValue;
+    }
+  | { readonly kind: 'function'; readonly expression: string };
+
+export type ExecutionMutationDefaultValue = {
+  readonly kind: 'generator';
+  readonly id: GeneratedValueSpec['id'];
+  readonly params?: Record<string, unknown>;
+};
+
+export type ExecutionMutationDefault = {
+  readonly ref: { readonly table: string; readonly column: string };
+  readonly onCreate?: ExecutionMutationDefaultValue;
+  readonly onUpdate?: ExecutionMutationDefaultValue;
+};
+
+export type ExecutionSection = {
+  readonly mutations: {
+    readonly defaults: ReadonlyArray<ExecutionMutationDefault>;
+  };
+};
+
 export interface Source {
   readonly readOnly: boolean;
   readonly projection: Record<string, FieldType>;
@@ -42,7 +186,7 @@ export type Expr =
 export interface DocCollection {
   readonly name: string;
   readonly id?: {
-    readonly strategy: 'auto' | 'client' | 'uuid' | 'cuid' | 'objectId';
+    readonly strategy: 'auto' | 'client' | 'uuid' | 'objectId';
   };
   readonly fields: Record<string, FieldType>;
   readonly indexes?: ReadonlyArray<DocIndex>;
@@ -55,7 +199,11 @@ export interface DocumentStorage {
   };
 }
 
-export interface DocumentContract extends ContractBase {
+export interface DocumentContract<
+  TStorageHash extends StorageHashBase<string> = StorageHashBase<string>,
+  TExecutionHash extends ExecutionHashBase<string> = ExecutionHashBase<string>,
+  TProfileHash extends ProfileHashBase<string> = ProfileHashBase<string>,
+> extends ContractBase<TStorageHash, TExecutionHash, TProfileHash> {
   // Accept string to work with JSON imports; runtime validation ensures 'document'
   readonly targetFamily: string;
   readonly storage: DocumentStorage;
@@ -68,7 +216,7 @@ export interface ParamDescriptor {
   readonly codecId?: string;
   readonly nativeType?: string;
   readonly nullable?: boolean;
-  readonly source: 'dsl' | 'raw';
+  readonly source: 'dsl' | 'raw' | 'lane';
   readonly refs?: { table: string; column: string };
 }
 
@@ -85,7 +233,7 @@ export interface PlanRefs {
 export interface PlanMeta {
   readonly target: string;
   readonly targetFamily?: string;
-  readonly coreHash: string;
+  readonly storageHash: string;
   readonly profileHash?: string;
   readonly lane: string;
   readonly annotations?: {
@@ -151,7 +299,7 @@ export function isDocumentContract(contract: unknown): contract is DocumentContr
  * Represents the current contract identity for a database.
  */
 export interface ContractMarkerRecord {
-  readonly coreHash: string;
+  readonly storageHash: string;
   readonly profileHash: string;
   readonly contractJson: unknown | null;
   readonly canonicalVersion: number | null;
@@ -180,6 +328,50 @@ export interface ValidationContext {
   readonly codecTypeImports?: ReadonlyArray<TypesImportSpec>;
   readonly operationTypeImports?: ReadonlyArray<TypesImportSpec>;
   readonly extensionIds?: ReadonlyArray<string>;
+  /**
+   * Parameterized codec descriptors collected from adapters and extensions.
+   * Map of codecId → descriptor for quick lookup during type generation.
+   */
+  readonly parameterizedCodecs?: Map<string, ParameterizedCodecDescriptor>;
+}
+
+/**
+ * Context for rendering parameterized types during contract.d.ts generation.
+ * Passed to type renderers so they can reference CodecTypes by name.
+ */
+export interface TypeRenderContext {
+  readonly codecTypesName: string;
+}
+
+/**
+ * A normalized type renderer for parameterized codecs.
+ * This is the interface expected by TargetFamilyHook.generateContractTypes.
+ */
+export interface TypeRenderEntry {
+  readonly codecId: string;
+  readonly render: (params: Record<string, unknown>, ctx: TypeRenderContext) => string;
+}
+
+/**
+ * Additional options for generateContractTypes.
+ */
+export interface GenerateContractTypesOptions {
+  /**
+   * Normalized parameterized type renderers, keyed by codecId.
+   * When a column has typeParams and a renderer exists for its codecId,
+   * the renderer is called to produce the TypeScript type expression.
+   */
+  readonly parameterizedRenderers?: Map<string, TypeRenderEntry>;
+  /**
+   * Type imports for parameterized codecs.
+   * These are merged with codec and operation type imports in contract.d.ts.
+   */
+  readonly parameterizedTypeImports?: ReadonlyArray<TypesImportSpec>;
+  /**
+   * Query operation type imports for the query builder.
+   * Flat operation signatures keyed by operation name, emitted as standalone QueryOperationTypes.
+   */
+  readonly queryOperationTypeImports?: ReadonlyArray<TypesImportSpec>;
 }
 
 /**
@@ -191,52 +383,117 @@ export interface TargetFamilyHook {
 
   /**
    * Validates that all type IDs in the contract come from referenced extension packs.
-   * @param ir - Contract IR to validate
+   * @param contract - Contract to validate
    * @param ctx - Validation context with operation registry and extension IDs
    */
-  validateTypes(ir: ContractIR, ctx: ValidationContext): void;
+  validateTypes(contract: Contract, ctx: ValidationContext): void;
 
   /**
    * Validates family-specific contract structure.
-   * @param ir - Contract IR to validate
+   * @param contract - Contract to validate
    */
-  validateStructure(ir: ContractIR): void;
+  validateStructure(contract: Contract): void;
 
   /**
    * Generates contract.d.ts file content.
-   * @param ir - Contract IR
+   * @param contract - Contract
    * @param codecTypeImports - Array of codec type import specs
    * @param operationTypeImports - Array of operation type import specs
+   * @param hashes - Contract hash values (storageHash, executionHash, profileHash)
+   * @param options - Additional options including parameterized type renderers
    * @returns Generated TypeScript type definitions as string
    */
   generateContractTypes(
-    ir: ContractIR,
+    contract: Contract,
     codecTypeImports: ReadonlyArray<TypesImportSpec>,
     operationTypeImports: ReadonlyArray<TypesImportSpec>,
+    hashes: {
+      readonly storageHash: string;
+      readonly executionHash?: string;
+      readonly profileHash: string;
+    },
+    options?: GenerateContractTypesOptions,
   ): string;
 }
 
-// Extension pack manifest types - moved from @prisma-next/core-control-plane to shared location
-export type ArgSpecManifest =
-  | { readonly kind: 'typeId'; readonly type: string }
-  | { readonly kind: 'param' }
-  | { readonly kind: 'literal' };
+// ============================================================================
+// Parameterized Codec Descriptor Types
+// ============================================================================
+//
+// Types for codecs that support type parameters (e.g., Vector<1536>, Decimal<2>).
+// These enable precise TypeScript types for parameterized columns without
+// coupling the SQL family emitter to specific adapter codec IDs.
+//
+// ============================================================================
 
-export type ReturnSpecManifest =
-  | { readonly kind: 'typeId'; readonly type: string }
-  | { readonly kind: 'builtin'; readonly type: 'number' | 'boolean' | 'string' };
+/**
+ * Declarative type renderer that produces a TypeScript type expression.
+ *
+ * Renderers can be:
+ * - A template string with `{{paramName}}` placeholders (e.g., `Vector<{{length}}>`)
+ * - A function that receives typeParams and context and returns a type expression
+ *
+ * **Prefer template strings** for most cases:
+ * - Templates are JSON-serializable (safe for pack-ref metadata)
+ * - Templates can be statically analyzed by tooling
+ *
+ * Function renderers are allowed but have tradeoffs:
+ * - Require runtime execution during emission (the emitter runs code)
+ * - Not JSON-serializable (can't be stored in contract.json)
+ * - The emitted artifacts (contract.json, contract.d.ts) still contain no
+ *   executable code - this constraint applies to outputs, not the emission process
+ */
+export type TypeRenderer =
+  | string
+  | ((params: Record<string, unknown>, ctx: RenderTypeContext) => string);
 
-export interface LoweringSpecManifest {
-  readonly targetFamily: 'sql';
-  readonly strategy: 'infix' | 'function';
-  readonly template: string;
-}
+/**
+ * Descriptor for a codec that supports type parameters.
+ *
+ * Parameterized codecs allow columns to carry additional metadata (typeParams)
+ * that affects the generated TypeScript types. For example:
+ * - A vector codec can use `{ length: 1536 }` to generate `Vector<1536>`
+ * - A decimal codec can use `{ precision: 10, scale: 2 }` to generate `Decimal<10, 2>`
+ *
+ * The SQL family emitter uses these descriptors to generate precise types
+ * without hard-coding knowledge of specific codec IDs.
+ *
+ * @example
+ * ```typescript
+ * const vectorCodecDescriptor: ParameterizedCodecDescriptor = {
+ *   codecId: 'pg/vector@1',
+ *   outputTypeRenderer: 'Vector<{{length}}>',
+ *   // Optional: paramsSchema for runtime validation
+ * };
+ * ```
+ */
+export interface ParameterizedCodecDescriptor {
+  /** The codec ID this descriptor applies to (e.g., 'pg/vector@1') */
+  readonly codecId: string;
+
+  /**
+   * Renderer for the output (read) type.
+   * Can be a template string or function.
+   *
+   * This is the primary renderer used by SQL emission to generate
+   * model field types in contract.d.ts.
+   */
+  readonly outputTypeRenderer: TypeRenderer;
 
-export interface OperationManifest {
-  readonly for: string;
-  readonly method: string;
-  readonly args: ReadonlyArray<ArgSpecManifest>;
-  readonly returns: ReturnSpecManifest;
-  readonly lowering: LoweringSpecManifest;
-  readonly capabilities?: ReadonlyArray<string>;
+  /**
+   * Optional renderer for the input (write) type.
+   * If not provided, outputTypeRenderer is used for both.
+   *
+   * **Reserved for future use**: Currently, SQL emission only uses
+   * outputTypeRenderer. This field is defined for future support of
+   * asymmetric codecs where input and output types differ (e.g., a
+   * codec that accepts `string | number` but always returns `number`).
+   */
+  readonly inputTypeRenderer?: TypeRenderer;
+
+  /**
+   * Optional import spec for types used by this codec's renderers.
+   * The emitter will add this import to contract.d.ts.
+   */
+  readonly typesImport?: TypesImportSpec;
 }

package/src/validate-contract.ts

@@ -0,0 +1,93 @@
+import { type } from 'arktype';
+import type { Contract } from './contract-types';
+import type { DomainContractShape, DomainValidationResult } from './validate-domain';
+import { validateContractDomain } from './validate-domain';
+
+/**
+ * Family-provided storage validator.
+ * SQL validates tables/columns/FKs; Mongo validates collections/embedding.
+ */
+export type StorageValidator = (contract: Contract) => void;
+
+export interface ValidateContractResult {
+  readonly warnings: string[];
+}
+
+const ContractSchema = type({
+  target: 'string',
+  targetFamily: 'string',
+  roots: 'Record<string, string>',
+  models: 'Record<string, unknown>',
+  storage: 'Record<string, unknown>',
+  capabilities: 'Record<string, Record<string, boolean>>',
+  extensionPacks: 'Record<string, unknown>',
+  meta: 'Record<string, unknown>',
+  'execution?': {
+    'executionHash?': 'string',
+    mutations: {
+      defaults: 'unknown[]',
+    },
+  },
+  'profileHash?': 'string',
+});
+
+function stripPersistenceFields(raw: Record<string, unknown>): Record<string, unknown> {
+  const { schemaVersion: _, sources: _s, ...rest } = raw;
+  return rest;
+}
+
+function extractDomainShape(contract: Contract): DomainContractShape {
+  return {
+    roots: contract.roots,
+    models: contract.models,
+  };
+}
+
+/**
+ * Framework-level contract validation (ADR 182).
+ *
+ * Three-pass validation:
+ * 1. **Structural validation** (arktype): verifies required fields exist with
+ *    correct base types.
+ * 2. **Domain validation** (framework-owned): roots, relation targets,
+ *    variant/base consistency, discriminators, ownership, orphans.
+ * 3. **Storage validation** (family-provided): SQL validates tables/columns/FKs;
+ *    Mongo validates collections/embedding.
+ *
+ * JSON persistence fields (`schemaVersion`, `sources`) are stripped before
+ * validation — they are not part of the in-memory contract representation.
+ *
+ * @template TContract  The fully-typed contract type (preserves literal types).
+ * @param value           Raw contract value (e.g. parsed from JSON).
+ * @param storageValidator  Family-specific storage validation function.
+ * @returns The validated contract with full literal types.
+ */
+export function validateContract<TContract extends Contract>(
+  value: unknown,
+  storageValidator: StorageValidator,
+): TContract & ValidateContractResult {
+  if (typeof value !== 'object' || value === null) {
+    throw new Error('Contract must be a non-null object');
+  }
+
+  const stripped = stripPersistenceFields(value as Record<string, unknown>);
+
+  const parsed = ContractSchema(stripped);
+  if (parsed instanceof type.errors) {
+    throw new Error(`Invalid contract structure: ${parsed.summary}`);
+  }
+
+  // Arktype verified the structural shape; Contract adds branded hash types and
+  // ContractModel generics that can't be expressed in the schema.
+  const contract = parsed as unknown as Contract;
+
+  const domainResult: DomainValidationResult = validateContractDomain(extractDomainShape(contract));
+
+  storageValidator(contract);
+
+  // TContract narrows Contract with literal types from the caller's contract.d.ts;
+  // the runtime object is the same — the cast preserves the caller's type parameter.
+  return Object.assign(contract as unknown as TContract, {
+    warnings: domainResult.warnings,
+  });
+}