better-supabase 0.5.0 → 0.6.0

package/dist/executor-XycESQPH.js

@@ -1,94 +0,0 @@
-import { c as mapDbError, n as dbError } from "./errors-DtwXa6b8.js";
-import { i as ok, n as err, o as toDbError } from "./result-BKiliPY7.js";
-import { t as compileSql } from "./sql-Coh6n4cC.js";
-//#region src/postgres/executor.ts
-function isPgError(value) {
-	return typeof value === "object" && value !== null && typeof value.code === "string";
-}
-/** node-postgres error fields to the shape `mapDbError` reads. */
-function fromPgError(error) {
-	if (!isPgError(error)) return void 0;
-	const raw = {};
-	if (error.code !== void 0) raw.code = error.code;
-	if (error.message !== void 0) raw.message = error.message;
-	if (error.detail !== void 0) raw.details = error.detail;
-	if (error.hint !== void 0) raw.hint = error.hint;
-	if (error.constraint !== void 0) raw.constraint = error.constraint;
-	if (error.column !== void 0) raw.column = error.column;
-	if (error.table !== void 0) raw.table = error.table;
-	return raw;
-}
-async function run(client, plan, op) {
-	const rows = plan.rows ? (await client.queryRaw(plan.rows.text, [...plan.rows.params])).map((entry) => entry.row) : [];
-	let count = null;
-	if (plan.count) {
-		const [first] = await client.queryRaw(plan.count.text, [...plan.count.params]);
-		count = first?.count ?? 0;
-	} else if (op.kind !== "select") count = rows.length;
-	for (const next of plan.chunks ?? []) {
-		const more = await run(client, next, op);
-		rows.push(...more.rows);
-		count = (count ?? 0) + (more.count ?? 0);
-	}
-	return {
-		rows,
-		count
-	};
-}
-/**
-* Executes repository operations as SQL on a direct Postgres connection.
-* Rows have the same shape as over PostgREST. RLS applies when the client
-* runs as the caller (`ctx.postgres`, `createPostgres().asUser()`).
-*/
-function postgresExecutor(client) {
-	return {
-		name: "postgres",
-		functionSources: true,
-		execute: (op, context) => executeOn(client, op, context),
-		async batch(ops, context) {
-			if (!client.transaction) return Promise.all(ops.map((op) => executeOn(client, op, context)));
-			try {
-				return await client.transaction(async (scoped) => {
-					const results = [];
-					for (const op of ops) {
-						const result = await executeOn(scoped, op, context);
-						if (!result.ok) throw new BatchFailed();
-						results.push(result);
-					}
-					return results;
-				});
-			} catch (cause) {
-				if (!(cause instanceof BatchFailed)) throw cause;
-				return Promise.all(ops.map((op) => executeOn(client, op, context)));
-			}
-		}
-	};
-}
-var BatchFailed = class extends Error {};
-async function executeOn(client, op, context) {
-	let plan;
-	try {
-		plan = compileSql(op);
-	} catch (cause) {
-		return err(toDbError(cause));
-	}
-	if (plan.never) return ok({
-		rows: [],
-		count: 0
-	});
-	if (context.signal?.aborted) return err(dbError("aborted", "The request was aborted"));
-	let result;
-	try {
-		result = plan.chunks && client.transaction ? await client.transaction((scoped) => run(scoped, plan, op)) : await run(client, plan, op);
-	} catch (cause) {
-		const raw = fromPgError(cause);
-		return err(raw ? mapDbError(raw, context.errorMappers) : toDbError(cause));
-	}
-	if (op.kind === "select" && op.single) {
-		if (result.rows.length > 1) return err(dbError("multiple_rows", `Expected one ${op.table.key} row`));
-		if (result.rows.length === 0 && op.single === "one") return err(dbError("not_found", `No ${op.table.key} row matched`));
-	}
-	return ok(result);
-}
-//#endregion
-export { postgresExecutor as n, fromPgError as t };

package/dist/impersonation-VfaGc4Q_.js

