better-supabase 0.7.1 → 0.8.0

package/dist/cli/scaffold-5DenHSxF.js

@@ -0,0 +1,292 @@
+import { a as list, r as defineCliCommand } from "./command-DV-StG1x.js";
+import { i as sameText, t as display } from "./io-CFzJVJ68.js";
+import { i as metaPaths } from "./emit-BHHfwUoT.js";
+import { t as importFresh } from "./fresh-import-BeYf9I3x.js";
+import { t as detectProject } from "./project-DZRaBaY7.js";
+import { r as writeLine } from "./files-BVupXPIC.js";
+import { posix, resolve } from "node:path";
+import { existsSync } from "node:fs";
+import { readFile } from "node:fs/promises";
+//#region src/cli/scaffold/api.ts
+const SCAFFOLD_FRAMEWORKS = ["hono", "next"];
+const GENERATED_HEADER = "// @generated by better-supabase scaffold. Do not edit; run `better-supabase scaffold api` again instead.";
+const join$1 = (...parts) => posix.normalize(posix.join(...parts));
+function importFrom(context, from, to) {
+	let path = posix.relative(posix.dirname(from), to);
+	if (!path.startsWith(".")) path = `./${path}`;
+	if (context.tsExtensions) return path;
+	return path.replace(/\.tsx?$/, "").replace(/^(\.\.?\/.+)\/index$/, "$1");
+}
+const quote$1 = (value) => JSON.stringify(value);
+function generatedModule(context) {
+	const names = context.tables.map(quote$1).join(", ");
+	const resources = context.tables.map((table) => `  ${/^[A-Za-z_$][\w$]*$/.test(table) ? table : quote$1(table)}: true,`).join("\n");
+	return `${GENERATED_HEADER}
+
+/** The tables served as REST resources and documented in the API model. */
+export const tableNames = [${names}] as const;
+
+export const resources = {
+${resources}
+} as const;
+
+export const basePath = ${quote$1(context.basePath)};
+`;
+}
+function apiModule(context, path, generated) {
+	return `import { defineApi } from 'better-supabase/spec';
+
+import { betterSupabase } from '${importFrom(context, path, join$1(context.srcDir, "lib", "supabase", "index.ts"))}';
+import { basePath, resources, tableNames } from '${importFrom(context, path, generated)}';
+
+export { basePath, resources, tableNames };
+
+/**
+ * The API model. Every OpenAPI version, and the other spec formats, render
+ * from it, and \`better-supabase spec emit\` reads it. Describe resources,
+ * add list queries and custom routes here: this file is yours, and
+ * \`better-supabase scaffold api\` never rewrites it.
+ */
+export const api = defineApi(betterSupabase, {
+  info: { title: 'API', version: '1.0.0' },
+  basePath,
+  resources,
+});
+`;
+}
+function nextFiles(context, api) {
+	const routeDir = join$1(context.srcDir, "app", context.basePath);
+	const resources = join$1(routeDir, "[...path]", "route.ts");
+	const spec = join$1(routeDir, "openapi.json", "route.ts");
+	const server = join$1(context.srcDir, "lib", "supabase", "server.ts");
+	return [{
+		path: resources,
+		generated: false,
+		contents: `import { basePath, resources } from '${importFrom(context, resources, api)}';
+import { bs } from '${importFrom(context, resources, server)}';
+
+export const { GET, POST, PATCH, PUT, DELETE } = bs.resources(resources, { basePath });
+`
+	}, {
+		path: spec,
+		generated: false,
+		contents: `import { specResponse } from 'better-supabase/spec';
+
+import { api } from '${importFrom(context, spec, api)}';
+
+const { document } = api.openapi();
+
+export const GET = (request: Request) => specResponse(document, request);
+`
+	}];
+}
+function honoFiles(context, api) {
+	const path = join$1(context.srcDir, `${context.name}-routes.ts`);
+	const server = join$1(context.srcDir, "server.ts");
+	return [{
+		path,
+		generated: false,
+		contents: `import { specResponse } from 'better-supabase/spec';
+
+import { api, basePath, tableNames } from '${importFrom(context, path, api)}';
+import type { bs as server } from '${importFrom(context, path, server)}';
+
+const { document } = api.openapi();
+
+/**
+ * The OpenAPI document and a REST resource per table. Mount it in
+ * server.ts with \`.route('/', apiRoutes(bs))\`.
+ */
+export function apiRoutes(bs: typeof server) {
+  const routes = bs
+    .app()
+    .get(\`\${basePath}/openapi.json\`, (c) => specResponse(document, c.req.raw))
+    .use(\`\${basePath}/*\`, bs.middleware());
+  for (const table of tableNames) routes.route(\`\${basePath}/\${table}\`, bs.resource(table));
+  return routes;
+}
+`
+	}];
+}
+/** The files `scaffold api` writes for a framework. */
+function scaffoldApiFiles(context) {
+	const lib = join$1(context.srcDir, "lib");
+	const generated = join$1(lib, `${context.name}.generated.ts`);
+	const api = join$1(lib, `${context.name}.ts`);
+	const shared = [{
+		path: generated,
+		generated: true,
+		contents: generatedModule(context)
+	}, {
+		path: api,
+		generated: false,
+		contents: apiModule(context, api, generated)
+	}];
+	switch (context.framework) {
+		case "next": return [...shared, ...nextFiles(context, api)];
+		case "hono": return [...shared, ...honoFiles(context, api)];
+		default: {
+			const unknown = context.framework;
+			throw new Error(`Unknown framework: ${String(unknown)}`);
+		}
+	}
+}
+/** What to do after the files are written. */
+function scaffoldNextSteps(context, specsEntry) {
+	const api = join$1(context.srcDir, "lib", `${context.name}.ts`);
+	const steps = [];
+	if (context.framework === "hono") steps.push(`Mount the routes in ${join$1(context.srcDir, "server.ts")}: \`.route('/', apiRoutes(bs))\`.`);
+	if (specsEntry !== api) steps.push(`Set \`specs: { entry: '${api}' }\` in better-supabase.config.ts, so \`better-supabase spec emit\` reads the API model.`);
+	steps.push(`Describe the resources in ${api}; \`scaffold api\` only rewrites ${context.name}.generated.ts.`);
+	return steps;
+}
+//#endregion
+//#region src/cli/commands/scaffold.ts
+const ARGS = {
+	kind: {
+		type: "positional",
+		required: false,
+		description: "api"
+	},
+	framework: {
+		type: "string",
+		description: "hono or next. Defaults to the one in package.json",
+		valueHint: "name"
+	},
+	tables: {
+		type: "string",
+		description: "Tables to serve. Defaults to every table and view in the public schema",
+		valueHint: "list"
+	},
+	name: {
+		type: "string",
+		description: "The API module's name: lib/<name>.ts and lib/<name>.generated.ts. Defaults to api",
+		valueHint: "name"
+	},
+	"base-path": {
+		type: "string",
+		description: "Where the resources are served. Defaults to /api",
+		valueHint: "path"
+	}
+};
+const isFramework = (value) => SCAFFOLD_FRAMEWORKS.some((framework) => framework === value);
+const isRecord = (value) => typeof value === "object" && value !== null && !Array.isArray(value);
+/** The public tables and views in the metadata module `gen` writes, or undefined without one. */
+async function generatedTables(config) {
+	const path = resolve(config.root, metaPaths(config.output).js);
+	if (!existsSync(path)) return void 0;
+	const meta = (await importFresh(path))["default"];
+	const tables = isRecord(meta) ? meta["tables"] : void 0;
+	if (!isRecord(tables)) return void 0;
+	return Object.entries(tables).filter(([, table]) => isRecord(table) && table["schema"] === "public" && (table["kind"] === "table" || table["kind"] === "view")).map(([key]) => key);
+}
+async function runScaffold(config, args, options = {}) {
+	const [kind] = args._ ?? [];
+	if (kind !== "api") return {
+		code: 2,
+		error: `${kind ? `Unknown scaffold "${kind}"` : "Name what to scaffold"}. Run \`better-supabase scaffold api\`.`
+	};
+	const configured = config.scaffold.api ?? {};
+	const project = await detectProject(config.root);
+	const detected = project.frameworks.filter(isFramework);
+	const chosen = args.framework ?? configured.framework;
+	const framework = chosen ?? (detected.length === 1 ? detected[0] : void 0);
+	if (!isFramework(framework)) return {
+		code: 2,
+		error: chosen === void 0 ? "Pass --framework hono or --framework next, or set scaffold.api.framework." : `--framework takes hono or next, got "${chosen}".`
+	};
+	const name = args.name ?? configured.name ?? "api";
+	if (!/^[a-z][\w-]*$/i.test(name)) return {
+		code: 2,
+		error: `--name must be a file name without a folder, got "${name}".`
+	};
+	const basePath = `/${(args["base-path"] ?? configured.basePath ?? "/api").replaceAll(/^\/+|\/+$/g, "")}`;
+	const known = await generatedTables(config);
+	const requested = args.tables === void 0 ? [...configured.tables ?? []] : list(args.tables);
+	if (requested.length === 0 && !known) return {
+		code: 1,
+		error: `No ${display(config.root, metaPaths(config.output).js)}. Run \`better-supabase gen\` first, or pass --tables.`
+	};
+	const unknown = known ? requested.filter((table) => !known.includes(table)) : [];
+	if (unknown.length > 0) return {
+		code: 1,
+		error: `Unknown tables: ${unknown.join(", ")}. Known tables: ${known?.join(", ")}.`
+	};
+	const tables = requested.length > 0 ? requested : known ?? [];
+	if (tables.length === 0) return {
+		code: 1,
+		error: "There are no public tables to serve. Pass --tables."
+	};
+	const context = {
+		framework,
+		srcDir: project.srcDir,
+		tsExtensions: project.tsExtensions,
+		name,
+		basePath,
+		tables
+	};
+	const lines = [];
+	const stale = [];
+	for (const file of scaffoldApiFiles(context)) {
+		if (options.generatedOnly === true && !file.generated) continue;
+		const path = resolve(config.root, file.path);
+		const exists = existsSync(path);
+		if (!file.generated && exists) {
+			lines.push(`Kept ${file.path} (yours)`);
+			continue;
+		}
+		const current = exists ? await readFile(path, "utf8") : void 0;
+		if (current !== void 0 && !current.startsWith("// @generated by better-supabase scaffold. Do not edit; run `better-supabase scaffold api` again instead.")) return {
+			code: 1,
+			error: `${file.path} was not written by better-supabase scaffold. Move it, or pass another --name.`
+		};
+		if (options.check === true) {
+			if (sameText(current, file.contents)) lines.push(`${file.path} is up to date.`);
+			else stale.push(file.path);
+			continue;
+		}
+		lines.push((await writeLine(path, file.contents, file.path)).line);
+	}
+	if (stale.length > 0) return {
+		code: 1,
+		error: `Out of date: ${stale.join(", ")}. Run \`better-supabase scaffold api\`.`
+	};
+	if (options.generatedOnly === true || options.check === true) return {
+		code: 0,
+		output: lines.join("\n")
+	};
+	const steps = scaffoldNextSteps(context, config.specs.entry);
+	const save = config.scaffold.api === void 0 ? [
+		"",
+		"Add this to your config so `better-supabase gen` keeps the generated file current:",
+		`  scaffold: { api: ${scaffoldSnippet({
+			framework,
+			...name === "api" ? {} : { name },
+			...basePath === "/api" ? {} : { basePath },
+			...requested.length > 0 ? { tables: requested } : {}
+		})} }`
+	] : [];
+	return {
+		code: 0,
+		output: [
+			...lines,
+			"",
+			"Next:",
+			...steps.map((step) => `- ${step}`),
+			...save
+		].join("\n")
+	};
+}
+const quote = (value) => `'${value}'`;
+const scaffoldSnippet = (api) => `{ ${Object.entries(api).map(([key, value]) => `${key}: ${typeof value === "string" ? quote(value) : `[${value.map(quote).join(", ")}]`}`).join(", ")} }`;
+const scaffoldCommand = defineCliCommand({
+	meta: {
+		name: "scaffold",
+		description: "Writes an API module, its resource routes and an OpenAPI route for Hono or Next.js"
+	},
+	args: ARGS,
+	lists: ["tables"],
+	run: (args, { config }) => runScaffold(config, args)
+});
+//#endregion
+export { scaffoldCommand as n, runScaffold as t };

