auth/bootstrap_routes.ts view source
ZodObject<{ token: ZodString; username: ZodString; password: ZodString; }, $strict> Input for POST /bootstrap. token is the one-shot token file contents.
auth/bootstrap_routes.ts
Bootstrap route spec for first-time account creation.
One-shot endpoint: exchanges a bootstrap token + credentials for an account with keeper privileges and a session cookie.
Declarations #
7 declarations
BootstrapInput #
BootstrapInput
BootstrapOutput #
BootstrapOutput
auth/bootstrap_routes.ts view source
ZodObject<{ ok: ZodLiteral<true>; username: ZodString; }, $strict> Output for POST /bootstrap. Session cookie is the operative side effect.
BootstrapRouteOptions #
BootstrapRouteOptions
auth/bootstrap_routes.ts view source
BootstrapRouteOptions Per-factory configuration for bootstrap route specs.
bootstrap_status is runtime state (a mutable ref), not a dep or options value —
it is passed through so the route handler can flip it on success.
session_options
type
SessionOptions<string>bootstrap_status
Shared mutable reference — flipped to false after successful bootstrap.
type BootstrapStatus
on_bootstrap
Called after successful bootstrap (account + session created). Use for app-specific post-bootstrap work like generating API tokens.
type
(result: BootstrapAccountSuccess, c: Context) => Promise<void>ip_rate_limiter
Rate limiter for bootstrap attempts (per-IP). Pass null to disable.
type
RateLimiter | nullBootstrapStatus #
BootstrapStatus
auth/bootstrap_routes.ts view source
BootstrapStatus Bootstrap status — runtime state computed once at startup.
available
type
booleantoken_path
type
string | nullcheck_bootstrap_status #
check_bootstrap_status
auth/bootstrap_routes.ts view source
(deps: CheckBootstrapStatusDeps, options: { token_path: string | null; }): Promise<BootstrapStatus> Check bootstrap availability at startup.
Bootstrap is available when:
1. A token path is configured
2. The token file exists on disk
3. The bootstrap_lock table shows bootstrapped = false
deps
filesystem and database access for the check
options
static configuration including token_path
type
{ token_path: string | null; }returns
Promise<BootstrapStatus> an object with available (boolean) and token_path (string | null)
CheckBootstrapStatusDeps #
CheckBootstrapStatusDeps
auth/bootstrap_routes.ts view source
CheckBootstrapStatusDeps Dependencies for checking bootstrap status at startup.
stat
type
(path: string) => Promise<StatResult | null>db
type Db
log
type
Loggercreate_bootstrap_route_specs #
create_bootstrap_route_specs
auth/bootstrap_routes.ts view source
(deps: RouteFactoryDeps, options: BootstrapRouteOptions): RouteSpec[] Create bootstrap route specs for first-time account creation.
deps
stateless capabilities including filesystem access
type RouteFactoryDeps
options
per-factory configuration (session, token path, bootstrap status)
returns
RouteSpec[] route specs (not yet applied to Hono)