@protobase/cli 0.5.0 → 0.6.0

package/dist/auth/migration-file.js

@@ -0,0 +1,18 @@
+//#region src/auth/migration-file.ts
+const numbered = /^(\d+)_.*\.sql$/;
+const namePart = /^[a-z0-9][a-z0-9_-]*$/;
+/**
+* The name of the next migration in a folder holding `files`: one past the highest number, as wide as the widest
+* (`009_…` after `008_…`; three digits in an empty folder), then `name`.
+*/
+const nextMigrationName = (files, name) => {
+	if (!namePart.test(name)) throw new Error(`Invalid migration name "${name}": use lowercase letters, digits, "_" or "-"`);
+	const numbers = files.map((file) => numbered.exec(file)?.[1]).filter((found) => found !== void 0);
+	const next = Math.max(0, ...numbers.map(Number)) + 1;
+	const width = Math.max(3, ...numbers.map((found) => found.length));
+	return `${String(next).padStart(width, "0")}_${name}.sql`;
+};
+/** The file's contents: what wrote it and why, then Better Auth's statements, one per paragraph. */
+const migrationText = (sql) => `-- The auth schema changes this version of Protobase needs, written by \`protobase auth migration\`.\n-- Applied with the project's other migrations; edit or remove statements the project handles differently.\n\n${sql}\n`;
+//#endregion
+export { migrationText, nextMigrationName };

package/dist/auth/register.js

@@ -0,0 +1,18 @@
+import { loadProjectAuth } from "../users/load-auth.js";
+import { writeAuthMigration } from "./write-migration.js";
+import path from "node:path";
+//#region src/auth/register.ts
+const out = (text) => process.stdout.write(text);
+const registerAuth = (program) => {
+	program.command("auth").description("The auth schema of the project in the current directory").command("migration").description("Write the auth schema changes this Protobase version needs as the project's next SQL migration, compared with its database").option("--dir <dir>", "migrations folder", "db/migrations").option("--name <name>", "file name after the number", "auth").action(async (opts) => {
+		const file = await writeAuthMigration({
+			auth: await loadProjectAuth(process.cwd()),
+			dir: path.resolve(opts.dir),
+			name: opts.name
+		});
+		out(file ? `wrote ${path.relative(process.cwd(), file)}; apply it with the project's migrations\n` : "the auth schema is up to date; nothing to write\n");
+		process.exit(0);
+	});
+};
+//#endregion
+export { registerAuth };

package/dist/auth/write-migration.js

@@ -0,0 +1,20 @@
+import { migrationText, nextMigrationName } from "./migration-file.js";
+import path from "node:path";
+import { mkdir, readdir, writeFile } from "node:fs/promises";
+import { authSchemaMigration } from "@protobase/server";
+//#region src/auth/write-migration.ts
+/**
+* Writes the auth schema changes the database still needs as the next migration in `dir`, and returns its path;
+* `undefined` when the database is current. The changes are found by comparing the database with what Better Auth
+* needs, so the project's earlier migrations must be applied to it first.
+*/
+const writeAuthMigration = async ({ auth, dir, name }) => {
+	const sql = await authSchemaMigration(auth);
+	if (sql === void 0) return void 0;
+	await mkdir(dir, { recursive: true });
+	const file = path.join(dir, nextMigrationName(await readdir(dir), name));
+	await writeFile(file, migrationText(sql), { flag: "wx" });
+	return file;
+};
+//#endregion
+export { writeAuthMigration };

package/dist/build/vite-bundle.js

@@ -1,8 +1,8 @@
 import { bunBuild } from "./bun-build.js";
 import path from "node:path";
+import { build } from "vite";
 import { mkdtemp, rm } from "node:fs/promises";
 import { tmpdir } from "node:os";
