@protobase/cli 0.8.0 → 0.8.1

package/dist/dev/entry.js

@@ -1,5 +1,5 @@
 import { loadProject, projectDb } from "./project.js";
-import { checkAuthSchema, configExports, createAdmin, hasUsers } from "@protobase/server";
+import { checkAuthSchema, checkChanges, configExports, createAdmin, hasUsers } from "@protobase/server";
 import { Hono } from "hono";
 //#region src/dev/entry.ts
 const projectDir = process.env.PROTOBASE_PROJECT;
@@ -12,6 +12,7 @@ if (project.auth && !store.__protobaseAuthSchemaChecked) {
 	await checkAuthSchema(project.auth);
 	store.__protobaseAuthSchemaChecked = true;
 }
+await checkChanges(db, resources.map((resource) => resource.toModel()), project.events);
 const admin = createAdmin({
 	resources,
 	views,
@@ -22,6 +23,7 @@ const admin = createAdmin({
 	...project.auth && { auth: project.auth },
 	...project.functions && { functions: project.functions },
 	...project.files && { files: project.files },
+	...project.events && { events: project.events },
 	options: {
 		onUnhandledError: (error) => console.error(error),
 		...project.options

package/dist/main.js

@@ -13,6 +13,7 @@ import { serveBundle } from "./serve/serve-bundle.js";
 import { serveBundleDir } from "./serve/serve-dir.js";
 import { registerOrganizations } from "./organizations/register.js";
 import { registerFiles } from "./files/register.js";
+import { registerMigration } from "./migration/register.js";
 import { registerToken, registerUsers } from "./users/register.js";
 import { statSync } from "node:fs";
 import path from "node:path";
@@ -89,6 +90,7 @@ registerUsers(program);
 registerOrganizations(program);
 registerToken(program);
 registerAuth(program);
+registerMigration(program);
 registerFiles(program);
 const run = (argv) => program.parseAsync(argv).catch((error) => {
 	process.stderr.write(`error: ${error.message}\n`);

package/dist/migration/load-project.js

@@ -0,0 +1,41 @@
+import { loadNearestEnvFile } from "../dev/env.js";
+import { importProjectFile } from "../project/import-project-file.js";
+import { createPgDb } from "../project/pg-db.js";
+import { existsSync } from "node:fs";
+import path from "node:path";
+import { configExports, mergeConfig } from "@protobase/server";
+import pg from "pg";
+//#region src/migration/load-project.ts
+const configOf = async (file) => (await importProjectFile(file)).default ?? {};
+/**
+* The project in `dir` as `protobase dev` merges it, for what its database needs: protobase.config.ts, or
+* config/index.ts when that has no `config`, after the configs of `extensions` and the configs it extends. `close`
+* ends the pool it opened; a `db` the project exports stays the project's.
+*/
+const loadMigrationProject = async (dir, extensions = []) => {
+	loadNearestEnvFile(dir);
+	const file = path.join(dir, "protobase.config.ts");
+	const custom = existsSync(file) ? await configOf(file) : {};
+	const index = path.join(dir, "config", "index.ts");
+	if (!custom.config && !existsSync(index)) throw new Error(`No config/index.ts or protobase.config.ts in ${dir}; run this inside a project`);
+	const own = {
+		...custom,
+		config: custom.config ?? await importProjectFile(index)
+	};
+	const extended = await Promise.all(extensions.flatMap((extension) => extension.config ? [configOf(extension.config)] : []));
+	const project = mergeConfig(...extended, own);
+	const url = process.env.DATABASE_URL;
+	if (!project.db && !url) throw new Error("No database: set DATABASE_URL or export `db` from protobase.config.ts");
+	const ownDb = project.db ? void 0 : createPgDb(pg, url);
+	return {
+		models: configExports(project.config ?? {}).resources.map((source) => source.toModel()),
+		db: project.db ?? ownDb,
+		...project.auth && { auth: project.auth },
+		...project.events && { events: project.events },
+		close: async () => {
+			await ownDb?.destroy();
+		}
+	};
+};
+//#endregion
+export { loadMigrationProject };

package/dist/migration/parts.js

@@ -0,0 +1,14 @@
+import { authSchemaMigration, changesMigration } from "@protobase/server";
+//#region src/migration/parts.ts
+/** Every feature the project's config enables, in the order their files are written. */
+const migrationParts = (project) => [...project.auth ? [{
+	name: "auth",
+	title: "The auth schema changes this version of Protobase needs",
+	sql: () => authSchemaMigration(project.auth)
+}] : [], {
+	name: "changes",
+	title: "The change capture the resources' events need",
+	sql: () => changesMigration(project.db, project.models, project.events)
+}];
+//#endregion
+export { migrationParts };

package/dist/migration/register.js

@@ -0,0 +1,22 @@
+import { resolveExtensions } from "../project/extensions.js";
+import { loadMigrationProject } from "./load-project.js";
+import { migrationParts } from "./parts.js";
+import { writeMigrations } from "./write-migrations.js";
+import path from "node:path";
+//#region src/migration/register.ts
+const out = (text) => process.stdout.write(text);
+const collect = (value, previous) => [...previous, value];
+const registerMigration = (program) => {
+	program.command("migration").description("Write what the database still needs for every feature the config enables (auth, events) as the project's next SQL migrations").option("--dir <dir>", "migrations folder", "db/migrations").option("--extend <dir>", "merge the protobase.config.ts in this folder before the project's, as dev and build do, repeatable", collect, []).action(async (opts) => {
+		const project = await loadMigrationProject(process.cwd(), resolveExtensions(opts.extend));
+		try {
+			const files = await writeMigrations(migrationParts(project), path.resolve(opts.dir));
+			out(files.length > 0 ? files.map((file) => `wrote ${path.relative(process.cwd(), file)}\n`).join("") + "apply them with the project's migrations\n" : "the database is up to date; nothing to write\n");
+		} finally {
+			await project.close();
+		}
+		process.exit(0);
+	});
+};
+//#endregion
+export { registerMigration };

package/dist/migration/write-migrations.js

@@ -0,0 +1,32 @@
+import { nextMigrationName } from "../auth/migration-file.js";
+import path from "node:path";
+import { mkdir, readdir, writeFile } from "node:fs/promises";
+//#region src/migration/write-migrations.ts
+/** A part's file: what wrote it and why, then its statements. */
+const partText = (title, sql) => `-- ${title}, written by \`protobase migration\`.\n-- Applied with the project's other migrations; edit or remove statements the project handles differently.\n\n${sql}\n`;
+/**
+* Writes what each part still needs as the next migrations in `dir`, one file per part, and returns their paths; none
+* when the database is current. Every part is compared with the database before any file is written, so the
+* project's earlier migrations must be applied to it first.
+*/
+const writeMigrations = async (parts, dir) => {
+	const pending = [];
+	for (const part of parts) {
+		const sql = await part.sql();
+		if (sql !== void 0) pending.push({
+			part,
+			sql
+		});
+	}
+	if (pending.length === 0) return [];
+	await mkdir(dir, { recursive: true });
+	const files = [];
+	for (const { part, sql } of pending) {
+		const file = path.join(dir, nextMigrationName(await readdir(dir), part.name));
+		await writeFile(file, partText(part.title, sql), { flag: "wx" });
+		files.push(file);
+	}
+	return files;
+};
+//#endregion
+export { partText, writeMigrations };

package/dist/package.js

@@ -1,4 +1,4 @@
 //#region package.json
-var version = "0.8.0";
+var version = "0.8.1";
 //#endregion
 export { version };

package/dist/serve/app.js

@@ -16,6 +16,7 @@ const createServeApp = ({ project, db, requestLog, site }) => {
 		...project.auth && { auth: project.auth },
 		...project.functions && { functions: project.functions },
 		...project.files && { files: project.files },
+		...project.events && { events: project.events },
 		options: {
 			onUnhandledError: (error) => console.error(error),
 			...project.options

package/dist/serve/lifecycle.js

@@ -1,7 +1,7 @@
 import { createPgDb } from "../project/pg-db.js";
 import { createServeApp } from "./app.js";
 import { startCleanupTimer } from "./cleanup-timer.js";
-import { checkAuthSchema, configExports, createFileCleanup } from "@protobase/server";
+import { checkAuthSchema, checkChanges, configExports, createFileCleanup } from "@protobase/server";
 import { createAdaptorServer } from "@hono/node-server";
 import pg from "pg";
 //#region src/serve/lifecycle.ts
@@ -18,6 +18,7 @@ const startServe = async ({ project, env, createDb = (url) => createPgDb(pg, url
 	if (project.auth) await checkAuthSchema(project.auth);
 	const ownDb = project.db ? void 0 : createDb(env.databaseUrl);
 	const db = project.db ?? ownDb;
+	const { resources } = configExports(project.config);
 	const app = createServeApp({
 		project,
 		db,
@@ -25,12 +26,12 @@ const startServe = async ({ project, env, createDb = (url) => createPgDb(pg, url
 		site
 	});
 	const server = createAdaptorServer({ fetch: app.fetch });
-	await listen(server, env.port).catch(async (error) => {
+	await checkChanges(db, resources.map((resource) => resource.toModel()), project.events).then(() => listen(server, env.port)).catch(async (error) => {
 		await ownDb?.destroy();
 		throw error;
 	});
 	const cleanup = createFileCleanup({
-		resources: configExports(project.config).resources,
+		resources,
 		db,
 		...project.files && { files: project.files }
 	});

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@protobase/cli",
-  "version": "0.8.0",
+  "version": "0.8.1",
   "description": "The protobase command: scaffold, doctor, dev, build and serve a Protobase project.",
   "license": "Apache-2.0",
   "repository": {
@@ -34,11 +34,11 @@
   "dependencies": {
     "@hono/node-server": "^2.1.3",
     "@hono/vite-dev-server": "^0.26.1",
-    "@protobase/layout": "0.8.0",
-    "@protobase/query": "0.8.0",
-    "@protobase/schema": "0.8.0",
-    "@protobase/server": "0.8.0",
-    "@protobase/ui": "0.8.0",
+    "@protobase/layout": "0.8.1",
+    "@protobase/query": "0.8.1",
+    "@protobase/schema": "0.8.1",
+    "@protobase/server": "0.8.1",
+    "@protobase/ui": "0.8.1",
     "@scalar/hono-api-reference": "^0.12.10",
     "@tailwindcss/vite": "^4.3.3",
     "@vitejs/plugin-react": "^6.1.2",