@nebular/auth
Version:
@nebular/auth
119 lines (118 loc) • 4.39 kB
TypeScript
import { HttpClient, HttpHeaders } from '@angular/common/http';
import { ActivatedRoute } from '@angular/router';
import { Observable } from 'rxjs';
import { NbAuthStrategy } from '../auth-strategy';
import { NbAuthRefreshableToken, NbAuthToken } from '../../services/token/token';
import { NbAuthResult } from '../../services/auth-result';
import { NbOAuth2AuthStrategyOptions } from './oauth2-strategy.options';
import { NbAuthStrategyClass } from '../../auth.options';
import * as i0 from "@angular/core";
/**
* OAuth2 authentication strategy.
*
* Strategy settings:
*
* ```ts
* export enum NbOAuth2ResponseType {
* CODE = 'code',
* TOKEN = 'token',
* }
*
* export enum NbOAuth2GrantType {
* AUTHORIZATION_CODE = 'authorization_code',
* PASSWORD = 'password',
* REFRESH_TOKEN = 'refresh_token',
* }
*
* export class NbOAuth2AuthStrategyOptions {
* name: string;
* baseEndpoint?: string = '';
* clientId: string = '';
* clientSecret: string = '';
* clientAuthMethod: string = NbOAuth2ClientAuthMethod.NONE;
* redirect?: { success?: string; failure?: string } = {
* success: '/',
* failure: null,
* };
* defaultErrors?: any[] = ['Something went wrong, please try again.'];
* defaultMessages?: any[] = ['You have been successfully authenticated.'];
* authorize?: {
* endpoint?: string;
* redirectUri?: string;
* responseType?: string;
* requireValidToken: true,
* scope?: string;
* state?: string;
* params?: { [key: string]: string };
* } = {
* endpoint: 'authorize',
* responseType: NbOAuth2ResponseType.CODE,
* };
* token?: {
* endpoint?: string;
* grantType?: string;
* requireValidToken: true,
* redirectUri?: string;
* scope?: string;
* class: NbAuthTokenClass,
* } = {
* endpoint: 'token',
* grantType: NbOAuth2GrantType.AUTHORIZATION_CODE,
* class: NbAuthOAuth2Token,
* };
* refresh?: {
* endpoint?: string;
* grantType?: string;
* scope?: string;
* requireValidToken: true,
* } = {
* endpoint: 'token',
* grantType: NbOAuth2GrantType.REFRESH_TOKEN,
* };
* }
* ```
*
*/
export declare class NbOAuth2AuthStrategy extends NbAuthStrategy {
protected http: HttpClient;
protected route: ActivatedRoute;
protected window: any;
static setup(options: NbOAuth2AuthStrategyOptions): [NbAuthStrategyClass, NbOAuth2AuthStrategyOptions];
get responseType(): any;
get clientAuthMethod(): any;
protected redirectResultHandlers: {
[]: Function;
};
protected redirectResults: {
[]: Function;
};
protected defaultOptions: NbOAuth2AuthStrategyOptions;
constructor(http: HttpClient, route: ActivatedRoute, window: any);
authenticate(data?: any): Observable<NbAuthResult>;
getAuthorizationResult(): Observable<any>;
refreshToken(token: NbAuthRefreshableToken): Observable<NbAuthResult>;
passwordToken(username: string, password: string): Observable<NbAuthResult>;
protected authorizeRedirect(): void;
protected isRedirectResult(): Observable<boolean>;
protected requestToken(code: string): Observable<NbAuthResult>;
protected buildCodeRequestData(code: string): any;
protected buildRefreshRequestData(token: NbAuthRefreshableToken): any;
protected buildPasswordRequestData(username: string, password: string): string;
protected buildAuthHeader(): HttpHeaders | undefined;
protected getHeaders(): HttpHeaders;
protected cleanParams(params: any): any;
protected addCredentialsToParams(params: any): any;
protected handleResponseError(res: any): Observable<NbAuthResult>;
protected buildRedirectUrl(): string;
protected parseHashAsQueryParams(hash: string): {
[]: string;
};
protected urlEncodeParameters(params: any): string;
protected createRefreshedToken(res: any, existingToken: NbAuthRefreshableToken, requireValidToken: boolean): NbAuthToken;
register(data?: any): Observable<NbAuthResult>;
requestPassword(data?: any): Observable<NbAuthResult>;
resetPassword(data?: any): Observable<NbAuthResult>;
logout(): Observable<NbAuthResult>;
static ɵfac: i0.ɵɵFactoryDeclaration<NbOAuth2AuthStrategy, never>;
static ɵprov: i0.ɵɵInjectableDeclaration<NbOAuth2AuthStrategy>;
}