Class EsiTokenManager

Keeps one valid SSO token per character on top of a pluggable ITokenStorage, refreshing ahead of expiry, coalescing concurrent refreshes, persisting rotated refresh tokens, and recording revocations so SSO is not hammered with a dead refresh token.

Index

Constructors

constructor

Methods

getSsoClient getStorage getAuthorizationUrl addCharacter importToken removeCharacter getStoredToken listTokens listCharacters hasScopes getToken refresh refreshAll tokenProviderFor identity createClient

Constructors

constructor

new EsiTokenManager(config: EsiTokenManagerConfig): EsiTokenManager
Parameters
- config: EsiTokenManagerConfig
Returns EsiTokenManager
- Defined in src/auth/EsiTokenManager.ts:178

Methods

getSsoClient

getSsoClient(): EveSsoClient
The SSO client used for all token traffic.

Returns EveSsoClient
- Defined in src/auth/EsiTokenManager.ts:204

getStorage

getStorage(): ITokenStorage
The storage adapter backing this manager.

Returns ITokenStorage
- Defined in src/auth/EsiTokenManager.ts:209

getAuthorizationUrl

getAuthorizationUrl(options: AuthorizationUrlOptions): string
Build the SSO login URL. See EveSsoClient.getAuthorizationUrl.
Parameters
- options: AuthorizationUrlOptions
Returns string
- Defined in src/auth/EsiTokenManager.ts:214

addCharacter

addCharacter(code: string, options?: AddCharacterOptions): Promise<StoredToken>
Exchange an authorization code and store the resulting token under the character it belongs to. An existing token for that character is replaced; storage never holds two entries for one character.
Parameters
- code: string
- options: AddCharacterOptions = {}
Returns Promise<StoredToken>

Throws
TokenVerificationError with verifyTokens on, when the access token fails verification; nothing is stored
- Defined in src/auth/EsiTokenManager.ts:226

importToken

importToken(
token: { accessToken: string; refreshToken: string; expiresIn?: number },
): Promise<StoredToken>
Import tokens obtained elsewhere (a previous library version, another tool, a migration). The character identity is decoded from the access token; expiresIn is in seconds and defaults to the JWT exp claim.
Parameters
- token: { accessToken: string; refreshToken: string; expiresIn?: number }
Returns Promise<StoredToken>

Throws
TokenVerificationError with verifyTokens on, when the access token fails verification (an expired access token included); nothing is stored
- Defined in src/auth/EsiTokenManager.ts:248

removeCharacter

removeCharacter(
characterId: number,
options?: RemoveCharacterOptions,
): Promise<void>
Delete a character's token, optionally revoking it at SSO first.
Parameters
- characterId: number
- options: RemoveCharacterOptions = {}
Returns Promise<void>
- Defined in src/auth/EsiTokenManager.ts:262

getStoredToken

getStoredToken(characterId: number): Promise<StoredToken | null>
The stored record for a character, or null.
Parameters
- characterId: number
Returns Promise<StoredToken | null>
- Defined in src/auth/EsiTokenManager.ts:277

listTokens

listTokens(): Promise<StoredToken[]>
Every stored token.

Returns Promise<StoredToken[]>
- Defined in src/auth/EsiTokenManager.ts:282

listCharacters

listCharacters(): Promise<CharacterSummary[]>
Every stored character without its secrets.

Returns Promise<CharacterSummary[]>
- Defined in src/auth/EsiTokenManager.ts:287

hasScopes

hasScopes(characterId: number, scopes: readonly string[]): Promise<boolean>
True when the stored token grants every listed scope.
Parameters
- characterId: number
- scopes: readonly string[]
Returns Promise<boolean>
- Defined in src/auth/EsiTokenManager.ts:299

getToken

getToken(characterId: number): Promise<string>
A usable access token for the character. With autoRefresh on, a token inside the refresh skew is refreshed first.
Parameters
- characterId: number
Returns Promise<string>

