wp-calypso/client/landing/stepper/hooks/use-exit-flow.ts

import { useDispatch } from '@wordpress/data';
import { ONBOARD_STORE } from 'calypso/landing/stepper/stores';
import type { Navigate } from '../declarative-flow/internals/types';

type UseExitFlowParams =
	| { processing: true; navigate: Navigate }
	| { processing?: false; navigate?: Navigate }
	| undefined;

/**
 * The useExitFlow hook provides a function to handle exiting a flow
 * by setting a pending action that redirects the browser to a specified URL,
 * with an optional navigation step if processing is required.
 */
export const useExitFlow = ( params?: UseExitFlowParams ) => {
	const { setPendingAction } = useDispatch( ONBOARD_STORE );

	const exitFlow = ( to: string ) => {
		setPendingAction( () => {
			return new Promise( () => {
				window.location.assign( to );
			} );
		} );

		if ( params?.processing && params?.navigate ) {
			return params.navigate( 'processing' );
		}
	};

	return {
		exitFlow,
	};
};