@@ -1,41 +0,0 @@
-//#region src/auth/impersonation.ts
-/** The `act` claim for an impersonated session. */
-function actClaim(options) {
-	return {
-		sub: options.actor,
-		reason: options.reason
-	};
-}
-/** The impersonator in `claims.act`, or `undefined` for a normal session. */
-function impersonatorOf(claims) {
-	const act = claims["act"];
-	if (typeof act !== "object" || act === null) return void 0;
-	const { sub, reason, session_id, read_only } = act;
-	if (typeof sub !== "string" || sub === "") return void 0;
-	return {
-		id: sub,
-		...typeof reason === "string" ? { reason } : {},
-		...typeof session_id === "string" ? { sessionId: session_id } : {},
-		...typeof read_only === "boolean" ? { readOnly: read_only } : {}
-	};
-}
-/**
-* The repository context of a signed-in user: the actor, with the
-* impersonator from `act`, and the claims. Every adapter builds it here, so
-* plugins see the same actor on the server, in middleware and in the browser.
-*/
-function userContext(user, claims) {
-	const impersonator = impersonatorOf(claims);
-	return {
-		actor: {
-			id: user.id,
-			kind: "user",
-			...user.role ? { role: user.role } : {},
-			...user.email ? { email: user.email } : {},
-			...impersonator ? { impersonator: impersonator.id } : {}
-		},
-		claims
-	};
-}
-//#endregion
-export { impersonatorOf as n, userContext as r, actClaim as t };

package/dist/index-BGdgBPdf.d.ts

