better-supabase 0.13.0 → 0.15.0

package/dist/types-SFRomQF7.d.ts

@@ -0,0 +1,624 @@
+/// <reference lib="esnext.temporal" />
+import { T as ErrorMapper, b as DbError, t as AsyncResult } from "./result-DZeA5KS6.js";
+import { Ft as RequestContext, xt as Actor } from "./types-DFdg_4yN.js";
+import { n as Logger } from "./logger-DWVYUmwi.js";
+import { i as CursorPageOptions, r as BlockTemporalOptions } from "./block-helpers-CRpAHrp_.js";
+import { n as SqlClient } from "./executor-hGjrop3A.js";
+import { t as BlockTransport } from "./block-transport-DWZSJrwN.js";
+import { n as BlockHooks } from "./block-hooks-DZN2w69m.js";
+import { t as BlockProblemOptions } from "./problem-DNwN8iGz.js";
+import { StandardSchemaV1 } from "@standard-schema/spec";
+//#region src/auth/delegation.d.ts
+/** One RFC 9396 `authorization_details` entry. */
+interface AuthorizationDetail {
+  readonly type: string;
+  readonly [field: string]: unknown;
+}
+//#endregion
+//#region src/blocks/queue/backends.d.ts
+/** The body of a queued message, on pgmq and the table backend alike. */
+interface QueueMessageBody {
+  readonly payload?: unknown;
+  readonly max_attempts?: number;
+  readonly last_error?: string;
+}
+/** A claimed message, as `better_supabase.claim_jobs` returns it. */
+interface QueueMessageRow {
+  readonly id: string | number;
+  /** 1 on the first claim; a lease token for complete, fail and extend. */
+  readonly attempts: number;
+  readonly enqueued_at: Date | string;
+  readonly visible_until: Date | string;
+  readonly message: QueueMessageBody | null;
+}
+/** A queue's counts, as `jobs.stats` returns them. */
+interface QueueStats {
+  /** Visible now: the next claim takes them. */
+  readonly ready: number;
+  /** Claimed by a worker, or waiting out the backoff before a retry. */
+  readonly inFlight: number;
+  /** Enqueued with a delay and not claimed yet. */
+  readonly delayed: number;
+  /** Dead letters kept in the archive. */
+  readonly dead: number;
+  /**
+   * Seconds since the oldest message that isn't done was enqueued; null when
+   * none is waiting.
+   */
+  readonly oldestAgeSeconds: number | null;
+}
+/** A dead letter, as `better_supabase.list_dead_jobs` returns it. */
+interface DeadJobRow {
+  readonly id: string | number;
+  readonly attempts: number;
+  readonly enqueued_at: Date | string;
+  readonly died_at: Date | string | null;
+  readonly message: QueueMessageBody | null;
+}
+/** A schedule whose run is due, claimed by `runSchedules`. */
+interface DueSchedule {
+  readonly name: string;
+  readonly cron: string;
+  readonly timeZone: string;
+  readonly queue: string;
+  /** The payload as stored, with its recorded context. */
+  readonly payload: unknown;
+  readonly nextRun: Temporal.Instant;
+}
+/** A Supabase client, or anything with `.schema(name).rpc(fn, args)`. */
+interface QueueRpcClient {
+  /**
+   * `never` parameters, so a typed `SupabaseClient<Database>` whose types leave
+   * out `pgmq_public` fits too.
+   */
+  schema(name: never): {
+    rpc(fn: never, args: never): PromiseLike<{
+      data: unknown;
+      error: unknown;
+    }>;
+  };
+}
+/**
+ * Where `createQueue` stores jobs. `sqlQueueProvider` (the `jobs` SQL module
+ * module, on pgmq or its table backend) and `pgmqPublicBackend` ship with the
+ * package; `testQueueProvider` from `better-supabase/testing` checks another
+ * one.
+ */
+interface QueueProvider {
+  readonly apiVersion: 1;
+  readonly name: string;
+  /** Whether `extend` works, so long-running batches keep their lease. */
+  readonly leases: boolean;
+  send(queue: string, payload: unknown, delay: number, maxAttempts: number, dedupeKey: string | undefined, dedupe?: "always" | "waiting"): Promise<number>;
+  /**
+   * Sends once per `dedupeKey`, counting archived messages too; `duplicate`
+   * when one existed. Absent when the backend can't.
+   */
+  sendOnce?(queue: string, payload: unknown, delay: number, maxAttempts: number, dedupeKey: string): Promise<{
+    readonly id: number;
+    readonly duplicate: boolean;
+  }>;
+  read(queue: string, lease: number, batch: number): Promise<readonly QueueMessageRow[]>;
+  /** `false` when the lease was lost. */
+  complete(job: Job): Promise<boolean>;
+  fail(job: Job, error: string, retryIn: number | undefined): Promise<"queued" | "dead" | null>;
+  extend(job: Job, lease: number): Promise<boolean>;
+  /**
+   * Re-enqueues a dead letter; `null` when it isn't one. Absent when the
+   * backend can't.
+   */
+  replay?(queue: string, id: number): Promise<number | null>;
+  /** Counts for one queue. Absent when the backend can't. */
+  stats?(queue: string): Promise<QueueStats>;
+  /**
+   * Dead letters, newest first, before `before` when given. Absent when the
+   * backend can't.
+   */
+  listDead?(queue: string, limit: number, before: number | undefined): Promise<readonly DeadJobRow[]>;
+  /**
+   * Re-enqueues the dead letters `ids`, or the newest `limit`; returns how
+   * many.
+   */
+  retryDead?(queue: string, ids: readonly number[] | undefined, limit: number): Promise<number>;
+  /**
+   * Deletes up to `batch` archived messages of `queue`; an unset option keeps
+   * the SQL default. Returns how many. Absent when the backend can't.
+   */
+  purge?(queue: string, options: QueuePurgeArgs): Promise<number>;
+  schedule(name: string, cron: string, queue: string, payload: unknown, timeZone: string, nextRun: Temporal.Instant, tenant?: string): Promise<void>;
+  unschedule(name: string): Promise<boolean>;
+  /**
+   * Schedules by name prefix and tenant. Absent when the backend can't list
+   * them.
+   */
+  listSchedules?(filter: ScheduleFilter): Promise<readonly ScheduleInfo[]>;
+  /**
+   * Removes a tenant's schedules and returns how many. Absent when the backend
+   * can't.
+   */
+  unscheduleTenant?(tenant: string): Promise<number>;
+  /** Leases due schedules (the drain scheduler); absent or empty with pg_cron. */
+  dueSchedules?(lease: number, batch: number): Promise<readonly DueSchedule[]>;
+  /**
+   * Moves a schedule from `ran` to `next`; `false` when it changed since the
+   * claim.
+   */
+  advanceSchedule?(name: string, ran: Temporal.Instant, next: Temporal.Instant): Promise<boolean>;
+}
+/**
+ * The `jobs` SQL module over a service SQL connection. The same functions back
+ * both `blocks.queue.options.backend` values (pgmq and table) and both
+ * schedulers. `now` dates a schedule's first run.
+ */
+declare function sqlQueueProvider(sql: SqlClient, now?: () => Temporal.Instant): QueueProvider;
+/** Options for `transportQueueProvider`. */
+interface TransportQueueProviderOptions {
+  /** The schema the functions live in. Defaults to `better_supabase`. */
+  readonly schema?: string;
+  /** Dates a schedule's first run. */
+  readonly now?: () => Temporal.Instant;
+}
+/** The intervals are Postgres intervals such as `"7 days"`. */
+interface QueuePurgeArgs {
+  readonly olderThan?: string | undefined;
+  readonly deadOlderThan?: string | undefined;
+  readonly batch?: number | undefined;
+}
+/**
+ * The `jobs` SQL module over a `BlockTransport`, with named arguments: a
+ * service-role `rpcTransport(supabase, { schema: "api" })` reaches the wrappers
+ * `blocks.queue.api` writes, so stats, dead letters, replays and schedules work
+ * without a direct Postgres connection. Over Postgres, pass the `SqlClient` to
+ * `createQueue` instead.
+ */
+declare function transportQueueProvider(transport: BlockTransport, options?: TransportQueueProviderOptions): QueueProvider;
+/**
+ * Supabase's `pgmq_public` RPCs (Integrations, Queues, "Expose Queues via
+ * PostgREST"). No lease check on complete, no retry delay, no deduplication and
+ * no schedules: a failed job reappears when its lease ends.
+ */
+declare function pgmqPublicBackend(client: QueueRpcClient): QueueProvider;
+//#endregion
+//#region src/blocks/queue/types.d.ts
+type QueueSchemas = Readonly<Record<string, StandardSchemaV1>>;
+type PayloadIn<Q extends QueueSchemas, N extends keyof Q> = StandardSchemaV1.InferInput<Q[N]>;
+type PayloadOut<Q extends QueueSchemas, N extends keyof Q> = StandardSchemaV1.InferOutput<Q[N]>;
+/**
+ * What a job records about the request that enqueued it, under wire names: the
+ * actor, the tenant, the ticket, and the delegation of the token, so
+ * `bsb.forContext(job.context)` runs the job under the same terms.
+ */
+interface JobContext {
+  readonly actor?: Actor;
+  readonly tenant?: string;
+  /**
+   * The RFC 8693 `act` claim: a support or impersonated session (a read-only
+   * support session stays read-only), or the full chain of an OAuth client or
+   * agent.
+   */
+  readonly act?: Readonly<Record<string, unknown>>;
+  /** The OAuth client of a delegated token. */
+  readonly client_id?: string;
+  /** The scopes the user granted the client, space-separated. */
+  readonly scope?: string;
+  /** The token's RFC 9396 authorization details. */
+  readonly authorization_details?: readonly AuthorizationDetail[];
+  /** The opaque ticket `forContext` resolves into the context the job runs as. */
+  readonly ticket?: string;
+  /** The permission keys a `forContext({ permissions })` cap left the work. */
+  readonly bsb_permission_cap?: readonly string[];
+}
+interface Job<P = unknown> {
+  /** The pgmq message id. */
+  readonly id: number;
+  readonly queue: string;
+  readonly payload: P;
+  /** 1 on the first run (pgmq's `read_ct`). */
+  readonly attempts: number;
+  readonly maxAttempts: number;
+  readonly enqueuedAt: Temporal.Instant;
+  /** End of the lease: the job becomes claimable again after this. */
+  readonly visibleUntil: Temporal.Instant;
+  readonly lastError: string | null;
+  /**
+   * The actor and tenant recorded at enqueue, ready for
+   * `bsb.forContext(job.context)`, which runs as that user with RLS. Without a
+   * recorded tenant, `membershipsExtension()` applies its `onMissing` unless
+   * the worker runs with `allTenants: true`.
+   */
+  readonly context: RequestContext;
+}
+interface EnqueueOptions {
+  /** Run no earlier than this. */
+  readonly runAt?: Temporal.Instant;
+  /**
+   * Whole seconds to wait before running; a fraction or a negative number is a
+   * `validation` error.
+   */
+  readonly delay?: number;
+  /** Defaults to 5. After this many failed attempts the job is archived as dead. */
+  readonly maxAttempts?: number;
+  /**
+   * While a job with this key is waiting or running, enqueueing again returns
+   * its id. SQL connections only.
+   */
+  readonly dedupeKey?: string;
+  /**
+   * Which jobs with the same `dedupeKey` take the enqueue: `"always"` (the
+   * default) a waiting or running one, `"waiting"` only one no worker has
+   * claimed yet, so a change made during a run queues one follow-up (a
+   * debounce).
+   */
+  readonly dedupe?: "always" | "waiting";
+  /**
+   * The request context whose actor and tenant the job records, next to the
+   * payload. The tenant is `context.tenant`, the one `membershipsExtension()`
+   * resolved, or the `tenant_id` claim (then `app_metadata.tenant_id`). A
+   * delegated token's `client_id`, `scope`, `authorization_details` and `act`
+   * chain are recorded too; an invalid `act` chain fails with `forbidden`.
+   */
+  readonly context?: RequestContext;
+  /**
+   * An opaque ticket, recorded instead of `context.ticket`.
+   * `bsb.forContext(job.context)` resolves it through the authorization
+   * provider's `tickets.subject` and runs as the context it returns.
+   */
+  readonly ticket?: string;
+}
+interface EnqueueOnceOptions extends Omit<EnqueueOptions, "dedupeKey" | "dedupe"> {
+  /** The key that makes the enqueue happen once. */
+  readonly dedupeKey: string;
+}
+interface EnqueueOnceResult {
+  readonly id: number;
+  /** True when a job with the key already existed; `id` is that job. */
+  readonly duplicate: boolean;
+}
+interface ScheduleOptions {
+  /** The actor and tenant every scheduled run records, as in `enqueue`. */
+  readonly context?: RequestContext;
+  /**
+   * The tenant the schedule belongs to, for `listSchedules({ tenant })` and
+   * `unscheduleAll({ tenant })`. Defaults to the tenant of `context`. Needs
+   * `blocks.queue.options.scheduler: "drain"`.
+   */
+  readonly tenant?: string;
+  /**
+   * The IANA time zone the cron fields are read in. Defaults to `UTC`. Other
+   * zones need `blocks.queue.options.scheduler: "drain"`.
+   */
+  readonly timeZone?: string;
+}
+/** One schedule of the set `ensureSchedules` keeps. */
+interface ScheduleDefinition<Q extends QueueSchemas, N extends Extract<keyof Q, string> = Extract<keyof Q, string>> extends ScheduleOptions {
+  readonly name: string;
+  readonly cron: string;
+  readonly queue: N;
+  readonly payload: PayloadIn<Q, N>;
+}
+/** Each queue's `ScheduleDefinition`, so `payload` follows `queue`. */
+type ScheduleDefinitions<Q extends QueueSchemas> = { readonly [N in Extract<keyof Q, string>]: ScheduleDefinition<Q, N>; }[Extract<keyof Q, string>];
+interface EnsureSchedulesOptions {
+  /**
+   * The set's name prefix, such as `workflow:`. Every definition's name starts
+   * with it, and existing schedules under it that the set doesn't name are
+   * removed.
+   */
+  readonly prefix: string;
+  /**
+   * Only this tenant's schedules under the prefix are compared and removed, and
+   * definitions without their own tenant get it.
+   */
+  readonly tenant?: string;
+}
+interface EnsureSchedulesResult {
+  /** The names written, in the order given. */
+  readonly scheduled: readonly string[];
+  /** Schedules under the prefix that the set no longer names. */
+  readonly removed: readonly string[];
+}
+interface ListDeadOptions extends CursorPageOptions<number> {
+  /** Defaults to 100, at most 1000. */
+  readonly limit?: number;
+  /** Only dead letters with a lower id, for the next page. */
+  readonly cursor?: number;
+}
+interface RetryDeadOptions {
+  /** The dead letters to retry. Defaults to the newest `limit`. */
+  readonly ids?: readonly number[];
+  /** Defaults to 1000. */
+  readonly limit?: number;
+}
+interface PurgeJobsOptions<N extends string = string> {
+  readonly queues?: readonly N[];
+  /** Seconds, or an interval such as `"7 days"`. */
+  readonly olderThan?: number | string;
+  /** Seconds, or an interval such as `"30 days"`. */
+  readonly deadOlderThan?: number | string;
+  /** Defaults to 10000. */
+  readonly batch?: number;
+}
+/** A dead letter as `listDead` returns it. */
+interface DeadJob<P = unknown> {
+  readonly id: number;
+  readonly queue: string;
+  /** The stored payload, unvalidated: its schema may have changed since. */
+  readonly payload: P;
+  readonly context: RequestContext;
+  readonly attempts: number;
+  readonly maxAttempts: number;
+  readonly lastError: string | null;
+  readonly enqueuedAt: Temporal.Instant;
+  /** When it was archived as dead. */
+  readonly diedAt: Temporal.Instant | null;
+}
+interface RunSchedulesOptions {
+  /** Seconds a claimed schedule stays leased. Defaults to 60. */
+  readonly lease?: number;
+  /** Defaults to 100. */
+  readonly batch?: number;
+}
+interface DrainOptions extends Omit<WorkOptions, "pollInterval" | "maxPollInterval" | "signal"> {
+  /** Stop claiming after this many ms; claimed jobs still finish. */
+  readonly budgetMs?: number;
+}
+interface DrainRouteOptions<Q extends QueueSchemas> extends Omit<DrainOptions, "onError">, BlockProblemOptions {
+  /**
+   * The bearer token callers send (`Authorization: Bearer <secret>`), such as
+   * Vercel's `CRON_SECRET`. Required.
+   */
+  readonly secret: string | undefined;
+  /** The queues to drain, in order, with their handlers. */
+  readonly handlers: { readonly [N in Extract<keyof Q, string>]?: JobHandler<PayloadOut<Q, N>>; };
+  /** Total time in ms for schedules and queues. Defaults to 50000. */
+  readonly budgetMs?: number;
+  /** Enqueue due schedules first (the drain scheduler). Defaults to true. */
+  readonly schedules?: boolean;
+  readonly onError?: (error: DbError, job?: Job) => void;
+  /** Hooks around each authorized drain, such as cron monitor check-ins. */
+  readonly monitor?: DrainMonitor;
+}
+interface DrainRouteResult {
+  /** Schedules whose run was enqueued. */
+  readonly schedules: number;
+  readonly queues: Readonly<Record<string, DrainResult>>;
+  /** True when the budget ran out before every queue was empty. */
+  readonly budgetExhausted: boolean;
+  /**
+   * Schedule or queue runs that failed as a whole (individual job failures are
+   * in `queues`).
+   */
+  readonly errors: number;
+}
+/**
+ * Hooks around one authorized drain, for cron monitoring such as Sentry
+ * check-ins. A hook that throws is reported to `onError` and never fails the
+ * drain.
+ */
+interface DrainMonitor {
+  /**
+   * Before schedules run. Its return value (a check-in id) is passed to
+   * `onFinish`.
+   */
+  onStart?(request: Request): unknown;
+  /** After the queues ran, with the result the route answers with. */
+  onFinish?(result: DrainRouteResult, started: unknown): unknown;
+}
+/** A schedule as `listSchedules` returns it. */
+interface ScheduleInfo {
+  readonly name: string;
+  readonly cron: string;
+  readonly timeZone: string;
+  /** Null under pg_cron, which keeps only the command. */
+  readonly queue: string | null;
+  readonly tenant: string | null;
+  /** The next run; null under pg_cron. */
+  readonly nextRun: Temporal.Instant | null;
+  readonly lastRun: Temporal.Instant | null;
+  /** Set while a drain holds the schedule. */
+  readonly leasedUntil: Temporal.Instant | null;
+  readonly createdAt: Temporal.Instant | null;
+}
+interface ScheduleFilter {
+  /** Schedules whose name starts with this, e.g. `workflow:`. */
+  readonly prefix?: string;
+  readonly tenant?: string;
+}
+interface ClaimOptions {
+  /** Defaults to 1. */
+  readonly batch?: number;
+  /** Seconds a claimed job stays invisible to other workers. Defaults to 300. */
+  readonly lease?: number;
+}
+interface FailOptions {
+  /**
+   * Retry after this many seconds instead of the exponential backoff. SQL
+   * connections only.
+   */
+  readonly retryIn?: number;
+}
+type JobHandler<P> = (payload: P, job: Job<P>, signal: AbortSignal) => unknown;
+interface WorkOptions extends ClaimOptions {
+  /** Jobs handled at once. Defaults to 1. */
+  readonly concurrency?: number;
+  /**
+   * First wait between polls when the queue is empty, in ms. Defaults to 1000.
+   * Each empty poll doubles the wait up to `maxPollInterval`; a claimed job
+   * resets it.
+   */
+  readonly pollInterval?: number;
+  /** Longest wait between empty polls, in ms. Defaults to 30000. */
+  readonly maxPollInterval?: number;
+  /** Stops the loop; running jobs finish first. */
+  readonly signal?: AbortSignal;
+  readonly onError?: (error: DbError, job: Job) => void;
+  /**
+   * Run jobs that recorded no tenant with a context that
+   * `membershipsExtension()` and tenant buckets don't scope. Off by default, so
+   * such jobs get the `onMissing` of `membershipsExtension()`.
+   */
+  readonly allTenants?: boolean;
+}
+interface DrainResult {
+  readonly succeeded: number;
+  readonly failed: number;
+}
+interface Queue<Q extends QueueSchemas> {
+  /**
+   * Validates the payload with the queue's schema, then enqueues it. Returns
+   * the job id.
+   */
+  enqueue<N extends Extract<keyof Q, string>>(queue: N, payload: PayloadIn<Q, N>, options?: EnqueueOptions): AsyncResult<number>;
+  /**
+   * Enqueues once per `dedupeKey`: while a job with the key is waiting, running
+   * or still archived (until `purge` removes it), returns its id with
+   * `duplicate: true` instead. For inbound deliveries that a sender retries.
+   * SQL connections or a transport only.
+   */
+  enqueueOnce<N extends Extract<keyof Q, string>>(queue: N, payload: PayloadIn<Q, N>, options: EnqueueOnceOptions): AsyncResult<EnqueueOnceResult>;
+  claim<N extends Extract<keyof Q, string>>(queue: N, options?: ClaimOptions): AsyncResult<Job<PayloadOut<Q, N>>[]>;
+  /**
+   * Archives the job. `false` when the lease was lost (another worker claimed
+   * it since).
+   */
+  complete(job: Job): AsyncResult<boolean>;
+  /**
+   * Returns the new state: `queued` (will retry), `dead` (archived), or `null`
+   * when the lease was lost.
+   */
+  fail(job: Job, error: unknown, options?: FailOptions): AsyncResult<"queued" | "dead" | null>;
+  /**
+   * Pushes the lease out by `lease` seconds. `false` when it was lost or the
+   * transport can't.
+   */
+  extend(job: Job, lease: number): AsyncResult<boolean>;
+  /**
+   * Enqueues a dead letter again with its payload and attempts, and removes it
+   * from the archive. Returns the new id, or `null` when `id` is not a dead
+   * letter of `queue`. SQL connections only.
+   */
+  replay(queue: Extract<keyof Q, string>, id: number): AsyncResult<number | null>;
+  /**
+   * Counts per queue (ready, in flight, delayed, dead and the oldest waiting
+   * message's age), for an admin page. Defaults to every queue `createQueue`
+   * declared. SQL connections only.
+   */
+  stats<N extends Extract<keyof Q, string>>(queues?: readonly N[]): AsyncResult<Record<N, QueueStats>>;
+  /**
+   * A queue's dead letters, newest first, for an admin page. SQL connections
+   * only.
+   */
+  listDead<N extends Extract<keyof Q, string>>(queue: N, options?: ListDeadOptions): AsyncResult<DeadJob<PayloadOut<Q, N>>[]>;
+  /**
+   * Enqueues dead letters again, the `ids` given or the newest `limit` (1000),
+   * each with its payload, attempts and dedupe key. Returns how many went back
+   * on the queue. SQL connections only.
+   */
+  retryDead(queue: Extract<keyof Q, string>, options?: RetryDeadOptions): AsyncResult<number>;
+  /**
+   * Deletes archived messages (`purge_job_archive`): completed ones after
+   * `olderThan` (7 days) and dead letters after `deadOlderThan` (30 days), up
+   * to `batch` per queue. Covers every queue `createQueue` declared unless
+   * `queues` is given. Returns how many. SQL connections or a transport only.
+   */
+  purge<N extends Extract<keyof Q, string>>(options?: PurgeJobsOptions<N>): AsyncResult<number>;
+  /** A job handler that runs `purge`; schedule it nightly. */
+  purgeJob(options?: PurgeJobsOptions<Extract<keyof Q, string>>): JobHandler<unknown>;
+  /**
+   * Enqueues `payload` on a cron schedule (`'0 3 * * *'`, `'@daily'`, `'30
+   * seconds'`), with pg_cron or the drain scheduler
+   * (`blocks.queue.options.scheduler`). Re-scheduling a name replaces it. SQL
+   * connections only.
+   */
+  schedule<N extends Extract<keyof Q, string>>(name: string, cron: string, queue: N, payload: PayloadIn<Q, N>, options?: ScheduleOptions): AsyncResult<void>;
+  unschedule(name: string): AsyncResult<boolean>;
+  /**
+   * Makes the schedules under `prefix` (and `tenant`) exactly `definitions`:
+   * writes each one, keeping the next run of a schedule whose cron and time
+   * zone didn't change, and removes the rest. Every payload and cron is checked
+   * before anything is written. Run it on deploy or after a settings change;
+   * running it twice changes nothing. SQL connections only.
+   */
+  ensureSchedules(definitions: readonly ScheduleDefinitions<Q>[], options: EnsureSchedulesOptions): AsyncResult<EnsureSchedulesResult>;
+  /**
+   * Schedules by name prefix or tenant, with their next and last run. SQL
+   * connections only.
+   */
+  listSchedules(filter?: ScheduleFilter): AsyncResult<ScheduleInfo[]>;
+  /**
+   * Removes every schedule of a tenant, for tenant deletion; returns how many.
+   * SQL connections only.
+   */
+  unscheduleAll(filter: {
+    readonly tenant: string;
+  }): AsyncResult<number>;
+  /**
+   * Enqueues one run of every due schedule (the drain scheduler) and moves it
+   * to its next time. Returns how many ran. Missed runs collapse into one.
+   */
+  runSchedules(options?: RunSchedulesOptions): AsyncResult<number>;
+  /**
+   * Processes ready jobs until the queue is empty or the budget is spent. For
+   * cron and edge invocations.
+   */
+  drain<N extends Extract<keyof Q, string>>(queue: N, handler: JobHandler<PayloadOut<Q, N>>, options?: DrainOptions): Promise<DrainResult>;
+  /**
+   * A route handler for a cron caller such as Vercel Cron: checks the bearer
+   * secret, runs due schedules, then drains each queue in `handlers` within the
+   * budget, and answers with a `DrainRouteResult`.
+   */
+  drainRoute(options: DrainRouteOptions<Q>): (request: Request) => Promise<Response>;
+  /** Polls and processes jobs until `signal` aborts. */
+  work<N extends Extract<keyof Q, string>>(queue: N, handler: JobHandler<PayloadOut<Q, N>>, options?: WorkOptions): Promise<DrainResult>;
+}
+/**
+ * The options `createQueue` takes: the queues, and where jobs live. Pass one of
+ * `backend`, `sql` or `client`, or a `transport`; the first one set in that
+ * order wins, so a block built by `createBlocks` (which passes the shared
+ * `transport`) can still run over `sql` set with `.with()`.
+ */
+interface QueueOptions<Q extends QueueSchemas = QueueSchemas> extends BlockTemporalOptions {
+  /**
+   * A Standard Schema for each queue's payload, keyed by queue name. Without it
+   * the client knows no queue: `createBlocks` builds the block that way unless
+   * `queueBlock.with({ queues })` sets them.
+   */
+  readonly queues?: Q;
+  /** Any `QueueProvider`. */
+  readonly backend?: QueueProvider;
+  /**
+   * A service SQL connection (`postgres.admin`, `ctx.sql`), for the full
+   * feature set.
+   */
+  readonly sql?: SqlClient;
+  /**
+   * A service-role Supabase client. With `schema`, it calls the wrappers
+   * `blocks.queue.api` writes into that schema, for the full feature set over
+   * the Data API. Without, it goes through the `pgmq_public` RPCs.
+   */
+  readonly client?: QueueRpcClient;
+  /**
+   * A service-role `rpcTransport` over the wrappers `blocks.queue.api` writes,
+   * for the full feature set over the Data API.
+   */
+  readonly transport?: BlockTransport;
+  /**
+   * The schema of the functions over `transport`, or over `client` (which then
+   * uses the wrappers instead of `pgmq_public`). Default `better_supabase` for
+   * `transport`.
+   */
+  readonly schema?: string;
+  /** Error mappers that run before the built-in ones, over `transport`. */
+  readonly mappers?: readonly ErrorMapper[];
+  /** `withBlockHooks` hooks around the methods that return an `AsyncResult`. */
+  readonly hooks?: NoInfer<BlockHooks<Queue<Q>>>;
+  /** Receives the errors `after` hooks throw. */
+  readonly logger?: Logger;
+  /**
+   * The clock for `runAt` delays and schedule runs; pass the definition's `now`
+   * option to share one clock. Defaults to `Temporal.Now.instant()`.
+   */
+  readonly now?: () => Temporal.Instant;
+}
+//#endregion
+export { DeadJobRow as A, sqlQueueProvider as B, RunSchedulesOptions as C, ScheduleInfo as D, ScheduleFilter as E, QueuePurgeArgs as F, QueueRpcClient as I, QueueStats as L, QueueMessageBody as M, QueueMessageRow as N, ScheduleOptions as O, QueueProvider as P, TransportQueueProviderOptions as R, RetryDeadOptions as S, ScheduleDefinitions as T, transportQueueProvider as V, ListDeadOptions as _, DrainResult as a, QueueOptions as b, EnqueueOnceOptions as c, EnsureSchedulesOptions as d, EnsureSchedulesResult as f, JobHandler as g, JobContext as h, DrainOptions as i, DueSchedule as j, WorkOptions as k, EnqueueOnceResult as l, Job as m, DeadJob as n, DrainRouteOptions as o, FailOptions as p, DrainMonitor as r, DrainRouteResult as s, ClaimOptions as t, EnqueueOptions as u, PurgeJobsOptions as v, ScheduleDefinition as w, QueueSchemas as x, Queue as y, pgmqPublicBackend as z };

