feat(auth): add resend method (#190)

Author: grdsdev

Sources/Auth/AuthClient.swift

@@ -689,6 +689,70 @@ public actor AuthClient {
     return response
   }
 
+  /// Resends an existing signup confirmation email or email change email.
+  ///
+  /// To obfuscate whether such the email already exists in the system this method succeeds in both
+  /// cases.
+  public func resend(
+    email: String,
+    type: ResendEmailType,
+    emailRedirectTo: URL? = nil,
+    captchaToken: String? = nil
+  ) async throws {
+    if type != .emailChange {
+      await sessionManager.remove()
+    }
+
+    _ = try await api.execute(
+      Request(
+        path: "/resend",
+        method: .post,
+        query: [
+          emailRedirectTo.map { URLQueryItem(name: "redirect_to", value: $0.absoluteString) },
+        ].compactMap { $0 },
+        body: configuration.encoder.encode(
+          ResendEmailParams(
+            type: type,
+            email: email,
+            gotrueMetaSecurity: captchaToken.map(AuthMetaSecurity.init(captchaToken:))
+          )
+        )
+      )
+    )
+  }
+
+  /// Resends an existing SMS OTP or phone change OTP.
+  /// - Returns: An object containing the unique ID of the message as reported by the SMS sending
+  /// provider. Useful for tracking deliverability problems.
+  ///
+  /// To obfuscate whether such the phone number already exists in the system this method succeeds
+  /// in both cases.
+  @discardableResult
+  public func resend(
+    phone: String,
+    type: ResendMobileType,
+    captchaToken: String? = nil
+  ) async throws -> ResendMobileResponse {
+    if type != .phoneChange {
+      await sessionManager.remove()
+    }
+
+    return try await api.execute(
+      Request(
+        path: "/resend",
+        method: .post,
+        body: configuration.encoder.encode(
+          ResendMobileParams(
+            type: type,
+            phone: phone,
+            gotrueMetaSecurity: captchaToken.map(AuthMetaSecurity.init(captchaToken:))
+          )
+        )
+      )
+    )
+    .decoded(decoder: configuration.decoder)
+  }
+
   /// Gets the current user details if there is an existing session.
   /// - Parameter jwt: Takes in an optional access token jwt. If no jwt is provided, user() will
   /// attempt to get the jwt from the current session.

Sources/Auth/Types.swift

@@ -586,3 +586,35 @@ public enum SignOutScope: String, Sendable {
   /// session.
   case others
 }
+
+public enum ResendEmailType: String, Hashable, Sendable, Encodable {
+  case signup
+  case emailChange = "email_change"
+}
+
+struct ResendEmailParams: Encodable {
+  let type: ResendEmailType
+  let email: String
+  let gotrueMetaSecurity: AuthMetaSecurity?
+}
+
+public enum ResendMobileType: String, Hashable, Sendable, Encodable {
+  case sms
+  case phoneChange = "phone_change"
+}
+
+struct ResendMobileParams: Encodable {
+  let type: ResendMobileType
+  let phone: String
+  let gotrueMetaSecurity: AuthMetaSecurity?
+}
+
+public struct ResendMobileResponse: Decodable, Hashable, Sendable {
+  /// Unique ID of the message as reported by the SMS sending provider. Useful for tracking
+  /// deliverability problems.
+  public let messageId: String?
+
+  public init(messageId: String?) {
+    self.messageId = messageId
+  }
+}

Tests/AuthTests/RequestsTests.swift

@@ -344,6 +344,31 @@ final class RequestsTests: XCTestCase {
     }
   }
 
+  func testResendEmail() async {
+    let sut = makeSUT()
+
+    await assert {
+      try await sut.resend(
+        email: "[email protected]",
+        type: .emailChange,
+        emailRedirectTo: URL(string: "https://supabase.com"),
+        captchaToken: "captcha-token"
+      )
+    }
+  }
+
+  func testResendPhone() async {
+    let sut = makeSUT()
+
+    await assert {
+      try await sut.resend(
+        phone: "+1 202-918-2132",
+        type: .phoneChange,
+        captchaToken: "captcha-token"
+      )
+    }
+  }
+
   private func assert(_ block: () async throws -> Void) async {
     do {
       try await block()

Tests/AuthTests/__Snapshots__/RequestsTests/testResendEmail.1.txt

@@ -0,0 +1,7 @@
+curl \
+	--request POST \
+	--header "Content-Type: application/json" \
+	--header "X-Client-Info: gotrue-swift/x.y.z" \
+	--header "apikey: dummy.api.key" \
+	--data "{\"email\":\"[email protected]\",\"gotrue_meta_security\":{\"captcha_token\":\"captcha-token\"},\"type\":\"email_change\"}" \
+	"http://localhost:54321/auth/v1/resend?redirect_to=https://supabase.com"

Tests/AuthTests/__Snapshots__/RequestsTests/testResendPhone.1.txt

@@ -0,0 +1,7 @@
+curl \
+	--request POST \
+	--header "Content-Type: application/json" \
+	--header "X-Client-Info: gotrue-swift/x.y.z" \
+	--header "apikey: dummy.api.key" \
+	--data "{\"gotrue_meta_security\":{\"captcha_token\":\"captcha-token\"},\"phone\":\"+1 202-918-2132\",\"type\":\"phone_change\"}" \
+	"http://localhost:54321/auth/v1/resend"