Skip to content

Installation

Terminal window
pnpm add @smplcty/auth @smplcty/db pg
  • pg is a peer dependency.
  • @smplcty/db provides the transaction primitive (withTransaction is re-exported from it).

Sign-in handlers are opt-in subpaths with their own optional peers — auth core depends on neither oauth4webapi nor Twilio, so a password-only app pulls neither.

Terminal window
# OIDC (org-bound):
pnpm add oauth4webapi # → import { oidcHandler } from '@smplcty/auth/oidc'
# Twilio Verify OTP (user-bound):
pnpm add @smplcty/twilio # → import { twilioVerifyHandler } from '@smplcty/auth/twilio'
ImportPurpose
@smplcty/authcore: withSession, session lifecycle, identity setters, createMethodRouter, errors, types
@smplcty/auth/oidcthe oidcHandler (needs oauth4webapi)
@smplcty/auth/twiliothe twilioVerifyHandler (needs @smplcty/twilio)
@smplcty/auth/flat-tenantthe flatTenantScope preset
@smplcty/auth/httpthe HTTP transport tier — Web-standard /auth/* handlers (no new deps)

The library ships its schema as schema-flow YAML under @smplcty/auth/schema/ and consumes generic mixins from @smplcty/schema-std. See Required database schema.

Continue to Quick start.