@auth0/auth0-angular 1.7.0 → 1.9.0

package/lib/auth.config.d.ts

@@ -205,12 +205,38 @@ export interface AuthConfig {
      * This is available from the user invitation URL that is given when participating in a user invitation flow.
      */
     invitation?: string;
+    /**
+     * The name of the connection configured for your application.
+     * If null, it will redirect to the Auth0 Login Page and show
+     * the Login Widget.
+     */
+    connection?: string;
+    /**
+     * Modify the value used as the current time during the token validation.
+     *
+     * **Note**: Using this improperly can potentially compromise the token validation.
+     */
+    nowProvider?: () => Promise<number> | number;
     /**
      * If you need to send custom parameters to the Authorization Server,
      * make sure to use the original parameter name.
      */
     [key: string]: any;
 }
+/**
+ * Angular specific state to be stored before redirect
+ */
+export interface AppState {
+    /**
+     * Target path the app gets routed to after
+     * handling the callback from Auth0 (defaults to '/')
+     */
+    target?: string;
+    /**
+     * Any custom parameter to be stored in appState
+     */
+    [key: string]: any;
+}
 /**
  * Gets and sets configuration for the internal Auth0 client. This can be
  * used to provide configuration outside of using AuthModule.forRoot, i.e. from

package/lib/auth.service.d.ts

@@ -1,10 +1,10 @@
 import { OnDestroy } from '@angular/core';
-import { Auth0Client, RedirectLoginOptions, PopupLoginOptions, PopupConfigOptions, LogoutOptions, GetTokenSilentlyOptions, GetTokenWithPopupOptions, RedirectLoginResult, LogoutUrlOptions } from '@auth0/auth0-spa-js';
+import { Auth0Client, RedirectLoginOptions, PopupLoginOptions, PopupConfigOptions, LogoutOptions, GetTokenSilentlyOptions, GetTokenWithPopupOptions, RedirectLoginResult, LogoutUrlOptions, GetTokenSilentlyVerboseResponse, GetUserOptions, User, GetIdTokenClaimsOptions, IdToken } from '@auth0/auth0-spa-js';
 import { Observable } from 'rxjs';
 import { AbstractNavigator } from './abstract-navigator';
-import { AuthClientConfig } from './auth.config';
+import { AuthClientConfig, AppState } from './auth.config';
 import { AuthState } from './auth.state';
-export declare class AuthService implements OnDestroy {
+export declare class AuthService<TAppState extends AppState = AppState> implements OnDestroy {
     private auth0Client;
     private configFactory;
     private navigator;
@@ -23,11 +23,11 @@ export declare class AuthService implements OnDestroy {
     /**
      * Emits details about the authenticated user, or null if not authenticated.
      */
-    readonly user$: Observable<import("@auth0/auth0-spa-js").User | null | undefined>;
+    readonly user$: Observable<User | null | undefined>;
     /**
      * Emits ID token claims when authenticated, or null if not authenticated.
      */
-    readonly idTokenClaims$: Observable<import("@auth0/auth0-spa-js").IdToken | null>;
+    readonly idTokenClaims$: Observable<IdToken | null | undefined>;
     /**
      * Emits errors that occur during login, or when checking for an active session on startup.
      */
