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
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
use anyhow::Result;
use spreadsheet_kit::model::{LayoutMode, LayoutRender, WorkbookId};
use spreadsheet_kit::tools::{LayoutPageParams, ListWorkbooksParams, layout_page, list_workbooks};
use std::sync::Arc;

mod support;

fn app_state(workspace: &support::TestWorkspace) -> Arc<spreadsheet_kit::state::AppState> {
    workspace.app_state()
}

async fn first_workbook_id(state: Arc<spreadsheet_kit::state::AppState>) -> Result<WorkbookId> {
    let list = list_workbooks(
        state,
        ListWorkbooksParams {
            slug_prefix: None,
            folder: None,
            path_glob: None,
            limit: None,
            offset: None,
            include_paths: None,
        },
    )
    .await?;
    Ok(list.workbooks[0].workbook_id.clone())
}

// ── column widths ─────────────────────────────────────────────────────────────

#[tokio::test(flavor = "current_thread")]
async fn layout_page_returns_column_widths() -> Result<()> {
    let workspace = support::TestWorkspace::new();
    workspace.create_workbook("widths.xlsx", |book| {
        let sheet = book.get_sheet_by_name_mut("Sheet1").unwrap();
        sheet.get_cell_mut("A1").set_value("Label");
        sheet.get_cell_mut("B1").set_value("Value");
        sheet.get_column_dimension_mut("A").set_width(28.0);
        sheet.get_column_dimension_mut("B").set_width(12.0);
    });

    let state = app_state(&workspace);
    let workbook_id = first_workbook_id(state.clone()).await?;
    let resp = layout_page(
        state,
        LayoutPageParams {
            workbook_or_fork_id: workbook_id,
            sheet_name: "Sheet1".to_string(),
            range: Some("A1:B1".to_string()),
            mode: None,
            max_col_width: None,
            fit_columns: None,
            trim_empty_columns: Some(false),
            render: None,
        },
    )
    .await?;

    assert_eq!(resp.columns.len(), 2);
    assert_eq!(resp.columns[0].col, "A");
    // 28.0 > default max_col_width of 20, so capped at 20
    assert_eq!(resp.columns[0].width_chars, 20.0);
    assert!(!resp.columns[0].is_default_width);
    assert_eq!(resp.columns[1].col, "B");
    assert_eq!(resp.columns[1].width_chars, 12.0);
    assert!(!resp.columns[1].is_default_width);
    Ok(())
}

#[tokio::test(flavor = "current_thread")]
async fn layout_page_default_width_for_unset_column() -> Result<()> {
    let workspace = support::TestWorkspace::new();
    workspace.create_workbook("default_width.xlsx", |book| {
        let sheet = book.get_sheet_by_name_mut("Sheet1").unwrap();
        sheet.get_cell_mut("A1").set_value("x");
        // No explicit column width set
    });

    let state = app_state(&workspace);
    let workbook_id = first_workbook_id(state.clone()).await?;
    let resp = layout_page(
        state,
        LayoutPageParams {
            workbook_or_fork_id: workbook_id,
            sheet_name: "Sheet1".to_string(),
            range: Some("A1:A1".to_string()),
            mode: None,
            max_col_width: None,
            fit_columns: None,
            trim_empty_columns: Some(false),
            render: None,
        },
    )
    .await?;

    assert_eq!(resp.columns.len(), 1);
    // Default Excel column width is 8.43 chars — well under max_col_width cap of 20
    // is_default_width may be true or false depending on xlsx round-trip,
    // but the width should always be at or near 8.43.
    assert!(
        resp.columns[0].width_chars <= 20.0,
        "width should not exceed max_col_width: {}",
        resp.columns[0].width_chars
    );
    // No explicit wide width was set
    assert!(
        resp.columns[0].width_chars <= 12.0,
        "default width should be under 12 chars, got: {}",
        resp.columns[0].width_chars
    );
    Ok(())
}

// ── bold and italic ───────────────────────────────────────────────────────────

