Athena.js SDK

@xylex-group/athena is the shared JS and TS client for two surfaces:

• Athena gateway and database operations
• Athena Auth client bindings

Use the runtime-first pages when you need a client working quickly, then move into the typed registry and generator pages once schema drift becomes the real problem.

Open This First If...

• You need install, client setup, reads, writes, or RPC: Getting Started
• You are debugging nested reads, relation selection, or gateway payload shape: findMany AST and server contract
• You need renamed response keys like user_id:id: Select column aliases
• You want one consolidated page for the table DSL, derived types, schema bundles, generator artifacts, and debug or error typing: Type surface manifest
• You want the runtime and helper contracts: API reference
• You want the grouped public method map across root exports, auth, React, cookies, and utils: Method surface reference
• You are moving from string table names to model-driven contracts: Typed schema registry
• You are generating contracts from PostgreSQL or a gateway-backed provider: Generator config

Reading Tracks

Runtime-first onboarding

1. Getting Started
2. findMany AST and server contract
3. Select column aliases
4. API reference
5. Method surface reference

Typed model architecture

1. Type surface manifest
2. Typed schema registry
3. Generator config
4. API reference

Athena Auth client

1. Auth overview
2. Domain pages under /auth/* for sessions, users, organizations, admin, passkeys, two-factor, and callbacks
3. API reference when you need the shared envelope and client types

React and operational runtime

1. React hook
2. Errors and retries
3. Method surface reference for @xylex-group/athena/react, /cookies, and /utils

Quick Links

• Athena Server API
• Athena Auth API Reference