better-supabase 0.12.0 → 0.13.0

package/dist/index-CrAKHNJF.d.ts

@@ -0,0 +1,287 @@
+import { b as DbError, f as Result, t as AsyncResult } from "./result-mijqfoJN.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-DBay-ICp.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-DLjs7j_z.d.ts

@@ -0,0 +1,61 @@
+import { c as InboxListSnapshot, i as ConversationSnapshot, l as InboxSource, p as InboxWidgetSnapshot, s as InboxListActions, t as ConversationActions, u as InboxWidgetActions } from "./client-BU5Yd0yO.js";
+//#region src/blocks/inbox/react/index.d.ts
+interface UseInboxOptions<T> {
+  /** The organization; the hook joins `inbox:org:<id>`. `null` waits. */
+  readonly organizationId: string | null;
+  readonly load: InboxSource<T>;
+  /**
+   * `blockConfig.inbox.options.topic` from `blocks.generated.ts`. Defaults to
+   * `inbox`.
+   */
+  readonly topic?: string;
+  /** Runs for each broadcast, e.g. to show a toast for `message`. */
+  readonly onMessage?: (event: string, payload: unknown) => void;
+}
+interface InboxListState<T> extends InboxListSnapshot<T>, InboxListActions {}
+/**
+ * The staff view of an organization's conversations, kept current: loads, then
+ * loads again after each ping on `inbox:org:<id>` and on rejoin.
+ */
+declare function useInbox<T>(options: UseInboxOptions<T>): InboxListState<T>;
+interface UseConversationOptions<T> {
+  /** `null` waits, e.g. before the widget opens a conversation. */
+  readonly conversationId: string | null;
+  /** The messages, oldest first. */
+  readonly load: InboxSource<T>;
+  readonly topic?: string;
+  /** How long a typing ping counts. Defaults to 5000 ms. */
+  readonly typingMs?: number;
+}
+interface ConversationState<T> extends ConversationSnapshot<T>, ConversationActions {}
+/**
+ * One conversation's messages, kept current over `inbox:<id>`, with typing
+ * pings between staff and the contact. Notes never reach this topic.
+ */
+declare function useConversation<T>(options: UseConversationOptions<T>): ConversationState<T>;
+interface UseInboxWidgetOptions<T> {
+  /**
+   * Opens the visitor's conversation, e.g. a server action that calls
+   * `inbox.conversations.open(inboxId, { message })` with the visitor's
+   * transport. Returns its id.
+   */
+  readonly open: (message: string) => Promise<string>;
+  /** Sends into the open conversation. */
+  readonly send: (conversationId: string, message: string) => Promise<void>;
+  readonly load: (conversationId: string) => Promise<readonly T[]>;
+  /**
+   * Remembers the conversation across reloads in the client's storage port
+   * (`localStorage` on the web). Defaults to `better-supabase:inbox-widget`.
+   */
+  readonly storageKey?: string | null;
+  readonly topic?: string;
+}
+interface InboxWidgetState<T> extends InboxWidgetSnapshot<T>, InboxWidgetActions {}
+/**
+ * The visitor side of an in-app inbox: the first message opens the
+ * conversation, later ones go into it, and the messages and typing pings stay
+ * current. Visitors without an account sign in anonymously first.
+ */
+declare function useInboxWidget<T>(options: UseInboxWidgetOptions<T>): InboxWidgetState<T>;
+//#endregion
+export { UseInboxOptions as a, useInbox as c, UseConversationOptions as i, useInboxWidget as l, InboxListState as n, UseInboxWidgetOptions as o, InboxWidgetState as r, useConversation as s, ConversationState as t };

package/dist/index-DbyDZZlc.d.ts

@@ -0,0 +1,53 @@
+import { ChatOnFinishCallback, ChatTransport, UIMessage } from "ai";
+import { UseChatHelpers } from "@ai-sdk/react";
+//#region src/ai-sdk/react/body.d.ts
+/** What a transport factory gets from `useAssistant`. */
+interface AssistantTransportConfig {
+  readonly api: string;
+  readonly model: string | undefined;
+  readonly body: Readonly<Record<string, unknown>> | undefined;
+  readonly headers: Readonly<Record<string, string>> | undefined;
+}
+//#endregion
+//#region src/ai-sdk/react/index.d.ts
+interface UseAssistantOptions {
+  /** The chat id; make one on the client for a new chat. */
+  readonly id: string;
+  /** The route of `createAssistant`. Defaults to `/api/chat`. */
+  readonly api?: string;
+  /** The model the next answer uses; the server checks it against the catalog. */
+  readonly model?: string;
+  /** The stored history, such as `toUIMessages(path)` from the server. */
+  readonly messages?: UIMessage[];
+  /** Picks up an answer that is still being written. Defaults to true. */
+  readonly resume?: boolean;
+  /** Extra fields for the request body. */
+  readonly body?: Readonly<Record<string, unknown>>;
+  readonly headers?: Readonly<Record<string, string>>;
+  readonly onError?: (error: Error) => void;
+  readonly onFinish?: ChatOnFinishCallback<UIMessage>;
+  /** Custom throttle wait in ms for message updates. */
+  readonly throttle?: number;
+  /**
+   * Makes the transport instead of the default one, such as `durableTransport`
+   * from `better-supabase/ai-sdk/workflow/react`. Pass a function defined
+   * outside the component, so the transport is kept.
+   */
+  readonly transport?: (config: AssistantTransportConfig) => ChatTransport<UIMessage>;
+  /** Sends again without user input, such as once every approval is answered. */
+  readonly sendAutomaticallyWhen?: (options: {
+    messages: UIMessage[];
+  }) => boolean | PromiseLike<boolean>;
+}
+type AssistantState = UseChatHelpers<UIMessage> & {
+  /** Stops the answer on the server too, so it is stored as stopped. */
+  stop: () => Promise<void>;
+};
+/**
+ * `useChat` wired to `createAssistant`: it sends only the new message (the
+ * server keeps the history), resumes a running answer after a reload and stops
+ * it on the server.
+ */
+declare function useAssistant(options: UseAssistantOptions): AssistantState;
+//#endregion
+export { AssistantTransportConfig as i, UseAssistantOptions as n, useAssistant as r, AssistantState as t };