@prisma-next/family-sql 0.3.0-dev.4 → 0.3.0-dev.40

package/src/core/control-adapter.ts

@@ -0,0 +1,67 @@
+import type {
+  ControlAdapterInstance,
+  ControlDriverInstance,
+} from '@prisma-next/core-control-plane/types';
+import type { SqlSchemaIR } from '@prisma-next/sql-schema-ir/types';
+import type { DefaultNormalizer, NativeTypeNormalizer } from './schema-verify/verify-sql-schema';
+
+/**
+ * SQL control adapter interface for control-plane operations.
+ * Implemented by target-specific adapters (e.g., Postgres, MySQL).
+ *
+ * @template TTarget - The target ID (e.g., 'postgres', 'mysql')
+ */
+export interface SqlControlAdapter<TTarget extends string = string>
+  extends ControlAdapterInstance<'sql', TTarget> {
+  /**
+   * The target ID this adapter implements.
+   * Used for type tracking and runtime validation.
+   * @deprecated Use targetId from ControlAdapterInstance instead
+   */
+  readonly target: TTarget;
+
+  /**
+   * Introspects a database schema and returns a raw SqlSchemaIR.
+   *
+   * This is a pure schema discovery operation that queries the database catalog
+   * and returns the schema structure without type mapping or contract enrichment.
+   * Type mapping and enrichment are handled separately by enrichment helpers.
+   *
+   * @param driver - ControlDriverInstance instance for executing queries (target-specific)
+   * @param contractIR - Optional contract IR for contract-guided introspection (filtering, optimization)
+   * @param schema - Schema name to introspect (defaults to 'public')
+   * @returns Promise resolving to SqlSchemaIR representing the live database schema
+   */
+  introspect(
+    driver: ControlDriverInstance<'sql', TTarget>,
+    contractIR?: unknown,
+    schema?: string,
+  ): Promise<SqlSchemaIR>;
+
+  /**
+   * Optional target-specific normalizer for raw database default expressions.
+   * When provided, schema defaults (raw strings) are normalized before comparison
+   * with contract defaults (ColumnDefault objects) during schema verification.
+   */
+  readonly normalizeDefault?: DefaultNormalizer;
+
+  /**
+   * Optional target-specific normalizer for schema native type names.
+   * When provided, schema native types (from introspection) are normalized
+   * before comparison with contract native types during schema verification.
+   */
+  readonly normalizeNativeType?: NativeTypeNormalizer;
+}
+
+/**
+ * SQL control adapter descriptor interface.
+ * Provides a factory method to create control adapter instances.
+ *
+ * @template TTarget - The target ID (e.g., 'postgres', 'mysql')
+ */
+export interface SqlControlAdapterDescriptor<TTarget extends string = string> {
+  /**
+   * Creates a SQL control adapter instance for control-plane operations.
+   */
+  create(): SqlControlAdapter<TTarget>;
+}

package/src/core/control-descriptor.ts

@@ -0,0 +1,37 @@
+import type { TargetDescriptor } from '@prisma-next/contract/framework-components';
+import type {
+  ControlFamilyDescriptor,
+  ControlPlaneStack,
+} from '@prisma-next/core-control-plane/types';
+import { sqlTargetFamilyHook } from '@prisma-next/sql-contract-emitter';
+import type { SqlControlDescriptorWithContributions } from './assembly';
+import { createSqlFamilyInstance, type SqlControlFamilyInstance } from './control-instance';
+import type {
+  SqlControlAdapterDescriptor,
+  SqlControlExtensionDescriptor,
+} from './migrations/types';
+
+export class SqlFamilyDescriptor
+  implements ControlFamilyDescriptor<'sql', SqlControlFamilyInstance>
+{
+  readonly kind = 'family' as const;
+  readonly id = 'sql';
+  readonly familyId = 'sql' as const;
+  readonly version = '0.0.1';
+  readonly hook = sqlTargetFamilyHook;
+
+  create<TTargetId extends string>(
+    stack: ControlPlaneStack<'sql', TTargetId>,
+  ): SqlControlFamilyInstance {
+    const target = stack.target as unknown as TargetDescriptor<'sql', TTargetId> &
+      SqlControlDescriptorWithContributions;
+    const adapter = stack.adapter as unknown as SqlControlAdapterDescriptor<TTargetId>;
+    const extensionPacks =
+      stack.extensionPacks as unknown as readonly SqlControlExtensionDescriptor<TTargetId>[];
+    return createSqlFamilyInstance({
+      target,
+      adapter,
+      extensionPacks,
+    });
+  }
+}