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
35 lines
1.2 KiB
JSON
35 lines
1.2 KiB
JSON
{
|
|
"$schema": "https://typedoc.org/schema.json",
|
|
"disableSources": true,
|
|
"parametersFormat": "table",
|
|
"textContentMappings": {
|
|
"title.memberPage": "{kind}: {name}\n\n[💗 Help the project](https://github.com/sponsors/panva)\n\nSupport from the community to continue maintaining and improving this module is welcome. If you find the module useful, please consider supporting the project by [becoming a sponsor](https://github.com/sponsors/panva).\n\n***\n\n",
|
|
"title.indexPage": "{projectName} API Reference"
|
|
},
|
|
"hideBreadcrumbs": true,
|
|
"hidePageHeader": true,
|
|
"entryPoints": ["src/index.ts"],
|
|
"excludeExternals": false,
|
|
"excludePrivate": true,
|
|
"excludeProtected": true,
|
|
"excludeInternal": true,
|
|
"gitRevision": "main",
|
|
"hideGenerator": true,
|
|
"out": "docs",
|
|
"plugin": ["typedoc-plugin-markdown", "typedoc-plugin-mdn-links"],
|
|
"readme": "none",
|
|
"groupOrder": [
|
|
"You are probably looking for this",
|
|
"Configuration",
|
|
"Grants",
|
|
"Advanced Configuration",
|
|
"Client Authentication Methods",
|
|
"Errors",
|
|
"*",
|
|
"Interfaces",
|
|
"Type Aliases",
|
|
"Variables"
|
|
],
|
|
"sort": ["static-first", "required-first", "alphabetical"]
|
|
}
|