authhero 7.2.2 → 8.1.0

package/dist/types/authentication-flows/passwordless.d.ts

@@ -540,8 +540,8 @@ export declare function passwordlessGrantUser(ctx: Context<{
         } | undefined;
         authenticated_at?: string | undefined;
     };
-    connectionType: "sms" | "email" | "username";
-    authConnection: "sms" | "email" | "username";
+    connectionType: "username" | "email" | "sms";
+    authConnection: "username" | "email" | "sms";
     session_id: string | undefined;
     authParams: {
         client_id: string;

package/dist/types/helpers/bundle-write-purge.d.ts

@@ -0,0 +1,16 @@
+import { CacheAdapter, DataAdapters } from "@authhero/adapter-interfaces";
+/**
+ * Wraps a {@link DataAdapters} so that writes to bundle-covered entities
+ * purge the corresponding `client-bundle:{tenant_id}:{client_id}` cache
+ * entry — best-effort and local-edge only on Cloudflare's Cache API.
+ *
+ * Two write shapes:
+ * 1. Client-scoped writes (args = [tenant_id, client_id, ...]): purge the
+ *    exact bundle key. Affects exactly one bundle.
+ * 2. Tenant-scoped writes (args = [tenant_id, ...]): attempt a prefix delete
+ *    of `client-bundle:{tenant_id}:`. This is a no-op on Cloudflare Cache
+ *    (which can't enumerate keys) but works on the in-memory adapter and
+ *    on Redis-backed adapters. Tenant-scoped staleness is otherwise bounded
+ *    by the bundle TTL.
+ */
+export declare function addBundleWritePurge(data: DataAdapters, cache: CacheAdapter, keyPrefix?: string): DataAdapters;

package/dist/types/helpers/client-bundle.d.ts

@@ -0,0 +1,65 @@
+import { CacheAdapter, Client, Connection, ClientWithTenantId, DataAdapters, ListConnectionsResponse, ListResourceServersResponse, ListHooksResponse, Branding, PromptSetting, Tenant, Theme } from "@authhero/adapter-interfaces";
+/**
+ * One snapshot of every per-(tenant, client) read that the request path
+ * touches outside of user-specific data. Loaded once per request and held
+ * in a 5-minute SWR cache.
+ *
+ * Tenant-scoped lists (connections, resourceServers, hooks) are stored as
+ * their full default-list response so callers calling list(tenant_id) with
+ * no params get an identical shape from the bundle.
+ */
+export interface ClientBundle {
+    tenant: Tenant | null;
+    client: Client | null;
+    connections: ListConnectionsResponse;
+    clientConnections: Connection[];
+    branding: Branding | null;
+    resourceServers: ListResourceServersResponse;
+    promptSettings: PromptSetting | null;
+    hooks: ListHooksResponse;
+    /** The tenant's default theme. Universal-login routes always fetch this
+     * one ("default") key, so bundling it saves a round-trip on every UI
+     * render. Non-UI routes get the field for free; the payload is small.
+     */
+    defaultTheme: Theme | null;
+}
+export interface ClientBundleConfig {
+    /** Seconds the bundle is served without a refresh. Default 300. */
+    freshSeconds?: number;
+    /** Seconds the bundle may be served stale while a background refresh runs. Default 600 (so total lifetime = fresh + stale). */
+    staleSeconds?: number;
+    /** Cache key prefix (per-deployment isolation). Default "client-bundle". */
+    keyPrefix?: string;
+}
+export declare function clientBundleKey(tenantId: string, clientId: string, prefix?: string): string;
+/**
+ * Entity names covered by the {@link ClientBundle}. Single source of truth
+ * used by {@link composeAuthData} so individual apps don't need to enumerate
+ * the bundled entities themselves — they only declare their long-tail
+ * (non-bundle) entities.
+ *
+ * Keep in sync with {@link fetchBundle} above.
+ */
+export declare const BUNDLE_ENTITIES: readonly ["tenants", "clients", "connections", "clientConnections", "branding", "resourceServers", "promptSettings", "hooks", "themes"];
+/**
+ * Look up — and on miss, populate — the per-(tenant, client) bundle.
+ *
+ * SWR semantics:
+ * - now < freshUntil → return immediately
+ * - freshUntil ≤ now < staleUntil → return immediately, schedule a refresh
+ *   via `scheduleRefresh` (typically wired to `ctx.executionCtx.waitUntil`)
+ * - now ≥ staleUntil OR no entry → fetch synchronously
+ *
+ * `data` should be the underlying adapter (i.e. with hooks but without the
+ * bundle wrapper). Passing the bundle-wrapped adapter would deadlock on
+ * itself, since bundle reads route back into this function.
+ */
+export declare function loadClientBundle(data: DataAdapters, cache: CacheAdapter, tenantId: string, clientId: string, options?: {
+    config?: ClientBundleConfig;
+    /** Schedule a background promise. Provide `ctx.executionCtx.waitUntil.bind(ctx.executionCtx)` on Workers; otherwise omit and we'll skip the background refresh. */
+    scheduleRefresh?: (promise: Promise<unknown>) => void;
+    /** Override the "now" clock for testing. */
+    now?: () => number;
+}): Promise<ClientBundle>;
+/** Helper to extract the ClientWithTenantId shape from a bundle. */
+export declare function bundleToClientWithTenantId(bundle: ClientBundle, tenantId: string): ClientWithTenantId | null;

package/dist/types/helpers/compose-auth-data.d.ts

@@ -0,0 +1,44 @@
+import { Context } from "hono";
+import { CacheAdapter, DataAdapters } from "@authhero/adapter-interfaces";
+import { Bindings, Variables } from "../types";
+/**
+ * Composes the per-request data-adapter wrapper stack used by every app
+ * that serves authenticated/tenant-scoped traffic (auth-api, universal-
+ * login v1/v2, saml). Keeps the layer order — and the safety constraints
+ * between layers — in one place so individual apps can't drift.
+ *
+ * Layering (outermost first; that's the order callers hit on each read):
+ *   addTimingLogs        — server-timing instrumentation
+ *   withClientBundle     — L0: per-(tenant_id, client_id) snapshot
+ *   addBundleWritePurge  — local-edge bundle invalidation on writes
+ *   addRequestScopedDedup — L1: in-request Promise memoization
+ *   addCaching           — L2: cross-request cache (CF Cache API in prod)
+ *   addDataHooks         — user lifecycle hooks
+ *   raw dataAdapter      — underlying DB
+ *
+ * Apps declare only their `nonBundleEntities` — the long-tail entities they
+ * read that aren't covered by {@link BUNDLE_ENTITIES}. Those get cross-
+ * request caching via L2 (`addCaching`). Bundle entities are intentionally
+ * NOT in L2 — the bundle (L0) is their cross-request cache, and double-
+ * caching them under per-entity keys would waste edge storage and create a
+ * second invalidation surface.
+ *
+ * L1 (`addRequestScopedDedup`) covers both sets, since in-request dedup is
+ * essentially free and a useful backstop for the rare bundle fall-through
+ * (mismatched ctx.var args, non-default list params).
+ *
+ * Transactional entities (sessions, codes, loginSessions, users, refresh-
+ * Tokens, clientGrants, logs, …) MUST NOT be included in `nonBundleEntities`
+ * — see request-scoped-dedup.ts for the rationale.
+ */
+export declare function composeAuthData(opts: {
+    ctx: Context<{
+        Bindings: Bindings;
+        Variables: Variables;
+    }>;
+    rawData: DataAdapters;
+    cacheAdapter: CacheAdapter;
+    defaultTtl: number;
+    /** Entities outside the ClientBundle that should still be cached cross-request. */
+    nonBundleEntities: string[];
+}): DataAdapters;

package/dist/types/helpers/prefetch-client-bundle.d.ts

@@ -0,0 +1,33 @@
+import { Context } from "hono";
+import { Client, Tenant } from "@authhero/adapter-interfaces";
+import { Bindings, Variables } from "../types";
+/**
+ * Explicit prefetch for the per-(tenant_id, client_id) bundle.
+ *
+ * Called once at the top of a route handler. Discovers tenant_id from
+ * client_id (if not provided), populates `ctx.var.{client_id, tenant_id}`,
+ * and warms the bundle so every downstream bundle-covered read in this
+ * request is served from one cache key.
+ *
+ * Why explicit instead of relying on the wrapper alone: the wrapper hooks
+ * via ctx.var, but several helpers (e.g. getEnrichedClient) need to read
+ * config BEFORE the route has resolved client_id/tenant_id. With this
+ * prefetch you set those upfront, so all the subsequent reads — including
+ * the ones inside getEnrichedClient's Promise.all — engage the bundle.
+ *
+ * Throws 403 if the client_id can't be resolved, 404 if its tenant is
+ * missing — matching the contract of getEnrichedClient. Does NOT handle
+ * CIMD clients (URL-based client_ids); callers that may receive a CIMD
+ * client_id should continue to use {@link getEnrichedClient} which has
+ * the CIMD-specific resolution path.
+ */
+export declare function prefetchClientBundle(ctx: Context<{
+    Bindings: Bindings;
+    Variables: Variables;
+}>, opts: {
+    client_id: string;
+    tenant_id?: string;
+}): Promise<{
+    tenant: Tenant;
+    client: Client;
+}>;

package/dist/types/helpers/request-scoped-dedup.d.ts

@@ -0,0 +1,8 @@
+import { DataAdapters } from "@authhero/adapter-interfaces";
+export interface RequestScopedDedupOptions {
+    /** Names of adapter entities to dedup. Entities outside this list pass through verbatim. Required — there is no safe default. */
+    dedupEntities: string[];
+    /** Shared Map for memoized Promises. Defaults to a fresh Map per call. */
+    dedup?: Map<string, Promise<unknown>>;
+}
+export declare function addRequestScopedDedup(data: DataAdapters, options: RequestScopedDedupOptions): DataAdapters;

package/dist/types/helpers/with-client-bundle.d.ts

@@ -0,0 +1,31 @@
+import { Context } from "hono";
+import { CacheAdapter, DataAdapters } from "@authhero/adapter-interfaces";
+import { Bindings, Variables } from "../types";
+import { ClientBundleConfig } from "./client-bundle";
+type Ctx = Context<{
+    Bindings: Bindings;
+    Variables: Variables;
+}>;
+/**
+ * Route reads that match the request's (tenant_id, client_id) to a single
+ * cached {@link ClientBundle} instead of going entity-by-entity through the
+ * downstream cache. Calls with different tenants/clients, or with non-default
+ * pagination, fall through to {@link upstream}.
+ *
+ * The bundle is loaded lazily on the first matching read — `tenant_id` and
+ * `client_id` typically come from middleware and route entry, so by the time
+ * any bundle-covered method is hit they're set.
+ *
+ * Pass `upstream` (the layer below this wrapper) so bundle component fetches
+ * still benefit from request-scoped dedup / persistent cache / hooks.
+ */
+export declare function withClientBundle(ctx: Ctx, upstream: DataAdapters, cache: CacheAdapter, options?: {
+    config?: ClientBundleConfig;
+}): DataAdapters;
+/**
+ * Best-effort purge of a (tenant_id, client_id) bundle entry from cache.
+ * On Cloudflare this only affects the local edge; entries on other colos
+ * will expire via TTL.
+ */
+export declare function purgeClientBundle(cache: CacheAdapter, tenantId: string, clientId: string, keyPrefix?: string): Promise<void>;
+export {};

package/dist/types/hooks/webhooks.d.ts

@@ -1,6 +1,20 @@
 import { DataAdapters, Hook, User } from "@authhero/adapter-interfaces";
 import { Context } from "hono";
 import { Variables, Bindings } from "../types";
+export interface WebHookResult {
+    ok: boolean;
+    status?: number;
+    body?: string;
+    error?: string;
+}
+export declare function invokeWebHook(ctx: Context<{
+    Bindings: Bindings;
+    Variables: Variables;
+}>, hook: Hook & {
+    url: string;
+}, data: any & {
+    tenant_id: string;
+}): Promise<WebHookResult>;
 export declare function invokeHooks(ctx: Context<{
     Bindings: Bindings;
     Variables: Variables;