@@ -1,161 +0,0 @@
-import { _ as DbError } from "./executor-BunPOO-k.js";
-import { Z as QuerySpec } from "./define-Bp_BZa5h.js";
-import { i as ClientAuth, t as AuthSnapshot } from "./index-DmXSxbLi.js";
-import { n as TemplateValues } from "./template-mbvlysOo.js";
-import { t as AuthSession } from "./view-BEf0diC5.js";
-import { a as LiveSource, g as Topic, h as SubscriptionStatus, p as SubscribeOptions, r as LiveCountSeed, u as EventSchemas, v as TopicHandlers, y as TopicMessage } from "./live-D9W2M5aO.js";
-import { SupabaseClient } from "@supabase/supabase-js";
-import { ReactNode } from "react";
-import { StandardSchemaV1 } from "@standard-schema/spec";
-import { QueryClient } from "@tanstack/query-core";
-//#region src/react/hooks.d.ts
-/** The parts of `createClient()` the provider needs. */
-interface ClientLike {
-  readonly betterSupabase: LiveSource;
-  readonly supabase: SupabaseClient;
-  readonly auth: ClientAuth;
-  readonly db: object;
-  readonly queries: object;
-}
-interface BetterSupabaseProviderProps {
-  readonly client: ClientLike;
-  /** better-supabase queries are removed when the user signs out or changes. */
-  readonly queryClient?: QueryClient;
-  readonly children?: ReactNode;
-}
-/** Provides the better-supabase client to the hooks. */
-declare function BetterSupabaseProvider(props: BetterSupabaseProviderProps): ReactNode;
-/** The session state for UI: `loading`, `signed-out` or `signed-in` with the user and claims. */
-declare function useAuth(): AuthSnapshot;
-declare function useSupabase(): SupabaseClient;
-interface BetterHooks<B extends ClientLike> {
-  /** Repositories bound to the current session. Re-renders when the user changes. */
-  readonly useDb: () => B["db"];
-  /** TanStack Query option factories: `useQuery(useQueries().customers.findMany())`. */
-  readonly useQueries: () => B["queries"];
-  readonly useSupabase: () => SupabaseClient;
-  readonly useAuth: () => AuthSnapshot;
-  /** `useSession()` typed by the client's `betterSupabase.claims(schema)` and `betterSupabase.userMetadata(schema)`. */
-  readonly useSession: () => AuthSession<ClaimsOf<B>, ProfileOf<B>>;
-}
-/** The claims type of a client's `betterSupabase.claims(schema)`, `unknown` without one. */
-type ClaimsOf<B extends ClientLike> = B["betterSupabase"] extends {
-  readonly claimsSchema: StandardSchemaV1<unknown, infer C> | undefined;
-} ? C : unknown;
-/** The profile type of a client's `betterSupabase.userMetadata(schema)`, `unknown` without one. */
-type ProfileOf<B extends ClientLike> = B["betterSupabase"] extends {
-  readonly userMetadataSchema: StandardSchemaV1<unknown, infer P> | undefined;
-} ? P : unknown;
-/**
- * Hooks typed for your schema.
- *
- * ```ts
- * export const { useDb, useQueries, useAuth } = createHooks<typeof bs>();
- * ```
- */
-declare function createHooks<B extends ClientLike>(): BetterHooks<B>;
-interface BroadcastOptions extends Omit<SubscribeOptions, "onStatus"> {
-  /**
-   * Refetch after each message: table keys (every query that read one of
-   * them), or a function returning query keys. Needs `queryClient` on the
-   * provider.
-   */
-  readonly invalidate?: readonly string[] | ((message: TopicMessage) => readonly (readonly unknown[])[]);
-}
-/**
- * Subscribes to a topic while mounted. Pass `null` values to pause. It
- * resubscribes when the topic or the signed-in user changes.
- *
- * ```ts
- * useBroadcast(customersTopic, orgId ? { orgId } : null, {}, { invalidate: ['customers'] });
- * ```
- */
-declare function useBroadcast<P extends string, E extends EventSchemas>(topic: Topic<P, E>, values: TemplateValues<P> | null | undefined, handlers?: TopicHandlers<E>, options?: BroadcastOptions): SubscriptionStatus;
-interface LiveQueryHookOptions {
-  /**
-   * Tenant for tenant-scoped tables. Defaults to the `config.claims.tenant`
-   * claim (`tenant_id`, top-level or in `app_metadata`).
-   */
-  readonly tenant?: string;
-  /** Defaults to 100 ms. */
-  readonly debounceMs?: number;
-}
-/**
- * Keeps a query fresh: invalidates every cached query that read a table the
- * spec touches whenever one of them changes. Pass `null` to pause. It
- * resubscribes when the spec, tenant or user changes.
- *
- * ```ts
- * const spec = betterSupabase.spec.customers.findMany({ include: { notes: true } });
- * const { data } = useQuery(q.$spec(spec));
- * useLiveQuery(spec);
- * ```
- */
-declare function useLiveQuery(spec: QuerySpec | null | undefined, options?: LiveQueryHookOptions): SubscriptionStatus;
-interface LiveCountHookOptions extends LiveQueryHookOptions {
-  /** The count to show before the first fetch, e.g. from the server. */
-  readonly initial?: number;
-}
-interface LiveCount {
-  /** `undefined` until the first count arrives. */
-  readonly count: number | undefined;
-  readonly status: SubscriptionStatus;
-  /** The last failed refetch; the previous count stays. */
-  readonly error: DbError | undefined;
-}
-/**
- * A count that stays current: refetches only the `count` spec (a HEAD
- * request) after each debounced change to a table it reads, and after the
- * channel rejoins. Takes a spec or a `bs.liveCount()` seed; pass `null` to
- * pause. Doesn't need a `QueryClient`.
- *
- * ```tsx
- * const { count } = useLiveCount(seed); // seed = await bs.liveCount(spec)
- * ```
- */
-declare function useLiveCount(source: QuerySpec<string, "count", number> | LiveCountSeed | null | undefined, options?: LiveCountHookOptions): LiveCount;
-//#endregion
-//#region src/react/notifications.d.ts
-/** Loads one list of items, e.g. a server action that calls `notifications.list()`. */
-type NotificationSource<T> = () => Promise<readonly T[]>;
-interface UseNotificationsOptions<T> {
-  /**
-   * The private topic the `notifications` module broadcasts to, e.g.
-   * `notifications:${userId}` (`kits.notifications.options.topic`). `null`
-   * loads once without realtime.
-   */
-  readonly topic: string | null;
-  /** The notifications, newest first. */
-  readonly load: NotificationSource<T>;
-  /** More items merged in, such as running jobs or pending approvals. */
-  readonly sources?: readonly NotificationSource<T>[];
-  /** Orders the merged list. Defaults to the order the sources return. */
-  readonly sort?: (a: T, b: T) => number;
-  /** The badge number. Defaults to the items without a `readAt`. */
-  readonly count?: (items: readonly T[]) => number;
-  /** Runs for each broadcast, e.g. to show a toast for `notification_created`. */
-  readonly onMessage?: (event: string, payload: unknown) => void;
-}
-interface NotificationsState<T> {
-  /** `undefined` until the first load. */
-  readonly items: readonly T[] | undefined;
-  readonly count: number;
-  readonly status: SubscriptionStatus;
-  readonly error: unknown;
-  /** Loads again, e.g. after marking items read. */
-  readonly refresh: () => Promise<void>;
-}
-/**
- * The signed-in user's notifications, kept current: loads them, then loads
- * again after each broadcast on `topic` and after the channel rejoins.
- *
- * ```tsx
- * const { items, count } = useNotifications({
- *   topic: `org:${orgId}:notifications:${userId}`,
- *   load: () => listNotifications(orgId),
- * });
- * ```
- */
-declare function useNotifications<T>(options: UseNotificationsOptions<T>): NotificationsState<T>;
-//#endregion
-export { useBroadcast as _, BetterHooks as a, useSupabase as b, BroadcastOptions as c, LiveCount as d, LiveCountHookOptions as f, useAuth as g, createHooks as h, useNotifications as i, ClaimsOf as l, ProfileOf as m, NotificationsState as n, BetterSupabaseProvider as o, LiveQueryHookOptions as p, UseNotificationsOptions as r, BetterSupabaseProviderProps as s, NotificationSource as t, ClientLike as u, useLiveCount as v, useLiveQuery as y };

