Address feedback

lib/msal-browser/docs/navigation.md

@@ -4,7 +4,7 @@ By default `msal-browser` uses `window.location.assign` and `window.location.rep
 
 ## Writing your own implemenation
 
-The interface contains 2 methods: 
+The interface contains 2 methods:
 
 - `navigateInternal` - Called when redirecting between pages in your app e.g. redirecting from the `redirectUri` back to the page that initiated the login
 - `navigateExternal` - Called when redirecting to urls external to your app e.g. AAD Sign-in prompt
@@ -35,6 +35,8 @@ class CustomNavigationClient extends NavigationClient {
 }
 ```
 
+**Note:** When providing your own implementation of `navigateInternal` you should not navigate to a different domain as this can break your authentication flow. It is intended only to be used for navigation to pages on the same domain.
+
 ### Function Parameters
 
 - `url`: The URL MSAL.js would like to navigate to. This will be an absolute url. If you need a relative url it is your responsibility to parse this out.

lib/msal-browser/src/navigation/NavigationClient.ts

@@ -13,17 +13,7 @@ export class NavigationClient implements INavigationClient {
      * @param options 
      */
     navigateInternal(url: string, options: NavigationOptions): Promise<boolean>{
-        if (options.noHistory) {
-            window.location.replace(url);
-        } else {
-            window.location.assign(url);
-        }
-
-        return new Promise((resolve) => {
-            setTimeout(() => {
-                resolve(true);
-            }, options.timeout);
-        });
+        return NavigationClient.defaultNavigateWindow(url, options);
     }
 
     /**
@@ -32,6 +22,15 @@ export class NavigationClient implements INavigationClient {
      * @param options 
      */
     navigateExternal(url: string, options: NavigationOptions): Promise<boolean> {
+        return NavigationClient.defaultNavigateWindow(url, options);
+    }
+
+    /**
+     * Default navigation implementation invoked by the internal and external functions
+     * @param url 
+     * @param options 
+     */
+    private static defaultNavigateWindow(url: string, options: NavigationOptions): Promise<boolean> {
         if (options.noHistory) {
             window.location.replace(url);
         } else {

lib/msal-browser/src/navigation/NavigationOptions.ts

@@ -5,8 +5,14 @@
 
 import { ApiId } from "../utils/BrowserConstants";
 
+/**
+ * Additional information passed to the navigateInternal and navigateExternal functions
+ */
 export type NavigationOptions = {
+    /** The Id of the API that initiated navigation */
     apiId: ApiId
+    /** Suggested timeout (ms) based on the configuration provided to PublicClientApplication */
     timeout: number
+    /** When set to true the url should not be added to the browser history */
     noHistory: boolean
 };