openlark-docs 0.16.0

飞书开放平台云文档服务模块 - 文档、表格、知识库API (202 APIs, 100% 覆盖,不含旧版本)
Documentation
//! Bitable 新增视图
//!
//! docPath: https://open.feishu.cn/document/server-docs/docs/bitable-v1/app-table-view/create

use openlark_core::{
    api::{ApiRequest, ApiResponseTrait, ResponseFormat},
    config::Config,
    error::SDKResult,
    http::Transport,
    req_option::RequestOption,
    validate_required,
};
use serde::{Deserialize, Serialize};

// 从 patch 模块导入 View 类型
use super::patch::View;

/// 新增视图请求
///
/// 用于在多维表格的数据表中创建新视图。
///
/// # 字段说明
///
/// - `app_token`: 多维表格的 app_token
/// - `table_id`: 数据表的 table_id
/// - `view`: 视图信息,包含视图名称和类型
///
/// # 示例
///
/// ```rust,ignore
/// use openlark_docs::base::bitable::v1::app::table::view::create::{CreateViewRequest, CreateViewData};
/// use openlark_core::Config;
///
/// let config = Config::default();
/// let view_data = CreateViewData::grid_view("我的表格视图");
/// let request = CreateViewRequest::new(config)
///     .app_token("app_token_xyz".to_string())
///     .table_id("table_id_xyz".to_string())
///     .view(view_data);
/// ```
#[derive(Debug, Clone)]
pub struct CreateViewRequest {
    /// 配置信息
    config: Config,
    /// 多维表格的 app_token
    app_token: String,
    /// 数据表的 table_id
    table_id: String,
    /// 视图信息
    view: CreateViewData,
}

impl CreateViewRequest {
    /// 创建新的视图创建请求。
    pub fn new(config: Config) -> Self {
        Self {
            config,
            app_token: String::new(),
            table_id: String::new(),
            view: CreateViewData::default(),
        }
    }

    /// 设置多维表格 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
    }

    /// 设置视图信息。
    pub fn view(mut self, view: CreateViewData) -> Self {
        self.view = view;
        self
    }

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

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

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

        if self.view.view_name.trim().is_empty() {
            return Err(openlark_core::error::validation_error(
                "view.view_name",
                "视图名称不能为空",
            ));
        }

        // === 业务规则验证 ===
        if self.view.view_name.len() > 100 {
            return Err(openlark_core::error::validation_error(
                "view.view_name",
                "视图名称长度不能超过100个字符",
            ));
        }

        // 视图名称不能包含 [ ]
        if self.view.view_name.contains('[') || self.view.view_name.contains(']') {
            return Err(openlark_core::error::validation_error(
                "view.view_name",
                "视图名称不能包含 '[' 或 ']'",
            ));
        }

        // === 枚举值验证 ===
        // 验证视图类型
        if let Some(ref view_type) = self.view.view_type {
            let valid_types = ["grid", "kanban", "gallery", "gantt", "form"];
            if !valid_types.contains(&view_type.as_str()) {
                return Err(openlark_core::error::validation_error(
                    "view.view_type",
                    "视图类型必须是以下之一: grid, kanban, gallery, gantt, form",
                ));
            }
        }

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

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

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

#[derive(Serialize, Default, Debug, Clone)]
/// 视图数据
pub struct CreateViewData {
    /// 视图名称
    pub view_name: String,
    /// 视图类型,可选值:grid (表格视图)、kanban (看板视图)、gallery (画册视图)、gantt (甘特视图)
    pub view_type: Option<String>,
}

impl CreateViewData {
    /// 创建仅包含名称的视图配置。
    pub fn new(view_name: impl ToString) -> Self {
        Self {
            view_name: view_name.to_string(),
            view_type: None,
        }
    }

    /// 创建表格视图
    pub fn grid_view(view_name: impl ToString) -> Self {
        Self {
            view_name: view_name.to_string(),
            view_type: Some("grid".to_string()),
        }
    }

    /// 创建看板视图
    pub fn kanban_view(view_name: impl ToString) -> Self {
        Self {
            view_name: view_name.to_string(),
            view_type: Some("kanban".to_string()),
        }
    }

    /// 创建画册视图
    pub fn gallery_view(view_name: impl ToString) -> Self {
        Self {
            view_name: view_name.to_string(),
            view_type: Some("gallery".to_string()),
        }
    }

    /// 创建甘特视图
    pub fn gantt_view(view_name: impl ToString) -> Self {
        Self {
            view_name: view_name.to_string(),
            view_type: Some("gantt".to_string()),
        }
    }

    /// 设置视图类型。
    pub fn with_view_type(mut self, view_type: impl ToString) -> Self {
        self.view_type = Some(view_type.to_string());
        self
    }
}

/// 创建视图响应。
#[derive(Debug, Clone, Serialize, Deserialize, PartialEq)]
pub struct CreateViewResponse {
    /// 视图信息
    pub view: View,
}

impl ApiResponseTrait for CreateViewResponse {
    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 view_data = CreateViewData::grid_view("测试视图");
        let request = CreateViewRequest::new(config)
            .app_token("".to_string())
            .table_id("table_id".to_string())
            .view(view_data);

        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") || err.to_string().contains("app_token"));
    }

    #[test]
    fn test_empty_table_id() {
        let config = Config::default();
        let view_data = CreateViewData::grid_view("测试视图");
        let request = CreateViewRequest::new(config)
            .app_token("app_token".to_string())
            .table_id("".to_string())
            .view(view_data);

        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_view_name() {
        let config = Config::default();
        let view_data = CreateViewData {
            view_name: "".to_string(),
            view_type: Some("grid".to_string()),
        };
        let request = CreateViewRequest::new(config)
            .app_token("app_token".to_string())
            .table_id("table_id".to_string())
            .view(view_data);

        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("view_name"));
    }

    #[test]
    fn test_view_name_too_long() {
        let config = Config::default();
        let long_name = "a".repeat(101);
        let view_data = CreateViewData {
            view_name: long_name,
            view_type: Some("grid".to_string()),
        };
        let request = CreateViewRequest::new(config)
            .app_token("app_token".to_string())
            .table_id("table_id".to_string())
            .view(view_data);

        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("100"));
    }

    #[test]
    fn test_invalid_view_type() {
        let config = Config::default();
        let view_data = CreateViewData {
            view_name: "测试视图".to_string(),
            view_type: Some("invalid_type".to_string()),
        };
        let request = CreateViewRequest::new(config)
            .app_token("app_token".to_string())
            .table_id("table_id".to_string())
            .view(view_data);

        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("view_type"));
    }

    #[test]
    fn test_view_name_with_brackets() {
        let config = Config::default();
        let view_data = CreateViewData {
            view_name: "测试[视图]".to_string(),
            view_type: Some("grid".to_string()),
        };
        let request = CreateViewRequest::new(config)
            .app_token("app_token".to_string())
            .table_id("table_id".to_string())
            .view(view_data);

        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("[") || err.to_string().contains("]"));
    }
}