better-supabase 0.11.0 → 0.13.0

package/dist/cli/version-CUKjFbNd.js

@@ -1,4 +0,0 @@
-//#region src/cli/version.ts
-const VERSION = "0.11.0";
-//#endregion
-export { VERSION as t };

package/dist/cli/write-VZljwoTB.js

@@ -1,198 +0,0 @@
-import { n as CliError } from "./errors-Caiz_0so.js";
-import { t as display } from "./io-BiPX-_J1.js";
-import { b as sqlPlan, c as writeLatestMigration, o as renderModuleMigration, p as writeExtensionsMigration, t as MODULES_SUFFIX, u as DATA_NEXT } from "./module-migration-CPhuiY8C.js";
-import { d as readSupabaseToml, f as schemaPaths, h as tomlGet, i as diffEngine, l as migrationCommand, o as findSupabaseRoot, p as sqlWorkflow, t as PGDELTA_TABLE } from "./supabase-toml-BC5sNVKU.js";
-import { n as applyPlan, r as changeLines } from "./files-DDvAwTko.js";
-import { t as loadTopics } from "./topics-BBE1-Vrg.js";
-import { dirname, join, resolve } from "node:path";
-import { readFile, readdir } from "node:fs/promises";
-import { APP_TABLES_MARKER, APP_TABLES_MODULE, moduleTopics, renderModules, resolveModules, sameModuleFile } from "better-supabase/sql";
-import { CONFIG_DEFAULTS } from "better-supabase/config";
-//#region src/cli/enable-pgdelta.ts
-/**
-* Adds `[experimental.pgdelta] enabled = true` to `supabase/config.toml`
-* when it has no such table, so `supabase db schema declarative sync`
-* runs on pg-delta. A table set to `enabled = false` is left alone, and a
-* project without `config.toml` gets nothing.
-*/
-async function enablePgDelta(root, dryRun, base = root) {
-	const supabaseRoot = findSupabaseRoot(root);
-	const toml = await readSupabaseToml(root);
-	if (supabaseRoot === void 0 || toml === void 0) return [];
-	const path = join(supabaseRoot, "supabase/config.toml");
-	const shown = display(base, path);
-	if (diffEngine(toml) === "pg-delta") return [];
-	if (tomlGet(toml.document, ["experimental", "pgdelta"]) !== void 0 || toml.text.includes("pgdelta")) return [`Skipped ${shown} (pg-delta is off; set [experimental.pgdelta] enabled = true, remove [db.migrations] schema_paths and use \`supabase db schema declarative sync\` instead of \`supabase db diff\`)`];
-	const separator = toml.text === "" || toml.text.endsWith("\n\n") ? "" : toml.text.endsWith("\n") ? "\n" : "\n\n";
-	await applyPlan({
-		root: dirname(path),
-		regenerate: "better-supabase init",
-		files: [{
-			path,
-			contents: `${toml.text}${separator}${PGDELTA_TABLE}`,
-			policy: "edit"
-		}]
-	}, { "dry-run": dryRun });
-	return [`${dryRun ? "Would enable" : "Enabled"} pg-delta in ${shown}`];
-}
-//#endregion
-//#region src/cli/topic-policies.ts
-const literalParts = (template) => template.replaceAll(/\{[^}]+\}/g, "{}");
-const owns = (owned, template) => owned.endsWith("*") ? template.startsWith(owned.slice(0, -1)) : literalParts(owned) === literalParts(template);
-const receivesOnly = (sql) => !sql.includes(" for insert ") && !sql.includes("'presence'");
-function triggerStatement(topic, table, options, index) {
-	try {
-		return topic.trigger(table, options);
-	} catch (error) {
-		if (error instanceof TypeError) throw new CliError("config_invalid", `realtime.triggers[${String(index)}]: ${error.message}`);
-		throw error;
-	}
-}
-/** The file `realtime.policies` writes, or `undefined` when it isn't set. */
-async function topicPolicyFile(config, owned = []) {
-	const policies = config.realtime.policies;
-	const triggers = config.realtime.triggers;
-	if (policies === void 0) {
-		if (triggers.length > 0) throw new CliError("config_invalid", "realtime.triggers needs realtime.policies: the triggers go to its output, for topics its from files export");
-		return;
-	}
-	const topics = (await loadTopics(config.root, policies.from)).map((each) => each.topic);
-	const functions = config.authorization?.functions;
-	const sqlOf = (topic) => topic.sql(functions === void 0 ? void 0 : { functions });
-	const skipped = [];
-	const written = topics.filter((topic) => {
-		const owner = owned.find((entry) => owns(entry.topic, topic.template));
-		if (owner === void 0 || !receivesOnly(sqlOf(topic))) return true;
-		skipped.push(`-- Skipped topic ${topic.template}: the ${owner.module} module writes its receive policy.`);
-		return false;
-	});
-	const topicFor = (template, where) => {
-		const topic = topics.find((candidate) => candidate.template === template);
-		if (topic === void 0) throw new CliError("config_invalid", `${where}: no topic "${template}" in ${policies.from.join(", ")}`);
-		return topic;
-	};
-	const triggerSql = triggers.map(({ topic: template, table, topics: extra, ...options }, index) => {
-		const statement = triggerStatement(topicFor(template, "realtime.triggers"), table, {
-			...options,
-			...extra === void 0 ? {} : { topics: extra.map((each) => ({
-				topic: topicFor(each.topic, `realtime.triggers[${String(index)}].topics`),
-				...each.values === void 0 ? {} : { values: each.values }
-			})) }
-		}, index);
-		if (statement.includes("better_supabase.broadcast_topic(") && !config.blockNames.includes("realtime-tables")) throw new CliError("config_invalid", `realtime.triggers: the trigger for ${template} on ${table} calls better_supabase.broadcast_topic(): add realtime-tables to blocks`);
-		return statement;
-	});
-	const header = [
-		"-- better-supabase: realtime topic policies",
-		`-- Written by \`better-supabase sql sync\` from ${policies.from.join(", ")}; edit the topics, not this file.`,
-		...skipped
-	].join("\n");
-	return {
-		path: policies.output,
-		contents: `${header}\n\n${[...written.map(sqlOf), ...triggerSql].join("\n")}`
-	};
-}
-//#endregion
-//#region src/cli/sql/write.ts
-const MODULE_TEST_MARKER = /^-- @bs-module-test ([a-z0-9-]+)$/m;
-/**
-* Test files a SQL module wrote for an earlier layout (a table that is no
-* longer audited), for the modules in `names`. With `appTables`, also the
-* app tables files once `appTables` is empty.
-*/
-async function staleModuleTests(config, names, sqlLayout, files, appTables = true) {
-	const dir = (sqlLayout.testsDir ?? CONFIG_DEFAULTS.sql.testsDir).replace(/\/$/, "");
-	const entries = await readdir(resolve(config.root, dir)).catch(() => []);
-	const current = new Set(files.map((file) => file.path));
-	const modules = /* @__PURE__ */ new Set([...resolveModules(names, sqlLayout).map((module) => module.name), ...appTables ? [APP_TABLES_MODULE] : []]);
-	const stale = appTables ? await staleAppTablesSchema(config, sqlLayout, current) : [];
-	for (const name of entries.toSorted()) {
-		const path = `${dir}/${name}`;
-		if (!name.endsWith(".test.sql") || current.has(path)) continue;
-		const text = await readFile(resolve(config.root, path), "utf-8");
-		const module = MODULE_TEST_MARKER.exec(text)?.[1];
-		if (module !== void 0 && modules.has(module)) stale.push(path);
-	}
-	return stale;
-}
-/** The app tables schema file, when `appTables` no longer renders it. */
-async function staleAppTablesSchema(config, sqlLayout, current) {
-	const path = `${(sqlLayout.dir ?? CONFIG_DEFAULTS.sql.dir).replace(/\/$/, "")}/${sqlLayout.prefix ?? CONFIG_DEFAULTS.sql.prefix}_app_tables.sql`;
-	if (current.has(path)) return [];
-	return (await readFile(resolve(config.root, path), "utf-8").catch(() => "")).split("\n").includes(APP_TABLES_MARKER) ? [path] : [];
-}
-/** A rendered module file as a plan entry, compared without its module version. */
-const moduleFile = (file) => ({
-	path: file.path,
-	contents: file.contents,
-	note: file.module,
-	same: sameModuleFile
-});
-async function write(config, args, names, sqlLayout, now, only, upgrade = []) {
-	const workflow = sqlWorkflow(config, await readSupabaseToml(config.root));
-	const migrations = workflow === "migrations";
-	const lines = [];
-	const dryRun = args["dry-run"] === true;
-	const rendered = renderModules(names, sqlLayout);
-	const files = rendered.filter((file) => only === void 0 || only.includes(file.module));
-	const written = files.filter((file) => !migrations || file.kind === "test");
-	const applied = await applyPlan(sqlPlan(config, {
-		regenerate: "better-supabase sql sync",
-		files: written.map((file) => moduleFile(file)),
-		remove: await staleModuleTests(config, only ?? names, sqlLayout, files, only === void 0)
-	}), { "dry-run": dryRun });
-	lines.push(...changeLines(applied));
-	const data = !dryRun && applied.changes.some((change, index) => (change.outcome === "create" || change.outcome === "update") && written[index]?.kind === "data");
-	if (migrations) {
-		const topics = await topicPolicyFile(config, moduleTopics(names, sqlLayout));
-		const written = await writeLatestMigration(config, MODULES_SUFFIX, renderModuleMigration({
-			files: rendered,
-			upgrade,
-			...topics === void 0 ? {} : { topics: topics.contents }
-		}), {
-			now: now(),
-			dryRun,
-			force: upgrade.length > 0
-		});
-		lines.push(written.line);
-		return lines;
-	}
-	lines.push(...await writeExtensionsMigration(config, files, dryRun, now));
-	if (data) lines.push("", DATA_NEXT);
-	if (workflow === "pg-delta") lines.push(...await enablePgDelta(config.root, dryRun));
-	return lines;
-}
-/** The command that takes the written modules to the database. */
-async function nextStep(config) {
-	const workflow = sqlWorkflow(config, await readSupabaseToml(config.root));
-	return workflow === "migrations" ? {
-		command: migrationCommand(workflow),
-		when: "applies the migration"
-	} : {
-		command: migrationCommand(workflow, "better_supabase_module"),
-		when: "creates a migration from the module files"
-	};
-}
-/** A note when migra's `schema_paths` is set and misses module files, which `supabase db diff` would then skip. */
-async function unlistedModuleFiles(config, names, sqlLayout) {
-	const toml = await readSupabaseToml(config.root);
-	const workflow = sqlWorkflow(config, toml);
-	if (workflow !== "migra") return [];
-	const order = await schemaPaths(config.root, toml, workflow);
-	if (!order.configured) return [];
-	const supabase = `${toml?.dir ?? "supabase"}/`;
-	const unlisted = new Set(order.unlisted);
-	const listed = new Set(order.files.filter((path) => !unlisted.has(path)));
-	const dir = `${config.sql.dir.replace(/\/$/, "")}/`;
-	const missing = renderModules(names, sqlLayout).filter((file) => file.kind !== "data").map((file) => file.path).filter((path) => path.startsWith(dir) && !listed.has(path));
-	if (missing.length === 0) return [];
-	return [
-		"",
-		`${toml?.path ?? "supabase/config.toml"} sets [db.migrations] schema_paths, and no entry matches these files, so \`supabase db diff\` skips them.`,
-		"Add them before the schemas that call their functions:",
-		...missing.map((path) => `  "./${path.startsWith(supabase) ? path.slice(supabase.length) : path}",`),
-		"Or switch to pg-delta, which orders the files by dependency: add [experimental.pgdelta] with enabled = true and remove schema_paths (doctor BS316)."
-	];
-}
-//#endregion
-export { write as a, unlistedModuleFiles as i, nextStep as n, topicPolicyFile as o, staleModuleTests as r, enablePgDelta as s, moduleFile as t };

