Skip to content

Commit

Permalink
chore(release): 6.0.0
Browse files Browse the repository at this point in the history
  • Loading branch information
panva committed Oct 15, 2024
1 parent 15890ff commit 8955583
Show file tree
Hide file tree
Showing 10 changed files with 3,146 additions and 4 deletions.
34 changes: 34 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,40 @@

All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.

## [6.0.0](https://github.com/panva/openid-client/compare/v5.7.0...v6.0.0) (2024-10-15)


### ⚠ BREAKING CHANGES

* openid-client v6.x is a complete rewrite of the openid-client module, this is the first time since 0.1.0 (8 years ago) that the API has drastically changed. The new module structure and API focuses on three core principles:

- runtime compatibility (adding support for Deno, Cloudflare Workers, Bun, and other Web API interoperable runtimes)
- tree-shakeability (bundles should not contain features that don't end up being used)
- less options (removing support for processing deprecated response types, cutting down on the number of combinations that need to handled)

To that end openid-client@6 no longer supports the full cartesian matrix of response types and response modes, it no longer supports issuing encrypted assertions, decrypting assertions is limited to only a few algorithms, it no longer supports Dynamic Client Registration or Management, and Self-Issued OpenID Provider responses are also not supported.

The new API makes basic setups simple while allowing some degree of complexity where needed.

openid-client@6 is an ESM module using ES2022 syntax and it depends on WebCryptoAPI and Fetch API globals being available in the JS runtime.

openid-client@6 is written in TypeScript and its exported types come with comment annotations.

(Node.js) Versions 20.x and newer have all the necessary globals.

(Node.js) CJS style `let client = require('openid-client')` is possible in versions where `process.features.require_module` is `true`. This is a new Node.js feature slated to be released without a CLI flag in 23.x and 22.x

### Documentation

* update ([3b7e09d](https://github.com/panva/openid-client/commit/3b7e09dd7f3019b416fd88579315dc38aa054c87))
* update README.md ([d142984](https://github.com/panva/openid-client/commit/d1429841484e7055abe1d2806a90f9689da9e731))
* update README.md ([13698a3](https://github.com/panva/openid-client/commit/13698a3553f909ec814b499bfdc0ae2362869602))


### Refactor

* openid-client@6 ([15890ff](https://github.com/panva/openid-client/commit/15890ff45a73a60243133dc674f4e9152481bd13))

## [5.7.0](https://github.com/panva/node-openid-client/compare/v5.6.5...v5.7.0) (2024-09-09)


Expand Down
Loading

0 comments on commit 8955583

Please sign in to comment.