Skip to content

feat(documents): layout-aware PDF table extraction#940

Open
mimeding wants to merge 9 commits intoosaurus-ai:mainfrom
mimeding:feat/pdf-table-extraction
Open

feat(documents): layout-aware PDF table extraction#940
mimeding wants to merge 9 commits intoosaurus-ai:mainfrom
mimeding:feat/pdf-table-extraction

Conversation

@mimeding
Copy link
Copy Markdown
Contributor

@mimeding mimeding commented Apr 24, 2026

Stacked on #939, which carries #937/#936/#929/#927 until the lower document stack merges. This branch has been rebased onto current origin/main (fd2ffece, #1015). Reviewers should focus on the layout-aware PDF table extraction and the small strict-lint rebase cleanup; stale unrelated CI/tool-timeout commits were intentionally dropped during rebase.

Business rationale

PDFs are a core business file format, but flat text extraction turns invoices, statements, and financial reports into run-together numbers that agents cannot reliably reason about. Layout-aware table detection strengthens the local document harness by preserving row and column structure from PDFs while keeping the existing text fallback for chat display.

Coding rationale

The PDF adapter now emits a typed PDFDocumentRepresentation instead of a generic text wrapper so downstream tools can inspect pages and detected tables without parsing prose. Table detection is implemented as testable pure stages around glyph geometry rather than a PDFKit-only black box, which lets the heuristic be pinned with synthetic grids. Image-only PDFs still throw emptyContent so the existing legacy image-render fallback remains intact. The rebase keeps main's lean folder-tool surface and carries only the stacked document commits needed for review context.

What changed

Validation

  • git fetch origin && git rebase origin/main - completed after resolving Package.resolved, keeping main's lean folder tool list plus workbook tools only, and dropping stale unrelated CI/tool-timeout commits.
  • swift build --package-path Packages/OsaurusCore - passed after the final lint cleanup.
  • swift build --package-path Packages/OsaurusCore -c release - passed after the final lint cleanup.
  • swift test --package-path Packages/OsaurusCore - passed, 1505 tests in 202 suites, with sandbox integration tests skipped by their normal environment gate.
  • xcrun swift-format lint --strict on every touched Swift file - passed.
  • swiftlint lint --strict on every touched Swift file - passed file-by-file.
  • git diff --check origin/main...HEAD - passed.
  • CLI gate skipped because this slice does not touch Packages/OsaurusCLI.

Non-scope

  • No OCR for scanned/image-only PDFs.
  • No semantic table classification, currency/date normalization, or spreadsheet export.
  • No workbook, CSV, or structured attachment behavior beyond the stacked lower document commits.
  • No changes to the legacy image fallback path for PDFs without text layers.

Residual risks

PDF table extraction remains heuristic because PDFs do not carry native table semantics. Complex layouts with rotated text, nested tables, or heavily kerned columns may still need future tuning, but the detector is now isolated and covered so those improvements can land without changing the adapter contract.

mimeding and others added 9 commits May 3, 2026 20:13
…ntParser through the registry

Migrates the three ingress paths already handled by DocumentParser onto
the adapter surface introduced in the foundations PR, without changing
any user-observable behaviour. parseAll now consults the registry first
and falls back to its existing switch for anything an adapter hasn't
claimed or has declined — specifically image-only PDFs, which continue
to render via the legacy fallback until the layout-aware PDF rework
lands.

- PlainTextAdapter wraps the existing UTF-8 / ISO-Latin-1 retry path
  and the 500K-character truncation marker so the legacy behaviour
  stays byte-identical.
- PDFAdapter wraps PDFKit text extraction; it throws emptyContent when
  there is no text layer so the shim falls through to the legacy image-
  render path rather than claiming a result it cannot produce.
- RichDocumentAdapter wraps NSAttributedString across docx/doc/rtf/html;
  a single adapter for all four because they share the framework call
  today, splitting when high-fidelity DOCX lands.
- DocumentAdaptersBootstrap registers the three on the shared registry
  from AppDelegate.applicationDidFinishLaunching exactly once so the
  shim sees adapters on the first file ingress.
- PlainTextRepresentation is the neutral text shape for adapters that
  cannot yet publish a format-native representation; replaced per-format
  by Workbook / WordDocument / etc. in later PRs.
