Fixed back stack navigation issue in Add Authenticator's SDK (#27)

Author: Sudhanshu96

Auth0UniversalComponents/Core/Navigation/Router.swift

@@ -35,6 +35,12 @@ public class Router<Route: Hashable>: ObservableObject {
     /// `nil` in standalone mode; set via `useExternalPath(_:)` at view appearance.
     private var externalPath: Binding<NavigationPath>?
 
+    /// Snapshot of the host path depth at the moment `useExternalPath(_:)` was called.
+    ///
+    /// Used by `popToSDKRoot()` to determine how many entries the SDK itself has
+    /// appended, so only those are removed without disturbing host-app entries.
+    private var initialExternalPathCount = 0
+
     public init() {}
 
     /// Redirects all navigation operations to an external `NavigationPath` binding.
@@ -46,6 +52,7 @@ public class Router<Route: Hashable>: ObservableObject {
     /// - Parameter binding: A writable binding to the host stack's `NavigationPath`.
     func useExternalPath(_ binding: Binding<NavigationPath>) {
         externalPath = binding
+        initialExternalPathCount = binding.wrappedValue.count
     }
 
     /// Pushes `route` onto the navigation stack.
@@ -81,4 +88,20 @@ public class Router<Route: Hashable>: ObservableObject {
             path.removeLast(path.count)
         }
     }
+
+    /// Pops only the routes pushed by the SDK, returning to `MyAccountAuthMethodsView`.
+    ///
+    /// In standalone mode, clears the entire internal path so the root content
+    /// (`MyAccountAuthMethodsView`) is shown.
+    /// In embedded mode, only removes entries added since `useExternalPath(_:)` was
+    /// called, leaving the host-app entries intact so the host stack is undisturbed.
+    func popToSDKRoot() {
+        if let ext = externalPath {
+            let toRemove = ext.wrappedValue.count - initialExternalPathCount
+            guard toRemove > 0 else { return }
+            ext.wrappedValue.removeLast(toRemove)
+        } else {
+            path.removeLast(path.count)
+        }
+    }
 }

Auth0UniversalComponents/Core/Utils/Hashable+Extension.swift

@@ -24,7 +24,8 @@ enum Route: Hashable {
                    emailEnrollmentChallenge: EmailEnrollmentChallenge? = nil)
     /// Route to the filtered authentication method selection screen
     case filteredAuthListScreen(type: AuthMethodType,
-                                authMethods: [AuthenticationMethod])
+                                authMethods: [AuthenticationMethod],
+                                isPostEnrollment: Bool = false)
 }
 
 /// Makes AuthMethodType conform to Hashable for use in routes.

Auth0UniversalComponents/Core/ViewFactories/ViewFactory.swift

@@ -19,9 +19,10 @@ struct ViewFactory {
                                             type: type,
                                             emailOrPhoneNumber: emailOrPhoneNumber,
                                             delegate: delegate))
-        case let .filteredAuthListScreen(type, authMethods):
+        case let .filteredAuthListScreen(type, authMethods, isPostEnrollment):
             SavedAuthenticatorsView(viewModel: SavedAuthenticatorsViewModel(type: type,
                                                                             authenticationMethods: authMethods,
+                                                                            isPostEnrollment: isPostEnrollment,
                                                                             delegate: delegate))
         case let .emailPhoneEnrollmentScreen(type):
             EmailPhoneEnrollmentView(viewModel: EmailPhoneEnrollmentViewModel(type: type))

Auth0UniversalComponents/Passkeys/Presentation/PasskeysEnrollmentViewModel.swift

@@ -107,7 +107,7 @@ final class PasskeysEnrollmentViewModel: NSObject,
                         )
                         _ = try await confirmPasskeyEnrollmentUseCase.execute(request: confirmPasskeyEnrollmentRequest)
                         delegate?.refreshAuthData()