package/dist/index-DOESKG27.d.ts

@@ -1,100 +0,0 @@
-/// <reference lib="esnext.temporal" />
-import { j as SchemaMeta } from "./types-Dnf_wRDz.js";
-import { a as EventHub, g as KitEventPattern, p as KitEvent, s as MutationNotice } from "./events-aIO7vsIk.js";
-import { l as MutationIntent } from "./plugin-o144f322.js";
-//#region src/events/index.d.ts
-/** A CloudEvents 1.0 event. Extension attributes are lowercase alphanumerics. */
-interface CloudEvent<T = unknown> {
-  readonly specversion: "1.0";
-  readonly id: string;
-  readonly source: string;
-  readonly type: string;
-  readonly subject?: string;
-  readonly time?: string;
-  readonly datacontenttype?: string;
-  readonly dataschema?: string;
-  readonly data?: T;
-  readonly [extension: string]: unknown;
-}
-declare const ROW_EVENT_TYPES: { readonly [K in MutationIntent]: string; };
-interface RowEventData {
-  readonly table: string;
-  readonly row: Readonly<Record<string, unknown>>;
-  readonly actorId?: string;
-}
-interface CloudEventOptions {
-  /** URI-reference of the producer, e.g. `https://crm.example.com` or `/crm`. */
-  readonly source: string;
-  /** Replaces the `dev.better-supabase` type prefix. */
-  readonly typePrefix?: string;
-  readonly id?: () => string;
-  readonly now?: () => Temporal.Instant;
-}
-/** Sends events somewhere: a queue, a bus, an outbox table, an HTTP endpoint. */
-interface EventSink {
-  send(events: readonly CloudEvent[]): void | Promise<void>;
-}
-/**
- * One CloudEvent per mutated row: `dev.better-supabase.row.created` with the
- * app-cased row and the actor in `data`, the primary key as `subject` and the
- * tenant as `partitionkey`. Writes that return no rows (soft
- * deletes, `returning: false`) send one event per known primary key, with the
- * key as `row`.
- */
-declare function toCloudEvents(notice: MutationNotice, options: CloudEventOptions & {
-  readonly meta?: SchemaMeta;
-}): CloudEvent<RowEventData>[];
-interface ForwardOptions extends CloudEventOptions {
-  /** Only forward these tables or kinds. */
-  readonly filter?: (notice: MutationNotice) => boolean;
-  /** Sink failures never fail the mutation. Defaults to the `Logger`. */
-  readonly onError?: (error: unknown, events: readonly CloudEvent[]) => void;
-}
-/**
- * Sends a CloudEvent for every mutation to `sink`. Returns a function that
- * stops forwarding. Sends in flight are tracked on `betterSupabase.events`
- * (`settled()`), which the Next adapter hands to `after()` and the edge
- * entry to `waitUntil`. Use an outbox (SQL kit) when events must not be lost.
- */
-declare function forwardMutations(betterSupabase: {
-  readonly events: EventHub;
-  readonly meta: SchemaMeta;
-}, sink: EventSink, options: ForwardOptions): () => void;
-/**
- * A kit event as a CloudEvent: `dev.better-supabase.support.started` with
- * the event data and the actor (`actorId`) as `data` and the tenant as
- * `partitionkey`.
- */
-declare function kitCloudEvent(event: KitEvent, options: CloudEventOptions): CloudEvent;
-interface ForwardKitOptions extends CloudEventOptions {
-  /** Only forward events that match, e.g. `support.*`. Defaults to all. */
-  readonly types?: readonly KitEventPattern[];
-  /** Sink failures never fail the kit call. Defaults to the `Logger`. */
-  readonly onError?: (error: unknown, events: readonly CloudEvent[]) => void;
-}
-/**
- * Sends a CloudEvent for every kit event (`support.*`, `org.*`, ...) to
- * `sink`. Returns a function that stops forwarding. Like
- * `forwardMutations`, sends are tracked on `betterSupabase.events`.
- */
-declare function forwardKitEvents(betterSupabase: {
-  readonly events: EventHub;
-}, sink: EventSink, options: ForwardKitOptions): () => void;
-type HttpMode = "structured" | "binary" | "batch";
-/** The HTTP protocol binding: headers and body for one event (or a batch). */
-declare function toHttp(events: CloudEvent | readonly CloudEvent[], mode?: HttpMode): {
-  headers: Record<string, string>;
-  body: string;
-}[];
-declare function isCloudEvent(value: unknown): value is CloudEvent;
-/** Reads CloudEvents from a request in any of the three HTTP modes. */
-declare function fromHttp(request: Request): Promise<CloudEvent[]>;
-interface HttpSinkOptions {
-  readonly mode?: HttpMode;
-  readonly headers?: Readonly<Record<string, string>>;
-  readonly fetch?: typeof fetch;
-}
-/** POSTs events to `url`. Non-2xx responses reject. */
-declare function httpSink(url: string | URL, options?: HttpSinkOptions): EventSink;
-//#endregion
-export { toHttp as _, ForwardOptions as a, ROW_EVENT_TYPES as c, forwardMutations as d, fromHttp as f, toCloudEvents as g, kitCloudEvent as h, ForwardKitOptions as i, RowEventData as l, isCloudEvent as m, CloudEventOptions as n, HttpMode as o, httpSink as p, EventSink as r, HttpSinkOptions as s, CloudEvent as t, forwardKitEvents as u };