First real-fidelity document adapter. Reads .xlsx into a typed Workbook
representation carrying sheet names, cells with formula source strings,
merged-range references, shared strings, and cell types (number, shared
string, inline string, boolean). The text fallback renders each sheet
as a tab-separated table so callers still on the legacy Attachment.
Kind.document path see something readable.

The adapter deliberately does NOT call CoreXLSX's parseStyles() — that
entry point crashes on openpyxl-generated workbooks because the
library's PatternFill.patternType is non-optional while Excel's default
empty pattern omits the attribute. Everything we surface today is
style-independent; lifting that limitation (number formats, column
widths, dates stored as styled numbers) lives in a follow-up slice
behind a hand-rolled styles fallback.

- Package.swift: CoreXLSX 0.14.2 dependency for the core target,
  testTarget resource declaration for the xlsxwriter-produced fixture.
- Workbook / Sheet / Row / Cell / CellValue / CellRange: the typed
  intermediate that both the XLSX read path and the eventual XLSX write
  emitter round-trip through.
- XLSXAdapter: the actual CoreXLSX → Workbook translator + markdown-
  style text fallback.
- DocumentAdaptersBootstrap: registers XLSXAdapter alongside PlainText /
  PDF / RichDocument, so DocumentParser.parseAll now routes .xlsx
  through the registry instead of throwing unsupportedFormat.
- Tests/Documents/Fixtures/xlsx/sample.xlsx: 5.9 KB fixture with two
  sheets, a SUM formula, a merged range (A5:B5), shared strings, and
  explicit booleans. Exercises the parse paths for each fidelity feature.
- XLSXAdapterTests: 7 tests pinning format routing, sheet/cell
  structure, formulas, merged ranges, shared strings, booleans, text
  fallback formatting, and size-limit refusal.
- DocumentParserShimTests: expands the bootstrap assertion to include
  "xlsx" alongside the three existing adapter ids.
Pairs with XLSXAdapter so agents can ingest a workbook, modify the
typed Workbook in-process, and emit it back as a fresh .xlsx attachment.
libxlsxwriter ships a first-party Swift Package as a pure C SwiftPM
target, so no XCFramework / vendored C source is needed in osaurus
itself — it's just a dependency add.

- Package.swift: libxlsxwriter 1.2.4 dependency for the core target.
- XLSXEmitter: Workbook -> .xlsx via libxlsxwriter. Parses A1 cell
  references into 0-indexed row/col, dispatches strings / numbers /
  booleans / formulas to the right write_* function, handles merged
  ranges via worksheet_merge_range with a nil string so the top-left
  cell's already-written content is preserved. Cleans up a partial
  .xlsx on any emit error so a failed round trip never masquerades as
  a readable file.
- DocumentAdaptersBootstrap: registers XLSXEmitter alongside XLSXAdapter.
- XLSXEmitterTests: 7 tests pinning the round trip end-to-end. Builds
  a Workbook in memory, writes via XLSXEmitter, reads via XLSXAdapter,
  asserts sheet names / formulas / merged ranges / strings / numbers /
  booleans all survive.

Licensing footnote: libxlsxwriter is BSD-2-Clause, but bundles
third_party/tmpfileplus/tmpfileplus.c under MPL 2.0. Statically linking
is permitted. A follow-up to AcknowledgementsView should list both;
deliberately out of scope for this PR.
…te_workbook

