Merge pull request #684 from vadjs/master

Add more types in OAuthService

Author: manfredsteyer

projects/lib/src/oauth-service.ts

@@ -54,7 +54,7 @@ export class OAuthService extends AuthConfig implements OnDestroy {
      * @internal
      * Deprecated:  use property events instead
      */
-    public discoveryDocumentLoaded$: Observable<object>;
+    public discoveryDocumentLoaded$: Observable<OidcDiscoveryDoc>;
 
     /**
      * Informs about events, like token_received or token_expires.
@@ -69,7 +69,7 @@ export class OAuthService extends AuthConfig implements OnDestroy {
     public state? = '';
 
     protected eventsSubject: Subject<OAuthEvent> = new Subject<OAuthEvent>();
-    protected discoveryDocumentLoadedSubject: Subject<object> = new Subject<object>();
+    protected discoveryDocumentLoadedSubject: Subject<OidcDiscoveryDoc> = new Subject<OidcDiscoveryDoc>();
     protected silentRefreshPostMessageEventListener: EventListener;
     protected grantTypesSupported: Array<string> = [];
     protected _storage: OAuthStorage;
@@ -128,7 +128,7 @@ export class OAuthService extends AuthConfig implements OnDestroy {
      * Use this method to configure the service
      * @param config the configuration
      */
-    public configure(config: AuthConfig) {
+    public configure(config: AuthConfig): void {
         // For the sake of downward compatibility with
         // original configuration API
         Object.assign(this, new AuthConfig(), config);
@@ -156,7 +156,7 @@ export class OAuthService extends AuthConfig implements OnDestroy {
         this.setupExpirationTimers();
     }
 
-    protected setupSessionCheck() {
+    protected setupSessionCheck(): void {
         this.events.pipe(filter(e => e.type === 'token_received')).subscribe(e => {
             this.initSessionCheck();
         });
@@ -170,7 +170,7 @@ export class OAuthService extends AuthConfig implements OnDestroy {
      * @param params Additional parameter to pass
      * @param listenTo Setup automatic refresh of a specific token type
      */
-    public setupAutomaticSilentRefresh(params: object = {}, listenTo?: 'access_token' | 'id_token' | 'any', noPrompt = true) {
+    public setupAutomaticSilentRefresh(params: object = {}, listenTo?: 'access_token' | 'id_token' | 'any', noPrompt = true): void {
       let shouldRunSilentRefresh = true;
       this.events.pipe(
         tap((e) => {
@@ -194,7 +194,7 @@ export class OAuthService extends AuthConfig implements OnDestroy {
       this.restartRefreshTimerIfStillLoggedIn();
     }
 
-    protected refreshInternal(params, noPrompt) {
+    protected refreshInternal(params, noPrompt): Promise<TokenResponse|OAuthEvent> {
         if (this.responseType === 'code') {
             return this.refreshToken();
         } else {
@@ -409,7 +409,7 @@ export class OAuthService extends AuthConfig implements OnDestroy {
      *
      * @param fullUrl
      */
-    public loadDiscoveryDocument(fullUrl: string = null): Promise<object> {
+    public loadDiscoveryDocument(fullUrl: string = null): Promise<OAuthSuccessEvent> {
         return new Promise((resolve, reject) => {
             if (!fullUrl) {
                 fullUrl = this.issuer || '';
@@ -590,7 +590,7 @@ export class OAuthService extends AuthConfig implements OnDestroy {
         userName: string,
         password: string,
         headers: HttpHeaders = new HttpHeaders()
-    ): Promise<object> {
+    ): Promise<UserInfo> {
         return this.fetchTokenUsingPasswordFlow(userName, password, headers).then(
             () => this.loadUserProfile()
         );
@@ -602,7 +602,7 @@ export class OAuthService extends AuthConfig implements OnDestroy {
      * When using this with OAuth2 password flow, make sure that the property oidc is set to false.
      * Otherwise stricter validations take place that make this operation fail.
      */
-    public loadUserProfile(): Promise<object> {
+    public loadUserProfile(): Promise<UserInfo> {
         if (!this.hasValidAccessToken()) {
             throw new Error('Can not load User Profile without access_token');
         }
@@ -666,7 +666,7 @@ export class OAuthService extends AuthConfig implements OnDestroy {
         userName: string,
         password: string,
         headers: HttpHeaders = new HttpHeaders()
-    ): Promise<object> {
+    ): Promise<TokenResponse> {
         if (!this.validateUrlForHttps(this.tokenEndpoint)) {
             throw new Error(
                 'tokenEndpoint must use https, or config value for property requireHttps must allow http'
@@ -743,7 +743,7 @@ export class OAuthService extends AuthConfig implements OnDestroy {
      * A solution for this is provided by the
      * method silentRefresh.
      */
-    public refreshToken(): Promise<object> {
+    public refreshToken(): Promise<TokenResponse> {
 
         if (!this.validateUrlForHttps(this.tokenEndpoint)) {
             throw new Error(
@@ -958,7 +958,7 @@ export class OAuthService extends AuthConfig implements OnDestroy {
         });
     }
 
-    protected calculatePopupFeatures(options: { height?: number, width?: number }) {
+    protected calculatePopupFeatures(options: { height?: number, width?: number }): string {
         // Specify an static height and width and calculate centered position
         const height = options.height || 470;
         const width = options.width || 500;
@@ -967,7 +967,7 @@ export class OAuthService extends AuthConfig implements OnDestroy {
         return `location=no,toolbar=no,width=${width},height=${height},top=${top},left=${left}`;
     }
 
-    protected processMessageEventMessage(e: MessageEvent) {
+    protected processMessageEventMessage(e: MessageEvent): string {
         let expectedPrefix = '#';
 
         if (this.silentRefreshMessagePrefix) {
@@ -1075,7 +1075,7 @@ export class OAuthService extends AuthConfig implements OnDestroy {
         }
     }
 
-    protected waitForSilentRefreshAfterSessionChange() {
+    protected waitForSilentRefreshAfterSessionChange(): void {
         this.events
             .pipe(
                 filter(
@@ -1173,7 +1173,7 @@ export class OAuthService extends AuthConfig implements OnDestroy {
         customRedirectUri = '',
         noPrompt = false,
         params: object = {}
-    ) {
+    ): Promise<string> {
         const that = this;
 
         let redirectUri: string;
@@ -1268,7 +1268,6 @@ export class OAuthService extends AuthConfig implements OnDestroy {
         }
 
         return url;
-        
     }
 
     initImplicitFlowInternal(
@@ -1452,7 +1451,7 @@ export class OAuthService extends AuthConfig implements OnDestroy {
     /**
      * Get token using an intermediate code. Works for the Authorization Code flow.
      */
-    private getTokenFromCode(code: string): Promise<object> {
+    private getTokenFromCode(code: string): Promise<TokenResponse> {
         let params = new HttpParams()
             .set('grant_type', 'authorization_code')
             .set('code', code)
@@ -1471,7 +1470,7 @@ export class OAuthService extends AuthConfig implements OnDestroy {
         return this.fetchAndProcessToken(params);
     }
 
-    private fetchAndProcessToken(params: HttpParams): Promise<object> {
+    private fetchAndProcessToken(params: HttpParams): Promise<TokenResponse> {
 
         let headers = new HttpHeaders()
                                 .set('Content-Type', 'application/x-www-form-urlencoded');
@@ -1700,7 +1699,7 @@ export class OAuthService extends AuthConfig implements OnDestroy {
         return true;
     }
 
-    protected storeIdToken(idToken: ParsedIdToken) {
+    protected storeIdToken(idToken: ParsedIdToken): void {
         this._storage.setItem('id_token', idToken.idToken);
         this._storage.setItem('id_token_claims_obj', idToken.idTokenClaimsJson);
         this._storage.setItem('id_token_expires_at', '' + idToken.idTokenExpiresAt);
@@ -2092,7 +2091,7 @@ export class OAuthService extends AuthConfig implements OnDestroy {
     /**
      * @ignore
      */
-    public ngOnDestroy() {
+    public ngOnDestroy(): void {
         this.clearAccessTokenTimer();
         this.clearIdTokenTimer();
     }
@@ -2157,7 +2156,7 @@ export class OAuthService extends AuthConfig implements OnDestroy {
     public initLoginFlow(
         additionalState = '',
         params = {}
-    ) {
+    ): void {
         if (this.responseType === 'code') {
             return this.initCodeFlow(additionalState, params);
         } else {