Add LocalNotifications module

Sources/Spezi/Notifications/Spezi+RequestNotificationAuthorization.swift

@@ -33,6 +33,10 @@ extension Spezi {
     ///     }
     /// }
     /// ```
+    ///
+    /// ## Topics
+    /// ### Action
+    /// - ``RequestNotificationAuthorizationAction``
     public var requestNotificationAuthorization: RequestNotificationAuthorizationAction {
         RequestNotificationAuthorizationAction()
     }

Sources/Spezi/Notifications/UserNotifications.swift

@@ -0,0 +1,82 @@
+//
+// This source file is part of the Stanford Spezi open-source project
+//
+// SPDX-FileCopyrightText: 2024 Stanford University and the project authors (see CONTRIBUTORS.md)
+//
+// SPDX-License-Identifier: MIT
+//
+
+@preconcurrency import UserNotifications
+
+
+/// Interact with local notifications.
+///
+/// This module provides some easy to use API to schedule and manage local notifications.
+///
+/// ## Topics
+///
+/// ### Configuration
+/// - ``init()``
+///
+/// ### Add a Notification Request
+/// - ``add(isolation:request:)``
+///
+/// ### Notification Limits
+/// - ``pendingNotificationsLimit``
+/// - ``remainingNotificationLimit(isolation:)``
+///
+/// ### Categories
+/// - ``add(isolation:categories:)``
+public final class LocalNotifications: Module, DefaultInitializable, EnvironmentAccessible {
+    /// The total limit of simultaneously scheduled notifications.
+    ///
+    /// The limit is `64`.
+    public static let pendingNotificationsLimit = 64
+
+    /// Configure the local notifications module.
+    public init() {}
+
+    /// Schedule a new notification request.
+    /// - Parameters:
+    ///   - isolation: Inherits the current isolation.
+    ///   - request: The notification request.
+    public func add( // swiftlint:disable:this function_default_parameter_at_end
+        isolation: isolated (any Actor)? = #isolation,
+        request: sending UNNotificationRequest
+    ) async throws {
+        try await UNUserNotificationCenter.current().add(request)
+    }
+
+    /// Retrieve the amount of notifications that can be scheduled for the app.
+    ///
+    /// An application has a total limit of ``pendingNotificationsLimit`` that can be scheduled (pending). This method retrieve the reaming notifications that can be scheduled.
+    ///
+    /// - Note: Already delivered notifications do not count towards this limit.
+    /// - Parameter isolation: Inherits the current isolation.
+    /// - Returns: Returns the remaining amount of notifications that can be scheduled for the application.
+    public func remainingNotificationLimit(isolation: isolated (any Actor)? = #isolation) async -> Int {
+        let pendingRequests = await UNUserNotificationCenter.current().pendingNotificationRequests()
+        return max(0, Self.pendingNotificationsLimit - pendingRequests.count)
+    }
+
+    /// Add additional notification categories.
+    ///
+    /// This method adds additional notification categories. Call this method within your configure method of your Module to ensure that categories are configured
+    /// as early as possible.
+    ///
+    /// To receive the action that are performed for your category, implement the ``NotificationHandler/handleNotificationAction(_:)`` method of the
+    /// ``NotificationHandler`` protocol.
+    ///
+    /// - Note: Aim to only call this method once at startup.
+    ///
+    /// - Parameters:
+    ///   - isolation: Inherits the current isolation.
+    ///   - categories: The notification categories you support.
+    public func add( // swiftlint:disable:this function_default_parameter_at_end
+        isolation: isolated (any Actor)? = #isolation,
+        categories: Set<UNNotificationCategory>
+    ) async {
+        let previousCategories = await UNUserNotificationCenter.current().notificationCategories()
+        UNUserNotificationCenter.current().setNotificationCategories(categories.union(previousCategories))
+    }
+}

Sources/Spezi/Spezi.docc/Module/Notifications.md

@@ -60,6 +60,7 @@ implement the ``NotificationHandler/receiveRemoteNotification(_:)`` method.
 ## Topics
 
 ### Notifications
+- ``LocalNotifications``
 - ``Spezi/notificationSettings``
 - ``Spezi/requestNotificationAuthorization``