@authhero/kysely-adapter 12.9.0 → 12.10.0

package/dist/types/migrate/plan.d.ts

@@ -0,0 +1,43 @@
+import { Kysely } from "kysely";
+import { Database } from "../src/db";
+export interface PlannedStatement {
+    sql: string;
+    parameters: readonly unknown[];
+}
+export 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;
+}
+export 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`).
+ */
+export declare function planMigrations(db: Kysely<Database>): Promise<MigrationPlan>;
+/** Renders a plan as an SQL-ish script for printing. */
+export declare function formatMigrationPlan(plan: MigrationPlan): string;

package/dist/types/src/index.d.ts

@@ -2,6 +2,8 @@ import { Kysely } from "kysely";
 import { Database } from "./db";
 import { DataAdapters } from "@authhero/adapter-interfaces";
 export { migrateToLatest, migrateDown } from "../migrate/migrate";
+export { planMigrations, formatMigrationPlan } from "../migrate/plan";
+export type { MigrationPlan, PlannedMigration, PlannedStatement, } from "../migrate/plan";
 export type { Database } from "./db";
 export { createProxyRoutesAdapter, createProxyDataAdapter, } from "./proxyRoutes";
 export default function createAdapters(db: Kysely<Database>, databaseOptions?: {