teamsync-pdf-viewer 1.5.0 → 1.6.0

package/CHANGELOG.md

@@ -2,6 +2,26 @@
 
 All notable changes to `teamsync-pdf-viewer` are documented here.
 
+## [1.6.0] — 2026-09-06
+
+### Added
+- **Whitespace-Tolerant Text Search**: Search queries now match across line breaks, multiple whitespace runs, tabs, NBSP (`\u00A0`), and other unicode whitespace variants seamlessly. Matches in normalized space while accurately reporting raw source coordinates and bounds.
+- **Shared `pageText` Builder & Bounding Box Interpolator**: Unified raw text extraction and character coordinate mapping between PDF search and regex redactions via internal `buildPageText` and `boundsForRawRange` helpers.
+- **Page-Scoped Search & Highlighting**:
+  - Added additive 5th parameter `pages?: number[]` to `searchPdfText(doc, query, redactions, onProgress, pages)`.
+  - Added `options.pages?: number[]` to `instance.searchText(query, options)`.
+  - Added `scope?: 'document' | 'page'` to `instance.highlightSnippet(query, options)` allowing strict page restriction when navigating to snippet citations.
+- **Sidebar Highlighting Precision**: Result `matchLength` now reflects the exact consumed raw glyph span, ensuring sidebar bold highlights match rendered page text identically.
+- **Stable Search Results Sorting**: Corrected search result sorting to maintain page index ascending order while preserving intra-page ascending match order.
+
+## [1.5.1] — 2026-09-06
+
+### Added
+- **`redactionsApplied` & `redactionsChanged` Events**: Added typed `redactionsApplied: { redactions: Redaction[] }` and `redactionsChanged: { redactions: Redaction[] }` events to `ViewerEventMap` available via `instance.on()`.
+- **Public Redaction Callbacks**: Added `onRedactionsApplied?: (redactions: Redaction[]) => void` and `onRedactionsChange?: (redactions: Redaction[]) => void` props to `<TeamSyncViewer>` and `WebViewerOptions`.
+- **Apply Confirmation Hook**: Threaded `onRedactionsApplied` through `DocumentViewerProps`, firing once per user click of Apply in the confirmation modal with the full combined list of applied redactions.
+- **Public `getRedactions()` API**: Added `instance.getRedactions(): Redaction[]` to `WebViewerInstance` mirroring `getAnnotations()`, returning the live combined redaction list.
+
 ## [1.5.0] — 2026-09-05
 
 ### Added

package/README.md

