Skip to content

Commit

Permalink
feat: added Node.js lts/dubnium support for runtime supported features
Browse files Browse the repository at this point in the history
  • Loading branch information
panva committed Aug 22, 2019
1 parent 1f3e42b commit 54788c2
Show file tree
Hide file tree
Showing 4 changed files with 13 additions and 18 deletions.
2 changes: 2 additions & 0 deletions .github/workflows/test.yml
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,8 @@ jobs:
fail-fast: false
matrix:
node-version:
- 10.13.0
- 10
- 12.0.0
- 12
os:
Expand Down
13 changes: 3 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,6 @@
openid-client is a server side [OpenID][openid-connect] Relying Party (RP, Client) implementation for
Node.js runtime, supports [passport][passport-url].

**WARNING: Node.js 12 or higher is required for openid-client@3 and above.** For older Node.js
versions use [openid-client@2](https://github.com/panva/openid-client/tree/v2.x).

## Implemented specs & features

The following client/RP features from OpenID Connect/OAuth2.0 specifications are implemented by
Expand Down Expand Up @@ -224,12 +221,9 @@ private API and is subject to change between any versions.

#### How do I use it outside of Node.js

It is **only built for Node.js** environment.

#### How do I use it older Node.js versions

Use [openid-client@2](https://github.com/panva/openid-client/tree/v2.x) release line, but be sure
to check its documentation as there were breaking changes between versions 2 and 3.
It is **only built for ^10.13.0 || >=12.0.0 Node.js** environment - including openid-client in
transpiled browser-environment targeted projects is not supported and may result in unexpected
results.

#### What's new in 3.x?

Expand All @@ -239,7 +233,6 @@ to check its documentation as there were breaking changes between versions 2 and
- Added support for any additional token exchange parameters to support specifications such as
Resource Indicators
- Typed [errors][documentation-errors]
- Coming soon™ - Typescript definitions

#### How to make the client send client_id and client_secret in the body?

Expand Down
6 changes: 3 additions & 3 deletions codecov.yml
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
coverage:
status:
project: no
patch: yes
changes: yes
project: off
patch: off
changes: off

comment:
layout: diff
Expand Down
10 changes: 5 additions & 5 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@
"test": "mocha"
},
"dependencies": {
"@panva/jose": "^1.6.1",
"@panva/jose": "^1.8.0",
"base64url": "^3.0.1",
"got": "^9.6.0",
"lodash": "^4.17.13",
Expand All @@ -51,19 +51,19 @@
"@commitlint/cli": "^8.1.0",
"@commitlint/config-conventional": "^8.1.0",
"chai": "^4.2.0",
"eslint": "^6.1.0",
"eslint": "^6.2.1",
"eslint-config-airbnb-base": "^14.0.0",
"eslint-plugin-import": "^2.18.2",
"husky": "^2.7.0",
"husky": "^3.0.4",
"mocha": "^6.2.0",
"nock": "^11.0.0",
"nock": "^11.3.1",
"nyc": "^14.1.1",
"readable-mock-req": "^0.2.2",
"sinon": "^7.3.2",
"timekeeper": "^2.2.0"
},
"engines": {
"node": ">=12.0.0"
"node": "^10.13.0 || >=12.0.0"
},
"commitlint": {
"extends": [
Expand Down

0 comments on commit 54788c2

Please sign in to comment.