feat: Add MFA support for the WebAuthn recipe [v0.16.0]

CHANGELOG.md

@@ -11,9 +11,9 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 -   Added support for auto inference of request/response body types along with query parameter types in querier methods.
 -   Adds a script to generate the types based on the FDI openapi spec.
+-   Include the `shouldTryLinkingToSessionUser` flag in the `Webauthn` recipe methods
 -   Update supported FDI versions and package version
 
-
 ## [0.15.0] - 2025-03-20
 
 -   Added `Webauthn` recipe to support logins using WebAuthN (Passkeys)

lib/ts/recipe/webauthn/index.ts

@@ -155,6 +155,7 @@ export default class RecipeWrapper {
     static signUp(input: {
         webauthnGeneratedOptionsId: string;
         credential: RegistrationResponseJSON;
+        shouldTryLinkingWithSessionUser?: boolean;
         options?: RecipeFunctionOptions;
         userContext: any;
     }): Promise<
@@ -197,6 +198,7 @@ export default class RecipeWrapper {
     static signIn(input: {
         webauthnGeneratedOptionsId: string;
         credential: AuthenticationResponseJSON;
+        shouldTryLinkingWithSessionUser?: boolean;
         options?: RecipeFunctionOptions;
         userContext: any;
     }): Promise<
@@ -376,6 +378,7 @@ export default class RecipeWrapper {
      */
     static registerCredentialWithSignUp(input: {
         email: string;
+        shouldTryLinkingWithSessionUser?: boolean;
         options?: RecipeFunctionOptions;
         userContext: any;
     }): Promise<
@@ -427,7 +430,11 @@ export default class RecipeWrapper {
      *
      * @returns `{ status: "OK", ...}` if successful along a description of the user details (id, etc.) and email
      */
-    static authenticateCredentialWithSignIn(input: { options?: RecipeFunctionOptions; userContext: any }): Promise<
+    static authenticateCredentialWithSignIn(input: {
+        options?: RecipeFunctionOptions;
+        userContext: any;
+        shouldTryLinkingWithSessionUser?: boolean;
+    }): Promise<
         | {
               status: "OK";
               user: User;

lib/ts/recipe/webauthn/recipeImplementation.ts

@@ -103,7 +103,13 @@ export default function getRecipeImplementation(
                 fetchResponse,
             };
         },
-        signUp: async function ({ webauthnGeneratedOptionsId, credential, options, userContext }) {
+        signUp: async function ({
+            webauthnGeneratedOptionsId,
+            credential,
+            options,
+            userContext,
+            shouldTryLinkingWithSessionUser,
+        }) {
             const { jsonBody, fetchResponse } = await querier.post(
                 {
                     path: "/<tenantId>/webauthn/signup",
@@ -118,6 +124,7 @@ export default function getRecipeImplementation(
                     body: {
                         webauthnGeneratedOptionsId,
                         credential,
+                        shouldTryLinkingWithSessionUser,
                     },
                 },
                 Querier.preparePreAPIHook({
@@ -138,7 +145,13 @@ export default function getRecipeImplementation(
                 fetchResponse,
             };
         },
-        signIn: async function ({ webauthnGeneratedOptionsId, credential, options, userContext }) {
+        signIn: async function ({
+            webauthnGeneratedOptionsId,
+            credential,
+            options,
+            userContext,
+            shouldTryLinkingWithSessionUser,
+        }) {
             const { jsonBody, fetchResponse } = await querier.post(
                 {
                     path: "/<tenantId>/webauthn/signin",
@@ -153,6 +166,7 @@ export default function getRecipeImplementation(
                     body: {
                         webauthnGeneratedOptionsId,
                         credential,
+                        shouldTryLinkingWithSessionUser,
                     },
                 },
                 Querier.preparePreAPIHook({
@@ -303,7 +317,12 @@ export default function getRecipeImplementation(
                 registrationResponse,
             };
         },
-        registerCredentialWithSignUp: async function ({ email, options, userContext }) {
+        registerCredentialWithSignUp: async function ({
+            email,
+            shouldTryLinkingWithSessionUser,
+            options,
+            userContext,
+        }) {
             // Get the registration options by using the passed email ID.
             const registrationOptions = await this.getRegisterOptions({ options, userContext, email });
             if (registrationOptions?.status !== "OK") {
@@ -330,6 +349,7 @@ export default function getRecipeImplementation(
             return await this.signUp({
                 webauthnGeneratedOptionsId: registrationOptions.webauthnGeneratedOptionsId,
                 credential: registerCredentialResponse.registrationResponse,
+                shouldTryLinkingWithSessionUser,
                 options,
                 userContext,
             });
@@ -357,7 +377,7 @@ export default function getRecipeImplementation(
                 authenticationResponse: authenticationResponse,
             };
         },
-        authenticateCredentialWithSignIn: async function ({ options, userContext }) {
+        authenticateCredentialWithSignIn: async function ({ shouldTryLinkingWithSessionUser, options, userContext }) {
             // Make a call to get the sign in options using the entered email ID.
             const signInOptions = await this.getSignInOptions({ options, userContext });
             if (signInOptions?.status !== "OK") {
@@ -379,6 +399,7 @@ export default function getRecipeImplementation(
             return await this.signIn({
                 webauthnGeneratedOptionsId: signInOptions.webauthnGeneratedOptionsId,
                 credential: authenticateCredentialResponse.authenticationResponse,
+                shouldTryLinkingWithSessionUser,
                 options: options,
                 userContext: userContext,
             });

lib/ts/recipe/webauthn/types.ts

@@ -152,6 +152,7 @@ export type RecipeInterface = {
     signUp: (input: {
         webauthnGeneratedOptionsId: string;
         credential: RegistrationResponseJSON;
+        shouldTryLinkingWithSessionUser?: boolean;
         options?: RecipeFunctionOptions;
         userContext: any;
     }) => Promise<
@@ -175,6 +176,7 @@ export type RecipeInterface = {
     signIn: (input: {
         webauthnGeneratedOptionsId: string;
         credential: AuthenticationResponseJSON;
+        shouldTryLinkingWithSessionUser?: boolean;
         options?: RecipeFunctionOptions;
         userContext: any;
     }) => Promise<
@@ -256,6 +258,7 @@ export type RecipeInterface = {
     >;
     registerCredentialWithSignUp: (input: {
         email: string;
+        shouldTryLinkingWithSessionUser?: boolean;
         options?: RecipeFunctionOptions;
         userContext: any;
     }) => Promise<
@@ -284,7 +287,11 @@ export type RecipeInterface = {
         | { status: "FAILED_TO_REGISTER_USER"; error: any }
         | { status: "WEBAUTHN_NOT_SUPPORTED"; error: any }
     >;
-    authenticateCredentialWithSignIn: (input: { options?: RecipeFunctionOptions; userContext: any }) => Promise<
+    authenticateCredentialWithSignIn: (input: {
+        shouldTryLinkingWithSessionUser?: boolean;
+        options?: RecipeFunctionOptions;
+        userContext: any;
+    }) => Promise<
         | {
               status: "OK";
               user: User;