package/dist/cli/scaffold-CwQUMFRb.js

@@ -0,0 +1,2 @@
+import { n as scaffoldCommand } from "./scaffold-5DenHSxF.js";
+export { scaffoldCommand };

package/dist/cli/{seed-DQzqT7LP.js → seed-CzBmrGON.js}

@@ -1,9 +1,10 @@
-import { r as defineCliCommand } from "./command-CK14fP91.js";
-import { i as writeIfChanged, r as sameText, t as display } from "./io-DI1mTdSA.js";
-import { i as importExport, s as stdinDatabaseUrl, t as databaseUrl } from "./config-NiPxAmUF.js";
+import { r as defineCliCommand } from "./command-DV-StG1x.js";
+import { t as display } from "./io-CFzJVJ68.js";
+import { a as importExport, c as stdinDatabaseUrl, n as databaseUrl } from "./config-M-WzL9O2.js";
 import { f as supabaseDir } from "./supabase-toml-B-bIukQF.js";
-import { n as withSpinner } from "./prompts-BNcNfAve.js";
-import { t as connect } from "./db-DOBPt660.js";
+import { t as connect } from "./db-BkcfOlyB.js";
+import { n as withSpinner } from "./prompts-DZJB1nTw.js";
+import { n as staleResult, r as writeLine, t as fileState } from "./files-BVupXPIC.js";
 import { resolve } from "node:path";
 import { existsSync } from "node:fs";
 import { readFile } from "node:fs/promises";
