@prisma-next/core-control-plane 0.1.0-dev.3 → 0.1.0-dev.30

package/dist/exports/types.d.ts

@@ -1,185 +1,263 @@
+import { TargetBoundComponentDescriptor, FamilyInstance, DriverInstance, FamilyDescriptor, TargetInstance, TargetDescriptor, AdapterInstance, AdapterDescriptor, DriverDescriptor, ExtensionInstance, ExtensionDescriptor } from '@prisma-next/contract/framework-components';
 import { ContractIR } from '@prisma-next/contract/ir';
-import { ExtensionPackManifest } from '@prisma-next/contract/pack-manifest-types';
-import { TargetFamilyHook } from '@prisma-next/contract/types';
+import { ContractMarkerRecord, TargetFamilyHook } from '@prisma-next/contract/types';
+import { Result } from '@prisma-next/utils/result';
 import { CoreSchemaView } from './schema-view.js';
 
 /**
- * Base interface for control-plane family instances.
- * Families extend this with domain-specific methods.
+ * Core migration types for the framework control plane.
  *
- * @template TFamilyId - The family ID (e.g., 'sql', 'document')
+ * These are family-agnostic, display-oriented types that provide a stable
+ * vocabulary for CLI commands to work with migration planners and runners
+ * without importing family-specific types.
+ *
+ * Family-specific types (e.g., SqlMigrationPlan) extend these base types
+ * with additional fields for execution (precheck SQL, execute SQL, etc.).
+ */
+
+/**
+ * Migration operation classes define the safety level of an operation.
+ * - 'additive': Adds new structures without modifying existing ones (safe)
+ * - 'widening': Relaxes constraints or expands types (generally safe)
+ * - 'destructive': Removes or alters existing structures (potentially unsafe)
  */
