# openauthjs/openauth architecture

> Architecture diagram of the GitHub repository openauthjs/openauth, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-02-06). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/openauthjs/openauth
- Repository: https://github.com/openauthjs/openauth

## Overview

##### Main Components

a. Core Components:
- Auth Server (Issuer)
- Client SDK
- Storage Layer
- Provider System
- UI Components

b. External Integration Points:
- Third-party OAuth Providers (GitHub, Google, etc.)
- Custom Identity Providers
- Client Applications (Web, Mobile, API)

**[Client Applications] ←→ [OpenAuth Client SDK] ←→ [OpenAuth Server]**
- ↕
- [Storage Layer] ←→ [OpenAuth Server] ←→ [Identity Providers]
- ↕
- [UI Components]

##### Detailed Component Breakdown

a. Auth Server (Core):
- Sub-components:
- PKCE Flow Handler
- Token Management
- Subject Management
- Provider Interface

b. Storage Layer (Bottom):
- Implementations:
- DynamoDB
- Cloudflare KV
- Memory Storage

c. Provider System (Right):
- Providers:
- OAuth Providers (GitHub, Google, etc.)
- Password Provider
- Custom Providers

d. Client SDK (Left):
- Authorization Flow
- Token Exchange
- Verification
- PKCE Implementation

e. UI Components (Top):
- Themeable components:
- Password UI
- Code UI
- Select UI

##### Deployment Options

A deployment section showing supported platforms:
- AWS Lambda
- Cloudflare Workers
- Node.js
- Bun

##### Additional Details

Callouts for:
- Standards compliance (OAuth 2.0)
- Security features (PKCE, JWT)
- Customization points
- Storage implementations

##### Implementation Notes

Notes about:
- Stateless design
- Minimal storage requirements
- Framework independence
- Standards compliance

##### Integration Points

Highlight:
- API endpoints
- Callback URLs
- Provider configuration
- Storage interfaces

## Diagram (Mermaid)

```mermaid
graph TB
    subgraph Client
        ClientApps[Client Applications]
        ClientSDK[Client SDK]:::sdk
    end

    subgraph Core["Auth Server (Core)"]
        Issuer[Auth Server]:::core
        PKCE[PKCE Handler]:::core
        TokenMgmt[Token Management]:::core
        SubjectMgmt[Subject Management]:::core
    end

    subgraph Storage["Storage Layer"]
        StorageBase[Storage Interface]:::storage
        DynamoDB[DynamoDB]:::storage
        CloudflareKV[Cloudflare KV]:::storage
        MemoryStore[Memory Storage]:::storage
    end

    subgraph Providers["Provider System"]
        ProviderBase[Provider Interface]:::provider
        OAuth2Base[OAuth2 Base]:::provider
        OIDCBase[OIDC Base]:::provider
        
        subgraph OAuthProviders["OAuth Providers"]
            GitHub[GitHub]:::provider
            Google[Google]:::provider
            Facebook[Facebook]:::provider
        end
        
        PasswordProv[Password Provider]:::provider
    end

    subgraph UI["UI Components"]
        BaseUI[Base UI]:::ui
        PasswordUI[Password UI]:::ui
        CodeUI[Code UI]:::ui
        SelectUI[Select UI]:::ui
        Theme[Theme System]:::ui
    end

    ClientApps --> ClientSDK
    ClientSDK --> Issuer
    
    Issuer --> PKCE
    Issuer --> TokenMgmt
    Issuer --> SubjectMgmt
    
    StorageBase --> DynamoDB
    StorageBase --> CloudflareKV
    StorageBase --> MemoryStore
    
    Core --> StorageBase
    Core --> ProviderBase
    
    ProviderBase --> OAuth2Base
    ProviderBase --> OIDCBase
    ProviderBase --> PasswordProv
    
    OAuth2Base --> GitHub
    OAuth2Base --> Google
    OAuth2Base --> Facebook
    
    Core --> BaseUI
    BaseUI --> PasswordUI
    BaseUI --> CodeUI
    BaseUI --> SelectUI
    BaseUI --> Theme

    %% Click Events
    click Issuer "https://github.com/openauthjs/openauth/blob/master/packages/openauth/src/issuer.ts"
    click ClientSDK "https://github.com/openauthjs/openauth/blob/master/packages/openauth/src/client.ts"
    click StorageBase "https://github.com/openauthjs/openauth/blob/master/packages/openauth/src/storage/storage.ts"
    click DynamoDB "https://github.com/openauthjs/openauth/blob/master/packages/openauth/src/storage/dynamo.ts"
    click CloudflareKV "https://github.com/openauthjs/openauth/blob/master/packages/openauth/src/storage/cloudflare.ts"
    click MemoryStore "https://github.com/openauthjs/openauth/blob/master/packages/openauth/src/storage/memory.ts"
    click ProviderBase "https://github.com/openauthjs/openauth/blob/master/packages/openauth/src/provider/provider.ts"
    click GitHub "https://github.com/openauthjs/openauth/blob/master/packages/openauth/src/provider/github.ts"
    click Google "https://github.com/openauthjs/openauth/blob/master/packages/openauth/src/provider/google.ts"
    click Facebook "https://github.com/openauthjs/openauth/blob/master/packages/openauth/src/provider/facebook.ts"
    click PasswordProv "https://github.com/openauthjs/openauth/blob/master/packages/openauth/src/provider/password.ts"
    click OAuth2Base "https://github.com/openauthjs/openauth/blob/master/packages/openauth/src/provider/oauth2.ts"
    click OIDCBase "https://github.com/openauthjs/openauth/blob/master/packages/openauth/src/provider/oidc.ts"
    click BaseUI "https://github.com/openauthjs/openauth/blob/master/packages/openauth/src/ui/base.tsx"
    click PasswordUI "https://github.com/openauthjs/openauth/blob/master/packages/openauth/src/ui/password.tsx"
    click CodeUI "https://github.com/openauthjs/openauth/blob/master/packages/openauth/src/ui/code.tsx"
    click SelectUI "https://github.com/openauthjs/openauth/blob/master/packages/openauth/src/ui/select.tsx"
    click Theme "https://github.com/openauthjs/openauth/blob/master/packages/openauth/src/ui/theme.ts"
    click PKCE "https://github.com/openauthjs/openauth/blob/master/packages/openauth/src/pkce.ts"
    click TokenMgmt "https://github.com/openauthjs/openauth/blob/master/packages/openauth/src/jwt.ts"
    click SubjectMgmt "https://github.com/openauthjs/openauth/blob/master/packages/openauth/src/subject.ts"

    %% Styling
    classDef core fill:#2374ab
    classDef storage fill:#ffd151
    classDef provider fill:#4caf50
    classDef ui fill:#9c27b0
    classDef sdk fill:#ff9800

    %% Legend
    subgraph Legend
        L1[Core Components]:::core
        L2[Storage Components]:::storage
        L3[Provider Components]:::provider
        L4[UI Components]:::ui
        L5[SDK Components]:::sdk
    end
```