package/dist/undo-B1jwnVyN.d.ts

@@ -0,0 +1,46 @@
+import { T as ErrorMapper, t as AsyncResult } from "./result-DZeA5KS6.js";
+import { n as Logger } from "./logger-DWVYUmwi.js";
+import { t as BlockTransport } from "./block-transport-DWZSJrwN.js";
+import { n as BlockHooks } from "./block-hooks-DZN2w69m.js";
+//#region src/blocks/undo/undo.d.ts
+/** One call that reverses part of a change. */
+interface UndoCall {
+  readonly fn: string;
+  readonly args: Readonly<Record<string, unknown>>;
+}
+/**
+ * What a block method returns when its change has an inverse. It is plain JSON,
+ * so it can travel from a server action to a toast and back. Applying it runs
+ * the calls in order as the caller, so the same permission checks apply as for
+ * any other write.
+ */
+interface UndoToken {
+  readonly v: 1;
+  readonly calls: readonly UndoCall[];
+}
+/** The functions an undo token may call: the inverses the blocks return. */
+declare const UNDO_FUNCTIONS: readonly string[];
+declare function undoToken(calls: readonly UndoCall[]): UndoToken;
+/** Whether a value is an undo token whose calls are all allowed. */
+declare function isUndoToken(value: unknown, allowed?: readonly string[]): value is UndoToken;
+interface UndoOptions {
+  readonly transport: BlockTransport;
+  readonly schema?: string;
+  readonly mappers?: readonly ErrorMapper[];
+  /** Extra functions a token may call, for an app's own inverses. */
+  readonly allow?: readonly string[];
+  /**
+   * `withBlockHooks` hooks around `apply`, such as a rule on which tokens a
+   * user may apply.
+   */
+  readonly hooks?: BlockHooks<Undo>;
+  /** Receives the errors `after` hooks throw. Default: `console`. */
+  readonly logger?: Logger;
+}
+interface Undo {
+  /** Runs a token's calls in order; stops at the first error. */
+  apply(token: unknown): AsyncResult<number>;
+}
+declare function createUndo(options: UndoOptions): Undo;
+//#endregion
+export { UndoToken as a, undoToken as c, UndoOptions as i, Undo as n, createUndo as o, UndoCall as r, isUndoToken as s, UNDO_FUNCTIONS as t };