Class HttpHandlers<Request, Response>`Abstract`

Low-level HTTP request handlers and utility functions that can be used by Express, Next, or other server frameworks.

Type Parameters

Request extends ExpressOrNextRequest = ExpressOrNextRequest
Response extends ExpressOrNextResponse = ExpressOrNextResponse

Hierarchy

HttpHandlers
- default

Index

Constructors

constructor

Properties

authErrorHandler client loginSuccessHandler

Accessors

Methods

completeCookieOptions getCachedUserToken getLoginCookie getLoginUrlFromLoginEvent getUserHandleNoAuth getUserToken getUserTokenOptional handleLoginEvent onAuthError onLoginSuccess resetLoginCookies setCachedUserToken setCookie setLoginCookies

Constructors

constructor

new HttpHandlers<Request, Response>(client: main): HttpHandlers<Request, Response>
Type Parameters
- Request extends ExpressOrNextRequest = ExpressOrNextRequest
- Response extends ExpressOrNextResponse = ExpressOrNextResponse
Parameters
- client: main
  
  unologin instance
Returns HttpHandlers<Request, Response>
- Defined in src/http-handlers.ts:91

Properties

`Protected` authErrorHandler

authErrorHandler: AuthErrorHandler<Request, Response> = ...

Executed when encountering an authentication error.

See

isAuthError

Param

req

Param

res

Param

error

Returns

void

`Readonly` client

client: main

unologin instance

`Protected` loginSuccessHandler

loginSuccessHandler: null | LoginSuccessHandler<Request, Response> = null

Accessors

cookies

get cookies(): {
    login: {
        name: string;
        options: CookieOptions;
    };
    loginState: {
        name: string;
        options: CookieOptions;
    };
}
Returns {
    login: {
        name: string;
        options: CookieOptions;
    };
    loginState: {
        name: string;
        options: CookieOptions;
    };
}
- login: {
  name: string;
  options: CookieOptions;
  }
  - name: string
  - options: CookieOptions
- loginState: {
  name: string;
  options: CookieOptions;
  }
  - name: string
  - options: CookieOptions
- Defined in src/http-handlers.ts:94

Methods

completeCookieOptions

completeCookieOptions(opts: CookieOptions): CookieOptions
Completes cookie options.

Returns
default cookie options
Parameters
- opts: CookieOptions
  
  cookie options
Returns CookieOptions
- Defined in src/http-handlers.ts:123

`Protected` getCachedUserToken

getCachedUserToken(res: Response): null | UserToken
Internal
Result of getUserTokenOptional may be stored in with the response object.

This function acts as a helper to retrieve the cached value.

This function is meant to be used in conjunction with Express-like frameworks where one middleware function is called after another, passing values using res.locals.

See
setCachedUserToken

Returns
parsed user token cached in res.locals
Parameters
- res: Response
  
  res
Returns null | UserToken
- Defined in src/http-handlers.ts:167

getLoginCookie

getLoginCookie(cookies: {
[k: string]: string | undefined;
}): null | string
Get login cookie from cookies object.

Returns
cookie value
Parameters
- cookies: {
  [k: string]: string | undefined;
  }
  
  cookies
  - [k: string]: string | undefined
Returns null | string
- Defined in src/http-handlers.ts:201

getLoginUrlFromLoginEvent

getLoginUrlFromLoginEvent(req: Request, _: Response): URL
Returns
URL
Parameters
- req: Request
  
  req
- _: Response
  
  res (not used)
Returns URL
- Defined in src/http-handlers.ts:472

getUserHandleNoAuth

getUserHandleNoAuth(req: Request, res: Response): null | UserHandle
Returns a UserHandle from the current request. Returns null if the request contains no login information.

IMPORTANT:

This function is synchronous and the UserHandle can therefore not be trusted to be authenticated.

The returned UserHandle can however be used in any API call that accepts a UserHandle as a parameter.

In this case, the authentication happens on the unologin API.

Use getUserTokenOptional for optional authentication. Use getUserToken for required authentication.

Returns
UserHandle | null
Parameters
- req: Request
  
  req
- res: Response
  
  res
Returns null | UserHandle
- Defined in src/http-handlers.ts:229

getUserToken

getUserToken(req: Request, res: Response): Promise<UserToken>
Authenticates the user and returns a Promise to the UserToken.

Requires the user to be logged in.

The resolved UserToken is authenticated and can be trusted.

See
getUserTokenOptional for optional authentication.

Throws
APIError 403 unauthorized if not logged in.

Throws
APIError 403 unauthorized if login token invalid.

Returns
Promise
Parameters
- req: Request
  
  req
- res: Response
  
  res
Returns Promise<UserToken>
- Defined in src/http-handlers.ts:267

getUserTokenOptional

getUserTokenOptional(req: Request, res: Response): Promise<null | UserToken>
Authenticates the user and returns a Promise to the UserToken.

Does not require the user to be logged in. Does nothing if no login cookie is present and returns null.

