@prisma-next/family-sql 0.3.0-dev.3 → 0.3.0-dev.5

package/src/core/control-adapter.ts

@@ -0,0 +1,52 @@
+import type {
+  ControlAdapterInstance,
+  ControlDriverInstance,
+} from '@prisma-next/core-control-plane/types';
+import type { SqlSchemaIR } from '@prisma-next/sql-schema-ir/types';
+
+/**
+ * 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>;
+}
+
+/**
+ * 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/descriptor.ts

@@ -0,0 +1,37 @@
+import type {
+  ControlAdapterDescriptor,
+  ControlDriverDescriptor,
+  ControlExtensionDescriptor,
+  ControlFamilyDescriptor,
+} from '@prisma-next/core-control-plane/types';
+import { sqlTargetFamilyHook } from '@prisma-next/sql-contract-emitter';
+import type { SqlControlAdapter } from './control-adapter';
+import { createSqlFamilyInstance, type SqlControlFamilyInstance } from './instance';
+import type { SqlControlTargetDescriptor } from './migrations/types';
+
+/**
+ * SQL family descriptor implementation.
+ * Provides the SQL family hook and factory method.
+ */
+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, TTargetDetails>(options: {
+    readonly target: SqlControlTargetDescriptor<TTargetId, TTargetDetails>;
+    readonly adapter: ControlAdapterDescriptor<'sql', TTargetId, SqlControlAdapter<TTargetId>>;
+    readonly driver: ControlDriverDescriptor<'sql', TTargetId>;
+    readonly extensionPacks: readonly ControlExtensionDescriptor<'sql', TTargetId>[];
+  }): SqlControlFamilyInstance {
+    return createSqlFamilyInstance({
+      target: options.target,
+      adapter: options.adapter,
+      extensionPacks: options.extensionPacks,
+    });
+  }
+}