sailfork / t3code-github / .repos/ effect/ packages/ sql/ sqlite-wasm/ src/ SqliteMigrator.ts

/**
 * Utilities for applying Effect SQL migrations to SQLite WASM databases.
 *
 * This module re-exports the shared `Migrator` loaders and error types, then
 * provides `run` and `layer` helpers that execute ordered migrations through the
 * current SQLite WASM `SqlClient`. Use it when a browser, worker, or test
 * runtime needs to create or upgrade a local SQLite schema before repositories,
 * caches, sync services, or other database-backed services start.
 *
 * The migrator operates on whichever WASM client is in the environment. With
 * `SqliteClient.makeMemory`, migrations update an in-memory database, so the
 * resulting schema is transient unless you persist it with the client's
 * `export` and `import` operations. With worker-backed OPFS databases, run the
 * migrator against the same worker configuration and OPFS database name used by
 * the rest of the application, and coordinate startup across tabs or workers so
 * only one migrator upgrades a given database at a time. OPFS availability is
 * browser- and origin-dependent, and this adapter does not currently write
 * SQLite schema dumps for `schemaDirectory`.
 *
 * @stability unstable
 * @since 4.0.0
 */
import type * as Effect from "effect/Effect"
import * as Layer from "effect/Layer"
import * as Migrator from "effect/sql/Migrator"
import type * as Client from "effect/sql/SqlClient"
import type { SqlError } from "effect/sql/SqlError"

/**
 * @since 4.0.0
 */
export * from "effect/sql/Migrator"
export {
  /**
   * @stability unstable
   * @category loaders
   * @since 4.0.0
   */
  fromFileSystem
} from "effect/sql/MigratorFileSystem"

/**
 * Runs SQL migrations for a SQLite WASM database using the shared `Migrator` implementation and the current `SqlClient`.
 *
 * @stability unstable
 * @category running
 * @since 4.0.0
 */
export const run: <R>(
  options: Migrator.MigratorOptions<R>
) => Effect.Effect<
  ReadonlyArray<readonly [id: number, name: string]>,
  SqlError | Migrator.MigrationError,
  Client.SqlClient | R
> = Migrator.make({})

/**
 * Creates a layer that runs the configured SQLite WASM migrations during layer construction and provides no services.
 *
 * @stability unstable
 * @category layers
 * @since 4.0.0
 */
export const layer = <R>(
  options: Migrator.MigratorOptions<R>
): Layer.Layer<never, SqlError | Migrator.MigrationError, R | Client.SqlClient> => Layer.effectDiscard(run(options))