react-pdf-highlighter-plus 1.1.2 → 1.1.4

package/dist/esm/index.d.ts

@@ -1,6 +1,6 @@
-import { PDFDocumentProxy, OnProgressParameters } from 'pdfjs-dist';
 import React, { ReactNode, CSSProperties, MouseEvent as MouseEvent$1 } from 'react';
 import { Root } from 'react-dom/client';
+import { PDFDocumentProxy, OnProgressParameters } from 'pdfjs-dist';
 import { PDFViewer as PDFViewer$2 } from 'pdfjs-dist/types/web/pdf_viewer';
 import { PDFViewer as PDFViewer$3 } from 'pdfjs-dist/web/pdf_viewer.mjs';
 import { TypedArray, DocumentInitParameters } from 'pdfjs-dist/types/src/display/api';
@@ -249,6 +249,102 @@ interface ThumbnailData {
  */
 type LeftPanelTab = 'outline' | 'thumbnails';
 
+/**
+ * Options for the PDF export function.
+ *
+ * @category Type
+ */
+interface ExportPdfOptions {
+    /** Default color for text highlights. Default: "rgba(255, 226, 143, 0.5)" */
+    textHighlightColor?: string;
+    /** Default color for area highlights. Default: "rgba(255, 226, 143, 0.5)" */
+    areaHighlightColor?: string;
+    /** Default text color for freetext. Default: "#333333" */
+    defaultFreetextColor?: string;
+    /** Default background for freetext. Default: "#ffffc8" */
+    defaultFreetextBgColor?: string;
+    /** Default font size for freetext. Default: 14 */
+    defaultFreetextFontSize?: number;
+    /** Progress callback for large PDFs */
+    onProgress?: (current: number, total: number) => void;
+}
+/**
+ * A highlight that can be exported to PDF.
+ *
+ * @category Type
+ */
+interface ExportableHighlight {
+    id: string;
+    type?: "text" | "area" | "freetext" | "image" | "drawing" | "shape";
+    content?: {
+        text?: string;
+        image?: string;
+        shape?: ShapeData;
+    };
+    position: ScaledPosition;
+    /** Per-highlight color override (for text/area highlights) */
+    highlightColor?: string;
+    /** Style mode for text highlights: "highlight" (default), "underline", or "strikethrough" */
+    highlightStyle?: "highlight" | "underline" | "strikethrough";
+    /** Text color for freetext highlights */
+    color?: string;
+    /** Background color for freetext highlights */
+    backgroundColor?: string;
+    /** Font size for freetext highlights */
+    fontSize?: string;
+    /** Font family for freetext highlights (not used in export, Helvetica is always used) */
+    fontFamily?: string;
+    /** Shape type for shape highlights */
+    shapeType?: "rectangle" | "circle" | "arrow";
+    /** Stroke color for shape highlights */
+    strokeColor?: string;
+    /** Stroke width for shape highlights */
+    strokeWidth?: number;
+}
+/**
+ * Export a PDF with annotations embedded.
+ *
+ * @param pdfSource - The source PDF as a URL string, Uint8Array, or ArrayBuffer
+ * @param highlights - Array of highlights to embed in the PDF
+ * @param options - Export options for customizing colors and behavior
+ * @returns Promise<Uint8Array> - The modified PDF as bytes
+ *
+ * @example
+ * ```typescript
+ * const pdfBytes = await exportPdf(pdfUrl, highlights, {
+ *   textHighlightColor: "rgba(255, 255, 0, 0.4)",
+ *   onProgress: (current, total) => console.log(`${current}/${total} pages`)
+ * });
+ *
+ * // Download the file
+ * const blob = new Blob([pdfBytes], { type: "application/pdf" });
+ * const url = URL.createObjectURL(blob);
+ * const a = document.createElement("a");
+ * a.href = url;
+ * a.download = "annotated.pdf";
+ * a.click();
+ * URL.revokeObjectURL(url);
+ * ```
+ *
+ * @category Function
+ */
+declare function exportPdf$1(pdfSource: string | Uint8Array | ArrayBuffer, highlights: ExportableHighlight[], options?: ExportPdfOptions): Promise<Uint8Array>;
+
+/**
+ * Options for searching text in the PDF document.
+ *
+ * @category Type
+ */
+type PdfSearchOptions = {
+    /** If true, search is case-sensitive. */
+    caseSensitive?: boolean;
+    /** If true, only whole-word matches are returned. */
+    entireWord?: boolean;
+    /** If true, all matches are highlighted, not just the selected match. */
+    highlightAll?: boolean;
+    /** If true, diacritics must match exactly. */
+    matchDiacritics?: boolean;
+};
 /**
  * A set of utilities for to control the behaviour of {@link PdfHighlighter}.
  *
@@ -344,6 +440,25 @@ type PdfHighlighterUtils = {
      * @param pageNumber - 1-indexed page number to navigate to.
      */
     goToPage(pageNumber: number): void;
+    /**
+     * Search for text in the PDF document.
+     *
+     * @param query - Search text.
+     * @param options - Search options.
+     */
+    search(query: string, options?: PdfSearchOptions): void;
+    /**
+     * Move to the next search result.
+     */
+    findNext(): void;
+    /**
+     * Move to the previous search result.
+     */
+    findPrevious(): void;
+    /**
+     * Clear active search highlights.
+     */
+    clearSearch(): void;
 };
 /**
  * Custom hook for providing {@link PdfHighlighterUtils}. Must be used
@@ -643,6 +758,10 @@ interface TextHighlightProps {
      * Callback triggered when the style changes.
      */
     onStyleChange?(style: TextHighlightStyle): void;
