Requires Angular `20.3.18` or above, with Angular peer range `>=20.3.18 <21.0.0`, and RxJS 7+.
## ๐ฆ Usage
### 1. Import and Provide the Service
```typescript
import { AlphaOasService } from '@pvway/alpha-oas';
// ProvidedIn: 'root' - no need to add to providers
```
### 2. Initialize the Service
```typescript
service.init(
httpClient,
getMeUrl,
refreshUrl,
signInUrl,
postErrorLog?,
onPrincipalUpdated?
);
```
### 3. Authenticate and Authorize
```typescript
service.signIn(username, password, rememberMe).subscribe(...);
service.refresh().subscribe(...);
service.getMe().subscribe(...);
service.authorize(httpRequest).subscribe(...);
```
### 4. Use the HTTP Interceptor
```typescript
import { HTTP_INTERCEPTORS } from '@angular/common/http';
import { AlphaOasInterceptor } from '@pvway/alpha-oas';
@NgModule({
providers: [
{ provide: HTTP_INTERCEPTORS, useClass: AlphaOasInterceptor, multi: true }
]
})
```
## ๐งโ๐ API Overview
- `AlphaOasService`: Main authentication service
- `AlphaOasInterceptor`: HTTP interceptor for secure requests
- `AlphaPrincipal`: Tracks authentication state and user
- `IAlphaUser`, `IAlphaAuthEnvelop`, `IAlphaPrincipal`: Strongly-typed models
- `AlphaSessionData`, `AlphaRefreshData`: Token lifecycle helpers
## ๐งช Testing
Run unit tests with:
```bash
ng test AlphaOas
```
## ๐ ๏ธ Building & Publishing
Build the library:
```bash
ng build AlphaOas
```
Publish to npm:
```bash
cd dist/alpha-oas
npm publish
```
## ๐ Documentation
- [Angular CLI Reference](https://angular.dev/tools/cli)
- [OAuth 2.0 Overview](https://oauth.net/2/)
- [RxJS Documentation](https://rxjs.dev/)
## ๐ License
This project is licensed under the MIT License.
---
