Class LocalStorageSessionService

A service which handles session management for a front-end application

Refresh token + access token in local storage
Fingerprint in local storage (generated randomly)
User id fetched from initial refresh call

Hierarchy

BaseSessionService
- LocalStorageSessionService

Index

Constructors

constructor

new LocalStorageSessionService(): LocalStorageSessionService
Returns LocalStorageSessionService
Inherited from BaseSessionService.constructor

Properties

`Protected` MAX_RETRY_ATTEMPTS

MAX_RETRY_ATTEMPTS: number = 15

`Protected` opts

opts: undefined | SessionServiceInitializer

`Private` sessionState

sessionState: SessionStateWithTokens = ...

Methods

`Protected` axiosRequest

axiosRequest<T, U>(method, url, headers, body?, options?): Promise<T>
Type Parameters
- T
- U extends object
Parameters
- method: "get" | "delete" | "post" | "patch"
- url: string
- headers: Partial<RawAxiosHeaders & {
      Accept: AxiosHeaderValue;
      Authorization: AxiosHeaderValue;
      Content-Encoding: AxiosHeaderValue;
      Content-Length: AxiosHeaderValue;
      User-Agent: AxiosHeaderValue;
  } & {
      Content-Type: ContentType;
  }>
- Optional body: U
- options: AxiosRequestOptions = ...
Returns Promise<T>
Inherited from BaseSessionService.axiosRequest
- Defined in src/session/baseSessionService.ts:45

getLogger

getLogger(): undefined | Logger
Gets logger set in options

Returns undefined | Logger
Inherited from BaseSessionService.getLogger
- Defined in src/session/baseSessionService.ts:39

getRequestHeaders

getRequestHeaders(options?): Record<string, undefined | null | string | string[]>
Return the request headers that would normally be used with an axios request Useful if you need to make a request via a different method and just need the headers
Parameters
- options: undefined | AxiosRequestOptions = ...
Returns Record<string, undefined | null | string | string[]>
Overrides BaseSessionService.getRequestHeaders
- Defined in src/session/localStorageSessionService.ts:98

getSessionState

getSessionState(): SessionState
Returns the current session state for the session in progress

Returns SessionState
Overrides BaseSessionService.getSessionState
- Defined in src/session/localStorageSessionService.ts:35

initialize

initialize(opts): Promise<boolean>
Initializes this service with the given options.
- Load information from local storage if needed
- For cookie service, will perform a reauth
- Sets up fingerprint if not present
Parameters
- opts: SessionServiceInitializer
Returns Promise<boolean>
Overrides BaseSessionService.initialize
- Defined in src/session/localStorageSessionService.ts:39

`Protected` initializeFingerprint

initializeFingerprint(): void
Returns void
Overrides BaseSessionService.initializeFingerprint
- Defined in src/session/localStorageSessionService.ts:128

`Private` initializeTokens

initializeTokens(): void
Returns void
- Defined in src/session/localStorageSessionService.ts:143

`Protected` performAxiosRequest

performAxiosRequest<T, U>(method, url, body?, options?): Promise<T>
Type Parameters
- T
- U extends object
Parameters
- method: "get" | "delete" | "post" | "patch"
- url: string
- Optional body: U
- options: AxiosRequestOptions = ...
Returns Promise<T>
Overrides BaseSessionService.performAxiosRequest
- Defined in src/session/localStorageSessionService.ts:114

performDelete

performDelete<T>(url, options?): Promise<T>
Perform a delete request to the specified url Will append any headers or other info needed for auth
Type Parameters
- T
Parameters
- url: string
- Optional options: AxiosRequestOptions
Returns Promise<T>
Inherited from BaseSessionService.performDelete
- Defined in src/session/baseSessionService.ts:90

performGet

performGet<T>(url, options?): Promise<T>
Perform a get request to the specified url Will append any headers or other info needed for auth
Type Parameters
- T
Parameters
- url: string
- Optional options: AxiosRequestOptions
Returns Promise<T>
Inherited from BaseSessionService.performGet
- Defined in src/session/baseSessionService.ts:97

performPatch

