better-supabase 0.3.0 → 0.5.0

package/dist/webhooks/index.d.ts

@@ -1,7 +1,12 @@
 /// <reference lib="esnext.temporal" />
-import { N as TableKey, O as Row, n as AnyModels, t as AnyFunctions } from "../types-DONv9SHN.js";
-import { o as Result } from "../result-c2OYgCV2.js";
-import { t as BetterSupabase } from "../define-DUbydmJa.js";
+import { P as TableKey, k as Row, n as AnyFunctions, r as AnyModels } from "../types-Dnf_wRDz.js";
+import { S as ErrorMapper, a as AsyncResult, u as Result } from "../executor-BunPOO-k.js";
+import { a as EventHub } from "../events-aIO7vsIk.js";
+import { t as BetterSupabase } from "../define-Bp_BZa5h.js";
+import { g as RequestContext } from "../plugin-o144f322.js";
+import { r as EventSink } from "../index-DOESKG27.js";
+import { i as sqlTransport, n as RpcClient, r as rpcTransport, t as KitTransport } from "../kit-transport-B82k1djG.js";
+import { _ as PublicUrlOptions, a as hmacSigner, b as publicUrl, c as WebhookSecretStore, d as WebhookPolicyError, f as WebhookRequest, g as AllowUrl, h as fetchTransport, i as WebhookSigner, l as sqlSecretStore, m as WebhookTransport, n as StandardWebhooksOptions, o as standardWebhooks, p as WebhookResponse, r as WebhookSignInput, s as RotateSecretOptions, t as HmacSignerOptions, u as FetchTransportOptions, v as ResolveHost, y as isPublicAddress } from "../signers-Cc6r98SW.js";
 //#region src/webhooks/verify.d.ts
 interface VerifiedWebhook<T = unknown> {
   readonly id: string;
@@ -73,6 +78,8 @@ interface AuthHooks {
         readonly site_url: string;
         readonly token_new: string;
         readonly token_hash_new: string;
+        /** Auth adds fields over time (`old_email`, `factor_type`, ...). */
+        readonly [key: string]: unknown;
       };
     };
     output: Record<never, never>;
@@ -149,6 +156,130 @@ export declare function isDatabaseWebhook(value: unknown): value is DatabaseWebh
  * Reads a database webhook payload for `table` as an app-cased change.
  * Returns `null` for other tables or payloads that aren't database webhooks.
  */
-export declare function databaseChange<M extends AnyModels, D, F extends AnyFunctions, E, T extends TableKey<M>>(sb: BetterSupabase<M, D, F, E>, table: T, payload: unknown): DatabaseChange<Row<M, T>> | null;
+export declare function databaseChange<M extends AnyModels, D, F extends AnyFunctions, E, T extends TableKey<M>>(betterSupabase: BetterSupabase<M, D, F, E>, table: T, payload: unknown): DatabaseChange<Row<M, T>> | null;
 //#endregion
