better-supabase 0.11.0 → 0.13.0

package/dist/resolve-D57oDWNr.d.ts

@@ -0,0 +1,289 @@
+/// <reference lib="esnext.temporal" />
+import { b as DbError } from "./result-mijqfoJN.js";
+import { t as StandardSchemaV1 } from "./standard-16AIDny5.js";
+import { n as AuthOutageEvent, u as RefreshEvent } from "./events-DhGgwqQA.js";
+import { n as Logger } from "./logger-DWVYUmwi.js";
+import { t as BetterSupabaseEnv } from "./index-NRMMhhEi.js";
+import { CookieOptions } from "@supabase/ssr";
+import { JWTClaims, SupabaseEnv, UserClaims } from "@supabase/server";
+//#region src/auth/session.d.ts
+/**
+ * The session object auth-js persists (`sb-<ref>-auth-token`). A `tokens-only`
+ * cookie has no `user`: auth-js keeps it in `auth.userStorage`.
+ */
+interface StoredSession {
+  readonly access_token: string;
+  readonly refresh_token: string;
+  readonly expires_at?: number;
+  readonly expires_in?: number;
+  readonly token_type?: string;
+  readonly user?: unknown;
+  readonly [key: string]: unknown;
+}
+/**
+ * `cookies.encode` in `@supabase/ssr`: `user-and-tokens` stores the user object
+ * in the cookie, `tokens-only` stores the access and refresh tokens alone. The
+ * server and the browser client must use the same value.
+ */
+type SessionEncoding = "user-and-tokens" | "tokens-only";
+declare const DEFAULT_SESSION_ENCODING: SessionEncoding;
+interface WriteSessionOptions {
+  /** Defaults to `user-and-tokens`, the `@supabase/ssr` default. */
+  readonly encode?: SessionEncoding;
+}
+/** A cookie scope an earlier deploy wrote the session at. */
+interface CookieScope {
+  readonly domain?: string;
+  readonly path?: string;
+}
+interface CookieRecord {
+  readonly name: string;
+  readonly value: string;
+}
+interface CookieWrite {
+  readonly name: string;
+  readonly value: string;
+  readonly options: CookieOptions;
+}
+/** Headers that keep responses carrying session cookies out of shared caches. */
+declare const AUTH_CACHE_HEADERS: Readonly<Record<string, string>>;
+/** `sb-<first label of the hostname>-auth-token`, the supabase-js default. */
+declare function sessionCookieName(url: string): string;
+declare function parseCookies(header: string | null | undefined): CookieRecord[];
+declare function serializeCookie(write: CookieWrite): string;
+/**
+ * Reads the session written by `@supabase/ssr` (plain or `base64-`, whole or
+ * chunked, `user-and-tokens` or `tokens-only`). Trailing chunks a shorter
+ * session no longer uses are ignored; chunks that never form a session read as
+ * no session.
+ */
+declare function readSession(cookies: readonly CookieRecord[], name: string): StoredSession | null;
+/**
+ * `Max-Age=0` writes for the session's chunk-like cookies that the readable
+ * session doesn't use: a leftover `.2` after a shorter rewrite, chunks next to
+ * a whole cookie, or chunks past a gap. Empty when no session reads.
+ */
+declare function pruneSessionChunks(cookies: readonly CookieRecord[], name: string, options?: CookieOptions): CookieWrite[];
+/**
+ * The encoding a stored session was written with: `tokens-only` without a
+ * `user`.
+ */
+declare function sessionEncoding(session: StoredSession): SessionEncoding;
+/**
+ * Cookie writes that store `session` (or clear it with `null`) exactly like
+ * `@supabase/ssr` with the same `encode`, and expire chunks the new value no
+ * longer uses.
+ */
+declare function writeSession(existing: readonly CookieRecord[], name: string, session: StoredSession | null, options?: CookieOptions, { encode }?: WriteSessionOptions): CookieWrite[];
+/**
+ * `Max-Age=0` writes for every chunk of the session cookie at each of `scopes`,
+ * like `clearAuthCookiesAtScopes` from `@supabase/ssr`. Use it once the cookie
+ * `domain` or `path` changed, for the scopes earlier deploys wrote: browsers
+ * ignore writes for scopes the host doesn't own, but a scope equal to the
+ * current one clears the live session.
+ */
+declare function clearSessionAtScopes(existing: readonly CookieRecord[], name: string, scopes: readonly CookieScope[]): CookieWrite[];
+/** Applies cookie writes to a cookie list, as the next request would see it. */
+declare function applyCookieWrites(cookies: readonly CookieRecord[], writes: readonly CookieWrite[]): CookieRecord[];
+//#endregion
+//#region src/auth/resolve.d.ts
+/**
+ * Who is calling. `C` is the claims type from `betterSupabase.claims(schema)`;
+ * the verified payload keeps every JWT claim and adds the schema's output. `P`
+ * is the `user_metadata` type from `betterSupabase.userMetadata(schema)`.
+ */
+type AuthState<C = unknown, P = unknown> = {
+  readonly kind: "user";
+  readonly token: string;
+  readonly claims: JWTClaims & C;
+  readonly user: UserClaims;
+  /**
+   * Where the token came from: `oauth` for an RFC 9068 access token from
+   * `accessTokenResolver`, which never has a cookie session.
+   */
+  readonly source: "bearer" | "cookie" | "oauth" | (string & {});
+  /** Seconds since epoch, from the token's `exp`. */
+  readonly expiresAt: number | null;
+  /**
+   * `user_metadata` parsed by `betterSupabase.userMetadata(schema)`;
+   * `undefined` without a schema or when the metadata fails it. Users can
+   * write this data themselves: use it for display, never for access.
+   */
+  readonly profile?: P;
+} | {
+  readonly kind: "service";
+  readonly keyName: string;
+} | {
+  readonly kind: "apiKey";
+  readonly keyId: string;
+  readonly name: string;
+  readonly organizationId?: string;
+  readonly userId?: string;
+  readonly scopes: readonly string[];
+  /** When the key was created. */
+  readonly createdAt?: Temporal.Instant;
+  /** The user who created the key, when the row records one. */
+  readonly createdBy?: string;
+  /**
+   * `sub` (the user, or the key for an organization key), `role:
+   * authenticated` and `api_key`.
+   */
+  readonly claims: JWTClaims;
+} | {
+  readonly kind: "anon";
+  /**
+   * `expired`: the cookie session needs a refresh that was not allowed here
+   * (run the proxy).
+   */
+  readonly reason: "none" | "expired" | "signed_out" | "refresh_failed";
+} | {
+  readonly kind: "invalid";
+  readonly reason: InvalidReason;
+  readonly error: DbError;
+};
+type InvalidReason = "token" | "claims" | "actor";
+/**
+ * What an `AuthResolver` returns. `reason` may be left out of an `invalid`
+ * state; it then counts as `token`.
+ */
+type ResolvedState = Exclude<AuthState, {
+  kind: "invalid";
+}> | {
+  readonly kind: "invalid";
+  readonly reason?: InvalidReason;
+  readonly error: DbError;
+};
+/**
+ * Extension point for other credentials (API keys, third-party auth, custom
+ * tokens). Return `undefined` when the request carries nothing this resolver
+ * understands; the built-in Bearer and cookie resolution runs next.
+ */
+interface AuthResolver {
+  readonly name: string;
+  resolve(request: Request): Promise<ResolvedState | undefined> | ResolvedState | undefined;
+}
+interface ResolveAuthOptions {
+  readonly env: BetterSupabaseEnv;
+  /**
+   * Allow refreshing an expiring cookie session. Only where cookies can be
+   * written (proxy).
+   */
+  readonly refresh?: boolean;
+  /**
+   * With `refresh`, refresh when the token expires within this many seconds.
+   * Defaults to 60. Without `refresh` a token stays valid until its `exp`.
+   */
+  readonly leeway?: number;
+  /** Milliseconds before a refresh counts as a network failure. Defaults to 5000. */
+  readonly refreshTimeoutMs?: number;
+  readonly checkSession?: boolean;
+  /**
+   * Accept `sb_secret_` keys (`apikey` header) as service callers: `true` for
+   * any configured key, or the key names allowed (`['cron']`). Defaults to
+   * false.
+   */
+  readonly secret?: boolean | readonly string[];
+  readonly audience?: string | string[];
+  readonly issuer?: string | string[];
+  readonly cookie?: {
+    readonly name?: string;
+    readonly options?: CookieOptions;
+    /**
+     * The shape refreshed sessions are written in, `cookies.encode` in
+     * `@supabase/ssr`. Use the browser client's value. Defaults to
+     * `user-and-tokens`.
+     */
+    readonly encode?: SessionEncoding;
+  };
+  /**
+   * Read the session cookie. Defaults to true. `false` suits endpoints only
+   * bearer clients call (MCP): a browser's cookie then can't authorize a
+   * request another site makes it send.
+   */
+  readonly cookies?: boolean;
+  /**
+   * Inline JWKS instead of fetching `env.jwksUrl` (tests, air-gapped). `false`
+   * or `null` verifies against no keys and never fetches, ignoring
+   * `SUPABASE_JWKS` and `SUPABASE_JWKS_URL`.
+   */
+  readonly jwks?: SupabaseEnv["jwks"] | false;
+  /**
+   * Verify HS256 tokens without a `kid` locally with this shared secret, the
+   * tokens Supabase Lite issues (`auth.jwt_secret`). Tokens with a `kid` still
+   * verify against the JWKS. `createServer` sets it from `SUPABASE_JWT_SECRET`
+   * with `backend: "lite"`.
+   */
+  readonly jwtSecret?: string;
+  /**
+   * Validates the verified claims (`betterSupabase.claims(schema)` sets it). A
+   * failure resolves to `{ kind: 'invalid', reason: 'claims' }`.
+   */
+  readonly claims?: StandardSchemaV1;
+  /**
+   * Parses `user_metadata` into `profile`
+   * (`betterSupabase.userMetadata(schema)` sets it). A failure leaves `profile`
+   * undefined and warns once; the session stays valid.
+   */
+  readonly userMetadata?: StandardSchemaV1;
+  /** Receives the `userMetadata` warning. Defaults to `console`. */
+  readonly logger?: Logger;
+  readonly resolvers?: readonly AuthResolver[];
+  /**
+   * The caller's IP, sent to Auth as `Sb-Forwarded-For` on refreshes so its
+   * per-IP rate limit counts users, not your server. Only with a secret key
+   * (`env.secretKey`), which Auth requires for the header. Defaults to
+   * `clientIp` (the last `x-forwarded-for` hop); `false` turns it off.
+   */
+  readonly clientIp?: ((request: Request) => string | undefined) | false;
+  /** Called after every refresh attempt (metrics, logging). */
+  readonly onRefresh?: (event: RefreshEvent) => void;
+  /**
+   * With `refresh`, expire session chunks the readable session doesn't use (a
+   * leftover `.2` after a shorter rewrite) on every request, not only when the
+   * session is rewritten. Defaults to true.
+   */
+  readonly pruneChunks?: boolean;
+  readonly fetch?: typeof fetch;
+  /** Epoch milliseconds, the unit JWT `exp` and `iat` math needs. */
+  readonly now?: () => number;
+}
+interface AuthResolution<C = unknown, P = unknown> {
+  readonly auth: AuthState<C, P>;
+  /**
+   * Cookie writes for the response. Empty unless the session was refreshed or
+   * cleared.
+   */
+  readonly cookies: readonly CookieWrite[];
+  /** No-store headers, set whenever `cookies` is not empty. */
+  readonly headers: Readonly<Record<string, string>>;
+  /** Cookies the rest of this request should see, including a refreshed session. */
+  readonly requestCookies: readonly CookieRecord[];
+  /** Adds `cookies` and `headers` to a response. */
+  apply(response: Response): Response;
+  /**
+   * The session was ended server-side (revoked, deleted or banned); the cookies
+   * are cleared.
+   */
+  readonly sessionEnded?: boolean;
+  /** Why `sessionEnded` is set: `banned` when Auth rejected the user as banned. */
+  readonly sessionEndedReason?: "ended" | "banned";
+  /** Set when a refresh failed because the Auth server was unreachable. */
+  readonly outage?: AuthOutageEvent;
+}
+/**
+ * The last `x-forwarded-for` hop, the one your own edge appended. Hops to its
+ * left come from the client and can be forged. Behind more than one proxy, pass
+ * your own reader to `clientIp`.
+ */
+declare function clientIp(request: Request): string | undefined;
+/**
+ * Resolves who is calling: custom resolvers, then `Authorization: Bearer`
+ * (APIs, MCP, mobile), then the `@supabase/ssr` session cookie (browsers).
+ *
+ * A valid token costs no network call: it is verified locally against the
+ * cached JWKS. An expiring cookie session is refreshed only when `refresh` is
+ * set, through a single-flight request, and only then are cookies written.
+ */
+declare function resolveAuth(request: Request, options: ResolveAuthOptions): Promise<AuthResolution>;
+//#endregion
+export { serializeCookie as C, writeSession as E, readSession as S, sessionEncoding as T, WriteSessionOptions as _, ResolveAuthOptions as a, parseCookies as b, resolveAuth as c, CookieRecord as d, CookieScope as f, StoredSession as g, SessionEncoding as h, InvalidReason as i, AUTH_CACHE_HEADERS as l, DEFAULT_SESSION_ENCODING as m, AuthResolver as n, ResolvedState as o, CookieWrite as p, AuthState as r, clientIp as s, AuthResolution as t, CookieOptions as u, applyCookieWrites as v, sessionCookieName as w, pruneSessionChunks as x, clearSessionAtScopes as y };