-                        navigationRoute = .filteredAuthListScreen(type: .passkey, authMethods: [])
+                        navigationRoute = .filteredAuthListScreen(type: .passkey, authMethods: [], isPostEnrollment: true)
                     } catch {
                         await handle(error: error, scope: "openid create:me:authentication_methods") { [weak self] in
                             Task {

Auth0UniversalComponents/RecoveryCode/Presentation/RecoveryCodeEnrollmentViewModel.swift

@@ -76,7 +76,7 @@ final class RecoveryCodeEnrollmentViewModel: ObservableObject, ErrorViewModelHan
                     request: confirmRecoveryCodeEnrollmentRequest
                 )
                 apiCallInProgress = false
-                navigationRoute = .filteredAuthListScreen(type: .recoveryCode, authMethods: [])
+                navigationRoute = .filteredAuthListScreen(type: .recoveryCode, authMethods: [], isPostEnrollment: true)
                 delegate?.refreshAuthData()
             } catch {
                 apiCallInProgress = false

Auth0UniversalComponents/SaveAuthenticators/Presentation/SavedAuthenticatorsView.swift

@@ -82,7 +82,11 @@ struct SavedAuthenticatorsView: View {
                     .renderingMode(.template)
                     .foregroundStyle(theme.colors.text.bold)
                     .onTapGesture {
-                        router.pop()
+                        if viewModel.isPostEnrollment {
+                            router.popToSDKRoot()
+                        } else {
+                            router.pop()
+                        }
                     }
             }
         }

Auth0UniversalComponents/SaveAuthenticators/Presentation/SavedAuthenticatorsViewModel.swift

@@ -14,6 +14,7 @@ final class SavedAuthenticatorsViewModel: ObservableObject, ErrorViewModelHandle
     private let dependencies: Auth0UniversalComponentsSDKInitializer
     private let authenticationMethods: [AuthenticationMethod]
     let type: AuthMethodType
+    let isPostEnrollment: Bool
     private let getAuthMethodsUseCase: GetAuthMethodsUseCaseable
     private let deleteAuthMethodUseCase: DeleteAuthMethodUseCaseable
     private weak var delegate: RefreshAuthDataProtocol?
@@ -30,12 +31,14 @@ final class SavedAuthenticatorsViewModel: ObservableObject, ErrorViewModelHandle
          deleteAuthMethodsUseCase: DeleteAuthMethodUseCaseable = DeleteAuthMethodUseCase(),
          type: AuthMethodType,
          authenticationMethods: [AuthenticationMethod],
+         isPostEnrollment: Bool = false,
          delegate: RefreshAuthDataProtocol?) {
         self.dependencies = dependencies
         self.type = type
         self.getAuthMethodsUseCase = getAuthMethodsUseCase
         self.deleteAuthMethodUseCase = deleteAuthMethodsUseCase
         self.authenticationMethods = authenticationMethods
+        self.isPostEnrollment = isPostEnrollment
         self.delegate = delegate
     }
 

Auth0UniversalComponents/TOTPPushEnrollment/Presentation/OTPViewModel.swift

@@ -107,7 +107,7 @@ final class OTPViewModel: ObservableObject, ErrorMessageHandler {
             }
             apiCallInProgress = false
             delegate?.refreshAuthData()
-            navigationRoute = .filteredAuthListScreen(type: type, authMethods: [])
+            navigationRoute = .filteredAuthListScreen(type: type, authMethods: [], isPostEnrollment: true)
         } catch {
             apiCallInProgress = false
             await handle(error: error, scope: "openid create:me:authentication_methods") { [weak self] in

Auth0UniversalComponents/TOTPPushEnrollment/Presentation/TOTPPushQRCodeViewModel.swift

@@ -112,7 +112,7 @@ final class TOTPPushQRCodeViewModel: ObservableObject, ErrorViewModelHandler {
                 )
                 delegate?.refreshAuthData()
                 apiCallInProgress = false
-                navigationRoute = .filteredAuthListScreen(type: type, authMethods: [])
+                navigationRoute = .filteredAuthListScreen(type: type, authMethods: [], isPostEnrollment: true)
             } catch {
                 apiCallInProgress = false
                 await handle(error: error, scope: "openid create:me:authentication_methods") { [weak self] in

Auth0UniversalComponentsTests/RecoveryCode/RecoveryCodeEnrollmentViewModelTests.swift

@@ -139,7 +139,7 @@ struct RecoveryCodeEnrollmentViewModelTests {
             }
 
             await viewModel.confirmEnrollment()
-            #expect(viewModel.navigationRoute == Route.filteredAuthListScreen(type: .recoveryCode, authMethods: []))
+            #expect(viewModel.navigationRoute == Route.filteredAuthListScreen(type: .recoveryCode, authMethods: [], isPostEnrollment: true))
         }
     }
 
@@ -212,7 +212,7 @@ struct RecoveryCodeEnrollmentViewModelTests {
 
             // Verify delegate was called
             #expect(mockDelegate.refreshCalled == true, "Delegate should be called after successful enrollment")
-            #expect(viewModel.navigationRoute == Route.filteredAuthListScreen(type: .recoveryCode, authMethods: []))
+            #expect(viewModel.navigationRoute == Route.filteredAuthListScreen(type: .recoveryCode, authMethods: [], isPostEnrollment: true))
         }
     }