openlark_analytics/lib.rs
1//! # OpenLark 数据分析模块
2//!
3//! OpenLark SDK 的数据分析模块，提供飞书数据分析和搜索相关 API 的完整访问。
4//!
5//! ## 功能特性
6//!
7//! - **搜索服务**: 全文搜索、智能搜索、内容检索
8//! - **数据分析**: 数据报表、统计分析、趋势分析
9//!
10//! ## 模块组织
11//!
12//! 本模块按业务域（bizTag）组织：
13//! - `search` - 搜索服务相关 API (14 APIs)
14//!
15//! ## 使用示例
16//!
17//! ```rust,no_run
18//! use openlark_analytics::AnalyticsService;
19//! use openlark_core::prelude::Config;
20//!
21//! # async fn example() -> Result<(), Box<dyn std::error::Error>> {
22//! // 使用 builder 模式创建配置
23//! let config = Config::builder()
24//! .app_id("app_id")
25//! .app_secret("app_secret")
26//! .build();
27//!
28//! let _analytics_service = AnalyticsService::new(config);
29//!
30//! # Ok(())
31//! # }
32//! ```
33
34#![allow(clippy::module_inception)]
35
36mod service;
37
38// 通用模块
39pub mod common;
40/// 报告模块。
41pub mod report;
42
43// 业务域模块
44#[cfg(feature = "search")]
45pub mod search;
46
47// Prelude 模块
48pub mod prelude;
49
50// 重新导出核心服务
51pub use service::AnalyticsService;
52
53/// 数据分析服务客户端类型别名（统一命名为 `XxxClient`）。
54pub type AnalyticsClient = AnalyticsService;
55pub use openlark_core::config::Config;
56
57/// 数据分析模块版本信息
58pub const VERSION: &str = env!("CARGO_PKG_VERSION");
59
60/// 数据分析服务配置别名
61pub type AnalyticsConfig = Config;
62
63#[cfg(test)]
64#[allow(unused_imports)]
65mod tests {
66 use super::*;
67
68 #[test]
69 fn test_version() {
70 assert_ne!(VERSION, "");
71 }
72
73 #[test]
74 fn test_module_composition() {
75 // 验证模块组织正确
76 assert_eq!(VERSION, env!("CARGO_PKG_VERSION"));
77 }
78}