@zeno-lib/db 0.6.0 → 0.7.0

package/dist/config.d.mts

@@ -15,6 +15,13 @@ import { Config, defineConfig } from "drizzle-kit";
  * Verified against Supabase CLI 2.84.1 / Postgres 17.
  */
 declare const supabaseManagedRoles: readonly ["pg_checkpoint", "pg_database_owner", "pg_execute_server_program", "pg_monitor", "pg_read_all_data", "pg_read_all_settings", "pg_read_all_stats", "pg_read_server_files", "pg_signal_backend", "pg_stat_scan_tables", "pg_write_all_data", "pg_write_server_files", "pgbouncer", "postgres", "supabase_functions_admin", "supabase_read_only_user", "supabase_realtime_admin", "supabase_replication_admin"];
-declare function defineDrizzleConfig(overrides?: Partial<Config>): ReturnType<typeof defineConfig>;
+/**
+ * Drizzle Kit config for migrations the Supabase CLI applies.
+ * Moves each generated `<name>/migration.sql` to `<name>.sql` when `drizzle-kit generate` exits.
+ * Set `moveGeneratedSql: false` if `drizzle-kit migrate` applies them instead.
+ */
+declare function defineDrizzleConfig(overrides?: Partial<Config> & {
+  moveGeneratedSql?: boolean;
+}): ReturnType<typeof defineConfig>;
 //#endregion
 export { defineDrizzleConfig, supabaseManagedRoles };

package/dist/config.mjs

@@ -1,4 +1,41 @@
 import { defineConfig } from "drizzle-kit";
+import { existsSync, readdirSync, renameSync } from "node:fs";
+import { join } from "node:path";
+import { styleText } from "node:util";
+//#region src/move-generated-sql.ts
+const GENERATED_SQL = "migration.sql";
+/**
+* Move each `<name>/migration.sql` to `<name>.sql`,
+* because the Supabase CLI only reads `.sql` files at the top of the folder.
+* Throws if a `<name>.sql` already exists.
+*/
+function moveGeneratedSql(options) {
+	const { migrationsDir } = options;
+	const names = existsSync(migrationsDir) ? readdirSync(migrationsDir).filter((name) => existsSync(join(migrationsDir, name, GENERATED_SQL))).sort() : [];
+	const taken = names.map((name) => join(migrationsDir, `${name}.sql`)).filter((target) => existsSync(target));
+	if (taken.length > 0) throw new Error(`Cannot move the generated SQL, because these files already exist: ${taken.join(", ")}`);
+	return { moved: names.map((name) => {
+		const target = join(migrationsDir, `${name}.sql`);
+		renameSync(join(migrationsDir, name, GENERATED_SQL), target);
+		return target;
+	}) };
+}
+/** Run `moveGeneratedSql` when `drizzle-kit generate` exits. */
+function moveGeneratedSqlAfterGenerate(options) {
+	if (process.argv[2] !== "generate") return;
+	process.once("exit", (code) => {
+		if (code !== 0) return;
+		try {
+			const check = styleText("green", "✓", { stream: process.stderr });
+			for (const path of moveGeneratedSql(options).moved) console.error(`${check} Moved the generated SQL to ${path}`);
+		} catch (error) {
+			const message = error instanceof Error ? error.message : String(error);
+			console.error(styleText("red", `✗ ${message}`, { stream: process.stderr }));
+			process.exitCode = 1;
+		}
+	});
+}
+//#endregion
 //#region src/config.ts
 /**
 * Roles a Supabase project ships that drizzle-kit's `provider: "supabase"` does
@@ -40,10 +77,15 @@ const supabaseManagedRoles = [
 * never right. Add your own schemas here rather than dropping the filter.
 */
 const DEFAULT_SCHEMA_FILTER = ["public"];