@@ -16,7 +17,7 @@ const ARGS = {
 	},
 	apply: {
 		type: "boolean",
-		description: "Also insert the rows into the database ($DATABASE_URL, --db-url-stdin, or the local stack)"
+		description: "Also insert the rows into the database ($DATABASE_URL, $SUPABASE_DB_URL, --db-url-stdin, or the local stack)"
 	},
 	entry: {
 		type: "string",
@@ -30,7 +31,7 @@ const ARGS = {
 	},
 	"db-url-stdin": {
 		type: "boolean",
-		description: "Read the connection string from stdin instead of $DATABASE_URL or the config"
+		description: "Read the connection string from stdin instead of the config, $DATABASE_URL or $SUPABASE_DB_URL"
 	}
 };
 const HEADER = "-- Generated by `better-supabase seed`";
@@ -44,20 +45,15 @@ async function runSeed(config, args, env, open = connect, dbUrl) {
 	};
 	const statements = seed.statements();
 	const contents = `${HEADER} from ${display(config.root, entry)}. Do not edit.\n\n${statements.join("\n\n")}\n`;
-	const path = resolve(config.root, out);
-	const current = existsSync(path) ? await readFile(path, "utf8") : void 0;
-	if (args.check === true) return sameText(current, contents) ? {
-		code: 0,
-		output: `${display(config.root, out)} is up to date.`
-	} : {
-		code: 1,
-		error: `${display(config.root, out)} is out of date. Run \`better-supabase seed\`.`
-	};
+	const state = await fileState(config.root, out, contents);
+	const { current } = state;
+	if (args.check === true) return staleResult(state, "better-supabase seed");
 	if (current !== void 0 && !current.startsWith(HEADER)) return {
 		code: 1,
 		error: `${display(config.root, out)} was not written by better-supabase; pass --out to write elsewhere.`
 	};
