Rename ConfigSnapshotProtocol -> ConfigSnapshot

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

@@ -74,7 +74,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)
     /// }
@@ -84,9 +84,9 @@ extension ConfigProvider {
     /// - Returns: The value returned by the handler closure.
     /// - Throws: Provider-specific errors or errors thrown by the handler.
     public func watchSnapshotFromSnapshot<Return>(
-        updatesHandler: (ConfigUpdatesAsyncSequence<any ConfigSnapshotProtocol, Never>) async throws -> Return
+        updatesHandler: (ConfigUpdatesAsyncSequence<any ConfigSnapshot, Never>) async throws -> Return
     ) async throws -> Return {
-        let (stream, continuation) = AsyncStream<any ConfigSnapshotProtocol>
+        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/FileConfigSnapshot.md

@@ -9,4 +9,4 @@
 
 ### Protocol requirements
 
-- ``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

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

Sources/Configuration/MultiProvider.swift

@@ -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,10 +201,10 @@ extension MultiProvider {
         let providers = storage.providers
         let sources:
             [@Sendable (
-                (ConfigUpdatesAsyncSequence<any ConfigSnapshotProtocol, Never>) async throws -> Void
+                (ConfigUpdatesAsyncSequence<any ConfigSnapshot, Never>) async throws -> Void
             ) async throws -> Void] = providers.map { $0.watchSnapshot }
         return try await combineLatestOneOrMore(
-            elementType: (any ConfigSnapshotProtocol).self,
+            elementType: (any ConfigSnapshot).self,
             sources: sources,
             updatesHandler: { updateArrays in
                 try await body(

Sources/Configuration/Providers/CLI/CLISnapshot.swift

@@ -155,7 +155,7 @@ internal struct CLISnapshot {
 }
 
 @available(Configuration 1.0, *)
-extension CLISnapshot: ConfigSnapshotProtocol {
+extension CLISnapshot: ConfigSnapshot {
     // swift-format-ignore: AllPublicDeclarationsHaveDocumentation
     func value(forKey key: AbsoluteConfigKey, type: ConfigType) throws -> LookupResult {
         let encodedKey = keyEncoder.encode(key)

Sources/Configuration/Providers/CLI/CommandLineArgumentsProvider.swift

@@ -159,13 +159,13 @@ extension CommandLineArgumentsProvider: ConfigProvider {
     }
 
     // swift-format-ignore: AllPublicDeclarationsHaveDocumentation
-    public func snapshot() -> any ConfigSnapshotProtocol {
+    public func snapshot() -> any ConfigSnapshot {
         _snapshot
     }
 
     // swift-format-ignore: AllPublicDeclarationsHaveDocumentation
     public func watchSnapshot<Return>(
-        updatesHandler: (ConfigUpdatesAsyncSequence<any ConfigSnapshotProtocol, Never>) async throws -> Return
+        updatesHandler: (ConfigUpdatesAsyncSequence<any ConfigSnapshot, Never>) async throws -> Return
     ) async throws -> Return {
         try await watchSnapshotFromSnapshot(updatesHandler: updatesHandler)
     }

Sources/Configuration/Providers/EnvironmentVariables/EnvironmentVariablesProvider.swift

@@ -442,7 +442,7 @@ extension EnvironmentVariablesProvider.Snapshot {
 }
 
 @available(Configuration 1.0, *)
-extension EnvironmentVariablesProvider.Snapshot: ConfigSnapshotProtocol {
+extension EnvironmentVariablesProvider.Snapshot: ConfigSnapshot {
     func value(
         forKey key: AbsoluteConfigKey,
         type: ConfigType
@@ -495,13 +495,13 @@ extension EnvironmentVariablesProvider: ConfigProvider {
     }
 
     // swift-format-ignore: AllPublicDeclarationsHaveDocumentation
-    public func snapshot() -> any ConfigSnapshotProtocol {
+    public func snapshot() -> any ConfigSnapshot {
         _snapshot
     }
 
     // swift-format-ignore: AllPublicDeclarationsHaveDocumentation
     public func watchSnapshot<Return>(
-        updatesHandler: (ConfigUpdatesAsyncSequence<any ConfigSnapshotProtocol, Never>) async throws -> Return
+        updatesHandler: (ConfigUpdatesAsyncSequence<any ConfigSnapshot, Never>) async throws -> Return
     ) async throws -> Return {
         try await watchSnapshotFromSnapshot(updatesHandler: updatesHandler)
     }

Sources/Configuration/Providers/Files/DirectoryFilesProvider.swift

@@ -381,7 +381,7 @@ extension DirectoryFilesProvider.Snapshot {
 }
 
 @available(Configuration 1.0, *)
-extension DirectoryFilesProvider.Snapshot: ConfigSnapshotProtocol {
+extension DirectoryFilesProvider.Snapshot: ConfigSnapshot {
     func value(
         forKey key: AbsoluteConfigKey,
         type: ConfigType
@@ -433,13 +433,13 @@ extension DirectoryFilesProvider: ConfigProvider {
     }
 
     // swift-format-ignore: AllPublicDeclarationsHaveDocumentation
-    public func snapshot() -> any ConfigSnapshotProtocol {
+    public func snapshot() -> any ConfigSnapshot {
         _snapshot
     }
 
     // swift-format-ignore: AllPublicDeclarationsHaveDocumentation
     public func watchSnapshot<Return>(
-        updatesHandler: (ConfigUpdatesAsyncSequence<any ConfigSnapshotProtocol, Never>) async throws -> Return
+        updatesHandler: (ConfigUpdatesAsyncSequence<any ConfigSnapshot, Never>) async throws -> Return
     ) async throws -> Return {
         try await watchSnapshotFromSnapshot(updatesHandler: updatesHandler)
     }

Sources/Configuration/Providers/Files/FileProvider.swift

@@ -178,7 +178,7 @@ extension FileProvider: ConfigProvider {
 
     // swift-format-ignore: AllPublicDeclarationsHaveDocumentation
     public func watchSnapshot<Return>(
-        updatesHandler: (ConfigUpdatesAsyncSequence<any ConfigSnapshotProtocol, Never>) async throws -> Return
+        updatesHandler: (ConfigUpdatesAsyncSequence<any ConfigSnapshot, Never>) async throws -> Return
     ) async throws -> Return {
         try await watchSnapshotFromSnapshot(updatesHandler: updatesHandler)
     }
@@ -195,7 +195,7 @@ extension FileProvider: ConfigProvider {
     }
 
     // swift-format-ignore: AllPublicDeclarationsHaveDocumentation
-    public func snapshot() -> any ConfigSnapshotProtocol {
+    public func snapshot() -> any ConfigSnapshot {
         _snapshot
     }
 }

Sources/Configuration/Providers/Files/FileProviderSnapshot.swift

@@ -47,7 +47,7 @@ public protocol FileParsingOptions: Sendable {
 
 /// A protocol for configuration snapshots created from file data.
 ///
-/// This protocol extends ``ConfigSnapshotProtocol`` to provide file-specific functionality
+/// This protocol extends ``ConfigSnapshot`` to provide file-specific functionality
 /// for creating configuration snapshots from raw file data. Types conforming to this protocol
 /// can parse various file formats (such as JSON and YAML) and convert them into configuration values.
 ///
@@ -75,7 +75,7 @@ public protocol FileParsingOptions: Sendable {
 /// The snapshot is responsible for parsing the file data and converting it into a
 /// representation of configuration values that can be queried by the configuration system.
 @available(Configuration 1.0, *)
-public protocol FileConfigSnapshot: ConfigSnapshotProtocol, CustomStringConvertible,
+public protocol FileConfigSnapshot: ConfigSnapshot, CustomStringConvertible,
     CustomDebugStringConvertible
 {
     /// The parsing options type used for parsing this snapshot.

Sources/Configuration/Providers/Files/JSONSnapshot.swift

@@ -313,7 +313,7 @@ extension JSONSnapshot: FileConfigSnapshot {
 }
 
 @available(Configuration 1.0, *)
-extension JSONSnapshot: ConfigSnapshotProtocol {
+extension JSONSnapshot: ConfigSnapshot {
     // swift-format-ignore: AllPublicDeclarationsHaveDocumentation
     public func value(forKey key: AbsoluteConfigKey, type: ConfigType) throws -> LookupResult {
         let encodedKey = Self.keyEncoder.encode(key)

Sources/Configuration/Providers/Files/ReloadingFileProvider.swift

@@ -489,13 +489,13 @@ extension ReloadingFileProvider: ConfigProvider {
     }
 
     // swift-format-ignore: AllPublicDeclarationsHaveDocumentation
-    public func snapshot() -> any ConfigSnapshotProtocol {
+    public func snapshot() -> any ConfigSnapshot {
         storage.withLock { $0.snapshot }
     }
 
     // swift-format-ignore: AllPublicDeclarationsHaveDocumentation
     public func watchSnapshot<Return>(
-        updatesHandler: (ConfigUpdatesAsyncSequence<any ConfigSnapshotProtocol, Never>) async throws -> Return
+        updatesHandler: (ConfigUpdatesAsyncSequence<any ConfigSnapshot, Never>) async throws -> Return
     ) async throws -> Return {
         let (stream, continuation) = AsyncStream<Snapshot>.makeStream(bufferingPolicy: .bufferingNewest(1))
         let id = UUID()

Sources/Configuration/Providers/Files/YAMLSnapshot.swift

@@ -264,7 +264,7 @@ extension YAMLSnapshot: FileConfigSnapshot {
 }
 
 @available(Configuration 1.0, *)
-extension YAMLSnapshot: ConfigSnapshotProtocol {
+extension YAMLSnapshot: ConfigSnapshot {
     // swift-format-ignore: AllPublicDeclarationsHaveDocumentation
     public func value(forKey key: AbsoluteConfigKey, type: ConfigType) throws -> LookupResult {
         let encodedKey = Self.keyEncoder.encode(key)

Sources/Configuration/Providers/InMemory/InMemoryProvider.swift

@@ -174,7 +174,7 @@ extension InMemoryProvider: CustomDebugStringConvertible {
 }
 
 @available(Configuration 1.0, *)
-extension InMemoryProvider.Snapshot: ConfigSnapshotProtocol {
+extension InMemoryProvider.Snapshot: ConfigSnapshot {
     func value(
         forKey key: AbsoluteConfigKey,
         type: ConfigType
@@ -226,13 +226,13 @@ extension InMemoryProvider: ConfigProvider {
     }
 
     // swift-format-ignore: AllPublicDeclarationsHaveDocumentation
-    public func snapshot() -> any ConfigSnapshotProtocol {
+    public func snapshot() -> any ConfigSnapshot {
         _snapshot
     }
 
     // swift-format-ignore: AllPublicDeclarationsHaveDocumentation
     public func watchSnapshot<Return>(
-        updatesHandler: (ConfigUpdatesAsyncSequence<any ConfigSnapshotProtocol, Never>) async throws -> Return
+        updatesHandler: (ConfigUpdatesAsyncSequence<any ConfigSnapshot, Never>) async throws -> Return
     ) async throws -> Return {
         try await watchSnapshotFromSnapshot(updatesHandler: updatesHandler)
     }

Sources/Configuration/Providers/InMemory/MutableInMemoryProvider.swift

@@ -373,7 +373,7 @@ extension MutableInMemoryProvider {
 }
 
 @available(Configuration 1.0, *)
-extension MutableInMemoryProvider.Snapshot: ConfigSnapshotProtocol {
+extension MutableInMemoryProvider.Snapshot: ConfigSnapshot {
     func value(forKey key: AbsoluteConfigKey, type: ConfigType) throws -> LookupResult {
         try MutableInMemoryProvider.parseValue(
             values[key],
@@ -450,13 +450,13 @@ extension MutableInMemoryProvider: ConfigProvider {
     }
 
     // swift-format-ignore: AllPublicDeclarationsHaveDocumentation
-    public func snapshot() -> any ConfigSnapshotProtocol {
+    public func snapshot() -> any ConfigSnapshot {
         storage.withLock { $0.snapshot }
     }
 
     // swift-format-ignore: AllPublicDeclarationsHaveDocumentation
     public func watchSnapshot<Return>(
-        updatesHandler: (ConfigUpdatesAsyncSequence<any ConfigSnapshotProtocol, Never>) async throws -> Return
+        updatesHandler: (ConfigUpdatesAsyncSequence<any ConfigSnapshot, Never>) async throws -> Return
     ) async throws -> Return {
         let (stream, continuation) = AsyncStream<Snapshot>.makeStream(bufferingPolicy: .bufferingNewest(1))
         let id = UUID()

Sources/Configuration/Providers/Wrappers/KeyMappingProvider.swift

@@ -112,13 +112,13 @@ extension KeyMappingProvider: ConfigProvider {
     }
 
     // swift-format-ignore: AllPublicDeclarationsHaveDocumentation
-    public func snapshot() -> any ConfigSnapshotProtocol {
+    public func snapshot() -> any ConfigSnapshot {
         MappedKeySnapshot(mapKey: self.mapKey, upstream: self.upstream.snapshot())
     }
 
     // swift-format-ignore: AllPublicDeclarationsHaveDocumentation
     public func watchSnapshot<Return>(
-        updatesHandler: (ConfigUpdatesAsyncSequence<any ConfigSnapshotProtocol, Never>) async throws -> Return
+        updatesHandler: (ConfigUpdatesAsyncSequence<any ConfigSnapshot, Never>) async throws -> Return
     ) async throws -> Return {
         try await upstream.watchSnapshot { sequence in
             try await updatesHandler(
@@ -135,13 +135,13 @@ extension KeyMappingProvider: ConfigProvider {
 
 /// A configuration snapshot that maps all keys before delegating to an upstream snapshot.
 @available(Configuration 1.0, *)
-private struct MappedKeySnapshot: ConfigSnapshotProtocol {
+private struct MappedKeySnapshot: ConfigSnapshot {
 
     /// The prefix key to prepend to all configuration keys.
     let mapKey: @Sendable (AbsoluteConfigKey) -> AbsoluteConfigKey
 
     /// The upstream configuration snapshot to delegate to after prefixing keys.
-    var upstream: any ConfigSnapshotProtocol
+    var upstream: any ConfigSnapshot
 
     var providerName: String {
         "KeyMappingProvider[upstream: \(self.upstream.providerName)]"

Sources/ConfigurationTestingInternal/TestProvider.swift

@@ -83,7 +83,7 @@ extension TestProvider {
 }
 
 @available(Configuration 1.0, *)
-extension TestProvider: ConfigProvider, ConfigSnapshotProtocol {
+extension TestProvider: ConfigProvider, ConfigSnapshot {
     package var providerName: String {
         "TestProvider"
     }
@@ -103,12 +103,12 @@ extension TestProvider: ConfigProvider, ConfigSnapshotProtocol {
         }
     }
 
-    package func snapshot() -> any ConfigSnapshotProtocol {
+    package func snapshot() -> any ConfigSnapshot {
         self
     }
 
     package func watchSnapshot<Return>(
-        updatesHandler: (ConfigUpdatesAsyncSequence<any ConfigSnapshotProtocol, Never>) async throws -> Return
+        updatesHandler: (ConfigUpdatesAsyncSequence<any ConfigSnapshot, Never>) async throws -> Return
     )
         async throws -> Return
     {

Tests/ConfigurationTests/KeyMappingProviderTests.swift

@@ -117,7 +117,7 @@ struct KeyMappingProviderTests {
             }
         }
 
-        var receivedSnapshots: [any ConfigSnapshotProtocol] = []
+        var receivedSnapshots: [any ConfigSnapshot] = []
         try await mapper.watchSnapshot { sequence in
             for try await snapshot in sequence {
                 receivedSnapshots.append(snapshot)