@paprize/core 0.0.6 → 0.0.8

package/dist/paprize-core.d.ts

@@ -50,7 +50,7 @@ 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;
+    dispatch<T extends keyof TEvents>(name: T, ...args: Parameters<EventHandler<T, TEvents>>): Promise<void>;
 }
 
 declare type EventHandler<TKey extends keyof TEvents, TEvents> = TEvents[TKey] extends (...args: infer TArgs) => infer TReturn ? (...args: TArgs) => TReturn : never;
@@ -405,7 +405,7 @@ export declare class ReportBuilder {
      * @param onPaginationCompleted - Callback invoked when pagination for the section is completed.
      * @returns `true` if the section was added to the report’s section list, or `false` if it already exists.
      */
-    tryAddSection(options: SectionOptions, components: SectionComponents, onPaginationCompleted: (pages: PageContext[]) => void): boolean;
+    tryAddSection(options: SectionOptions, components: SectionComponents, onPaginationCompleted: SectionState['onPaginationCompleted']): Promise<boolean>;
     /**
      * Schedules a pagination operation.
      *
@@ -422,6 +422,22 @@ export declare class ReportBuilder {
      * `suspension` property of the returned result object.
      */
     schedulePagination(): Promise<ScheduleResult>;
+    /**
+     * 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.
+     *
+     * @template T - The expected type of the injected JSON data.
+     * @param defaultData - Optional fallback value to return if no injected data is found.
+     * @returns A promise resolving to the injected JSON data if available, otherwise the provided default value or `null`.
+     */
+    getJsonData<T>(defaultData?: T): Promise<T | null>;
+    private _lazyJsonDataReader;
     private _executePagination;
     private _processPendingPagination;
     private _injectStyle;
@@ -454,6 +470,10 @@ export declare interface ReportBuilderEvents {
     paginationCycleCompleted: (event: PaginationCycleCompleted) => void;
 }
 
+export declare interface ReportContext {
+    jsonData: unknown | null;
+}
+
 export declare const reportStyles: {
     globalStyle: string;
     component: CSSProperties;
@@ -581,7 +601,7 @@ export declare interface SectionState {
     options: SectionOptions;
     context: SectionContext;
     components: SectionComponents;
-    onPaginationCompleted: (pages: PageContext[]) => void;
+    onPaginationCompleted: (pages: PageContext[]) => Promise<unknown> | void;
 }
 
 export declare const sectionTocName = "sectionToc";