@anaralabs/lector 3.9.1 → 3.10.1

package/dist/_tsup-dts-rollup.d.ts

@@ -4,11 +4,12 @@ import type { DocumentInitParameters } from 'pdfjs-dist/types/src/display/api';
 import { ForwardRefExoticComponent } from 'react';
 import { FunctionComponent } from 'react';
 import { HTMLProps } from 'react';
-import type { IPDFLinkService } from 'pdfjs-dist/types/web/interfaces';
 import { JSX } from 'react/jsx-runtime';
-import type { JSX as JSX_2 } from 'react';
+import { JSX as JSX_2 } from 'react';
+import { MemoExoticComponent } from 'react';
 import type { PageViewport } from 'pdfjs-dist';
-import { PDFDocumentProxy } from 'pdfjs-dist';
+import type { PDFDocumentProxy } from 'pdfjs-dist';
+import { pdfjsDist } from 'pdfjs-dist';
 import type { PDFPageProxy } from 'pdfjs-dist';
 import type { default as React_2 } from 'react';
 import { ReactElement } from 'react';
@@ -37,7 +38,7 @@ declare interface Annotation {
 export { Annotation }
 export { Annotation as Annotation_alias_1 }
 
-export declare const AnnotationHighlightLayer: ({ className, style, renderTooltipContent, renderHoverTooltipContent, tooltipClassName, highlightClassName, underlineClassName, commentIconPosition, commmentIcon, commentIconClassName, focusedAnnotationId, focusedHoverAnnotationId, onAnnotationClick, onAnnotationTooltipClose, hoverTooltipClassName, }: AnnotationHighlightLayerProps) => JSX.Element;
+export declare const AnnotationHighlightLayer: ({ className, style, renderTooltipContent, renderHoverTooltipContent, tooltipClassName, highlightClassName, underlineClassName, commentIconPosition, commmentIcon, commentIconClassName, focusedAnnotationId, focusedHoverAnnotationId, onAnnotationClick, onAnnotationTooltipClose, hoverTooltipClassName, }: AnnotationHighlightLayerProps) => JSX.Element | null;
 
 declare interface AnnotationHighlightLayerProps {
     className?: string;
@@ -68,7 +69,7 @@ declare interface AnnotationHighlightLayerProps {
  * @param jumpOptions - Options for page navigation behavior when clicking internal links.
  *                      See `usePdfJump` hook for available options.
  */
-export declare const AnnotationLayer: ({ renderForms, externalLinksEnabled, jumpOptions, className, style, ...props }: AnnotationLayerParams & HTMLProps<HTMLDivElement>) => JSX.Element;
+export declare const AnnotationLayer: MemoExoticComponent<({ renderForms, externalLinksEnabled, jumpOptions, className, style, ...props }: AnnotationLayerParams & HTMLProps<HTMLDivElement>) => JSX.Element>;
 
 declare interface AnnotationLayerParams {
     /**
@@ -123,6 +124,12 @@ declare interface AnnotationTooltipProps {
     }) => React.ReactNode;
 }
 
+declare type CacheEntry = {
+    bitmap: ImageBitmap;
+    width: number;
+    height: number;
+};
+
 /**
  * Calculates the highlight rectangles for a given text match.
  *
@@ -142,12 +149,14 @@ export declare const cancellable: <T extends Promise<unknown>>(promise: T) => {
     cancel: () => void;
 };
 
-export declare const CanvasLayer: ({ style, background, ...props }: HTMLProps<HTMLCanvasElement> & {
-    background?: string;
-}) => JSX.Element;
+export declare const CanvasLayer: MemoExoticComponent<({ style, background, ...props }: HTMLProps<HTMLCanvasElement> & {
+background?: string;
+}) => JSX.Element>;
 
 export declare const clamp: (value: number, minimum: number, maximum: number) => number;
 
+export declare function clampScaleForPage(targetScale: number, pageWidth: number, pageHeight: number): number;
+
 declare type CollapsibleSelection = {
     highlights: HighlightRect[];
     underlines?: HighlightRect[];
@@ -175,9 +184,11 @@ export declare const CurrentPage: ({ ...props }: HTMLProps<HTMLInputElement>) =>
 
 export declare const CurrentZoom: ({ ...props }: HTMLProps<HTMLInputElement>) => JSX.Element;
 
-export declare const CustomLayer: ({ children, }: {
-    children: (pageNumber: number) => JSX_2.Element;
-}) => JSX_2.Element;
+export declare const CustomLayer: MemoExoticComponent<({ children }: {
+children: (pageNumber: number) => JSX_2.Element;
+}) => JSX_2.Element>;
+
+export declare const ensureAnnotationLayerStyles: () => void;
 
 export declare const firstMemo: <T>(first: boolean, memo: unknown, initializer: () => T) => T;
 
@@ -225,7 +236,7 @@ export declare interface InitialPDFState {
     zoomOptions?: ZoomOptions;
 }
 
-export declare class LinkService implements IPDFLinkService {
+export declare class LinkService {
     _pdfDocumentProxy?: PDFDocumentProxy;
     externalLinkEnabled: boolean;
     isInPresentationMode: boolean;
@@ -252,6 +263,12 @@ export declare class LinkService implements IPDFLinkService {
     unregisterPageNavigationCallback(): void;
 }
 
+export declare const loadPdfJs: () => Promise<pdfjsDist>;
+
+export declare const MAX_CANVAS_DIMENSION = 32767;
+
+export declare const MAX_CANVAS_PIXELS = 16777216;
+
 export declare const NextPage: () => void;
 
 export declare const Outline: ({ children, ...props }: HTMLProps<HTMLUListElement> & {
@@ -273,10 +290,10 @@ declare interface OutlineItemProps extends HTMLProps<HTMLDivElement> {
 
 declare type OutlineItemType = NonNullable<ReturnType<typeof usePDFOutline>>[number];
 
-export declare const Page: ({ children, pageNumber, style, ...props }: HTMLProps<HTMLDivElement> & {
-    children: ReactNode;
-    pageNumber?: number;
-}) => JSX.Element;
+export declare const Page: MemoExoticComponent<({ children, pageNumber, style, ...props }: HTMLProps<HTMLDivElement> & {
+children: ReactNode;
+pageNumber?: number;
+}) => JSX.Element>;
 
 export declare const Pages: ({ children, gap, virtualizerOptions, initialOffset, onOffsetChange, ...props }: HTMLProps<HTMLDivElement> & {
     virtualizerOptions?: {
@@ -316,6 +333,9 @@ declare interface PDFState {
     coloredHighlights: ColoredHighlight[];
     addColoredHighlight: (value: ColoredHighlight) => void;
     deleteColoredHighlight: (uuid: string) => void;
+    renderedPages: Record<number, true>;
+    markPageRendered: (pageNumber: number) => void;
+    unmarkPageRendered: (pageNumber: number) => void;
 }
 
 export declare const PDFStore: {
@@ -331,6 +351,51 @@ export declare type PDFVirtualizer = Virtualizer<any, any>;
 
 export declare const PreviousPage: () => void;
 
+/**
+ * LRU cache for rendered page bitmaps. When scrolling back to a previously
+ * rendered page at the same scale, we can draw from cache instantly instead
+ * of re-rendering through PDF.js.
+ *
+ * Cache keys include a document ID to prevent collisions when multiple
+ * <Root> instances render different PDFs on the same page.
+ */
+declare class RenderCache {
+    private cache;
+    private maxEntries;
+    private invalidatedDocs;
+    constructor(maxEntries?: number);
+    private key;
+    get(documentId: string, pageNumber: number, scale: number, background?: string): CacheEntry | undefined;
+    set(documentId: string, pageNumber: number, scale: number, canvas: HTMLCanvasElement, background?: string): Promise<void>;
+    /** Remove all cached entries for a specific document (call on Root unmount). */
+    invalidateDocument(documentId: string): void;
+    clear(): void;
+}
+
+export declare const renderCache: RenderCache;
+
+/**
+ * Serializes PDF page render operations so only one runs at a time.
+ * This prevents multiple heavy pages from competing for CPU and blocking the UI.
+ */
+declare class RenderQueue {
+    private queue;
+    private running;
+    enqueue(execute: () => Promise<void>): {
+        promise: Promise<void>;
+        cancel: () => void;
+    };
+    private flush;
+}
+
+/**
+ * Global singleton — intentionally shared across all <Root> instances.
+ * Serializing renders across documents prevents overall GPU/CPU pressure
+ * on the main thread (CanvasGraphics is single-threaded). The trade-off
+ * is increased latency in multi-viewer setups.
+ */
+export declare const renderQueue: RenderQueue;
+
 export declare const Root: ForwardRefExoticComponent<Omit<HTMLProps<HTMLDivElement> & usePDFDocumentParams & {
 loader?: ReactNode;
 }, "ref"> & RefAttributes<unknown>>;
@@ -371,12 +436,14 @@ declare interface SelectionTooltipProps {
 
 export declare type Source = string | URL | TypedArray | ArrayBuffer | DocumentInitParameters;
 
+export declare const subscribeToViewportInvalidation: (viewport: HTMLDivElement, callback: ViewportCallback) => () => void;
+
 declare type TextContent = {
     pageNumber: number;
     text: string;
 };
 
-export declare const TextLayer: ({ className, style, ...props }: HTMLProps<HTMLDivElement>) => JSX.Element;
+export declare const TextLayer: MemoExoticComponent<({ className, style, ...props }: HTMLProps<HTMLDivElement>) => JSX.Element>;
 
 declare interface TextPosition {
     pageNumber: number;
@@ -419,11 +486,15 @@ declare interface UseAnnotationTooltipReturn {
 
 export declare const useCreatePDFLinkService: (pdfDocumentProxy: PDFDocumentProxy | null) => LinkService;
 
+declare const usePageRendered: (pageNumber: number) => boolean;
+export { usePageRendered }
+export { usePageRendered as usePageRendered_alias_1 }
+
 declare const usePdf: <T>(selector: (state: PDFState) => T) => T;
 export { usePdf }
 export { usePdf as usePdf_alias_1 }
 
-export declare const usePDFDocumentContext: ({ onDocumentLoad, source, initialRotation, isZoomFitWidth, zoom, zoomOptions, }: usePDFDocumentParams) => {
+export declare const usePDFDocumentContext: ({ onDocumentLoad, source, initialRotation, isZoomFitWidth, zoom, zoomOptions, documentOptions, }: usePDFDocumentParams) => {
     initialState: InitialPDFState | null | undefined;
 };
 
@@ -440,6 +511,12 @@ export declare interface usePDFDocumentParams {
     isZoomFitWidth?: boolean;
     zoom?: number;
     zoomOptions?: ZoomOptions;
+    /**
+     * Override or extend the PDF.js DocumentInitParameters passed to getDocument().
+     * These take highest precedence over both the source object and lector's defaults.
+     * Must be a stable reference (module-level constant or useMemo) to avoid reloading the document.
+     */
+    documentOptions?: Partial<DocumentInitParameters>;
 }
 
 export declare const usePdfJump: () => {
@@ -494,6 +571,8 @@ export declare const useSelectionDimensions: () => {
     } | undefined;
 };
 
+declare type ViewportCallback = () => void;
+
 export declare const ZoomIn: ({ ...props }: HTMLProps<HTMLButtonElement>) => JSX.Element;
 
 export declare interface ZoomOptions {

package/dist/index.d.ts

@@ -31,6 +31,7 @@ export { useSearch } from './_tsup-dts-rollup.js';
 export { calculateHighlightRects } from './_tsup-dts-rollup.js';
 export { Annotation } from './_tsup-dts-rollup.js';
 export { useAnnotations } from './_tsup-dts-rollup.js';
+export { usePageRendered } from './_tsup-dts-rollup.js';
 export { LinkService } from './_tsup-dts-rollup.js';
 export { PDFLinkServiceContext } from './_tsup-dts-rollup.js';
 export { useCreatePDFLinkService } from './_tsup-dts-rollup.js';