Skip to main content

flare_grpc_proto/
lib.rs

1//! Flare IM **gRPC 服务** proto 生成层(tonic client/server + 各服务消息类型)。
2//!
3//! 依赖 [`flare_proto`](flare_proto) 中的 `flare.common.v1` 等基础类型;业务 crate 按需依赖本 crate。
4
5// 本 crate 内容全部由 prost/tonic 从 .proto 生成,代码风格不由我们控制。
6// large_enum_variant 针对 oneof 生成枚举的变体大小差异 —— 这是 protobuf 固有形态,
7// 真要收敛得改 .proto 的消息设计,而不是在生成代码里加 Box。
8#![allow(clippy::large_enum_variant)]
9
10pub mod flare {
11    pub mod access_gateway {
12        pub mod v1 {
13            tonic::include_proto!("flare.access_gateway.v1");
14        }
15    }
16
17    pub mod signaling {
18        pub mod online {
19            pub mod v1 {
20                tonic::include_proto!("flare.signaling.online.v1");
21            }
22        }
23        pub mod router {
24            pub mod v1 {
25                tonic::include_proto!("flare.signaling.router.v1");
26            }
27        }
28    }
29
30    pub mod push {
31        pub mod v1 {
32            tonic::include_proto!("flare.push.v1");
33        }
34    }
35
36    pub mod storage {
37        pub mod v1 {
38            tonic::include_proto!("flare.storage.v1");
39        }
40    }
41
42    pub mod media {
43        pub mod v1 {
44            tonic::include_proto!("flare.media.v1");
45        }
46    }
47
48    pub mod capability {
49        pub mod v1 {
50            tonic::include_proto!("flare.capability.v1");
51        }
52    }
53
54    pub mod conversation {
55        pub mod v1 {
56            tonic::include_proto!("flare.conversation.v1");
57        }
58    }
59
60    pub mod message {
61        pub mod v1 {
62            tonic::include_proto!("flare.message.v1");
63        }
64    }
65
66    pub mod sync {
67        pub mod v1 {
68            tonic::include_proto!("flare.sync.v1");
69        }
70    }
71
72    #[cfg(feature = "sfu_control")]
73    pub mod sfu {
74        pub mod control {
75            pub mod v1 {
76                tonic::include_proto!("flare.sfu.control.v1");
77            }
78        }
79    }
80}
81
82pub mod signaling {
83    pub mod online {
84        pub use crate::flare::signaling::online::v1::*;
85    }
86    pub mod router {
87        pub use crate::flare::signaling::router::v1::*;
88    }
89    pub use crate::flare::signaling::online::v1::*;
90}
91
92pub mod push {
93    pub use crate::flare::push::v1::*;
94}
95
96pub mod storage {
97    pub use crate::flare::storage::v1::*;
98}
99
100pub mod media {
101    pub use crate::flare::media::v1::*;
102}
103
104pub mod capability {
105    pub use crate::flare::capability::v1::*;
106}
107
108pub mod conversation {
109    pub use crate::flare::conversation::v1::*;
110}
111
112pub mod message {
113    pub use crate::flare::message::v1::*;
114}
115
116pub mod access_gateway {
117    pub use crate::flare::access_gateway::v1::*;
118}
119
120pub mod sync {
121    pub use crate::flare::sync::v1::*;
122}
123
124/// SFU 插件控制面(`sfu_control.proto` → `flare.sfu.control.v1`)。需启用 crate feature `sfu_control`。
125#[cfg(feature = "sfu_control")]
126pub mod sfu_control {
127    pub use crate::flare::sfu::control::v1::*;
128}
129
130pub use flare_proto::PushTaskPayloadKind;
131pub use flare_proto::common::{
132    AppCardAction, AppCardContent, AudioContent, AudioInfo, AuditContext, CapabilityPacket,
133    CardContent, ConflictResolution, ContentVisibility, ConversationDetailSync,
134    ConversationDetailSyncRes, ConversationSummary as ConversationSummaryProto,
135    ConversationSyncSlice, ConversationUserSettingsSync, ConversationUserSettingsSyncRes,
136    ConversationsSync, ConversationsSyncRes, CustomContent, DataPacket, DeleteType,
137    DeviceState as ConversationDeviceState, FileContent, ForwardContent, GetSyncCursorSync,
138    GetSyncCursorSyncRes, ImageContent, ImageInfo, LocationContent, MarkType, MediaAttachment,
139    Mention, Message, MessageContent, MessageReadRecord, MessageRetentionExpiredEvent,
140    MessageRetentionLifecycle, MessageRetentionPolicy, MessageRetentionPurgedEvent,
141    MessageRetentionScheduledEvent, MessageRetentionState, MessageSource, MessageStatus,
142    MessageTimeline, MessageType, MqEnvelope, MqPayloadKind, MultiConversationSync,
143    MultiConversationSyncRes, MultiDeviceCursor, NotificationContent, OfflinePushInfo, Pagination,
144    PresenceHintPacket, QueryEventsSync, QueryEventsSyncRes, ReactionAction, RealtimeControlPacket,
145    RetentionMode, RetentionTrigger, SingleConversationSync, SingleConversationSyncRes, Sync,
146    SyncRes, SyncSliceItem, TextContent, TypingStatePacket, UpdateSyncCursorSync,
147    UpdateSyncCursorSyncRes, VideoContent, VideoInfo,
148};
149
150pub use storage::VisibilityStatus;
151
152pub use signaling::online::{
153    DeviceInfo, GetOnlineStatusRequest as SignalingGetOnlineStatusRequest,
154    GetOnlineStatusResponse as SignalingGetOnlineStatusResponse, HeartbeatRequest,
155    HeartbeatResponse, LoginRequest as SignalingLoginRequest,
156    LoginResponse as SignalingLoginResponse, LogoutRequest, LogoutResponse, UserPresence,
157};
158
159pub use signaling::router::{
160    PushStrategy, RouteTarget, RouterDownstreamPushAckRequest, RouterDownstreamPushCustomRequest,
161    RouterDownstreamPushEventRequest, RouterDownstreamPushMessageRequest,
162    RouterDownstreamPushNotificationRequest,
163};
164
165pub use push::{
166    DevicePushProvider, Notification as PushNotificationContent,
167    PushCustomRequest as PushPushCustomRequest, PushCustomResponse as PushPushCustomResponse,
168    PushFailure, PushMessageRequest as PushPushMessageRequest,
169    PushMessageResponse as PushPushMessageResponse,
170    PushNotificationRequest as PushPushNotificationRequest,
171    PushNotificationResponse as PushPushNotificationResponse, PushOptions, QueryPushStatusRequest,
172    QueryPushStatusResponse, RegisterDevicePushTokenRequest, RegisterDevicePushTokenResponse,
173    UnregisterDevicePushTokenRequest, UnregisterDevicePushTokenResponse,
174};
175
176pub use storage::{
177    ExportMessagesRequest, ExportMessagesResponse, FailedMessage,
178    GetMessageRequest as StorageGetMessageRequest, GetMessageResponse as StorageGetMessageResponse,
179    QueryMessagesRequest as StorageQueryMessagesRequest,
180    QueryMessagesResponse as StorageQueryMessagesResponse, SearchMessagesRequest,
181    SearchMessagesResponse,
182};
183
184pub use media::{
185    AbortMultipartUploadRequest, AbortMultipartUploadResponse, AccessControlEntry,
186    CleanupOrphanedAssetsRequest, CleanupOrphanedAssetsResponse, CompleteMultipartUploadRequest,
187    CompressOperation, CompressVideoOperation, CreateReferenceRequest, CreateReferenceResponse,
188    DeleteFileRequest as MediaDeleteFileRequest, DeleteFileResponse as MediaDeleteFileResponse,
189    DeleteReferenceRequest, DeleteReferenceResponse, DescribeBucketRequest, DescribeBucketResponse,
190    FileInfo, GenerateUploadUrlRequest, GenerateUploadUrlResponse, GetFileInfoRequest,
191    GetFileInfoResponse, GetFileUrlRequest, GetFileUrlResponse, ImageOperation,
192    InitiateMultipartUploadRequest, InitiateMultipartUploadResponse, ListObjectsRequest,
193    ListObjectsResponse, ListReferencesRequest, ListReferencesResponse, MediaReferenceInfo,
194    ProcessImageRequest, ProcessImageResponse, ProcessVideoRequest, ProcessVideoResponse,
195    ResizeOperation, SetObjectAclRequest, SubtitleBurnOperation, ThumbnailOperation,
196    UploadFileMetadata, UploadFileRequest, UploadFileResponse, UploadMultipartChunkRequest,
197    UploadMultipartChunkResponse, VideoOperation, WatermarkOperation,
198};
199
200pub use capability::{
201    ConversationLifecycleHookRequest, ConversationLifecycleHookResponse, CustomHookRequest,
202    CustomHookResponse, DeliveryHookRequest as ProtoDeliveryHookRequest,
203    DeliveryHookResponse as ProtoDeliveryHookResponse, GenericRequest, GenericResponse,
204    HookDeliveryEvent as ProtoHookDeliveryEvent,
205    HookInvocationContext as ProtoHookInvocationContext, HookMessageDraft as ProtoHookMessageDraft,
206    HookMessageRecord as ProtoHookMessageRecord, HookRecallEvent as ProtoHookRecallEvent,
207    PostSendHookRequest as ProtoPostSendHookRequest,
208    PostSendHookResponse as ProtoPostSendHookResponse,
209    PreSendHookRequest as ProtoPreSendHookRequest, PreSendHookResponse as ProtoPreSendHookResponse,
210    PresenceHookRequest, PresenceHookResponse, RecallHookRequest as ProtoRecallHookRequest,
211    RecallHookResponse as ProtoRecallHookResponse,
212};
213
214#[cfg(not(target_arch = "wasm32"))]
215pub use conversation::{
216    ConversationBootstrapRequest, ConversationBootstrapResponse, ConversationPolicy,
217    DevicePresence as ConversationDevicePresence, ForceConversationSyncRequest,
218    ListConversationsRequest as ConversationListConversationsRequest,
219    ListConversationsResponse as ConversationListConversationsResponse,
220    SortOrder as ConversationSortOrder, SyncMessagesRequest as ConversationSyncMessagesRequest,
221    SyncMessagesResponse as ConversationSyncMessagesResponse, UpdateCursorRequest,
222    UpdatePresenceRequest,
223};
224
225/// 「确保会话存在」的建群请求约定(唯一实现):
226/// - `conversation_id` 经 `attributes["conversation_id"]` 携带——服务端按此 id 建群(幂等),
227///   与客户端 `hash(group_key)` 推导的会话 id 对齐;改动此约定必须三方(ingest 管线 /
228///   sync 编排 / conversation 消费端)同步,故收敛为单一构造函数。
229/// - 成员默认无角色/未静音/未置顶;可见性恒 Private。
230#[cfg(not(target_arch = "wasm32"))]
231pub fn ensure_conversation_request(
232    conversation_id: &str,
233    conversation_type: i32,
234    business_type: String,
235    member_ids: impl IntoIterator<Item = String>,
236    channel_id: String,
237) -> conversation::CreateConversationRequest {
238    let participants = member_ids
239        .into_iter()
240        .map(|user_id| flare_proto::common::ConversationParticipant {
241            user_id,
242            roles: vec![],
243            muted: false,
244            pinned: false,
245            attributes: std::collections::HashMap::new(),
246            joined_at: 0,
247            // 建群时的初始成员无历史下限:他们本来就在场,没有「入群前」可言。
248            visible_from_seq: 0,
249            mention_only: false,
250        })
251        .collect();
252    let mut attributes = std::collections::HashMap::new();
253    attributes.insert("conversation_id".to_string(), conversation_id.to_string());
254    conversation::CreateConversationRequest {
255        conversation_type,
256        business_type,
257        participants,
258        attributes,
259        visibility: 0, // SessionVisibility::Private
260        channel_id,
261    }
262}