openlark-docs 0.17.0

//! Bitable 新增字段
//!
//! docPath: https://open.feishu.cn/document/server-docs/docs/bitable-v1/app-table-field/create

use openlark_core::{
    api::{ApiRequest, ApiResponseTrait, ResponseFormat},
    config::Config,
    error::SDKResult,
    http::Transport,
    validate_required,
};
use serde::{Deserialize, Serialize};
use serde_json::Value;
use serde_repr::{Deserialize_repr, Serialize_repr};

/// 字段类型枚举
#[derive(Debug, Clone, Copy, PartialEq, Eq, Serialize_repr, Deserialize_repr)]
#[repr(i32)]
pub enum FieldType {
    /// 文本。
    Text = 1,
    /// 数字。
    Number = 2,
    /// 单选。
    SingleSelect = 3,
    /// 多选。
    MultiSelect = 4,
    /// 日期时间。
    DateTime = 5,
    /// 复选框。
    Checkbox = 7,
    /// 用户。
    User = 11,
    /// 电话号码。
    PhoneNumber = 13,
    /// 链接。
    Url = 15,
    /// 附件。
    Attachment = 17,
    /// 关联记录。
    Link = 18,
    /// 公式。
    Formula = 20,
    /// 双向关联。
    DuplexLink = 21,
    /// 地点。
    Location = 22,
    /// 群聊。
    GroupChat = 23,
    /// 创建时间。
    CreatedTime = 1001,
    /// 修改时间。
    ModifiedTime = 1002,
    /// 创建人。
    CreatedUser = 1003,
    /// 修改人。
    ModifiedUser = 1004,
    /// 自动编号。
    AutoNumber = 1005,
}

/// 字段属性
pub type FieldProperty = Value;

/// 创建字段请求
///
/// 用于在多维表格数据表中创建新字段。
///
/// # 字段说明
///
/// - `app_token`: 多维表格的 app_token
/// - `table_id`: 数据表的 table_id
/// - `client_token`: 格式为标准的 uuidv4，操作的唯一标识，用于幂等的进行更新操作（可选）
/// - `field_name`: 多维表格字段名
/// - `type`: 多维表格字段类型
/// - `property`: 字段属性（可选）
/// - `description`: 字段的描述（可选）
/// - `ui_type`: 字段在界面上的展示类型（可选）
///
/// # 示例
///
/// ```rust,ignore
/// use openlark_docs::base::bitable::v1::app::table::field::create::{CreateFieldRequest, FieldType};
/// use openlark_core::Config;
///
/// let config = Config::default();
/// let request = CreateFieldRequest::new(config)
///     .app_token("app_token_xyz".to_string())
///     .table_id("table_id_xyz".to_string())
///     .field_name("任务名称".to_string())
///     .field_type(FieldType::Text);
/// ```
#[derive(Debug, Clone)]
pub struct CreateFieldRequest {
    /// 配置信息
    config: Config,
    /// 多维表格的 app_token
    app_token: String,
    /// 数据表的 table_id
    table_id: String,
    /// 格式为标准的 uuidv4，操作的唯一标识，用于幂等的进行更新操作
    client_token: Option<String>,
    /// 多维表格字段名
    field_name: String,
    /// 多维表格字段类型
    r#type: FieldType,
    /// 字段属性
    property: Option<FieldProperty>,
    /// 字段的描述
    description: Option<Value>,
    /// 字段在界面上的展示类型
    ui_type: Option<String>,
}

impl CreateFieldRequest {
    /// 创建新的字段创建请求。
    pub fn new(config: Config) -> Self {
        Self {
            config,
            app_token: String::new(),
            table_id: String::new(),
            client_token: None,
            field_name: String::new(),
            r#type: FieldType::Text,
            property: None,
            description: None,
            ui_type: None,
        }
    }

    /// 设置多维表格 token。
    pub fn app_token(mut self, app_token: String) -> Self {
        self.app_token = app_token;
        self
    }

    /// 设置数据表 ID。
    pub fn table_id(mut self, table_id: String) -> Self {
        self.table_id = table_id;
        self
    }

    /// 设置客户端幂等 token。
    pub fn client_token(mut self, client_token: String) -> Self {
        self.client_token = Some(client_token);
        self
    }

    /// 设置字段名称。
    pub fn field_name(mut self, field_name: String) -> Self {
        self.field_name = field_name;
        self
    }

    /// 设置字段类型。
    pub fn field_type(mut self, field_type: FieldType) -> Self {
        self.r#type = field_type;
        self
    }

    /// 设置字段属性。
    pub fn property(mut self, property: FieldProperty) -> Self {
        self.property = Some(property);
        self
    }

    /// 设置字段描述。
    pub fn description(mut self, description: Value) -> Self {
        self.description = Some(description);
        self
    }

    /// 设置界面类型。
    pub fn ui_type(mut self, ui_type: String) -> Self {
        self.ui_type = Some(ui_type);
        self
    }

    /// 执行请求。
    pub async fn execute(self) -> SDKResult<CreateFieldResponse> {
        self.execute_with_options(openlark_core::req_option::RequestOption::default())
            .await
    }

