teamsync-pdf-viewer 1.2.0 → 1.3.0

package/dist/src/core/ViewerInstance.d.ts

@@ -2,7 +2,8 @@ import { ViewerBus } from './eventBus';
 import { ExportOptions } from './export';
 import { Annotation } from '../annotations/types';
 import { AnnotationManager } from '../annotations/AnnotationManager';
-import { Redaction, WatermarkOptions, ViewerEventMap, ViewerEventType } from './types';
+import { Redaction, WatermarkOptions, ViewerEventMap, ViewerEventType, TransientHighlight } from './types';
+import { SearchResult } from '../hooks/usePdfSearch';
 /**
  * © 2026 AngelBot Ai Pvt Ltd. All rights reserved.
  * WebViewerInstance — the imperative handle returned by `createWebViewer()` and exposed through
@@ -21,6 +22,11 @@ export interface ViewerBinding {
     getCurrentPage(): number;
     getPageCount(): number;
     loadDocument(url: string): void;
+    goToPage(pageNumber: number, options?: {
+        smooth?: boolean;
+    }): void;
+    getTransientHighlights(): TransientHighlight[];
+    setTransientHighlights(highlights: TransientHighlight[]): void;
 }
 export declare class WebViewerInstance {
     readonly bus: ViewerBus;
@@ -56,6 +62,39 @@ export declare class WebViewerInstance {
     getPdfDocument(): pdfjsLib.PDFDocumentProxy | null;
     getCurrentPage(): number;
     getPageCount(): number;
+    /** Navigate to a specific page number (1-based). */
+    goToPage(pageNumber: number, options?: {
+        smooth?: boolean;
+    }): void;
+    /** Set the current page number (1-based). Alias of goToPage. */
+    setCurrentPage(pageNumber: number): void;
+    /**
+     * Search the document for text matches, returning snippets and page bounding boxes.
+     */
+    searchText(query: string): Promise<SearchResult[]>;
+    /** Get the current list of transient highlights. */
+    getTransientHighlights(): TransientHighlight[];
+    /**
+     * Set transient visual highlights across one or more pages.
+     * These render directly on the PDF canvas but are NEVER saved into AnnotationManager
+     * or exported to XFDF.
+     */
+    setTransientHighlights(highlights: TransientHighlight[]): void;
+    /** Add a single transient highlight to the current list. */
+    addTransientHighlight(highlight: TransientHighlight): void;
+    /** Clear all active transient highlights. */
+    clearTransientHighlights(): void;
+    /**
+     * Search for a snippet or citation query, scroll to its page, and highlight it temporarily.
+     * Returns the matched SearchResult or null if not found.
+     */
+    highlightSnippet(query: string, options?: {
+        pageIndex?: number;
+        pulse?: boolean;
+        scrollTo?: boolean;
+        color?: string;
+        tooltip?: string;
+    }): Promise<SearchResult | null>;
     getAnnotations(): Annotation[];
     /** Print the exported document (annotations, redactions and watermark baked in). */
     print(): void;
