ShelfAuthOptions

Defined in: packages/auth/src/engine.ts:34

Options for createShelfAuth.

Properties

baseURL

baseURL: string

Defined in: packages/auth/src/engine.ts:40

Public base URL issuing auth responses (callback + cookie scope).

db

db: DatabaseAdapter

Defined in: packages/auth/src/engine.ts:36

Shelf database (any driver; auth tables migrate via driver DDL).

emailPassword?

optional emailPassword?: boolean

Defined in: packages/auth/src/engine.ts:42

Enable email/password login. Defaults to true.

emailSender?

optional emailSender?: EmailSender

Defined in: packages/auth/src/engine.ts:48

Email transport shared with notification channels. When set, invite links are emailed best-effort and password-reset requests send mail; when unset, invites stay out-of-band links and resets stay re-invite.

fromEmail?

optional fromEmail?: string

Defined in: packages/auth/src/engine.ts:50

Sender address for auth mail (defaults to storyshelf@<baseURL host>).

logger?

optional logger?: Logger

Defined in: packages/auth/src/engine.ts:61

Host-owned logger for auth diagnostics (explicit override only).

oauth?

optional oauth?: ShelfOAuthProvider[]

Defined in: packages/auth/src/engine.ts:65

OAuth/OIDC providers, each rendered as one login button. Defaults to none.

onAuthSystemEvent?

optional onAuthSystemEvent?: (event, data) => unknown

Defined in: packages/auth/src/engine.ts:56

System-event hook for host-owned fan-out (e.g. sys:user-created, sys:invite-issued to admin channels). Best-effort: failures are logged and swallowed, never break auth flows.