performPatch<T, U>(url, body, options?): Promise<T>
Perform a patch request to the specified url Will append any headers or other info needed for auth
Type Parameters
- T
- U extends object
Parameters
- url: string
- body: U
- Optional options: AxiosRequestOptions
Returns Promise<T>
Inherited from BaseSessionService.performPatch
- Defined in src/session/baseSessionService.ts:101

performPost

performPost<T, U>(url, body, options?): Promise<T>
Perform a post request to the specified url Will append any headers or other info needed for auth
Type Parameters
- T
- U extends object
Parameters
- url: string
- body: U
- Optional options: AxiosRequestOptions
Returns Promise<T>
Inherited from BaseSessionService.performPost
- Defined in src/session/baseSessionService.ts:109

updateOpts

updateOpts(opts): void
Update the options after the service is already initialized
Parameters
- opts: SessionServiceInitializer
Returns void
Inherited from BaseSessionService.updateOpts
- Defined in src/session/baseSessionService.ts:117

updateSessionState

updateSessionState(__namedParameters): void
Update the session state with the given data.

If a userId is provided, the session will be set as logged in (or logged out if null). Call after a successful login or refresh.

Otherwise, this can be used to update tenantId and other session-based variables
Parameters
- __namedParameters: SessionStateUpdate
Returns void
Overrides BaseSessionService.updateSessionState
- Defined in src/session/localStorageSessionService.ts:47

`Protected` validateAxiosOptions

validateAxiosOptions(options): void
Parameters
- options: AxiosRequestOptions
Returns void
Overrides BaseSessionService.validateAxiosOptions
- Defined in src/session/localStorageSessionService.ts:82

Class LocalStorageSessionService

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Returns LocalStorageSessionService

Properties

Protected MAX_RETRY_ATTEMPTS

Protected opts

Private sessionState

Methods

Protected axiosRequest

Type Parameters

T

U extends object

Parameters

method: "get" | "delete" | "post" | "patch"

url: string

headers: Partial<RawAxiosHeaders & { Accept: AxiosHeaderValue; Authorization: AxiosHeaderValue; Content-Encoding: AxiosHeaderValue; Content-Length: AxiosHeaderValue; User-Agent: AxiosHeaderValue; } & { Content-Type: ContentType; }>

Optional body: U

options: AxiosRequestOptions = ...

Returns Promise<T>

getLogger

Returns undefined | Logger

getRequestHeaders

Parameters

options: undefined | AxiosRequestOptions = ...

Returns Record<string, undefined | null | string | string[]>

getSessionState

Returns SessionState

initialize

Parameters

opts: SessionServiceInitializer

Returns Promise<boolean>

Protected initializeFingerprint

Returns void

Private initializeTokens

Returns void

Protected performAxiosRequest

Type Parameters

T

U extends object

Parameters

method: "get" | "delete" | "post" | "patch"

url: string

Optional body: U

options: AxiosRequestOptions = ...

Returns Promise<T>

performDelete

Type Parameters

T

Parameters

url: string

Optional options: AxiosRequestOptions

Returns Promise<T>

performGet

Type Parameters

T

Parameters

url: string

Optional options: AxiosRequestOptions

Returns Promise<T>

performPatch

Type Parameters

T

U extends object

Parameters

url: string

body: U

Optional options: AxiosRequestOptions

Returns Promise<T>

performPost

Type Parameters

T

U extends object

Parameters

url: string

`Protected` MAX_RETRY_ATTEMPTS

`Protected` opts

`Private` sessionState

`Protected` axiosRequest

headers: Partial<RawAxiosHeaders & {
Accept: AxiosHeaderValue;
Authorization: AxiosHeaderValue;
Content-Encoding: AxiosHeaderValue;
Content-Length: AxiosHeaderValue;
User-Agent: AxiosHeaderValue;
} & {
Content-Type: ContentType;
}>

`Optional` body: U

`Protected` initializeFingerprint

`Private` initializeTokens

`Protected` performAxiosRequest

`Optional` body: U

`Optional` options: AxiosRequestOptions

`Optional` options: AxiosRequestOptions

`Optional` options: AxiosRequestOptions

`Optional` options: AxiosRequestOptions

`Protected` validateAxiosOptions