Skip to content

[V5] Add Identifiable conformances to models #3852

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: v5
Choose a base branch
from
+24 −27
Open

[V5] Add Identifiable conformances to models #3852

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion Sources/StreamChat/Models/Attachments/ChatMessageAttachment.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ public struct StreamAttachment<Payload> {
/// A type representing a chat message attachment.
/// `ChatMessageAttachment<Payload>` is an immutable snapshot of message attachment at the given time.
@dynamicMemberLookup
public struct ChatMessageAttachment<Payload> {
public struct ChatMessageAttachment<Payload>: Identifiable {
/// The attachment identifier.
public let id: AttachmentId

Expand Down
4 changes: 4 additions & 0 deletions Sources/StreamChat/Models/Channel.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -369,6 +369,10 @@ public struct ChatChannel: Sendable {
}
}

extension ChatChannel: Identifiable {
public var id: String { cid.rawValue }
}

extension ChatChannel {
/// The type of the channel.
public var type: ChannelType { cid.type }
Expand Down
2 changes: 1 addition & 1 deletion Sources/StreamChat/Models/ChatMessage.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ import Foundation
public typealias MessageId = String

/// A type representing a chat message. `ChatMessage` is an immutable snapshot of a chat message entity at the given time.
public struct ChatMessage: Sendable {
public struct ChatMessage: Identifiable, Sendable {
/// A unique identifier of the message.
public let id: MessageId

Expand Down
2 changes: 1 addition & 1 deletion Sources/StreamChat/Models/Device.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ extension Data {
}

/// An object representing a device which can receive push notifications.
public struct Device: Codable, Equatable, Sendable {
public struct Device: Codable, Equatable, Identifiable, Sendable {
private enum CodingKeys: String, CodingKey {
case id
case createdAt = "created_at"
Expand Down
2 changes: 1 addition & 1 deletion Sources/StreamChat/Models/DraftMessage.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

import Foundation

public struct DraftMessage: Sendable {
public struct DraftMessage: Sendable, Identifiable {
/// A unique identifier of the message.
public let id: MessageId

Expand Down
4 changes: 2 additions & 2 deletions Sources/StreamChat/Models/MessageReaction.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,9 @@ import Foundation

/// A type representing a message reaction. `ChatMessageReaction` is an immutable snapshot
/// of a message reaction entity at the given time.
public struct ChatMessageReaction: Hashable, Sendable {
public struct ChatMessageReaction: Hashable, Identifiable, Sendable {
/// The id of the reaction.
let id: String
public let id: String
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is this enough to identify a reaction?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Internally this is

static func createId(
        userId: String,
        messageId: MessageId,
        type: MessageReactionType
    ) -> String {
        [userId, messageId, type.rawValue].joined(separator: "/")
    }

Which should be enough I think. SwiftUI has it currently

extension ChatMessageReaction: Identifiable {
    public var id: String {
        "\(author.id)-\(type.rawValue)"
    }
}


/// The reaction type.
public let type: MessageReactionType
Expand Down
2 changes: 1 addition & 1 deletion Sources/StreamChat/Models/MessageReminder.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
import Foundation

/// A type representing a message reminder.
public struct MessageReminder: Sendable {
public struct MessageReminder: Identifiable, Sendable {
/// A unique identifier of the reminder, based on the message ID.
public let id: String

Expand Down
2 changes: 1 addition & 1 deletion Sources/StreamChat/Models/Poll.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
import Foundation

/// The model for a Poll.
public struct Poll: Equatable, Sendable {
public struct Poll: Equatable, Identifiable, Sendable {
/// A boolean indicating whether the poll allows answers/comments.
public let allowAnswers: Bool

Expand Down
2 changes: 1 addition & 1 deletion Sources/StreamChat/Models/PollOption.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
import Foundation

/// The model for an option in a poll.
public struct PollOption: Hashable, Equatable, Sendable {
public struct PollOption: Hashable, Equatable, Identifiable, Sendable {
/// The unique identifier of the poll option.
public let id: String

Expand Down
2 changes: 1 addition & 1 deletion Sources/StreamChat/Models/PollVote.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
import Foundation

/// A structure representing a vote in a poll.
public struct PollVote: Hashable, Equatable, Sendable {
public struct PollVote: Hashable, Equatable, Identifiable, Sendable {
/// The unique identifier of the poll vote.
public let id: String

Expand Down
3 changes: 2 additions & 1 deletion Sources/StreamChat/Models/Thread.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,8 @@
import Foundation

/// A type representing a thread.
public struct ChatThread: Sendable {
public struct ChatThread: Identifiable, Sendable {
public var id: MessageId { parentMessageId }
/// The id of the message which created the thread. It is also the id of the thread.
public let parentMessageId: MessageId
/// The parent message which is the root of this thread.
Expand Down
6 changes: 6 additions & 0 deletions Sources/StreamChat/Models/ThreadParticipant.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,3 +15,9 @@ public struct ThreadParticipant: Equatable, Sendable {
/// The date when the participant last read the thread.
public let lastReadAt: Date?
}

extension ThreadParticipant: Identifiable {
public var id: String {
"\(threadId)-\(user.id)"
}
}
8 changes: 0 additions & 8 deletions Sources/StreamChat/Models/User+SwiftUI.swift
View file
Open in desktop

This file was deleted.

2 changes: 1 addition & 1 deletion Sources/StreamChat/Models/User.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ public typealias TeamId = String

/// A type representing a chat user. `ChatUser` is an immutable snapshot of a chat user entity at the given time.
///
public class ChatUser: @unchecked Sendable {
public class ChatUser: Identifiable, @unchecked Sendable {
/// The unique identifier of the user.
public let id: UserId

Expand Down
2 changes: 1 addition & 1 deletion Sources/StreamChat/Models/UserInfo.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
import Foundation

/// The user information used to connect the user to chat.
public struct UserInfo: Sendable {
public struct UserInfo: Identifiable, Sendable {
/// The id of the user.
public let id: UserId
/// The name of the user.
Expand Down
6 changes: 0 additions & 6 deletions StreamChat.xcodeproj/project.pbxproj
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -488,7 +488,6 @@
7865705825FB6DF300974045 /* UIViewController+Extensions_Tests.swift in Sources */ = {isa = PBXBuildFile; fileRef = 7865705725FB6DF300974045 /* UIViewController+Extensions_Tests.swift */; };
78C8473825FA0EF000A5D1D0 /* ChatChannelUnreadCountView+SwiftUI.swift in Sources */ = {isa = PBXBuildFile; fileRef = 78C8473725FA0EF000A5D1D0 /* ChatChannelUnreadCountView+SwiftUI.swift */; };
78C8474125FA0F2900A5D1D0 /* ChatChannelUnreadCountView+SwiftUI_Tests.swift in Sources */ = {isa = PBXBuildFile; fileRef = 78C8474025FA0F2900A5D1D0 /* ChatChannelUnreadCountView+SwiftUI_Tests.swift */; };
7900452625374CA20096ECA1 /* User+SwiftUI.swift in Sources */ = {isa = PBXBuildFile; fileRef = 7900452525374CA20096ECA1 /* User+SwiftUI.swift */; };
7908820625432B7200896F03 /* StreamChatUI.framework in Frameworks */ = {isa = PBXBuildFile; fileRef = 790881FD25432B7200896F03 /* StreamChatUI.framework */; };
7908823325432C6400896F03 /* StreamChatUI.h in Headers */ = {isa = PBXBuildFile; fileRef = 7908823125432C6400896F03 /* StreamChatUI.h */; settings = {ATTRIBUTES = (Public, ); }; };
7908824A25432CC600896F03 /* StreamChatStressTestPlan.xctestplan in Resources */ = {isa = PBXBuildFile; fileRef = 7908824725432CC600896F03 /* StreamChatStressTestPlan.xctestplan */; };
Expand Down Expand Up @@ -2217,7 +2216,6 @@
C121E894274544B000023E4C /* ChatMessage.swift in Sources */ = {isa = PBXBuildFile; fileRef = 799C9431247D2FB9001F1104 /* ChatMessage.swift */; };
C121E895274544B000023E4C /* MessagePinning.swift in Sources */ = {isa = PBXBuildFile; fileRef = AD7AC98B260A94C6004AADA5 /* MessagePinning.swift */; };
C121E896274544B000023E4C /* UnreadCount.swift in Sources */ = {isa = PBXBuildFile; fileRef = 8AAB1C6524CB39F2009B783F /* UnreadCount.swift */; };
C121E897274544B000023E4C /* User+SwiftUI.swift in Sources */ = {isa = PBXBuildFile; fileRef = 7900452525374CA20096ECA1 /* User+SwiftUI.swift */; };
C121E898274544B000023E4C /* MessageReaction.swift in Sources */ = {isa = PBXBuildFile; fileRef = 8899BC52254318CC003CB98B /* MessageReaction.swift */; };
C121E899274544B000023E4C /* MessageReactionType.swift in Sources */ = {isa = PBXBuildFile; fileRef = 88EA9AED254721C0007EE76B /* MessageReactionType.swift */; };
C121E89A274544B000023E4C /* MuteDetails.swift in Sources */ = {isa = PBXBuildFile; fileRef = 88DA57632631CF1F00FA8C53 /* MuteDetails.swift */; };
Expand Down Expand Up @@ -3470,7 +3468,6 @@
7865705725FB6DF300974045 /* UIViewController+Extensions_Tests.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = "UIViewController+Extensions_Tests.swift"; sourceTree = "<group>"; };
78C8473725FA0EF000A5D1D0 /* ChatChannelUnreadCountView+SwiftUI.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = "ChatChannelUnreadCountView+SwiftUI.swift"; sourceTree = "<group>"; };
78C8474025FA0F2900A5D1D0 /* ChatChannelUnreadCountView+SwiftUI_Tests.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = "ChatChannelUnreadCountView+SwiftUI_Tests.swift"; sourceTree = "<group>"; };
7900452525374CA20096ECA1 /* User+SwiftUI.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = "User+SwiftUI.swift"; sourceTree = "<group>"; };
790881FD25432B7200896F03 /* StreamChatUI.framework */ = {isa = PBXFileReference; explicitFileType = wrapper.framework; includeInIndex = 0; path = StreamChatUI.framework; sourceTree = BUILT_PRODUCTS_DIR; };
7908820525432B7200896F03 /* StreamChatUITests.xctest */ = {isa = PBXFileReference; explicitFileType = wrapper.cfbundle; includeInIndex = 0; path = StreamChatUITests.xctest; sourceTree = BUILT_PRODUCTS_DIR; };
7908823125432C6400896F03 /* StreamChatUI.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; path = StreamChatUI.h; sourceTree = "<group>"; };
Expand Down Expand Up @@ -6295,7 +6292,6 @@
AD37D7D22BC9938E00800D8C /* ThreadRead.swift */,
8AAB1C6524CB39F2009B783F /* UnreadCount.swift */,
79877A012498E4BB00015F8B /* User.swift */,
7900452525374CA20096ECA1 /* User+SwiftUI.swift */,
64C8C86D26934C6100329F82 /* UserInfo.swift */,
);
path = Models;
Expand Down Expand Up @@ -11944,7 +11940,6 @@
ADB8B90F2D8C7B2500549C95 /* ReminderUpdaterMiddleware.swift in Sources */,
882C5759252C794900E60C44 /* MemberEndpoints.swift in Sources */,
DA640FC12535CFA100D32944 /* ChannelMemberListSortingKey.swift in Sources */,
7900452625374CA20096ECA1 /* User+SwiftUI.swift in Sources */,
82C18FDC2C10C8E600C5283C /* BlockedUserPayload.swift in Sources */,
404296DA2A0112D00089126D /* AudioQueuePlayer.swift in Sources */,
4F51519C2BC66FBE001B7152 /* Task+Extensions.swift in Sources */,
Expand Down Expand Up @@ -12940,7 +12935,6 @@
C121E896274544B000023E4C /* UnreadCount.swift in Sources */,
ADFCA5B42D121EB8000F515F /* LocationInfo.swift in Sources */,
842F9746277A09B10060A489 /* PinnedMessagesQuery.swift in Sources */,
C121E897274544B000023E4C /* User+SwiftUI.swift in Sources */,
C121E898274544B000023E4C /* MessageReaction.swift in Sources */,
C121E899274544B000023E4C /* MessageReactionType.swift in Sources */,
84B7383E2BE8C13A00EC66EC /* PollController+SwiftUI.swift in Sources */,
Expand Down
Loading