Files
faunosteo/docs/PDF-FORMAT.md
T

1.2 KiB
Raw Blame History

PDF Format

Placeholder — to be written when implementing src/pdf/.

Will cover:

  • A4 portrait dimensions (595.28 × 841.89 pt)
  • Page layout: header / body / footer zones
  • Observation page structure
  • Conclusion page structure
  • JSON attachment spec (EmbeddedFiles, afRelationship:Data)
  • Font handling (pdf-lib StandardFonts Helvetica/Times-Roman, WinAnsi; TTF Inter/Fraunces planned, not shipped)
  • Import/re-import roundtrip contract

Attachment versions (Step 5)

The attachment osteo-report.json carries the Report v3 document (packages/domain/src/report/v3.ts): zones by (annotationId, viewId), findings by (findingZoneId, path) with label snapshots, severity codes, the sheet reference (sheet id, version id, sha256 of the document) and the reserved localAnnotations.

Import (importReportFromPdf(bytes, migrationMap)) accepts:

  • v3: read as is;
  • v2 (PDFs produced by the application before Step 5, the practitioner's archive): migrated through the sheet's report-migration-map.json; a zone or finding the map cannot place is kept with its snapshots and flagged unresolved: true; the outcome reports migrated and the unresolved counts;
  • any other version: ImportError('incompatible_version', foundVersion).