better-supabase 0.3.0 → 0.5.0

package/README.md

@@ -12,18 +12,18 @@
 
 ```bash
 pnpm add better-supabase @supabase/supabase-js
-pnpm add -D @better-supabase/cli pg
+pnpm add -D pg
 ```
 
-ESM only. The CLI ships as [`@better-supabase/cli`](https://www.npmjs.com/package/@better-supabase/cli), always at the same version as `better-supabase`, and needs Node 24 or later; the runtime entries run on every WinterTC runtime (Node, Deno, Bun, Workers, Supabase Edge Functions). TypeScript 6 and 7 are tested.
+ESM only. The package includes the `better-supabase` CLI, which needs Node 24 or later; the runtime entries run on every WinterTC runtime (Node, Deno, Bun, Workers, Supabase Edge Functions). TypeScript 6 and 7 are tested.
 
 ## Quick start
 
-Or start with `npx @better-supabase/cli init`, which detects your frameworks and prints the install command.
+Or start with `npx better-supabase init`, which detects your frameworks and prints the install command.
 
 ```bash
 supabase start
-pnpm better-supabase init   # config, src/lib/supabase.ts and framework glue
+pnpm better-supabase init   # config, src/lib/supabase/index.ts and framework glue
 pnpm better-supabase gen    # database.types.ts and generated.ts
 ```
 
@@ -33,9 +33,9 @@ import { defineSupabase } from "better-supabase";
 
 import { schema } from "./lib/supabase/generated.ts";
 
-export const sb = defineSupabase(schema);
+export const betterSupabase = defineSupabase(schema);
 
-const db = sb.connect(createClient(url, publishableKey));
+const db = betterSupabase.connect(createClient(url, publishableKey));
 
 const result = await db.customers.findMany({
   select: ["id", "name"],
@@ -53,6 +53,7 @@ if (!result.ok) return result; // DbError: kind, message, status, code
 | ---------------------------------------------------------- | ------------------------------------------------------------------------ |
 | `better-supabase`                                          | `defineSupabase`, repositories, `Result`, `DbError`, `SPEC_PINS`         |
 | `better-supabase/config`                                   | `defineConfig` and generators for `better-supabase.config.ts`            |
+| `better-supabase/cli`                                      | `run`, `registerCommand` and codegen for scripts that drive the CLI      |
 | `better-supabase/client`                                   | Browser repositories that follow the session                             |
 | `better-supabase/react`                                    | Provider, typed hooks and the server session                             |
 | `better-supabase/query`                                    | TanStack Query options with table-based invalidation                     |
@@ -63,6 +64,8 @@ if (!result.ok) return result; // DbError: kind, message, status, code
 | `better-supabase/hono`, `/orpc`, `/edge`                   | Framework adapters                                                       |
 | `better-supabase/mcp`                                      | MCP servers whose tools run as the signed-in user                        |
 | `better-supabase/jobs`                                     | Supabase Queues jobs, idempotency keys and a webhook inbox               |
+| `better-supabase/orgs`                                     | Organizations, members, invitations and switching from the SQL kit       |
+| `better-supabase/notifications`                            | Sending, listing and delivering notifications from the SQL kit           |
 | `better-supabase/list`                                     | Search, facets, sorting and pagination from one definition               |
 | `better-supabase/storage`, `/realtime`                     | Typed bucket paths and broadcast topics                                  |
 | `better-supabase/env`                                      | Validated Supabase settings                                              |

package/bin/better-supabase.js

@@ -0,0 +1,4 @@
+#!/usr/bin/env node
+// Checked in so pnpm can link the bin on a fresh install, before dist/ is built.
+// oxlint-disable-next-line import/no-unassigned-import -- the CLI module runs on import.
+import "../dist/cli/bin.js";

package/dist/{base64-CQeB1eSf.js → base64-D2gsioCY.js}

@@ -1,6 +1,6 @@
 //#region src/core/base64.ts
-const encoder = new TextEncoder();
-const decoder = new TextDecoder();
+const encoder = /* @__PURE__ */ new TextEncoder();
+const decoder = /* @__PURE__ */ new TextDecoder();
 /** Standard base64 (RFC 4648 section 4) of `input`, with padding. */
 function toBase64(input) {
 	const bytes = typeof input === "string" ? encoder.encode(input) : input;

package/dist/channel-FQW-CnGR.d.ts

@@ -0,0 +1,70 @@
+/// <reference lib="esnext.temporal" />
+//#region src/notifications/types.d.ts
+/** A subject a notification is about, e.g. `{ type: 'task', id: '42' }`. */
+interface NotificationSubject {
+  readonly type: string;
+  readonly id: string;
+  /** Shown in the list, e.g. the task title, kept as it was at send time. */
+  readonly label?: string;
+}
+/** One notification as its recipient sees it. */
+interface NotificationItem<K extends string = string, D = unknown> {
+  /** The recipient row id: pass it to `markRead` and `dismiss`. */
+  readonly id: string;
+  /** The shared event id, the same for every recipient. */
+  readonly eventId: string;
+  readonly type: K;
+  readonly data: D;
+  readonly tenant: string | null;
+  readonly actorId: string | null;
+  readonly subject: NotificationSubject | null;
+  readonly summary: string | null;
+  readonly actionPath: string | null;
+  readonly priority: string | null;
+  readonly createdAt: Temporal.Instant;
+  readonly readAt: Temporal.Instant | null;
+  readonly resolvedAt: Temporal.Instant | null;
+}
+/** What `render` returns: the text for one notification, in one locale. */
+interface RenderedText {
+  readonly title: string;
+  readonly body?: string;
+}
+//#endregion
+//#region src/notifications/channel.d.ts
+/** One pending delivery a channel sends: the notification and who gets it. */
+interface NotificationMessage {
+  readonly deliveryId: string;
+  /** The channel name, e.g. `email`. */
+  readonly channel: string;
+  /** 1 on the first try. */
+  readonly attempts: number;
+  readonly userId: string;
+  /** The recipient's `auth.users` email, for email channels. */
+  readonly email: string | null;
+  readonly notification: NotificationItem;
+  /** What `render` returned for it, when `createNotifications` has one. */
+  readonly text?: RenderedText;
+}
+interface NotificationSendResult {
+  /** `skipped` when the channel decided not to send. Defaults to `sent`. */
+  readonly status?: "sent" | "skipped";
+  /** The provider's name, e.g. `resend` or `fcm`. */
+  readonly provider?: string;
+  /** The provider's id for the message, kept for support and webhooks. */
+  readonly providerMessageId?: string;
+}
+/**
+ * Sends notifications on one channel (email, push, Slack). The delivery
+ * worker (`notifications.deliver()`) claims pending deliveries for the
+ * channel's `name` and calls `send` for each. Throwing retries the delivery
+ * after its lease, up to `maxAttempts`, then marks it `failed`.
+ */
+interface NotificationChannel {
+  readonly apiVersion: 1;
+  /** Matches the `channel` the deliveries were created for. */
+  readonly name: string;
+  send(message: NotificationMessage): NotificationSendResult | void | Promise<NotificationSendResult | void>;
+}
+//#endregion
+export { NotificationSubject as a, NotificationItem as i, NotificationMessage as n, RenderedText as o, NotificationSendResult as r, NotificationChannel as t };

package/dist/claims-BAf6c7is.js

@@ -0,0 +1,48 @@
+//#region src/core/claims.ts
+const DEFAULT_CLAIMS = {
+	tenant: "tenant_id",
+	scope: "tenant",
+	features: "features"
+};
+/** The configured claim names, with defaults for the ones codegen left out. */
+function claimsOf(meta) {
+	if (!meta?.claims) return DEFAULT_CLAIMS;
+	let claims = claimsByMeta.get(meta);
+	if (!claims) {
+		claims = {
+			...DEFAULT_CLAIMS,
+			...meta.claims
+		};
+		claimsByMeta.set(meta, claims);
+	}
+	return claims;
+}
+const claimsByMeta = /* @__PURE__ */ new WeakMap();
+/** Where the active tenant is read from: the top-level claim, then `app_metadata`. */
+function tenantClaimPaths(tenant = DEFAULT_CLAIMS.tenant) {
+	let paths = tenantPaths.get(tenant);
+	if (!paths) {
+		paths = [tenant, `app_metadata.${tenant}`];
+		tenantPaths.set(tenant, paths);
+	}
+	return paths;
+}
+const tenantPaths = /* @__PURE__ */ new Map();
+/** Claim paths come from configuration, so this stays small. */
+const segmentsByPath = /* @__PURE__ */ new Map();
+function segmentsOf(path) {
+	let segments = segmentsByPath.get(path);
+	if (!segments) {
+		segments = path.split(".");
+		if (segmentsByPath.size < 256) segmentsByPath.set(path, segments);
+	}
+	return segments;
+}
+/** The string at a dotted claim path, if any. */
+function claimAt(claims, path) {
+	let value = claims;
+	for (const segment of segmentsOf(path)) value = typeof value === "object" && value !== null ? value[segment] : void 0;
+	return typeof value === "string" && value.length > 0 ? value : void 0;
+}
+//#endregion
+export { tenantClaimPaths as i, claimAt as n, claimsOf as r, DEFAULT_CLAIMS as t };

package/dist/cli/_format-Cax5EsM9.js

@@ -0,0 +1,101 @@
+//#region ../../node_modules/.pnpm/confbox@0.3.1/node_modules/confbox/dist/_chunks/libs/detect-indent.mjs
+const e = /^(?:( )+|\t+)/;
+const t$1 = `space`;
+function n$1(e, n, r) {
+	return e && n === t$1 && r === 1;
+}
+function r$1(r, a) {
+	let o = /* @__PURE__ */ new Map(), s = 0, c, l;
+	for (let u of r.split(/\n/g)) {
+		if (!u) continue;
+		let r = u.match(e);
+		if (r === null) s = 0, c = ``;
+		else {
+			let e = r[0].length, u = r[1] ? t$1 : `tab`;
+			if (n$1(a, u, e)) continue;
+			u !== c && (s = 0), c = u;
+			let d = 1, f = 0, p = e - s;
+			if (s = e, p === 0) d = 0, f = 1;
+			else {
+				let e = Math.abs(p);
+				if (n$1(a, u, e)) continue;
+				l = i$1(u, e);
+			}
+			let m = o.get(l);
+			o.set(l, m === void 0 ? [1, 0] : [m[0] + d, m[1] + f]);
+		}
+	}
+	return o;
+}
+function i$1(e, n) {
+	return (e === t$1 ? `s` : `t`) + String(n);
+}
+function a$1(e) {
+	return {
+		type: e[0] === `s` ? t$1 : `tab`,
+		amount: Number(e.slice(1))
+	};
+}
+function o$1(e) {
+	let t, n = 0, r = 0;
+	for (let [i, [a, o]] of e) (a > n || a === n && o > r) && (n = a, r = o, t = i);
+	return t;
+}
+function s$1(e, n) {
+	return (e === t$1 ? ` ` : `	`).repeat(n);
+}
+function c(e) {
+	if (typeof e != `string`) throw TypeError(`Expected a string`);
+	let t = r$1(e, !0);
+	t.size === 0 && (t = r$1(e, !1));
+	let n = o$1(t), i, c = 0, l = ``;
+	return n !== void 0 && ({type: i, amount: c} = a$1(n), l = s$1(i, c)), {
+		amount: c,
+		type: i,
+		indent: l
+	};
+}
+//#endregion
+//#region ../../node_modules/.pnpm/confbox@0.3.1/node_modules/confbox/dist/_chunks/_format.mjs
+const t = Symbol.for(`__confbox_fmt__`);
+const n = /^(\s+)/;
+const r = /(\s+)$/;
+function i(e) {
+	return e.charCodeAt(0) === 65279 ? e.slice(1) : e;
+}
+function a(e, t = {}) {
+	return {
+		sample: t.indent === void 0 && t.preserveIndentation !== !1 && i(e).slice(0, t?.sampleSize || 1024),
+		whiteSpace: t.preserveWhitespace === !1 ? void 0 : {
+			start: n.exec(e)?.[0] || ``,
+			end: r.exec(e)?.[0] || ``
+		}
+	};
+}
+function o(e, n, r) {
+	!n || typeof n != `object` || Object.defineProperty(n, t, {
+		enumerable: !1,
+		configurable: !0,
+		writable: !0,
+		value: a(e, r)
+	});
+}
+function s(n, r) {
+	if (!n || typeof n != `object` || !(t in n)) return {
+		indent: r?.indent ?? 2,
+		whitespace: {
+			start: ``,
+			end: ``
+		}
+	};
+	let i = n[t];
+	return {
+		indent: r?.indent || c(i.sample || ``).indent,
+		whitespace: i.whiteSpace || {
+			start: ``,
+			end: ``
+		}
+	};
+}
+//#endregion
+export { o as n, s as r, i as t };

package/dist/cli/bin.d.ts

@@ -0,0 +1 @@
+export {}

package/dist/cli/bin.js

@@ -0,0 +1,48 @@
+#!/usr/bin/env node
+import { i as run } from "./run-BKR2W_79.js";
+import { t as colorEnabled } from "./style-C0NFdJRL.js";
+import { text } from "node:stream/consumers";
+//#region src/cli/bin.ts
+const clack = () => import("./prompts-BTYQGunc.js").then((module) => module.clackPrompter);
+const prompts = {
+	select: async (message, choices, initial) => (await clack()).select(message, choices, initial),
+	multiselect: async (message, choices, initial) => (await clack()).multiselect(message, choices, initial),
+	confirm: async (message) => (await clack()).confirm(message),
+	spinner: (message) => {
+		let stop;
+		let stopped = false;
+		clack().then((prompter) => {
+			if (!stopped) stop = prompter.spinner(message);
+		});
+		return () => {
+			stopped = true;
+			stop?.();
+		};
+	}
+};
+const controller = new AbortController();
+process.once("SIGINT", () => {
+	controller.abort();
+});
+process.once("SIGTERM", () => {
+	controller.abort();
+});
+const result = await run(process.argv.slice(2), {
+	cwd: process.cwd(),
+	env: process.env,
+	signal: controller.signal,
+	io: {
+		stdout: (chunk) => {
+			process.stdout.write(chunk);
+		},
+		stderr: (chunk) => {
+			process.stderr.write(chunk);
+		},
+		stdin: () => text(process.stdin),
+		color: colorEnabled(),
+		...process.stdin.isTTY && process.stdout.isTTY ? { prompts } : {}
+	}
+});
+process.exitCode = controller.signal.aborted ? 130 : result.code;
+//#endregion
+export {};