@paprize/core

ReportBuilder

Defined in: report/ReportBuilder.ts:54

The report builder class that contains the logic for handling pagination and managing the report layout.

Accessors

monitor

Get Signature

get monitor(): Monitor<ReportBuilderEvents>

Defined in: report/ReportBuilder.ts:79

Monitor instance used to subscribe to pagination events. See ReportBuilderEvents for available event types.

Returns

Monitor<ReportBuilderEvents>

Methods

getJsonData()

getJsonData<T>(defaultData?): Promise<T | null>

Defined in: report/ReportBuilder.ts:195

Retrieves JSON data injected by @paprize/puppeteer during server-side rendering (SSR).

If no injected data is available, the function returns the provided defaultData, or null if none is given.

⚠️ Important Notes:

• This function is not type-safe — it performs no runtime type validation on the returned data.
• It is available only during server-side rendering when using @paprize/puppeteer.
• When used in client-side rendering or development mode, you should provide a defaultData value for testing purposes.

Type Parameters

Type Parameter	Description
T	The expected type of the injected JSON data.

Parameters

Parameter	Type	Description
defaultData?	T	Optional fallback value to return if no injected data is found.

Returns

Promise<T | null>

A promise resolving to the injected JSON data if available, otherwise the provided default value or null.

removeSection()

removeSection(sectionId): void

Defined in: report/ReportBuilder.ts:86

Removes a section from the registered sections, if it has already been registered in the report.

Parameters

Parameter	Type
sectionId	string

Returns

void

schedulePagination()

schedulePagination(): Promise<ScheduleResult>

Defined in: report/ReportBuilder.ts:152

Schedules a pagination operation.

It is not possible to schedule multiple pagination operations in parallel, as the process involves DOM manipulation, and concurrent modifications could cause conflicts and unexpected results. Each newly scheduled operation is queued and executed sequentially. When a new pagination is scheduled, any ongoing or pending operations will be aborted, and the new pagination will start immediately afterward.

Returns

Promise<ScheduleResult>

A promise that resolves when the first pagination cycle is completed. It does not wait for suspended sections to resolve and be paginated. To wait for all sections to complete pagination, use the suspension property of the returned result object.

tryAddSection()

tryAddSection(options, components, onPaginationCompleted): Promise<boolean>

Defined in: report/ReportBuilder.ts:98

Registers a section by its ID, specifying the page size, margins, and other options.

Parameters

Parameter	Type	Description
options	SectionOptions	Configuration options for the section.
components	SectionComponents	The DOM components associated with the section.
onPaginationCompleted	(context) => void | Promise<unknown>	Callback invoked when pagination for the section is completed.

Returns

Promise<boolean>

true if the section was added to the report’s section list, or false if it already exists.

---

LayoutOptions

Defined in: paginate/LayoutOptions.ts:15

Layout options for the pagination engine

Properties

Property	Type	Default value	Description
hyphen?	string	"-"	Specifies the character used for hyphenation when a word is broken across lines.
hyphenationDisabled?	boolean	false	Disables automatic word hyphenation. When disabled, if a word (a sequence of text without whitespace) does not fit on the current page, it will move to the next page instead of being split with a hyphen character.
keepOnSamePage?	KeepOnSamePageOptions	false	Prevents an element from being split across pages.

---

PageContext

Defined in: report/ReportBuilderEvents.ts:7

Context information for a paginated page.

Properties

Property	Type	Description
pageContentHtml	string	HTML string representing the paginated content of this page.
pageIndex	number	Index of this page within its section.
sectionId	string	Index of the section to which this page belongs
totalPages	number	Total number of pages in the section that contains this page.

---

PageMargin

Defined in: report/pageTypes.ts:20

Represents the margin sizes for a page. All values should be valid CSS size strings (e.g., '10mm', '1in').

Common presets are available in pageMargin

Properties

Property	Type
bottom	string
left	string
right	string
top	string

---

PageSize

Defined in: report/pageTypes.ts:7

Represents the dimensions of a page. All values should be valid CSS size strings (e.g., '210mm', '8.5in').

Common presets are available in pageSize

Properties

Property	Type
height	string
width	string

---

PaginationCycleCompleted

Defined in: report/ReportBuilderEvents.ts:68

Context information for pagination cycle.

Properties

Property	Type	Description
sections	SectionContext[]	All paginated section within the report.

---

PaginationOptions

Defined in: paginate/PaginationOptions.ts:10

Pagination options

Properties

Property	Type	Default value	Description
hyphen	string	"-"	Specifies the character used for hyphenation when a word is broken across lines.
hyphenationDisabled	boolean	false	Disables automatic word hyphenation. When disabled, if a word (a sequence of text without whitespace) does not fit on the current page, it will move to the next page instead of being split with a hyphen character.
id	string	undefined	Unique id of the pagination.
keepOnSamePage	KeepOnSamePageOptions	false	Prevents an element from being split across pages.
plugins	PaginationPlugin[]	undefined	List of plugins to use during pagination.

---

ReportBuilderEvents

Defined in: report/ReportBuilderEvents.ts:78

Available events that can be subscribed to, during the pagination process.

Properties

Property	Type	Description
pageCompleted	(event) => void	Triggered when a page has been fully paginated. event: PageContext
paginationCycleCompleted	(event) => void	Triggered when an entire pagination cycle is completed. event: PaginationCycleCompleted
sectionCompleted	(event) => void	Triggered when a section has been fully paginated. event: SectionContext
sectionCreated	(event) => void	Triggered when a new section is created. event: SectionContext