#[tokio::test(flavor = "current_thread")]
async fn layout_page_detects_bold_and_italic() -> Result<()> {
    let workspace = support::TestWorkspace::new();
    workspace.create_workbook("font.xlsx", |book| {
        let sheet = book.get_sheet_by_name_mut("Sheet1").unwrap();
        sheet.get_cell_mut("A1").set_value("Bold");
        sheet.get_style_mut("A1").get_font_mut().set_bold(true);

        sheet.get_cell_mut("B1").set_value("Italic");
        sheet.get_style_mut("B1").get_font_mut().set_italic(true);

        sheet.get_cell_mut("C1").set_value("Plain");
    });

    let state = app_state(&workspace);
    let workbook_id = first_workbook_id(state.clone()).await?;
    let resp = layout_page(
        state,
        LayoutPageParams {
            workbook_or_fork_id: workbook_id,
            sheet_name: "Sheet1".to_string(),
            range: Some("A1:C1".to_string()),
            mode: None,
            max_col_width: None,
            fit_columns: None,
            trim_empty_columns: Some(false),
            render: None,
        },
    )
    .await?;

    assert_eq!(resp.rows.len(), 1);
    let cells = &resp.rows[0].cells;
    assert_eq!(cells[0].bold, Some(true), "A1 should be bold");
    assert_eq!(cells[0].italic, None);
    assert_eq!(cells[1].bold, None);
    assert_eq!(cells[1].italic, Some(true), "B1 should be italic");
    assert_eq!(cells[2].bold, None);
    assert_eq!(cells[2].italic, None);
    Ok(())
}

// ── borders ───────────────────────────────────────────────────────────────────

#[tokio::test(flavor = "current_thread")]
async fn layout_page_captures_border_styles() -> Result<()> {
    let workspace = support::TestWorkspace::new();
    workspace.create_workbook("borders.xlsx", |book| {
        let sheet = book.get_sheet_by_name_mut("Sheet1").unwrap();
        sheet.get_cell_mut("A1").set_value("Total");
        sheet
            .get_style_mut("A1")
            .get_borders_mut()
            .get_bottom_border_mut()
            .set_border_style("medium");
        sheet
            .get_style_mut("A1")
            .get_borders_mut()
            .get_top_border_mut()
            .set_border_style("thin");
    });

    let state = app_state(&workspace);
    let workbook_id = first_workbook_id(state.clone()).await?;
    let resp = layout_page(
        state,
        LayoutPageParams {
            workbook_or_fork_id: workbook_id,
            sheet_name: "Sheet1".to_string(),
            range: Some("A1:A1".to_string()),
            mode: None,
            max_col_width: None,
            fit_columns: None,
            trim_empty_columns: Some(false),
            render: None,
        },
    )
    .await?;

    let cell = &resp.rows[0].cells[0];
    let borders = cell.borders.as_ref().expect("borders should be present");
    assert_eq!(borders.bottom.as_deref(), Some("medium"));
    assert_eq!(borders.top.as_deref(), Some("thin"));
    assert!(borders.left.is_none());
    assert!(borders.right.is_none());
    Ok(())
}

#[tokio::test(flavor = "current_thread")]
async fn layout_page_no_borders_on_plain_cell() -> Result<()> {
    let workspace = support::TestWorkspace::new();
    workspace.create_workbook("no_borders.xlsx", |book| {
        let sheet = book.get_sheet_by_name_mut("Sheet1").unwrap();
        sheet.get_cell_mut("A1").set_value("plain");
    });

    let state = app_state(&workspace);
    let workbook_id = first_workbook_id(state.clone()).await?;
    let resp = layout_page(
        state,
        LayoutPageParams {
            workbook_or_fork_id: workbook_id,
            sheet_name: "Sheet1".to_string(),
            range: Some("A1:A1".to_string()),
            mode: None,
            max_col_width: None,
            fit_columns: None,
            trim_empty_columns: Some(false),
            render: None,
        },
    )
    .await?;

    let cell = &resp.rows[0].cells[0];
    assert!(cell.borders.is_none(), "plain cell should have no borders");
    Ok(())
}

