authts / oidc-client-ts

OpenID Connect (OIDC) and OAuth2 protocol support for browser-based JavaScript applications

oidc-client-ts

Library to provide OpenID Connect (OIDC) and OAuth2 protocol support for client-side, browser-based JavaScript client applications. Also included is support for user session and access token management.

This project is a fork of IdentityModel/oidc-client-js which halted its development in June 2021. It has since been ported to TypeScript here with a similar API for the initial 2.0 release. Going forward, this library will focus only on protocols that continue to have support in OAuth 2.1. As such, the implicit grant is not supported by this client. Additional migration notes from oidc-client are available here.

Contributions and help are greatly appreciated!

Implements the following OAuth 2.0 protocols and supports OpenID Connect Core 1.0:

• Authorization Code Grant with Proof Key for Code Exchange (PKCE)
• Authorization Code Grant
• Resource Owner Password Credentials (ROPC) Grant
• Refresh Token Grant
• Silent Refresh Token in iframe Flow

Table of Contents

• Documentation
• Installation
• Building the Source
• Contributing
• License

Installation

Using npm

$ npm install oidc-client-ts --save

Building the Source

$ git clone https://github.com/authts/oidc-client-ts.git
$ cd oidc-client-ts
$ npm install
$ npm run build

Running the Sample

Parcel project

$ cd samples/Parcel
$ npm install
$ npm run start

and then browse to http://localhost:1234.

Angular app

can be found here.

Running the Tests

$ npm test

Contributing

We appreciate feedback and contribution to this repo!

License

This project is licensed under the Apache-2.0 license. See the LICENSE file for more info.