---

ScheduleResult

Defined in: report/ReportBuilder.ts:36

Represents the result of a scheduled pagination process.

Properties

Property	Type	Description
sections	SectionContext[]	List of all registered sections.
suspension	Promise<void>	If there are any suspended sections, this Promise tracks their state and resolves only after all suspended sections have been resumed and paginated.

---

SectionComponents

Defined in: report/sectionComponents.ts:5

Represents the collection of DOM elements generated by the pagination engine from the report components on the current page.

Properties

Property	Type	Description
pageContent	HTMLElement	The main HTML element for the this page content This property is always defined.
pageFooter	HTMLElement | null	The HTML element that serves as the footer for this page. null if the page has no footer.
pageHeader	HTMLElement | null	The HTML element that serves as the header for this page. null if the page has no header.
sectionFooter	HTMLElement | null	The HTML element that serves as the footer for the entire section. null if the section has no section footer.
sectionHeader	HTMLElement | null	The HTML element that serves as the header for the entire section. null if the section has no section header.

---

SectionContext

Defined in: report/ReportBuilderEvents.ts:29

Context information for a paginated section.

Properties

Property	Type	Description
components	SectionComponents	Components used in this section.
isPaginated	boolean	Indicates whether pagination for this section has completed.
isSuspended	boolean	Indicates whether pagination for this section is suspended and waiting for the suspension to be resolved.
options	SectionOptions	Options used for paginating this section. Remarks Options may differ from the original SectionOptions provided during section creation, as some values may be
pages	PageContext[]	All paginated pages that belong to this section.
sectionId	string	Unique identifier of the section.
sectionIndex	number	Index of the section within the report.

---

SectionOptions

Defined in: report/SectionOptions.ts:9

Configuration options for a section.

Extends

• Partial<Omit<PaginationOptions, "id">>

Properties

Property	Type	Default value	Description
hyphen?	string	"-"	Specifies the character used for hyphenation when a word is broken across lines.
hyphenationDisabled?	boolean	false	Disables automatic word hyphenation. When disabled, if a word (a sequence of text without whitespace) does not fit on the current page, it will move to the next page instead of being split with a hyphen character.
id	string	undefined	Unique id of the section within the report.
keepOnSamePage?	KeepOnSamePageOptions	false	Prevents an element from being split across pages.
margin?	PageMargin	undefined	Page margins for this section.
orientation?	"portrait" | "landscape"	undefined	Page orientation used for this section. Default portrait
plugins?	PaginationPlugin[]	undefined	List of plugins to use during pagination.
size	PageSize	undefined	Page size used for this section.
suspense?	Promise<unknown>[]	undefined	A list of promises that must be resolved before the section can be paginated.

---

TablePluginOptions

Defined in: plugins/TablePlugin.ts:17

Table plugin options

Properties

Property	Type	Description
cloneFooter?	boolean	If true, the table footer (tfoot) will be cloned on each page.
cloneHeader?	boolean	If true, the table header (thead) will be cloned on each page.
includeHeaderOnlyTables?	boolean	When true, tables containing only a header (no body rows) will not be removed.

---

KeepOnSamePageOptions

KeepOnSamePageOptions = true | false | "prefer"

Defined in: paginate/LayoutOptions.ts:10

Controls how elements handle page breaks when they exceed the remaining space on a page.

• true (Strict Keep): Forces the element to stay whole. Moves it to the next page if it doesn't fit. If it's larger than a full empty page, it is dropped.
• false (Allow Split): Prioritizes rendering immediately. Splits the element across pages; if splitting is impossible, it moves to the next page or is dropped.
• 'prefer' (Balanced): Attempts to keep the element whole by moving it to the next page first. If it still doesn't fit a full page, it falls back to splitting.

---

PageOrientation

PageOrientation = "portrait" | "landscape"

Defined in: report/pageTypes.ts:38

Defines the physical orientation of the page.

• portrait: Standard vertical orientation (height > width). Dimensions are applied exactly as defined. Default.
• landscape: Horizontal orientation (width > height). The provided width and height values are automatically swapped.

---

pageMargin

const pageMargin: object

Defined in: report/pageConst.ts:40

Predefined values for commonly used PageMargin

Type Declaration

Name	Type	Description
Narrow	PageMargin	Top: 0.4in, Right, Bottom, Left: 0.6in
None	PageMargin	Top, Right, Bottom, Left: 0
Normal	PageMargin	Top, Right, Bottom, Left: 1in
Wide	PageMargin	Top, Bottom: 0.5in, Right, Left: 2in

---

pageSize

const pageSize: object

Defined in: report/pageConst.ts:8

Predefined values for commonly used PageSize

Type Declaration

Name	Type	Description
A1	PageSize	841mm x 594mm
A2	PageSize	594mm x 420mm
A3	PageSize	420mm x 297mm
A4	PageSize	297mm x 210mm
A5	PageSize	210mm x 148mm
A6	PageSize	148mm x 105mm
B3	PageSize	500mm x 353mm
B4	PageSize	353mm x 250mm
B5	PageSize	250mm x 176mm
Legal	PageSize	11in x 8.5in
Letter	PageSize	8.5in x 11in
Tabloid	PageSize	11in x 17in