spreadsheet-kit 0.11.1

Core spreadsheet automation primitives — shared types, edit normalization, and session traits for agent-facing surfaces
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
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138

use anyhow::Result;
use spreadsheet_kit as spreadsheet_mcp;
use spreadsheet_mcp::tools::{
    ListWorkbooksParams, SheetOverviewParams, list_workbooks, sheet_overview,
};
use support::builders::{CellVal, fill_table};
use umya_spreadsheet::Spreadsheet;

mod support;

#[tokio::test(flavor = "current_thread")]
async fn sheet_overview_truncates_regions_and_sets_counts() -> Result<()> {
    let workspace = support::TestWorkspace::new();
    let _path = workspace.create_workbook("overview_truncate.xlsx", build_multi_region_workbook);
    let state = workspace.app_state();

    let workbook_id = list_workbooks(
        state.clone(),
        ListWorkbooksParams {
            slug_prefix: None,
            folder: None,
            path_glob: None,
            limit: None,
            offset: None,
            include_paths: None,
        },
    )
    .await?
    .workbooks
    .remove(0)
    .workbook_id;

    let overview = sheet_overview(
        state,
        SheetOverviewParams {
            workbook_or_fork_id: workbook_id,
            sheet_name: "Sheet1".to_string(),
            max_regions: Some(1),
            max_headers: None,
            include_headers: Some(true),
        },
    )
    .await?;

    assert_eq!(overview.detected_regions.len(), 1);
    assert!(overview.detected_regions_truncated);
    assert!(overview.detected_region_count > overview.detected_regions.len() as u32);
    assert!(
        overview
            .notes
            .iter()
            .any(|note| note.contains("Detected regions truncated"))
    );

    Ok(())
}

#[tokio::test(flavor = "current_thread")]
async fn sheet_overview_truncates_headers_and_sets_flags() -> Result<()> {
    let workspace = support::TestWorkspace::new();
    let _path = workspace.create_workbook("overview_headers.xlsx", build_wide_header_workbook);
    let state = workspace.app_state();

    let workbook_id = list_workbooks(
        state.clone(),
        ListWorkbooksParams {
            slug_prefix: None,
            folder: None,
            path_glob: None,
            limit: None,
            offset: None,
            include_paths: None,
        },
    )
    .await?
    .workbooks
    .remove(0)
    .workbook_id;

    let overview = sheet_overview(
        state,
        SheetOverviewParams {
            workbook_or_fork_id: workbook_id,
            sheet_name: "Sheet1".to_string(),
            max_regions: None,
            max_headers: Some(3),
            include_headers: Some(true),
        },
    )
    .await?;

    let region = overview.detected_regions.first().expect("region exists");
    assert_eq!(region.header_count, 8);
    assert_eq!(region.headers.len(), 3);
    assert!(region.headers_truncated);
    assert!(
        overview
            .notes
            .iter()
            .any(|note| note.contains("Region headers truncated"))
    );

    Ok(())
}

fn build_multi_region_workbook(book: &mut Spreadsheet) {
    let sheet = book.get_sheet_by_name_mut("Sheet1").unwrap();

    let headers = ["A", "B"];
    let rows = vec![
        vec![CellVal::Num(1.0), CellVal::Num(2.0)],
        vec![CellVal::Num(3.0), CellVal::Num(4.0)],
    ];
    fill_table(sheet, "A1", &headers, &rows);

    let rows_right = vec![
        vec![CellVal::Num(5.0), CellVal::Num(6.0)],
        vec![CellVal::Num(7.0), CellVal::Num(8.0)],
    ];
    fill_table(sheet, "F1", &headers, &rows_right);

    let rows_lower = vec![
        vec![CellVal::Num(9.0), CellVal::Num(10.0)],
        vec![CellVal::Num(11.0), CellVal::Num(12.0)],
    ];
    fill_table(sheet, "A7", &headers, &rows_lower);
}

fn build_wide_header_workbook(book: &mut Spreadsheet) {
    let sheet = book.get_sheet_by_name_mut("Sheet1").unwrap();

    let headers: Vec<String> = (1..=8).map(|i| format!("Col{}", i)).collect();
    let header_refs: Vec<&str> = headers.iter().map(|s| s.as_str()).collect();
    let row1: Vec<CellVal> = (1..=8).map(|i| CellVal::Num(i as f64)).collect();
    let row2: Vec<CellVal> = (1..=8).map(|i| CellVal::Num((i * 10) as f64)).collect();
    let rows = vec![row1, row2];
    fill_table(sheet, "A1", &header_refs, &rows);
}