-import { build } from "vite";
 //#region src/build/vite-bundle.ts
 const viteBuild = async ({ root, entry, outFile, plugins, logLevel = "warn" }) => {
 	await build({

package/dist/dev/entry.js

@@ -1,12 +1,17 @@
 import { loadProject, projectDb } from "./project.js";
+import { checkAuthSchema, configExports, createAdmin, hasUsers } from "@protobase/server";
 import { Hono } from "hono";
-import { configExports, createAdmin, hasUsers } from "@protobase/server";
 //#region src/dev/entry.ts
 const projectDir = process.env.PROTOBASE_PROJECT;
 const project = await loadProject(projectDir, JSON.parse(process.env.PROTOBASE_EXTENSIONS ?? "[]"));
 const db = projectDb(project, projectDir);
 const { resources, views, pages, userMenu } = configExports(project.exports);
 if (!project.authenticate) throw new Error("No authenticator: export `authenticate` (and `auth`) from protobase.config.ts; see https://docs.protobase.net/reference/auth/");
+const store = globalThis;
+if (project.auth && !store.__protobaseAuthSchemaChecked) {
+	await checkAuthSchema(project.auth);
+	store.__protobaseAuthSchemaChecked = true;
+}
 const admin = createAdmin({
 	resources,
 	views,
@@ -21,7 +26,6 @@ const admin = createAdmin({
 	}
 });
 var entry_default = new Hono().route("/", admin);
-const store = globalThis;
 if (project.auth && !store.__protobaseNoUsersShown) {
 	store.__protobaseNoUsersShown = true;
 	hasUsers(project.auth).then((any) => {

package/dist/dev/run.js

@@ -1,9 +1,9 @@
+import { loadNearestEnvFile } from "./env.js";
 import { adminAppDir, adminAppMain, uiPackageDir } from "../project/admin-app.js";
 import { extensionImports, extensionStyles } from "../project/extensions.js";
 import { moduleFile } from "../module-file.js";
 import { layoutCheck } from "../build/layout-check.js";
 import { projectUiPlugin } from "../project/project-ui.js";
-import { loadNearestEnvFile } from "./env.js";
 import { checkDatabase } from "./check-database.js";
 import { existsSync } from "node:fs";
 import path from "node:path";

package/dist/main.js

@@ -1,10 +1,11 @@
+import { loadNearestEnvFile } from "./dev/env.js";
+import { registerAuth } from "./auth/register.js";
 import { manifestFile } from "./bundle/manifest.js";
 import { resolveExtensions } from "./project/extensions.js";
 import { buildDeployBundle } from "./build/deploy-bundle.js";
 import { buildServeRuntime } from "./build/serve-runtime.js";
 import { resolveConnectionUrl } from "./db/connect.js";
 import { parseHosts } from "./dev/hosts.js";
-import { loadNearestEnvFile } from "./dev/env.js";
 import { runDev } from "./dev/run.js";
 import { runDoctor } from "./doctor/run.js";
 import { runScaffold } from "./scaffold/run.js";
@@ -84,6 +85,7 @@ program.command("serve").description("Serve a bundle written by `protobase build
 });
 registerUsers(program);
 registerToken(program);
+registerAuth(program);
 const run = (argv) => program.parseAsync(argv).catch((error) => {
 	process.stderr.write(`error: ${error.message}\n`);
 	process.exitCode = 1;

package/dist/package.js

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

package/dist/serve/app.js

@@ -1,8 +1,8 @@
 import { isApiPath } from "../bundle/manifest.js";
 import { serveStaticSite } from "./static-site.js";
+import { configExports, createAdmin } from "@protobase/server";
 import { Hono } from "hono";
 import { logger } from "hono/logger";
-import { configExports, createAdmin } from "@protobase/server";
 //#region src/serve/app.ts
 const createServeApp = ({ project, db, requestLog, site }) => {
 	const { resources, views, pages, userMenu } = configExports(project.config);

package/dist/serve/host-modules.js

@@ -1,10 +1,10 @@
+import * as server from "@protobase/server";
 import * as postgres$1 from "postgres";
 import * as schema from "@protobase/schema";
 import * as nodeServer from "@hono/node-server";
 import * as pg$1 from "pg";
 import * as kysely from "kysely";
 import * as hono from "hono";
-import * as server from "@protobase/server";
 import * as apiReference from "@scalar/hono-api-reference";
 import * as aipParsers from "aip-parsers";
 import * as betterAuth from "better-auth";

package/dist/serve/lifecycle.js

@@ -1,5 +1,6 @@
 import { createPgDb } from "../project/pg-db.js";
 import { createServeApp } from "./app.js";
+import { checkAuthSchema } from "@protobase/server";
 import { createAdaptorServer } from "@hono/node-server";
 import pg from "pg";
 //#region src/serve/lifecycle.ts
@@ -13,6 +14,7 @@ const listen = (server, port) => new Promise((resolve, reject) => {
 const closeServer = (server) => new Promise((resolve, reject) => server.close((error) => error ? reject(error) : resolve()));
 const startServe = async ({ project, env, createDb = (url) => createPgDb(pg, url), site }) => {
 	if (!project.db && !env.databaseUrl) throw new Error("No database: set DATABASE_URL or export `db` from protobase.config.ts");
+	if (project.auth) await checkAuthSchema(project.auth);
 	const ownDb = project.db ? void 0 : createDb(env.databaseUrl);
 	const db = project.db ?? ownDb;
 	const app = createServeApp({

package/dist/users/commands.js

@@ -1,16 +1,22 @@
 import { resolvePassword } from "./password.js";
 //#region src/users/commands.ts
+const githubId = /^[1-9][0-9]*$/;
 const createUserCommand = async (api, options, deps, out) => {
 	if (!options.email.includes("@")) throw new Error(`"${options.email}" is not an email address`);
+	if (options.githubId !== void 0 && !githubId.test(options.githubId)) throw new Error(`"${options.githubId}" is not a GitHub user id, a number such as 583231`);
 	const { password, generated } = await resolvePassword(options, deps);
 	const role = !await api.hasUsers() ? "admin" : options.role;
 	const user = await api.createUser({
 		email: options.email,
 		password,
 		...role && { role },
-		...options.name && { name: options.name }
+		...options.name && { name: options.name },
+		...options.githubId && { accounts: [{
+			providerId: "github",
+			accountId: options.githubId
+		}] }
 	});
-	out(`Created ${user.role} ${user.email}\n`);
+	out(`Created ${user.role} ${user.email}${options.githubId ? `, linked to GitHub user ${options.githubId}` : ""}\n`);
 	if (generated) out(`Password (shown once): ${password}\n`);
 };
 const listUsersCommand = async (api, out) => {

package/dist/users/register.js

@@ -1,11 +1,11 @@
+import { loadProjectAuth } from "./load-auth.js";
 import { readHidden, rejectPasswordArgument } from "./password.js";
 import { createUserCommand, listRolesCommand, listUsersCommand } from "./commands.js";
 import { deleteUserCommand, setDisabledCommand, setRoleCommand } from "./manage.js";
-import { loadProjectAuth } from "./load-auth.js";
 import { parseTtl } from "./ttl.js";
 import { Option } from "commander";
-import { createInterface } from "node:readline/promises";
 import { createUser, deleteUser, hasUsers, issueToken, listUsers, roleChoices, setUserBanned, setUserRole } from "@protobase/server";
+import { createInterface } from "node:readline/promises";
 //#region src/users/register.ts
 const out = (text) => process.stdout.write(text);
 const usersApi = (auth) => ({
@@ -34,14 +34,15 @@ const ask = async (question) => {
 const finish = (code) => process.exit(code);
 const registerUsers = (program) => {
 	const users = program.command("users").description("Manage the admin users of the project in the current directory");
-	users.command("create").description("Create a user; the first user is always an admin").argument("<email>").option("--name <name>", "display name").option("--role <role>", "role for users after the first (default: the project's default role; see `users roles`)").option("--password-stdin", "read the password from stdin", false).option("--generate-password", "generate a strong password and print it once", false).addOption(new Option("--password <value>").hideHelp()).action(async (email, opts) => {
+	users.command("create").description("Create a user; the first user is always an admin").argument("<email>").option("--name <name>", "display name").option("--role <role>", "role for users after the first (default: the project's default role; see `users roles`)").option("--password-stdin", "read the password from stdin", false).option("--generate-password", "generate a strong password and print it once", false).option("--github-id <id>", "link the user to this GitHub user id, so signing in with GitHub finds them whatever their address").addOption(new Option("--password <value>").hideHelp()).action(async (email, opts) => {
 		rejectPasswordArgument(opts.password);
 		await createUserCommand(await projectApi(), {
 			email,
 			name: opts.name,
 			role: opts.role,
 			passwordStdin: opts.passwordStdin,
-			generatePassword: opts.generatePassword
+			generatePassword: opts.generatePassword,
+			githubId: opts.githubId
 		}, {
 			stdin: process.stdin,
 			prompt: readHidden

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@protobase/cli",
-  "version": "0.5.0",
+  "version": "0.6.0",
   "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.5.0",
-    "@protobase/query": "0.5.0",
-    "@protobase/schema": "0.5.0",
-    "@protobase/server": "0.5.0",
-    "@protobase/ui": "0.5.0",
+    "@protobase/layout": "0.6.0",
+    "@protobase/query": "0.6.0",
+    "@protobase/schema": "0.6.0",
+    "@protobase/server": "0.6.0",
+    "@protobase/ui": "0.6.0",
     "@scalar/hono-api-reference": "^0.12.10",
     "@tailwindcss/vite": "^4.3.3",
     "@vitejs/plugin-react": "^6.1.2",