better-supabase 0.13.0 → 0.14.0

package/dist/index-WEafENqH.d.ts

@@ -0,0 +1,149 @@
+import { t as AsyncResult } from "./result-C6jDfedy.js";
+import { M as AnyFunctions, N as AnyModels } from "./executor-CPyrQdjh.js";
+import { l as PublicEnv } from "./index-NRMMhhEi.js";
+import { h as SessionEncoding } from "./resolve-CzUKTIMq.js";
+import { t as BetterSupabase } from "./define-Dw7pRO4h.js";
+import { i as KeyboardPort, l as StoragePort, n as DeepLinkPort, r as FilePickerPort, s as PushTokenPort, t as ClientPorts } from "./ports-DsJicwI2.js";
+import { i as BindClientOptions, r as BetterClient } from "./bind-Dz8y3T5T.js";
+import { n as FunctionContract } from "./function-contract-vPqwt1j4.js";
+import { FunctionInvokeOptions, SupabaseClient, SupabaseClientOptions } from "@supabase/supabase-js";
+//#region src/client/functions.d.ts
+/**
+ * `supabase.functions.invoke` options, without the body: `invoke` sends the
+ * input.
+ */
+type InvokeOptions = Omit<FunctionInvokeOptions, "body">;
+/** Edge Function contracts by function name. */
+type FunctionContracts = Readonly<Record<string, FunctionContract>>;
+/** Anything with supabase-js's `functions` client, e.g. a `SupabaseClient`. */
+interface FunctionsHost {
+  readonly functions: {
+    invoke(name: string, options?: FunctionInvokeOptions): Promise<{
+      data: unknown;
+      error: unknown;
+      response?: Response;
+    }>;
+  };
+}
+interface TypedFunctions<Contracts extends FunctionContracts> {
+  /**
+   * Calls the function with `input` as the JSON body. Problem Details from the
+   * function come back as their `DbError`; a network or relay failure is a
+   * `network` error.
+   */
+  invoke<N extends keyof Contracts & string>(name: N, ...[input, options]: undefined extends Contracts[N]["input"] ? [input?: Contracts[N]["input"], options?: InvokeOptions] : [input: Contracts[N]["input"], options?: InvokeOptions]): AsyncResult<Contracts[N]["output"]>;
+}
+/**
+ * Typed Edge Function calls over supabase-js's `functions` client. The
+ * contracts come from the functions' own code, imported as types:
+ *
+ * ```ts
+ * import type { SendInvite } from "../supabase/functions/send-invite/index.ts";
+ *
+ * const fns = functions<{ "send-invite": SendInvite }>(supabase);
+ * const invite = await fns.invoke("send-invite", { email }).orThrow();
+ * ```
+ */
+declare function functions<Contracts extends FunctionContracts>(host: FunctionsHost): TypedFunctions<Contracts>;
+//#endregion
+//#region src/client/web-ports.d.ts
+/** The part of a `ServiceWorkerRegistration` the push token port uses. */
+interface PushRegistrationLike {
+  readonly pushManager: {
+    getSubscription(): Promise<unknown>;
+    subscribe(options: {
+      readonly userVisibleOnly: boolean;
+      readonly applicationServerKey: Uint8Array<ArrayBuffer>;
+    }): Promise<unknown>;
+  };
+}
+/**
+ * The storage port over `localStorage` (or `sessionStorage`). Reads resolve
+ * with `null` and writes do nothing where storage is missing or blocked.
+ */
+declare function webStorage(kind?: "local" | "session"): StoragePort;
+/** The keyboard port over `keydown` on `window`; `mod` matches Cmd and Ctrl. */
+declare function webKeyboard(): KeyboardPort;
+/** The file picker port over a hidden `<input type="file">`. */
+declare function webFilePicker(): FilePickerPort;
+/** The deep link port over `location`, `popstate` and `hashchange`. */
+declare function webDeepLinks(): DeepLinkPort;
+interface WebPushTokenOptions {
+  /** The VAPID public key, base64url-encoded. */
+  readonly vapidPublicKey: string;
+  /**
+   * The service worker that receives the pushes. Default
+   * `navigator.serviceWorker.ready`.
+   */
+  readonly registration?: () => Promise<PushRegistrationLike>;
+}
+/**
+ * The push token port over the Push API: the token is the JSON of the browser's
+ * push subscription, which a Web Push sender needs.
+ */
+declare function webPushToken(options: WebPushTokenOptions): PushTokenPort;
+/**
+ * The web ports `createClient` uses: storage, the keyboard, the file picker and
+ * deep links.
+ */
+declare function webPorts(): ClientPorts;
+//#endregion
+//#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 (custom storage). React Native apps use
+   * `better-supabase/client/native`, which doesn't load `@supabase/ssr`.
+   */
+  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";
+  readonly cookies?: {
+    /**
+     * `tokens-only` keeps the user object out of the cookie (it lives in
+     * `auth.userStorage`, localStorage by default), so cookies stay small. Use
+     * the same value as the server's `encode`. Defaults to `user-and-tokens`.
+     */
+    readonly encode?: SessionEncoding;
+  };
+  readonly auth?: {
+    /** Where auth-js keeps the user object with `cookies.encode: 'tokens-only'`. */
+    readonly userStorage?: UserStorage;
+  };
+  /**
+   * `staleTime` for every query option in `bs.queries`. Above zero, a remount
+   * or a window focus reuses cached rows instead of refetching.
+   */
+  readonly staleTime?: number;
+  /**
+   * Platform services for the block hooks, over the web defaults (`webPorts()`
+   * and an upload port over Supabase Storage).
+   */
+  readonly ports?: ClientPorts;
+  /**
+   * `blockConfig` from `blocks.generated.ts`: the block hooks call the schema,
+   * function names and topics `gen` wrote.
+   */
+  readonly blocks?: BindClientOptions["blocks"];
+  /** The tenant the block hooks act in; default the session's tenant claim. */
+  readonly tenant?: BindClientOptions["tenant"];
+}
+type UserStorage = NonNullable<NonNullable<SupabaseClientOptions<"public">["auth"]>["userStorage"]>;
+/**
+ * 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 { webDeepLinks as a, webPorts as c, FunctionContracts as d, FunctionsHost as f, functions as h, WebPushTokenOptions as i, webPushToken as l, TypedFunctions as m, createClient$1 as n, webFilePicker as o, InvokeOptions as p, PushRegistrationLike as r, webKeyboard as s, ClientOptions as t, webStorage as u };

package/dist/index-Yep7auV-.d.ts

@@ -0,0 +1,287 @@
+import { b as DbError, f as Result, t as AsyncResult } from "./result-C6jDfedy.js";
+import { X as StoragePath, a as BucketConnectOptions, g as StorageAdminClient, i as BucketConfig, j as StorageClient, n as Bucket, r as BucketClient, s as BucketPolicy, x as TransformOptions } from "./bucket-TkB7_xv8.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()`.
+ *
+ * A crop keeps its shape: when `size` has no `height` but `src` already carries
+ * a `width` and `height` (a render URL from a variant), the height scales with
+ * the new width. Both sides stop at Storage's 2500 limit by the same factor.
+ *
+ * ```ts
+ * const imageUrl = storageImageUrl({ url: SUPABASE_URL });
+ * imageUrl(avatar, { width: 96 }) ?? avatar;
+ * ```
+ */
+declare function storageImageUrl(options: StorageImageOptions): (src: string, size: StorageImageSize) => string | undefined;
+/**
+ * Builds a `srcset` of public Storage images at `densities` times the size
+ * (`1x` and `2x` by default) for a plain `<img>`. Returns `undefined` for the
+ * URLs `storageImageUrl` leaves alone.
+ *
+ * ```tsx
+ * const srcSet = storageImageSrcSet({ url: SUPABASE_URL });
+ * <img
+ *   src={avatar}
+ *   srcSet={srcSet(avatar, { width: 96, height: 96 })}
+ *   width={96}
+ *   height={96}
+ * />;
+ * ```
+ */
+declare function storageImageSrcSet(options: StorageImageOptions): (src: string, size: StorageImageSize, densities?: readonly number[]) => 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, V extends string = never> {
+  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;
+  /** Replaces the preset's variants. */
+  readonly variants?: Readonly<Record<V, TransformOptions>>;
+}
+type AvatarBucketOptions<P extends string, Id extends string, V extends string = never> = ImageBucketOptions<P, Id, V>;
+interface OrganizationLogoBucketOptions<P extends string, Id extends string, V extends string = never> extends ImageBucketOptions<P, Id, V> {
+  /**
+   * 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}";
+/** The variant names of the image presets. */
+type ImageVariant = "sm" | "md" | "lg";
+/**
+ * A bucket for profile pictures: `{userId}/avatar-{version}.{ext}`, public, 2
+ * MiB of images, written only by their owner (the `owner` policy). Variants
+ * `sm`, `md` and `lg` are 48, 96 and 256 pixel square crops.
+ */
+declare function avatarBucket<const P extends string = typeof AVATAR_PATH, const Id extends string = "avatars", const V extends string = ImageVariant>(options?: AvatarBucketOptions<P, Id, V>): Bucket<P, Id, V>;
+/**
+ * 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. Variants `sm`, `md` and `lg` fit the whole logo in a 64, 128 or 256
+ * pixel square.
+ */
+declare function organizationLogoBucket<const P extends string = typeof LOGO_PATH, const Id extends string = "organization-logos", const V extends string = ImageVariant>(options?: OrganizationLogoBucketOptions<P, Id, V>): Bucket<P, Id, V>;
+//#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 { StoredRef as A, AnyBucket as C, Buckets as D, BucketWithId as E, storageImageUrl as F, fromStorageError as I, StorageImageOptions as M, StorageImageSize as N, ConnectedRef as O, storageImageSrcSet as P, organizationLogoBucket as S, BucketMap as T, IMAGE_TYPES as _, VectorHit as a, OrganizationLogoBucketOptions as b, VectorMetadata as c, defineVectorBucket as d, AnalyticsBucket as f, AvatarBucketOptions as g, defineAnalyticsBucket as h, VectorDistance as i, defineBuckets as j, ResolvedRef 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, BucketIdOf as w, avatarBucket as x, ImageVariant as y };

package/dist/index-eTY4kJzo.d.ts

@@ -0,0 +1,163 @@
+import { b as DbError, f as Result } from "./result-C6jDfedy.js";
+import { dt as SubjectRef, lt as SchemaMeta } from "./executor-CPyrQdjh.js";
+import { J as QuerySpec } from "./define-Dw7pRO4h.js";
+import { c as RealtimeClient, m as Topic, p as SubscriptionStatus } from "./topic-D9j8G2dw.js";
+import { StandardSchemaV1 } from "@standard-schema/spec";
+//#region src/realtime/subject-presence.d.ts
+/** The presence topic template; the subjects module's policies authorize it. */
+declare const SUBJECT_PRESENCE_TEMPLATE = "presence:{subjectType}:{subjectId}";
+type SubjectPresenceTopic<R extends boolean | StandardSchemaV1 = true> = Topic<typeof SUBJECT_PRESENCE_TEMPLATE, Record<never, never>, R>;
+/**
+ * The presence topic of a record, `presence:<type>:<id>`: who has it open.
+ * Anyone who can read the subject (`can_subject(type, id, 'read')`) joins it,
+ * so a channel uses its `conversation` subject, a comment thread its record and
+ * a document its own subject. Pass a schema to validate the tracked states.
+ *
+ * Presence states come from the clients, so show them as hints (a name, an
+ * avatar, a cursor) and never decide access on them.
+ */
+declare function subjectPresenceTopic<S extends StandardSchemaV1>(schema: S): SubjectPresenceTopic<S>;
+declare function subjectPresenceTopic(): SubjectPresenceTopic;
+/** `subjectPresenceTopic()` without a schema. */
+declare const subjectPresence: SubjectPresenceTopic;
+interface SubjectPresenceValues {
+  readonly subjectType: string;
+  readonly subjectId: string;
+}
+/**
+ * The topic values of a subject for `usePresence` and the bindings; `null` (no
+ * subject yet) pauses the join.
+ *
+ * ```tsx
+ * const { members } = usePresence(
+ *   subjectPresence,
+ *   subjectPresenceValues({ type: "conversation", id: conversationId }),
+ *   { state: { name, avatarUrl } },
+ * );
+ * ```
+ */
+declare function subjectPresenceValues(subject: SubjectRef | null | undefined): SubjectPresenceValues | null;
+//#endregion
+//#region src/realtime/live.d.ts
+/**
+ * What `liveQuery` needs from `betterSupabase`: metadata and the tables a spec
+ * reads.
+ */
+interface LiveSource {
+  readonly meta: SchemaMeta;
+  tablesOf(spec: QuerySpec): string[];
+}
+interface LiveQueryOptions {
+  /**
+   * Called once per burst of changes, with the app keys of the tables that
+   * changed.
+   */
+  readonly onChange: (tables: readonly string[]) => void;
+  /**
+   * Tenant value for tables scoped by a tenant column (`realtime-tables`
+   * topics).
+   */
+  readonly tenant?: string;
+  /**
+   * The signed-in user's id, for tables that broadcast per user
+   * (`realtime.users`).
+   */
+  readonly user?: string;
+  /**
+   * Waits this long after the last change before calling `onChange`. Defaults
+   * to 100 ms.
+   */
+  readonly debounceMs?: number;
+  /**
+   * Also reports a channel that errors after it joined (`error`) and its rejoin
+   * (`subscribed`), not only the first join.
+   */
+  readonly onStatus?: (status: SubscriptionStatus, error?: Error) => void;
+  /**
+   * Retries a first join that failed, after 1 s and then twice as long each
+   * time, up to 30 s. Pass `false` to stay in `error`. Defaults to `true`.
+   */
+  readonly retry?: boolean;
+}
+interface LiveSubscription extends Disposable, AsyncDisposable {
+  /** App keys of the watched tables. */
+  readonly tables: readonly string[];
+  /**
+   * Tables the query reads that don't broadcast changes (not in
+   * `realtime.tables`).
+   */
+  readonly unwatched: readonly string[];
+  readonly ready: Promise<void>;
+  unsubscribe(): Promise<void>;
+}
+/**
+ * A count from the server plus the spec to keep it live on the client:
+ * `bs.liveCount(spec)` makes one, `useLiveCount(seed)` reads it. `count` is
+ * `null` when the server read failed; the client then fetches it.
+ */
+interface LiveCountSeed<T extends string = string> {
+  readonly spec: QuerySpec<T, "count", number>;
+  readonly count: number | null;
+  /**
+   * When the count was taken (epoch ms). `useLiveCount` counts again after
+   * joining when it is older than a second.
+   */
+  readonly at?: number;
+}
+/**
+ * Topic a `realtime-tables` trigger broadcasts on:
+ * `bs:t:<schema>.<table>[:<tenant>]`, or `bs:t:<schema>.<table>:u:<user>` for a
+ * `realtime.users` table.
+ */
+declare function liveTopic(meta: SchemaMeta, table: string, tenant?: string, user?: string): string;
+/**
+ * Calls `onChange` when a table the spec reads changes, so you can refetch.
+ * Needs the `realtime-tables` SQL module and the tables in `realtime.tables`.
+ * Live queries on the same client share one channel per table, so any number of
+ * them can run at once.
+ *
+ * ```ts
+ * using live = liveQuery(betterSupabase, supabase, spec, {
+ *   onChange: () => refetch(),
+ * });
+ * ```
+ */
+declare function liveQuery(betterSupabase: LiveSource, client: RealtimeClient, spec: QuerySpec | readonly string[], options: LiveQueryOptions): LiveSubscription;
+/**
+ * What `liveCount` runs the spec with: a `db` from `betterSupabase.connect()`
+ * or `createClient()`.
+ */
+interface CountRunner {
+  $run(spec: QuerySpec): PromiseLike<Result<unknown>>;
+}
+interface LiveCountOptions extends Omit<LiveQueryOptions, "onChange"> {
+  readonly onCount: (count: number) => void;
+  /** A failed refetch; the previous count stays valid. */
+  readonly onError?: (error: DbError) => void;
+  /** Count right away. Defaults to `true`; pass `false` when you have a seed. */
+  readonly immediate?: boolean;
+  /**
+   * When the count you already have was taken (epoch ms). Counts again once the
+   * channel joins when that is more than a second ago, so a change made before
+   * the join is not lost.
+   */
+  readonly since?: number;
+}
+/**
+ * Keeps a count current: runs the `count` spec (a HEAD request) now, after each
+ * debounced change to a table it reads, and after the channel rejoins.
+ * Responses that arrive out of order are dropped.
+ *
+ * ```ts
+ * using live = liveCount(
+ *   betterSupabase,
+ *   supabase,
+ *   db,
+ *   betterSupabase.spec.notes.count(),
+ *   { onCount: (count) => render(count) },
+ * );
+ * ```
+ */
+declare function liveCount(betterSupabase: LiveSource, client: RealtimeClient, db: CountRunner, spec: QuerySpec<string, "count", number>, options: LiveCountOptions): LiveSubscription;
+//#endregion
+export { LiveSource as a, liveQuery as c, SubjectPresenceTopic as d, SubjectPresenceValues as f, subjectPresenceValues as h, LiveQueryOptions as i, liveTopic as l, subjectPresenceTopic as m, LiveCountOptions as n, LiveSubscription as o, subjectPresence as p, LiveCountSeed as r, liveCount as s, CountRunner as t, SUBJECT_PRESENCE_TEMPLATE as u };