Skip to main content

flare_im_core_sdk/
lib.rs

1//! Flare IM Core SDK.
2//!
3//! This crate is the client-side source of truth for IM behavior: reliable
4//! send, local pending state, sync convergence, message projections, protocol
5//! mapping, and extension dispatch. Platform bindings adapt this API instead
6//! of duplicating delivery or synchronization rules.
7
8#![cfg_attr(
9    not(test),
10    deny(clippy::expect_used, clippy::panic, clippy::unwrap_used)
11)]
12
13// Internal modules stay crate-private; public facades below own the SDK surface.
14#[allow(dead_code, unused_imports)]
15pub(crate) mod application;
16pub mod client;
17pub mod content;
18#[allow(dead_code, unused_imports)]
19pub(crate) mod core;
20#[allow(dead_code, unused_imports)]
21pub(crate) mod domain;
22#[allow(dead_code, unused_imports)]
23pub(crate) mod extension;
24#[allow(dead_code, unused_imports)]
25pub(crate) mod infrastructure;
26#[allow(dead_code, unused_imports)]
27pub(crate) mod kernel;
28pub mod model;
29#[allow(dead_code, unused_imports)]
30pub(crate) mod platform;
31#[allow(dead_code, unused_imports)]
32pub(crate) mod runtime;
33#[allow(dead_code, unused_imports)]
34pub(crate) mod shared;
35pub mod spi;
36
37/// Re-export serialization crates for platform binding runtimes that must share
38/// the exact same serde/serde_json crate instances as SDK model types.
39pub use schemars;
40pub use serde;
41pub use serde_json;
42
43/// Event subscription and SDK event payload facade.
44pub mod event {
45    pub use crate::kernel::event::*;
46}
47
48/// SDK capability plugin facade.
49///
50/// Plugin crates and code generators should depend on this facade instead of
51/// reaching into SDK internals.
52pub mod plugin {
53    pub use crate::extension::capability::{
54        AvCapabilityPlugin, SdkCapabilityPlugin, SdkCapabilityRegistry, SdkPluginEventManifest,
55        SdkPluginManifest, SdkPluginOperationManifest, SdkPluginPermissionManifest,
56        SdkPluginUiKitManifest,
57    };
58}
59
60/// Storage adapter facade for core-owned persistence implementations.
61///
62/// Product/business extensions should prefer `spi::ExtensionStore`; this
63/// module is for SDK storage adapters such as SQLite or IndexedDB.
64pub mod storage {
65    pub use crate::domain::{
66        ConversationReader, ConversationStore, ConversationWriter, MediaCacheAdmin,
67        MediaCacheEntryVo, MediaCacheStatsVo, MediaCacheStore, MessageReader, MessageStore,
68        MessageWriter, OperationApplyResult, PendingSendReader, PendingSendVo, PendingSendWriter,
69        SyncCursorReader, SyncCursorVo, SyncCursorWriter, UserFileDownloadStore, UserReader,
70        UserWriter, set_local_cleared_through_seq,
71    };
72    pub use crate::infrastructure::persistence::memory_im::{
73        MemoryConversationStore, MemoryMessageStore,
74    };
75    pub use crate::infrastructure::persistence::{
76        MemoryPendingSendStore, MemorySyncCursorStore, MemoryUserProfileStore, StoreProvider,
77        in_memory_empty_im_provider, in_memory_im_provider,
78    };
79    pub use crate::platform::ports::storage::{
80        LOCAL_DATABASE_KEY_BYTES, SecureKeyDescriptor, SecureKeyStore, SecureSecret,
81        VolatileSecureKeyStore, load_or_create_local_database_key, validate_local_database_key,
82    };
83}
84
85pub use client::*;
86pub use core::SdkState;
87pub use core::event::{
88    CustomEventDefinition, CustomEventSelector, EventBus, EventFilter, EventReceiver,
89    FilteredEventReceiver, PublishOutcome, RawSdkEvent, SdkEvent, SdkEventKind, SdkEventType,
90    SharedEventReceiver,
91};
92pub use shared::error::{ErrorCode, FlareError, Result};
93/// 跨平台异步延时(wasm 用 JS 定时器,native 用 tokio)。供 SDK 上层做有界重试等。
94pub use shared::util::time::delay;
95
96/// App-facing imports for the production SDK surface.
97pub mod prelude {
98    pub use crate::application::{
99        FileDownloadProgress, FileDownloadProgressCallback, InboundNotificationView,
100        NotificationDispatchReport, NotificationHandleResult, NotificationHandler,
101        NotificationHandlerRegistry, UploadPhase, UploadProgress, UploadProgressCallback,
102        UserFileDownloadRequest,
103    };
104    pub use crate::client::{
105        CapabilityApi, CapabilityDescriptorDto, CapabilityDispatchResult, ConnectedApis,
106        ConversationApi, CoreTokenConfig, CreateLocationRequest, CreateRichDocRequest,
107        CreateStickerRequest, EditRichDocRequest, IMClient, IMClientBuilder, LoginDbKind, MediaApi,
108        MessageApi, MessageBuildApi, NetworkChangeEvent, RtcSfuSubscriptionRequest,
109        RuntimeHealthSnapshot, SdkConfig, SdkConfigBuilder, SdkConfigOverlay, SdkResourceProfile,
110        SdkRuntimeResources, TransportKind, TransportPolicy, UserCapabilityGrantDto,
111    };
112    pub use crate::domain::{
113        ConversationStore, MediaCacheEntryVo, MediaCacheStatsVo, MessageStore, PendingSendVo,
114        SyncCursorVo,
115    };
116    /// E2EE 参考 codec(需 `e2ee` feature)。
117    #[cfg(feature = "e2ee")]
118    pub use crate::extension::e2ee_codec::{
119        E2EE_CODEC_CONTENT_TYPE, E2EE_CODEC_NAMESPACE, X25519AeadCodec, shared_secret_codec,
120    };
121    pub use crate::extension::encryption::{
122        ContentEncryptionInterceptor, ConversationEncryptionPolicy,
123        ConversationEncryptionPolicyResolver, E2EE_CONTENT_TYPE, E2EE_FALLBACK_TEXT,
124        E2EE_PLACEHOLDER_REASON, E2eeIdentityKey, E2eeKeyManager, E2eePreKeyBundle,
125        E2eeSessionDescriptor, EncryptedContentEnvelope, EncryptionTier,
126        KeyManagedConversationEncryptionPolicyResolver, PLAINTEXT_CONTENT_TYPE,
127        StaticConversationEncryptionPolicyResolver, VolatileE2eeKeyManager,
128        encrypted_content_envelope, encrypted_content_envelope_from_bytes,
129    };
130    pub use crate::extension::{
131        ContentCodec, ConversationProjectionReport, ConversationProjectionSource, ExtensionContent,
132        ExtensionContext, ExtensionLifecycle, ExtensionLifecycleContext, ExtensionMigration,
133        ExtensionRegistry, ExtensionRuntime, ExtensionStore, ProfileProvider, SdkExtension,
134    };
135    #[cfg(feature = "storage-sqlite")]
136    pub use crate::infrastructure::persistence::sqlite_init_schema;
137    pub use crate::infrastructure::persistence::{
138        StoreProvider, in_memory_empty_im_provider, in_memory_im_provider,
139    };
140    pub use crate::infrastructure::protocol::{
141        Codec, DownlinkPayload, PacketSender, ProtobufCodec,
142    };
143    pub use crate::infrastructure::transport::{
144        HttpApiResponse, HttpClient, HttpRequestContext, unwrap_api_response,
145        unwrap_void_api_response,
146    };
147    pub use crate::kernel::event::{
148        ConnectionEvent, ConnectionEventType, ConversationEvent, ConversationEventType,
149        CustomEventDefinition, CustomEventSelector, EventBus, EventFilter, EventReceiver,
150        ExtensionEvent, ExtensionEventType, FilteredEventReceiver, MessageEvent, MessageEventType,
151        NotificationEvent, NotificationEventType, PublishOutcome, RawSdkEvent, SdkEvent,
152        SdkEventKind, SdkEventType, SharedEventReceiver, Subscription, SyncEventType, SyncNotify,
153        SyncPhase,
154    };
155    pub use crate::kernel::{SdkState, SyncRunContext, SyncScope, SyncTrigger, SyncVisibility};
156    pub use crate::model::{
157        Conversation, ConversationSummary, IMMessage, MediaDestinationDescriptor,
158        MediaDestinationKind, MessageStatus, MessageType, RenderableMedia, RenderableMediaKind,
159        SendAck, UploadedMedia,
160    };
161    pub use crate::platform::ports::media::{
162        MediaByteStream, MediaDeliverMeta, MediaDeliveryResult, MediaHost, MediaHttp,
163        MediaHttpRequest, MediaHttpResponse, MediaMetadata, MediaProfile, MediaServicePort,
164        MediaSink, MediaSinkCapabilities, MediaSourceDescriptor, MediaSourceKind,
165        MediaSourceReader, MediaTranscoder, TranscodedMedia,
166    };
167    pub use crate::platform::ports::storage::{
168        LOCAL_DATABASE_KEY_BYTES, SecureKeyDescriptor, SecureKeyStore, SecureSecret,
169        VolatileSecureKeyStore, load_or_create_local_database_key, validate_local_database_key,
170    };
171    pub use crate::platform::{
172        MediaRuntimeConfig, MediaRuntimeKind, NativeRuntimeAssembler, PlatformKind,
173        RuntimeAssembler, RuntimeComponents, RuntimeConfig, StorageConfig, StorageEncryptionConfig,
174        StorageKind,
175    };
176    pub use crate::plugin::{
177        SdkCapabilityPlugin, SdkCapabilityRegistry, SdkPluginEventManifest, SdkPluginManifest,
178        SdkPluginOperationManifest, SdkPluginPermissionManifest, SdkPluginUiKitManifest,
179    };
180    pub use crate::shared::error::{ErrorCode, FlareError, Result};
181    #[cfg(feature = "lifecycle-sqlite")]
182    pub use crate::shared::util::sqlite_store::ensure_core_sqlite_schema_registered;
183    pub use crate::shared::util::{generate_core_token, resolve_user_db_path};
184    #[cfg(feature = "lifecycle-sqlite")]
185    pub use crate::shared::util::{
186        open_sqlite_store_for_user_with_secure_key_store,
187        sqlite_security_config_from_secure_key_store,
188    };
189    pub use crate::spi::metrics::{
190        HistogramSnapshot, InMemoryMetricsSink, MetricLabel, MetricsRecorder, MetricsSink,
191        MetricsSnapshot,
192    };
193}