openlark-workflow 0.17.0

OpenLark 工作流模块 - 提供飞书任务/审批/看板 API
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113

/// 通用模块
///
/// 提供openlark-workflow项目中通用的工具、宏和类型定义。
pub mod api_endpoints;
/// 工作流 API 通用辅助函数。
pub mod api_utils;
/// Board v1 新增端点。
pub mod board_v1_endpoints;
/// Task v2 新增端点。
pub mod task_v2_endpoints;

// 重新导出API端点枚举
pub use api_endpoints::TaskApiV2;
pub use board_v1_endpoints::BoardV1Endpoint;
pub use task_v2_endpoints::TaskV2Endpoint;

/// 通用常量定义
pub mod constants {
    /// 默认分页大小
    pub const DEFAULT_PAGE_SIZE: i32 = 20;
    /// 最大分页大小
    pub const MAX_PAGE_SIZE: i32 = 100;
}

/// 通用类型别名
pub mod types {
    /// 任务 GUID
    pub type TaskGuid = String;
    /// 任务清单 GUID
    pub type TasklistGuid = String;
    /// 分组 GUID
    pub type SectionGuid = String;
    /// 自定义字段 GUID
    pub type CustomFieldGuid = String;
    /// 评论 GUID
    pub type CommentGuid = String;
    /// 附件 GUID
    pub type AttachmentGuid = String;
}

#[cfg(test)]
#[allow(unused_imports)]
mod tests {
    use super::constants;
    use super::types;
    use super::{board_v1_endpoints::BoardV1Endpoint, task_v2_endpoints::TaskV2Endpoint};

    #[test]
    fn test_default_page_size() {
        assert_eq!(constants::DEFAULT_PAGE_SIZE, 20);
    }

    #[test]
    fn test_max_page_size() {
        assert_eq!(constants::MAX_PAGE_SIZE, 100);
    }

    #[test]
    fn test_task_guid_type() {
        let guid: types::TaskGuid = "test_guid".to_string();
        assert_eq!(guid, "test_guid");
    }

    #[test]
    fn test_tasklist_guid_type() {
        let guid: types::TasklistGuid = "test_tasklist".to_string();
        assert_eq!(guid, "test_tasklist");
    }

    #[test]
    fn test_section_guid_type() {
        let guid: types::SectionGuid = "test_section".to_string();
        assert_eq!(guid, "test_section");
    }

    #[test]
    fn test_custom_field_guid_type() {
        let guid: types::CustomFieldGuid = "test_field".to_string();
        assert_eq!(guid, "test_field");
    }

    #[test]
    fn test_comment_guid_type() {
        let guid: types::CommentGuid = "test_comment".to_string();
        assert_eq!(guid, "test_comment");
    }

    #[test]
    fn test_attachment_guid_type() {
        let guid: types::AttachmentGuid = "test_attachment".to_string();
        assert_eq!(guid, "test_attachment");
    }

    #[test]
    fn issue_194_split_endpoint_paths() {
        assert_eq!(
            BoardV1Endpoint::WhiteboardNodeBatchDelete("board_123".to_string()).to_url(),
            "/open-apis/board/v1/whiteboards/board_123/nodes/batch_delete"
        );
        assert_eq!(
            TaskV2Endpoint::TaskSetAncestorTask("task_123".to_string()).to_url(),
            "/open-apis/task/v2/tasks/task_123/set_ancestor_task"
        );
        assert_eq!(
            TaskV2Endpoint::ListRelatedTask.to_url(),
            "/open-apis/task/v2/task_v2/list_related_task"
        );
        assert_eq!(
            TaskV2Endpoint::TaskSubscription.to_url(),
            "/open-apis/task/v2/task_v2/task_subscription"
        );
    }
}