Add new enum case for explicitly passing ASAuthorizationController.RequestOptions (#588)

* Add new enum case for explicitly passing ASAuthorizationController.RequestOptions

* Lint

Author: jhaven-stytch

Sources/StytchCore/PasskeysClient/PasskeysClient+Live.swift

@@ -49,6 +49,8 @@ extension PasskeysClient {
                         controller.performAutoFillAssistedRequests()
                     case let .default(preferLocalCredentials):
                         controller.performRequests(options: preferLocalCredentials ? .preferImmediatelyAvailableCredentials : [])
+                    case let .options(requestOptions):
+                        controller.performRequests(options: requestOptions)
                     }
                     #else
                     controller.performRequests()

Sources/StytchCore/StytchClient/Passkeys/StytchClient+Passkeys.swift

@@ -2,6 +2,8 @@
 import Foundation
 
 #if !os(watchOS)
+import AuthenticationServices
+
 public extension StytchClient {
     /// Passkeys are an extremely simple authentication mechanism which securely syncs key sets across your devices — access-controlled via FaceID/TouchID — ultimately enabling WebAuthN-powered public-key authentication with Stytch's servers.
     ///
@@ -127,7 +129,10 @@ public extension StytchClient.Passkeys {
         public enum RequestBehavior: Sendable {
             #if os(iOS)
             /// Uses the default request behavior with a boolean flag to determine whether credentials are limited to those local on device or whether a passkey on a nearby device can be used
+            @available(*, deprecated, renamed: "options(requestOptions:)", message: "Deprecated in favor of explicitly passing the desired ASAuthorizationController.RequestOptions")
             case `default`(preferLocalCredentials: Bool)
+            /// Explicitly pass the desired `ASAuthorizationController.RequestOptions` to the authenticate request, for instance `[.preferImmediatelyAvailableCredentials]`
+            case options(_: ASAuthorizationController.RequestOptions = [])
             /// When a user selects a textfield with the `.username` textContentType, an existing local passkey will be suggested to the user.
             case autoFill
             #else
@@ -136,8 +141,8 @@ public extension StytchClient.Passkeys {
             #endif
 
             #if os(iOS)
-            /// The RequestBehavior parameter's default value for this platform — `.default(prefersLocalCredentials: false)`
-            public static let defaultPlatformValue: RequestBehavior = .default(preferLocalCredentials: false)
+            /// The RequestBehavior parameter's default value for this platform — `.options([])`
+            public static let defaultPlatformValue: RequestBehavior = .options([])
             #else
             /// The RequestBehavior parameter's default value for this platform — `.default`
             public static let defaultPlatformValue: RequestBehavior = .default

Tests/StytchCoreTests/PasskeysTestCase.swift

@@ -53,11 +53,15 @@ final class PasskeysTestCase: BaseTestCase {
             AuthenticateResponse.mock
         }
         var requestBehaviorIsAutoFill = false
+        var requestBehaviorIsPreferLocallyAvailableCredentials = false
         Current.passkeysClient.assertCredential = { _, _, requestBehavior in
             #if os(iOS)
             if case .autoFill = requestBehavior {
                 requestBehaviorIsAutoFill = true
             }
+            if case .options([.preferImmediatelyAvailableCredentials]) = requestBehavior {
+                requestBehaviorIsPreferLocallyAvailableCredentials = true
+            }
             #endif
             return MockAssertion(
                 rawAuthenticatorData: .init("fake_auth_data".utf8),
@@ -69,13 +73,13 @@ final class PasskeysTestCase: BaseTestCase {
         }
         Current.timer = { _, _, _ in Self.mockTimer }
         #if os(iOS)
-        let parameters: Base.AuthenticateParameters = .init(domain: "something.blah.com", requestBehavior: .autoFill)
+        let parameters: Base.AuthenticateParameters = .init(domain: "something.blah.com", requestBehavior: .options([.preferImmediatelyAvailableCredentials]))
         #else
         let parameters: Base.AuthenticateParameters = .init(domain: "something.blah.com")
         #endif
         _ = try await StytchClient.passkeys.authenticate(parameters: parameters)
         #if os(iOS)
-        XCTAssertTrue(requestBehaviorIsAutoFill)
+        XCTAssertTrue(requestBehaviorIsPreferLocallyAvailableCredentials)
         #else
         XCTAssertFalse(requestBehaviorIsAutoFill)
         #endif