fix(davinci-client): return-url-from-external-idp

updating the api for the social login external idp method. Instead
of redirecting for the application, we will return a url for the
application to redirect to themselves.

Author: ryanbas21

.changeset/clear-cars-tan.md

@@ -0,0 +1,5 @@
+---
+'@forgerock/davinci-client': patch
+---
+
+Return a url from the externalIdp function for app developers to use to redirect their url

e2e/davinci-app/components/social-login-button.ts

@@ -5,17 +5,28 @@
  * of the MIT license. See the LICENSE file for details.
  */
 import type { IdpCollector } from '@forgerock/davinci-client/types';
+import { InternalErrorResponse } from 'packages/davinci-client/src/lib/client.types.js';
 
 export default function submitButtonComponent(
   formEl: HTMLFormElement,
   collector: IdpCollector,
-  updater: () => void,
+  updater: () => string | InternalErrorResponse,
 ) {
   const button = document.createElement('button');
   console.log('collector', collector);
   button.value = collector.output.label;
   button.innerHTML = collector.output.label;
-  button.onclick = () => updater();
+  button.onclick = () => {
+    const url = updater();
+    if (typeof url === 'string') {
+      window.location.assign(url);
+    } else {
+      /**
+       * this is an error now
+       **/
+      console.error(url);
+    }
+  };
 
   formEl?.appendChild(button);
 }

e2e/davinci-app/main.ts

@@ -239,7 +239,6 @@ const urlParams = new URLSearchParams(window.location.search);
         );
       } else if (collector.type === 'IdpCollector') {
         // eslint-disable-next-line @typescript-eslint/no-unused-expressions
-        collector;
         socialLoginButtonComponent(formEl, collector, davinciClient.externalIdp(collector));
       } else if (collector.type === 'FlowCollector') {
         flowLinkComponent(

packages/davinci-client/src/lib/client.store.ts

@@ -33,10 +33,16 @@ import type {
   ObjectValueCollectors,
   PhoneNumberInputValue,
 } from './collector.types.js';
-import type { InitFlow, NodeStates, Updater, Validator } from './client.types.js';
+import type {
+  InitFlow,
+  InternalErrorResponse,
+  NodeStates,
+  Updater,
+  Validator,
+} from './client.types.js';
 import { returnValidator } from './collector.utils.js';
-import { authorize } from './davinci.utils.js';
 import { StartNode } from './node.types.js';
+import { returnRedirectUrlForSocialLogin } from './davinci.utils.js';
 
 /**
  * Create a client function that returns a set of methods
@@ -108,12 +114,18 @@ export async function davinci<ActionType extends ActionTypes = ActionTypes>({
      * @param collector IdpCollector
      * @returns {function}
      */
-    externalIdp: (collector: IdpCollector) => {
+    externalIdp: (collector: IdpCollector): (() => string | InternalErrorResponse) => {
       const rootState: RootState = store.getState();
 
       const serverSlice = nodeSlice.selectors.selectServer(rootState);
 
-      return () => authorize(serverSlice, collector, log);
+      return () => {
+        const result = returnRedirectUrlForSocialLogin(serverSlice, collector, log);
+        if (typeof result == 'string') {
+          return result;
+        }
+        return result;
+      };
     },
 
     /**

packages/davinci-client/src/lib/davinci.utils.ts

@@ -246,39 +246,43 @@ export function handleResponse(
   }
 }
 
-export function authorize(
+export function returnRedirectUrlForSocialLogin(
   serverSlice: RootState['node']['server'],
   collector: IdpCollector,
   logger: ReturnType<typeof loggerFn>,
-): InternalErrorResponse | void {
+): InternalErrorResponse | string {
   if (serverSlice && '_links' in serverSlice) {
     const continueUrl = serverSlice._links?.['continue']?.href ?? null;
     if (continueUrl) {
       window.localStorage.setItem('continueUrl', continueUrl);
       if (collector.output.url) {
-        window.location.assign(collector.output.url);
+        return collector.output.url;
+      } else {
+        logger.error('No url found in collector, social login needs a url in the collector');
+        return {
+          error: {
+            message:
+              'No url found in collector, social login needs a url in the collector to navigate to',
+            type: 'network_error',
+          },
+          type: 'internal_error',
+        };
       }
-    } else {
-      logger.error('No url found in collector, social login needs a url in the collector');
-      return {
-        error: {
-          message:
-            'No url found in collector, social login needs a url in the collector to navigate to',
-          type: 'network_error',
-        },
-        type: 'internal_error',
-      };
     }
-    logger.error(
-      'No Continue Url found, social login needs a continue url to be saved in localStorage',
-    );
-    return {
-      error: {
-        message:
-          'No Continue Url found, social login needs a continue url to be saved in localStorage',
-        type: 'network_error',
-      },
-      type: 'internal_error',
-    };
   }
+  /**
+   * If we have no continue url
+   * we have to return an error
+   **/
+  logger.error(
+    'No Continue Url found, social login needs a continue url to be saved in localStorage',
+  );
+  return {
+    error: {
+      message:
+        'No Continue Url found, social login needs a continue url to be saved in localStorage',
+      type: 'network_error',
+    },
+    type: 'internal_error',
+  };
 }