@@ -67,6 +106,8 @@ export declare class WebViewerInstance {
     readonly UI: {
         /** Theming is not implemented; kept for API compatibility. */
         setTheme: (_theme: string) => void;
+        goToPage: (pageNumber: number) => void;
+        setCurrentPageNumber: (pageNumber: number) => void;
         openElements: (elements: string[]) => void;
         closeElements: (elements: string[]) => void;
         enableElements: (elements: string[]) => void;
@@ -77,6 +118,10 @@ export declare class WebViewerInstance {
         fitPage: () => void;
         fitToWidth: () => void;
         fitToPage: () => void;
+        startCompare: (docA: any, docB: any, options?: any) => void;
+        stopCompare: () => void;
+        setCompareMode: (mode: "overlay" | "side-by-side" | "semantic") => void;
+        setCompareColors: (colorA: string, colorB: string) => void;
     };
     readonly Core: {
         /** The real AnnotationManager (XFDF import/export, granular events, permissions). */
@@ -86,6 +131,9 @@ export declare class WebViewerInstance {
             removeEventListener: (event: string, callback: (detail: unknown) => void) => void;
             getCurrentPage: () => number;
             getPageCount: () => number;
+            goToPage: (pageNumber: number) => void;
+            setCurrentPage: (pageNumber: number) => void;
+            setCurrentPageNumber: (pageNumber: number) => void;
             getDocument: () => {
                 getFileData: (options?: ExportOptions) => Promise<Uint8Array<ArrayBufferLike>>;
             };

package/dist/src/core/types.d.ts

@@ -3,6 +3,27 @@ import { Annotation } from '../annotations/types';
 import { AnnotationChangedEvent } from '../annotations/AnnotationManager';
 import { PdfAssetPaths } from './pdfAssets';
 export type { PdfAssetPaths };
+export interface SearchBounds {
+    x: number;
+    y: number;
+    width: number;
+    height: number;
+}
+export interface TransientHighlight {
+    id?: string;
+    /** 1-based page number */
+    pageIndex: number;
+    /** Bounding boxes on the page in PDF coordinate points */
+    bounds: SearchBounds[];
+    /** Background fill color (default 'rgba(250, 204, 21, 0.4)') */
+    color?: string;
+    /** Border color (default 'rgba(234, 179, 8, 0.8)') */
+    borderColor?: string;
+    /** Whether to animate with a pulsing focus ring */
+    pulse?: boolean;
+    /** Optional tooltip text displayed above the highlight */
+    tooltip?: string;
+}
 export interface Redaction {
     id?: string;
     /** 1-based page number */
@@ -47,6 +68,10 @@ export interface WebViewerOptions {
     initialScale?: InitialScale;
     /** 1-based page to scroll to after load. */
     initialPage?: number;
+    /** Current 1-based page to display. Changes navigate to the given page. */
+    page?: number;
+    /** Transient visual highlights that render on pages without polluting AnnotationManager. */
+    transientHighlights?: TransientHighlight[];
     plugins?: ViewerPlugin[];
     redactions?: Redaction[];
     regexRedactions?: RegExp[];
@@ -100,6 +125,9 @@ export interface ViewerEventMap {
     };
     /** Granular add / modify / delete (with the `imported` flag) from the AnnotationManager. */
     annotationChanged: AnnotationChangedEvent;
+    transientHighlightsChanged: {
+        highlights: TransientHighlight[];
+    };
     toolChanged: {
         tool: string | null;
     };

package/dist/src/hooks/usePdfSearch.d.ts

@@ -1,11 +1,6 @@
-import { Redaction } from '../core/types';
-import * as pdfjsLib from 'pdfjs-dist';
-export interface SearchBounds {
-    x: number;
-    y: number;
-    width: number;
-    height: number;
-}
+import { Redaction, SearchBounds } from '../core/types';
+import type * as pdfjsLib from 'pdfjs-dist';
+export type { SearchBounds };
 export interface SearchResult {
     id: string;
     pageIndex: number;
@@ -14,6 +9,11 @@ export interface SearchResult {
     matchLength: number;
     bounds: SearchBounds[];
 }
+/**
+ * Standalone asynchronous text search across all pages of a PDFDocumentProxy.
+ * Sanitizes redacted regions and returns matching snippets and bounding boxes.
+ */
+export declare function searchPdfText(pdfDoc: pdfjsLib.PDFDocumentProxy, query: string, redactions?: Redaction[], onProgress?: (progress: number) => void): Promise<SearchResult[]>;
 export declare function usePdfSearch(pdfDoc: pdfjsLib.PDFDocumentProxy | null, redactions?: Redaction[]): {
     search: (query: string) => Promise<void>;
     searchResults: SearchResult[];

package/dist/src/index.d.ts

@@ -9,6 +9,8 @@ export { createWebViewer, WebViewer } from './core/createWebViewer';
 export { WebViewerInstance } from './core/ViewerInstance';
 export { TeamSyncViewer } from './components/TeamSyncViewer';
 export type { TeamSyncViewerProps } from './components/TeamSyncViewer';
+export * from './types/compare';
+export * from './utils/pdfDiffEngine';
 export { configurePdfAssets, getPdfAssetPaths, isWorkerConfigured, pdfjsVersion } from './core/pdfAssets';
 export type { PdfAssetPaths } from './core/pdfAssets';
 export { ViewerBus } from './core/eventBus';
@@ -26,4 +28,7 @@ export { annotationsToXfdf, annotationToXfdfFragment, parseXfdf, toPdfDate, from
 export type { XfdfExportOptions } from './annotations/xfdf';
 export { printPdfBytes } from './core/print';
 export type { PrintOptions } from './core/print';
+export { usePdfSearch, searchPdfText } from './hooks/usePdfSearch';
+export type { SearchResult, SearchBounds } from './hooks/usePdfSearch';
+export type { TransientHighlight } from './core/types';
 export * from './plugins/types';

package/dist/src/types/compare.d.ts

@@ -0,0 +1,56 @@
+/**
+ * © 2026 AngelBot Ai Pvt Ltd. All rights reserved.
+ */
+export type CompareMode = 'overlay' | 'side-by-side' | 'semantic';
+export interface CompareOptions {
+    docA?: string | ArrayBuffer | Uint8Array;
+    docB?: string | ArrayBuffer | Uint8Array;
+    mode?: CompareMode;
+    colorA?: string;
+    colorB?: string;
+    opacityA?: number;
+    opacityB?: number;
+    blendMode?: 'multiply' | 'difference' | 'screen' | 'normal';
+}
+export interface TextDiffSegment {
+    type: 'equal' | 'add' | 'delete';
+    text: string;
+    pageIndex: number;
+}
+export interface DiffBoundingBox {
+    id: string;
+    pageIndex: number;
+    type: 'addition' | 'deletion' | 'modification';
+    text: string;
+    x: number;
+    y: number;
+    width: number;
+    height: number;
+}
+export interface DiffItem {
+    id: string;
+    pageIndex: number;
+    type: 'addition' | 'deletion' | 'modification';
+    description: string;
+    x?: number;
+    y?: number;
+    width?: number;
+    height?: number;
+}
+export interface CompareState {
+    isActive: boolean;
+    docA?: string | ArrayBuffer | Uint8Array;
+    docB?: string | ArrayBuffer | Uint8Array;
+    mode: CompareMode;
+    colorA: string;
+    colorB: string;
+    opacityA: number;
+    opacityB: number;
+    blendMode: 'multiply' | 'difference' | 'screen' | 'normal';
+    curtainPosition: number;
+    showCurtain: boolean;
+    diffItems: DiffItem[];
+    currentDiffIndex: number;
+    pageDiffsA?: Record<number, DiffBoundingBox[]>;
+    pageDiffsB?: Record<number, DiffBoundingBox[]>;
+}

package/dist/src/utils/pdfDiffEngine.d.ts

@@ -0,0 +1,37 @@
+import { TextDiffSegment, DiffItem, DiffBoundingBox } from '../types/compare';
+/**
+ * © 2026 AngelBot Ai Pvt Ltd. All rights reserved.
+ */
+import type * as pdfjsLib from 'pdfjs-dist';
+export interface PageDiffResult {
+    diffsA: DiffBoundingBox[];
+    diffsB: DiffBoundingBox[];
+    summary: DiffItem[];
+}
+export interface WordToken {
+    text: string;
+    x: number;
+    y: number;
+    width: number;
+    height: number;
+}
+/**
+ * Extracts individual words with precise unscaled viewport bounding boxes from a PDF.js page.
+ */
+export declare function extractWordsFromPage(page: pdfjsLib.PDFPageProxy): Promise<WordToken[]>;
+/**
+ * Computes exact text difference bounding boxes on a page for both Document A and Document B.
+ */
+export declare function computePageDiffBoxes(pdfDocA: pdfjsLib.PDFDocumentProxy, pdfDocB: pdfjsLib.PDFDocumentProxy, pageIndex: number): Promise<PageDiffResult>;
+/**
+ * Lightweight client-side Myers Diff algorithm for raw text comparison.
+ */
+export declare function computeTextDiff(textA: string, textB: string, pageIndex: number): TextDiffSegment[];
+/**
+ * Colorizes a rendered page canvas with a custom hex tint.
+ */
+export declare function tintCanvas(ctx: CanvasRenderingContext2D, width: number, height: number, colorHex: string, opacity?: number): void;
+/**
+ * Computes pixel-level difference bounding boxes between two rendered page canvases.
+ */
+export declare function computeCanvasPixelDiff(canvasA: HTMLCanvasElement, canvasB: HTMLCanvasElement, pageIndex: number, scale: number): DiffItem[];