// ── merged cells ──────────────────────────────────────────────────────────────

#[tokio::test(flavor = "current_thread")]
async fn layout_page_reports_merged_cells() -> Result<()> {
    let workspace = support::TestWorkspace::new();
    workspace.create_workbook("merged.xlsx", |book| {
        let sheet = book.get_sheet_by_name_mut("Sheet1").unwrap();
        sheet.get_cell_mut("B1").set_value("Header");
        sheet.add_merge_cells("B1:D1");
    });

    let state = app_state(&workspace);
    let workbook_id = first_workbook_id(state.clone()).await?;
    let resp = layout_page(
        state,
        LayoutPageParams {
            workbook_or_fork_id: workbook_id,
            sheet_name: "Sheet1".to_string(),
            range: Some("A1:E1".to_string()),
            mode: None,
            max_col_width: None,
            fit_columns: None,
            trim_empty_columns: Some(false),
            render: None,
        },
    )
    .await?;

    assert!(
        resp.merged_cells.contains(&"B1:D1".to_string()),
        "merged_cells should contain B1:D1, got: {:?}",
        resp.merged_cells
    );

    let b1 = resp.rows[0]
        .cells
        .iter()
        .find(|c| c.address == "B1")
        .unwrap();
    assert_eq!(
        b1.merge_start,
        Some(true),
        "B1 should be flagged merge_start"
    );

    let a1 = resp.rows[0]
        .cells
        .iter()
        .find(|c| c.address == "A1")
        .unwrap();
    assert_eq!(a1.merge_start, None, "A1 should not be merge_start");
    Ok(())
}

#[tokio::test(flavor = "current_thread")]
async fn layout_page_filters_merges_outside_range() -> Result<()> {
    let workspace = support::TestWorkspace::new();
    workspace.create_workbook("merge_filter.xlsx", |book| {
        let sheet = book.get_sheet_by_name_mut("Sheet1").unwrap();
        sheet.get_cell_mut("A1").set_value("x");
        // Merge far outside the render range
        sheet.add_merge_cells("Z1:AB1");
    });

    let state = app_state(&workspace);
    let workbook_id = first_workbook_id(state.clone()).await?;
    let resp = layout_page(
        state,
        LayoutPageParams {
            workbook_or_fork_id: workbook_id,
            sheet_name: "Sheet1".to_string(),
            range: Some("A1:B2".to_string()),
            mode: None,
            max_col_width: None,
            fit_columns: None,
            trim_empty_columns: Some(false),
            render: None,
        },
    )
    .await?;

    assert!(
        resp.merged_cells.is_empty(),
        "out-of-range merge should not appear: {:?}",
        resp.merged_cells
    );
    Ok(())
}

// ── formula mode ──────────────────────────────────────────────────────────────

#[tokio::test(flavor = "current_thread")]
async fn layout_page_formula_mode_returns_formula_text() -> Result<()> {
    let workspace = support::TestWorkspace::new();
    workspace.create_workbook("formulas.xlsx", |book| {
        let sheet = book.get_sheet_by_name_mut("Sheet1").unwrap();
        sheet.get_cell_mut("A1").set_value_number(10.0_f64);
        sheet.get_cell_mut("A2").set_value_number(20.0_f64);
        sheet.get_cell_mut("A3").set_formula("SUM(A1:A2)");
    });

    let state = app_state(&workspace);
    let workbook_id = first_workbook_id(state.clone()).await?;
    let resp = layout_page(
        state,
        LayoutPageParams {
            workbook_or_fork_id: workbook_id,
            sheet_name: "Sheet1".to_string(),
            range: Some("A1:A3".to_string()),
            mode: Some(LayoutMode::Formulas),
            max_col_width: None,
            fit_columns: None,
            trim_empty_columns: Some(false),
            render: None,
        },
    )
    .await?;

    // A1 and A2 are plain values
    assert_eq!(resp.rows[0].cells[0].value.as_deref(), Some("10"));
    assert_eq!(resp.rows[1].cells[0].value.as_deref(), Some("20"));
    // A3 is a formula — should start with '='
    let a3_val = resp.rows[2].cells[0].value.as_deref().unwrap_or("");
    assert!(
        a3_val.starts_with('='),
        "formula mode cell should start with '=', got: {a3_val}"
    );
    assert!(a3_val.contains("SUM"), "should contain SUM, got: {a3_val}");
    Ok(())
}

