Use openUrl instead of onRedirect (#396)

* Use openUrl instead of onRedirect

* update lock file

* fix ci

* update typedoc to show externals

Author: frederikprijck

angular.json

@@ -10,7 +10,7 @@
       "prefix": "lib",
       "architect": {
         "build": {
-          "builder": "@angular-devkit/build-ng-packagr:build",
+          "builder": "@angular-devkit/build-angular:ng-packagr",
           "options": {
             "tsConfig": "projects/auth0-angular/tsconfig.lib.json",
             "project": "projects/auth0-angular/ng-package.json"

package-lock.json

@@ -41,7 +41,6 @@
   },
   "devDependencies": {
     "@angular-devkit/build-angular": "^13.3.9",
-    "@angular-devkit/build-ng-packagr": "^0.1000.8",
     "@angular-eslint/builder": "13.5.0",
     "@angular-eslint/eslint-plugin": "13.5.0",
     "@angular-eslint/eslint-plugin-template": "13.5.0",

package.json

@@ -32,7 +32,7 @@
   },
   "dependencies": {
     "tslib": "^2.0.0",
-    "@auth0/auth0-spa-js": "^1.22.0"
+    "@auth0/auth0-spa-js": "^2.0.1"
   },
   "schematics": "./schematics/collection.json"
 }

projects/auth0-angular/package.json

@@ -0,0 +1,8 @@
+import { RedirectLoginOptions as SPARedirectLoginOptions, LogoutOptions as SPALogoutOptions } from '@auth0/auth0-spa-js';
+
+// eslint-disable-next-line @typescript-eslint/no-empty-interface
+export interface RedirectLoginOptions<TAppState> extends Omit<SPARedirectLoginOptions<TAppState>, 'onRedirect'> {}
+
+// eslint-disable-next-line @typescript-eslint/no-empty-interface
+export interface LogoutOptions extends Omit<SPALogoutOptions, 'onRedirect'> {}
+

projects/auth0-angular/src/interfaces.ts

@@ -298,7 +298,7 @@ describe('AuthService', () => {
           false
         );
         service.logout({
-          onRedirect: async () => {},
+          openUrl: false,
         });
       });
     });
@@ -440,7 +440,7 @@ describe('AuthService', () => {
           false
         );
         service.logout({
-          onRedirect: async () => {},
+          openUrl: false,
         });
       });
     });
@@ -713,7 +713,7 @@ describe('AuthService', () => {
 
   it('should reset the authentication state when passing `localOnly` to logout', (done) => {
     const options = {
-      onRedirect: async () => {
+      openUrl: async () => {
         ((auth0Client.isAuthenticated as unknown) as jest.SpyInstance).mockResolvedValue(
           false
         );

projects/auth0-angular/src/lib/auth.service.spec.ts

@@ -2,16 +2,12 @@ import { Injectable, Inject, OnDestroy } from '@angular/core';
 
 import {
   Auth0Client,
-  RedirectLoginOptions,
   PopupLoginOptions,
   PopupConfigOptions,
-  LogoutOptions,
   GetTokenSilentlyOptions,
   GetTokenWithPopupOptions,
   RedirectLoginResult,
   GetTokenSilentlyVerboseResponse,
-  User,
-  IdToken,
 } from '@auth0/auth0-spa-js';
 
 import {
@@ -39,6 +35,7 @@ import { Auth0ClientService } from './auth.client';
 import { AbstractNavigator } from './abstract-navigator';
 import { AuthClientConfig, AppState } from './auth.config';
 import { AuthState } from './auth.state';
+import { LogoutOptions, RedirectLoginOptions } from '../interfaces';
 
 @Injectable({
   providedIn: 'root',
@@ -176,8 +173,8 @@ export class AuthService<TAppState extends AppState = AppState>
    * Clears the application session and performs a redirect to `/v2/logout`, using
    * the parameters provided as arguments, to clear the Auth0 session.
    * If the `federated` option is specified it also clears the Identity Provider session.
-   * If the `localOnly` option is specified, it only clears the application session.
-   * It is invalid to set both the `federated` and `localOnly` options to `true`,
+   * If the `openUrl` option is set to false, it only clears the application session.
+   * It is invalid to set both the `federated` to true and `openUrl` to `false`,
    * and an error will be thrown if you do.
    * [Read more about how Logout works at Auth0](https://auth0.com/docs/logout).
    *
@@ -186,7 +183,7 @@ export class AuthService<TAppState extends AppState = AppState>
   logout(options?: LogoutOptions): Observable<void> {
     return from(
       this.auth0Client.logout(options).then(() => {
-        if (options?.onRedirect) {
+        if (options?.openUrl === false || options?.openUrl) {
           this.authState.refresh();
         }
       })

projects/auth0-angular/src/lib/auth.service.ts

@@ -116,7 +116,7 @@ describe('AppComponent', () => {
       fixture.detectChanges();
 
       expect(authMock.logout).toHaveBeenCalledWith({
-        onRedirect: undefined,
+        openUrl: undefined,
         logoutParams: {
           federated: false,
           returnTo: 'http://localhost',
@@ -134,7 +134,7 @@ describe('AppComponent', () => {
       fixture.detectChanges();
 
       expect(authMock.logout).toHaveBeenCalledWith({
-        onRedirect: undefined,
+        openUrl: undefined,
         logoutParams: {
           federated: true,
           returnTo: 'http://localhost',
@@ -153,7 +153,7 @@ describe('AppComponent', () => {
 
       expect(authMock.logout).toHaveBeenCalledWith(
         expect.objectContaining({
-          onRedirect: expect.any(Function),
+          openUrl: false,
           logoutParams: {
             federated: false,
             returnTo: 'http://localhost',

projects/playground/src/app/app.component.spec.ts

@@ -4,9 +4,9 @@ import { FormGroup, FormControl } from '@angular/forms';
 import { AuthService } from '../../../auth0-angular/src/lib/auth.service';
 import { iif } from 'rxjs';
 import { first } from 'rxjs/operators';
-import { LogoutOptions } from '@auth0/auth0-spa-js';
 import { DOCUMENT } from '@angular/common';
 import { HttpClient } from '@angular/common/http';
+import { LogoutOptions } from 'projects/auth0-angular/src/interfaces';
 
 @Component({
   selector: 'app-root',
@@ -98,7 +98,7 @@ export class AppComponent implements OnInit {
   launchLogout(): void {
     const formOptions = this.logoutOptionsForm.value;
     const options: LogoutOptions = {
-      onRedirect: formOptions.localOnly === true ? async () => {} : undefined,
+      openUrl: formOptions.localOnly === true ? false : undefined,
       logoutParams: {
         federated: formOptions.federated === true,
         returnTo: this.doc.location.origin,

projects/playground/src/app/app.component.ts

@@ -4,8 +4,13 @@
   "exclude": ["**/*.spec.ts"],
   "tsconfig": "./projects/auth0-angular/tsconfig.lib.json",
   "out": "docs",
-  "excludeExternals": true,
+  "excludeExternals": false,
   "excludePrivate": true,
   "hideGenerator": true,
-  "readme": "./README.md"
+  "readme": "./README.md",
+  "visibilityFilters": {
+    "protected": false,
+    "inherited": true,
+    "external": true,
+  }
 }