@vibeorm/runtime 1.3.0 → 2.0.0-alpha.10

package/src/adapter.ts

@@ -1,146 +0,0 @@
-/**
- * Database adapter interface for VibeORM.
- *
- * Each adapter implementation (bun:sql, pg, etc.) provides a concrete
- * implementation of this interface. The runtime is completely driver-agnostic
- * and interacts with the database exclusively through this contract.
- */
-
-// ─── Transaction Options ──────────────────────────────────────────
-
-/**
- * Options for controlling transaction behavior.
- *
- * @example
- * ```ts
- * await db.$transaction(async (tx) => {
- *   await tx.account.update({ where: { id: 1 }, data: { balance: { decrement: 100 } } });
- *   await tx.account.update({ where: { id: 2 }, data: { balance: { increment: 100 } } });
- * }, { isolationLevel: "Serializable", timeout: 5000 });
- * ```
- */
-export type TransactionOptions = {
-  /**
-   * PostgreSQL isolation level for the transaction.
-   * - "ReadCommitted" (default): Standard PostgreSQL default.
-   * - "RepeatableRead": Prevents non-repeatable reads.
-   * - "Serializable": Full serializability — conflicts throw serialization_failure.
-   */
-  isolationLevel?: "ReadCommitted" | "RepeatableRead" | "Serializable";
-  /**
-   * Maximum time in milliseconds the transaction may run before being cancelled.
-   * Implemented via `SET LOCAL statement_timeout = N` inside the transaction,
-   * so it is scoped to the transaction and does not affect other connections.
-   */
-  timeout?: number;
-};
-
-// ─── Core Adapter Interface ───────────────────────────────────────
-
-/**
- * The primary interface that every database adapter must implement.
- * Adapters own connection management, query execution, statement caching,
- * transactions, and driver-specific parameter formatting.
- */
-export type DatabaseAdapter = {
-  /**
-   * Execute a parameterized query and return rows.
-   * The adapter owns statement caching and driver-specific optimizations.
-   *
-   * For bun:sql this means synthetic tagged template caching.
-   * For pg this means named prepared statement caching.
-   */
-  execute(params: { text: string; values: unknown[] }): Promise<Record<string, unknown>[]>;
-
-  /**
-   * Execute a raw/unsafe query without prepared statement caching.
-   * Used for `$queryRawUnsafe`, `$executeRawUnsafe`, and dynamic DDL.
-   *
-   * Returns both rows and affected row count (for INSERT/UPDATE/DELETE).
-   */
-  executeUnsafe(params: {
-    text: string;
-    values?: unknown[];
-  }): Promise<QueryResult>;
-
-  /**
-   * Run a function inside a database transaction.
-   * The callback receives a transactional adapter with the same interface.
-   * If the callback throws, the transaction is automatically rolled back.
-   *
-   * @param fn - The transactional callback.
-   * @param options - Optional isolation level and timeout.
-   */
-  transaction<T>(fn: (txAdapter: DatabaseAdapter) => Promise<T>, options?: TransactionOptions): Promise<T>;
-
-  /**
-   * Eagerly warm up the connection pool.
-   * Forces at least one TCP handshake + auth so subsequent queries start instantly.
-   */
-  connect(): Promise<void>;
-
-  /**
-   * Gracefully close all connections in the pool.
-   */
-  disconnect(): Promise<void>;
-
-  /**
-   * Convert a JS array to the driver's preferred format for `= ANY($N)` queries.
-   *
-   * - **bun:sql**: Returns a PG array literal string `"{val1,val2,val3}"` because
-   *   bun:sql's extended query protocol sends values as strings.
-   * - **pg**: Returns the raw JS array (pg driver handles native array serialization).
-   */
-  formatArrayParam(values: unknown[]): unknown;
-};
-
-// ─── Query Result ─────────────────────────────────────────────────
-
-/**
- * Result from an unsafe query execution.
- * Contains both the rows returned and the number of affected rows
- * (parsed from the PostgreSQL CommandComplete tag).
- */
-export type QueryResult = {
-  rows: Record<string, unknown>[];
-  affectedRows: number;
-};
-
-// ─── SQL Executor (Migration Compatibility) ───────────────────────
-
-/**
- * Minimal SQL execution interface compatible with `@vibeorm/migrate`.
- * Adapters expose this via a helper function so migrations can run
- * without knowing which adapter is in use.
- *
- * @example
- * ```ts
- * import { bunAdapter } from "@vibeorm/adapter-bun";
- * import { toSqlExecutor } from "@vibeorm/runtime";
- *
- * const adapter = bunAdapter({ url: "postgres://..." });
- * const executor = toSqlExecutor({ adapter });
- * await applyMigration({ executor, migrationName: "init", sql, checksum });
- * ```
- */
-export type SqlExecutor = (params: {
-  text: string;
-  values?: unknown[];
-}) => Promise<Record<string, unknown>[]>;
-
-/**
- * Create an SqlExecutor from a DatabaseAdapter.
- * Bridges the adapter pattern with the migrate package's SqlExecutor interface.
- */
-export function toSqlExecutor(params: {
-  adapter: DatabaseAdapter;
-}): SqlExecutor {
-  const { adapter } = params;
-  return async (queryParams) => {
-    const result = await adapter.executeUnsafe({
-      text: queryParams.text,
-      values: queryParams.values,
-    });
-    return result.rows;
-  };
-}