@tempoxyz/id 0.0.0-pr-187.sha-eed04d3

package/src/internal/Env.ts

@@ -0,0 +1,58 @@
+/**
+ * The Hono environment that Tempo ID's middleware and route apps share: the page renderer that the
+ * root app falls back to, and the variables that `Timing.middleware` and `RequestId.middleware()`
+ * set on each request.
+ * @module
+ */
+import type { Context } from 'hono'
+import type * as Auth from './Auth.js'
+import type * as Limits from './Limits.js'
+import type * as RateLimit from './RateLimit.js'
+import type * as RequestId from './RequestId.js'
+import type * as TestInbox from './TestInbox.js'
+import type * as Timing from './Timing.js'
+import type * as Wallet from './Wallet.js'
+
+/** The bindings and variables of a request that Tempo ID's middleware serves. */
+export type Env = {
+  /**
+   * The bindings that the root app reads: the page renderer, each rate limit by its name,
+   * wallet.tempo's passkey lookup, and a preview's test inbox.
+   */
+  Bindings: {
+    /**
+     * Renders the request's page through TanStack Start, or runs one of its server functions, with
+     * the request's context. A path that no route serves renders the not-found page.
+     */
+    pages: (c: Context<Env>) => Promise<Response>
+    /**
+     * The test inbox, which receives the sign-in codes of addresses under `TEST_EMAIL_DOMAIN`. Only a
+     * preview binds it. Absent, every code is emailed.
+     */
+    TEST_INBOX?: TestInbox.Service | undefined
+    /**
+     * wallet.tempo's `Credentials` entrypoint, which links its passkeys at their first sign-in.
+     * Absent, only passkeys that Tempo ID stores sign in.
+     */
+    WALLET?: Wallet.Service | undefined
+  } & Record<Limits.Limit, RateLimit.Limiter>
+  /** The values that middleware sets on `c.var` for each request. */
+  Variables: Variables
+}
+
+/** The values that middleware sets on `c.var` for each request. */
+export type Variables = {
+  /**
+   * Whether the request already chose the app's account, as `POST /v1/authorize` does before its
+   * in-process authorization. The account step then reads no accounts again. Absent elsewhere.
+   */
+  accountChosen?: boolean | undefined
+  /** The request's Better Auth instance, which `Auth.middleware` in `src/api/lib/Auth.ts` sets. */
+  auth: Auth.Instance
+  /** The codes of the response's OAuth error body, which `RequestId.middleware()` reads. */
+  refusal: RequestId.Refusal | undefined
+  /** The request ID, which `RequestId.middleware()` assigns. */
+  requestId: string
+  /** The request's timings, which `Timing.measure` appends to. */
+  timing: Timing.Timing
+}