Skip to main content

flare_proto/
lib.rs

1//! Shared protobuf model types for Flare IM.
2//!
3//! `flare-proto` exposes the common wire contracts used by Flare services and
4//! SDK infrastructure: messages, message content, conversations, sync payloads,
5//! metadata, notifications, push envelopes, event-bus envelopes, and data
6//! packets.
7//!
8//! The crate intentionally contains common model types only. gRPC service
9//! definitions and tonic-generated clients/servers are published separately by
10//! `flare-grpc-proto`.
11//!
12//! # Main Modules
13//!
14//! - [`common`] re-exports generated `flare.common.v1` protobuf types.
15//! - [`response`] provides helpers for packing `prost_types::Any`.
16//! - [`metadata_builder`] provides ergonomic constructors for pagination,
17//!   filters, actor context, device context, audit context, sorting, and time
18//!   ranges.
19//! - [`message_content_ext`] provides encoding and decoding helpers for typed
20//!   message content.
21//!
22//! # Build Behavior
23//!
24//! The crate uses `prost-build` with a vendored `protoc` binary, so downstream
25//! users and docs.rs can build it without installing a system protobuf compiler.
26
27pub mod flare {
28    pub mod common {
29        pub mod v1 {
30            #![allow(clippy::large_enum_variant)]
31
32            include!(concat!(env!("OUT_DIR"), "/flare.common.v1.rs"));
33        }
34    }
35}
36
37pub mod common {
38    pub use crate::flare::common::v1::*;
39}
40
41pub use common::push_envelope;
42
43/// Convenience builders for `prost_types::Any`.
44pub mod response;
45
46/// Convenience builders aligned with `metadata.proto`.
47pub mod metadata_builder;
48
49// MessageContent extension methods with a unified encode/decode interface.
50pub mod message_content_ext;
51pub use message_content_ext::{MessageContentExt, decode_message_content, encode_message_content};
52
53pub use response::pack_any;
54
55// Metadata convenience builders used by business layers.
56pub use metadata_builder::{
57    actor_service, actor_system, actor_tenant_admin, actor_user, actor_with_attributes,
58    actor_with_roles, audit_context, device_context, device_with_priority_critical,
59    device_with_priority_high, device_with_priority_low, filter_contains, filter_eq, filter_ge,
60    filter_gt, filter_in, filter_le, filter_lt, filter_ne, filter_not_in, pagination,
61    pagination_first, pagination_with_more, sort_asc, sort_desc, time_range,
62    unix_millis_from_seconds,
63};
64
65// Re-export commonly used common model types.
66pub use common::{
67    AckPayload, AppCardAction, AppCardContent, AudioContent, AudioInfo, AuditContext,
68    CapabilityPacket, CardContent, ConflictResolution, ConnectionQuality, ContentVisibility,
69    ConversationDetailSync, ConversationDetailSyncRes, ConversationParticipant,
70    ConversationParticipantsSync, ConversationParticipantsSyncRes,
71    ConversationSummary as ConversationSummaryProto, ConversationSyncSlice,
72    ConversationUserSettingsSync, ConversationUserSettingsSyncRes, ConversationVersion,
73    ConversationsSync, ConversationsSyncRes, CustomContent, CustomPayload, DataPacket, DeleteType,
74    DeviceState as ConversationDeviceState, EventBusEnvelope, FileContent, ForwardContent,
75    ForwardItem, ForwardMode, GetSyncCursorSync, GetSyncCursorSyncRes, ImageContent, ImageInfo,
76    LocationContent, MarkType, MediaAttachment, Mention, Message, MessageContent,
77    MessageReadRecord, MessageRetentionExpiredEvent, MessageRetentionLifecycle,
78    MessageRetentionPolicy, MessageRetentionPurgedEvent, MessageRetentionScheduledEvent,
79    MessageRetentionState, MessageSource, MessageStatus, MessageTimeline, MessageType, MqEnvelope,
80    MqPayloadKind, MultiConversationSync, MultiConversationSyncRes, MultiDeviceCursor,
81    NotificationContent, NotificationPayload, OfflinePushInfo, Pagination, PresenceHintPacket,
82    PushDelivered, PushEnvelope, PushFailed, PushOptions, PushPayloadKind, PushResult,
83    PushTargetType, PushTaskEnvelope, PushTaskPayloadKind, QueryEventsSync, QueryEventsSyncRes,
84    ReactionAction, RealtimeControlPacket, RetentionMode, RetentionTrigger, SendAccepted, SendAck,
85    SendAckDurability, SingleConversationSync, SingleConversationSyncRes, Sync, SyncRes,
86    SyncSkipItem, SyncSliceItem, SyncTombstoneItem, SystemPayload, TextContent, TypingStatePacket,
87    UpdateSyncCursorSync, UpdateSyncCursorSyncRes, VideoContent, VideoInfo,
88};