Rename ConfigSnapshotProtocol -> ConfigSnapshot (#67)

### Motivation

Fixes #65.

### Modifications

Renamed `ConfigSnapshotProtocol` to `ConfigSnapshot` and leave around a
deprecated typealias for easier migration to the next 0.x version (will
be removed for 1.0).

### Result

Better name.

### Test Plan

Adapted tests.

Author: czechboy0

Sources/Configuration/ConfigProvider.swift

@@ -115,7 +115,7 @@ public protocol ConfigProvider: Sendable {
     /// significant performance impact.
     ///
     /// - Returns: An immutable snapshot that represents the current provider state.
-    func snapshot() -> any ConfigSnapshotProtocol
+    func snapshot() -> any ConfigSnapshot
 
     /// Monitors the provider's state for changes by emitting snapshots.
     ///
@@ -129,7 +129,7 @@ public protocol ConfigProvider: Sendable {
     /// - Throws: Provider-specific errors or errors thrown by the handler closure.
     /// - Returns: The value returned by the closure.
     func watchSnapshot<Return>(
-        updatesHandler: (ConfigUpdatesAsyncSequence<any ConfigSnapshotProtocol, Never>) async throws -> Return
+        updatesHandler: (ConfigUpdatesAsyncSequence<any ConfigSnapshot, Never>) async throws -> Return
     ) async throws -> Return
 }
 
@@ -139,7 +139,7 @@ public protocol ConfigProvider: Sendable {
 /// capturing the provider's state at a specific moment. This prevents the underlying
 /// data from changing between individual key lookups.
 @available(Configuration 1.0, *)
-public protocol ConfigSnapshotProtocol: Sendable {
+public protocol ConfigSnapshot: Sendable {
 
     /// The human-readable name of the configuration provider that created this snapshot.
     ///

Sources/Configuration/ConfigProviderHelpers.swift

@@ -76,7 +76,7 @@ extension ConfigProvider {
     ///
     /// ```swift
     /// func watchSnapshot(
-    ///     updatesHandler: (ConfigUpdatesAsyncSequence<any ConfigSnapshotProtocol, Never>) async throws -> Void
+    ///     updatesHandler: (ConfigUpdatesAsyncSequence<any ConfigSnapshot, Never>) async throws -> Void
     /// ) async throws {
     ///     try await watchSnapshotFromSnapshot(updatesHandler)
     /// }
@@ -85,12 +85,10 @@ extension ConfigProvider {
     /// - Parameter updatesHandler: The closure that processes the async sequence of snapshot updates.
     /// - Returns: The value returned by the handler closure.
     /// - Throws: Provider-specific errors or errors thrown by the handler.
-    nonisolated(nonsending)
-        public func watchSnapshotFromSnapshot<Return>(
-            updatesHandler: (ConfigUpdatesAsyncSequence<any ConfigSnapshotProtocol, Never>) async throws -> Return
-        ) async throws -> Return
-    {
-        let (stream, continuation) = AsyncStream<any ConfigSnapshotProtocol>
+    nonisolated(nonsending) public func watchSnapshotFromSnapshot<Return>(
+        updatesHandler: (ConfigUpdatesAsyncSequence<any ConfigSnapshot, Never>) async throws -> Return
+    ) async throws -> Return {
+        let (stream, continuation) = AsyncStream<any ConfigSnapshot>
             .makeStream(bufferingPolicy: .bufferingNewest(1))
         let initialValue = snapshot()
         continuation.yield(initialValue)

Sources/Configuration/Deprecations.swift

@@ -43,3 +43,8 @@ public typealias ReloadingYAMLProvider = ReloadingFileProvider<YAMLSnapshot>
 #endif
 
 #endif
+
+/// An immutable snapshot of a configuration provider's state.
+@available(Configuration 1.0, *)
+@available(*, deprecated, renamed: "ConfigSnapshot")
+public typealias ConfigSnapshotProtocol = ConfigSnapshot

Sources/Configuration/Documentation.docc/Documentation.md

@@ -426,7 +426,7 @@ Any package can implement a ``ConfigProvider``, making the ecosystem extensible
 - ``KeyMappingProvider``
 
 ### Creating a custom provider
-- ``ConfigSnapshotProtocol``
+- ``ConfigSnapshot``
 - ``FileParsingOptions``
 - ``ConfigProvider``
 - ``ConfigContent``

Sources/Configuration/Documentation.docc/Reference/ConfigSnapshot.md

@@ -0,0 +1,8 @@
+# ``Configuration/ConfigSnapshot``
+
+## Topics
+
+### Required methods
+
+- ``ConfigSnapshot/providerName``
+- ``ConfigSnapshot/value(forKey:type:)``

Sources/Configuration/Documentation.docc/Reference/ConfigSnapshotProtocol.md

@@ -9,4 +9,4 @@
 
 ### Protocol requirements
 
-- ``ConfigSnapshotProtocol``
+- ``ConfigSnapshot``

Sources/Configuration/Documentation.docc/Reference/FileConfigSnapshot.md

@@ -10,4 +10,4 @@
 ### Snapshot configuration
 
 - ``FileConfigSnapshot``
-- ``ConfigSnapshotProtocol``
+- ``ConfigSnapshot``

Sources/Configuration/Documentation.docc/Reference/JSONSnapshot.md

@@ -10,4 +10,4 @@
 ### Snapshot configuration
 
 - ``FileConfigSnapshot``
-- ``ConfigSnapshotProtocol``
+- ``ConfigSnapshot``

Sources/Configuration/Documentation.docc/Reference/YAMLSnapshot.md

@@ -89,7 +89,7 @@ extension MultiProvider: CustomStringConvertible {
 struct MultiSnapshot {
 
     /// The individual snapshots from each nested provider, maintained in precedence order.
-    var snapshots: [any ConfigSnapshotProtocol]
+    var snapshots: [any ConfigSnapshot]
 
     /// Resolves a configuration value by querying nested provider snapshots in precedence order.
     /// - Parameters:
@@ -201,7 +201,7 @@ extension MultiProvider {
         ) async throws -> Return
     {
         let providers = storage.providers
-        typealias UpdatesSequence = any (AsyncSequence<any ConfigSnapshotProtocol, Never> & Sendable)
+        typealias UpdatesSequence = any (AsyncSequence<any ConfigSnapshot, Never> & Sendable)
         var updateSequences: [UpdatesSequence] = []
         updateSequences.reserveCapacity(providers.count)
         return try await withProvidersWatchingSnapshot(