package/dist/index-DmXSxbLi.d.ts

@@ -1,62 +0,0 @@
-import { n as AnyFunctions, r as AnyModels } from "./types-Dnf_wRDz.js";
-import { t as BetterSupabase, y as Db } from "./define-Bp_BZa5h.js";
-import { l as PublicEnv } from "./index-CLg87OBW.js";
-import { r as BetterQueries } from "./index-DgILJRXj.js";
-import { SupabaseClient } from "@supabase/supabase-js";
-//#region src/client/index.d.ts
-interface ClientOptions {
-  /** URL and publishable key. Not needed when `client` is given. */
-  readonly env?: PublicEnv;
-  /** Bring your own supabase-js client (React Native, custom storage). */
-  readonly client?: SupabaseClient;
-  /**
-   * `cookies` (default) shares the session with the server through
-   * `@supabase/ssr`; `local` keeps it in localStorage for SPAs without a server.
-   */
-  readonly storage?: "cookies" | "local";
-}
-interface AuthUser {
-  readonly id: string;
-  readonly email?: string;
-  readonly role?: string;
-}
-/** What the UI needs to know. Claims are decoded, not verified: RLS enforces access. */
-type AuthSnapshot = {
-  readonly status: "loading";
-  readonly user: null;
-  readonly claims: null;
-} | {
-  readonly status: "signed-out";
-  readonly user: null;
-  readonly claims: null;
-} | {
-  readonly status: "signed-in";
-  readonly user: AuthUser;
-  readonly claims: Readonly<Record<string, unknown>>;
-};
-interface ClientAuth {
-  readonly current: () => AuthSnapshot;
-  /** `useSyncExternalStore`-compatible. */
-  readonly subscribe: (listener: () => void) => () => void;
-}
-interface BetterClient<M extends AnyModels, F extends AnyFunctions, E, C = unknown, P = unknown> {
-  /** The definition the client was created from (schema metadata, specs, live queries). */
-  readonly betterSupabase: BetterSupabase<M, unknown, F, E, C, P>;
-  readonly supabase: SupabaseClient;
-  /** Repositories with the current session's actor and claims. */
-  readonly db: Db<M, F, E, SupabaseClient>;
-  /** TanStack Query option factories over `db`. */
-  readonly queries: BetterQueries<M, E, F>;
-  readonly auth: ClientAuth;
-}
-/**
- * The browser side: a supabase-js client, repositories that follow the
- * session, TanStack Query options and an auth store for UI state.
- *
- * ```ts
- * export const bs = createClient(betterSupabase, { env: { url, publishableKey } });
- * ```
- */
-declare function createClient$1<M extends AnyModels, D, F extends AnyFunctions, E, C = unknown, P = unknown>(betterSupabase: BetterSupabase<M, D, F, E, C, P>, options?: ClientOptions): BetterClient<M, F, E, C, P>;
-//#endregion
-export { ClientOptions as a, ClientAuth as i, AuthUser as n, createClient$1 as o, BetterClient as r, AuthSnapshot as t };

