better-supabase 0.8.0 → 0.9.0

package/dist/index-Bvw9r94Q.d.ts

@@ -0,0 +1,245 @@
+import { b as DbError, f as Result, t as AsyncResult } from "./result-Cj3yWhjH.js";
+import { C as BucketClient, D as BucketPolicy, F as StorageAdminClient, Q as StoragePath, S as Bucket, T as BucketConnectOptions, r as StorageClient, w as BucketConfig } from "./storage-api-Cx-1iWBd.js";
+import { SupabaseClient } from "@supabase/supabase-js";
+//#region src/storage/errors.d.ts
+/** Maps a Storage error (`StorageApiError`, fetch failures) to a `DbError`. */
+declare function fromStorageError(raw: unknown, table?: string): DbError;
+//#endregion
+//#region src/storage/image-url.d.ts
+interface StorageImageOptions {
+  /** Project URL, e.g. `import.meta.env.PUBLIC_SUPABASE_URL`. */
+  readonly url: string;
+  /** Resize mode for the transform. Defaults to Storage's own (`cover`). */
+  readonly resize?: "cover" | "contain" | "fill";
+}
+/** The size and quality to render an image at. */
+interface StorageImageSize {
+  readonly width: number;
+  readonly height?: number | undefined;
+  readonly quality?: number | undefined;
+}
+/**
+ * Turns public Storage object URLs into Supabase image transformation URLs
+ * (`/render/image/public`) at a given size. Any other URL (local files,
+ * other hosts, signed URLs) comes back as `undefined`: a signed URL's token
+ * covers the transform it was signed with, so sign it with `renderUrl()`.
+ *
+ * ```ts
+ * const imageUrl = storageImageUrl({ url: SUPABASE_URL })
+ * imageUrl(avatar, { width: 96 }) ?? avatar
+ * ```
+ */
+declare function storageImageUrl(options: StorageImageOptions): (src: string, size: StorageImageSize) => string | undefined;
+//#endregion
+//#region src/storage/registry.d.ts
+/** Any bucket definition from `defineBucket` or a preset. */
+type AnyBucket = Bucket<string>;
+type BucketMap = Readonly<Record<string, AnyBucket>>;
+/** The bucket ids of a registry's buckets. */
+type BucketIdOf<B extends BucketMap> = B[keyof B]["id"];
+/** The bucket of a registry whose id is `I`. */
+type BucketWithId<B extends BucketMap, I extends string> = Extract<B[keyof B], {
+  readonly id: I;
+}>;
+/** A stored object as rows keep it: the bucket id and the object path. */
+interface StoredRef {
+  /** The bucket id, e.g. a `bucket_id` column. */
+  readonly bucket: string;
+  readonly path: string;
+}
+/** A stored reference whose bucket is registered and whose path matches one of its templates. */
+interface ResolvedRef<B extends BucketMap> {
+  readonly bucket: B[keyof B];
+  readonly path: StoragePath<BucketIdOf<B>>;
+}
+/** A resolved reference with a client of its bucket. */
+interface ConnectedRef<B extends BucketMap> extends ResolvedRef<B> {
+  readonly storage: BucketClient<string, BucketIdOf<B>>;
+}
+interface Buckets<B extends BucketMap> {
+  /** The bucket definitions, by the names given. */
+  readonly buckets: B;
+  /** Every registered bucket id, in the order given. */
+  readonly ids: readonly BucketIdOf<B>[];
+  /** Whether `id` names a registered bucket. */
+  has(id: string): id is BucketIdOf<B>;
+  /** The bucket with this id, or `invalid_input` for an id no bucket has. */
+  byId<I extends BucketIdOf<B>>(id: I): Result<BucketWithId<B, I>>;
+  byId(id: string): Result<B[keyof B]>;
+  /**
+   * Checks a stored `{ bucket, path }`: the bucket must be registered and the
+   * path must match one of its templates. Either failure is `invalid_input`.
+   */
+  resolve(ref: StoredRef): Result<ResolvedRef<B>>;
+  /**
+   * `resolve`, then `connect` the bucket and check the path with the
+   * connected client, so a bucket with `tenant` also refuses another
+   * tenant's path (`forbidden`). No request is made.
+   */
+  connectStored(client: StorageClient, ref: StoredRef, options?: BucketConnectOptions): Result<ConnectedRef<B>>;
+}
+/**
+ * A registry of bucket definitions by id, for rows that store a bucket id
+ * next to an object path (files, attachments, sources). An id no bucket
+ * has, and a path outside the bucket's templates, are errors, never a
+ * fallback bucket.
+ *
+ * ```ts
+ * export const buckets = defineBuckets({ files, attachments, logos });
+ *
+ * const ref = buckets.connectStored(supabase, {
+ *   bucket: row.bucketId,
+ *   path: row.path,
+ * }, { context: db.$context });
+ * if (ref.ok) await ref.data.storage.signedUrl(ref.data.path);
+ * ```
+ */
+declare function defineBuckets<const B extends BucketMap>(buckets: B): Buckets<B>;
+//#endregion
+//#region src/storage/presets.d.ts
+/** The image types browsers display everywhere. */
+declare const IMAGE_TYPES: readonly string[];
+interface ImageBucketOptions<P extends string, Id extends string> {
+  readonly id?: Id;
+  /** The path template; keep the preset's placeholders the policy relies on. */
+  readonly path?: P | readonly [P, ...P[]];
+  /** Defaults to `true`: images load from their public URL without signing. */
+  readonly public?: boolean;
+  readonly fileSizeLimit?: string | number;
+  readonly allowedMimeTypes?: readonly string[];
+  /** Replaces the preset's policy. */
+  readonly policy?: BucketPolicy;
+}
+type AvatarBucketOptions<P extends string, Id extends string> = ImageBucketOptions<P, Id>;
+interface OrganizationLogoBucketOptions<P extends string, Id extends string> extends ImageBucketOptions<P, Id> {
+  /**
+   * The permission that may upload, replace and delete a logo, checked
+   * through the access contract. Defaults to `organization.update`, the
+   * `organizations` module's update permission.
+   */
+  readonly permission?: string;
+  /**
+   * The tenant segment connected clients are held to. `false` lets one
+   * client upload for any organization the policy allows. Defaults to
+   * `{ param: 'organizationId' }`.
+   */
+  readonly tenant?: BucketConfig["tenant"] | false;
+}
+declare const AVATAR_PATH = "{userId}/avatar-{version}.{ext}";
+declare const LOGO_PATH = "{organizationId}/logo-{version}.{ext}";
+/**
+ * A bucket for profile pictures: `{userId}/avatar-{version}.{ext}`, public,
+ * 2 MiB of images, written only by their owner (the `owner` policy).
+ */
+declare function avatarBucket<const P extends string = typeof AVATAR_PATH, const Id extends string = "avatars">(options?: AvatarBucketOptions<P, Id>): Bucket<P, Id>;
+/**
+ * A bucket for organization logos: `{organizationId}/logo-{version}.{ext}`, public,
+ * 2 MiB of images, written by members with the update permission through
+ * the access contract (`tenant_ids_with`), so it follows the app's roles.
+ */
+declare function organizationLogoBucket<const P extends string = typeof LOGO_PATH, const Id extends string = "organization-logos">(options?: OrganizationLogoBucketOptions<P, Id>): Bucket<P, Id>;
+//#endregion
+//#region src/storage/analytics-bucket.d.ts
+/** The Iceberg REST catalog of an analytics bucket, from `storage.analytics.from(id)`. */
+type AnalyticsCatalog = ReturnType<SupabaseClient["storage"]["analytics"]["from"]>;
+interface AnalyticsBucketClient {
+  /** Creates the bucket when it is missing. Needs the secret key. */
+  apply(): AsyncResult<{
+    readonly created: boolean;
+  }>;
+  /** The bucket's Iceberg catalog: namespaces and tables, each call returning `{ data, error }`. */
+  catalog(): AnalyticsCatalog;
+}
+interface AnalyticsBucket<Id extends string> {
+  readonly id: Id;
+  connect(client: StorageAdminClient): AnalyticsBucketClient;
+}
+/**
+ * A Storage analytics bucket: Apache Iceberg tables that query engines read
+ * through the Iceberg REST catalog.
+ *
+ * ```ts
+ * export const events = defineAnalyticsBucket({ id: "events" });
+ * await events.connect(admin).apply().orThrow();
+ * ```
+ */
+declare function defineAnalyticsBucket<const Id extends string>(config: {
+  readonly id: Id;
+}): AnalyticsBucket<Id>;
+//#endregion
+//#region src/storage/vector-bucket.d.ts
+type VectorDistance = "cosine" | "euclidean" | "dotproduct";
+interface VectorIndexConfig {
+  /** Number of values in every vector, e.g. 1536 for `text-embedding-3-small`. */
+  readonly dimension: number;
+  /** Defaults to `cosine`. */
+  readonly distanceMetric?: VectorDistance;
+  /** Metadata keys stored with each vector but not usable in `filter`. */
+  readonly nonFilterableMetadataKeys?: readonly string[];
+}
+interface VectorBucketConfig<Id extends string, I extends Readonly<Record<string, VectorIndexConfig>>> {
+  readonly id: Id;
+  readonly indexes: I;
+}
+type VectorMetadata = Readonly<Record<string, unknown>>;
+interface VectorRecord<M extends VectorMetadata = VectorMetadata> {
+  readonly key: string;
+  readonly vector: readonly number[];
+  readonly metadata?: M;
+}
+interface VectorHit<M extends VectorMetadata = VectorMetadata> {
+  readonly key: string;
+  /** Set by `query()`: smaller is closer for every metric. */
+  readonly distance?: number;
+  readonly metadata?: M;
+  readonly vector?: readonly number[];
+}
+interface VectorQueryOptions {
+  /** Number of matches, defaults to 10. */
+  readonly topK?: number;
+  /** A metadata filter, e.g. `{ organizationId: "o1" }` or `{ year: { $gte: 2024 } }`. */
+  readonly filter?: VectorMetadata;
+  /** Return each match's metadata. Defaults to `true`. */
+  readonly metadata?: boolean;
+}
+interface VectorIndexClient<M extends VectorMetadata = VectorMetadata> {
+  readonly name: string;
+  readonly dimension: number;
+  /** Inserts or replaces vectors by key, in batches of 500. */
+  put(records: readonly VectorRecord<M>[]): AsyncResult<number>;
+  /** The nearest vectors, closest first. */
+  query(vector: readonly number[], options?: VectorQueryOptions): AsyncResult<readonly VectorHit<M>[]>;
+  /** Vectors by key; missing keys are left out. */
+  get(keys: readonly string[], options?: {
+    readonly vector?: boolean;
+  }): AsyncResult<readonly VectorHit<M>[]>;
+  remove(keys: readonly string[]): AsyncResult<readonly string[]>;
+}
+interface VectorBucketClient<I extends string> {
+  /** Creates the bucket and any missing index. An index with another dimension or metric is a `conflict`. */
+  apply(): AsyncResult<{
+    readonly created: readonly string[];
+  }>;
+  index<M extends VectorMetadata = VectorMetadata>(name: I): VectorIndexClient<M>;
+}
+interface VectorBucket<Id extends string, I extends Readonly<Record<string, VectorIndexConfig>>> {
+  readonly id: Id;
+  readonly indexes: I;
+  connect(client: StorageAdminClient): VectorBucketClient<keyof I & string>;
+}
+/**
+ * A Storage vector bucket with typed indexes. Storage keeps the vectors
+ * outside Postgres; use the `vector-search` module for pgvector in a table.
+ *
+ * ```ts
+ * export const embeddings = defineVectorBucket({
+ *   id: "embeddings",
+ *   indexes: { documents: { dimension: 1536 } },
+ * });
+ * const docs = embeddings.connect(admin).index("documents");
+ * await docs.put([{ key: doc.id, vector, metadata: { organizationId } }]);
+ * ```
+ */
+declare function defineVectorBucket<const Id extends string, const I extends Readonly<Record<string, VectorIndexConfig>>>(config: VectorBucketConfig<Id, I>): VectorBucket<Id, I>;
+//#endregion
+export { defineBuckets as A, BucketIdOf as C, ConnectedRef as D, Buckets as E, StorageImageSize as M, storageImageUrl as N, ResolvedRef as O, fromStorageError as P, AnyBucket as S, BucketWithId as T, IMAGE_TYPES as _, VectorHit as a, avatarBucket as b, VectorMetadata as c, defineVectorBucket as d, AnalyticsBucket as f, AvatarBucketOptions as g, defineAnalyticsBucket as h, VectorDistance as i, StorageImageOptions as j, StoredRef as k, VectorQueryOptions as l, AnalyticsCatalog as m, VectorBucketClient as n, VectorIndexClient as o, AnalyticsBucketClient as p, VectorBucketConfig as r, VectorIndexConfig as s, VectorBucket as t, VectorRecord as u, ImageBucketOptions as v, BucketMap as w, organizationLogoBucket as x, OrganizationLogoBucketOptions as y };

