@trust/oidc-web
v0.2.1
Published
Authentication library for Solid client based on OAuth2/OpenID Connect
Downloads
7
Readme
oidc-web
OIDC (OpenID Connect) authentication client for web browsers (Relying Party wrapper)
OpenID Connect Web Client (@trust/oidc-web)
OIDC (OpenID Connect) authentication client for web browsers (Relying Party wrapper)
Authentication client for use in browser-based JS applications.
Table of Contents
Background
Install
$ npm install @trust/oidc-web
Usage
const { OIDCWebClient } = require('@trust/oidc-web')
let auth = new OIDCWebClient({})
auth.login(issuer)
.then(session => {
// logged in session or null
})
// On Document Ready (or on web framework ready) event:
auth.currentSession()
.then(session => {
if (session) {
// logged in
} else {
console.log('please log in')
}
})
Develop
Install
git clone https://github.com/anvilresearch/oidc-web.git
cd oidc-web
npm install
Test
$ npm test
Coverage
$ npm run coverage
API
Contribute
Issues
- please file issues :)
- for bug reports, include relevant details such as platform, version, relevant data, and stack traces
- be sure to check for existing issues before opening new ones
- read the documentation before asking questions
- it's strongly recommended to open an issue before hacking and submitting a PR
- we reserve the right to close an issue for excessive bikeshedding
Pull requests
Policy
- we're not presently accepting unsolicited pull requests
- create an issue to discuss proposed features before submitting a pull request
- create an issue to propose changes of code style or introduce new tooling
- ensure your work is harmonious with the overall direction of the project
- ensure your work does not duplicate existing effort
- keep the scope compact; avoid PRs with more than one feature or fix
- code review with maintainers is required before any merging of pull requests
- new code must respect the style guide and overall architecture of the project
- be prepared to defend your work
Style guide
- Conventional Changelog
- Standard JavaScript (and corresponding editor configs)
- ES6
- jsdocs
Code reviews
- required before merging PRs
- reviewers MUST run and test the code under review
Collaborating
This project is part of a greater group of projects visible here at the @trust organisation on NPM.
Pair programming
- Required for new contributors
- Work directly with one or more members of the core development team
Code of conduct
- @trust/model follows the Contributor Covenant Code of Conduct.
Maintainers
License
MIT © 2017 MIT Trust Consortium