-	const lines = [`${await writeIfChanged(path, contents) ? "Wrote" : "Unchanged"} ${display(config.root, out)} (${statements.length} table${statements.length === 1 ? "" : "s"})`];
+	const { line } = await writeLine(state.path, contents, state.file, ` (${statements.length} table${statements.length === 1 ? "" : "s"})`);
+	const lines = [line];
 	if (args.apply === true) {
 		const { client, close } = await open(await databaseUrl(config, env, dbUrl));
 		try {
@@ -97,4 +93,4 @@ const seedCommand = defineCliCommand({
 	}
 });
 //#endregion
-export { seedCommand };
+export { seedCommand as n, runSeed as t };

package/dist/cli/seed-DOmit9Hq.js

@@ -0,0 +1,2 @@
+import { n as seedCommand } from "./seed-CzBmrGON.js";
+export { seedCommand };

package/dist/cli/{skills-QQs4q68J.js → skills-CnO8QFS7.js}

@@ -1,6 +1,7 @@
-import { a as list, r as defineCliCommand } from "./command-CK14fP91.js";
-import { i as writeIfChanged, r as sameText, t as display } from "./io-DI1mTdSA.js";
+import { a as list, r as defineCliCommand } from "./command-DV-StG1x.js";
+import { i as sameText, r as readIfExists, t as display } from "./io-CFzJVJ68.js";
 import { t as byCodePoint } from "./compare-BmIWVEui.js";
+import { r as writeLine } from "./files-BVupXPIC.js";
 import { dirname, join, resolve } from "node:path";
 import { existsSync } from "node:fs";
 import { readFile, readdir } from "node:fs/promises";
@@ -15,7 +16,7 @@ const ARGS = {
 	},
 	agent: {
 		type: "string",
-		description: "cursor (.cursor/skills), claude (.claude/skills) or agents (.agents/skills). Defaults to the agent folders the project has, else agents",
+		description: "cursor (.cursor/skills), claude (.claude/skills) or agents (.agents/skills). Defaults to skills.agents, then the agent folders the project has, else agents",
 		valueHint: "names"
 	},
 	global: {
@@ -88,7 +89,7 @@ async function runSkills(config, args, env) {
 	};
 	const global = args.global === true;
 	const base = global ? env.HOME ?? homedir() : config.root;
-	const requested = list(args.agent);
+	const requested = args.agent === void 0 ? [...config.skills.agents ?? []] : list(args.agent);
 	const unknown = requested.filter((name) => !isAgent(name));
 	if (unknown.length > 0) return {
 		code: 2,
@@ -107,11 +108,11 @@ async function runSkills(config, args, env) {
 		const path = resolve(base, relativePath);
 		const shown = global ? `~/${relativePath}` : display(config.root, relativePath);
 		if (check) {
-			const current = existsSync(path) ? await readFile(path, "utf8") : void 0;
+			const current = await readIfExists(path);
 			if (!sameText(current, file.contents)) stale.push(shown);
 			continue;
 		}
-		lines.push(`${await writeIfChanged(path, file.contents) ? "Wrote" : "Unchanged"} ${shown}`);
+		lines.push((await writeLine(path, file.contents, shown)).line);
 	}
 	if (check) return stale.length === 0 ? {
 		code: 0,