+    /**
+     * Text to copy for this highlight.
+     */
+    copyText?: string;
     /**
      * Callback triggered when the delete button is clicked.
      */
@@ -666,7 +785,7 @@ interface TextHighlightProps {
  *
  * @category Component
  */
-declare const TextHighlight: ({ highlight, onClick, onMouseOver, onMouseOut, isScrolledTo, onContextMenu, style, highlightColor, highlightStyle, onStyleChange, onDelete, styleIcon, deleteIcon, colorPresets, }: TextHighlightProps) => React.JSX.Element;
+declare const TextHighlight: ({ highlight, onClick, onMouseOver, onMouseOut, isScrolledTo, onContextMenu, style, highlightColor, highlightStyle, onStyleChange, onDelete, styleIcon, deleteIcon, copyText, colorPresets, }: TextHighlightProps) => React.JSX.Element;
 
 /**
  * The props type for {@link MonitoredHighlightContainer}.
@@ -759,6 +878,10 @@ interface AreaHighlightProps {
      * Callback triggered when the style changes.
      */
     onStyleChange?(style: AreaHighlightStyle): void;
+    /**
+     * Text to copy for this area highlight.
+     */
+    copyText?: string;
     /**
      * Callback triggered when the delete button is clicked.
      */
@@ -782,7 +905,7 @@ interface AreaHighlightProps {
  *
  * @category Component
  */
-declare const AreaHighlight: ({ highlight, onChange, isScrolledTo, bounds, onContextMenu, onEditStart, style, highlightColor, onStyleChange, onDelete, styleIcon, deleteIcon, colorPresets, }: AreaHighlightProps) => React.JSX.Element;
+declare const AreaHighlight: ({ highlight, onChange, isScrolledTo, bounds, onContextMenu, onEditStart, style, highlightColor, onStyleChange, onDelete, styleIcon, deleteIcon, copyText, colorPresets, }: AreaHighlightProps) => React.JSX.Element;
 
 /**
  * Style options for freetext highlight appearance.
@@ -891,8 +1014,20 @@ interface FreetextHighlightProps {
      * Custom delete icon. Replaces the default trash icon.
      */
     deleteIcon?: ReactNode;
+    /**
+     * Render the note as a compact marker until opened.
+     */
+    compact?: boolean;
+    /**
+     * Size of the compact marker in pixels.
+     */
+    compactSize?: number;
+    /**
+     * Custom compact marker icon.
+     */
+    compactIcon?: ReactNode;
 }
-declare const FreetextHighlight: ({ highlight, onChange, onTextChange, onStyleChange, isScrolledTo, bounds, onContextMenu, onEditStart, onEditEnd, style, color, backgroundColor, fontFamily, fontSize, dragIcon, editIcon, styleIcon, backgroundColorPresets, textColorPresets, onDelete, deleteIcon, }: FreetextHighlightProps) => React.JSX.Element;
+declare const FreetextHighlight: ({ highlight, onChange, onTextChange, onStyleChange, isScrolledTo, bounds, onContextMenu, onEditStart, onEditEnd, style, color, backgroundColor, fontFamily, fontSize, dragIcon, editIcon, styleIcon, backgroundColorPresets, textColorPresets, onDelete, deleteIcon, compact, compactSize, compactIcon, }: FreetextHighlightProps) => React.JSX.Element;
 
 /**
  * The props type for {@link ImageHighlight}.
@@ -1301,8 +1436,8 @@ interface PdfLoaderProps {
      */
     onError?(error: Error): void;
     /**
-     * NOTE: This will be applied to all PdfLoader instances.
-     * If you want to only apply a source to this instance, use the document parameters.
+     * Optional PDF.js worker source override. By default, PdfLoader resolves the
+     * worker from the installed pdfjs-dist package so bundlers can emit it locally.
      */
     workerSrc?: string;
 }