-export type { AuthHookError, AuthHookKind, AuthHooks, DatabaseChange, DatabaseWebhookPayload, VerifiedWebhook, VerifyOptions, WebhookInput };
+//#region src/webhooks/outgoing.d.ts
+/** One claimed delivery, as `shouldDeliver`, `transform` and `headers` see it. */
+interface WebhookDelivery {
+  readonly id: string;
+  readonly endpointId: string;
+  readonly url: string;
+  readonly type: string;
+  readonly payload: unknown;
+  /** 1 on the first try. Counted when the delivery is claimed. */
+  readonly attempt: number;
+  readonly tenant: string | null;
+  readonly eventId: string | null;
+  readonly runId: string | null;
+  readonly createdAt: Temporal.Instant;
+}
+interface RetryPolicy {
+  /** Attempts before a delivery is dead-lettered. Defaults to 8. */
+  readonly maxAttempts?: number;
+  /**
+   * Seconds before the next attempt. Defaults to 5 seconds, 5 minutes, 30
+   * minutes, 2 hours, 5 hours, then 10 hours, each with full jitter. A
+   * receiver's `Retry-After` wins when it asks for longer, up to a day.
+   */
+  readonly backoff?: (attempt: number) => number;
+  /** Statuses worth retrying. Defaults to 408, 429 and 5xx; network errors always retry. */
+  readonly retryable?: (status: number) => boolean;
+}
+interface WebhooksOptions {
+  /** `sqlTransport(postgres.admin)` for the worker, or the user's connection to manage. */
+  readonly transport: KitTransport;
+  /** `kits.webhooks-out.schema`. Defaults to `better_supabase`. */
+  readonly schema?: string;
+  /** Defaults to `fetchTransport({ allowUrl })`. */
+  readonly http?: WebhookTransport;
+  /** Used by the default `http`. Defaults to `publicUrl()`. */
+  readonly allowUrl?: AllowUrl;
+  /** Defaults to `standardWebhooks()`. */
+  readonly signer?: WebhookSigner;
+  /** Defaults to `sqlSecretStore(transport)`. */
+  readonly secrets?: WebhookSecretStore;
+  readonly retry?: RetryPolicy;
+  /** Return `false` (or throw) to cancel a delivery instead of sending it. */
+  readonly shouldDeliver?: (delivery: WebhookDelivery) => boolean | Promise<boolean>;
+  /**
+   * The JSON body. Defaults to the Standard Webhooks envelope,
+   * `{ type, timestamp, data }`.
+   */
+  readonly transform?: (delivery: WebhookDelivery) => unknown;
+  /** Extra headers, e.g. an `idempotency-key`. */
+  readonly headers?: (delivery: WebhookDelivery) => Readonly<Record<string, string>>;
+  /** Characters of the response body kept in the log. Defaults to 2000. */
+  readonly responseBodyLimit?: number;
+  /** `betterSupabase.events`, for `webhook.*` kit events. */
+  readonly events?: EventHub;
+  readonly context?: RequestContext;
+  readonly errorMappers?: readonly ErrorMapper[];
+}
+interface PublishInput {
+  readonly type: string;
+  readonly data: unknown;
+  readonly tenant?: string;
+  /** With an id, publishing it again never queues a second delivery. */
+  readonly id?: string;
+}
+interface DispatchInput {
+  readonly endpointId: string;
+  readonly type: string;
+  readonly data: unknown;
+  /** An external run id stored with the delivery, e.g. a workflow run. */
+  readonly runId?: string;
+  readonly eventId?: string;
+}
+interface DeliverWebhooksOptions {
+  /** Deliveries per claim. Defaults to 25. */
+  readonly batch?: number;
+  /**
+   * Requests in flight at once. Defaults to 10, so a batch of 25 at the
+   * 10-second timeout finishes well inside the lease.
+   */
+  readonly concurrency?: number;
+  /** How long a claim holds a delivery. Defaults to `'2 minutes'`. */
+  readonly lease?: string;
+  readonly budgetMs?: number;
+}
+interface DeliverWebhooksResult {
+  readonly succeeded: number;
+  /** Failed attempts that will retry. */
+  readonly retrying: number;
+  /** Deliveries that ran out of attempts or can't succeed. */
+  readonly dead: number;
+  readonly canceled: number;
+  /** Endpoints disabled after failing for `disableAfter`. */
+  readonly disabled: number;
+}
+interface WebhooksRouteOptions extends DeliverWebhooksOptions {
+  readonly secret: string | undefined;
+  readonly onError?: (error: unknown) => void;
+}
+interface Webhooks {
+  /** Queues the event for each subscribed endpoint; returns how many. */
+  publish(event: PublishInput): AsyncResult<number>;
+  /** Sends to one endpoint outside its subscriptions; returns the delivery id. */
+  dispatch(input: DispatchInput): AsyncResult<string>;
+  /** Queues a finished delivery again. */
+  redeliver(deliveryId: string): AsyncResult<string>;
+  /** A new signing secret, returned once. */
+  rotateSecret(endpointId: string, options?: RotateSecretOptions): AsyncResult<string>;
+  /** Sends due deliveries. Run it from a cron route or a job. */
+  deliver(options?: DeliverWebhooksOptions): Promise<DeliverWebhooksResult>;
+  /** A `GET`/`POST` handler for Vercel Cron that runs `deliver` behind a bearer secret. */
+  deliverRoute(options: WebhooksRouteOptions): (request: Request) => Promise<Response>;
+  /**
+   * An `EventSink` that publishes CloudEvents, e.g. from the outbox relay.
+   * Endpoints subscribe to unprefixed types, so it removes `typePrefix`
+   * (`dev.better-supabase` by default, the relay's default) and the dot.
+   */
+  sink(options?: WebhookSinkOptions): EventSink;
+}
+interface WebhookSinkOptions {
+  /** The relay's `typePrefix`. */
+  readonly typePrefix?: string;
+}
+export declare function createWebhooks(options: WebhooksOptions): Webhooks;
+//#endregion
+export { type AllowUrl, type AuthHookError, type AuthHookKind, type AuthHooks, type DatabaseChange, type DatabaseWebhookPayload, type DeliverWebhooksOptions, type DeliverWebhooksResult, type DispatchInput, type FetchTransportOptions, type HmacSignerOptions, type KitTransport, type PublicUrlOptions, type PublishInput, type ResolveHost, type RetryPolicy, type RotateSecretOptions, type RpcClient, type StandardWebhooksOptions, type VerifiedWebhook, type VerifyOptions, type WebhookDelivery, type WebhookInput, WebhookPolicyError, type WebhookRequest, type WebhookResponse, type WebhookSecretStore, type WebhookSignInput, type WebhookSigner, type WebhookSinkOptions, type WebhookTransport, type Webhooks, type WebhooksOptions, type WebhooksRouteOptions, fetchTransport, hmacSigner, isPublicAddress, publicUrl, rpcTransport, sqlSecretStore, sqlTransport, standardWebhooks };