@@ -4,7 +4,7 @@
 
 ![TeamSync PDF Viewer UI](https://raw.githubusercontent.com/angelbot-ai/TeamSync-PDF-Viewer/main/docs/images/viewer_ui.png)
 
-### **100% Open Source. 100% Client-Side. Enterprise PDF Engine.**
+### **100% Open Source. 100% Client-Side. Enterprise SDK.**
 
 [![License: CPAL-1.0](https://img.shields.io/badge/License-CPAL--1.0-blue.svg)](LICENSE)
 [![Live Demo](https://img.shields.io/badge/Live%20Demo-pdfviewer.teamsync.com-000000.svg)](https://pdfviewer.teamsync.com/)
@@ -25,7 +25,7 @@ Try the **[Interactive Live Demo](https://pdfviewer.teamsync.com/)** or integrat
 Traditional commercial PDF viewers force developers into expensive per-domain licenses, opaque sales calls, and heavy server-side processing dependencies. **TeamSync PDF Viewer** is built from the ground up to solve these pain points.
 
 - 💰 **Zero-Cost, Transparent Licensing**: Uncapped usage, no per-server fees, and no commercial paywalls. 100% free and open-source under CPAL 1.0.
-- ⚡ **100% Client-Side WebAssembly**: Documents never leave the browser sandbox. Process, redact, and render PDFs entirely on the client—guaranteeing instant **HIPAA**, **GDPR**, and **FINRA** compliance.
+- ⚡ **100% Client-Side WebAssembly**: Documents never leave the browser sandbox. Process, redact, and render PDFs entirely on the client. 
 - 🔌 **Universal WebViewer API**: Clean, intuitive `WebViewer({...})` API interface that makes integrating into your web applications effortless.
 - 🎨 **Headless & Customizable**: Built for modern React 19 SPA lifecycles. No bloated iFrames to fight—customize toolbars, sidebars, context menus, and controls natively.
 
@@ -84,10 +84,10 @@ Everything you need to build collaborative, secure document workflows.
 - **Notes & Callouts**: Sticky notes, callout text boxes with directional arrows, and text annotations.
 - **Interactive Hyperlinks**: Create internal page-jump links (`#page=N`) or external web URL links directly on document selections.
 
-### 🛡️ Military-Grade Secure Redaction
+### 🛡️ Secure Redaction
 - **Binary-Level Data Obliteration**: We don't just place black boxes over text—redactions are permanently rasterized and burned into the underlying PDF vector structure.
 - **Text Layer Sanitization**: Redacted text is automatically stripped from the DOM `textLayer` and PDF content streams, preventing copy/paste extraction and search indexing.
-- **Automatic Regex Redactions**: Programmatically locate and redact sensitive PII (Aadhaar numbers, SSNs, credit cards, dates of birth) in a single click.
+- **Automatic Regex Redactions**: Programmatically locate and redact sensitive PII in a single click.
 - **Discard Unapplied Redactions**: Easily discard individual pending redactions or bulk-discard all unapplied redaction marks before committing.
 
 ### 📐 Dynamic Layout & Viewport Controls

package/dist/src/components/DocumentViewer.d.ts

@@ -31,6 +31,8 @@ interface DocumentViewerProps {
     onAnnotationsChange?: (annotations: Annotation[]) => void;
     /** Reports the combined (prop + regex + manual) redaction list whenever it changes. */
     onRedactionsChange?: (redactions: Redaction[]) => void;
+    /** Fires once per user click of Apply in the confirmation modal with all applied redactions. */
+    onRedactionsApplied?: (redactions: Redaction[]) => void;
     onDocumentLoaded?: (doc: pdfjsLib.PDFDocumentProxy, url: string) => void;
     onLoadError?: (error: Error, info: DocumentLoadErrorInfo) => void;
     /** Fires once per loaded document, after the first page canvas has been painted. */
@@ -55,5 +57,5 @@ interface DocumentViewerProps {
     defaultTool?: 'select' | 'pan';
     showSelectionTooltip?: boolean;
 }
-export default function DocumentViewer({ leftSidebarOpen, rightSidebarOpen, activeTab, annotationManager, initialDoc, loadNonce, withCredentials, assets, sidebars, redactions, regexRedactions, scale, setScale, sidebarTab, setSidebarTab, onAnnotationsChange, onRedactionsChange, onDocumentLoaded, onLoadError, onFirstPageRendered, onPageRendered, onPageChange, pageTransition, pageLayout, rotation, setRotation, watermark, watermarkText, enableAnnotations: _enableAnnotations, initialPage, page, transientHighlights, permissions, hideAnnotationsUntilPageRendered, enableTextSelection, defaultTool, showSelectionTooltip }: DocumentViewerProps): React.JSX.Element;
+export default function DocumentViewer({ leftSidebarOpen, rightSidebarOpen, activeTab, annotationManager, initialDoc, loadNonce, withCredentials, assets, sidebars, redactions, regexRedactions, scale, setScale, sidebarTab, setSidebarTab, onAnnotationsChange, onRedactionsChange, onRedactionsApplied, onDocumentLoaded, onLoadError, onFirstPageRendered, onPageRendered, onPageChange, pageTransition, pageLayout, rotation, setRotation, watermark, watermarkText, enableAnnotations: _enableAnnotations, initialPage, page, transientHighlights, permissions, hideAnnotationsUntilPageRendered, enableTextSelection, defaultTool, showSelectionTooltip }: DocumentViewerProps): React.JSX.Element;
 export {};

package/dist/src/components/TeamSyncViewer.d.ts

@@ -1,7 +1,7 @@
 import { default as React } from 'react';
 import { DocumentLoadErrorInfo } from './DocumentViewer';
 import { WebViewerInstance } from '../core/ViewerInstance';
-import { WebViewerOptions, TransientHighlight } from '../core/types';
+import { WebViewerOptions, Redaction, TransientHighlight } from '../core/types';
 import { Annotation } from '../annotations/types';
 export interface TeamSyncViewerProps extends Omit<WebViewerOptions, 'path'> {
     /** URL of the PDF to display. Alias of `initialDoc`; `fileUrl` wins when both are set. */
@@ -33,6 +33,10 @@ export interface TeamSyncViewerProps extends Omit<WebViewerOptions, 'path'> {
     }) => void;
     onPageChange?: (pageNumber: number, numPages: number) => void;
     onAnnotationsChange?: (annotations: Annotation[]) => void;
+    /** Fires whenever pending or applied redactions change in the viewer. */
+    onRedactionsChange?: (redactions: Redaction[]) => void;
+    /** Fires once per user click of Apply in the confirmation modal with all applied redactions. */
+    onRedactionsApplied?: (redactions: Redaction[]) => void;
     /** Fires whenever transient highlights change. */
     onTransientHighlightsChange?: (highlights: TransientHighlight[]) => void;
     /** Fires whenever the user selects text within the document. */

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

@@ -70,8 +70,14 @@ export declare class WebViewerInstance {
     setCurrentPage(pageNumber: number): void;
     /**
      * Search the document for text matches, returning snippets and page bounding boxes.
+     *
+     * @param query - Search term.
+     * @param options - Search options:
+     *   - `pages`: Specific 1-based page numbers to search. Defaults to all pages.
      */
-    searchText(query: string): Promise<SearchResult[]>;
+    searchText(query: string, options?: {
+        pages?: number[];
+    }): Promise<SearchResult[]>;
     /** Get the current list of transient highlights. */
     getTransientHighlights(): TransientHighlight[];
     /**
@@ -87,15 +93,29 @@ export declare class WebViewerInstance {
     /**
      * Search for a snippet or citation query, scroll to its page, and highlight it temporarily.
      * Returns the matched SearchResult or null if not found.
+     *
+     * @param query - The text snippet to locate and highlight.
+     * @param options - Navigation and display options:
+     *   - `pageIndex`: Preferred page (1-based). When `scope: 'page'`, restricts search to this page.
+     *   - `scope`: Search scope. `'document'` (default) searches all pages, keeping `pageIndex` as a preference.
+     *     `'page'` restricts the search strictly to `pageIndex` (avoids full-document walk).
+     *     If `scope: 'page'` is provided without `pageIndex`, it gracefully degrades to `'document'`.
+     *   - `pulse`: Animate focus ring (default true).
+     *   - `scrollTo`: Scroll page into view (default true).
+     *   - `color`: Background highlight color.
+     *   - `tooltip`: Tooltip text above the highlight (defaults to matched snippet).
      */
     highlightSnippet(query: string, options?: {
         pageIndex?: number;
+        scope?: 'document' | 'page';
         pulse?: boolean;
         scrollTo?: boolean;
         color?: string;
         tooltip?: string;
     }): Promise<SearchResult | null>;
     getAnnotations(): Annotation[];
+    /** Get the current list of redactions (pending and applied). */
+    getRedactions(): Redaction[];
     /** Print the exported document (annotations, redactions and watermark baked in). */
     print(): void;
     /**

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

@@ -113,6 +113,10 @@ export interface WebViewerOptions {
     defaultTool?: 'select' | 'pan';
     /** Show floating quick-action copy badge above selected text (default true). */
     showSelectionTooltip?: boolean;
+    /** Fires whenever pending or applied redactions change in the viewer. */
+    onRedactionsChange?: (redactions: Redaction[]) => void;
+    /** Fires once per user click of Apply in the confirmation modal with all applied redactions. */
+    onRedactionsApplied?: (redactions: Redaction[]) => void;
 }
 /** Events available through `instance.on(type, listener)`. */
 export interface ViewerEventMap {
@@ -142,6 +146,12 @@ export interface ViewerEventMap {
     };
     /** Granular add / modify / delete (with the `imported` flag) from the AnnotationManager. */
     annotationChanged: AnnotationChangedEvent;
+    redactionsChanged: {
+        redactions: Redaction[];
+    };
+    redactionsApplied: {
+        redactions: Redaction[];
+    };
     transientHighlightsChanged: {
         highlights: TransientHighlight[];
     };

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

@@ -10,10 +10,10 @@ export interface SearchResult {
     bounds: SearchBounds[];
 }
 /**
- * Standalone asynchronous text search across all pages of a PDFDocumentProxy.
+ * Standalone asynchronous text search across all pages (or specified 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 searchPdfText(pdfDoc: pdfjsLib.PDFDocumentProxy, query: string, redactions?: Redaction[], onProgress?: (progress: number) => void, pages?: number[]): Promise<SearchResult[]>;
 export declare function usePdfSearch(pdfDoc: pdfjsLib.PDFDocumentProxy | null, redactions?: Redaction[]): {
     search: (query: string) => Promise<void>;
     searchResults: SearchResult[];

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

@@ -0,0 +1,23 @@
+import { SearchBounds } from '../core/types';
+export interface PageText {
+    fullText: string;
+    itemIndices: number[];
+    charIndices: number[];
+    normText: string;
+    normToRaw: number[];
+}
+/**
+ * Collapses any consecutive whitespace runs to a single space and trims edges.
+ */
+export declare function collapseWhitespace(s: string): string;
+/**
+ * Builds raw page text with item/char index source-mapping, followed by a second pass
+ * creating normalized text (collapsing any maximal whitespace run to a single space)
+ * and a 1-to-1 index map back to raw string indices.
+ */
+export declare function buildPageText(items: any[]): PageText;
+/**
+ * Computes bounding boxes in PDF coordinate points for a matched range [rawStart, rawEndExcl) in fullText.
+ * Separator sentinels (-1) are skipped, and character positions are interpolated across each TextItem.
+ */
+export declare function boundsForRawRange(items: any[], pageText: Pick<PageText, 'itemIndices' | 'charIndices'>, rawStart: number, rawEndExcl: number): SearchBounds[];