Adapters

Adapters are a set of helper functions to provide framework specific integration into @jmondi/oauth2-server. Currently, Express and Fastify are both supported.

Express

https://expressjs.com/

import {
  requestFromExpress,
  handleExpressResponse,
  handleExpressError,
} from "@jmondi/oauth2-server/express"

requestFromExpress(req: Express.Request): OAuthRequest;

Helper function to return an OAuthRequest from an Express.Request.

handleExpressResponse(expressResponse: Express.Response, oauthResponse: OAuthResponse): void;

Helper function that handles the express response after authorization.

handleExpressError(res: Express.Response, e: unknown | OAuthException): void;

Helper function that handles the express response if an error was thrown.

Fastify

https://www.fastify.io/

import {
  requestFromFastify,
  handleFastifyReply,
  handleFastifyError,
} from "@jmondi/oauth2-server/fastify"

The following functions are imported directly from the adapter instead of the root package.

requestFromFastify(req: FastifyRequest): OAuthRequest;

Helper function to return an OAuthRequest from an FastifyRequest.

handleFastifyReply(fastifyReply: FasitfyReply, oauthResponse: OAuthResponse): void;

Helper function that handles the express response after authorization.

handleFastifyError(reply: FasitfyReply, e: unknown | OAuthException): void;

Helper function that handles the express response if an error was thrown.