package/dist/client-5YAtJjyT.d.ts

@@ -1,68 +0,0 @@
-import { b as DbError, f as Result } from "./result-BREt7qOh.js";
-import { n as Controller, t as AuthPort } from "./controller-BBXX1RMw.js";
-//#region src/blocks/billing/client.d.ts
-/** A plan the picker lists: a key from the app's plan catalog, plus whatever the app shows. */
-interface PlanOption {
-  readonly key: string;
-  readonly name: string;
-}
-/** The plans to offer and the tenant's current plan. */
-interface PlanCatalog<P> {
-  readonly plans: readonly P[];
-  /** The key of the tenant's current plan, `undefined` without a subscription. */
-  readonly current: string | undefined;
-}
-/** Where Checkout continues: Stripe's hosted page, or `undefined` when the server finished the change itself. */
-interface CheckoutStarted {
-  readonly url: string | undefined;
-}
-interface PlanPickerControllerOptions<P extends {
-  readonly key: string;
-} = PlanOption> {
-  readonly auth: AuthPort;
-  /**
-   * The plans and the current one, such as a server action that reads the
-   * app's plan catalog and the tenant's subscription. It throws on failure.
-   */
-  readonly load: () => Promise<PlanCatalog<P>>;
-  /** What a server already loaded: the first load is skipped. */
-  readonly initial?: PlanCatalog<P>;
-  /**
-   * Starts Checkout for a plan key on the server, such as a server action
-   * that calls `billing.checkout()`. The controller never talks to Stripe:
-   * the secret key stays on the server.
-   */
-  readonly checkout: (plan: string) => Promise<Result<CheckoutStarted>>;
-  /**
-   * Opens the Checkout URL: `location.assign(url)` on the web,
-   * `WebBrowser.openBrowserAsync(url)` from `expo-web-browser` in React Native.
-   */
-  readonly open: (url: string) => void | Promise<void>;
-}
-interface PlanPickerSnapshot<P> {
-  /** `undefined` until the first load. */
-  readonly plans: readonly P[] | undefined;
-  readonly current: string | undefined;
-  /** The plan whose Checkout is starting. */
-  readonly pending: string | undefined;
-  readonly error: DbError | undefined;
-}
-interface PlanPickerActions {
-  /**
-   * Starts Checkout for `plan` and opens its URL; a failure is also kept in
-   * `error`. Choosing the current plan does nothing.
-   */
-  readonly choose: (plan: string) => Promise<Result<CheckoutStarted>>;
-  readonly refresh: () => Promise<void>;
-}
-type PlanPickerController<P> = Controller<PlanPickerSnapshot<P>, PlanPickerActions>;
-/**
- * The plans with the tenant's current one, for a plan picker: `choose`
- * starts Checkout through the injected server action and opens the URL it
- * returns.
- */
-declare function createPlanPickerController<P extends {
-  readonly key: string;
-} = PlanOption>(options: PlanPickerControllerOptions<P>): PlanPickerController<P>;
-//#endregion
-export { PlanPickerController as a, createPlanPickerController as c, PlanPickerActions as i, PlanCatalog as n, PlanPickerControllerOptions as o, PlanOption as r, PlanPickerSnapshot as s, CheckoutStarted as t };

