# uzairports/uzair-id architecture

> Architecture diagram of the GitHub repository uzairports/uzair-id, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2026-10-04). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/uzairports/uzair-id
- Repository: https://github.com/uzairports/uzair-id

## Overview

UzAir ID is a Laravel OAuth 2.0 integration for Uzbekistan Airports SSO. The main flow registers package routes, sends users through the SSO authorization and callback, resolves or creates the local account, and persists its login tokens. Authenticated requests can then check and refresh the login; logout and session-management paths end logins, while commands support provider transitions and pruning. The graph includes documented capabilities, but some wiring is inferred only from README or source-index references; those references do not establish every runtime detail.

Main entry points: [`src/Models/OauthToken.php`](https://github.com/uzairports/uzair-id/blob/master/src/Models/OauthToken.php) (OAuth token model), [`src/Http/Controllers/UzairAuthController.php`](https://github.com/uzairports/uzair-id/blob/master/src/Http/Controllers/UzairAuthController.php) (Auth controller), [`src/Providers/UzairServiceProvider.php`](https://github.com/uzairports/uzair-id/blob/master/src/Providers/UzairServiceProvider.php) (Laravel service provider), [`src/Http/Middleware/EnsureAccessTokenIsFresh.php`](https://github.com/uzairports/uzair-id/blob/master/src/Http/Middleware/EnsureAccessTokenIsFresh.php) (Token middleware)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_auth["Sign-in and identity"]
  node_routes["Route registration<br/>[Uzair.php]"]
  node_auth_controller["Auth controller"]
  node_socialite["Socialite driver"]
  node_user_resolver["User resolver"]
  node_user_trait["Token user trait<br/>[HasUzairToken.php]"]
  node_events["Domain events"]
end

subgraph group_session["Sessions and tokens"]
  node_token_store[("OAuth token model<br/>[OauthToken.php]")]
  node_freshness["Token middleware"]
  node_refresh["Token refresh"]
  node_storage_check["Provider storage check"]
  node_end_sessions["End sessions<br/>[EndSessions.php]"]
end

subgraph group_integration["Laravel integration"]
  node_facade["UzAir API<br/>[Uzair.php]"]
  node_service_provider["Laravel service provider"]
  node_config["Package configuration<br/>[uzairports.php]"]
  node_migrations["Token and user schema"]
end

subgraph group_operations["Operations"]
  node_provider_command["Provider transition command"]
  node_prune_command["Token pruning command<br/>[PruneCommand.php]"]
end

node_app_user(("Application user"))
node_sso{{"UzAirports SSO"}}

node_app_user -->|"starts sign-in"| node_routes
node_routes -->|"registers routes"| node_auth_controller
node_auth_controller -->|"uses driver"| node_socialite
node_socialite -->|"exchanges OAuth"| node_sso
node_auth_controller -->|"resolves account"| node_user_resolver
node_user_resolver -.->|"records login"| node_token_store
node_auth_controller -->|"records session"| node_token_store
node_auth_controller -->|"dispatches events"| node_events
node_app_user -->|"uses protected routes"| node_freshness
node_freshness -->|"checks ownership"| node_storage_check
node_freshness -->|"looks up login"| node_token_store
node_freshness -->|"renews token"| node_refresh
node_refresh -->|"updates login"| node_token_store
node_refresh -->|"requests renewal"| node_socialite
node_refresh -->|"dispatches outcomes"| node_events
node_auth_controller -->|"ends logins"| node_end_sessions
node_end_sessions -->|"deletes logins"| node_token_store
node_end_sessions -->|"revokes grants"| node_socialite
node_user_trait -->|"checks provider"| node_storage_check
node_user_trait -->|"reads token"| node_token_store
node_service_provider -->|"registers driver"| node_socialite
node_service_provider -.->|"registers middleware"| node_freshness
node_service_provider -->|"registers command"| node_provider_command
node_service_provider -->|"registers command"| node_prune_command
node_service_provider -->|"loads configuration"| node_config
node_provider_command -->|"ends logins"| node_end_sessions
node_provider_command -->|"checks ownership"| node_storage_check
node_provider_command -->|"rebuilds table"| node_token_store
node_prune_command -->|"prunes rows"| node_token_store
node_migrations -.->|"defines schema"| node_token_store
node_routes -->|"provides route API"| node_facade

click node_routes "https://github.com/uzairports/uzair-id/blob/master/src/Uzair.php"
click node_auth_controller "https://github.com/uzairports/uzair-id/blob/master/src/Http/Controllers/UzairAuthController.php"
click node_socialite "https://github.com/uzairports/uzair-id/blob/master/src/Socialite/UzairportsProvider.php"
click node_user_resolver "https://github.com/uzairports/uzair-id/blob/master/src/Actions/ResolveUserFromSocialite.php"
click node_user_trait "https://github.com/uzairports/uzair-id/blob/master/src/Concerns/HasUzairToken.php"
click node_events "https://github.com/uzairports/uzair-id/tree/master/src/Events"
click node_token_store "https://github.com/uzairports/uzair-id/blob/master/src/Models/OauthToken.php"
click node_freshness "https://github.com/uzairports/uzair-id/blob/master/src/Http/Middleware/EnsureAccessTokenIsFresh.php"
click node_refresh "https://github.com/uzairports/uzair-id/blob/master/src/Actions/RefreshAccessToken.php"
click node_storage_check "https://github.com/uzairports/uzair-id/blob/master/src/Actions/EnsureTokenStorageMatchesProvider.php"
click node_end_sessions "https://github.com/uzairports/uzair-id/blob/master/src/Actions/EndSessions.php"
click node_facade "https://github.com/uzairports/uzair-id/blob/master/src/Uzair.php"
click node_service_provider "https://github.com/uzairports/uzair-id/blob/master/src/Providers/UzairServiceProvider.php"
click node_config "https://github.com/uzairports/uzair-id/blob/master/config/uzairports.php"
click node_migrations "https://github.com/uzairports/uzair-id/tree/master/database/migrations"
click node_provider_command "https://github.com/uzairports/uzair-id/blob/master/src/Console/Commands/ProviderCommand.php"
click node_prune_command "https://github.com/uzairports/uzair-id/blob/master/src/Console/Commands/PruneCommand.php"

classDef toneNeutral fill:#f8fafc,stroke:#334155,stroke-width:1.5px,color:#0f172a
classDef toneBlue fill:#dbeafe,stroke:#2563eb,stroke-width:1.5px,color:#172554
classDef toneAmber fill:#fef3c7,stroke:#d97706,stroke-width:1.5px,color:#78350f
classDef toneMint fill:#dcfce7,stroke:#16a34a,stroke-width:1.5px,color:#14532d
classDef toneRose fill:#ffe4e6,stroke:#e11d48,stroke-width:1.5px,color:#881337
classDef toneIndigo fill:#e0e7ff,stroke:#4f46e5,stroke-width:1.5px,color:#312e81
classDef toneTeal fill:#ccfbf1,stroke:#0f766e,stroke-width:1.5px,color:#134e4a
class node_routes,node_auth_controller,node_socialite,node_user_resolver,node_user_trait,node_events,node_app_user toneBlue
class node_token_store,node_freshness,node_refresh,node_storage_check,node_end_sessions toneAmber
class node_facade,node_service_provider,node_config,node_migrations toneMint
class node_provider_command,node_prune_command toneRose
class node_sso toneIndigo
```

## Components

### Sign-in and identity

- [Route registration](https://github.com/uzairports/uzair-id/blob/master/src/Uzair.php): `src/Uzair.php`
- [Auth controller](https://github.com/uzairports/uzair-id/blob/master/src/Http/Controllers/UzairAuthController.php): `src/Http/Controllers/UzairAuthController.php`
- [Socialite driver](https://github.com/uzairports/uzair-id/blob/master/src/Socialite/UzairportsProvider.php): `src/Socialite/UzairportsProvider.php`
- [User resolver](https://github.com/uzairports/uzair-id/blob/master/src/Actions/ResolveUserFromSocialite.php): `src/Actions/ResolveUserFromSocialite.php`
- [Token user trait](https://github.com/uzairports/uzair-id/blob/master/src/Concerns/HasUzairToken.php): `src/Concerns/HasUzairToken.php`
- [Domain events](https://github.com/uzairports/uzair-id/tree/master/src/Events): `src/Events`

### Sessions and tokens

- [OAuth token model](https://github.com/uzairports/uzair-id/blob/master/src/Models/OauthToken.php): `src/Models/OauthToken.php`
- [Token middleware](https://github.com/uzairports/uzair-id/blob/master/src/Http/Middleware/EnsureAccessTokenIsFresh.php): `src/Http/Middleware/EnsureAccessTokenIsFresh.php`
- [Token refresh](https://github.com/uzairports/uzair-id/blob/master/src/Actions/RefreshAccessToken.php): `src/Actions/RefreshAccessToken.php`
- [Provider storage check](https://github.com/uzairports/uzair-id/blob/master/src/Actions/EnsureTokenStorageMatchesProvider.php): `src/Actions/EnsureTokenStorageMatchesProvider.php`
- [End sessions](https://github.com/uzairports/uzair-id/blob/master/src/Actions/EndSessions.php): `src/Actions/EndSessions.php`

### Laravel integration

- [UzAir API](https://github.com/uzairports/uzair-id/blob/master/src/Uzair.php): `src/Uzair.php`
- [Laravel service provider](https://github.com/uzairports/uzair-id/blob/master/src/Providers/UzairServiceProvider.php): `src/Providers/UzairServiceProvider.php`
- [Package configuration](https://github.com/uzairports/uzair-id/blob/master/config/uzairports.php): `config/uzairports.php`
- [Token and user schema](https://github.com/uzairports/uzair-id/tree/master/database/migrations): `database/migrations`

### Operations

- [Provider transition command](https://github.com/uzairports/uzair-id/blob/master/src/Console/Commands/ProviderCommand.php): `src/Console/Commands/ProviderCommand.php`
- [Token pruning command](https://github.com/uzairports/uzair-id/blob/master/src/Console/Commands/PruneCommand.php): `src/Console/Commands/PruneCommand.php`

### Other components

- **Application user**
- **UzAirports SSO**

## Connections

- Application user → Route registration: starts sign-in (evidence: `README.md`)
- Route registration → Auth controller: registers routes (evidence: `src/Uzair.php`)
- Auth controller → Socialite driver: uses driver (evidence: `src/Http/Controllers/UzairAuthController.php`)
- Socialite driver → UzAirports SSO: exchanges OAuth (evidence: `src/Socialite/UzairportsProvider.php`)
- Auth controller → User resolver: resolves account (evidence: `src/Http/Controllers/UzairAuthController.php`)
- User resolver → OAuth token model: records login
- Auth controller → OAuth token model: records session (evidence: `src/Http/Controllers/UzairAuthController.php`)
- Auth controller → Domain events: dispatches events (evidence: `src/Http/Controllers/UzairAuthController.php`)
- Application user → Token middleware: uses protected routes (evidence: `README.md`)
- Token middleware → Provider storage check: checks ownership (evidence: `src/Http/Middleware/EnsureAccessTokenIsFresh.php`)
- Token middleware → OAuth token model: looks up login (evidence: `src/Http/Middleware/EnsureAccessTokenIsFresh.php`)
- Token middleware → Token refresh: renews token (evidence: `src/Http/Middleware/EnsureAccessTokenIsFresh.php`)
- Token refresh → OAuth token model: updates login (evidence: `src/Actions/RefreshAccessToken.php`)
- Token refresh → Socialite driver: requests renewal (evidence: `src/Actions/RefreshAccessToken.php`)
- Token refresh → Domain events: dispatches outcomes (evidence: `src/Actions/RefreshAccessToken.php`)
- Auth controller → End sessions: ends logins (evidence: `src/Http/Controllers/UzairAuthController.php`)
- End sessions → OAuth token model: deletes logins (evidence: `src/Actions/EndSessions.php`)
- End sessions → Socialite driver: revokes grants (evidence: `src/Actions/EndSessions.php`)
- Token user trait → Provider storage check: checks provider (evidence: `src/Concerns/HasUzairToken.php`)
- Token user trait → OAuth token model: reads token (evidence: `src/Concerns/HasUzairToken.php`)
- Laravel service provider → Socialite driver: registers driver (evidence: `src/Providers/UzairServiceProvider.php`)
- Laravel service provider → Token middleware: registers middleware (evidence: `src/Providers/UzairServiceProvider.php`)
- Laravel service provider → Provider transition command: registers command (evidence: `src/Providers/UzairServiceProvider.php`)
- Laravel service provider → Token pruning command: registers command (evidence: `src/Providers/UzairServiceProvider.php`)
- Laravel service provider → Package configuration: loads configuration (evidence: `src/Providers/UzairServiceProvider.php`)
- Provider transition command → End sessions: ends logins (evidence: `src/Console/Commands/ProviderCommand.php`)
- Provider transition command → Provider storage check: checks ownership (evidence: `src/Console/Commands/ProviderCommand.php`)
- Provider transition command → OAuth token model: rebuilds table (evidence: `src/Console/Commands/ProviderCommand.php`)
- Token pruning command → OAuth token model: prunes rows (evidence: `src/Console/Commands/PruneCommand.php`)
- Token and user schema → OAuth token model: defines schema
- Route registration → UzAir API: provides route API (evidence: `README.md`)