Throws
CharacterNotFoundError when no token is stored

Throws
TokenRevokedError when the character's refresh token is revoked
- Defined in src/auth/EsiTokenManager.ts:316

refresh

refresh(characterId: number): Promise<StoredToken>
Refresh a character's token through SSO regardless of expiry. Concurrent calls for the same character share one SSO request.
Parameters
- characterId: number
Returns Promise<StoredToken>
- Defined in src/auth/EsiTokenManager.ts:335

refreshAll

refreshAll(options?: RefreshAllOptions): Promise<RefreshResult[]>
Refresh stored tokens with bounded concurrency. Per-character failures never reject: each character gets its own RefreshResult. The one rejection is a failing storage.list(), because with no records there is no character to attribute the fault to and a silent empty run would hide a broken store from a scheduler.
Parameters
- options: RefreshAllOptions = {}
Returns Promise<RefreshResult[]>
- Defined in src/auth/EsiTokenManager.ts:369

tokenProviderFor

tokenProviderFor(characterId: number): TokenProvider
A TokenProvider bound to a character, for onTokenRefresh. Every invocation refreshes through SSO (coalesced), because the client only calls it after ESI has rejected the current token.
Parameters
- characterId: number
Returns TokenProvider
- Defined in src/auth/EsiTokenManager.ts:393

identity

identity(characterId: number): Identity
The character as an Identity for esi.as() on the shared runtime (@lgriffin/esi.ts/client). Before each request the view gets the stored token, refreshed first when it is stale; after a 401 it gets a token refreshed through SSO. Nothing is looked up until a request needs it, so an unknown character fails at the request, not here. The same object comes back for the same character, so esi.as() memoises one view per character rather than one per call.
Parameters
- characterId: number
Returns Identity
- Defined in src/auth/EsiTokenManager.ts:409

createClient

createClient(
characterId: number,
config?: ManagedClientConfig,
): Promise<EsiClient>
An EsiClient whose access token and refresh provider are bound to the character. The token is validated (and refreshed if stale) first.
Parameters
- characterId: number
- config: ManagedClientConfig = {}
Returns Promise<EsiClient>
Deprecated
Since 11.0.0; removing it needs a future major release, and none is scheduled. Each client this returns has its own rate limiter, error budget and cache. Build one runtime with createEsi({ userAgent }) from @lgriffin/esi.ts/client and call esi.as(this.identity(characterId)) for a per-character view over it; esi.shutdown() replaces each client's shutdown(). See guides/MULTI-CHARACTER.md, "Moving from EsiTokenManager.createClient".
Example
```
// Before
const client = await tokens.createClient(id, { userAgent });
await client.wallet.getCharacterWallet(id);
// After
const esi = createEsi({ userAgent }); // once per application
await esi.as(tokens.identity(id)).character(id).wallet.get();
```
- Defined in src/auth/EsiTokenManager.ts:443

Class EsiTokenManager

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns EsiTokenManager

Methods

getSsoClient

Returns EveSsoClient

getStorage

Returns ITokenStorage

getAuthorizationUrl

Parameters

Returns string

addCharacter

Parameters

Returns Promise<StoredToken>

Throws

importToken

Parameters

Returns Promise<StoredToken>

Throws

removeCharacter

Parameters

Returns Promise<void>

getStoredToken

Parameters

Returns Promise<StoredToken | null>

listTokens

Returns Promise<StoredToken[]>

listCharacters

Returns Promise<CharacterSummary[]>

hasScopes

Parameters

Returns Promise<boolean>

getToken

Parameters

Returns Promise<string>

Throws

Throws

refresh

Parameters

Returns Promise<StoredToken>

refreshAll

Parameters

Returns Promise<RefreshResult[]>

tokenProviderFor

Parameters

Returns TokenProvider

identity

Parameters

Returns Identity

createClient

Parameters

Returns Promise<EsiClient>

Deprecated

Example

Settings

On This Page