@@ -1360,86 +1495,77 @@ declare const viewportPositionToScaled: ({ boundingRect, rects }: ViewportPositi
 /** @category Utilities */
 declare const scaledPositionToViewport: ({ boundingRect, rects, usePdfCoordinates }: ScaledPosition, viewer: PDFViewer$2) => ViewportPosition;
 
-/**
- * Options for the PDF export function.
- *
- * @category Type
- */
-interface ExportPdfOptions {
-    /** Default color for text highlights. Default: "rgba(255, 226, 143, 0.5)" */
-    textHighlightColor?: string;
-    /** Default color for area highlights. Default: "rgba(255, 226, 143, 0.5)" */
-    areaHighlightColor?: string;
-    /** Default text color for freetext. Default: "#333333" */
-    defaultFreetextColor?: string;
-    /** Default background for freetext. Default: "#ffffc8" */
-    defaultFreetextBgColor?: string;
-    /** Default font size for freetext. Default: 14 */
-    defaultFreetextFontSize?: number;
-    /** Progress callback for large PDFs */
-    onProgress?: (current: number, total: number) => void;
-}
-/**
- * A highlight that can be exported to PDF.
- *
- * @category Type
- */
-interface ExportableHighlight {
+type PdfTextItem = {
+    text: string;
+    index: number;
+    pageNumber: number;
+    rect: LTWHP;
+    fontName?: string;
+    columnIndex?: number;
+};
+type PdfTextColumn = {
+    index: number;
+    left: number;
+    right: number;
+    width: number;
+    textItemIndexes: number[];
+};
+type PdfExtractedPage = {
+    pageNumber: number;
+    width: number;
+    height: number;
+    textItems: PdfTextItem[];
+    columns?: PdfTextColumn[];
+};
+type PdfTextUnitType = "paragraph" | "title" | "heading" | "author" | "affiliation" | "footnote" | "reference" | "unknown";
+type PdfTextUnit = {
     id: string;
-    type?: "text" | "area" | "freetext" | "image" | "drawing" | "shape";
-    content?: {
-        text?: string;
-        image?: string;
-        shape?: ShapeData;
+    type: PdfTextUnitType;
+    text: string;
+    rawText: string;
+    pageNumber: number;
+    indexInPage: number;
+    columnIndex?: number;
+    position?: ScaledPosition;
+    source?: {
+        textItemIndexes: number[];
     };
-    position: ScaledPosition;
-    /** Per-highlight color override (for text/area highlights) */
-    highlightColor?: string;
-    /** Style mode for text highlights: "highlight" (default), "underline", or "strikethrough" */
-    highlightStyle?: "highlight" | "underline" | "strikethrough";
-    /** Text color for freetext highlights */
-    color?: string;
-    /** Background color for freetext highlights */
-    backgroundColor?: string;
-    /** Font size for freetext highlights */
-    fontSize?: string;
-    /** Font family for freetext highlights (not used in export, Helvetica is always used) */
-    fontFamily?: string;
-    /** Shape type for shape highlights */
-    shapeType?: "rectangle" | "circle" | "arrow";
-    /** Stroke color for shape highlights */
-    strokeColor?: string;
-    /** Stroke width for shape highlights */
-    strokeWidth?: number;
-}
-/**
- * Export a PDF with annotations embedded.
- *
- * @param pdfSource - The source PDF as a URL string, Uint8Array, or ArrayBuffer
- * @param highlights - Array of highlights to embed in the PDF
- * @param options - Export options for customizing colors and behavior
- * @returns Promise<Uint8Array> - The modified PDF as bytes
- *
- * @example
- * ```typescript
- * const pdfBytes = await exportPdf(pdfUrl, highlights, {
- *   textHighlightColor: "rgba(255, 255, 0, 0.4)",
- *   onProgress: (current, total) => console.log(`${current}/${total} pages`)
- * });
- *
- * // Download the file
- * const blob = new Blob([pdfBytes], { type: "application/pdf" });
- * const url = URL.createObjectURL(blob);
- * const a = document.createElement("a");
- * a.href = url;
- * a.download = "annotated.pdf";
- * a.click();
- * URL.revokeObjectURL(url);
- * ```
- *
- * @category Function
- */
-declare function exportPdf(pdfSource: string | Uint8Array | ArrayBuffer, highlights: ExportableHighlight[], options?: ExportPdfOptions): Promise<Uint8Array>;
+};
+type PdfSentenceSource = {
+    startOffset: number;
+    endOffset: number;
+    textItemIndexes: number[];
+};
+type PdfSentence = {
+    id: string;
+    text: string;
+    rawText: string;
+    pageNumber: number;
+    indexInPage: number;
+    globalIndex: number;
+    columnIndex?: number;
+    position?: ScaledPosition;
+    source?: PdfSentenceSource;
+};
+type PdfReadingOrder = "auto" | "document" | "position";
+type PdfColumnDetection = "auto" | "none";
+type ExtractSentencesOptions = {
+    pages?: "all" | number[];
+    includePositions?: boolean;
+    includeSources?: boolean;
+    normalize?: boolean;
+    locale?: string;
+    idPrefix?: string;
+    includeTextUnitTypes?: PdfTextUnitType[];
+    readingOrder?: PdfReadingOrder;
+    columnDetection?: PdfColumnDetection;
+};
+declare const extractTextUnits: (pdfDocument: PDFDocumentProxy, options?: ExtractSentencesOptions) => Promise<PdfTextUnit[]>;
+declare const extractPageTextItems: (pdfDocument: PDFDocumentProxy, options?: Pick<ExtractSentencesOptions, "pages" | "columnDetection">) => Promise<PdfExtractedPage[]>;
+declare const extractSentences: (pdfDocument: PDFDocumentProxy, options?: ExtractSentencesOptions) => Promise<PdfSentence[]>;
+declare const sentenceToHighlight: (sentence: PdfSentence, options?: {
+    id?: string;
+}) => Highlight;
 
 /** Style configuration for outline items */
 interface OutlineItemStyles {
@@ -1902,4 +2028,6 @@ interface UsePageNavigationResult {
  */
 declare function usePageNavigation(options: UsePageNavigationOptions): UsePageNavigationResult;
 
-export { AreaHighlight, type AreaHighlightProps, type AreaHighlightStyle, type Content, DocumentOutline, type DocumentOutlineClassNames, type DocumentOutlineProps, type DocumentOutlineStyles, DrawingCanvas, type DrawingCanvasProps, DrawingHighlight, type DrawingHighlightProps, type DrawingPoint, type DrawingStroke, type ExportPdfOptions, type ExportableHighlight, type FooterClassNames, type FooterStyles, FreetextHighlight, type FreetextHighlightProps, type FreetextStyle, type GhostHighlight, type Highlight, type HighlightBindings, type HighlightContainerUtils, type HighlightType, ImageHighlight, type ImageHighlightProps, type LTWH, type LTWHP, LeftPanel, type LeftPanelProps, type LeftPanelTab, type LeftPanelTheme, type LeftPanelUtils, MonitoredHighlightContainer, type MonitoredHighlightContainerProps, OutlineItem, type OutlineItemClassNames, type OutlineItemProps, type OutlineItemRenderProps, type OutlineItemStyles, type Page, PdfHighlighter, type PdfHighlighterProps, type PdfHighlighterTheme, type PdfHighlighterUtils, PdfLoader, type PdfLoaderProps, type PdfScaleValue, type PdfSelection, type ProcessedOutlineItem, type Scaled, type ScaledPosition, ShapeCanvas, type ShapeCanvasProps, type ShapeData, ShapeHighlight, type ShapeHighlightProps, type ShapeStyle, type ShapeType, SignaturePad, type SignaturePadProps, type TabClassNames, type TabStyles, TextHighlight, type TextHighlightProps, type TextHighlightStyle, type ThumbnailData, ThumbnailItem, type ThumbnailItemProps, ThumbnailPanel, type ThumbnailPanelProps, type Tip, type ToggleButtonClassNames, type ToggleButtonStyles, type ViewportHighlight, type ViewportPosition, exportPdf, scaledPositionToViewport, useDocumentOutline, useHighlightContainerContext, useLeftPanelContext, usePageNavigation, usePdfHighlighterContext, useThumbnails, viewportPositionToScaled };
+declare const exportPdf: typeof exportPdf$1;
+
+export { AreaHighlight, type AreaHighlightProps, type AreaHighlightStyle, type Content, DocumentOutline, type DocumentOutlineClassNames, type DocumentOutlineProps, type DocumentOutlineStyles, DrawingCanvas, type DrawingCanvasProps, DrawingHighlight, type DrawingHighlightProps, type DrawingPoint, type DrawingStroke, type ExportPdfOptions, type ExportableHighlight, type ExtractSentencesOptions, type FooterClassNames, type FooterStyles, FreetextHighlight, type FreetextHighlightProps, type FreetextStyle, type GhostHighlight, type Highlight, type HighlightBindings, type HighlightContainerUtils, type HighlightType, ImageHighlight, type ImageHighlightProps, type LTWH, type LTWHP, LeftPanel, type LeftPanelProps, type LeftPanelTab, type LeftPanelTheme, type LeftPanelUtils, MonitoredHighlightContainer, type MonitoredHighlightContainerProps, OutlineItem, type OutlineItemClassNames, type OutlineItemProps, type OutlineItemRenderProps, type OutlineItemStyles, type Page, type PdfColumnDetection, type PdfExtractedPage, PdfHighlighter, type PdfHighlighterProps, type PdfHighlighterTheme, type PdfHighlighterUtils, PdfLoader, type PdfLoaderProps, type PdfReadingOrder, type PdfScaleValue, type PdfSearchOptions, type PdfSelection, type PdfSentence, type PdfSentenceSource, type PdfTextColumn, type PdfTextItem, type PdfTextUnit, type PdfTextUnitType, type ProcessedOutlineItem, type Scaled, type ScaledPosition, ShapeCanvas, type ShapeCanvasProps, type ShapeData, ShapeHighlight, type ShapeHighlightProps, type ShapeStyle, type ShapeType, SignaturePad, type SignaturePadProps, type TabClassNames, type TabStyles, TextHighlight, type TextHighlightProps, type TextHighlightStyle, type ThumbnailData, ThumbnailItem, type ThumbnailItemProps, ThumbnailPanel, type ThumbnailPanelProps, type Tip, type ToggleButtonClassNames, type ToggleButtonStyles, type ViewportHighlight, type ViewportPosition, exportPdf, extractPageTextItems, extractSentences, extractTextUnits, scaledPositionToViewport, sentenceToHighlight, useDocumentOutline, useHighlightContainerContext, useLeftPanelContext, usePageNavigation, usePdfHighlighterContext, useThumbnails, viewportPositionToScaled };