@prisma-next/contract 0.3.0-pr.99.6 → 0.3.0

package/src/types.ts

@@ -1,17 +1,60 @@
-import type { OperationRegistry } from '@prisma-next/operations';
-import type { RenderTypeContext } from './framework-components';
-import type { ContractIR } from './ir';
+/**
+ * Unique symbol used as the key for branding types.
+ */
+export const $: unique symbol = Symbol('__prisma_next_brand__');
 
-export interface ContractBase {
-  readonly schemaVersion: string;
-  readonly target: string;
-  readonly targetFamily: string;
-  readonly coreHash: string;
-  readonly profileHash?: string;
-  readonly capabilities: Record<string, Record<string, boolean>>;
-  readonly extensionPacks: Record<string, unknown>;
-  readonly meta: Record<string, unknown>;
-  readonly sources: Record<string, Source>;
+/**
+ * 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;
+  };
+};
+
+/**
+ * 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 executionHash<const T extends string>(value: T): ExecutionHashBase<T> {
+  return value as ExecutionHashBase<T>;
+}
+
+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 FieldType {
@@ -21,6 +64,48 @@ 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 ColumnDefaultLiteralValue = JsonValue;
+
+export type ColumnDefaultLiteralInputValue = ColumnDefaultLiteralValue | 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<THash extends string = string> = {
+  readonly executionHash: ExecutionHashBase<THash>;
+  readonly mutations: {
+    readonly defaults: ReadonlyArray<ExecutionMutationDefault>;
+  };
+};
+
 export interface Source {
   readonly readOnly: boolean;
   readonly projection: Record<string, FieldType>;
@@ -43,25 +128,13 @@ 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>;
   readonly readOnly?: boolean;
 }
 
-export interface DocumentStorage {
-  readonly document: {
-    readonly collections: Record<string, DocCollection>;
-  };
-}
-
-export interface DocumentContract extends ContractBase {
-  // Accept string to work with JSON imports; runtime validation ensures 'document'
-  readonly targetFamily: string;
-  readonly storage: DocumentStorage;
-}
-
 // Plan types - target-family agnostic execution types
 export interface ParamDescriptor {
   readonly index?: number;
@@ -69,7 +142,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 };
 }
 
@@ -86,7 +159,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?: {
@@ -135,24 +208,12 @@ export interface ExecutionPlan<Row = unknown, Ast = unknown> {
 export type ResultType<P> =
   P extends ExecutionPlan<infer R, unknown> ? R : P extends { readonly _Row?: infer R } ? R : never;
 
-/**
- * Type guard to check if a contract is a Document contract
- */
-export function isDocumentContract(contract: unknown): contract is DocumentContract {
-  return (
-    typeof contract === 'object' &&
-    contract !== null &&
-    'targetFamily' in contract &&
-    contract.targetFamily === 'document'
-  );
-}
-
 /**
  * Contract marker record stored in the database.
  * 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;
@@ -160,210 +221,3 @@ export interface ContractMarkerRecord {
   readonly appTag: string | null;
   readonly meta: Record<string, unknown>;
 }
-
-// Emitter types - moved from @prisma-next/emitter to shared location
-/**
- * Specifies how to import TypeScript types from a package.
- * Used in extension pack manifests to declare codec and operation type imports.
- */
-export interface TypesImportSpec {
-  readonly package: string;
-  readonly named: string;
-  readonly alias: string;
-}
-
-/**
- * Validation context passed to TargetFamilyHook.validateTypes().
- * Contains pre-assembled operation registry, type imports, and extension IDs.
- */
-export interface ValidationContext {
-  readonly operationRegistry?: OperationRegistry;
-  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>;
-}
-
-/**
- * SPI interface for target family hooks that extend emission behavior.
- * Implemented by family-specific emitter hooks (e.g., SQL family).
- */
-export interface TargetFamilyHook {
-  readonly id: string;
-
-  /**
-   * Validates that all type IDs in the contract come from referenced extension packs.
-   * @param ir - Contract IR to validate
-   * @param ctx - Validation context with operation registry and extension IDs
-   */
-  validateTypes(ir: ContractIR, ctx: ValidationContext): void;
-
-  /**
-   * Validates family-specific contract structure.
-   * @param ir - Contract IR to validate
-   */
-  validateStructure(ir: ContractIR): void;
-
-  /**
-   * Generates contract.d.ts file content.
-   * @param ir - Contract IR
-   * @param codecTypeImports - Array of codec type import specs
-   * @param operationTypeImports - Array of operation type import specs
-   * @param options - Additional options including parameterized type renderers
-   * @returns Generated TypeScript type definitions as string
-   */
-  generateContractTypes(
-    ir: ContractIR,
-    codecTypeImports: ReadonlyArray<TypesImportSpec>,
-    operationTypeImports: ReadonlyArray<TypesImportSpec>,
-    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' };
-
-export type ReturnSpecManifest =
-  | { readonly kind: 'typeId'; readonly type: string }
-  | { readonly kind: 'builtin'; readonly type: 'number' | 'boolean' | 'string' };
-
-export interface LoweringSpecManifest {
-  readonly targetFamily: 'sql';
-  readonly strategy: 'infix' | 'function';
-  readonly template: string;
-}
-
-export interface OperationManifest {
-  readonly for: string;
-  readonly method: string;
-  readonly args: ReadonlyArray<ArgSpecManifest>;
-  readonly returns: ReturnSpecManifest;
-  readonly lowering: LoweringSpecManifest;
-  readonly capabilities?: ReadonlyArray<string>;
-}
-
-// ============================================================================
-// 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.
-//
-// ============================================================================
-
-// Re-export RenderTypeContext so it's available alongside TypeRenderer
-export type { RenderTypeContext };
-
-/**
- * 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);
-
-/**
- * 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;
-
-  /**
-   * 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,101 @@
+import { type } from 'arktype';
+import type { Contract } from './contract-types';
+import type { DomainContractShape } from './validate-domain';
+import { validateContractDomain } from './validate-domain';
+
+export type ContractValidationPhase = 'structural' | 'domain' | 'storage';
+
+export class ContractValidationError extends Error {
+  readonly code = 'CONTRACT.VALIDATION_FAILED';
+  readonly phase: ContractValidationPhase;
+
+  constructor(message: string, phase: ContractValidationPhase) {
+    super(message);
+    this.name = 'ContractValidationError';
+    this.phase = phase;
+  }
+}
+
+/**
+ * Family-provided storage validator.
+ * SQL validates tables/columns/FKs; Mongo validates collections/embedding.
+ */
+export type StorageValidator = (contract: Contract) => void;
+
+const ContractSchema = type({
+  target: 'string',
+  targetFamily: 'string',
+  roots: 'Record<string, string>',
+  models: 'Record<string, unknown>',
+  'valueObjects?': '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: _, _generated: _g, ...rest } = raw;
+  return rest;
+}
+
+function extractDomainShape(contract: Contract): DomainContractShape {
+  return {
+    roots: contract.roots,
+    models: contract.models,
+    ...(contract.valueObjects ? { valueObjects: contract.valueObjects } : {}),
+  };
+}
+
+/**
+ * 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`, `_generated`) 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 {
+  if (typeof value !== 'object' || value === null) {
+    throw new ContractValidationError('Contract must be a non-null object', 'structural');
+  }
+
+  const stripped = stripPersistenceFields(value as Record<string, unknown>);
+
+  const parsed = ContractSchema(stripped);
+  if (parsed instanceof type.errors) {
+    throw new ContractValidationError(
+      `Invalid contract structure: ${parsed.summary}`,
+      'structural',
+    );
+  }
+
+  const contract = parsed as unknown as Contract;
+
+  validateContractDomain(extractDomainShape(contract));
+
+  storageValidator(contract);
+
+  return contract as unknown as TContract;
+}