Adding Magic Links (#116)

Added Magic links to the SDK

Co-authored-by: Oleksii Holub <1935960+Tyrrrz@users.noreply.github.com>
Co-authored-by: Jonas Hendrickx <jhendrickx@bitwarden.com>

Author: 3 people

src/Passwordless/Helpers/PasswordlessSerializerContext.cs

@@ -26,4 +26,5 @@ namespace Passwordless.Helpers;
 [JsonSerializable(typeof(JsonElement))]
 [JsonSerializable(typeof(GetEventLogRequest))]
 [JsonSerializable(typeof(GetEventLogResponse))]
+[JsonSerializable(typeof(SendMagicLinkApiRequest))]
 internal partial class PasswordlessSerializerContext : JsonSerializerContext;

src/Passwordless/IPasswordlessClient.cs

@@ -110,4 +110,12 @@ Task DeleteCredentialAsync(
     /// <param name="cancellationToken"></param>
     /// <returns></returns>
     Task<GetEventLogResponse> GetEventLogAsync(GetEventLogRequest request, CancellationToken cancellationToken = default);
+
+    /// <summary>
+    /// Sends an email containing a magic link template allowing users to login.
+    /// </summary>
+    /// <param name="request"><see cref="SendMagicLinkRequest"/></param>
+    /// <param name="cancellationToken"></param>
+    /// <returns></returns>
+    Task SendMagicLinkAsync(SendMagicLinkRequest request, CancellationToken cancellationToken = default);
 }

src/Passwordless/Models/GetEventLogRequest.cs

@@ -1,5 +1,3 @@
-using System.ComponentModel.DataAnnotations;
-
 namespace Passwordless.Models;
 
 /// <summary>

src/Passwordless/Models/SendMagicLinkRequest.cs

@@ -0,0 +1,23 @@
+using System;
+using Passwordless.Helpers.Extensions;
+
+namespace Passwordless.Models;
+
+/// <summary>
+/// Request for sending an email with a link that contains a 1-time-use token to be used for validating signin.
+/// </summary>
+/// <param name="EmailAddress">Valid email address that will be the recipient of the magic link email</param>
+/// <param name="UrlTemplate">Url template that needs to contain the token template, <token>. The token template will be replaced with a valid signin token to be sent to the verify sign in token endpoint (https://v4.passwsordless.dev/signin/verify).</param>
+/// <param name="UserId">Identifier for the user the email is intended for.</param>
+/// <param name="TimeToLive">Length of time the magic link will be active. Default value will be 15 minutes.</param>
+public record SendMagicLinkRequest(string EmailAddress, string UrlTemplate, string UserId, TimeSpan? TimeToLive)
+{
+    internal SendMagicLinkApiRequest ToRequest() =>
+        new(
+            this.EmailAddress,
+            this.UrlTemplate,
+            this.UserId,
+            this.TimeToLive?.TotalSeconds.Pipe(Convert.ToInt32));
+};
+
+internal record SendMagicLinkApiRequest(string EmailAddress, string UrlTemplate, string UserId, int? TimeToLive);

src/Passwordless/PasswordlessClient.cs

@@ -115,6 +115,18 @@ public async Task<GetEventLogResponse> GetEventLogAsync(GetEventLogRequest reque
             PasswordlessSerializerContext.Default.GetEventLogResponse,
             cancellationToken))!;
 
+    /// <inheritdoc />
+    public async Task SendMagicLinkAsync(SendMagicLinkRequest request, CancellationToken cancellationToken = default)
+    {
+        using var response = await _http.PostAsJsonAsync(
+            "magic-links/send",
+            request.ToRequest(),
+            PasswordlessSerializerContext.Default.SendMagicLinkApiRequest,
+            cancellationToken);
+
+        response.EnsureSuccessStatusCode();
+    }
+
     /// <inheritdoc />
     public async Task<UsersCount> GetUsersCountAsync(CancellationToken cancellationToken = default) =>
         (await _http.GetFromJsonAsync(

tests/Passwordless.Tests.Infra/TestApi.cs

@@ -96,7 +96,8 @@ public async Task<PasswordlessApplication> CreateAppAsync()
             {
               "adminEmail": "test@passwordless.dev",
               "eventLoggingIsEnabled": true,
-              "eventLoggingRetentionPeriod": 7
+              "eventLoggingRetentionPeriod": 7,
+              "magicLinkEmailMonthlyQuota" : 100
             }
             """,
             Encoding.UTF8,

tests/Passwordless.Tests/MagicLinksTests.cs

@@ -0,0 +1,41 @@
+using System;
+using System.Threading;
+using System.Threading.Tasks;
+using FluentAssertions;
+using Passwordless.Models;
+using Passwordless.Tests.Infra;
+using Xunit;
+using Xunit.Abstractions;
+
+namespace Passwordless.Tests;
+
+public class MagicLinksTests(TestApiFixture api, ITestOutputHelper testOutput) : ApiTestBase(api, testOutput)
+{
+    [Fact]
+    public async Task I_can_send_a_magic_link_with_a_specified_time_to_live()
+    {
+        // Arrange
+        var passwordless = await Api.CreateClientAsync();
+        var request = new SendMagicLinkRequest("test@passwordless.dev", "https://www.example.com?token=$TOKEN", "user", new TimeSpan(0, 15, 0));
+
+        // Act
+        var action = async () => await passwordless.SendMagicLinkAsync(request, CancellationToken.None);
+
+        // Assert
+        await action.Should().NotThrowAsync();
+    }
+
+    [Fact]
+    public async Task I_can_send_a_magic_link_without_a_time_to_live()
+    {
+        // Arrange
+        var passwordless = await Api.CreateClientAsync();
+        var request = new SendMagicLinkRequest("test@passwordless.dev", "https://www.example.com?token=$TOKEN", "user", null);
+
+        // Act
+        var action = async () => await passwordless.SendMagicLinkAsync(request, CancellationToken.None);
+
+        // Assert
+        await action.Should().NotThrowAsync();
+    }
+}