@paprize/core 0.0.4 → 0.0.5

package/dist/paprize-core.d.ts

@@ -1,5 +1,8 @@
+import type * as CSS_2 from 'csstype';
 import { default as default_2 } from 'loglevel';
 
+export declare function adjustDimension(dimension: PageDimension, orientation: PageOrientation): PageDimension;
+
 declare const AttributeDef: {
     hyphen: AttributeValueDef<string>;
     keepOnSamePage: AttributeValueDef<boolean>;
@@ -22,8 +25,12 @@ declare class AttributeValueDef<T> {
     static createBool(name: string, defaultValue: boolean): AttributeValueDef<boolean>;
 }
 
+export declare function buildPageId(sectionId: string, pageIndex: number): string;
+
 export declare function callPluginHook<T extends PluginHookNames>(plugins: PaginationPlugin[], hookName: T, ...args: Parameters<NonNullable<PaginationPlugin[T]>>): void;
 
+export declare function cloneComponents(components: SectionComponents): SectionComponents;
+
 export declare type ConfigAttribute = {
     [K in AttributeKey]?: AttributeValue<K>;
 };
@@ -32,6 +39,8 @@ export declare function configToAttributeMap(config: ConfigAttribute): Record<st
 
 export declare function createLoremIpsumParagraph(wordCount: number, seed: number): string;
 
+export declare type CSSProperties = CSS_2.Properties<string | number>;
+
 export declare const currentElementClassName = "pz-current-element";
 
 export declare const currentTextClassName = "pz-current-text";
@@ -51,11 +60,11 @@ export declare class DomState {
     get completed(): boolean;
     get currentNode(): PageNode | null;
     get previousNode(): PageNode | null;
-    nextNode(): void;
-    nextSiblingOrParentSibling(): {
+    goToNextNode(): void;
+    goToNextSiblingOrParentSibling(): {
         parentsTraversed: number;
     };
-    firstChildOrNextNode(): {
+    goToFirstChildOrNextNode(): {
         parentsTraversed: number;
     };
     private setState;
@@ -63,8 +72,21 @@ export declare class DomState {
 
 export declare const enableDebugMode: () => void;
 
+export declare class EventDispatcher<TEvents> {
+    private registry;
+    addEventListener<T extends keyof TEvents>(name: T, handler: EventHandler<T, TEvents>): () => void;
+    removeEventListener<T extends keyof TEvents>(name: T, handler: EventHandler<T, TEvents>): void;
+    dispatch<T extends keyof TEvents>(name: T, ...args: Parameters<EventHandler<T, TEvents>>): void;
+}
+
+declare type EventHandler<TKey extends keyof TEvents, TEvents> = TEvents[TKey] extends (...args: infer TArgs) => infer TReturn ? (...args: TArgs) => TReturn : never;
+
 export declare function getVisibleHeight(element: Element): number;
 
+export declare const globalStyle = "\n    html {\n        box-sizing: border-box;\n    }\n\n    *,\n    *:before,\n    *:after {\n        box-sizing: inherit;\n    }\n\n    :root {\n        --paprize-page-background-color: #ffffff;\n        --paprize-page-margin-bottom: 10px;\n        --paprize-page-box-shadow: rgb(142 138 138) -1px 3px 5px 2px;\n        --paprize-section-margin-bottom: 10px;\n        --paprize-preview-background-color: rgb(218 220 224);\n        --paprize-preview-padding: 30px 10px;\n    }\n\n    body {\n        margin: 0;\n    }\n    \n    @media screen {\n        .pz-preview {\n            min-height: 100vh;\n            display: flex;\n            flex-direction: column;\n            align-items: center;\n            background-color: var(--paprize-preview-background-color);\n            padding: var(--paprize-preview-padding);\n        }\n\n        .pz-page {\n            box-shadow: var(--paprize-page-box-shadow);\n            margin-bottom: var(--paprize-page-margin-bottom);\n            background-color: var(--paprize-page-background-color);\n        }\n\n        .pz-section {\n            margin-bottom: var(--paprize-section-margin-bottom);\n        }\n    }\n\n    @media print {\n        html:has(.pz-preview) *:not(.pz-preview):not(.pz-preview *):not(:has(.pz-preview)) {\n            display: none !important;\n        }\n    }   \n ";
+
+export declare const globalStyleId = "paprize-global-style";
+
 export declare const ignoredElementClassName = "pz-ignored-element";
 
 export declare const ignoredTextClassName = "pz-ignored-text";
@@ -79,22 +101,43 @@ export declare const logger: default_2.Logger;
 
 export declare const loggerName = "paprize";
 
+export declare type Monitor<TEvents> = Omit<EventDispatcher<TEvents>, 'dispatch'>;
+
 export declare function moveOffscreen(element: HTMLDivElement): void;
 
 export declare const pageBreakAttributeName = "data-pz-page-break";
 
-export declare const pageBreakPlugin: PaginationPlugin;
-
-export declare const pageBreakPluginName = "pageBreak";
+export declare class PageBreakPlugin implements PaginationPlugin {
+    name: string;
+    order: number;
+    onVisitElement: (_id: string, domState: DomState & {
+        currentNode: PageElement;
+    }, pageManager: PageManager, context: VisitContext) => void;
+}
 
 export declare const pageClassName = "pz-page";
 
+export declare interface PageContext {
+    sectionId: string;
+    index: number;
+    totalPages: number;
+    pageContentHtml: string;
+}
+
+export declare interface PageDimension {
+    height: string;
+    width: string;
+}
+
 declare class PageElement {
     private readonly _node;
-    private readonly _transaction;
+    config: PaginationConfig;
     readonly type: 'element';
-    readonly config: PaginationConfig;
-    constructor(element: Element, transaction: Transaction, config: PaginationConfig);
+    readonly transaction: Transaction;
+    readonly clonedFrom?: PageElement;
+    readonly cloneCount: number;
+    constructor(element: Element, transaction: Transaction, config: PaginationConfig, clonedFrom?: PageElement);
+    getOriginalNode(): Node | undefined;
     appendChild(node: PageNode): void;
     clone(withChildren?: boolean): PageElement;
     getHeight(): number;
@@ -129,13 +172,104 @@ declare class PageManager {
     getPageState(): PageState;
 }
 
+export declare interface PageMargin {
+    top: string;
+    right: string;
+    bottom: string;
+    left: string;
+}
+
+export declare const pageMargin: Record<keyof typeof _pageMargin, PageMargin>;
+
+declare const _pageMargin: {
+    Normal: {
+        top: string;
+        right: string;
+        bottom: string;
+        left: string;
+    };
+    Narrow: {
+        top: string;
+        right: string;
+        bottom: string;
+        left: string;
+    };
+    Wide: {
+        top: string;
+        right: string;
+        bottom: string;
+        left: string;
+    };
+    None: {
+        top: string;
+        right: string;
+        bottom: string;
+        left: string;
+    };
+};
+
 declare type PageNode = PageElement | PageText;
 
+export declare type PageOrientation = 'portrait' | 'landscape';
+
 export declare interface PageSize {
     width: number;
     height: number;
 }
 
+export declare const pageSize: Record<keyof typeof _pageSize, PageDimension>;
+
+declare const _pageSize: {
+    A1: {
+        height: string;
+        width: string;
+    };
+    A2: {
+        height: string;
+        width: string;
+    };
+    A3: {
+        height: string;
+        width: string;
+    };
+    A4: {
+        height: string;
+        width: string;
+    };
+    A5: {
+        height: string;
+        width: string;
+    };
+    A6: {
+        height: string;
+        width: string;
+    };
+    B3: {
+        height: string;
+        width: string;
+    };
+    B4: {
+        height: string;
+        width: string;
+    };
+    B5: {
+        height: string;
+        width: string;
+    };
+    Letter: {
+        height: string;
+        width: string;
+    };
+    Legal: {
+        height: string;
+        width: string;
+    };
+    Tabloid: {
+        height: string;
+        width: string;
+    };
+};
+
 declare class PageState {
     currentPage: PageElement;
     activeElement: PageNode | null;
@@ -151,9 +285,9 @@ declare class PageState {
 
 declare class PageText {
     private readonly _node;
-    private readonly _transaction;
     readonly type: 'text';
-    readonly config: PaginationConfig;
+    readonly transaction: Transaction;
+    config: PaginationConfig;
     constructor(text: Text, transaction: Transaction, config: PaginationConfig);
     get textContent(): string;
     set textContent(value: string);
@@ -168,6 +302,10 @@ export declare type PaginationConfig = Required<ConfigAttribute> & {
     plugins: PaginationPlugin[];
 };
 
+export declare interface PaginationCycleCompleted {
+    sections: SectionContext[];
+}
+
 export declare interface PaginationPlugin {
     readonly name: string;
     readonly order: number;
@@ -177,7 +315,7 @@ export declare interface PaginationPlugin {
     onVisitElement?: (id: string, domState: DomState & {
         currentNode: PageElement;
     }, pageManager: PageManager, context: VisitContext) => void;
-    afterVisitNode?: (id: string, domState: DomState, pageManager: PageManager) => void;
+    afterVisitNode?: (id: string, result: SplitResult, domState: DomState, pageManager: PageManager) => void;
     onNewPage?: (id: string, pageManager: PageManager) => void;
     onClone?: (id: string, source: Element, cloned: PageElement) => void;
 }
@@ -198,6 +336,8 @@ export declare class Paginator {
     private processCurrentNode;
 }
 
+export declare const paprize_isInitialized = "__PAPRIZE_IS_INITIALIZED";
+
 export declare const paprize_isReady = "__PAPRIZE_IS_READY";
 
 export declare const paprize_readJsonDataFile = "__PAPRIZE_READ_JSON_DATA_FILE";
@@ -205,19 +345,96 @@ export declare const paprize_readJsonDataFile = "__PAPRIZE_READ_JSON_DATA_FILE";
 declare type PluginHookNames = NonNullable<PluginKeys>;
 
 declare type PluginKeys = {
-    [K in keyof PaginationPlugin]: PaginationPlugin[K] extends ((...args: any[]) => any) | undefined ? K : never;
+    [K in keyof PaginationPlugin]: PaginationPlugin[K] extends ((...args: never[]) => unknown) | undefined ? K : never;
 }[keyof PaginationPlugin];
 
+export declare const previewClassName = "pz-preview";
+
+export declare class ReportBuilder {
+    private readonly _sections;
+    private readonly _monitor;
+    private _paginationInProgress;
+    private _pendingPaginateResolvers;
+    private _currentAbortController;
+    constructor();
+    get monitor(): Monitor<ReportBuilderEvents>;
+    removeSection(sectionId: string): void;
+    tryAddSection(options: SectionOptions, components: SectionComponents, onPaginationCompleted: (pages: PageContext[]) => void): boolean;
+    schedulePaginate(): Promise<ScheduleResult>;
+    private _executePagination;
+    private _processPendingPagination;
+    private _injectStyle;
+    private _paginateSection;
+}
+
+export declare interface ReportBuilderEvents {
+    pageCompleted: (event: PageContext) => void;
+    sectionCompleted: (event: SectionContext) => void;
+    sectionCreated: (event: SectionContext) => void;
+    paginationCycleCompleted: (event: PaginationCycleCompleted) => void;
+}
+
+export declare const reportStyles: {
+    globalStyle: string;
+    component: CSSProperties;
+    outOfScreen: CSSProperties;
+    page: (pageDimension: PageDimension, pageMargin: PageMargin) => CSSProperties;
+    overlay: CSSProperties;
+    pageContent: CSSProperties;
+    sectionPageMedia: typeof sectionPageMedia;
+    section: (sectionId: string) => CSSProperties;
+};
+
 declare type SafeElement = Omit<Element, 'removeChild' | 'appendChild' | 'replaceChild' | 'remove'>;
 
 declare type SafeText = Omit<Text, 'remove'>;
 
+export declare interface ScheduleResult {
+    sections: SectionContext[];
+    suspension: Promise<void>;
+}
+
+export declare const sectionClassName = "pz-section";
+
+export declare interface SectionComponents {
+    sectionHeader: HTMLElement | null;
+    sectionFooter: HTMLElement | null;
+    pageHeader: HTMLElement | null;
+    pageFooter: HTMLElement | null;
+    pageContent: HTMLElement;
+}
+
+export declare interface SectionContext {
+    index: number;
+    sectionId: string;
+    isSuspended: boolean;
+    isPaginated: boolean;
+    pages: PageContext[];
+}
+
+export declare interface SectionOptions extends Partial<PaginationConfig> {
+    readonly id: string;
+    readonly dimension: PageDimension;
+    readonly margin?: PageMargin;
+    readonly suspense?: Promise<unknown>[];
+}
+
+declare function sectionPageMedia(sectionId: string, dimension: PageDimension): string;
+
+export declare interface SectionState {
+    options: SectionOptions;
+    context: SectionContext;
+    components: SectionComponents;
+    onPaginationCompleted: (pages: PageContext[]) => void;
+}
+
 export declare const sectionTocName = "sectionToc";
 
 export declare class SectionTocPlugin implements PaginationPlugin {
-    readonly state: SectionTocState[];
     readonly name = "sectionToc";
     readonly order = 1;
+    private _state;
+    getContentList: () => SectionTocState[];
     onVisitElement: (id: string, domState: DomState & {
         currentNode: PageElement;
     }, pageManager: PageManager) => void;
@@ -226,7 +443,7 @@ export declare class SectionTocPlugin implements PaginationPlugin {
 
 export declare type SectionTocState = {
     sectionId: string;
-    pageNumber: number;
+    pageIndex: number;
     title: string;
     level: number;
 };
@@ -239,6 +456,32 @@ export declare const SplitResult: {
 
 export declare type SplitResult = (typeof SplitResult)[keyof typeof SplitResult];
 
+export declare class TablePlugin implements PaginationPlugin {
+    private readonly _options;
+    name: string;
+    order: number;
+    constructor(options?: TablePluginOptions);
+    onNewPage: (_id: string, pageManager: PageManager) => void;
+    onClone: (_id: string, source: Element, cloned: PageElement) => void;
+    private _isTable;
+    private _isTableBodyEmpty;
+}
+
+export declare interface TablePluginOptions {
+    /**
+     * If true, the table header (thead) will be cloned on each page.
+     */
+    cloneHeader?: boolean;
+    /**
+     * If true, the table footer (tfoot) will be cloned on each page.
+     */
+    cloneFooter?: boolean;
+    /**
+     * When true, tables containing only a header (no body rows) will not be removed.
+     */
+    includeHeaderOnlyTables?: boolean;
+}
+
 export declare const tempContainerClassName = "pz-temp-container";
 
 declare class Transaction {
@@ -262,6 +505,7 @@ export { }
 
 declare global {
     interface Window {
+        [paprize_isInitialized]?: boolean;
         [paprize_isReady]?: boolean;
         [paprize_readJsonDataFile]?: () => Promise<string>;
     }