package/dist/index-Dxn2a5cw.d.ts

@@ -1,50 +0,0 @@
-import { c as ClaimsMeta, j as SchemaMeta } from "./types-Dnf_wRDz.js";
-import { d as Generator } from "./config-T_ejwyd3.js";
-//#region src/core/claims.d.ts
-declare const DEFAULT_CLAIMS: ClaimsMeta;
-/** Where the active tenant is read from: the top-level claim, then `app_metadata`. */
-declare function tenantClaimPaths(tenant?: string): readonly [string, string];
-//#endregion
-//#region src/generators/shared.d.ts
-/** What field planning reads: the metadata and the typed-jsonb config. */
-interface SchemaSource {
-  readonly meta: SchemaMeta;
-  readonly config: {
-    readonly json: Readonly<Record<string, unknown>>;
-  };
-}
-//#endregion
-//#region src/generators/json-schema.d.ts
-interface JsonSchemaGeneratorOptions {
-  /** Output path relative to the project root. Defaults to `<output>.schema.json`. */
-  readonly output?: string;
-  /** `$id` of the document. */
-  readonly id?: string;
-}
-type JsonSchema = Record<string, unknown>;
-/** JSON Schema (2020-12) `$defs` for every table: `customersRow`, `customersInsert`, ... */
-declare function buildJsonSchema(input: SchemaSource, id?: string): JsonSchema;
-/** Writes the JSON Schema document; `createOpenApi` reuses the same `$defs`. */
-declare function jsonSchema(options?: JsonSchemaGeneratorOptions): Generator;
-//#endregion
-//#region src/generators/valibot.d.ts
-interface ValibotGeneratorOptions {
-  /** Output path relative to the project root. Defaults to `<output>.valibot.ts`. */
-  readonly output?: string;
-  /** Schemas for typed jsonb columns: `{ 'customers.metadata': './schemas.ts#metadata' }`. */
-  readonly json?: Readonly<Record<string, string>>;
-}
-/** Valibot schemas for every table's Row, Insert and Update shape. */
-declare function valibot(options?: ValibotGeneratorOptions): Generator;
-//#endregion
-//#region src/generators/zod.d.ts
-interface ZodGeneratorOptions {
-  /** Output path relative to the project root. Defaults to `<output>.zod.ts`. */
-  readonly output?: string;
-  /** Schemas for typed jsonb columns: `{ 'customers.metadata': './schemas.ts#metadata' }`. */
-  readonly json?: Readonly<Record<string, string>>;
-}
-/** Zod 4 schemas for every table's Row, Insert and Update shape. */
-declare function zod(options?: ZodGeneratorOptions): Generator;
-//#endregion
-export { JsonSchemaGeneratorOptions as a, DEFAULT_CLAIMS as c, valibot as i, tenantClaimPaths as l, zod as n, buildJsonSchema as o, ValibotGeneratorOptions as r, jsonSchema as s, ZodGeneratorOptions as t };