mirror of
https://github.com/hanzoai/openid-client.git
synced 2026-09-24 17:01:10 +00:00
Filip Skokan
53927452eb
BREAKING CHANGE: 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
48 lines
885 B
JSON
48 lines
885 B
JSON
{
|
|
"commit-all": true,
|
|
"scripts": {
|
|
"prerelease": "npm run format && npm run docs && git diff --quiet && npm run tap:node && npm run build",
|
|
"postbump": "node .postbump.cjs",
|
|
"postchangelog": "sed -i '' -e 's/### \\[/## [/g' CHANGELOG.md"
|
|
},
|
|
"types": [
|
|
{
|
|
"type": "feat",
|
|
"section": "Features",
|
|
"hidden": false
|
|
},
|
|
{
|
|
"type": "fix",
|
|
"section": "Fixes",
|
|
"hidden": false
|
|
},
|
|
{
|
|
"type": "chore",
|
|
"hidden": true
|
|
},
|
|
{
|
|
"type": "docs",
|
|
"section": "Documentation",
|
|
"hidden": false
|
|
},
|
|
{
|
|
"type": "style",
|
|
"hidden": true
|
|
},
|
|
{
|
|
"type": "refactor",
|
|
"section": "Refactor",
|
|
"hidden": false
|
|
},
|
|
{
|
|
"type": "perf",
|
|
"section": "Performance",
|
|
"hidden": false
|
|
},
|
|
{
|
|
"type": "test",
|
|
"hidden": true
|
|
}
|
|
]
|
|
}
|