tempest-db-js 0.5.0 → 0.7.0

package/dist/migrations/index.d.cts

@@ -399,6 +399,40 @@ declare function sqliteAffinity(declared: string): SqliteAffinity;
  */
 declare function introspectSqlite(driver: SyncDriver): SchemaIR;
 declare function checkDrift(driver: SyncDriver, models: readonly ModelClass[]): string[];
+/**
+ * Compare an introspected SQLite schema against the reflected models.
+ *
+ * Split out from {@link checkDrift} so the sync and async drivers share one
+ * comparison — a second copy would drift from this one the first time a rule
+ * changes.
+ *
+ * @param actual The schema read from the database.
+ * @param expected The schema reflected from the models.
+ * @returns A list of human-readable drift messages — empty means no drift.
+ */
+declare function compareSqliteSchemas(actual: SchemaIR, expected: SchemaIR): string[];
+/**
+ * Read the current SQLite schema into a `SchemaIR` over an **async** driver.
+ *
+ * The sequencing differs from {@link introspectSqlite} — each `PRAGMA` depends on
+ * the previous result, so it cannot be one awaited batch — but every row → IR
+ * mapping is the shared code above.
+ *
+ * @param driver An async SQLite driver.
+ * @returns The introspected schema.
+ */
+declare function introspectSqliteAsync(driver: AsyncDriver): Promise<SchemaIR>;
+/**
+ * Drift check over an **async** driver, routed by dialect. This is what
+ * `tempest-db check` runs, so the CLI reaches the same comparison for every
+ * supported database instead of only SQLite.
+ *
+ * @param driver An async driver for the live database.
+ * @param dialect The dialect the driver speaks.
+ * @param models The model classes that define the intended schema.
+ * @returns A list of drift messages — empty means no drift.
+ */
+declare function checkDriftAsync(driver: AsyncDriver, dialect: Dialect, models: readonly ModelClass[]): Promise<string[]>;
 /**
  * Read the current PostgreSQL schema into a `SchemaIR` from `information_schema`.
  *
@@ -500,7 +534,12 @@ declare function applyRenames(ops: readonly Operation[], confirmed: readonly Ren
 
 /** Configuration the CLI operates against. */
 interface CliConfig {
-    readonly driver: SyncDriver;
+    /**
+     * The driver for the live database — sync (SQLite) or async (PostgreSQL,
+     * MySQL). Both are accepted: the CLI adapts either to the async runner, so a
+     * Postgres migration runs through the same commands as a SQLite one.
+     */
+    readonly driver: SyncDriver | AsyncDriver;
     readonly dialect: Dialect;
     readonly migrations: readonly Migration[];
     readonly models?: readonly ModelClass[];
@@ -542,10 +581,14 @@ declare function defineMigrationConfig(config: CliConfig): CliConfig;
  * Commands: `current`, `history`, `heads`, `upgrade [--sql]`, `downgrade [N]`,
  * `check`, `revision -m <msg> [--autogenerate]`.
  *
+ * Async for every dialect: the config's driver is adapted with
+ * {@link toAsyncDriver}, so SQLite and PostgreSQL take the same path and the CLI
+ * is not silently SQLite-only.
+ *
  * @param argv The command and its arguments (without the program name).
  * @param config The driver, migrations, and models to operate on.
  * @returns Output lines and an exit code.
  */
-declare function runMigrationCli(argv: readonly string[], config: CliConfig): CliResult;
+declare function runMigrationCli(argv: readonly string[], config: CliConfig): Promise<CliResult>;
 
-export { AsyncMigrationRunner, type CliConfig, type CliResult, type ColumnIR, CyclicMigrationGraph, type DefaultIR, type ForeignKeyIR, IrreversibleMigration, type Migration, type MigrationDraft, MigrationRunner, type NamedConstraint, Op, type Operation, type RenameCandidate, type RevisionNode, type SchemaIR, type SqliteAffinity, type TableIR, type UniqueConstraintIR, UnknownRevision, applyOperation, applyRenames, checkDrift, checkDriftPostgres, defineMigrationConfig, detectRenames, diffSchema, emptySchema, generateMigration, heads, introspectPostgres, introspectSqlite, invert, invertAll, makeRevisionId, reflectSchema, reflectTable, renderColumnDef, renderColumnType, renderDefault, renderOperation, replaySchema, runMigrationCli, sqliteAffinity, topoOrder };
+export { AsyncMigrationRunner, type CliConfig, type CliResult, type ColumnIR, CyclicMigrationGraph, type DefaultIR, type ForeignKeyIR, IrreversibleMigration, type Migration, type MigrationDraft, MigrationRunner, type NamedConstraint, Op, type Operation, type RenameCandidate, type RevisionNode, type SchemaIR, type SqliteAffinity, type TableIR, type UniqueConstraintIR, UnknownRevision, applyOperation, applyRenames, checkDrift, checkDriftAsync, checkDriftPostgres, compareSqliteSchemas, defineMigrationConfig, detectRenames, diffSchema, emptySchema, generateMigration, heads, introspectPostgres, introspectSqlite, introspectSqliteAsync, invert, invertAll, makeRevisionId, reflectSchema, reflectTable, renderColumnDef, renderColumnType, renderDefault, renderOperation, replaySchema, runMigrationCli, sqliteAffinity, topoOrder };

package/dist/migrations/index.d.ts

@@ -399,6 +399,40 @@ declare function sqliteAffinity(declared: string): SqliteAffinity;
  */
 declare function introspectSqlite(driver: SyncDriver): SchemaIR;
 declare function checkDrift(driver: SyncDriver, models: readonly ModelClass[]): string[];
+/**
+ * Compare an introspected SQLite schema against the reflected models.
+ *
+ * Split out from {@link checkDrift} so the sync and async drivers share one
+ * comparison — a second copy would drift from this one the first time a rule
+ * changes.
+ *
+ * @param actual The schema read from the database.
+ * @param expected The schema reflected from the models.
+ * @returns A list of human-readable drift messages — empty means no drift.
+ */
+declare function compareSqliteSchemas(actual: SchemaIR, expected: SchemaIR): string[];
+/**
+ * Read the current SQLite schema into a `SchemaIR` over an **async** driver.
+ *
+ * The sequencing differs from {@link introspectSqlite} — each `PRAGMA` depends on
+ * the previous result, so it cannot be one awaited batch — but every row → IR
+ * mapping is the shared code above.
+ *
+ * @param driver An async SQLite driver.
+ * @returns The introspected schema.
+ */
+declare function introspectSqliteAsync(driver: AsyncDriver): Promise<SchemaIR>;
+/**
+ * Drift check over an **async** driver, routed by dialect. This is what
+ * `tempest-db check` runs, so the CLI reaches the same comparison for every
+ * supported database instead of only SQLite.
+ *
+ * @param driver An async driver for the live database.
+ * @param dialect The dialect the driver speaks.
+ * @param models The model classes that define the intended schema.
+ * @returns A list of drift messages — empty means no drift.
+ */
+declare function checkDriftAsync(driver: AsyncDriver, dialect: Dialect, models: readonly ModelClass[]): Promise<string[]>;
 /**
  * Read the current PostgreSQL schema into a `SchemaIR` from `information_schema`.
  *
@@ -500,7 +534,12 @@ declare function applyRenames(ops: readonly Operation[], confirmed: readonly Ren
 
 /** Configuration the CLI operates against. */
 interface CliConfig {
-    readonly driver: SyncDriver;
+    /**
+     * The driver for the live database — sync (SQLite) or async (PostgreSQL,
+     * MySQL). Both are accepted: the CLI adapts either to the async runner, so a
+     * Postgres migration runs through the same commands as a SQLite one.
+     */
+    readonly driver: SyncDriver | AsyncDriver;
     readonly dialect: Dialect;
     readonly migrations: readonly Migration[];
     readonly models?: readonly ModelClass[];
@@ -542,10 +581,14 @@ declare function defineMigrationConfig(config: CliConfig): CliConfig;
  * Commands: `current`, `history`, `heads`, `upgrade [--sql]`, `downgrade [N]`,
  * `check`, `revision -m <msg> [--autogenerate]`.
  *
+ * Async for every dialect: the config's driver is adapted with
+ * {@link toAsyncDriver}, so SQLite and PostgreSQL take the same path and the CLI
+ * is not silently SQLite-only.
+ *
  * @param argv The command and its arguments (without the program name).
  * @param config The driver, migrations, and models to operate on.
  * @returns Output lines and an exit code.
  */
-declare function runMigrationCli(argv: readonly string[], config: CliConfig): CliResult;
+declare function runMigrationCli(argv: readonly string[], config: CliConfig): Promise<CliResult>;
 
-export { AsyncMigrationRunner, type CliConfig, type CliResult, type ColumnIR, CyclicMigrationGraph, type DefaultIR, type ForeignKeyIR, IrreversibleMigration, type Migration, type MigrationDraft, MigrationRunner, type NamedConstraint, Op, type Operation, type RenameCandidate, type RevisionNode, type SchemaIR, type SqliteAffinity, type TableIR, type UniqueConstraintIR, UnknownRevision, applyOperation, applyRenames, checkDrift, checkDriftPostgres, defineMigrationConfig, detectRenames, diffSchema, emptySchema, generateMigration, heads, introspectPostgres, introspectSqlite, invert, invertAll, makeRevisionId, reflectSchema, reflectTable, renderColumnDef, renderColumnType, renderDefault, renderOperation, replaySchema, runMigrationCli, sqliteAffinity, topoOrder };
+export { AsyncMigrationRunner, type CliConfig, type CliResult, type ColumnIR, CyclicMigrationGraph, type DefaultIR, type ForeignKeyIR, IrreversibleMigration, type Migration, type MigrationDraft, MigrationRunner, type NamedConstraint, Op, type Operation, type RenameCandidate, type RevisionNode, type SchemaIR, type SqliteAffinity, type TableIR, type UniqueConstraintIR, UnknownRevision, applyOperation, applyRenames, checkDrift, checkDriftAsync, checkDriftPostgres, compareSqliteSchemas, defineMigrationConfig, detectRenames, diffSchema, emptySchema, generateMigration, heads, introspectPostgres, introspectSqlite, introspectSqliteAsync, invert, invertAll, makeRevisionId, reflectSchema, reflectTable, renderColumnDef, renderColumnType, renderDefault, renderOperation, replaySchema, runMigrationCli, sqliteAffinity, topoOrder };

package/dist/migrations/index.js

@@ -1,4 +1,4 @@
-export { AsyncMigrationRunner, CyclicMigrationGraph, IrreversibleMigration, MigrationRunner, Op, UnknownRevision, applyOperation, applyRenames, checkDrift, checkDriftPostgres, defineMigrationConfig, detectRenames, diffSchema, emptySchema, generateMigration, heads, introspectPostgres, introspectSqlite, invert, invertAll, makeRevisionId, reflectSchema, reflectTable, renderColumnDef, renderColumnType, renderDefault, renderOperation, replaySchema, runMigrationCli, sqliteAffinity, topoOrder } from '../chunk-EPMLFNFK.js';
-import '../chunk-5QQMVTS5.js';
+export { AsyncMigrationRunner, CyclicMigrationGraph, IrreversibleMigration, MigrationRunner, Op, UnknownRevision, applyOperation, applyRenames, checkDrift, checkDriftAsync, checkDriftPostgres, compareSqliteSchemas, defineMigrationConfig, detectRenames, diffSchema, emptySchema, generateMigration, heads, introspectPostgres, introspectSqlite, introspectSqliteAsync, invert, invertAll, makeRevisionId, reflectSchema, reflectTable, renderColumnDef, renderColumnType, renderDefault, renderOperation, replaySchema, runMigrationCli, sqliteAffinity, topoOrder } from '../chunk-SI4CLSF7.js';
+import '../chunk-4AWUP7BM.js';
 //# sourceMappingURL=index.js.map
 //# sourceMappingURL=index.js.map

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "tempest-db-js",
-  "version": "0.5.0",
+  "version": "0.7.0",
   "description": "Type-safe, class-based ORM for TypeScript — SQLAlchemy 2.0 ergonomics for the JS/TS world.",
   "type": "module",
   "sideEffects": false,
@@ -62,6 +62,7 @@
     "better-sqlite3": "^12.11.1",
     "drizzle-orm": "^0.45.2",
     "kysely": "^0.29.2",
+    "mysql2": "^3.11.5",
     "postgres": "^3.4.5",
     "tsup": "^8.3.0",
     "typescript": "^5.9.3",
@@ -69,12 +70,16 @@
   },
   "peerDependencies": {
     "better-sqlite3": "*",
+    "mysql2": "*",
     "postgres": "*"
   },
   "peerDependenciesMeta": {
     "better-sqlite3": {
       "optional": true
     },
+    "mysql2": {
+      "optional": true
+    },
     "postgres": {
       "optional": true
     }