lonelyhentxi
fe10ed2850
Some checks failed
Build, Lint & Test Lib / Build, Lint and Test Library (push) Has been cancelled
67 lines
2.0 KiB
Markdown
67 lines
2.0 KiB
Markdown
<h1 align="center">
|
|
<img src="./assets/logo-512.png" height="150" alt="OUTPOSTS">
|
|
<div style="color: #232848; font-weight: 700;">OIDC-CLIENT-RX</div>
|
|
<div align="center">
|
|
<img src="https://img.shields.io/github/actions/workflow/status/lonelyhentxi/oidc-client-rx/build.yml?branch=main" alt="build-status" />
|
|
<img src="https://img.shields.io/badge/status-work--in--progress-blue" alt="status-badge" />
|
|
</div>
|
|
</h1>
|
|
|
|
<p align="center">ReactiveX enhanced OIDC and OAuth2 protocol support for browser-based JavaScript applications.</p>
|
|
|
|
## Quick Start
|
|
|
|
@TODO Add More Details
|
|
|
|
### Install
|
|
|
|
```sh
|
|
pnpm add oidc-client-rx @outposts/injection-js @abraham/reflection
|
|
# npm install oidc-client-rx @outposts/injection-js @abraham/reflection
|
|
# yarn add oidc-client-rx @outposts/injection-js @abraham/reflection
|
|
```
|
|
|
|
### Basic Usage
|
|
|
|
```typescript
|
|
import '@abraham/reflection'; // or 'reflect-metadata' | 'core-js/es7/reflect'
|
|
import { type Injector, ReflectiveInjector } from '@outposts/injection-js';
|
|
import { LogLevel, OidcSecurityService, provideAuth, withDefaultFeatures } from 'oidc-client-rx';
|
|
|
|
const injector = ReflectiveInjector.resolveAndCreate(
|
|
provideAuth(
|
|
{
|
|
config: {
|
|
authority: '<your-authority>',
|
|
redirectUrl: `${window.location.origin}/auth/callback`,
|
|
postLogoutRedirectUri: window.location.origin,
|
|
clientId: '<your-client-id>',
|
|
scope: 'openid profile email offline_access',
|
|
responseType: 'code',
|
|
silentRenew: true,
|
|
useRefreshToken: true,
|
|
logLevel: LogLevel.Debug,
|
|
...
|
|
},
|
|
},
|
|
withDefaultFeatures()
|
|
)
|
|
) as Injector;
|
|
|
|
const oidcSecurityService = injector.get(OidcSecurityService);
|
|
|
|
oidcSecurityService.checkAuth().subscribe((result) => {
|
|
console.debug('checkAuth result: ', result);
|
|
});
|
|
|
|
const isAuthenticated$ = oidcSecurityService.isAuthenticated$;
|
|
```
|
|
|
|
### More Examples
|
|
|
|
- [React + TanStack Router](https://github.com/lonelyhentxi/oidc-client-rx/tree/main/examples/react-tanstack-router)
|
|
|
|
## License
|
|
|
|
[MIT](https://choosealicense.com/licenses/mit/)
|