    /// 使用指定请求选项执行请求。
    pub async fn execute_with_options(
        self,
        option: openlark_core::req_option::RequestOption,
    ) -> SDKResult<CreateFieldResponse> {
        // === 必填字段验证 ===
        validate_required!(self.app_token.trim(), "app_token");

        validate_required!(self.table_id.trim(), "table_id");

        validate_required!(self.field_name.trim(), "field_name");

        // 🚀 使用新的enum+builder系统生成API端点
        // 替代传统的字符串拼接方式，提供类型安全和IDE自动补全
        use crate::common::api_endpoints::BitableApiV1;
        let api_endpoint = BitableApiV1::FieldCreate(self.app_token.clone(), self.table_id.clone());

        // 构建请求体
        let body = CreateFieldRequestBody {
            field_name: self.field_name,
            r#type: self.r#type,
            property: self.property,
            description: self.description,
            ui_type: self.ui_type,
        };

        // 创建API请求 - 使用类型安全的URL生成
        let mut api_request: ApiRequest<CreateFieldResponse> =
            ApiRequest::post(&api_endpoint.to_url()).body(serde_json::to_vec(&body)?);

        // 构建查询参数
        api_request = api_request.query_opt("client_token", self.client_token);

        // 发送请求
        let response = Transport::request(api_request, &self.config, Some(option)).await?;
        response.data.ok_or_else(|| {
            openlark_core::error::validation_error("响应数据为空", "服务器没有返回有效的数据")
        })
    }
}

/// 字段信息
#[derive(Debug, Clone, Serialize, Deserialize, PartialEq)]
pub struct Field {
    /// 字段名称
    pub field_name: String,
    /// 字段类型
    #[serde(rename = "type")]
    pub field_type: i32,
    /// 字段属性，不同字段类型对应不同的属性结构
    #[serde(skip_serializing_if = "Option::is_none")]
    pub property: Option<Value>,
    /// 字段描述（可能是 string/array/object，受 text_field_as_array 影响）
    #[serde(skip_serializing_if = "Option::is_none")]
    pub description: Option<Value>,
    /// 是否是索引列
    pub is_primary: bool,
    /// 字段 ID
    pub field_id: String,
    /// 字段在界面上的展示类型
    #[serde(skip_serializing_if = "Option::is_none")]
    pub ui_type: Option<String>,
    /// 是否是隐藏字段
    pub is_hidden: bool,
}

/// 请求体结构
#[derive(Serialize)]
struct CreateFieldRequestBody {
    field_name: String,
    r#type: FieldType,
    property: Option<FieldProperty>,
    description: Option<Value>,
    ui_type: Option<String>,
}

/// 创建字段响应
#[derive(Debug, Clone, Serialize, Deserialize, PartialEq)]
pub struct CreateFieldResponse {
    /// 字段信息
    pub field: Field,
}

impl ApiResponseTrait for CreateFieldResponse {
    fn data_format() -> ResponseFormat {
        ResponseFormat::Data
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use openlark_core::testing::prelude::test_runtime;

    #[test]
    fn test_empty_app_token() {
        let config = Config::default();
        let request = CreateFieldRequest::new(config)
            .app_token("".to_string())
            .table_id("table_id".to_string())
            .field_name("字段名".to_string());

        let rt = test_runtime();
        let result = rt.block_on(request.execute());

        assert!(result.is_err());
        let err = result.unwrap_err();
        assert!(err.to_string().contains("app_token"));
    }

    #[test]
    fn test_empty_table_id() {
        let config = Config::default();
        let request = CreateFieldRequest::new(config)
            .app_token("app_token".to_string())
            .table_id("".to_string())
            .field_name("字段名".to_string());

        let rt = test_runtime();
        let result = rt.block_on(request.execute());

        assert!(result.is_err());
        let err = result.unwrap_err();
        assert!(err.to_string().contains("table_id"));
    }

    #[test]
    fn test_empty_field_name() {
        let config = Config::default();
        let request = CreateFieldRequest::new(config)
            .app_token("app_token".to_string())
            .table_id("table_id".to_string())
            .field_name("".to_string());

        let rt = test_runtime();
        let result = rt.block_on(request.execute());

        assert!(result.is_err());
        let err = result.unwrap_err();
        assert!(err.to_string().contains("field_name"));
    }

    #[test]
    fn test_create_field_request_builder() {
        let config = Config::default();
        let request = CreateFieldRequest::new(config)
            .app_token("app_token".to_string())
            .table_id("table_id".to_string())
            .field_name("任务名称".to_string())
            .field_type(FieldType::Text);

        assert_eq!(request.app_token, "app_token");
        assert_eq!(request.table_id, "table_id");
        assert_eq!(request.field_name, "任务名称");
        assert_eq!(request.r#type, FieldType::Text);
    }

    #[test]
    fn test_field_type_variants() {
        assert_eq!(FieldType::Text as i32, 1);
        assert_eq!(FieldType::Number as i32, 2);
        assert_eq!(FieldType::SingleSelect as i32, 3);
        assert_eq!(FieldType::MultiSelect as i32, 4);
        assert_eq!(FieldType::DateTime as i32, 5);
        assert_eq!(FieldType::Checkbox as i32, 7);
        assert_eq!(FieldType::User as i32, 11);
        assert_eq!(FieldType::PhoneNumber as i32, 13);
        assert_eq!(FieldType::Url as i32, 15);
        assert_eq!(FieldType::Attachment as i32, 17);
        assert_eq!(FieldType::Link as i32, 18);
        assert_eq!(FieldType::Formula as i32, 20);
        assert_eq!(FieldType::DuplexLink as i32, 21);
        assert_eq!(FieldType::Location as i32, 22);
        assert_eq!(FieldType::GroupChat as i32, 23);
        assert_eq!(FieldType::CreatedTime as i32, 1001);
        assert_eq!(FieldType::ModifiedTime as i32, 1002);
        assert_eq!(FieldType::CreatedUser as i32, 1003);
        assert_eq!(FieldType::ModifiedUser as i32, 1004);
        assert_eq!(FieldType::AutoNumber as i32, 1005);
    }
}