Deprecate ResetContext & RefreshContext

README.md

@@ -807,7 +807,7 @@ struct FetchMoviesPhaseAtom: ValueAtom, Refreshable, Hashable {
         context.watch(FetchMoviesTaskAtom().phase)
     }
 
-    func refresh(context: RefreshContext) async -> AsyncPhase<[Movies], Error> {
+    func refresh(context: CurrentContext) async -> AsyncPhase<[Movies], Error> {
         await context.refresh(FetchMoviesTaskAtom().phase)
     }
 
@@ -838,7 +838,7 @@ struct RandomIntAtom: ValueAtom, Resettable, Hashable {
         return .random(in: 0..<100, using: &generator)
     }
 
-    func reset(context: ResetContext) {
+    func reset(context: CurrentContext) {
         context.reset(RandomNumberGeneratorAtom())
     }
 }

Sources/Atoms/Atom/Atom.swift

@@ -19,6 +19,10 @@ public protocol Atom {
     /// with other atoms.
     typealias Context = AtomTransactionContext<Coordinator>
 
+    /// A type of the context structure to read, set, and otherwise interact
+    /// with other atoms.
+    typealias CurrentContext = AtomCurrentContext<Loader.Coordinator>
+
     /// A type of the context structure to read, set, and otherwise interact
     /// with other atoms.
     typealias UpdatedContext = AtomCurrentContext<Loader.Coordinator>

Sources/Atoms/Attribute/Refreshable.swift

@@ -9,7 +9,7 @@
 ///         context.watch(FetchUserAtom().phase)
 ///     }
 ///
-///     func refresh(context: RefreshContext) async -> AsyncPhase<User?, Never> {
+///     func refresh(context: CurrentContext) async -> AsyncPhase<User?, Never> {
 ///         await context.refresh(FetchUserAtom().phase)
 ///     }
 /// }
@@ -22,10 +22,6 @@
 /// ```
 ///
 public protocol Refreshable where Self: Atom {
-    /// A type of the context structure to read, set, and otherwise interact
-    /// with other atoms.
-    typealias RefreshContext = AtomCurrentContext<Loader.Coordinator>
-
     /// Refreshes and then return a result value.
     ///
     /// The value returned by this method will be cached as a new value when
@@ -36,5 +32,5 @@ public protocol Refreshable where Self: Atom {
     ///
     /// - Returns: A refreshed value.
     @MainActor
-    func refresh(context: RefreshContext) async -> Loader.Value
+    func refresh(context: CurrentContext) async -> Loader.Value
 }

Sources/Atoms/Attribute/Resettable.swift

@@ -9,7 +9,7 @@
 ///         context.watch(FetchUserAtom().phase)
 ///     }
 ///
-///     func reset(context: ResetContext) {
+///     func reset(context: CurrentContext) {
 ///         context.reset(FetchUserAtom())
 ///     }
 /// }
@@ -22,16 +22,12 @@
 /// ```
 ///
 public protocol Resettable where Self: Atom {
-    /// A type of the context structure to read, set, and otherwise interact
-    /// with other atoms.
-    typealias ResetContext = AtomCurrentContext<Loader.Coordinator>
-
     /// Arbitrary reset method to be executed on atom reset.
     ///
     /// This is arbitrary custom reset method that replaces regular atom reset functionality.
     ///
     /// - Parameter context: A context structure to read, set, and otherwise interact
     ///                      with other atoms.
     @MainActor
-    func reset(context: ResetContext)
+    func reset(context: CurrentContext)
 }

Sources/Atoms/Deprecated.swift

@@ -9,6 +9,16 @@ public extension Atom {
     }
 }
 
+public extension Resettable {
+    @available(*, deprecated, renamed: "CurrentContext")
+    typealias ResetContext = AtomCurrentContext<Loader.Coordinator>
+}
+
+public extension Refreshable {
+    @available(*, deprecated, renamed: "CurrentContext")
+    typealias RefreshContext = AtomCurrentContext<Loader.Coordinator>
+}
+
 public extension AtomScope {
     @available(*, deprecated, renamed: "init(inheriting:content:)")
     init(

Tests/AtomsTests/Utilities/TestAtom.swift

@@ -88,14 +88,14 @@ struct TestCustomRefreshableAtom<Publisher: Combine.Publisher>: PublisherAtom, R
         makePublisher()
     }
 
-    func refresh(context: RefreshContext) async -> AsyncPhase<Publisher.Output, Publisher.Failure> {
+    func refresh(context: CurrentContext) async -> AsyncPhase<Publisher.Output, Publisher.Failure> {
         refresh()
     }
 }
 
 struct TestCustomResettableAtom<T>: StateAtom, Resettable {
     var defaultValue: (Context) -> T
-    var reset: (ResetContext) -> Void
+    var reset: (CurrentContext) -> Void
 
     var key: UniqueKey {
         UniqueKey()
@@ -105,7 +105,7 @@ struct TestCustomResettableAtom<T>: StateAtom, Resettable {
         defaultValue(context)
     }
 
-    func reset(context: ResetContext) {
+    func reset(context: CurrentContext) {
         reset(context)
     }
 }