How jikenlabs/oxid works
Oxid provides document ingestion, conversion and PDF-oriented analysis through a Rust server, alongside a TypeScript web-component viewer. A typical user opens a document in the viewer; the server exposes document and page operations, and the viewer presents rendered pages and interactive tools. The documented product also includes headless conversion, multiple storage connectors, document comparison, forms, annotations, PII detection, redaction and signatures. Some route-to-engine links are shown as unverified because the sampled route excerpt does not include their invocation sites.
Main entry points: routes.rs HTTP API · viewer.ts Viewer workflow · connectors/mod.rs Connector registry · converter/mod.rs Format dispatch
Components 32
Server and API
- HTTP API
backend/src/api/routes.rs - API keys and quotas
backend/src/auth.rs - Application config
backend/src/config.rs - Render cache
backend/src/cache.rs - Security validation
backend/src/security.rs
Document storage
- Local document storage
backend/src/connectors/mod.rs - Connector registry
backend/src/connectors/mod.rs - Connector contract
backend/src/connectors/traits.rs - Filesystem connector
backend/src/connectors/filesystem.rs - S3 connector
backend/src/connectors/s3.rs - CMIS connector
backend/src/connectors/cmis.rs
Conversion and rendering
- Format dispatch
backend/src/engine/converter/mod.rs - Office conversion
backend/src/engine/converter/office.rs - CAD conversion
backend/src/engine/converter/cad.rs - DICOM conversion
backend/src/engine/converter/dicom.rs - PDF processing
backend/src/engine/pdf.rs
Document operations
- Annotations
backend/src/engine/annotations.rs - Document comparison
backend/src/engine/comparison.rs - Form handling
backend/src/engine/forms.rs - PII detection
backend/src/engine/pii.rs - Redaction
backend/src/engine/redaction.rs - Digital signatures
backend/src/engine/signature.rs - Document builder
backend/src/engine/builder.rs
Web viewer
- Web component
frontend/src/oxid-element.ts - Viewer workflow
frontend/src/viewer.ts - Viewer template
frontend/src/template.ts - Annotation layer
frontend/src/annotation-layer.ts - Comparison UI
frontend/src/comparison-ui.ts - Builder UI
frontend/src/document-builder-ui.ts - Form layer
frontend/src/form-layer.ts - Text layer
frontend/src/text-layer.ts
Other components
- Document user
Connections 34
- Document user → Web component: opens viewer
- Web component → Viewer workflow: creates viewer
frontend/src/oxid-element.ts - Web component → Viewer template: uses markup
frontend/src/oxid-element.ts - Viewer workflow → Annotation layer: uses layer
frontend/src/viewer.ts - Viewer workflow → Comparison UI: uses UI
frontend/src/viewer.ts - Viewer workflow → Builder UI: renders builder
frontend/src/viewer.ts - Viewer workflow → Form layer: renders forms
frontend/src/viewer.ts - Viewer workflow → Text layer: uses renderer
frontend/src/viewer.ts - Viewer workflow → HTTP API: requests documents
- Document user → HTTP API: requests conversion
- HTTP API → Render cache: reads cache
backend/src/api/routes.rs - HTTP API → Local document storage: gets document path
backend/src/api/routes.rs - HTTP API → API keys and quotas: checks quotas
backend/src/api/routes.rs - HTTP API → Application config: uses settings
backend/src/api/routes.rs - HTTP API → Security validation: validates inputs
backend/src/api/routes.rs - Connector registry → Connector contract: dispatches connectors
backend/src/connectors/mod.rs - Connector registry → Filesystem connector: registers connector
backend/src/connectors/mod.rs - Connector registry → S3 connector: registers connector
backend/src/connectors/mod.rs - Connector registry → CMIS connector: registers connector
backend/src/connectors/mod.rs - HTTP API → Connector registry: uses storage connectors
backend/src/api/routes.rs - HTTP API → Format dispatch: converts documents
backend/src/api/routes.rs - Format dispatch → Office conversion: dispatches Office
backend/src/engine/converter/mod.rs - Format dispatch → CAD conversion: dispatches CAD
backend/src/engine/converter/mod.rs - Format dispatch → DICOM conversion: dispatches DICOM
backend/src/engine/converter/mod.rs - HTTP API → PDF processing: renders pages
backend/src/api/routes.rs - HTTP API → Annotations: handles annotations
backend/src/api/routes.rs - HTTP API → Document comparison: compares documents
backend/src/api/routes.rs - HTTP API → Form handling: handles forms
backend/src/api/routes.rs - HTTP API → PII detection: scans for PII
backend/src/api/routes.rs - HTTP API → Redaction: applies redactions
backend/src/api/routes.rs - HTTP API → Digital signatures: handles signatures
backend/src/api/routes.rs - HTTP API → Document builder: builds documents
backend/src/api/routes.rs - Form handling → Format dispatch: uses conversion
backend/src/engine/forms.rs - PII detection → PDF processing: reads PDF text
backend/src/engine/pii.rs