Add RoomState Store interface

kloenk · kloenk · commit cfd386c30fc9 · 2022-04-24T20:31:24.000+02:00
diff --git a/Sources/MatrixClient/API/Events/Messages/Messages.Codable.swift b/Sources/MatrixClient/API/Events/Messages/Messages.Codable.swift
@@ -18,7 +18,7 @@ enum MatrixMessageTypeCodingKeys: String, CodingKey {
     case type = "msgtype"
 }
 
-extension CodingUserInfoKey {
+public extension CodingUserInfoKey {
     static var matrixMessageTypes: CodingUserInfoKey {
         CodingUserInfoKey(rawValue: "MatrixClient.MessageTypes")!
     }
diff --git a/Sources/MatrixClient/API/Events/RoomEvent.swift b/Sources/MatrixClient/API/Events/RoomEvent.swift
@@ -32,7 +32,7 @@ extension KeyedDecodingContainer {
     }
 }
 
-extension CodingUserInfoKey {
+public extension CodingUserInfoKey {
     /// The key used to determine the types of `MatrixEvent` that can be decoded.
     static var matrixEventTypes: CodingUserInfoKey {
         CodingUserInfoKey(rawValue: "MatrixClient.EventTypes")!
diff --git a/Sources/MatrixClient/API/Events/State/StateEvent+Codable.swift b/Sources/MatrixClient/API/Events/State/StateEvent+Codable.swift
@@ -16,7 +16,7 @@ enum MatrixStateEventTypeCodingKeys: String, CodingKey {
     case content
 }
 
-extension CodingUserInfoKey {
+public extension CodingUserInfoKey {
     static var matrixStateEventTypes: CodingUserInfoKey {
         CodingUserInfoKey(rawValue: "MatrixClient.StateTypes")!
     }
diff --git a/Sources/MatrixCore/MatrixStore.swift b/Sources/MatrixCore/MatrixStore.swift
@@ -14,6 +14,7 @@ public protocol MatrixStore {
 
     /// Type for Account Informations.
     associatedtype AccountInfo: MatrixStoreAccountInfo
+    associatedtype RoomState: MatrixStoreRoomState
 
     @available(swift, introduced: 5.5)
     @available(macOS 12.0, iOS 15.0, watchOS 8.0, tvOS 15.0, *)
@@ -30,4 +31,28 @@ public protocol MatrixStore {
     @available(swift, introduced: 5.5)
     @available(macOS 12.0, iOS 15.0, watchOS 8.0, tvOS 15.0, *)
     func deleteAccountInfo(account: AccountInfo) async throws
+
+    // MARK: - Room
+
+    // MARK: Room State
+
+    @available(swift, introduced: 5.5)
+    @available(macOS 12.0, iOS 15.0, watchOS 8.0, tvOS 15.0, *)
+    func addRoomState(state: RoomState) async throws
+
+    @available(swift, introduced: 5.5)
+    @available(macOS 12.0, iOS 15.0, watchOS 8.0, tvOS 15.0, *)
+    func getRoomState(roomId: String) async throws -> [RoomState]
+    @available(swift, introduced: 5.5)
+    @available(macOS 12.0, iOS 15.0, watchOS 8.0, tvOS 15.0, *)
+    func getRoomState(eventId: String) async throws -> RoomState?
+    @available(swift, introduced: 5.5)
+    @available(macOS 12.0, iOS 15.0, watchOS 8.0, tvOS 15.0, *)
+    func getRoomState(roomId: String, stateType: String) async throws -> [RoomState]
+    @available(swift, introduced: 5.5)
+    @available(macOS 12.0, iOS 15.0, watchOS 8.0, tvOS 15.0, *)
+    func getRoomState(roomId: String, stateKey: String) async throws -> [RoomState]
+    @available(swift, introduced: 5.5)
+    @available(macOS 12.0, iOS 15.0, watchOS 8.0, tvOS 15.0, *)
+    func getRoomState(roomId: String, stateType: String, stateKey: String) async throws -> [RoomState]
 }
diff --git a/Sources/MatrixCore/MatrixStoreRoomState.swift b/Sources/MatrixCore/MatrixStoreRoomState.swift
@@ -0,0 +1,17 @@
+//
+//  File.swift
+//
+//
+//  Created by Finn Behrens on 24.04.22.
+//
+
+import Foundation
+import MatrixClient
+
+public protocol MatrixStoreRoomState {
+    var eventId: String { get }
+    var roomId: String { get }
+    var stateKey: String { get }
+    var contentType: String { get }
+    var content: MatrixStateEventType { get }
+}

Original file line number	Diff line number	Diff line change
`@@ -18,7 +18,7 @@ enum MatrixMessageTypeCodingKeys: String, CodingKey {`
`18`	`18`	`case type = "msgtype"`
`19`	`19`	`}`
`20`	`20`
`21`		`-extension CodingUserInfoKey {`
	`21`	`+public extension CodingUserInfoKey {`
`22`	`22`	`static var matrixMessageTypes: CodingUserInfoKey {`
`23`	`23`	`CodingUserInfoKey(rawValue: "MatrixClient.MessageTypes")!`
`24`	`24`	`}`
Original file line number	Diff line number	Diff line change
`@@ -32,7 +32,7 @@ extension KeyedDecodingContainer {`
`32`	`32`	`}`
`33`	`33`	`}`
`34`	`34`
`35`		`-extension CodingUserInfoKey {`
	`35`	`+public extension CodingUserInfoKey {`
`36`	`36`	/// The key used to determine the types of `MatrixEvent` that can be decoded.
`37`	`37`	`static var matrixEventTypes: CodingUserInfoKey {`
`38`	`38`	`CodingUserInfoKey(rawValue: "MatrixClient.EventTypes")!`
Original file line number	Diff line number	Diff line change
`@@ -16,7 +16,7 @@ enum MatrixStateEventTypeCodingKeys: String, CodingKey {`
`16`	`16`	`case content`
`17`	`17`	`}`
`18`	`18`
`19`		`-extension CodingUserInfoKey {`
	`19`	`+public extension CodingUserInfoKey {`
`20`	`20`	`static var matrixStateEventTypes: CodingUserInfoKey {`
`21`	`21`	`CodingUserInfoKey(rawValue: "MatrixClient.StateTypes")!`
`22`	`22`	`}`