+/**
+* Drizzle Kit config for migrations the Supabase CLI applies.
+* Moves each generated `<name>/migration.sql` to `<name>.sql` when `drizzle-kit generate` exits.
+* Set `moveGeneratedSql: false` if `drizzle-kit migrate` applies them instead.
+*/
 function defineDrizzleConfig(overrides = {}) {
-	const { entities, ...configOverrides } = overrides;
+	const { entities, moveGeneratedSql = true, ...configOverrides } = overrides;
 	const roleOverrides = typeof entities?.roles === "object" ? entities.roles : {};
-	return defineConfig({
+	const config = defineConfig({
 		dbCredentials: { url: process.env.SUPABASE_DATABASE_URL ?? "" },
 		dialect: "postgresql",
 		entities: {
@@ -59,6 +101,8 @@ function defineDrizzleConfig(overrides = {}) {
 		schemaFilter: DEFAULT_SCHEMA_FILTER,
 		...configOverrides
 	});
+	if (moveGeneratedSql && config.out) moveGeneratedSqlAfterGenerate({ migrationsDir: config.out });
+	return config;
 }
 //#endregion
 export { defineDrizzleConfig, supabaseManagedRoles };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@zeno-lib/db",
-  "version": "0.6.0",
+  "version": "0.7.0",
   "type": "module",
   "exports": {
     ".": {
@@ -92,7 +92,6 @@
     "stop": "pnpm exec supabase stop",
     "reset": "pnpm exec supabase db reset",
     "db:generate": "drizzle-kit generate",
-    "db:migrate": "drizzle-kit migrate",
     "db:push": "drizzle-kit push",
     "db:studio": "drizzle-kit studio",
     "test": "vitest --run",

package/src/config.ts

@@ -1,6 +1,7 @@
 // https://orm.drizzle.team/docs/drizzle-config-file
 // https://orm.drizzle.team/docs/rls#migrations  (entities.roles.provider: "supabase")
 import { type Config, defineConfig } from "drizzle-kit"
+import { moveGeneratedSqlAfterGenerate } from "./move-generated-sql.ts"
 
 /**
  * Roles a Supabase project ships that drizzle-kit's `provider: "supabase"` does
@@ -44,17 +45,22 @@ export const supabaseManagedRoles = [
  */
 const DEFAULT_SCHEMA_FILTER = ["public"]
 
+/**
+ * Drizzle Kit config for migrations the Supabase CLI applies.
+ * Moves each generated `<name>/migration.sql` to `<name>.sql` when `drizzle-kit generate` exits.
+ * Set `moveGeneratedSql: false` if `drizzle-kit migrate` applies them instead.
+ */
 export function defineDrizzleConfig(
-  overrides: Partial<Config> = {}
+  overrides: Partial<Config> & { moveGeneratedSql?: boolean } = {}
 ): ReturnType<typeof defineConfig> {
-  const { entities, ...configOverrides } = overrides
+  const { entities, moveGeneratedSql = true, ...configOverrides } = overrides
   // `entities.roles` may be a boolean (`true`) in drizzle-kit config; in that
   // form there are no role options to preserve, so we only merge the object
   // form. The `provider: "supabase"` flag below is always enforced regardless.
   const roleOverrides =
     typeof entities?.roles === "object" ? entities.roles : {}
 
-  return defineConfig({
+  const config = defineConfig({
     dbCredentials: { url: process.env.SUPABASE_DATABASE_URL ?? "" },
     dialect: "postgresql",
     // Tells drizzle-kit that Supabase's built-in roles (anon, authenticated,
@@ -74,4 +80,10 @@ export function defineDrizzleConfig(
     schemaFilter: DEFAULT_SCHEMA_FILTER,
     ...configOverrides,
   } as Config)
+
+  if (moveGeneratedSql && config.out) {
+    moveGeneratedSqlAfterGenerate({ migrationsDir: config.out })
+  }
+
+  return config
 }

package/src/move-generated-sql.test.ts

@@ -0,0 +1,98 @@
+import {
+  mkdirSync,
+  mkdtempSync,
+  readdirSync,
+  readFileSync,
+  rmSync,
+  writeFileSync,
+} from "node:fs"
+import { tmpdir } from "node:os"
+import { join } from "node:path"
+import { afterEach, beforeEach, describe, expect, it } from "vitest"
+import { moveGeneratedSql } from "./move-generated-sql.ts"
+
+const POSTS = "20260102030405_posts"
+const COMMENTS = "20260102030406_comments"
+
+let migrationsDir: string
+
+beforeEach(() => {
+  migrationsDir = mkdtempSync(join(tmpdir(), "zeno-db-migrations-"))
+})
+
+afterEach(() => {
+  rmSync(migrationsDir, { force: true, recursive: true })
+})
+
+// Write `<name>/migration.sql` and `<name>/snapshot.json`, as `drizzle-kit generate` does.
+function generated(name: string): void {
+  mkdirSync(join(migrationsDir, name))
+  writeFileSync(join(migrationsDir, name, "migration.sql"), `-- ${name}`)
+  writeFileSync(join(migrationsDir, name, "snapshot.json"), "{}")
+}
+
+// The migrations folder, sorted.
+const files = () => readdirSync(migrationsDir).sort()
+
+const read = (name: string) => readFileSync(join(migrationsDir, name), "utf-8")
+
+describe("moveGeneratedSql", () => {
+  it("moves migration.sql next to its folder", () => {
+    generated(POSTS)
+
+    moveGeneratedSql({ migrationsDir })
+
+    expect(files()).toEqual([POSTS, `${POSTS}.sql`])
+    expect(readdirSync(join(migrationsDir, POSTS))).toEqual(["snapshot.json"])
+    expect(read(`${POSTS}.sql`)).toBe(`-- ${POSTS}`)
+  })
+
+  it("returns the new paths in name order", () => {
+    generated(COMMENTS)
+    generated(POSTS)
+
+    expect(moveGeneratedSql({ migrationsDir })).toEqual({
+      moved: [
+        join(migrationsDir, `${POSTS}.sql`),
+        join(migrationsDir, `${COMMENTS}.sql`),
+      ],
+    })
+  })
+
+  it("moves nothing on a second run", () => {
+    generated(POSTS)
+    moveGeneratedSql({ migrationsDir })
+
+    expect(moveGeneratedSql({ migrationsDir })).toEqual({ moved: [] })
+  })
+
+  it("leaves a hand-written .sql file alone", () => {
+    generated(POSTS)
+    writeFileSync(join(migrationsDir, "20260102030407_grants.sql"), "grant;")
+
+    moveGeneratedSql({ migrationsDir })
+
+    expect(files()).toEqual([
+      POSTS,
+      `${POSTS}.sql`,
+      "20260102030407_grants.sql",
+    ])
+    expect(read("20260102030407_grants.sql")).toBe("grant;")
+  })
+
+  it("throws before moving anything when a .sql file is in the way", () => {
+    generated(POSTS)
+    generated(COMMENTS)
+    writeFileSync(join(migrationsDir, `${COMMENTS}.sql`), "-- edited by hand")
+
+    expect(() => moveGeneratedSql({ migrationsDir })).toThrow(`${COMMENTS}.sql`)
+    expect(files()).toEqual([POSTS, COMMENTS, `${COMMENTS}.sql`])
+    expect(read(`${COMMENTS}.sql`)).toBe("-- edited by hand")
+  })
+
+  it("returns nothing for a missing folder", () => {
+    expect(
+      moveGeneratedSql({ migrationsDir: join(migrationsDir, "missing") })
+    ).toEqual({ moved: [] })
+  })
+})

package/src/move-generated-sql.ts

@@ -0,0 +1,80 @@
+import { existsSync, readdirSync, renameSync } from "node:fs"
+import { join } from "node:path"
+import { styleText } from "node:util"
+
+export type MoveGeneratedSqlOptions = {
+  /** drizzle-kit writes migrations to this folder. */
+  migrationsDir: string
+}
+
+export type MoveGeneratedSqlResult = {
+  /** The new paths of the SQL files, sorted by name. */
+  moved: string[]
+}
+
+const GENERATED_SQL = "migration.sql"
+
+/**
+ * Move each `<name>/migration.sql` to `<name>.sql`,
+ * because the Supabase CLI only reads `.sql` files at the top of the folder.
+ * Throws if a `<name>.sql` already exists.
+ */
+export function moveGeneratedSql(
+  options: MoveGeneratedSqlOptions
+): MoveGeneratedSqlResult {
+  const { migrationsDir } = options
+
+  const names = existsSync(migrationsDir)
+    ? readdirSync(migrationsDir)
+        .filter((name) => existsSync(join(migrationsDir, name, GENERATED_SQL)))
+        .sort()
+    : []
+
+  const taken = names
+    .map((name) => join(migrationsDir, `${name}.sql`))
+    .filter((target) => existsSync(target))
+  if (taken.length > 0) {
+    throw new Error(
+      `Cannot move the generated SQL, because these files already exist: ${taken.join(", ")}`
+    )
+  }
+
+  const moved = names.map((name) => {
+    const target = join(migrationsDir, `${name}.sql`)
+    renameSync(join(migrationsDir, name, GENERATED_SQL), target)
+    return target
+  })
+
+  return { moved }
+}
+
+/** Run `moveGeneratedSql` when `drizzle-kit generate` exits. */
+export function moveGeneratedSqlAfterGenerate(
+  options: MoveGeneratedSqlOptions
+): void {
+  // drizzle-kit loads the config for every command.
+  // Only `generate` writes a migration.
+  if (process.argv[2] !== "generate") {
+    return
+  }
+
+  process.once("exit", (code) => {
+    if (code !== 0) {
+      return
+    }
+
+    // Print to stderr, so the JSON from `--output json` on stdout stays valid.
+    try {
+      const check = styleText("green", "✓", { stream: process.stderr })
+      for (const path of moveGeneratedSql(options).moved) {
+        console.error(`${check} Moved the generated SQL to ${path}`)
+      }
+    } catch (error) {
+      const message = error instanceof Error ? error.message : String(error)
+      console.error(
+        styleText("red", `✗ ${message}`, { stream: process.stderr })
+      )
+      process.exitCode = 1
+    }
+  })
+}