SudoSOS Back-end API / internal/pdf
internal/pdf ​
This is the page of pdf-service.
Classes ​
| Class | Description |
|---|---|
| BaseHtmlPdfService | Base class for HTML-to-PDF services. Produces bytes via createPdfBuffer. Concrete stored services should implement createPdfWithEntity to persist and return the Pdf entity. |
| BasePdfService | Base PDF service that always provides bytes. Concrete services that store a Pdf entity should implement IStoredPdfService. |
| HtmlPdfService | HTML-to-PDF service for entities that store PDFs. Similar to PdfService but uses HTML templates instead of LaTeX. |
| HtmlUnstoredPdfService | HTML-to-PDF service for entities that don't store PDFs. It inherits createPdfBuffer and createRaw from BaseHtmlPdfService. It does not implement any stored interface. |
| PdfService | Stored PDF service. Uses BasePdfService to produce bytes then uploads and returns the Pdf entity. |
| RouteParams | - |
| UnstoredPdfService | UnstoredPdfService - produces bytes but does not persist. It inherits createPdfBuffer and createRaw from BasePdfService. It does not implement any stored interface. |
Interfaces ​
| Interface | Description |
|---|---|
| IPdfServiceBase | Base interface for all PDF services. - createPdfBuffer always produces the PDF bytes - createRaw produces raw output (tex or html) as bytes - getParameters must be implemented by concrete services |
| IStoredPdfService | Optional interface for services that also persist and return a Pdf entity. Services that do not persist can simply not implement this interface. |
Type Aliases ​
| Type Alias | Description |
|---|---|
| HtmlGenerator | Type alias for a function that generates HTML from a data object. |
| PdfTemplateParameters | Type alias for template parameters used in HTML PDF services. Parameters must be a record (object) with string keys. |