// ── range cap ─────────────────────────────────────────────────────────────────

#[tokio::test(flavor = "current_thread")]
async fn layout_page_caps_oversized_range() -> Result<()> {
    let workspace = support::TestWorkspace::new();
    workspace.create_workbook("big.xlsx", |book| {
        let sheet = book.get_sheet_by_name_mut("Sheet1").unwrap();
        sheet.get_cell_mut("A1").set_value("x");
    });

    let state = app_state(&workspace);
    let workbook_id = first_workbook_id(state.clone()).await?;
    // AX = column 50, 200 rows — both beyond the 80×25 cap
    let resp = layout_page(
        state,
        LayoutPageParams {
            workbook_or_fork_id: workbook_id,
            sheet_name: "Sheet1".to_string(),
            range: Some("A1:AX200".to_string()),
            mode: None,
            max_col_width: None,
            fit_columns: None,
            trim_empty_columns: Some(false),
            render: None,
        },
    )
    .await?;

    assert!(resp.truncated, "should be marked truncated");
    assert!(
        resp.rows.len() <= 80,
        "rows should be capped: {}",
        resp.rows.len()
    );
    assert!(
        resp.columns.len() <= 25,
        "cols should be capped: {}",
        resp.columns.len()
    );
    Ok(())
}

// ── ASCII render ───────────────────────────────────────────────────────────────

#[tokio::test(flavor = "current_thread")]
async fn layout_page_ascii_render_present_when_requested() -> Result<()> {
    let workspace = support::TestWorkspace::new();
    workspace.create_workbook("ascii.xlsx", |book| {
        let sheet = book.get_sheet_by_name_mut("Sheet1").unwrap();
        sheet.get_cell_mut("A1").set_value("Revenue");
        sheet.get_style_mut("A1").get_font_mut().set_bold(true);
        sheet.get_cell_mut("B1").set_value_number(1_000_000.0_f64);
    });

    let state = app_state(&workspace);
    let workbook_id = first_workbook_id(state.clone()).await?;
    let resp = layout_page(
        state,
        LayoutPageParams {
            workbook_or_fork_id: workbook_id,
            sheet_name: "Sheet1".to_string(),
            range: Some("A1:B1".to_string()),
            mode: None,
            max_col_width: None,
            fit_columns: None,
            trim_empty_columns: Some(false),
            render: Some(LayoutRender::Ascii),
        },
    )
    .await?;

    let ascii = resp.ascii_render.expect("ascii_render should be present");
    // Bold cell should produce * markers
    assert!(
        ascii.contains('*'),
        "bold cell should use * markers:\n{ascii}"
    );
    // Should use box-drawing chars for the grid frame
    assert!(
        ascii.contains('') || ascii.contains(''),
        "should contain box-drawing chars:\n{ascii}"
    );
    Ok(())
}