package/dist/index-CETRk4YO.d.ts

@@ -0,0 +1,82 @@
+import { SupabaseEnv } from "@supabase/server";
+import { StandardSchemaV1 } from "@standard-schema/spec";
+//#region src/env/index.d.ts
+/** Validated Supabase settings. Only `publicEnv()` of it is safe to ship to a browser. */
+interface BetterSupabaseEnv {
+  readonly url: string;
+  readonly publishableKey: string;
+  readonly secretKey?: string;
+  /** Named secret keys from `SUPABASE_SECRET_KEYS`, including `default` when `secretKey` is set. */
+  readonly secretKeys?: Readonly<Record<string, string>>;
+  /** `SUPABASE_JWKS_URL`, or `<url>/auth/v1/.well-known/jwks.json`. */
+  readonly jwksUrl: URL;
+  /** `SUPABASE_JWKS`: inline keys, used instead of fetching `jwksUrl`. */
+  readonly jwks?: InlineJwks;
+  /** Direct Postgres connection string (`SUPABASE_DB_URL` / `DATABASE_URL`). */
+  readonly dbUrl?: string;
+  /** Project ref for hosted projects (`<ref>.supabase.co`). */
+  readonly projectRef?: string;
+  /** `SUPABASE_READ_URL`: a read replica or the `<ref>-all` load balancer, for reads. */
+  readonly readUrl?: string;
+  /**
+   * `SUPABASE_JWT_SECRET`: the shared HS256 secret Supabase Lite signs user
+   * tokens with (`auth.jwt_secret`). Server-only; read with `backend: "lite"`.
+   */
+  readonly jwtSecret?: string;
+}
+/** A JSON Web Key Set, as `@supabase/server` verifies with it. */
+type InlineJwks = Exclude<SupabaseEnv["jwks"], URL | null>;
+interface PublicEnv {
+  readonly url: string;
+  readonly publishableKey: string;
+}
+type EnvSource = Readonly<Record<string, string | undefined>>;
+interface EnvIssue {
+  /** The variable names that were checked, first one preferred. */
+  readonly variables: readonly string[];
+  readonly message: string;
+}
+interface EnvOptions {
+  /** Settings that must be present. `url` and `publishableKey` always are. */
+  readonly require?: readonly ("secretKey" | "dbUrl")[];
+}
+type EnvResult = {
+  readonly ok: true;
+  readonly env: BetterSupabaseEnv;
+  readonly issues?: undefined;
+} | {
+  readonly ok: false;
+  readonly env?: undefined;
+  readonly issues: readonly EnvIssue[];
+};
+declare const ENV_VARIABLES: {
+  readonly url: readonly string[];
+  readonly publishableKey: readonly string[];
+  readonly secretKey: readonly string[];
+  readonly dbUrl: readonly string[];
+  readonly jwksUrl: readonly string[];
+  readonly jwks: readonly string[];
+  readonly readUrl: readonly string[];
+  readonly jwtSecret: readonly string[];
+};
+declare class EnvValidationError extends Error {
+  override readonly name = "EnvValidationError";
+  readonly issues: readonly EnvIssue[];
+  constructor(issues: readonly EnvIssue[]);
+}
+/**
+ * Reads and validates Supabase settings. Accepts the `SUPABASE_`,
+ * `NEXT_PUBLIC_`, `VITE_`, `PUBLIC_`, `EXPO_PUBLIC_` and `NUXT_PUBLIC_`
+ * spellings. Issues name variables, never values.
+ */
+declare function parseEnv(source: EnvSource, options?: EnvOptions): EnvResult;
+/** Like `parseEnv`, but throws `EnvValidationError`. Reads `process.env` by default. */
+declare function loadEnv(source?: EnvSource, options?: EnvOptions): BetterSupabaseEnv;
+/** The env validator as a Standard Schema, for t3-env, framework config or any validator slot. */
+declare function envSchema(options?: EnvOptions): StandardSchemaV1<EnvSource, BetterSupabaseEnv>;
+/** The parts that are safe in client bundles. */
+declare function publicEnv(env: BetterSupabaseEnv): PublicEnv;
+/** Converts to `@supabase/server`'s `SupabaseEnv` (the `env` option of `withSupabase`). */
+declare function toServerEnv(env: BetterSupabaseEnv): SupabaseEnv;
+//#endregion
+export { EnvResult as a, InlineJwks as c, loadEnv as d, parseEnv as f, EnvOptions as i, PublicEnv as l, toServerEnv as m, ENV_VARIABLES as n, EnvSource as o, publicEnv as p, EnvIssue as r, EnvValidationError as s, BetterSupabaseEnv as t, envSchema as u };

