pdf-search-highlight 0.1.0

package/dist/PDFSearchViewer-8kMeXl51.d.cts

@@ -0,0 +1,184 @@
+type Listener<T> = (data: T) => void;
+declare class EventEmitter<EventMap extends {
+    [key: string]: unknown;
+}> {
+    private listeners;
+    on<K extends keyof EventMap>(event: K, listener: Listener<EventMap[K]>): this;
+    off<K extends keyof EventMap>(event: K, listener: Listener<EventMap[K]>): this;
+    protected emit<K extends keyof EventMap>(event: K, data: EventMap[K]): void;
+    removeAllListeners(): void;
+}
+
+/**
+ * Custom CSS class names for each part of the viewer.
+ * All are optional — defaults are applied if omitted.
+ */
+interface ClassNames {
+    /** Root container. Default: 'psh-container' */
+    container?: string;
+    /** Each page wrapper. Default: 'psh-page' */
+    page?: string;
+    /** Canvas element. Default: 'psh-canvas' */
+    canvas?: string;
+    /** Text layer overlay. Default: 'psh-text-layer' */
+    textLayer?: string;
+    /** Page label (e.g. "Page 1 / 5"). Default: 'psh-page-label' */
+    pageLabel?: string;
+    /** Highlight <mark>. Default: 'highlight' */
+    highlight?: string;
+    /** Active highlight modifier. Default: 'active' */
+    activeHighlight?: string;
+}
+interface PDFSearchViewerOptions {
+    /** Scale factor. 'auto' = fit container width. Defaults to 'auto'. */
+    scale?: number | 'auto';
+    /** Path or URL to pdf.js worker script. */
+    workerSrc?: string;
+    /** Gap in pixels between rendered pages. Defaults to 20. */
+    pageGap?: number;
+    /**
+     * Custom CSS class names for viewer elements.
+     * Override any or all to apply your own styles.
+     *
+     * ```js
+     * classNames: {
+     *   page: 'my-page',
+     *   highlight: 'my-highlight',
+     *   activeHighlight: 'my-active',
+     * }
+     * ```
+     */
+    classNames?: ClassNames;
+}
+interface SearchOptions {
+    /** Case-sensitive matching. Defaults to false. */
+    caseSensitive?: boolean;
+    /**
+     * Flexible whitespace matching: insert \s* between every character.
+     * Handles PDF text split inconsistencies. Defaults to true.
+     * Only applies for queries < 200 chars (performance).
+     */
+    flexibleWhitespace?: boolean;
+}
+
+type PDFSearchViewerEventMap = {
+    /** Fired when PDF finishes loading. */
+    load: {
+        pageCount: number;
+    };
+    /** Fired when a search completes. */
+    search: {
+        query: string;
+        total: number;
+    };
+    /** Fired when active match changes (via next/prev). */
+    matchchange: {
+        current: number;
+        total: number;
+    };
+    /** Fired on error. */
+    error: {
+        error: Error;
+        context: string;
+    };
+};
+
+/**
+ * A single search match, potentially spanning multiple spans.
+ * Each match contains an array of <mark> elements that highlight
+ * the matched text across one or more text layer spans.
+ */
+interface SearchMatch {
+    /** The <mark> elements for this match (may span multiple spans). */
+    marks: HTMLElement[];
+}
+/**
+ * Internal span data for a rendered page.
+ */
+interface SpanData {
+    /** The DOM element in the text layer. */
+    el: HTMLElement;
+    /** Original text content. */
+    text: string;
+    /** Whether this span has end-of-line. */
+    hasEOL: boolean;
+}
+/**
+ * Internal page data after rendering.
+ */
+interface PageData {
+    /** Page wrapper container element. */
+    container: HTMLElement;
+    /** All text spans on this page. */
+    spans: SpanData[];
+}
+
+type PDFSource = File | ArrayBuffer | Uint8Array | string;
+/**
+ * Main PDF viewer with search and highlight functionality.
+ *
+ * Usage:
+ * ```js
+ * import * as pdfjsLib from 'pdfjs-dist';
+ * import { PDFSearchViewer } from 'pdf-search-highlight';
+ *
+ * const viewer = new PDFSearchViewer(container, pdfjsLib, {
+ *   classNames: {
+ *     page: 'my-page',
+ *     highlight: 'my-highlight',
+ *     activeHighlight: 'my-active',
+ *   }
+ * });
+ * await viewer.loadPDF(file);
+ * viewer.search('hello');
+ * viewer.nextMatch();
+ * ```
+ */
+declare class PDFSearchViewer extends EventEmitter<PDFSearchViewerEventMap> {
+    private renderer;
+    private highlightManager;
+    private pageData;
+    private lastQuery;
+    private lastSearchOptions;
+    private destroyed;
+    constructor(container: HTMLElement, pdfjsLib: any, options?: PDFSearchViewerOptions);
+    /**
+     * Load and render a PDF document.
+     */
+    loadPDF(source: PDFSource): Promise<void>;
+    /**
+     * Search for text across all pages.
+     * Clears previous highlights and creates new ones.
+     */
+    search(query: string, options?: SearchOptions): number;
+    /**
+     * Navigate to next match (wraps around).
+     */
+    nextMatch(): number;
+    /**
+     * Navigate to previous match (wraps around).
+     */
+    prevMatch(): number;
+    /**
+     * Clear all search highlights.
+     */
+    clearSearch(): void;
+    /**
+     * Get total number of pages.
+     */
+    getPageCount(): number;
+    /**
+     * Get current active match index (0-based). -1 if none.
+     */
+    getCurrentMatchIndex(): number;
+    /**
+     * Get total number of matches.
+     */
+    getMatchCount(): number;
+    /**
+     * Destroy the viewer, release all resources.
+     */
+    destroy(): void;
+}
+
+export { type ClassNames as C, EventEmitter as E, type PageData as P, type SearchOptions as S, type PDFSearchViewerOptions as a, type SpanData as b, type SearchMatch as c, PDFSearchViewer as d, type PDFSearchViewerEventMap as e, type PDFSource as f };

