Skip to content
getnextpdf.com

Core engine reference

The nextpdf/core engine is documented one module at a time. Each page below owns one namespace of the core Portable Document Format 2.0 (PDF 2.0) engine. Use this map to find the module that owns the symbol you are working with, then read that module’s page for the exact types and methods.

Four modules — Contracts, Core, HTML, and Security — carry deeper sub-family pages. The namespace map lists every module; the sub-family pages follow.

PageTopic
Accelerator: Spectrum sidecar clientThe client for the Spectrum acceleration sidecar.
Accessibility: tagging primitives and the PDF/UA-2 structure modelTagging primitives and the structure model.
Ast: semantic document tree and serializationThe semantic document tree and its serialization.
Audit: deterministic compliance-evidence exportCompliance-evidence export.
Barcode: 1D and 2D symbology encodersThe one-dimensional (1D) and two-dimensional (2D) symbology encoders.
Chaos: deterministic resilience-scenario harnessThe resilience-scenario harness.
Cli: command handlers and external-validator adaptersCommand handlers and external-validator adapters.
Compliance: PDF/R-1 validator, Arlington grammar, lifecycle toolsThe validator, grammar, and lifecycle tooling.
Config: immutable document configurationImmutable document configuration.
Conformance: ConformanceMode routing and the validation boundaryConformanceMode routing and the validation boundary.
Content: textual + structured content modelThe textual and structured content model.
ContentStream: PDF content-stream emitterThe content-stream emitter.
Contracts: 41 public interfaces (SPI)The public interfaces of the service provider interface (SPI).
Core: Document facade + concern traitsThe Document facade and the concern traits.
Document: DParts, split / merge, and vendor extensionsDocument Parts, split and merge, and vendor extensions.
Event: PSR-14 lifecycle event taxonomyThe lifecycle event taxonomy.
Exception: typed exception hierarchyThe typed exception hierarchy.
Font: value types, embedding, and fallbackFont value types, embedding, and fallback.
Form: AcroForm interactive fields and flatteningInteractive form fields and flattening.
Graphics: path + shading + transform primitivesPath, shading, and transform primitives.
HTML: HTML+CSS to PDF rendering subsystemThe HTML and Cascading Style Sheets (CSS) rendering subsystem.
Inspect: PDF introspection and preflightIntrospection and preflight.
Layout: headers, footers, columns, booklet, page managerHeaders, footers, columns, booklet, and the page manager.
Linearization: Fast Web View outputFast Web View output.
Render manifest: the portable render requestThe portable render request.
Metadata: XMP packet build and streaming readExtensible Metadata Platform (XMP) packet build and streaming read.
Multimedia: rendition, media clip, and screen parametersRendition, media clip, and screen parameters.
Navigation: annotations, links, outlines, actions, and attachmentsAnnotations, links, outlines, actions, and attachments.
Observability: hash-chained SIEM log and render reportingThe security log and render reporting.
PageBackfill: retained page bufferThe retained page buffer.
Performance: memory-fragmentation analyzerThe memory-fragmentation analyzer.
Security: encryption, crypto-policy, and the signing surfaceEncryption, crypto policy, and the signing surface.
Support: shared utilities + Clock + SleeperShared utilities, Clock, and Sleeper.
Telemetry: OpenTelemetry bridge and no-op fallbackThe OpenTelemetry bridge and the no-op fallback.
Text: shaping seam, CJK, and run handlingThe shaping seam and run handling, including Chinese, Japanese, and Korean (CJK) text.
Typography: font registry, subsetting, CMap, encoding, BiDiThe font registry, subsetting, CMaps, encoding, and bidirectional text.
ValueObjects: domain primitives + unitsDomain primitives and units.
Writer: PDF 2.0 serializer + xrefThe PDF 2.0 serializer and the cross-reference layer.

Four modules are documented in more depth by a page per area. Each sub-family page belongs to its module page above.

PageTopic
Contracts / BarcodeThe Barcode contracts.
Contracts / DocumentThe document, factory, and registry contracts.
Contracts / ExtractionThe inspection and extraction contracts.
Contracts / ObservabilityThe observability and job-progress contracts.
Contracts / Security PolicyThe security-policy contracts.
Contracts / SigningThe Signing contracts.
Contracts / StreamingThe streaming writer and cursor contracts.
Contracts / TypographyThe typography contracts.
PageTopic
Core / Document FacadeThe Document Facade page.
Core / HasLayout traitThe HasLayout trait page.
Core / HasOutput traitThe output concern of the facade.
Core / HasPages traitThe page-management concern of the facade.
Core / HasSecurity traitThe security concern of the facade.
Core / HasTextOutput traitThe text-output concern of the facade.
PageTopic
HTML rendering pipelineThe rendering pipeline.
HTML engine layer contractsThe rendering-engine layer contracts.
HTML single-pass streaming constraintsThe single-pass streaming model and its constraints.
CSS resolver: cascade and specificityThe cascade and specificity model.
Paged-media CSS preview flags (GCPM running content, named pages, page floats)The paged-media CSS preview flags.
Retained-mode layout for CSS Grid (grid-template-areas)Retained-mode layout for CSS Grid.
PageTopic
Encryption: AES-256 (CBC) and AES-256-GCMThe document-encryption page.
Security / Signing: CMS, RFC 3161 timestamp, LTV, trustThe core signing, timestamping, and trust surface.
  • Reference — the map of the whole Reference tab: matrices, errors, conformance, and policies.
  • Error reference — every exception the engine raises, by domain.
  • Extension authoring — the extension-authoring hub for the public SPI.