fix(auth): pass preferredRedirectUrl through signInWithRedirect to ge…

packages/auth/__tests__/providers/cognito/signInWithRedirect.test.ts

@@ -434,6 +434,56 @@ describe('signInWithRedirect', () => {
 		});
 	});
 
+	describe('preferredRedirectUrl', () => {
+		it('passes preferredRedirectUrl to getRedirectUrl and uses it in the authorization URL', async () => {
+			const preferredUrl = 'http://localhost:3000/';
+			await signInWithRedirect({
+				provider: 'Google',
+				options: {
+					preferredRedirectUrl: preferredUrl,
+				},
+			});
+
+			const [oauthUrl] = mockOpenAuthSession.mock.calls[0];
+			expect(oauthUrl).toContain(
+				`redirect_uri=${encodeURIComponent(preferredUrl)}`,
+			);
+		});
+
+		it('uses preferredRedirectUrl when multiple redirect URLs are configured', async () => {
+			const preferredUrl = 'https://myapp.example.com/callback';
+			const mockConfigWithMultipleRedirects = {
+				Auth: {
+					Cognito: {
+						...mockAuthConfigWithOAuth.Auth.Cognito,
+						loginWith: {
+							...mockAuthConfigWithOAuth.Auth.Cognito.loginWith,
+							oauth: {
+								...mockAuthConfigWithOAuth.Auth.Cognito.loginWith.oauth,
+								redirectSignIn: ['http://localhost:3000/', preferredUrl],
+							},
+						},
+					},
+				},
+			};
+			(Amplify.getConfig as jest.Mock).mockReturnValueOnce(
+				mockConfigWithMultipleRedirects,
+			);
+
+			await signInWithRedirect({
+				provider: 'Google',
+				options: {
+					preferredRedirectUrl: preferredUrl,
+				},
+			});
+
+			const [oauthUrl] = mockOpenAuthSession.mock.calls[0];
+			expect(oauthUrl).toContain(
+				`redirect_uri=${encodeURIComponent(preferredUrl)}`,
+			);
+		});
+	});
+
 	describe('errors', () => {
 		it('rethrows error thrown from `assertTokenProviderConfig`', async () => {
 			const mockError = new Error('mock error');

packages/auth/src/providers/cognito/apis/signInWithRedirect.ts

@@ -75,6 +75,7 @@ export async function signInWithRedirect(
 			prompt: input?.options?.prompt,
 		},
 		authSessionOpener: input?.options?.authSessionOpener,
+		preferredRedirectUrl: input?.options?.preferredRedirectUrl,
 	});
 }
 
@@ -87,6 +88,7 @@ const oauthSignIn = async ({
 	preferPrivateSession,
 	options,
 	authSessionOpener,
+	preferredRedirectUrl,
 }: {
 	oauthConfig: OAuthConfig;
 	provider: string;
@@ -96,6 +98,7 @@ const oauthSignIn = async ({
 	preferPrivateSession?: boolean;
 	options?: SignInWithRedirectInput['options'];
 	authSessionOpener?: OpenAuthSession;
+	preferredRedirectUrl?: string;
 }) => {
 	const { domain, redirectSignIn, responseType, scopes } = oauthConfig;
 	const { loginHint, lang, nonce, prompt } = options ?? {};
@@ -113,7 +116,10 @@ const oauthSignIn = async ({
 		: randomState;
 
 	const { value, method, toCodeChallenge } = generateCodeVerifier(128);
-	const redirectUri = getRedirectUrl(oauthConfig.redirectSignIn);
+	const redirectUri = getRedirectUrl(
+		oauthConfig.redirectSignIn,
+		preferredRedirectUrl,
+	);
 
 	if (isBrowser()) oAuthStore.storeOAuthInFlight(true);
 	oAuthStore.storeOAuthState(state);

packages/auth/src/types/inputs.ts

@@ -124,6 +124,12 @@ export interface AuthSignInWithRedirectInput {
 		 * @see https://docs.aws.amazon.com/cognito/latest/developerguide/authorization-endpoint.html
 		 */
 		prompt?: AuthPrompt;
+		/**
+		 * The preferred redirect URL to use for the OAuth flow. Must match one of the
+		 * configured `redirectSignIn` URLs. On native platforms, this allows selecting
+		 * an HTTPS App Link/Universal Link over the default custom scheme.
+		 */
+		preferredRedirectUrl?: string;
 	};
 }