package/dist/PDFSearchViewer-8kMeXl51.d.ts

@@ -0,0 +1,184 @@
+type Listener<T> = (data: T) => void;
+declare class EventEmitter<EventMap extends {
+    [key: string]: unknown;
+}> {
+    private listeners;
+    on<K extends keyof EventMap>(event: K, listener: Listener<EventMap[K]>): this;
+    off<K extends keyof EventMap>(event: K, listener: Listener<EventMap[K]>): this;
+    protected emit<K extends keyof EventMap>(event: K, data: EventMap[K]): void;
+    removeAllListeners(): void;
+}
+
+/**
+ * Custom CSS class names for each part of the viewer.
+ * All are optional — defaults are applied if omitted.
+ */
+interface ClassNames {
+    /** Root container. Default: 'psh-container' */
+    container?: string;
+    /** Each page wrapper. Default: 'psh-page' */
+    page?: string;
+    /** Canvas element. Default: 'psh-canvas' */
+    canvas?: string;
+    /** Text layer overlay. Default: 'psh-text-layer' */
+    textLayer?: string;
+    /** Page label (e.g. "Page 1 / 5"). Default: 'psh-page-label' */
+    pageLabel?: string;
+    /** Highlight <mark>. Default: 'highlight' */
+    highlight?: string;
+    /** Active highlight modifier. Default: 'active' */
+    activeHighlight?: string;
+}
+interface PDFSearchViewerOptions {
+    /** Scale factor. 'auto' = fit container width. Defaults to 'auto'. */
+    scale?: number | 'auto';
+    /** Path or URL to pdf.js worker script. */
+    workerSrc?: string;
+    /** Gap in pixels between rendered pages. Defaults to 20. */
+    pageGap?: number;
+    /**
+     * Custom CSS class names for viewer elements.
+     * Override any or all to apply your own styles.
+     *
+     * ```js
+     * classNames: {
+     *   page: 'my-page',
+     *   highlight: 'my-highlight',
+     *   activeHighlight: 'my-active',
+     * }
+     * ```
+     */
+    classNames?: ClassNames;
+}
+interface SearchOptions {
+    /** Case-sensitive matching. Defaults to false. */
+    caseSensitive?: boolean;
+    /**
+     * Flexible whitespace matching: insert \s* between every character.
+     * Handles PDF text split inconsistencies. Defaults to true.
+     * Only applies for queries < 200 chars (performance).
+     */
+    flexibleWhitespace?: boolean;
+}
+
+type PDFSearchViewerEventMap = {
+    /** Fired when PDF finishes loading. */
+    load: {
+        pageCount: number;
+    };
+    /** Fired when a search completes. */
+    search: {
+        query: string;
+        total: number;
+    };
+    /** Fired when active match changes (via next/prev). */
+    matchchange: {
+        current: number;
+        total: number;
+    };
+    /** Fired on error. */
+    error: {
+        error: Error;
+        context: string;
+    };
+};
+
+/**
+ * A single search match, potentially spanning multiple spans.
+ * Each match contains an array of <mark> elements that highlight
+ * the matched text across one or more text layer spans.
+ */
+interface SearchMatch {
+    /** The <mark> elements for this match (may span multiple spans). */
+    marks: HTMLElement[];
+}
+/**
+ * Internal span data for a rendered page.
+ */
+interface SpanData {
+    /** The DOM element in the text layer. */
+    el: HTMLElement;
+    /** Original text content. */
+    text: string;
+    /** Whether this span has end-of-line. */
+    hasEOL: boolean;
+}
+/**
+ * Internal page data after rendering.
+ */
+interface PageData {
+    /** Page wrapper container element. */
+    container: HTMLElement;
+    /** All text spans on this page. */
+    spans: SpanData[];
+}
+
+type PDFSource = File | ArrayBuffer | Uint8Array | string;
+/**
+ * Main PDF viewer with search and highlight functionality.
+ *
+ * Usage:
+ * ```js
+ * import * as pdfjsLib from 'pdfjs-dist';
+ * import { PDFSearchViewer } from 'pdf-search-highlight';
+ *
+ * const viewer = new PDFSearchViewer(container, pdfjsLib, {
+ *   classNames: {
+ *     page: 'my-page',
+ *     highlight: 'my-highlight',
+ *     activeHighlight: 'my-active',
+ *   }
+ * });
+ * await viewer.loadPDF(file);
+ * viewer.search('hello');
+ * viewer.nextMatch();
+ * ```
+ */
+declare class PDFSearchViewer extends EventEmitter<PDFSearchViewerEventMap> {
+    private renderer;
+    private highlightManager;
+    private pageData;
+    private lastQuery;
+    private lastSearchOptions;
+    private destroyed;
+    constructor(container: HTMLElement, pdfjsLib: any, options?: PDFSearchViewerOptions);
+    /**
+     * Load and render a PDF document.
+     */
+    loadPDF(source: PDFSource): Promise<void>;
+    /**
+     * Search for text across all pages.
+     * Clears previous highlights and creates new ones.
+     */
+    search(query: string, options?: SearchOptions): number;
+    /**
+     * Navigate to next match (wraps around).
+     */
+    nextMatch(): number;
+    /**
+     * Navigate to previous match (wraps around).
+     */
+    prevMatch(): number;
+    /**
+     * Clear all search highlights.
+     */
+    clearSearch(): void;
+    /**
+     * Get total number of pages.
+     */
+    getPageCount(): number;
+    /**
+     * Get current active match index (0-based). -1 if none.
+     */
+    getCurrentMatchIndex(): number;
+    /**
+     * Get total number of matches.
+     */
+    getMatchCount(): number;
+    /**
+     * Destroy the viewer, release all resources.
+     */
+    destroy(): void;
+}
+
+export { type ClassNames as C, EventEmitter as E, type PageData as P, type SearchOptions as S, type PDFSearchViewerOptions as a, type SpanData as b, type SearchMatch as c, PDFSearchViewer as d, type PDFSearchViewerEventMap as e, type PDFSource as f };