@clerk/shared
Version:
Internal package utils used by the Clerk SDKs
37 lines • 1.26 kB
text/typescript
import { SignUpResource } from "../../types/signUp.mjs";
//#region src/internal/clerk-js/navigateToNextStepSignUp.d.ts
type NavigateToNextStepSignUpProps = {
signUp: SignUpResource;
continueSignUpUrl: string;
verifyEmailAddressUrl: string;
verifyPhoneNumberUrl: string;
signUpProtectCheckUrl: string;
navigate: (to: string, options?: {
searchParams?: URLSearchParams;
}) => Promise<unknown>;
};
/**
* Routes a sign-up that's still in `missing_requirements` to the appropriate
* next step:
*
* - If the sign-up is protect-gated, go to the protect-check challenge.
* - Otherwise, if there are missing fields, go straight to the continue page so
* the user can fill them in.
* - Otherwise, hand off to `completeSignUpFlow` which routes unverified email
* or phone identifications to their respective verify pages.
*
* Used by both the OAuth callback handler and the sign-in `signUpIfMissing`
* transfer flow so they stay in lockstep.
*
* @internal
*/
declare const navigateToNextStepSignUp: ({
signUp,
continueSignUpUrl,
verifyEmailAddressUrl,
verifyPhoneNumberUrl,
signUpProtectCheckUrl,
navigate
}: NavigateToNextStepSignUpProps) => Promise<unknown> | undefined;
//#endregion
export { navigateToNextStepSignUp };