@paprize/core 0.0.2 → 0.0.4

package/dist/paprize-core.d.ts

@@ -36,6 +36,8 @@ export declare const currentElementClassName = "pz-current-element";
 
 export declare const currentTextClassName = "pz-current-text";
 
+export declare const debugPlugin: PaginationPlugin;
+
 export declare const defaultPlugins: PaginationPlugin[];
 
 export declare class DomState {
@@ -124,6 +126,7 @@ declare class PageManager {
     markPageAsFull(): void;
     appendChild(node: PageElement, withChildren: boolean): PageElement;
     addTextNode(text: string): PageText;
+    getPageState(): PageState;
 }
 
 declare type PageNode = PageElement | PageText;
@@ -161,20 +164,22 @@ declare class PageText {
 export declare type PaginateResult = string[];
 
 export declare type PaginationConfig = Required<ConfigAttribute> & {
+    id: string;
     plugins: PaginationPlugin[];
 };
 
 export declare interface PaginationPlugin {
     readonly name: string;
-    onVisitText?: (domState: DomState & {
+    readonly order: number;
+    onVisitText?: (id: string, domState: DomState & {
         currentNode: PageText;
     }, pageManager: PageManager, context: VisitContext) => void;
-    onVisitElement?: (domState: DomState & {
+    onVisitElement?: (id: string, domState: DomState & {
         currentNode: PageElement;
     }, pageManager: PageManager, context: VisitContext) => void;
-    afterVisitNode?: (domState: DomState, pageManager: PageManager) => void;
-    onNewPage?: (newPageState: PageState) => void;
-    onClone?: (source: Element, cloned: PageElement) => void;
+    afterVisitNode?: (id: string, domState: DomState, pageManager: PageManager) => void;
+    onNewPage?: (id: string, pageManager: PageManager) => void;
+    onClone?: (id: string, source: Element, cloned: PageElement) => void;
 }
 
 export declare class Paginator {
@@ -193,6 +198,10 @@ export declare class Paginator {
     private processCurrentNode;
 }
 
+export declare const paprize_isReady = "__PAPRIZE_IS_READY";
+
+export declare const paprize_readJsonDataFile = "__PAPRIZE_READ_JSON_DATA_FILE";
+
 declare type PluginHookNames = NonNullable<PluginKeys>;
 
 declare type PluginKeys = {
@@ -203,6 +212,25 @@ declare type SafeElement = Omit<Element, 'removeChild' | 'appendChild' | 'replac
 
 declare type SafeText = Omit<Text, 'remove'>;
 
+export declare const sectionTocName = "sectionToc";
+
+export declare class SectionTocPlugin implements PaginationPlugin {
+    readonly state: SectionTocState[];
+    readonly name = "sectionToc";
+    readonly order = 1;
+    onVisitElement: (id: string, domState: DomState & {
+        currentNode: PageElement;
+    }, pageManager: PageManager) => void;
+    getHeadingLevel(node: SafeElement): number | null;
+}
+
+export declare type SectionTocState = {
+    sectionId: string;
+    pageNumber: number;
+    title: string;
+    level: number;
+};
+
 export declare const SplitResult: {
     readonly None: 0;
     readonly FullNodePlaced: 1;
@@ -230,3 +258,11 @@ export declare interface VisitContext {
 }
 
 export { }
+
+
+declare global {
+    interface Window {
+        [paprize_isReady]?: boolean;
+        [paprize_readJsonDataFile]?: () => Promise<string>;
+    }
+}