package/dist/client-9ZOirdtr.d.ts

@@ -1,122 +0,0 @@
-/// <reference lib="esnext.temporal" />
-import { T as ErrorMapper, b as DbError, t as AsyncResult } from "./result-BREt7qOh.js";
-import { n as Logger } from "./logger-DWVYUmwi.js";
-import { t as StandardSchemaV1 } from "./standard-BcUQuUgu.js";
-import { t as BlockTransport } from "./block-transport-DezJPPA0.js";
-import { r as BlockTemporalOptions } from "./block-helpers-CjcQM1yA.js";
-import { n as BlockHooks } from "./block-hooks-DcPJHztl.js";
-import { r as FieldsOf } from "./block-fields-DnaDbgZS.js";
-import { p as SubscriptionStatus } from "./topic-1WTkDnPd.js";
-import { n as TopicPort } from "./watch-topic-DWHy63ZJ.js";
-import { n as Controller, t as AuthPort } from "./controller-BBXX1RMw.js";
-//#region src/blocks/announcements/announcements.d.ts
-type AnnouncementSeverity = "info" | "success" | "warning" | "critical";
-/**
- * Who sees it: everyone, members of some tenants, members with some roles,
- * or tenants on some plans (entitlement lookup keys, with the entitlements
- * module).
- */
-type AnnouncementAudience = {
-  readonly type: "all";
-} | {
-  readonly type: "tenant";
-  readonly organizationIds: readonly string[];
-} | {
-  readonly type: "role";
-  readonly roles: readonly string[];
-} | {
-  readonly type: "plan";
-  readonly plans: readonly string[];
-};
-interface Announcement {
-  readonly id: string;
-  readonly title: string;
-  readonly body: string;
-  readonly severity: AnnouncementSeverity;
-  readonly href: string | undefined;
-  readonly startsAt: Temporal.Instant;
-  readonly endsAt: Temporal.Instant | undefined;
-  readonly dismissible: boolean;
-  readonly createdAt: Temporal.Instant;
-  readonly updatedAt: Temporal.Instant;
-}
-/** An announcement as staff see it, with its audience. */
-interface ManagedAnnouncement extends Announcement {
-  readonly audience: AnnouncementAudience;
-  readonly createdBy: string | undefined;
-}
-interface AnnouncementInput {
-  readonly title: string;
-  /** Plain text or Markdown; the app renders it. */
-  readonly body?: string;
-  readonly severity?: AnnouncementSeverity;
-  /** A link for "Learn more": `https://` or a path. */
-  readonly href?: string | null;
-  readonly audience?: AnnouncementAudience;
-  readonly startsAt?: Temporal.Instant;
-  readonly endsAt?: Temporal.Instant | null;
-  readonly dismissible?: boolean;
-}
-interface AnnouncementsOptions<S extends StandardSchemaV1 | undefined = undefined> extends BlockTemporalOptions {
-  /**
-   * A Standard Schema for the announcement columns the app adds
-   * (`blocks.announcements.options.extraColumns`), keyed by column name. It
-   * types and parses them on every read, and validates them on `publish`
-   * and `update`, which return a `validation` error for a bad value.
-   */
-  readonly fields?: S;
-  /** `withBlockHooks` hooks around the client's methods. */
-  readonly hooks?: NoInfer<BlockHooks<Announcements<FieldsOf<S>>>>;
-  /** Receives the errors `after` hooks throw. Default: `console`. */
-  readonly logger?: Logger;
-  readonly transport: BlockTransport;
-  /** The module schema, or its API schema: `defineBlocks` passes it from `blocks.generated.ts`. Default `better_supabase`. */
-  readonly schema?: string;
-  readonly mappers?: readonly ErrorMapper[];
-}
-/** `F` is the extra fields `options.fields` describes. */
-interface Announcements<F extends object = Record<never, never>> {
-  /** The caller's live, undismissed announcements; pass the active tenant for tenant, role and plan audiences. */
-  listActive(organizationId?: string | null): AsyncResult<readonly (Announcement & F)[]>;
-  /** Hides one for the caller; `false` when it was hidden already. */
-  dismiss(announcementId: string): AsyncResult<boolean>;
-  /** Every announcement; needs `announcements.manage` on the platform. */
-  list(): AsyncResult<readonly (ManagedAnnouncement & F)[]>;
-  /** Keys besides the input's own are the announcement's extra columns. */
-  publish(input: AnnouncementInput & Partial<F>): AsyncResult<ManagedAnnouncement & F>;
-  update(announcementId: string, input: Partial<AnnouncementInput> & Partial<F>): AsyncResult<ManagedAnnouncement & F>;
-  remove(announcementId: string): AsyncResult<boolean>;
-}
-declare function createAnnouncements<S extends StandardSchemaV1 | undefined = undefined>(options: AnnouncementsOptions<S>): Announcements<FieldsOf<S>>;
-//#endregion
-//#region src/blocks/announcements/client.d.ts
-interface AnnouncementsControllerOptions {
-  readonly client: Pick<Announcements, "listActive" | "dismiss">;
-  readonly auth: AuthPort;
-  readonly ports: {
-    readonly topic: TopicPort;
-  };
-  /** The active tenant, for tenant, role and plan audiences. */
-  readonly organizationId?: string | null;
-  /** The topic the module broadcasts to (`blockConfig.announcements.options.topic` from `blocks.generated.ts`); `null` loads once. */
-  readonly topic?: string | null;
-}
-interface AnnouncementsSnapshot {
-  /** `undefined` until the first load. */
-  readonly items: readonly Announcement[] | undefined;
-  readonly status: SubscriptionStatus;
-  readonly error: DbError | undefined;
-}
-interface AnnouncementsActions {
-  /** Hides one for the user, then drops it from `items`. */
-  readonly dismiss: (announcementId: string) => Promise<void>;
-  readonly refresh: () => Promise<void>;
-}
-type AnnouncementsController = Controller<AnnouncementsSnapshot, AnnouncementsActions>;
-/**
- * The signed-in user's live announcements, loaded again whenever staff
- * publish, change or remove one.
- */
-declare function createAnnouncementsController(options: AnnouncementsControllerOptions): AnnouncementsController;
-//#endregion
-export { createAnnouncementsController as a, AnnouncementInput as c, AnnouncementsOptions as d, ManagedAnnouncement as f, AnnouncementsSnapshot as i, AnnouncementSeverity as l, AnnouncementsController as n, Announcement as o, createAnnouncements as p, AnnouncementsControllerOptions as r, AnnouncementAudience as s, AnnouncementsActions as t, Announcements as u };