better-supabase 0.13.0 → 0.14.0

package/dist/index-eoAU_QaY.d.ts

@@ -1,357 +0,0 @@
-import { b as DbError, f as Result, t as AsyncResult } from "./result-mijqfoJN.js";
-import { J as QuerySpec } from "./define-D0LSXmUP.js";
-import { $ as TemplateValues, C as UploadOptions, O as TtlPreset, S as UploadBody, l as ImageTransform, w as UrlOptions, x as TransformOptions } from "./bucket-DBay-ICp.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-CZvLXFND.js";
-import { t as AuthSnapshot } from "./bind-DcXLU1ul.js";
-import { t as AuthSession } from "./view-CKzCp8FW.js";
-import { r as LiveCountSeed } from "./index-C7-2ZS9f.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-CKEqR38q.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 `useImage` calls. */
-interface ImageSource<T, V extends string = never> {
-  readonly bucket: {
-    readonly id: string;
-    readonly public: boolean;
-    readonly variants: Readonly<Record<V, TransformOptions>>;
-  };
-  publicUrl(target: T, options?: {
-    readonly transform?: TransformOptions;
-    readonly cacheNonce?: string;
-  }): Result<string>;
-  signedUrl(target: T, options?: UrlOptions): AsyncResult<string>;
-}
-interface UseImageOptions {
-  /** Pixel densities for `srcSet`. Defaults to `[1, 2]`. */
-  readonly densities?: readonly number[];
-  /** How long signed URLs of a private bucket last. Defaults to `hour`. */
-  readonly ttl?: number | TtlPreset;
-  /** Added to the URLs so browsers fetch a replaced object again. */
-  readonly cacheNonce?: string;
-}
-interface StorageImage {
-  /** The URL at the first density; `undefined` while loading or paused. */
-  readonly src: string | undefined;
-  /** `url 1x, url 2x`; `undefined` while loading, paused, or for one density. */
-  readonly srcSet: string | undefined;
-  /** The transform's width and height, for the `<img>` attributes. */
-  readonly width: number | undefined;
-  readonly height: number | undefined;
-  readonly error: DbError | undefined;
-  readonly loading: boolean;
-}
-/**
- * The `src` and `srcSet` of a stored image at a variant or transform. Public
- * buckets build the URLs during render, with no request. Private buckets sign
- * one URL per density and sign them again before they expire, since a signed
- * URL's token covers the size it was signed at. Pass `null` as the target to
- * pause.
- *
- * ```tsx
- * const avatar = useImage(
- *   avatars,
- *   user ? { userId: user.id, version, ext } : null,
- *   "md",
- * );
- * <img
- *   src={avatar.src}
- *   srcSet={avatar.srcSet}
- *   width={avatar.width}
- *   height={avatar.height}
- *   alt=""
- * />;
- * ```
- */
-declare function useImage<T, V extends string = never>(source: ImageSource<T, V>, target: T | null | undefined, transform: ImageTransform<V>, options?: UseImageOptions): StorageImage;
-/** 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 { useAuth as A, useAction as C, BetterSupabaseProviderProps as D, BetterSupabaseProvider as E, useLiveCount as M, useLiveQuery as N, LiveCount as O, useSupabase as P, UseActionFormOptions as S, BetterHooks as T, PresenceHookOptions as _, Upload as a, ActionForm as b, UseImageOptions as c, useSignedUrl as d, useUpload as f, Presence as g, useDebouncedSearch as h, StorageImage as i, useBroadcast as j, createHooks as k, UseUploadOptions as l, DebouncedSearchOptions as m, SignedUrl as n, UploadStatus as o, DebouncedSearch as p, SignedUrlSource as r, UploadTarget as s, ImageSource as t, useImage as u, PresenceTopic as v, useActionForm as w, ActionHandle as x, usePresence as y };