-interface ControlFamilyInstance<TFamilyId extends string = string> {
-    readonly familyId: TFamilyId;
+type MigrationOperationClass = 'additive' | 'widening' | 'destructive';
+/**
+ * Policy defining which operation classes are allowed during a migration.
+ */
+interface MigrationOperationPolicy {
+    readonly allowedOperationClasses: readonly MigrationOperationClass[];
 }
 /**
- * Base interface for control-plane target instances.
- *
- * @template TFamilyId - The family ID (e.g., 'sql', 'document')
- * @template TTargetId - The target ID (e.g., 'postgres', 'mysql')
+ * A single migration operation for display purposes.
+ * Contains only the fields needed for CLI output (tree view, JSON envelope).
  */
-interface ControlTargetInstance<TFamilyId extends string = string, TTargetId extends string = string> {
-    readonly familyId: TFamilyId;
-    readonly targetId: TTargetId;
+interface MigrationPlanOperation {
+    /** Unique identifier for this operation (e.g., "table.users.create"). */
+    readonly id: string;
+    /** Human-readable label for display in UI/CLI (e.g., "Create table users"). */
+    readonly label: string;
+    /** The class of operation (additive, widening, destructive). */
+    readonly operationClass: MigrationOperationClass;
 }
 /**
- * Base interface for control-plane adapter instances.
- * Families extend this with family-specific adapter interfaces.
- *
- * @template TFamilyId - The family ID (e.g., 'sql', 'document')
- * @template TTargetId - The target ID (e.g., 'postgres', 'mysql')
+ * A migration plan for display purposes.
+ * Contains only the fields needed for CLI output (summary, JSON envelope).
  */
-interface ControlAdapterInstance<TFamilyId extends string = string, TTargetId extends string = string> {
-    readonly familyId: TFamilyId;
-    readonly targetId: TTargetId;
+interface MigrationPlan {
+    /** The target ID this plan is for (e.g., 'postgres'). */
+    readonly targetId: string;
+    /** Destination contract identity that the plan intends to reach. */
+    readonly destination: {
+        readonly coreHash: string;
+        readonly profileHash?: string;
+    };
+    /** Ordered list of operations to execute. */
+    readonly operations: readonly MigrationPlanOperation[];
 }
 /**
- * Base interface for control-plane driver instances.
- * Replaces ControlPlaneDriver with plane-first naming.
- *
- * @template TTargetId - The target ID (e.g., 'postgres', 'mysql')
+ * A conflict detected during migration planning.
  */
-interface ControlDriverInstance<TTargetId extends string = string> {
-    readonly targetId?: TTargetId;
-    query<Row = Record<string, unknown>>(sql: string, params?: readonly unknown[]): Promise<{
-        readonly rows: Row[];
-    }>;
-    close(): Promise<void>;
+interface MigrationPlannerConflict {
+    /** Kind of conflict (e.g., 'typeMismatch', 'nullabilityConflict'). */
+    readonly kind: string;
+    /** Human-readable summary of the conflict. */
+    readonly summary: string;
+    /** Optional explanation of why this conflict occurred. */
+    readonly why?: string;
 }
 /**
- * Base interface for control-plane extension instances.
- *
- * @template TFamilyId - The family ID (e.g., 'sql', 'document')
- * @template TTargetId - The target ID (e.g., 'postgres', 'mysql')
+ * Successful planner result with the migration plan.
  */
-interface ControlExtensionInstance<TFamilyId extends string = string, TTargetId extends string = string> {
-    readonly familyId: TFamilyId;
-    readonly targetId: TTargetId;
+interface MigrationPlannerSuccessResult {
+    readonly kind: 'success';
+    readonly plan: MigrationPlan;
 }
 /**
- * Descriptor for a control-plane family (e.g., SQL).
- * Provides the family hook and factory method.
- *
- * @template TFamilyId - The family ID (e.g., 'sql', 'document')
- * @template TFamilyInstance - The family instance type
+ * Failed planner result with the list of conflicts.
  */
-interface ControlFamilyDescriptor<TFamilyId extends string, TFamilyInstance extends ControlFamilyInstance<TFamilyId> = ControlFamilyInstance<TFamilyId>> {
-    readonly kind: 'family';
-    readonly id: string;
-    readonly familyId: TFamilyId;
-    readonly manifest: ExtensionPackManifest;
-    readonly hook: TargetFamilyHook;
-    create<TTargetId extends string>(options: {
-        readonly target: ControlTargetDescriptor<TFamilyId, TTargetId>;
-        readonly adapter: ControlAdapterDescriptor<TFamilyId, TTargetId>;
-        readonly driver: ControlDriverDescriptor<TFamilyId, TTargetId>;
-        readonly extensions: readonly ControlExtensionDescriptor<TFamilyId, TTargetId>[];
-    }): TFamilyInstance;
+interface MigrationPlannerFailureResult {
+    readonly kind: 'failure';
+    readonly conflicts: readonly MigrationPlannerConflict[];
 }
 /**
- * Descriptor for a control-plane target pack (e.g., Postgres target).
- *
- * @template TFamilyId - The family ID (e.g., 'sql', 'document')
- * @template TTargetId - The target ID (e.g., 'postgres', 'mysql')
- * @template TTargetInstance - The target instance type
+ * Union type for planner results.
  */
-interface ControlTargetDescriptor<TFamilyId extends string, TTargetId extends string, TTargetInstance extends ControlTargetInstance<TFamilyId, TTargetId> = ControlTargetInstance<TFamilyId, TTargetId>> {
-    readonly kind: 'target';
-    readonly id: string;
-    readonly familyId: TFamilyId;
-    readonly targetId: TTargetId;
-    readonly manifest: ExtensionPackManifest;
-    create(): TTargetInstance;
+type MigrationPlannerResult = MigrationPlannerSuccessResult | MigrationPlannerFailureResult;
+/**
+ * Success value for migration runner execution.
+ */
+interface MigrationRunnerSuccessValue {
+    readonly operationsPlanned: number;
+    readonly operationsExecuted: number;
+}
+/**
+ * Failure details for migration runner execution.
+ */
+interface MigrationRunnerFailure {
+    /** Error code for the failure. */
+    readonly code: string;
+    /** Human-readable summary of the failure. */
+    readonly summary: string;
+    /** Optional explanation of why the failure occurred. */
+    readonly why?: string;
+    /** Optional metadata for debugging and UX (e.g., schema issues, SQL state). */
+    readonly meta?: Record<string, unknown>;
+}
+/**
+ * Result type for migration runner execution.
+ */
+type MigrationRunnerResult = Result<MigrationRunnerSuccessValue, MigrationRunnerFailure>;
+/**
+ * Execution-time checks configuration for migration runners.
+ * All checks default to `true` (enabled) when omitted.
+ */
+interface MigrationRunnerExecutionChecks {
+    /**
+     * Whether to run prechecks before executing operations.
+     * Defaults to `true` (prechecks are run).
+     */
+    readonly prechecks?: boolean;
+    /**
+     * Whether to run postchecks after executing operations.
+     * Defaults to `true` (postchecks are run).
+     */
+    readonly postchecks?: boolean;
+    /**
+     * Whether to run idempotency probe (check if postcheck is already satisfied before execution).
+     * Defaults to `true` (idempotency probe is run).
+     */
+    readonly idempotencyChecks?: boolean;
 }
 /**
- * Descriptor for a control-plane adapter pack (e.g., Postgres adapter).
+ * Migration planner interface for planning schema changes.
+ * This is the minimal interface that CLI commands use.
  *
  * @template TFamilyId - The family ID (e.g., 'sql', 'document')
  * @template TTargetId - The target ID (e.g., 'postgres', 'mysql')
- * @template TAdapterInstance - The adapter instance type
  */
-interface ControlAdapterDescriptor<TFamilyId extends string, TTargetId extends string, TAdapterInstance extends ControlAdapterInstance<TFamilyId, TTargetId> = ControlAdapterInstance<TFamilyId, TTargetId>> {
-    readonly kind: 'adapter';
-    readonly id: string;
-    readonly familyId: TFamilyId;
-    readonly targetId: TTargetId;
-    readonly manifest: ExtensionPackManifest;
-    create(): TAdapterInstance;
+interface MigrationPlanner<TFamilyId extends string = string, TTargetId extends string = string> {
+    plan(options: {
+        readonly contract: unknown;
+        readonly schema: unknown;
+        readonly policy: MigrationOperationPolicy;
+        /**
+         * Active framework components participating in this composition.
+         * Families/targets can interpret this list to derive family-specific metadata.
+         * All components must have matching familyId and targetId.
+         */
+        readonly frameworkComponents: ReadonlyArray<TargetBoundComponentDescriptor<TFamilyId, TTargetId>>;
+    }): MigrationPlannerResult;
 }
 /**
- * Descriptor for a control-plane driver pack (e.g., Postgres driver).
+ * Migration runner interface for executing migration plans.
+ * This is the minimal interface that CLI commands use.
  *
  * @template TFamilyId - The family ID (e.g., 'sql', 'document')
  * @template TTargetId - The target ID (e.g., 'postgres', 'mysql')
- * @template TDriverInstance - The driver instance type
  */
-interface ControlDriverDescriptor<TFamilyId extends string, TTargetId extends string, TDriverInstance extends ControlDriverInstance<TTargetId> = ControlDriverInstance<TTargetId>> {
-    readonly kind: 'driver';
-    readonly id: string;
-    readonly familyId: TFamilyId;
-    readonly targetId: TTargetId;
-    readonly manifest: ExtensionPackManifest;
-    create(url: string): Promise<TDriverInstance>;
+interface MigrationRunner<TFamilyId extends string = string, TTargetId extends string = string> {
+    execute(options: {
+        readonly plan: MigrationPlan;
+        readonly driver: ControlDriverInstance<TFamilyId, TTargetId>;
+        readonly destinationContract: unknown;
+        readonly policy: MigrationOperationPolicy;
+        readonly callbacks?: {
+            onOperationStart?(op: MigrationPlanOperation): void;
+            onOperationComplete?(op: MigrationPlanOperation): void;
+        };
+        /**
+         * Execution-time checks configuration.
+         * All checks default to `true` (enabled) when omitted.
+         */
+        readonly executionChecks?: MigrationRunnerExecutionChecks;
+        /**
+         * Active framework components participating in this composition.
+         * Families/targets can interpret this list to derive family-specific metadata.
+         * All components must have matching familyId and targetId.
+         */
+        readonly frameworkComponents: ReadonlyArray<TargetBoundComponentDescriptor<TFamilyId, TTargetId>>;
+    }): Promise<MigrationRunnerResult>;
 }
 /**
- * Descriptor for a control-plane extension pack (e.g., pgvector).
+ * Optional capability interface for targets that support migrations.
+ * Targets that implement migrations expose this via their descriptor.
  *
  * @template TFamilyId - The family ID (e.g., 'sql', 'document')
  * @template TTargetId - The target ID (e.g., 'postgres', 'mysql')
- * @template TExtensionInstance - The extension instance type
+ * @template TFamilyInstance - The family instance type (e.g., SqlControlFamilyInstance)
  */
-interface ControlExtensionDescriptor<TFamilyId extends string, TTargetId extends string, TExtensionInstance extends ControlExtensionInstance<TFamilyId, TTargetId> = ControlExtensionInstance<TFamilyId, TTargetId>> {
-    readonly kind: 'extension';
-    readonly id: string;
-    readonly familyId: TFamilyId;
-    readonly targetId: TTargetId;
-    readonly manifest: ExtensionPackManifest;
-    create(): TExtensionInstance;
+interface TargetMigrationsCapability<TFamilyId extends string = string, TTargetId extends string = string, TFamilyInstance extends ControlFamilyInstance<TFamilyId> = ControlFamilyInstance<TFamilyId>> {
+    createPlanner(family: TFamilyInstance): MigrationPlanner<TFamilyId, TTargetId>;
+    createRunner(family: TFamilyInstance): MigrationRunner<TFamilyId, TTargetId>;
 }
+
 /**
- * Family instance interface for control-plane domain actions.
- * Each family implements this interface with family-specific types.
+ * Control-plane family instance interface.
+ * Extends the base FamilyInstance with control-plane domain actions.
+ *
+ * @template TFamilyId - The family ID (e.g., 'sql', 'document')
+ * @template TSchemaIR - The schema IR type returned by introspect() (family-specific)
  */
-interface FamilyInstance<TFamilyId extends string, TSchemaIR = unknown, TVerifyResult = unknown, TSchemaVerifyResult = unknown, TSignResult = unknown> {
-    readonly familyId: TFamilyId;
+interface ControlFamilyInstance<TFamilyId extends string, TSchemaIR = unknown> extends FamilyInstance<TFamilyId> {
     /**
      * Validates a contract JSON and returns a validated ContractIR (without mappings).
      * Mappings are runtime-only and should not be part of ContractIR.
+     *
+     * Note: The returned ContractIR may include additional fields from the emitted contract
+     * (like coreHash, profileHash) that are not part of the ContractIR type but are preserved
+     * for use by verify/sign operations.
      */
-    validateContractIR(contractJson: unknown): unknown;
+    validateContractIR(contractJson: unknown): ContractIR;
     /**
      * Verifies the database marker against the contract.
      * Compares target, coreHash, and profileHash.
+     *
+     * @param options.contractIR - The validated contract (from validateContractIR). Must have
+     *   coreHash and target fields for verification. These fields are present in emitted
+     *   contracts but not in the ContractIR type definition.
      */
     verify(options: {
-        readonly driver: ControlDriverInstance;
+        readonly driver: ControlDriverInstance<TFamilyId, string>;
         readonly contractIR: unknown;
         readonly expectedTargetId: string;
         readonly contractPath: string;
         readonly configPath?: string;
-    }): Promise<TVerifyResult>;
+    }): Promise<VerifyDatabaseResult>;
     /**
      * Verifies the database schema against the contract.
      * Compares contract requirements against live database schema.
      */
     schemaVerify(options: {
-        readonly driver: ControlDriverInstance;
+        readonly driver: ControlDriverInstance<TFamilyId, string>;
         readonly contractIR: unknown;
         readonly strict: boolean;
         readonly contractPath: string;
         readonly configPath?: string;
-    }): Promise<TSchemaVerifyResult>;
+        /**
+         * Active framework components participating in this composition.
+         * All components must have matching familyId and targetId.
+         */
+        readonly frameworkComponents: ReadonlyArray<TargetBoundComponentDescriptor<TFamilyId, string>>;
+    }): Promise<VerifyDatabaseSchemaResult>;
     /**
      * Signs the database with the contract marker.
      * Writes or updates the contract marker if schema verification passes.
      * This operation is idempotent - if the marker already matches, no changes are made.
      */
     sign(options: {
-        readonly driver: ControlDriverInstance;
+        readonly driver: ControlDriverInstance<TFamilyId, string>;
         readonly contractIR: unknown;
         readonly contractPath: string;
         readonly configPath?: string;
-    }): Promise<TSignResult>;
+    }): Promise<SignDatabaseResult>;
+    /**
+     * Reads the contract marker from the database.
+     * Returns null if no marker exists.
+     */
+    readMarker(options: {
+        readonly driver: ControlDriverInstance<TFamilyId, string>;
+    }): Promise<ContractMarkerRecord | null>;
     /**
      * Introspects the database schema and returns a family-specific schema IR.
      *
@@ -189,15 +267,15 @@ interface FamilyInstance<TFamilyId extends string, TSchemaIR = unknown, TVerifyR
      *
      * @param options - Introspection options
      * @param options.driver - Control plane driver for database connection
-     * @param options.contractIR - Optional contract IR for contract-guided introspection.
+     * @param options.contractIR - Optional contract for contract-guided introspection.
      *   When provided, families may use it for filtering, optimization, or validation
-     *   during introspection. The contract IR does not change the meaning of "what exists"
+     *   during introspection. The contract does not change the meaning of "what exists"
      *   in the database - it only guides how introspection is performed.
      * @returns Promise resolving to the family-specific Schema IR (e.g., `SqlSchemaIR` for SQL).
      *   The IR represents the complete schema snapshot at the time of introspection.
      */
     introspect(options: {
-        readonly driver: ControlDriverInstance;
+        readonly driver: ControlDriverInstance<TFamilyId, string>;
         readonly contractIR?: unknown;
     }): Promise<TSchemaIR>;
     /**
@@ -215,6 +293,146 @@ interface FamilyInstance<TFamilyId extends string, TSchemaIR = unknown, TVerifyR
         readonly contractIR: ContractIR | unknown;
     }): Promise<EmitContractResult>;
 }
+/**
+ * Control-plane target instance interface.
+ * Extends the base TargetInstance with control-plane specific behavior.
+ *
+ * @template TFamilyId - The family ID (e.g., 'sql', 'document')
+ * @template TTargetId - The target ID (e.g., 'postgres', 'mysql')
+ */
+interface ControlTargetInstance<TFamilyId extends string, TTargetId extends string> extends TargetInstance<TFamilyId, TTargetId> {
+}
+/**
+ * Control-plane adapter instance interface.
+ * Extends the base AdapterInstance with control-plane specific behavior.
+ * Families extend this with family-specific adapter interfaces.
+ *
+ * @template TFamilyId - The family ID (e.g., 'sql', 'document')
+ * @template TTargetId - The target ID (e.g., 'postgres', 'mysql')
+ */
+interface ControlAdapterInstance<TFamilyId extends string, TTargetId extends string> extends AdapterInstance<TFamilyId, TTargetId> {
+}
+/**
+ * Control-plane driver instance interface.
+ * Extends the base DriverInstance with control-plane specific behavior.
+ *
+ * @template TFamilyId - The family ID (e.g., 'sql', 'document')
+ * @template TTargetId - The target ID (e.g., 'postgres', 'mysql')
+ */
+interface ControlDriverInstance<TFamilyId extends string, TTargetId extends string> extends DriverInstance<TFamilyId, TTargetId> {
+    query<Row = Record<string, unknown>>(sql: string, params?: readonly unknown[]): Promise<{
+        readonly rows: Row[];
+    }>;
+    close(): Promise<void>;
+}
+/**
+ * Control-plane extension instance interface.
+ * Extends the base ExtensionInstance with control-plane specific behavior.
+ *
+ * @template TFamilyId - The family ID (e.g., 'sql', 'document')
+ * @template TTargetId - The target ID (e.g., 'postgres', 'mysql')
+ */
+interface ControlExtensionInstance<TFamilyId extends string, TTargetId extends string> extends ExtensionInstance<TFamilyId, TTargetId> {
+}
+/**
+ * Operation context for propagating metadata through control-plane operation call chains.
+ * Inspired by OpenTelemetry's Context and Sentry's Scope patterns.
+ *
+ * This context carries informational metadata (like file paths) that can be used for
+ * error reporting, logging, and debugging, but is not required for structural correctness.
+ * It allows subsystems to propagate context without coupling to file I/O concerns.
+ *
+ * @example
+ * ```typescript
+ * const context: OperationContext = {
+ *   contractPath: './contract.json',
+ *   configPath: './prisma-next.config.ts',
+ * };
+ *
+ * await runner.execute({ plan, driver, destinationContract: contract, context });
+ * ```
+ */
+interface OperationContext {
+    /**
+     * Path to the contract file (if applicable).
+     * Used for error reporting and metadata, not for file I/O.
+     */
+    readonly contractPath?: string;
+    /**
+     * Path to the configuration file (if applicable).
+     * Used for error reporting and metadata, not for file I/O.
+     */
+    readonly configPath?: string;
+    /**
+     * Additional metadata that can be propagated through the call chain.
+     * Extensible for future needs without breaking changes.
+     */
+    readonly meta?: Readonly<Record<string, unknown>>;
+}
+/**
+ * Descriptor for a control-plane family (e.g., SQL).
+ * Provides the family hook and factory method.
+ *
+ * @template TFamilyId - The family ID (e.g., 'sql', 'document')
+ * @template TFamilyInstance - The family instance type
+ */
+interface ControlFamilyDescriptor<TFamilyId extends string, TFamilyInstance extends ControlFamilyInstance<TFamilyId> = ControlFamilyInstance<TFamilyId>> extends FamilyDescriptor<TFamilyId> {
+    readonly hook: TargetFamilyHook;
+    create<TTargetId extends string>(options: {
+        readonly target: ControlTargetDescriptor<TFamilyId, TTargetId>;
+        readonly adapter: ControlAdapterDescriptor<TFamilyId, TTargetId>;
+        readonly driver: ControlDriverDescriptor<TFamilyId, TTargetId>;
+        readonly extensionPacks: readonly ControlExtensionDescriptor<TFamilyId, TTargetId>[];
+    }): TFamilyInstance;
+}
+/**
+ * Descriptor for a control-plane target component (e.g., Postgres target).
+ *
+ * @template TFamilyId - The family ID (e.g., 'sql', 'document')
+ * @template TTargetId - The target ID (e.g., 'postgres', 'mysql')
+ * @template TTargetInstance - The target instance type
+ * @template TFamilyInstance - The family instance type for migrations (optional)
+ */
+interface ControlTargetDescriptor<TFamilyId extends string, TTargetId extends string, TTargetInstance extends ControlTargetInstance<TFamilyId, TTargetId> = ControlTargetInstance<TFamilyId, TTargetId>, TFamilyInstance extends ControlFamilyInstance<TFamilyId> = ControlFamilyInstance<TFamilyId>> extends TargetDescriptor<TFamilyId, TTargetId> {
+    /**
+     * Optional migrations capability.
+     * Targets that support migrations expose this property.
+     * The capability is parameterized by family and target IDs to ensure type-level
+     * compatibility of framework components.
+     */
+    readonly migrations?: TargetMigrationsCapability<TFamilyId, TTargetId, TFamilyInstance>;
+    create(): TTargetInstance;
+}
+/**
+ * Descriptor for a control-plane adapter component (e.g., Postgres adapter).
+ *
+ * @template TFamilyId - The family ID (e.g., 'sql', 'document')
+ * @template TTargetId - The target ID (e.g., 'postgres', 'mysql')
+ * @template TAdapterInstance - The adapter instance type
+ */
+interface ControlAdapterDescriptor<TFamilyId extends string, TTargetId extends string, TAdapterInstance extends ControlAdapterInstance<TFamilyId, TTargetId> = ControlAdapterInstance<TFamilyId, TTargetId>> extends AdapterDescriptor<TFamilyId, TTargetId> {
+    create(): TAdapterInstance;
+}
+/**
+ * Descriptor for a control-plane driver component (e.g., Postgres driver).
+ *
+ * @template TFamilyId - The family ID (e.g., 'sql', 'document')
+ * @template TTargetId - The target ID (e.g., 'postgres', 'mysql')
+ * @template TDriverInstance - The driver instance type
+ */
+interface ControlDriverDescriptor<TFamilyId extends string, TTargetId extends string, TDriverInstance extends ControlDriverInstance<TFamilyId, TTargetId> = ControlDriverInstance<TFamilyId, TTargetId>> extends DriverDescriptor<TFamilyId, TTargetId> {
+    create(url: string): Promise<TDriverInstance>;
+}
+/**
+ * Descriptor for a control-plane extension component (e.g., pgvector).
+ *
+ * @template TFamilyId - The family ID (e.g., 'sql', 'document')
+ * @template TTargetId - The target ID (e.g., 'postgres', 'mysql')
+ * @template TExtensionInstance - The extension instance type
+ */
+interface ControlExtensionDescriptor<TFamilyId extends string, TTargetId extends string, TExtensionInstance extends ControlExtensionInstance<TFamilyId, TTargetId> = ControlExtensionInstance<TFamilyId, TTargetId>> extends ExtensionDescriptor<TFamilyId, TTargetId> {
+    create(): TExtensionInstance;
+}
 /**
  * Result type for database marker verification operations.
  */
@@ -248,7 +466,7 @@ interface VerifyDatabaseResult {
  * Schema issue type for schema verification results.
  */
 interface SchemaIssue {
-    readonly kind: 'missing_table' | 'missing_column' | 'type_mismatch' | 'nullability_mismatch' | 'primary_key_mismatch' | 'foreign_key_mismatch' | 'unique_constraint_mismatch' | 'index_mismatch' | 'extension_missing';
+    readonly kind: 'missing_table' | 'missing_column' | 'extra_table' | 'extra_column' | 'extra_primary_key' | 'extra_foreign_key' | 'extra_unique_constraint' | 'extra_index' | 'type_mismatch' | 'nullability_mismatch' | 'primary_key_mismatch' | 'foreign_key_mismatch' | 'unique_constraint_mismatch' | 'index_mismatch' | 'extension_missing';
     readonly table: string;
     readonly column?: string;
     readonly indexOrConstraint?: string;
@@ -298,7 +516,7 @@ interface VerifyDatabaseSchemaResult {
     };
     readonly meta?: {
         readonly configPath?: string;
-        readonly contractPath: string;
+        readonly contractPath?: string;
         readonly strict: boolean;
     };
     readonly timings: {
@@ -320,7 +538,7 @@ interface EmitContractResult {
  *
  * @template TSchemaIR - The family-specific Schema IR type (e.g., `SqlSchemaIR` for SQL)
  */
-interface IntrospectSchemaResult<TSchemaIR = unknown> {
+interface IntrospectSchemaResult<TSchemaIR> {
     readonly ok: true;
     readonly summary: string;
     readonly target: {
@@ -368,4 +586,4 @@ interface SignDatabaseResult {
     };
 }
 
-export type { ControlAdapterDescriptor, ControlAdapterInstance, ControlDriverDescriptor, ControlDriverInstance, ControlExtensionDescriptor, ControlExtensionInstance, ControlFamilyDescriptor, ControlFamilyInstance, ControlTargetDescriptor, ControlTargetInstance, EmitContractResult, FamilyInstance, IntrospectSchemaResult, SchemaIssue, SchemaVerificationNode, SignDatabaseResult, VerifyDatabaseResult, VerifyDatabaseSchemaResult };
+export type { ControlAdapterDescriptor, ControlAdapterInstance, ControlDriverDescriptor, ControlDriverInstance, ControlExtensionDescriptor, ControlExtensionInstance, ControlFamilyDescriptor, ControlFamilyInstance, ControlTargetDescriptor, ControlTargetInstance, EmitContractResult, IntrospectSchemaResult, MigrationOperationClass, MigrationOperationPolicy, MigrationPlan, MigrationPlanOperation, MigrationPlanner, MigrationPlannerConflict, MigrationPlannerFailureResult, MigrationPlannerResult, MigrationPlannerSuccessResult, MigrationRunner, MigrationRunnerExecutionChecks, MigrationRunnerFailure, MigrationRunnerResult, MigrationRunnerSuccessValue, OperationContext, SchemaIssue, SchemaVerificationNode, SignDatabaseResult, TargetMigrationsCapability, VerifyDatabaseResult, VerifyDatabaseSchemaResult };

package/package.json

@@ -1,19 +1,21 @@
 {
   "name": "@prisma-next/core-control-plane",
-  "version": "0.1.0-dev.3",
+  "version": "0.1.0-dev.30",
   "type": "module",
   "sideEffects": false,
   "description": "Control plane domain actions, config types, validation, and error factories for Prisma Next",
   "dependencies": {
     "arktype": "^2.1.26",
     "prettier": "^3.3.3",
-    "@prisma-next/operations": "0.1.0-dev.3",
-    "@prisma-next/contract": "0.1.0-dev.3"
+    "@prisma-next/contract": "0.1.0-dev.30",
+    "@prisma-next/operations": "0.1.0-dev.30",
+    "@prisma-next/utils": "0.1.0-dev.30"
   },
   "devDependencies": {
+    "@vitest/coverage-v8": "^4.0.0",
     "tsup": "^8.3.0",
     "typescript": "^5.9.3",
-    "vitest": "^2.1.1",
+    "vitest": "^4.0.16",
     "@prisma-next/test-utils": "0.0.1"
   },
   "files": [
@@ -50,7 +52,9 @@
     "test": "vitest run --passWithNoTests",
     "test:coverage": "vitest run --coverage --passWithNoTests",
     "typecheck": "tsc --project tsconfig.json --noEmit",
-    "lint": "biome check . --config-path ../../../biome.json --error-on-warnings",
-    "clean": "node ../../../scripts/clean.mjs"
+    "lint": "biome check . --config-path ../../../../../biome.json --error-on-warnings",
+    "lint:fix": "biome check --write . --config-path ../../../biome.json",
+    "lint:fix:unsafe": "biome check --write --unsafe . --config-path ../../../biome.json",
+    "clean": "node ../../../../../scripts/clean.mjs"
   }
 }

package/dist/chunk-DZPZSLCM.js.map

@@ -1 +0,0 @@
-{"version":3,"sources":["../src/errors.ts"],"sourcesContent":["/**\n * CLI error envelope for output formatting.\n * This is the serialized form of a CliStructuredError.\n */\nexport interface CliErrorEnvelope {\n  readonly code: string;\n  readonly domain: string;\n  readonly severity: 'error' | 'warn' | 'info';\n  readonly summary: string;\n  readonly why: string | undefined;\n  readonly fix: string | undefined;\n  readonly where:\n    | {\n        readonly path: string | undefined;\n        readonly line: number | undefined;\n      }\n    | undefined;\n  readonly meta: Record<string, unknown> | undefined;\n  readonly docsUrl: string | undefined;\n}\n\n/**\n * Structured CLI error that contains all information needed for error envelopes.\n * Call sites throw these errors with full context.\n */\nexport class CliStructuredError extends Error {\n  readonly code: string;\n  readonly domain: 'CLI' | 'RTM';\n  readonly severity: 'error' | 'warn' | 'info';\n  readonly why: string | undefined;\n  readonly fix: string | undefined;\n  readonly where:\n    | {\n        readonly path: string | undefined;\n        readonly line: number | undefined;\n      }\n    | undefined;\n  readonly meta: Record<string, unknown> | undefined;\n  readonly docsUrl: string | undefined;\n\n  constructor(\n    code: string,\n    summary: string,\n    options?: {\n      readonly domain?: 'CLI' | 'RTM';\n      readonly severity?: 'error' | 'warn' | 'info';\n      readonly why?: string;\n      readonly fix?: string;\n      readonly where?: { readonly path?: string; readonly line?: number };\n      readonly meta?: Record<string, unknown>;\n      readonly docsUrl?: string;\n    },\n  ) {\n    super(summary);\n    this.name = 'CliStructuredError';\n    this.code = code;\n    this.domain = options?.domain ?? 'CLI';\n    this.severity = options?.severity ?? 'error';\n    this.why = options?.why;\n    this.fix = options?.fix;\n    this.where = options?.where\n      ? {\n          path: options.where.path,\n          line: options.where.line,\n        }\n      : undefined;\n    this.meta = options?.meta;\n    this.docsUrl = options?.docsUrl;\n  }\n\n  /**\n   * Converts this error to a CLI error envelope for output formatting.\n   */\n  toEnvelope(): CliErrorEnvelope {\n    const codePrefix = this.domain === 'CLI' ? 'PN-CLI-' : 'PN-RTM-';\n    return {\n      code: `${codePrefix}${this.code}`,\n      domain: this.domain,\n      severity: this.severity,\n      summary: this.message,\n      why: this.why,\n      fix: this.fix,\n      where: this.where,\n      meta: this.meta,\n      docsUrl: this.docsUrl,\n    };\n  }\n}\n\n// ============================================================================\n// Config Errors (PN-CLI-4001-4007)\n// ============================================================================\n\n/**\n * Config file not found or missing.\n */\nexport function errorConfigFileNotFound(\n  configPath?: string,\n  options?: {\n    readonly why?: string;\n  },\n): CliStructuredError {\n  return new CliStructuredError('4001', 'Config file not found', {\n    domain: 'CLI',\n    ...(options?.why ? { why: options.why } : { why: 'Config file not found' }),\n    fix: \"Run 'prisma-next init' to create a config file\",\n    docsUrl: 'https://prisma-next.dev/docs/cli/config',\n    ...(configPath ? { where: { path: configPath } } : {}),\n  });\n}\n\n/**\n * Contract configuration missing from config.\n */\nexport function errorContractConfigMissing(options?: {\n  readonly why?: string;\n}): CliStructuredError {\n  return new CliStructuredError('4002', 'Contract configuration missing', {\n    domain: 'CLI',\n    why: options?.why ?? 'The contract configuration is required for emit',\n    fix: 'Add contract configuration to your prisma-next.config.ts',\n    docsUrl: 'https://prisma-next.dev/docs/cli/contract-emit',\n  });\n}\n\n/**\n * Contract validation failed.\n */\nexport function errorContractValidationFailed(\n  reason: string,\n  options?: {\n    readonly where?: { readonly path?: string; readonly line?: number };\n  },\n): CliStructuredError {\n  return new CliStructuredError('4003', 'Contract validation failed', {\n    domain: 'CLI',\n    why: reason,\n    fix: 'Check your contract file for errors',\n    docsUrl: 'https://prisma-next.dev/docs/contracts',\n    ...(options?.where ? { where: options.where } : {}),\n  });\n}\n\n/**\n * File not found.\n */\nexport function errorFileNotFound(\n  filePath: string,\n  options?: {\n    readonly why?: string;\n  },\n): CliStructuredError {\n  return new CliStructuredError('4004', 'File not found', {\n    domain: 'CLI',\n    why: options?.why ?? `File not found: ${filePath}`,\n    fix: 'Check that the file path is correct',\n    where: { path: filePath },\n  });\n}\n\n/**\n * Database URL is required but not provided.\n */\nexport function errorDatabaseUrlRequired(options?: { readonly why?: string }): CliStructuredError {\n  return new CliStructuredError('4005', 'Database URL is required', {\n    domain: 'CLI',\n    why: options?.why ?? 'Database URL is required for db verify',\n    fix: 'Provide --db flag or config.db.url in prisma-next.config.ts',\n  });\n}\n\n/**\n * Query runner factory is required but not provided in config.\n */\nexport function errorQueryRunnerFactoryRequired(options?: {\n  readonly why?: string;\n}): CliStructuredError {\n  return new CliStructuredError('4006', 'Query runner factory is required', {\n    domain: 'CLI',\n    why: options?.why ?? 'Config.db.queryRunnerFactory is required for db verify',\n    fix: 'Add db.queryRunnerFactory to prisma-next.config.ts',\n    docsUrl: 'https://prisma-next.dev/docs/cli/db-verify',\n  });\n}\n\n/**\n * Family verify.readMarker is required but not provided.\n */\nexport function errorFamilyReadMarkerSqlRequired(options?: {\n  readonly why?: string;\n}): CliStructuredError {\n  return new CliStructuredError('4007', 'Family readMarker() is required', {\n    domain: 'CLI',\n    why: options?.why ?? 'Family verify.readMarker is required for db verify',\n    fix: 'Ensure family.verify.readMarker() is exported by your family package',\n    docsUrl: 'https://prisma-next.dev/docs/cli/db-verify',\n  });\n}\n\n/**\n * Driver is required for DB-connected commands but not provided.\n */\nexport function errorDriverRequired(options?: { readonly why?: string }): CliStructuredError {\n  return new CliStructuredError('4010', 'Driver is required for DB-connected commands', {\n    domain: 'CLI',\n    why: options?.why ?? 'Config.driver is required for db verify',\n    fix: 'Add driver to prisma-next.config.ts',\n    docsUrl: 'https://prisma-next.dev/docs/cli/db-verify',\n  });\n}\n\n/**\n * Config validation error (missing required fields).\n */\nexport function errorConfigValidation(\n  field: string,\n  options?: {\n    readonly why?: string;\n  },\n): CliStructuredError {\n  return new CliStructuredError('4001', 'Config file not found', {\n    domain: 'CLI',\n    why: options?.why ?? `Config must have a \"${field}\" field`,\n    fix: \"Run 'prisma-next init' to create a config file\",\n    docsUrl: 'https://prisma-next.dev/docs/cli/config',\n  });\n}\n\n// ============================================================================\n// Runtime Errors (PN-RTM-3000-3003)\n// ============================================================================\n\n/**\n * Contract marker not found in database.\n */\nexport function errorMarkerMissing(options?: {\n  readonly why?: string;\n  readonly dbUrl?: string;\n}): CliStructuredError {\n  return new CliStructuredError('3001', 'Marker missing', {\n    domain: 'RTM',\n    why: options?.why ?? 'Contract marker not found in database',\n    fix: 'Run `prisma-next db sign --db <url>` to create marker',\n  });\n}\n\n/**\n * Contract hash does not match database marker.\n */\nexport function errorHashMismatch(options?: {\n  readonly why?: string;\n  readonly expected?: string;\n  readonly actual?: string;\n}): CliStructuredError {\n  return new CliStructuredError('3002', 'Hash mismatch', {\n    domain: 'RTM',\n    why: options?.why ?? 'Contract hash does not match database marker',\n    fix: 'Migrate database or re-sign if intentional',\n    ...(options?.expected || options?.actual\n      ? {\n          meta: {\n            ...(options.expected ? { expected: options.expected } : {}),\n            ...(options.actual ? { actual: options.actual } : {}),\n          },\n        }\n      : {}),\n  });\n}\n\n/**\n * Contract target does not match config target.\n */\nexport function errorTargetMismatch(\n  expected: string,\n  actual: string,\n  options?: {\n    readonly why?: string;\n  },\n): CliStructuredError {\n  return new CliStructuredError('3003', 'Target mismatch', {\n    domain: 'RTM',\n    why:\n      options?.why ??\n      `Contract target does not match config target (expected: ${expected}, actual: ${actual})`,\n    fix: 'Align contract target and config target',\n    meta: { expected, actual },\n  });\n}\n\n/**\n * Generic runtime error.\n */\nexport function errorRuntime(\n  summary: string,\n  options?: {\n    readonly why?: string;\n    readonly fix?: string;\n    readonly meta?: Record<string, unknown>;\n  },\n): CliStructuredError {\n  return new CliStructuredError('3000', summary, {\n    domain: 'RTM',\n    ...(options?.why ? { why: options.why } : { why: 'Verification failed' }),\n    ...(options?.fix ? { fix: options.fix } : { fix: 'Check contract and database state' }),\n    ...(options?.meta ? { meta: options.meta } : {}),\n  });\n}\n\n// ============================================================================\n// Generic Error\n// ============================================================================\n\n/**\n * Generic unexpected error.\n */\nexport function errorUnexpected(\n  message: string,\n  options?: {\n    readonly why?: string;\n    readonly fix?: string;\n  },\n): CliStructuredError {\n  return new CliStructuredError('4999', 'Unexpected error', {\n    domain: 'CLI',\n    why: options?.why ?? message,\n    fix: options?.fix ?? 'Check the error message and try again',\n  });\n}\n"],"mappings":";AAyBO,IAAM,qBAAN,cAAiC,MAAM;AAAA,EACnC;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EAMA;AAAA,EACA;AAAA,EAET,YACE,MACA,SACA,SASA;AACA,UAAM,OAAO;AACb,SAAK,OAAO;AACZ,SAAK,OAAO;AACZ,SAAK,SAAS,SAAS,UAAU;AACjC,SAAK,WAAW,SAAS,YAAY;AACrC,SAAK,MAAM,SAAS;AACpB,SAAK,MAAM,SAAS;AACpB,SAAK,QAAQ,SAAS,QAClB;AAAA,MACE,MAAM,QAAQ,MAAM;AAAA,MACpB,MAAM,QAAQ,MAAM;AAAA,IACtB,IACA;AACJ,SAAK,OAAO,SAAS;AACrB,SAAK,UAAU,SAAS;AAAA,EAC1B;AAAA;AAAA;AAAA;AAAA,EAKA,aAA+B;AAC7B,UAAM,aAAa,KAAK,WAAW,QAAQ,YAAY;AACvD,WAAO;AAAA,MACL,MAAM,GAAG,UAAU,GAAG,KAAK,IAAI;AAAA,MAC/B,QAAQ,KAAK;AAAA,MACb,UAAU,KAAK;AAAA,MACf,SAAS,KAAK;AAAA,MACd,KAAK,KAAK;AAAA,MACV,KAAK,KAAK;AAAA,MACV,OAAO,KAAK;AAAA,MACZ,MAAM,KAAK;AAAA,MACX,SAAS,KAAK;AAAA,IAChB;AAAA,EACF;AACF;AASO,SAAS,wBACd,YACA,SAGoB;AACpB,SAAO,IAAI,mBAAmB,QAAQ,yBAAyB;AAAA,IAC7D,QAAQ;AAAA,IACR,GAAI,SAAS,MAAM,EAAE,KAAK,QAAQ,IAAI,IAAI,EAAE,KAAK,wBAAwB;AAAA,IACzE,KAAK;AAAA,IACL,SAAS;AAAA,IACT,GAAI,aAAa,EAAE,OAAO,EAAE,MAAM,WAAW,EAAE,IAAI,CAAC;AAAA,EACtD,CAAC;AACH;AAKO,SAAS,2BAA2B,SAEpB;AACrB,SAAO,IAAI,mBAAmB,QAAQ,kCAAkC;AAAA,IACtE,QAAQ;AAAA,IACR,KAAK,SAAS,OAAO;AAAA,IACrB,KAAK;AAAA,IACL,SAAS;AAAA,EACX,CAAC;AACH;AAKO,SAAS,8BACd,QACA,SAGoB;AACpB,SAAO,IAAI,mBAAmB,QAAQ,8BAA8B;AAAA,IAClE,QAAQ;AAAA,IACR,KAAK;AAAA,IACL,KAAK;AAAA,IACL,SAAS;AAAA,IACT,GAAI,SAAS,QAAQ,EAAE,OAAO,QAAQ,MAAM,IAAI,CAAC;AAAA,EACnD,CAAC;AACH;AAKO,SAAS,kBACd,UACA,SAGoB;AACpB,SAAO,IAAI,mBAAmB,QAAQ,kBAAkB;AAAA,IACtD,QAAQ;AAAA,IACR,KAAK,SAAS,OAAO,mBAAmB,QAAQ;AAAA,IAChD,KAAK;AAAA,IACL,OAAO,EAAE,MAAM,SAAS;AAAA,EAC1B,CAAC;AACH;AAKO,SAAS,yBAAyB,SAAyD;AAChG,SAAO,IAAI,mBAAmB,QAAQ,4BAA4B;AAAA,IAChE,QAAQ;AAAA,IACR,KAAK,SAAS,OAAO;AAAA,IACrB,KAAK;AAAA,EACP,CAAC;AACH;AAKO,SAAS,gCAAgC,SAEzB;AACrB,SAAO,IAAI,mBAAmB,QAAQ,oCAAoC;AAAA,IACxE,QAAQ;AAAA,IACR,KAAK,SAAS,OAAO;AAAA,IACrB,KAAK;AAAA,IACL,SAAS;AAAA,EACX,CAAC;AACH;AAKO,SAAS,iCAAiC,SAE1B;AACrB,SAAO,IAAI,mBAAmB,QAAQ,mCAAmC;AAAA,IACvE,QAAQ;AAAA,IACR,KAAK,SAAS,OAAO;AAAA,IACrB,KAAK;AAAA,IACL,SAAS;AAAA,EACX,CAAC;AACH;AAKO,SAAS,oBAAoB,SAAyD;AAC3F,SAAO,IAAI,mBAAmB,QAAQ,gDAAgD;AAAA,IACpF,QAAQ;AAAA,IACR,KAAK,SAAS,OAAO;AAAA,IACrB,KAAK;AAAA,IACL,SAAS;AAAA,EACX,CAAC;AACH;AAKO,SAAS,sBACd,OACA,SAGoB;AACpB,SAAO,IAAI,mBAAmB,QAAQ,yBAAyB;AAAA,IAC7D,QAAQ;AAAA,IACR,KAAK,SAAS,OAAO,uBAAuB,KAAK;AAAA,IACjD,KAAK;AAAA,IACL,SAAS;AAAA,EACX,CAAC;AACH;AASO,SAAS,mBAAmB,SAGZ;AACrB,SAAO,IAAI,mBAAmB,QAAQ,kBAAkB;AAAA,IACtD,QAAQ;AAAA,IACR,KAAK,SAAS,OAAO;AAAA,IACrB,KAAK;AAAA,EACP,CAAC;AACH;AAKO,SAAS,kBAAkB,SAIX;AACrB,SAAO,IAAI,mBAAmB,QAAQ,iBAAiB;AAAA,IACrD,QAAQ;AAAA,IACR,KAAK,SAAS,OAAO;AAAA,IACrB,KAAK;AAAA,IACL,GAAI,SAAS,YAAY,SAAS,SAC9B;AAAA,MACE,MAAM;AAAA,QACJ,GAAI,QAAQ,WAAW,EAAE,UAAU,QAAQ,SAAS,IAAI,CAAC;AAAA,QACzD,GAAI,QAAQ,SAAS,EAAE,QAAQ,QAAQ,OAAO,IAAI,CAAC;AAAA,MACrD;AAAA,IACF,IACA,CAAC;AAAA,EACP,CAAC;AACH;AAKO,SAAS,oBACd,UACA,QACA,SAGoB;AACpB,SAAO,IAAI,mBAAmB,QAAQ,mBAAmB;AAAA,IACvD,QAAQ;AAAA,IACR,KACE,SAAS,OACT,2DAA2D,QAAQ,aAAa,MAAM;AAAA,IACxF,KAAK;AAAA,IACL,MAAM,EAAE,UAAU,OAAO;AAAA,EAC3B,CAAC;AACH;AAKO,SAAS,aACd,SACA,SAKoB;AACpB,SAAO,IAAI,mBAAmB,QAAQ,SAAS;AAAA,IAC7C,QAAQ;AAAA,IACR,GAAI,SAAS,MAAM,EAAE,KAAK,QAAQ,IAAI,IAAI,EAAE,KAAK,sBAAsB;AAAA,IACvE,GAAI,SAAS,MAAM,EAAE,KAAK,QAAQ,IAAI,IAAI,EAAE,KAAK,oCAAoC;AAAA,IACrF,GAAI,SAAS,OAAO,EAAE,MAAM,QAAQ,KAAK,IAAI,CAAC;AAAA,EAChD,CAAC;AACH;AASO,SAAS,gBACd,SACA,SAIoB;AACpB,SAAO,IAAI,mBAAmB,QAAQ,oBAAoB;AAAA,IACxD,QAAQ;AAAA,IACR,KAAK,SAAS,OAAO;AAAA,IACrB,KAAK,SAAS,OAAO;AAAA,EACvB,CAAC;AACH;","names":[]}