@authhero/kysely-adapter 12.9.0 → 12.10.0

package/dist/kysely-adapter.d.ts

@@ -1036,6 +1036,48 @@ interface Database {
 declare function migrateToLatest(db: Kysely<Database>, debug?: boolean): Promise<void>;
 declare function migrateDown(db: Kysely<Database>, debug?: boolean): Promise<void>;
 
+interface PlannedStatement {
+    sql: string;
+    parameters: readonly unknown[];
+}
+interface PlannedMigration {
+    name: string;
+    /** Writes (DDL and DML) the migration would execute, in order. */
+    statements: PlannedStatement[];
+    /**
+     * Set when the migration threw during planning. The statements captured
+     * before the failure are still listed. This can be a dry-run artifact: a
+     * migration that reads a column an earlier pending migration adds will fail
+     * here because the earlier migration was never applied.
+     */
+    error?: string;
+    /** True when planning stopped at MAX_STATEMENTS_PER_MIGRATION. */
+    truncated?: boolean;
+}
+interface MigrationPlan {
+    /** Migrations already recorded as executed, in order. */
+    executed: string[];
+    /** Migrations `migrateToLatest` would run, in order. */
+    pending: PlannedMigration[];
+}
+/**
+ * Dry run of `migrateToLatest`: lists the pending migrations and the SQL each
+ * would execute, without changing the database.
+ *
+ * Each pending migration's `up` runs against a wrapper around `db` that
+ * passes reads through and captures writes. Nothing is written — including
+ * the `kysely_migration` bookkeeping tables, which are only read if present.
+ *
+ * Because captured writes are never applied, the plan can diverge from a real
+ * run where a migration depends on its own or an earlier migration's writes:
+ * "tolerate duplicate column" guards never fire (so an already-present column
+ * still shows up as an ALTER), and reads of not-yet-created columns fail (see
+ * `PlannedMigration.error`).
+ */
+declare function planMigrations(db: Kysely<Database>): Promise<MigrationPlan>;
+/** Renders a plan as an SQL-ish script for printing. */
+declare function formatMigrationPlan(plan: MigrationPlan): string;
+
 declare function createProxyRoutesAdapter(db: Kysely<Database>): ProxyRoutesAdapter;
 
 /**
@@ -1050,5 +1092,5 @@ declare function createAdapters(db: Kysely<Database>, databaseOptions?: {
     useTransactions: boolean;
 }): DataAdapters;
 
-export { createProxyDataAdapter, createProxyRoutesAdapter, createAdapters as default, migrateDown, migrateToLatest };
-export type { Database };
+export { createProxyDataAdapter, createProxyRoutesAdapter, createAdapters as default, formatMigrationPlan, migrateDown, migrateToLatest, planMigrations };
+export type { Database, MigrationPlan, PlannedMigration, PlannedStatement };