feat: adds initialPath param to getWithPopup (#1594)

OKTA-972681 feat: adds initialPath param to getWithPopup

Author: jaredperreault-okta

CHANGELOG.md

@@ -1,5 +1,13 @@
 # Changelog
 
+# 7.13.0
+
+### Features
+
+- [#1594](https://github.com/okta/okta-auth-js/pull/1594) feat: adds `initialPath` configuration to `token.getWithPopup`
+
+- [#1593](https://github.com/okta/okta-auth-js/pull/1593) feat: adds `multiOptionalFactorEnroll` support to `authn.verifyRecoveryToken`
+
 # 7.12.1
 
 ### Fixes

README.md

@@ -1633,6 +1633,8 @@ authClient.token.getWithoutPrompt({
 Create token with a popup.
 
 * `options` - See [Authorize options](#authorize-options)
+* `options.initialPath` - `string` _(optional)_ 
+To reduce the likelihood of the popup being blocked, the popup window first loads the web app before redirecting to the authorization server. Customize the path which is loaded by setting this value. (This must be an unauthenticated path). Defaults to `'/'`
 
 ```javascript
 authClient.token.getWithPopup(options)

lib/oidc/getWithPopup.ts

@@ -16,22 +16,27 @@ import { clone } from '../util';
 import { getToken } from './getToken';
 import { loadPopup, generateState } from './util';
 
-export function getWithPopup(sdk: OktaAuthOAuthInterface, options: TokenParams): Promise<TokenResponse> {
+export function getWithPopup(
+  sdk: OktaAuthOAuthInterface,
+  options: TokenParams & { initialPath?: string }
+): Promise<TokenResponse> {
   if (arguments.length > 2) {
     return Promise.reject(new AuthSdkError('As of version 3.0, "getWithPopup" takes only a single set of options'));
   }
 
+  const { initialPath, ...params } = options;
+
   // some browsers (safari, firefox) block popup if it's initialed from an async process
   // here we create the popup window immediately after user interaction
   // then redirect to the /authorize endpoint when the requestUrl is available
-  const popupWindow = loadPopup('/', options);
-  options = clone(options) || {};
-  Object.assign(options, {
+  const popupWindow = loadPopup(initialPath ?? '/', params);
+  options = clone(params) || {};
+  Object.assign(params, {
     display: 'popup',
     responseMode: 'okta_post_message',
     popupWindow
   });
-  return getToken(sdk, options);
+  return getToken(sdk, params);
 }
 
 export function getWithIDPPopup(

test/spec/oidc/getWithPopup.ts

@@ -170,16 +170,17 @@ describe('token.getWithPopup', function() {
       });
   });
 
-  it('returns tokens using idp with authorization server', function() {
-      return oauthUtil.setupPopup({
+  it('returns tokens using idp with authorization server', async function() {
+      await oauthUtil.setupPopup({
         oktaAuthArgs: {
           pkce: false,
           issuer: 'https://auth-js-test.okta.com/oauth2/aus8aus76q8iphupD0h7',
           clientId: 'NPSfOkH5eZrTy8PMDlvx',
           redirectUri: 'https://example.com/redirect'
         },
         getWithPopupArgs: {
-          idp: 'testIdp'
+          idp: 'testIdp',
+          initialPath: '?foo=1'
         },
         postMessageSrc: {
           baseUri: 'https://auth-js-test.okta.com/oauth2/aus8aus76q8iphupD0h7/v1/authorize',
@@ -207,6 +208,8 @@ describe('token.getWithPopup', function() {
           }
         }
       });
+      expect(window.open).toHaveBeenCalled();
+      expect(window.open).toHaveBeenCalledWith('?foo=1', expect.any(String), expect.any(String));
   });
 
   it('allows passing issuer through getWithPopup, which takes precedence', function() {