Skip to content

Commit 79867b3

Browse files
committed
chore: bump to v9.0.0-alpha
1 parent 7aec052 commit 79867b3

File tree

3 files changed

+35
-28
lines changed

3 files changed

+35
-28
lines changed

README.md

Lines changed: 27 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# angular-simple-oidc
22

3-
An Angular (currently 8+, lower versions could be supported) library for the [Open Id Connect Protocol](https://openid.net/specs/openid-connect-core-1_0.html) implementing:
3+
An Angular library for the [Open Id Connect Protocol](https://openid.net/specs/openid-connect-core-1_0.html) implementing:
44

55
* Discovery Document
66
* Code Flow
@@ -9,6 +9,21 @@ An Angular (currently 8+, lower versions could be supported) library for the [Op
99
* Session Checks
1010
* Code Flow in popup
1111

12+
## Angular Versioning
13+
14+
For Angular 8, use the `v8.x` latest release.
15+
16+
For Angular 9, use the `v9.x` latest release.
17+
18+
Using `master` branch is not recommended.
19+
20+
## Disclaimer
21+
22+
I am not a security expert. I've followed my best the RFCs, please I encourage you
23+
to review my work and report issues if you suspect something may be wrong.
24+
25+
**Use at your own risk**.
26+
1227
## Motivation
1328

1429
Why another OIDC library?
@@ -34,6 +49,14 @@ Install from NPM
3449
yarn add angular-simple-oidc
3550
```
3651

52+
### Configuring your Identity Provider
53+
54+
Authorization Code Flow with PKCE will be used, so your Identity Provider (idp)
55+
must support this. Your idp may require a client secret as well.
56+
57+
The redirect URI, by default will be `http://yourapp.example.com/oidc-token-callback`.
58+
You can change the path by configuring the `tokenCallbackRoute`.
59+
3760
### Static Configuration
3861

3962
You will then need to supply the configuration for OIDC.
@@ -65,6 +88,9 @@ import {
6588
// clientSecret: 'myDummySecret',
6689
openIDProviderUrl: 'http://my.oidc.provider.com',
6790
scope: 'openid profile offline_access',
91+
92+
// Other relevant configs.
93+
// tokenCallbackRoute: 'oidc-token-callback'
6894
}),
6995

7096
// For automatic token refresh.
Lines changed: 3 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,5 @@
1-
# AngularSimpleOidc
1+
# angular-simple-oidc
22

3-
This library was generated with [Angular CLI](https://github.com/angular/angular-cli) version 8.1.2.
3+
Please, check the [whole readme at GitHub](https://github.com/leonardochaia/angular-simple-oidc#angular-simple-oidc)
44

5-
## Code scaffolding
6-
7-
Run `ng generate component component-name --project angular-simple-oidc` to generate a new component. You can also use `ng generate directive|pipe|service|class|guard|interface|enum|module --project angular-simple-oidc`.
8-
> Note: Don't forget to add `--project angular-simple-oidc` or else it will be added to the default project in your `angular.json` file.
9-
10-
## Build
11-
12-
Run `ng build angular-simple-oidc` to build the project. The build artifacts will be stored in the `dist/` directory.
13-
14-
## Publishing
15-
16-
After building your library with `ng build angular-simple-oidc`, go to the dist folder `cd dist/angular-simple-oidc` and run `npm publish`.
17-
18-
## Running unit tests
19-
20-
Run `ng test angular-simple-oidc` to execute the unit tests via [Karma](https://karma-runner.github.io).
21-
22-
## Further help
23-
24-
To get more help on the Angular CLI use `ng help` or go check out the [Angular CLI README](https://github.com/angular/angular-cli/blob/master/README.md).
5+
Sorry for the troubles.

projects/angular-simple-oidc/package.json

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "angular-simple-oidc",
3-
"version": "8.1.3",
3+
"version": "9.0.0-alpha",
44
"description": "Angular Library implementing Open Id Connect specification. Code Flow, Refresh Tokens, Session Management, Discovery Document.",
55
"repository": {
66
"type": "git",
@@ -27,10 +27,10 @@
2727
"url": "https://github.com/leonardochaia"
2828
},
2929
"peerDependencies": {
30-
"@angular/common": "^8.1.2",
31-
"@angular/core": "^8.1.2"
30+
"@angular/common": "^9.1.11",
31+
"@angular/core": "^9.1.11"
3232
},
3333
"dependencies": {
34-
"jsrsasign": "^8.0.12"
34+
"jsrsasign": "^8.0.18"
3535
}
36-
}
36+
}

0 commit comments

Comments
 (0)