@protobase/cli 0.8.2 → 0.10.0

package/dist/dev/entry.js

@@ -1,12 +1,13 @@
 import { devJobs } from "./dev-jobs.js";
+import { projectAdmin } from "../project/project-admin.js";
 import { loadProject, projectDb } from "./project.js";
-import { checkAuthSchema, checkChanges, configExports, createAdmin, hasUsers, jobDefinitions } from "@protobase/server";
+import { checkAuthSchema, checkChanges, checkWebhooksSchema, configExports, hasUsers } from "@protobase/server";
 import { Hono } from "hono";
 //#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);
+const { resources } = 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) {
@@ -14,24 +15,12 @@ if (project.auth && !store.__protobaseAuthSchemaChecked) {
 	store.__protobaseAuthSchemaChecked = true;
 }
 await checkChanges(db, resources.map((resource) => resource.toModel()), project.events);
-await devJobs(db, jobDefinitions(project.jobs ?? {}));
-const admin = createAdmin({
-	resources,
-	views,
-	pages,
-	...userMenu && { userMenu },
-	db,
-	authenticate: project.authenticate,
-	...project.auth && { auth: project.auth },
-	...project.functions && { functions: project.functions },
-	...project.files && { files: project.files },
-	...project.events && { events: project.events },
-	jobs: jobDefinitions(project.jobs ?? {}),
-	options: {
-		onUnhandledError: (error) => console.error(error),
-		...project.options
-	}
-});
+if (project.webhooks) await checkWebhooksSchema(db, project.webhooks);
+const { admin, jobs } = projectAdmin({
+	...project,
+	authenticate: project.authenticate
+}, project.exports, db);
+await devJobs(db, jobs);
 var entry_default = new Hono().route("/", admin);
 if (project.auth && !store.__protobaseNoUsersShown) {
 	store.__protobaseNoUsersShown = true;

package/dist/dev/run.js

@@ -79,7 +79,7 @@ const runDev = async (options, out) => {
 			tailwindcss(),
 			devServer({
 				entry,
-				exclude: [/^(?!\/api(\/|\?|$)).*/],
+				exclude: [/^(?!\/api(\/|\?|$)|\/\.well-known\/webauthn(\?|$)).*/],
 				injectClientScript: false
 			})
 		]

package/dist/infer/names.js

@@ -3,6 +3,11 @@ const words = (name) => name.split(/[^A-Za-z0-9]+/).filter(Boolean);
 const capitalize = (word) => word.charAt(0).toUpperCase() + word.slice(1);
 const lowerFirst = (word) => word.charAt(0).toLowerCase() + word.slice(1);
 const identifier = (name) => /^[0-9]/.test(name) ? `c${name}` : name;
+const snakeName = (name) => {
+	const parts = words(name.replace(/([a-z0-9])([A-Z])/g, "$1_$2").replace(/([A-Z])([A-Z][a-z])/g, "$1_$2"));
+	if (parts.length === 0) throw new Error(`Cannot derive a field name from "${name}"`);
+	return identifier(parts.map((part) => part.toLowerCase()).join("_"));
+};
 const camelCase = (name) => {
 	const parts = words(name);
 	if (parts.length === 0) throw new Error(`Cannot derive a field name from "${name}"`);
@@ -25,4 +30,4 @@ const humanizeSingular = (name) => {
 	return [...parts.slice(0, -1), singular(parts.at(-1).toLowerCase())].join(" ").replace(/^./, (c) => c.toUpperCase());
 };
 //#endregion
-export { camelCase, humanize, humanizeSingular, singular };
+export { camelCase, humanize, humanizeSingular, singular, snakeName };

package/dist/infer/proposal.js

@@ -3,7 +3,7 @@ import { checkEnumValues } from "./check-values.js";
 import { columnDefault } from "./defaults.js";
 import { inferKind } from "./type-map.js";
 import { defaultColumn } from "./default-column.js";
-import { camelCase } from "./names.js";
+import { snakeName } from "./names.js";
 import { isTenantColumn } from "./tenant.js";
 //#region src/infer/proposal.ts
 const columnIndexing = (table, column) => {
@@ -41,7 +41,7 @@ const defaultsOf = (table, column, kind) => {
 const proposeField = (table, column, context) => {
 	const kind = inferKind(column, checkEnumValues(table.checks, column.name));
 	const relation = relationOf(table, column.name, context);
-	const name = camelCase(column.name);
+	const name = snakeName(column.name);
 	const defaults = defaultsOf(table, column, kind);
 	return {
 		name,

package/dist/migration/load-project.js

@@ -32,6 +32,7 @@ const loadMigrationProject = async (dir, extensions = []) => {
 		db: project.db ?? ownDb,
 		...project.auth && { auth: project.auth },
 		...project.events && { events: project.events },
+		...project.webhooks && { webhooks: project.webhooks },
 		jobs: jobDefinitions(project.jobs ?? {}),
 		close: async () => {
 			await ownDb?.destroy();

package/dist/migration/parts.js

@@ -1,4 +1,4 @@
-import { authSchemaMigration, changesMigration, jobsSchemaMigration } from "@protobase/server";
+import { authSchemaMigration, changesMigration, jobsSchemaMigration, webhooksMigration } 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) => [
@@ -7,7 +7,7 @@ const migrationParts = (project) => [
 		title: "The auth schema changes this version of Protobase needs",
 		sql: () => authSchemaMigration(project.auth)
 	}] : [],
-	...project.jobs.length > 0 ? [{
+	...project.jobs.length > 0 || project.models.some((model) => model.events) || project.webhooks ? [{
 		name: "jobs",
 		title: "The jobs schema this version of Protobase needs",
 		sql: () => jobsSchemaMigration(project.db)
@@ -16,7 +16,12 @@ const migrationParts = (project) => [
 		name: "changes",
 		title: "The change capture the resources' events need",
 		sql: () => changesMigration(project.db, project.models, project.events)
-	}
+	},
+	...project.webhooks ? [{
+		name: "webhooks",
+		title: "The webhook subscriptions of webhooks()",
+		sql: () => webhooksMigration(project.db, project.webhooks, project.events)
+	}] : []
 ];
 //#endregion
 export { migrationParts };

package/dist/package.js

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

package/dist/project/project-admin.js

@@ -0,0 +1,36 @@
+import { configExports, createAdmin, jobDefinitions } from "@protobase/server";
+//#region src/project/project-admin.ts
+/**
+* The admin API of a project over `db`, as `dev`, `serve` and `worker` build it: its config module's resources, views,
+* pages and subscriptions, and the rest of its config. `jobs` are the project's own and the delivery of its events.
+*/
+const projectAdmin = (project, config, db) => {
+	const { resources, views, pages, userMenu, bottomBars, subscriptions } = configExports(config);
+	const own = jobDefinitions(project.jobs ?? {});
+	const admin = createAdmin({
+		resources,
+		views,
+		pages,
+		...userMenu && { userMenu },
+		bottomBars,
+		db,
+		authenticate: project.authenticate,
+		...project.auth && { auth: project.auth },
+		...project.functions && { functions: project.functions },
+		...project.files && { files: project.files },
+		...project.events && { events: project.events },
+		...project.webhooks && { webhooks: project.webhooks },
+		jobs: own,
+		subscriptions,
+		options: {
+			onUnhandledError: (error) => console.error(error),
+			...project.options
+		}
+	});
+	return {
+		admin,
+		jobs: [...own, ...admin.jobs]
+	};
+};
+//#endregion
+export { projectAdmin };

package/dist/scaffold/data-file.js

@@ -1,4 +1,5 @@
 import { tableKey } from "../db/model.js";
+import { camelCase } from "../infer/names.js";
 import { parseSource } from "./project.js";
 import { fieldsObject, resourceChain } from "./existing-config.js";
 import { renderField } from "../infer/render-field.js";
@@ -19,7 +20,7 @@ const renderDataFile = (plan) => {
 	return [
 		`import { f, resource } from '@protobase/schema'`,
 		"",
-		`${docComment(plan)}export const ${plan.name} = resource('${plan.name}')`,
+		`${docComment(plan)}export const ${camelCase(plan.name)} = resource('${plan.name}')`,
 		`  .table('${tableKey(plan.table)}')`,
 		`  .fields({`,
 		properties,

package/dist/scaffold/existing-config.js

@@ -1,5 +1,5 @@
 import { defaultColumn } from "../infer/default-column.js";
-import { camelCase } from "../infer/names.js";
+import { camelCase, snakeName } from "../infer/names.js";
 import { parseSource } from "./project.js";
 import path from "node:path";
 import { readFile, readdir } from "node:fs/promises";
@@ -65,9 +65,11 @@ const parseResource = (text, dir) => {
 	const tableCall = methodCalls(chainTop, "table")[0];
 	const table = tableCall && stringArg(tableCall);
 	const fields = fieldsObject(chainTop);
-	if (!name || !table || !fields) return void 0;
+	const identifier = root.getFirstAncestorByKind(SyntaxKind.VariableDeclaration)?.getName();
+	if (!name || !table || !fields || !identifier) return void 0;
 	return {
 		name,
+		identifier,
 		table,
 		dir,
 		text,
@@ -77,7 +79,7 @@ const parseResource = (text, dir) => {
 		})
 	};
 };
-const findField = (resource, column) => resource.fields.find((field) => field.ignored ? field.column.toLowerCase() === column.toLowerCase() || field.name === camelCase(column) : field.column === column);
+const findField = (resource, column) => resource.fields.find((field) => field.ignored ? field.column.toLowerCase() === column.toLowerCase() || field.name === snakeName(column) || field.name === camelCase(column) : field.column === column);
 const readExistingResources = async (configDir) => {
 	const entries = await readdir(configDir, { withFileTypes: true }).catch((error) => {
 		if (error.code === "ENOENT") return [];

package/dist/scaffold/plan.js

@@ -1,5 +1,6 @@
 import { tableKey } from "../db/model.js";
 import { keyColumns } from "../db/keys.js";
+import { camelCase } from "../infer/names.js";
 import { findField } from "./existing-config.js";
 import { proposeField } from "../infer/proposal.js";
 import { addFieldsToDataFile, renderDataFile } from "./data-file.js";
@@ -49,19 +50,20 @@ const planScaffold = async (input) => {
 	const drift = [];
 	const warnings = [];
 	const registrations = [];
-	const writeUi = async (dir, resource, table, current, decisions) => {
+	const writeUi = async (dir, resource, identifier, table, current, decisions) => {
 		if (ui.length === 0) return;
 		const file = path.join(configDir, dir, "ui.ts");
 		const before = await input.readText(file);
 		const target = {
 			resource,
+			identifier,
 			tableName: table.name,
 			fields: uiFields(table, current, decisions)
 		};
 		changes.push(...change(file, before, before === void 0 ? renderUiFile(target, ui) : addUiSections(before, target, ui)));
 		if (before === void 0) registrations.push({
 			from: `./${dir}/ui`,
-			names: [viewName(resource)]
+			names: [viewName(identifier)]
 		});
 	};
 	for (const table of targets) {
@@ -75,7 +77,7 @@ const planScaffold = async (input) => {
 			const file = path.join(configDir, current.dir, "data.ts");
 			changes.push(...change(file, current.text, addFieldsToDataFile(current.text, decisions)));
 			drift.push(...detectDrift(current, table, context(table)));
-			await writeUi(current.dir, current.name, table, current, decisions);
+			await writeUi(current.dir, current.name, current.identifier, table, current, decisions);
 			continue;
 		}
 		const name = names.get(key);
@@ -93,9 +95,9 @@ const planScaffold = async (input) => {
 		});
 		registrations.push({
 			from: `./${name}/data`,
-			names: [name]
+			names: [camelCase(name)]
 		});
-		await writeUi(name, name, table, void 0, decisions);
+		await writeUi(name, name, camelCase(name), table, void 0, decisions);
 	}
 	const indexFile = path.join(configDir, "index.ts");
 	const indexBefore = await input.readText(indexFile);
@@ -114,12 +116,12 @@ const registerExisting = async (input, planned) => {
 		const data = `./${resource.dir}/data`;
 		if (!known.has(data)) registrations.push({
 			from: data,
-			names: [resource.name]
+			names: [resource.identifier]
 		});
 		const ui = `./${resource.dir}/ui`;
 		if (await input.readText(path.join(input.configDir, resource.dir, "ui.ts")) !== void 0 && !known.has(ui)) registrations.push({
 			from: ui,
-			names: [viewName(resource.name)]
+			names: [viewName(resource.identifier)]
 		});
 	}
 	return registrations;

package/dist/scaffold/resource-names.js

@@ -1,15 +1,15 @@
 import { tableKey } from "../db/model.js";
-import { camelCase } from "../infer/names.js";
+import { snakeName } from "../infer/names.js";
 //#region src/scaffold/resource-names.ts
 const assignNames = (tables, existing) => {
 	const names = new Map(existing.map((resource) => [resource.table, resource.name]));
 	const taken = new Set(names.values());
 	const fresh = tables.filter((table) => !names.has(tableKey(table)));
 	const counts = /* @__PURE__ */ new Map();
-	for (const table of tables) counts.set(camelCase(table.name), (counts.get(camelCase(table.name)) ?? 0) + 1);
+	for (const table of tables) counts.set(snakeName(table.name), (counts.get(snakeName(table.name)) ?? 0) + 1);
 	for (const table of fresh) {
-		const plain = camelCase(table.name);
-		const name = counts.get(plain) === 1 && !taken.has(plain) ? plain : camelCase(`${table.schema}_${table.name}`);
+		const plain = snakeName(table.name);
+		const name = counts.get(plain) === 1 && !taken.has(plain) ? plain : snakeName(`${table.schema}_${table.name}`);
 		names.set(tableKey(table), name);
 		taken.add(name);
 	}

package/dist/scaffold/ui-file.js

@@ -3,7 +3,7 @@ import { parseSource } from "./project.js";
 import { methodCalls } from "./existing-config.js";
 import { Node, SyntaxKind } from "ts-morph";
 //#region src/scaffold/ui-file.ts
-const auditField = /^(created|updated)(At|On)$/;
+const auditField = /^(created|updated)(At|On|_at|_on)$/;
 const longText = /^(notes?|description|body|comment|comments)$/;
 const listSize = 5;
 const listColumns = (fields) => {
@@ -13,7 +13,7 @@ const listColumns = (fields) => {
 	const picked = [...scalars.slice(0, listSize), ...scalars.length < 3 ? relations : []].slice(0, listSize);
 	return (picked.length > 0 ? picked : fields.filter((f) => f.role === "key")).map((f) => f.name);
 };
-const viewName = (resource) => `${resource}View`;
+const viewName = (identifier) => `${identifier}View`;
 const sectionText = {
 	names: (t) => `.names({ singular: '${humanizeSingular(t.tableName)}', plural: '${humanize(t.tableName)}' })`,
 	list: (t) => `.list((r) => ({ columns: [${listColumns(t.fields).map((n) => `r.${n}`).join(", ")}] }))`
@@ -21,9 +21,9 @@ const sectionText = {
 const lines = (sections, target) => sections.map((s) => `  ${sectionText[s](target)}`);
 const renderUiFile = (target, sections) => [
 	`import { view } from '@protobase/schema'`,
-	`import type { ${target.resource} } from './data'`,
+	`import type { ${target.identifier} } from './data'`,
 	"",
-	`export const ${viewName(target.resource)} = view<typeof ${target.resource}>('${target.resource}')`,
+	`export const ${viewName(target.identifier)} = view<typeof ${target.identifier}>('${target.resource}')`,
 	...lines(sections, target),
 	""
 ].join("\n");

package/dist/serve/app.js

@@ -1,32 +1,14 @@
 import { isApiPath } from "../bundle/manifest.js";
 import { serveStaticSite } from "./static-site.js";
-import { configExports, createAdmin, jobDefinitions, jobsDrainApp } from "@protobase/server";
+import { jobsDrainApp, webauthnPath } from "@protobase/server";
 import { Hono } from "hono";
 import { logger } from "hono/logger";
 //#region src/serve/app.ts
-const createServeApp = ({ project, db, requestLog, site, jobs, drainToken }) => {
-	const { resources, views, pages, userMenu } = configExports(project.config);
-	const admin = createAdmin({
-		resources,
-		views,
-		pages,
-		...userMenu && { userMenu },
-		db,
-		authenticate: project.authenticate,
-		...project.auth && { auth: project.auth },
-		...project.functions && { functions: project.functions },
-		...project.files && { files: project.files },
-		...project.events && { events: project.events },
-		jobs: jobDefinitions(project.jobs ?? {}),
-		options: {
-			onUnhandledError: (error) => console.error(error),
-			...project.options
-		}
-	});
+const createServeApp = ({ admin, requestLog, site, jobs, drainToken }) => {
 	const app = new Hono();
 	if (requestLog) app.use(logger());
 	app.get("/health", (c) => c.json({ status: "ok" }));
-	if (site) app.use("*", (c, next) => isApiPath(site.api, c.req.path) ? next() : serveStaticSite(site, c.req.raw));
+	if (site) app.use("*", (c, next) => isApiPath(site.api, c.req.path) || c.req.path === webauthnPath ? next() : serveStaticSite(site, c.req.raw));
 	if (jobs && drainToken) app.route("/", jobsDrainApp({
 		runtime: jobs,
 		token: drainToken

package/dist/serve/lifecycle.js

@@ -1,7 +1,8 @@
+import { projectAdmin } from "../project/project-admin.js";
 import { createPgDb } from "../project/pg-db.js";
 import { createServeApp } from "./app.js";
 import { startCleanupTimer } from "./cleanup-timer.js";
-import { checkAuthSchema, checkChanges, checkJobsSchema, configExports, createFileCleanup, jobDefinitions, startJobs } from "@protobase/server";
+import { checkAuthSchema, checkChanges, checkJobsSchema, checkWebhooksSchema, configExports, createFileCleanup, startJobs } from "@protobase/server";
 import { createAdaptorServer } from "@hono/node-server";
 import pg from "pg";
 //#region src/serve/lifecycle.ts
@@ -19,9 +20,10 @@ const startServe = async ({ project, env, createDb = (url) => createPgDb(pg, url
 	const ownDb = project.db ? void 0 : createDb(env.databaseUrl);
 	const db = project.db ?? ownDb;
 	const { resources } = configExports(project.config);
-	const definitions = jobDefinitions(project.jobs ?? {});
 	const startJobsAndListen = async () => {
 		await checkChanges(db, resources.map((resource) => resource.toModel()), project.events);
+		if (project.webhooks) await checkWebhooksSchema(db, project.webhooks);
+		const { admin, jobs: definitions } = projectAdmin(project, project.config, db);
 		if (definitions.length > 0) await checkJobsSchema(db);
 		const jobs = definitions.length > 0 ? await startJobs({
 			db,
@@ -30,8 +32,7 @@ const startServe = async ({ project, env, createDb = (url) => createPgDb(pg, url
 			onError: (error) => console.error(error)
 		}) : void 0;
 		const app = createServeApp({
-			project,
-			db,
+			admin,
 			requestLog: env.requestLog,
 			site,
 			...jobs && { jobs },

package/dist/worker/start-worker.js

@@ -1,10 +1,11 @@
 import { readManifest } from "../bundle/manifest.js";
 import { checkBundleVersion } from "../serve/bundle-version.js";
+import { projectAdmin } from "../project/project-admin.js";
 import { createPgDb } from "../project/pg-db.js";
 import { loadBundle } from "../serve/load-bundle.js";
 import { statSync } from "node:fs";
 import path from "node:path";
-import { checkJobsSchema, jobDefinitions, startJobs } from "@protobase/server";
+import { checkJobsSchema, configExports, jobDefinitions, startJobs } from "@protobase/server";
 import pg from "pg";
 //#region src/worker/start-worker.ts
 const bundleConfigFile = async (bundle) => {
@@ -16,20 +17,24 @@ const bundleConfigFile = async (bundle) => {
 * their own. It reads the jobs schema at start and refuses one that is missing or behind, like `serve`.
 */
 const startWorker = async ({ project, databaseUrl, createDb = (url) => createPgDb(pg, url) }) => {
-	const definitions = jobDefinitions(project.jobs ?? {});
-	if (definitions.length === 0) throw new Error("The bundle has no jobs: export them from protobase.config.ts as `jobs`");
+	const withEvents = configExports(project.config).resources.some((resource) => resource.toModel().events);
+	if (jobDefinitions(project.jobs ?? {}).length === 0 && !withEvents) throw new Error("The bundle has no jobs: export them from protobase.config.ts as `jobs`, or give a resource events");
 	if (!project.db && !databaseUrl) throw new Error("No database: set DATABASE_URL or export `db` from protobase.config.ts");
 	const ownDb = project.db ? void 0 : createDb(databaseUrl);
 	const db = project.db ?? ownDb;
 	const start = async () => {
+		const { jobs: definitions } = projectAdmin(project, project.config, db);
 		await checkJobsSchema(db);
-		return startJobs({
-			db,
-			jobs: definitions,
-			onError: (error) => console.error(error)
-		});
+		return {
+			definitions,
+			runtime: await startJobs({
+				db,
+				jobs: definitions,
+				onError: (error) => console.error(error)
+			})
+		};
 	};
-	const jobs = await start().catch(async (error) => {
+	const { definitions, runtime: jobs } = await start().catch(async (error) => {
 		await ownDb?.destroy();
 		throw error;
 	});

package/package.json

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