@@ -36,7 +36,7 @@ export declare class AuthService implements OnDestroy {
      * Emits the value (if any) that was passed to the `loginWithRedirect` method call
      * but only **after** `handleRedirectCallback` is first called
      */
-    readonly appState$: Observable<any>;
+    readonly appState$: Observable<TAppState>;
     constructor(auth0Client: Auth0Client, configFactory: AuthClientConfig, navigator: AbstractNavigator, authState: AuthState);
     /**
      * Called when the service is destroyed
@@ -53,7 +53,7 @@ export declare class AuthService implements OnDestroy {
      *
      * @param options The login options
      */
-    loginWithRedirect(options?: RedirectLoginOptions): Observable<void>;
+    loginWithRedirect(options?: RedirectLoginOptions<TAppState>): Observable<void>;
     /**
      * ```js
      * await loginWithPopup(options);
@@ -89,29 +89,15 @@ export declare class AuthService implements OnDestroy {
      */
     logout(options?: LogoutOptions): void;
     /**
-     * ```js
-     * getAccessTokenSilently(options).subscribe(token => ...)
-     * ```
-     *
-     * If there's a valid token stored, return it. Otherwise, opens an
-     * iframe with the `/authorize` URL using the parameters provided
-     * as arguments. Random and secure `state` and `nonce` parameters
-     * will be auto-generated. If the response is successful, results
-     * will be valid according to their expiration times.
-     *
-     * If refresh tokens are used, the token endpoint is called directly with the
-     * 'refresh_token' grant. If no refresh token is available to make this call,
-     * the SDK falls back to using an iframe to the '/authorize' URL.
-     *
-     * This method may use a web worker to perform the token call if the in-memory
-     * cache is used.
-     *
-     * If an `audience` value is given to this function, the SDK always falls
-     * back to using an iframe to make the token exchange.
+     * Fetches a new access token and returns the response from the /oauth/token endpoint, omitting the refresh token.
      *
-     * Note that in all cases, falling back to an iframe requires access to
-     * the `auth0` cookie, and thus will not work in browsers that block third-party
-     * cookies by default (Safari, Brave, etc).
+     * @param options The options for configuring the token fetch.
+     */
+    getAccessTokenSilently(options: GetTokenSilentlyOptions & {
+        detailedResponse: true;
+    }): Observable<GetTokenSilentlyVerboseResponse>;
+    /**
+     * Fetches a new access token and returns it.
      *
      * @param options The options for configuring the token fetch.
      */
@@ -129,6 +115,44 @@ export declare class AuthService implements OnDestroy {
      * results will be valid according to their expiration times.
      */
     getAccessTokenWithPopup(options?: GetTokenWithPopupOptions): Observable<string>;
+    /**
+     * ```js
+     * getUser(options).subscribe(user => ...);
+     * ```
+     *
+     * Returns the user information if available (decoded
+     * from the `id_token`).
+     *
+     * If you provide an audience or scope, they should match an existing Access Token
+     * (the SDK stores a corresponding ID Token with every Access Token, and uses the
+     * scope and audience to look up the ID Token)
+     *
+     * @remarks
+     *
+     * The returned observable will emit once and then complete.
+     *
+     * @typeparam TUser The type to return, has to extend {@link User}.
+     * @param options The options to get the user
+     */
+    getUser<TUser extends User>(options?: GetUserOptions): Observable<TUser | undefined>;
+    /**
+     * ```js
+     * getIdTokenClaims(options).subscribe(claims => ...);
+     * ```
+     *
+     * Returns all claims from the id_token if available.
+     *
+     * If you provide an audience or scope, they should match an existing Access Token
+     * (the SDK stores a corresponding ID Token with every Access Token, and uses the
+     * scope and audience to look up the ID Token)
+     *
+     * @remarks
+     *
+     * The returned observable will emit once and then complete.
+     *
+     * @param options The options to get the Id token claims
+     */
+    getIdTokenClaims(options?: GetIdTokenClaimsOptions): Observable<IdToken | undefined>;
     /**
      * ```js
      * handleRedirectCallback(url).subscribe(result => ...)
@@ -143,7 +167,7 @@ export declare class AuthService implements OnDestroy {
      *
      * @param url The URL to that should be used to retrieve the `state` and `code` values. Defaults to `window.location.href` if not given.
      */
-    handleRedirectCallback(url?: string): Observable<RedirectLoginResult>;
+    handleRedirectCallback(url?: string): Observable<RedirectLoginResult<TAppState>>;
     /**
      * ```js
      * buildAuthorizeUrl().subscribe(url => ...)

package/lib/auth.state.d.ts

@@ -35,7 +35,7 @@ export declare class AuthState {
     /**
      * Emits ID token claims when authenticated, or null if not authenticated.
      */
-    readonly idTokenClaims$: import("rxjs").Observable<import("@auth0/auth0-spa-js").IdToken | null>;
+    readonly idTokenClaims$: import("rxjs").Observable<import("@auth0/auth0-spa-js").IdToken | null | undefined>;
     /**
      * Emits errors that occur during login, or when checking for an active session on startup.
      */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@auth0/auth0-angular",
-  "version": "1.7.0",
+  "version": "1.9.0",
   "description": "Auth0 SDK for Angular Single Page Applications (SPA)",
   "keywords": [
     "auth0",
@@ -21,12 +21,13 @@
   },
   "homepage": "https://github.com/auth0/auth0-angular#readme",
   "peerDependencies": {
-    "@angular/common": ">=9 <=12",
-    "@angular/core": ">=9 <=12"
+    "@angular/common": ">=9 <=13",
+    "@angular/core": ">=9 <=13",
+    "@angular/router": ">=9 <=13"
   },
   "dependencies": {
     "tslib": "^2.0.0",
-    "@auth0/auth0-spa-js": "^1.16.0"
+    "@auth0/auth0-spa-js": "^1.19.3"
   },
   "schematics": "./schematics/collection.json",
   "main": "bundles/auth0-auth0-angular.umd.js",

package/public-api.d.ts

@@ -5,4 +5,4 @@ export * from './lib/auth.interceptor';
 export * from './lib/auth.config';
 export * from './lib/auth.client';
 export * from './lib/auth.state';
-export { ICache, Cacheable, LocalStorageCache, InMemoryCache, } from '@auth0/auth0-spa-js';
+export { ICache, Cacheable, LocalStorageCache, InMemoryCache, IdToken, User } from '@auth0/auth0-spa-js';