package/dist/index-CrZitvSC.d.ts

@@ -0,0 +1,258 @@
+import { b as DbError, f as Result, t as AsyncResult } from "./result-Cj3yWhjH.js";
+import { H as UploadOptions, J as TemplateValues, U as UrlOptions, V as UploadBody } from "./storage-api-Cx-1iWBd.js";
+import { at as QuerySpec } from "./define-DxHHbNEb.js";
+import { c as RealtimeClient, d as SubscribeOptions, g as TopicHandlers, i as PresenceOptions, m as Topic, p as SubscriptionStatus, r as PresenceMember, s as PresenceSubscription, t as EventSchemas } from "./topic-cMS7UtM1.js";
+import { t as AuthSnapshot } from "./bind-a7sUgvf4.js";
+import { t as AuthSession } from "./view-Dv0A949a.js";
+import { r as LiveCountSeed } from "./index-BIi8i6BO.js";
+import { a as BroadcastOptions, c as LiveCountHookOptions, m as UseActionOptions, n as ActionInputOf, o as ClaimsOf, p as ProfileOf, r as ActionResultOf, s as ClientLike, u as LiveQueryHookOptions } from "./field-errors-CWXN_h_E.js";
+import { SupabaseClient } from "@supabase/supabase-js";
+import { ReactNode, SubmitEvent } from "react";
+import { QueryClient } from "@tanstack/query-core";
+//#region src/react/hooks.d.ts
+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>>;
+}
+/**
+ * Hooks typed for your schema.
+ *
+ * ```ts
+ * export const { useDb, useQueries, useAuth } = createHooks<typeof bs>();
+ * ```
+ */
+declare function createHooks<B extends ClientLike>(): BetterHooks<B>;
+/**
+ * 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, organizationId ? { organizationId } : 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;
+/**
+ * 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 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/actions.d.ts
+interface ActionHandle<I, T> {
+  /** Runs the action in a transition; resolves with its result. */
+  run(input: I): Promise<ActionResultOf<T>>;
+  /** True while a run is in flight, including the router update it causes. */
+  readonly pending: boolean;
+  /** The inputs of the runs in flight, e.g. to dim one table row. */
+  readonly pendingInputs: readonly I[];
+  /** The input of the latest run in flight. */
+  readonly pendingInput: I | undefined;
+  /** The data of the last successful run. */
+  readonly data: T | undefined;
+  /** The error of the last run, until the next one starts. */
+  readonly error: DbError | undefined;
+  reset(): void;
+}
+/**
+ * Calls a Server Action from an event handler: tracks pending inputs and the
+ * last result, and calls `onSuccess` or `onError`.
+ *
+ * ```tsx
+ * const remove = useAction(removeMember, { onError: (e) => toast.error(message(e)) });
+ * <Button disabled={remove.pendingInputs.some((p) => p.userId === id)} onClick={() => remove.run({ userId: id })} />
+ * ```
+ */
+declare function useAction<I, T>(action: (input: I) => Promise<ActionResultOf<T>>, options?: UseActionOptions<ActionInputOf<I>, T>): ActionHandle<ActionInputOf<I>, T>;
+interface UseActionFormOptions<T> {
+  readonly onSuccess?: (data: T, form: HTMLFormElement) => void;
+  readonly onError?: (error: DbError, form: HTMLFormElement) => void;
+  /** Clear the fields after a successful run. Defaults to true. */
+  readonly resetOnSuccess?: boolean;
+}
+interface ActionForm<T> {
+  /** Spread on the `<form>`. */
+  readonly formProps: {
+    readonly onSubmit: (event: SubmitEvent<HTMLFormElement>) => void;
+  };
+  readonly pending: boolean;
+  readonly data: T | undefined;
+  readonly error: DbError | undefined;
+  /** The first message per top-level field of a `validation` error. */
+  readonly fieldErrors: Readonly<Partial<Record<string, string>>>;
+  reset(): void;
+}
+/**
+ * A `<form>` that submits `FormData` to a Server Action. Fields keep what
+ * the user typed when the action fails (a `<form action>` resets them) and
+ * clear only on success.
+ *
+ * ```tsx
+ * const form = useActionForm(createCustomer, { onSuccess: () => toast.success('Saved') });
+ * <form {...form.formProps}>
+ *   <Input name="name" aria-invalid={form.fieldErrors.name !== undefined} />
+ * </form>
+ * ```
+ */
+declare function useActionForm<T>(action: (input: FormData) => Promise<ActionResultOf<T>>, options?: UseActionFormOptions<T>): ActionForm<T>;
+//#endregion
+//#region src/react/presence.d.ts
+interface PresenceHookOptions<I> {
+  /**
+   * The state this client shares while mounted. It is tracked after the
+   * join and tracked again when its JSON changes; `null` stays untracked.
+   */
+  readonly state?: I | null;
+  /** A supabase-js client for apps without `<BetterSupabaseProvider>`. */
+  readonly client?: SupabaseClient;
+}
+interface Presence<I, O> {
+  /** Everyone on the topic, this client included, from the last sync. */
+  readonly members: readonly PresenceMember<O>[];
+  readonly status: SubscriptionStatus;
+  /** Shares a state now; the `state` option tracks one for you. */
+  readonly track: (state: I) => Promise<DbError | undefined>;
+  readonly untrack: () => Promise<DbError | undefined>;
+}
+/** The parts of a `defineTopic(..., { presence })` topic the hook uses. */
+interface PresenceTopic<P extends string, I, O> {
+  topic(values: TemplateValues<P>): string;
+  match(topic: string): TemplateValues<P> | null;
+  subscribe(client: RealtimeClient, values: TemplateValues<P>, handlers: Readonly<Record<string, never>>, options?: SubscribeOptions & PresenceOptions<O>): PresenceSubscription<I, O>;
+}
+/**
+ * Joins a presence topic while mounted and returns who is on it. Pass
+ * `null` values to pause. It rejoins when the topic or the user changes.
+ *
+ * ```tsx
+ * const { members } = usePresence(roomTopic, { roomId }, { state: { name } });
+ * ```
+ */
+declare function usePresence<P extends string, I, O>(topic: PresenceTopic<P, I, O>, values: TemplateValues<P> | null | undefined, options?: PresenceHookOptions<I>): Presence<I, O>;
+//#endregion
+//#region src/react/search.d.ts
+interface DebouncedSearchOptions {
+  /** Defaults to 250 ms. */
+  readonly delayMs?: number;
+  /** Shorter terms count as no search. Defaults to 1. */
+  readonly minLength?: number;
+}
+interface DebouncedSearch {
+  /** What the input shows; updates on every keystroke. */
+  readonly value: string;
+  readonly setValue: (value: string) => void;
+  /** The trimmed value once typing pauses, or `undefined` below `minLength`. */
+  readonly term: string | undefined;
+  /** `term` with `%` and `_` escaped and wrapped in `%`, for `like` and `ilike`. */
+  readonly pattern: string | undefined;
+  /** `value` changed and `term` hasn't caught up yet. */
+  readonly pending: boolean;
+}
+/**
+ * A search box's value, debounced. Pass `term` to `contains` (which
+ * escapes it) or `pattern` to `ilike`; both are `undefined` while empty.
+ *
+ * ```tsx
+ * const search = useDebouncedSearch();
+ * useQuery(q.customers.findMany({ where: search.term ? { name: { contains: search.term } } : {} }));
+ * ```
+ */
+declare function useDebouncedSearch(initial?: string, options?: DebouncedSearchOptions): DebouncedSearch;
+//#endregion
+//#region src/react/storage.d.ts
+/** The part of a connected bucket `useSignedUrl` calls. */
+interface SignedUrlSource<T> {
+  signedUrl(target: T, options?: UrlOptions): AsyncResult<string>;
+}
+interface SignedUrl {
+  /** `undefined` until the first URL arrives, and while paused. */
+  readonly url: string | undefined;
+  readonly error: DbError | undefined;
+  readonly loading: boolean;
+}
+/**
+ * A signed URL for an object, signed again before it expires. Pass `null`
+ * as the target to pause. Connect the bucket with `cacheSignedUrls: true`
+ * so components showing the same object share one URL.
+ *
+ * ```tsx
+ * const { url } = useSignedUrl(avatars, user ? { userId: user.id } : null, { ttl: 'hour' });
+ * ```
+ */
+declare function useSignedUrl<T>(bucket: SignedUrlSource<T>, target: T | null | undefined, options?: UrlOptions): SignedUrl;
+/** The part of a connected bucket `useUpload` calls. */
+interface UploadTarget<T, R> {
+  upload(target: T, body: UploadBody, options?: UploadOptions): AsyncResult<R>;
+}
+type UploadStatus = "idle" | "uploading" | "done" | "error";
+interface Upload<T, R> {
+  readonly status: UploadStatus;
+  /** 0 to 1 while uploading; see `UploadOptions.onProgress` for when it is exact. */
+  readonly progress: number;
+  readonly data: R | undefined;
+  readonly error: DbError | undefined;
+  /** Starts an upload; a new one aborts the one in flight. */
+  readonly upload: (target: T, body: UploadBody, options?: Omit<UploadOptions, "signal" | "onProgress">) => Promise<Result<R>>;
+  /** Cancels the upload in flight. */
+  readonly abort: () => void;
+  /** Back to `idle`. */
+  readonly reset: () => void;
+}
+interface UseUploadOptions<R> {
+  readonly onSuccess?: (data: R) => void;
+  readonly onError?: (error: DbError) => void;
+}
+/**
+ * Uploads to a connected bucket with progress, abort and status state.
+ * Unmounting aborts the upload in flight.
+ *
+ * ```tsx
+ * const avatar = useUpload(avatars, { onSuccess: ({ path }) => save(path) });
+ * <input type="file" onChange={(e) => avatar.upload({ userId }, e.target.files[0], { upsert: true })} />
+ * <progress value={avatar.progress} />
+ * ```
+ */
+declare function useUpload<T, R>(bucket: UploadTarget<T, R>, options?: UseUploadOptions<R>): Upload<T, R>;
+//#endregion
+export { useSupabase as A, BetterSupabaseProviderProps as C, useBroadcast as D, useAuth as E, useLiveCount as O, BetterSupabaseProvider as S, createHooks as T, ActionHandle as _, UploadTarget as a, useActionForm as b, useUpload as c, useDebouncedSearch as d, Presence as f, ActionForm as g, usePresence as h, UploadStatus as i, useLiveQuery as k, DebouncedSearch as l, PresenceTopic as m, SignedUrlSource as n, UseUploadOptions as o, PresenceHookOptions as p, Upload as r, useSignedUrl as s, SignedUrl as t, DebouncedSearchOptions as u, UseActionFormOptions as v, LiveCount as w, BetterHooks as x, useAction as y };