Merge pull request #6 from carloshpdoc/feat/app-group-support

Add App Group support to NoteletStorage and noteletSheet

Author: mykolaharmash

Sources/Notelet/Constants.swift

@@ -5,4 +5,15 @@
 //  Created by Mykola Harmash on 05.05.26.
 //
 
-public let NOTELET_APP_STORAGE_LATEST_SEEN_APP_VERSION_KEY = "Notelet.LatestSeenAppVersion"
+/// Namespaced keys used by `NoteletStorage` when reading from or writing to a
+/// `UserDefaults` instance. Exposed publicly so host apps that share state with
+/// an extension target (widget, intent, share extension) can read or clear the
+/// same keys from the App Group `UserDefaults`.
+public enum NoteletStorageKey {
+    /// The persisted app version string that was last seen by the user when a
+    /// `noteletSheet` was dismissed in `.current` mode.
+    public static let latestSeenAppVersion = "Notelet.LatestSeenAppVersion"
+}
+
+@available(*, deprecated, renamed: "NoteletStorageKey.latestSeenAppVersion", message: "Use NoteletStorageKey.latestSeenAppVersion instead.")
+public let NOTELET_APP_STORAGE_LATEST_SEEN_APP_VERSION_KEY = NoteletStorageKey.latestSeenAppVersion

Sources/Notelet/NoteletSheet.swift

@@ -14,6 +14,7 @@ struct NoteletSheet: ViewModifier {
     let version: NoteletPresentedVersion?
     let onDismiss: () -> Void
     let configuration: NoteletConfiguration
+    let userDefaults: UserDefaults
 
     private var versionToShow: String? {
         switch version {
@@ -43,8 +44,8 @@ struct NoteletSheet: ViewModifier {
     }
 
     private var isCurrentVersionAlreadySeen: Bool {
-        UserDefaults.standard.string(
-            forKey: NOTELET_APP_STORAGE_LATEST_SEEN_APP_VERSION_KEY
+        userDefaults.string(
+            forKey: NoteletStorageKey.latestSeenAppVersion
         ) == Helpers.getCurrentAppVersion()
     }
 
@@ -83,26 +84,35 @@ struct NoteletSheet: ViewModifier {
 
     private func handleDismiss() {
         if isCurrentVersionMode {
-            NoteletStorage.markCurrentVersionAsSeen()
+            NoteletStorage.markCurrentVersionAsSeen(userDefaults: userDefaults)
         }
-        
+
         onDismiss()
     }
 }
 
 extension View {
+    /// Attach a release-notes sheet to the modified view.
+    ///
+    /// - Parameter userDefaults: Storage backing the "seen version" check used
+    ///   in `.current` presentation mode. Defaults to `.standard`. Pass an App
+    ///   Group `UserDefaults` (e.g. `UserDefaults(suiteName: "group.com.example.myapp")`)
+    ///   when the host app needs to share "seen" state with an extension
+    ///   target like a widget, intent, or share extension.
     public func noteletSheet(
         notes: [NoteletVersionNotes],
         version: NoteletPresentedVersion? = nil,
         onDismiss: @escaping () -> Void = { },
-        configuration: NoteletConfiguration = .init()
+        configuration: NoteletConfiguration = .init(),
+        userDefaults: UserDefaults = .standard
     ) -> some View {
         modifier(
             NoteletSheet(
                 notes: notes,
                 version: version,
                 onDismiss: onDismiss,
-                configuration: configuration
+                configuration: configuration,
+                userDefaults: userDefaults
             )
         )
     }

Sources/Notelet/Storage.swift

@@ -1,14 +1,34 @@
 import Foundation
 
 public final class NoteletStorage {
-    public static func markCurrentVersionAsSeen() {
-        UserDefaults.standard.set(
+    /// Mark the current bundle version as seen.
+    ///
+    /// - Parameter userDefaults: Storage to write to. Defaults to `.standard`.
+    ///   Pass `UserDefaults(suiteName: "group.com.example.myapp")` to share the
+    ///   "seen" state with an App Group target (widget, intent, share extension).
+    public static func markCurrentVersionAsSeen(userDefaults: UserDefaults = .standard) {
+        userDefaults.set(
             Helpers.getCurrentAppVersion(),
-            forKey: NOTELET_APP_STORAGE_LATEST_SEEN_APP_VERSION_KEY
+            forKey: NoteletStorageKey.latestSeenAppVersion
         )
     }
 
-    public static func resetSeenVersion() {
-        UserDefaults.standard.removeObject(forKey: NOTELET_APP_STORAGE_LATEST_SEEN_APP_VERSION_KEY)
+    /// Clear the persisted "latest seen version" so the next `.current`
+    /// presentation triggers regardless of bundle version.
+    ///
+    /// - Parameter userDefaults: Storage to clear. Defaults to `.standard`.
+    ///   Pass an App Group `UserDefaults` here if you used one in
+    ///   `markCurrentVersionAsSeen(userDefaults:)`.
+    public static func resetSeenVersion(userDefaults: UserDefaults = .standard) {
+        userDefaults.removeObject(forKey: NoteletStorageKey.latestSeenAppVersion)
+    }
+
+    /// Read the persisted "latest seen version" string, or `nil` if it has
+    /// never been set.
+    ///
+    /// - Parameter userDefaults: Storage to read from. Defaults to `.standard`.
+    /// - Returns: The bundle version string the user last saw, or `nil`.
+    public static func getLatestSeenAppVersion(userDefaults: UserDefaults = .standard) -> String? {
+        userDefaults.string(forKey: NoteletStorageKey.latestSeenAppVersion)
     }
 }