The resolved UserToken is authenticated and can be trusted if not null.

Requires a cookie parser.

See
getUserToken for required authentication.

Returns
Promise
Parameters
- req: Request
  
  req
- res: Response
  
  res
Returns Promise<null | UserToken>
- Defined in src/http-handlers.ts:304

handleLoginEvent

handleLoginEvent(req: Request, res: Response): Promise<{
url: URL;
}>
Internal
Handles the unologin login event. Returns a URL to redirect the user to.

Returns
Promise to redirect the user to
Parameters
- req: Request
  
  req
- res: Response
  
  res
Returns Promise<{
url: URL;
}>
- Defined in src/http-handlers.ts:512

onAuthError

onAuthError(handler: AuthErrorHandler<Request, Response>): void
Decide what to do on auth error.

See

Returns
void
Parameters
- handler: AuthErrorHandler<Request, Response>
  
  Express handler
Returns void
- Defined in src/http-handlers.ts:361

onLoginSuccess

onLoginSuccess(handler: LoginSuccessHandler<Request, Response>): void
Add a callback that is called after the login event has finished but before the response is sent to the client.

The UserToken passed to handler is authenticated an can be trusted.

Returns
void
Parameters
- handler: LoginSuccessHandler<Request, Response>
  
  (req, res, userToken) => unknown
Returns void
- Defined in src/http-handlers.ts:379

`Protected` resetLoginCookies

resetLoginCookies(req: Request, res: Response): void
Resets/deletes login cookies.

Returns
void
Parameters
- req: Request
  
  req
- res: Response
  
  res
Returns void
- Defined in src/http-handlers.ts:456

`Protected` setCachedUserToken

setCachedUserToken(res: Response, userToken: null | UserToken): void
See
getCachedUserToken

Returns
void
Parameters
- res: Response
  
  res
- userToken: null | UserToken
  
  token or null
Returns void
- Defined in src/http-handlers.ts:180

`Protected` `Abstract` setCookie

setCookie(req: Request, res: Response, name: string, value: string, options: CookieOptions): void
Internal
Framework specific implementation required.
Parameters
- req: Request
  
  req
- res: Response
  
  res
- name: string
  
  name
- value: string
  
  value
- options: CookieOptions
  
  cookie options
Returns void
- Defined in src/http-handlers.ts:397

`Protected` setLoginCookies

setLoginCookies(req: Request, res: Response, cookie: LoginCookie, options?: CookieOptions): void
Internal
Set the login cookies for a response.

Returns
void
Parameters
- req: Request
  
  req
- res: Response
  
  rest
- cookie: LoginCookie
  
  cookie to set
- options: CookieOptions = {}
  
  cookie options
Returns void
- Defined in src/http-handlers.ts:417

Class HttpHandlers<Request, Response>Abstract

Type Parameters

Request extends ExpressOrNextRequest = ExpressOrNextRequest

Response extends ExpressOrNextResponse = ExpressOrNextResponse

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

Request extends ExpressOrNextRequest = ExpressOrNextRequest

Response extends ExpressOrNextResponse = ExpressOrNextResponse

Parameters

client: main

Returns HttpHandlers<Request, Response>

Properties

Protected authErrorHandler

See

Param

Param

Param

Returns

Readonly client

Protected loginSuccessHandler

Accessors

cookies

Returns { login: { name: string; options: CookieOptions; }; loginState: { name: string; options: CookieOptions; }; }

login: { name: string; options: CookieOptions; }

name: string

options: CookieOptions

loginState: { name: string; options: CookieOptions; }

name: string

options: CookieOptions

Methods

completeCookieOptions

Returns

Parameters

opts: CookieOptions

Returns CookieOptions

Protected getCachedUserToken

See

Returns

Parameters

res: Response

Returns null | UserToken

getLoginCookie

Returns

Parameters

cookies: { [k: string]: string | undefined; }

[k: string]: string | undefined

Returns null | string

getLoginUrlFromLoginEvent

Returns

Parameters

req: Request

_: Response

Returns URL

getUserHandleNoAuth

Returns

Parameters

req: Request

res: Response

Returns null | UserHandle

getUserToken

See

Throws

Throws

Returns

Parameters

req: Request

res: Response

Returns Promise<UserToken>

getUserTokenOptional

See

Returns

Parameters

req: Request

Class HttpHandlers<Request, Response>`Abstract`

`Protected` authErrorHandler

`Readonly` client

`Protected` loginSuccessHandler

Returns {
login: {
name: string;
options: CookieOptions;
};
loginState: {
name: string;
options: CookieOptions;
};
}

login: {
name: string;
options: CookieOptions;
}

loginState: {
name: string;
options: CookieOptions;
}

`Protected` getCachedUserToken

cookies: {
[k: string]: string | undefined;
}

Returns Promise<{
url: URL;
}>

`Protected` resetLoginCookies

`Protected` setCachedUserToken

`Protected` `Abstract` setCookie

`Protected` setLoginCookies