#[tokio::test(flavor = "current_thread")]
async fn layout_page_json_render_no_ascii_by_default() -> Result<()> {
    let workspace = support::TestWorkspace::new();
    workspace.create_workbook("no_ascii.xlsx", |book| {
        let sheet = book.get_sheet_by_name_mut("Sheet1").unwrap();
        sheet.get_cell_mut("A1").set_value("x");
    });

    let state = app_state(&workspace);
    let workbook_id = first_workbook_id(state.clone()).await?;
    let resp = layout_page(
        state,
        LayoutPageParams {
            workbook_or_fork_id: workbook_id,
            sheet_name: "Sheet1".to_string(),
            range: Some("A1:A1".to_string()),
            mode: None,
            max_col_width: None,
            fit_columns: None,
            trim_empty_columns: Some(false),
            render: None, // default = json
        },
    )
    .await?;

    assert!(
        resp.ascii_render.is_none(),
        "ascii_render should be None for default json render"
    );
    Ok(())
}

#[tokio::test(flavor = "current_thread")]
async fn layout_page_both_render_returns_json_and_ascii() -> Result<()> {
    let workspace = support::TestWorkspace::new();
    workspace.create_workbook("both.xlsx", |book| {
        let sheet = book.get_sheet_by_name_mut("Sheet1").unwrap();
        sheet.get_cell_mut("A1").set_value("x");
    });

    let state = app_state(&workspace);
    let workbook_id = first_workbook_id(state.clone()).await?;
    let resp = layout_page(
        state,
        LayoutPageParams {
            workbook_or_fork_id: workbook_id,
            sheet_name: "Sheet1".to_string(),
            range: Some("A1:A1".to_string()),
            mode: None,
            max_col_width: None,
            fit_columns: None,
            trim_empty_columns: Some(false),
            render: Some(LayoutRender::Both),
        },
    )
    .await?;

    assert!(
        resp.ascii_render.is_some(),
        "ascii_render should be present for render=both"
    );
    assert!(!resp.columns.is_empty());
    assert!(!resp.rows.is_empty());
    Ok(())
}

// ── max_col_width cap ─────────────────────────────────────────────────────────

#[tokio::test(flavor = "current_thread")]
async fn layout_page_max_col_width_caps_wide_columns() -> Result<()> {
    let workspace = support::TestWorkspace::new();
    workspace.create_workbook("wide.xlsx", |book| {
        let sheet = book.get_sheet_by_name_mut("Sheet1").unwrap();
        sheet.get_cell_mut("A1").set_value("x");
        sheet.get_column_dimension_mut("A").set_width(60.0);
    });

    let state = app_state(&workspace);
    let workbook_id = first_workbook_id(state.clone()).await?;
    let resp = layout_page(
        state,
        LayoutPageParams {
            workbook_or_fork_id: workbook_id,
            sheet_name: "Sheet1".to_string(),
            range: Some("A1:A1".to_string()),
            mode: None,
            max_col_width: Some(15),
            fit_columns: None,
            trim_empty_columns: Some(false),
            render: None,
        },
    )
    .await?;

    assert_eq!(
        resp.columns[0].width_chars, 15.0,
        "width should be capped at 15"
    );
    Ok(())
}

// ── alignment ─────────────────────────────────────────────────────────────────

#[tokio::test(flavor = "current_thread")]
async fn layout_page_captures_explicit_alignment() -> Result<()> {
    let workspace = support::TestWorkspace::new();
    workspace.create_workbook("align.xlsx", |book| {
        let sheet = book.get_sheet_by_name_mut("Sheet1").unwrap();
        sheet.get_cell_mut("A1").set_value("centered");
        sheet
            .get_style_mut("A1")
            .get_alignment_mut()
            .set_horizontal(umya_spreadsheet::HorizontalAlignmentValues::Center);
    });

    let state = app_state(&workspace);
    let workbook_id = first_workbook_id(state.clone()).await?;
    let resp = layout_page(
        state,
        LayoutPageParams {
            workbook_or_fork_id: workbook_id,
            sheet_name: "Sheet1".to_string(),
            range: Some("A1:A1".to_string()),
            mode: None,
            max_col_width: None,
            fit_columns: None,
            trim_empty_columns: Some(false),
            render: None,
        },
    )
    .await?;

    let cell = &resp.rows[0].cells[0];
    assert_eq!(cell.align_h.as_deref(), Some("center"));
    Ok(())
}