@fundwave/oidc-client NPM

OIDC Client

@fundwave/oidc-client is a lightweight client-side library that allows you to prepare headers for your network-calls by automatically refreshing tokens (if expired) with the provided OIDC server.

Installation

npm install @fundwave/oidc-client

Initialization

import { OIDCClient } from "@fundwave/oidc-client";

const oidcClient = new OIDCClient();

// Set the URL-String where token refresh requests will be sent
oidcClient.setBaseUrl("https://my-awesome-oidc-server.com");

// Set the path on the server which is responsible for the refresh
oidcClient.setRefreshPath("refresh-token");

Note: the refreshPath property defaults to token/refresh

Usage

Once the class has been instantiated, you can

use the prepareHeaders method to get the required headers for your calls
```
const headers = await oidcClient.prepareHeaders();
```
Optionally, directly use the getAccessToken method to update the tokens (access and refresh) at browser's storage
```
await oidcClient.getAccessToken();
```
If the refresh-token call returns a 401/403 or any other error status, the library will throw an custom-event logged-out

Notes:

Tokens aren't refreshed every time the prepareHeaders method is called. Tokens are only refreshed when the token is about to expire.
If your client app makes parallel calls to the same object of oidc-client, this library will still make only one active call to your OIDC server. This will reduce network calls and avoid exceeding any rate limits with your OIDC server.
Access Token is maintained at browser's session storage with the key being token
Refresh Token is maintained at browser's local storage with the key being refreshToken
The library will read tokens sent by your OIDC server from either the response body or headers