Exposes the typed Workbook surface to folder-mode agents. Stacks on top
of the XLSX read (osaurus-ai#929) + write (osaurus-ai#936) PRs and completes the stage-4
round-trip goal: an agent can now ingest a spreadsheet, reason about
cells and formulas in their native types, and emit a modified workbook
— all without the model having to handroll XML.

- read_workbook: returns a compact JSON summary of every sheet
  (names, row counts, merged ranges, truncated cell sample). Capped at
  200 cells per sheet so large workbooks don't blow the context
  window; agents drop to read_workbook_cell for specific values.
- read_workbook_cell: single-cell lookup by (path, sheet, A1 ref).
  Returns value, formula source, and type in a one-line JSON payload.
- write_workbook: accepts a structured sheets array and emits the
  file via XLSXEmitter. Each cell carries its A1 ref, typed value,
  and optional formula; the schema enum guards against unknown
  types. write_workbook creates parent directories and surfaces a
  sheetCount / totalCells summary on success.
- All three plug into FolderToolFactory.buildCoreTools alongside
  file_read / file_write, so they're registered the moment a working
  folder is selected and go away when it's cleared.
- Tests: 8 tests covering sheet summary rendering, missing-file and
  out-of-root rejection, formula preservation on cell lookup, missing-
  sheet error, end-to-end write + re-parse fidelity, non-xlsx path
  refusal, and empty-sheets validation. Tests reuse the sample.xlsx
  fixture from the XLSX read PR.
Replaces the legacy 'CSV as plain text' ingestion with a typed
CSVTable representation that preserves encoding, delimiter, line-ending
style, and per-row cell boundaries. Pairs a batch adapter for chat
attachments with a streaming variant for multi-GB exports.

- CSVTable / CSVRecord: typed representation + one streamed row shape.
- CSVParser: shared RFC-4180-ish state machine. Handles quoted fields,
  '""' quote escapes, embedded newlines in quoted cells, CRLF / LF /
  bare-CR line endings.
- CSVAdapter: eager, in-memory. Delimiter defaults per extension
  ('.csv' -> ',', '.tsv' -> '\t'). UTF-8 BOM stripping + ISO-Latin-1
  fallback decode. Conservative header heuristic (first row is a
  header when at least one cell is non-numeric and there's a body
  row below). Renders a markdown-style text fallback for chat display.
- CSVStreamer: row-at-a-time AsyncThrowingStream for large files.
  Reads 64 KB chunks, splits at the last complete UTF-8 scalar so
  multi-byte scalars never cross a chunk boundary, feeds bytes
  through the same CSVParser.Machine so quoting / newline semantics
  match the batch path exactly. Honours Task cancellation so the
  agent tool surface can back-pressure.
- Registers both in DocumentAdaptersBootstrap after PlainText so
  later-wins routing picks the typed adapter for '.csv' / '.tsv'.
- Tests: 10 adapter tests (header split, TSV delimiter, quoted commas
  + newlines, '""' escape, UTF-8 BOM, numeric-only header rejection,
  size-limit refusal, empty-file emptyContent, CRLF, canHandle) + 7
  streamer tests (in-order yield, 1-based line numbering, TSV,
  quoted newlines across chunks, cancellation mid-file, UTF-8
  boundary helper coverage).
Upgrades the PDFAdapter from flat text to a typed PDFDocumentRepresentation
that carries per-page text PLUS a list of detected tables. Turns invoices,
bank statements, and 10-Ks from 'run-together numeric columns' into
proper cell grids without changing the flat-text contract other consumers
rely on.

Detection strategy:
  1. Walk each page's characters and capture (scalar, rect) from
     PDFPage.characterBounds(at:). Whitespace glyphs are dropped up
     front because PDFKit reports their bounds as spanning the visual
     gap they introduce, which would hide column boundaries.
  2. Cluster glyphs into rows by y-coordinate tolerance (3pt).
  3. Within each row, split into cells wherever the inter-glyph gap
     exceeds 8pt — clearly above word-space (~3pt at 12pt body) but
     well below intentional column gaps (>20pt typical).
  4. Collect runs of multi-cell rows into PDFTable regions. Isolated
     single-tabular rows are dropped so form lines like
     'Invoice No. 1234' don't masquerade as tables.

- PDFDocumentRepresentation / PDFPageRepresentation / PDFTable: the new
  typed shape emitted by the adapter.
- PDFAdapter now emits PDFDocumentRepresentation instead of
  PlainTextRepresentation. textFallback stays the flat concatenation of
  page text so chat attachments render unchanged.
- PDFTableDetector: pure-function stages (clusterRows, cellsForRow,
  groupConsecutiveTabularRows, detect(glyphs:)) exposed internally for
  unit testing without PDFKit, so the heuristic can be pinned against
  synthetic glyph grids that aren't subject to Core Graphics' habit of
  reporting character bounds that span trailing whitespace.
- Image-only PDFs still throw emptyContent so the DocumentParser shim
  can fall through to the legacy image-render path.

Test suite (16 new):
  - Row clustering by y (including descending PDF-coord sort).
  - Cell splitting for wide gaps, word-in-cell, single glyph.
  - Tabular row grouping: multi-row collection, single-cell row split,
    drop-isolated-single-row, empty input.
  - Full detect(glyphs:) on a 3x3 synthetic grid.
  - End-to-end adapter integration (emits PDFDocumentRepresentation,
    preserves text fallback; blank PDF still throws emptyContent).
@mimeding mimeding force-pushed the feat/pdf-table-extraction branch from 14874b7 to 7fc1dd6 Compare May 3, 2026 23:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant