teamsync-pdf-viewer 1.0.3 → 1.2.0

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

@@ -0,0 +1,23 @@
+import { Annotation } from '../annotations/types';
+import { Redaction, WatermarkOptions } from './types';
+import { GeometryResolver } from '../annotations/geometry';
+/** Refuse to build documents larger than this in the browser (memory safety). */
+export declare const MAX_EXPORT_BYTES: number;
+export interface ExportInput {
+    /** Returns the original document bytes (prefer `pdfDocument.getData()`). */
+    getSourceBytes: () => Promise<Uint8Array | ArrayBuffer>;
+    /** Page geometry resolver (from the loaded pdf.js document). Derived from the bytes when absent. */
+    getPageGeometry?: GeometryResolver;
+    annotations: Annotation[];
+    redactions: Redaction[];
+    watermark?: WatermarkOptions;
+    /** Name printed on digital-signature placeholder blocks when the annotation has no signer. */
+    signerName?: string;
+}
+export interface ExportOptions {
+    /** Bake exactly these annotations instead of the live list. */
+    explicitAnnotations?: Annotation[];
+    /** Accepted for API compatibility; annotations are always taken from the live list / explicitAnnotations. */
+    xfdfString?: string;
+}
+export declare function buildPdfBytes(input: ExportInput, options?: ExportOptions): Promise<Uint8Array>;

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

@@ -0,0 +1,27 @@
+import { DocumentInitParameters } from 'pdfjs-dist/types/src/display/api';
+export interface PdfAssetPaths {
+    /** URL of `pdf.worker.min.mjs` matching the installed pdfjs-dist version. REQUIRED. */
+    workerSrc?: string;
+    /** Directory URL (trailing slash) of the packed CMaps — needed for CJK/Indic text. */
+    cMapUrl?: string;
+    /** Directory URL (trailing slash) of the standard 14 font substitutes. */
+    standardFontDataUrl?: string;
+    /** Directory URL (trailing slash) of the wasm decoders (JPX/OpenJPEG, qcms). */
+    wasmUrl?: string;
+    /** Directory URL (trailing slash) of ICC profiles. */
+    iccUrl?: string;
+}
+export declare function configurePdfAssets(paths: PdfAssetPaths): void;
+export declare function getPdfAssetPaths(): Readonly<PdfAssetPaths>;
+/** True once a worker URL has been configured (either via configurePdfAssets or directly on pdf.js). */
+export declare function isWorkerConfigured(): boolean;
+/**
+ * Throws a descriptive error when the worker has not been configured. Called lazily right before
+ * the first `getDocument()` — never at module scope, so importing the package is side-effect free
+ * and safe under SSR.
+ */
+export declare function assertWorkerConfigured(): void;
+/** Extra `getDocument()` parameters derived from the configured asset paths. */
+export declare function getDocumentParams(): Partial<DocumentInitParameters>;
+/** pdfjs-dist version this build was compiled against (useful for worker-version mismatch checks). */
+export declare const pdfjsVersion: string;

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

@@ -0,0 +1,12 @@
+/**
+ * © 2026 AngelBot Ai Pvt Ltd. All rights reserved.
+ * Printing: the exported document (annotations / redactions / watermark baked in) is loaded into a
+ * hidden iframe and printed through the browser's PDF viewer. Falls back to opening the PDF in a
+ * new tab when the frame cannot print (e.g. the browser has no inline PDF viewer).
+ */
+export interface PrintOptions {
+    title?: string;
+    /** How long the hidden frame is kept alive for the print dialog (default 60s). */
+    timeoutMs?: number;
+}
+export declare function printPdfBytes(bytes: Uint8Array, opts?: PrintOptions): Promise<void>;

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

@@ -0,0 +1,108 @@
+import { ViewerPlugin } from '../plugins/types';
+import { Annotation } from '../annotations/types';
+import { AnnotationChangedEvent } from '../annotations/AnnotationManager';
+import { PdfAssetPaths } from './pdfAssets';
+export type { PdfAssetPaths };
+export interface Redaction {
+    id?: string;
+    /** 1-based page number */
+    pageIndex: number;
+    x: number;
+    y: number;
+    width: number;
+    height: number;
+    status?: 'pending' | 'applied';
+}
+export interface WatermarkOptions {
+    text: string;
+    opacity?: number;
+    size?: number;
+    mode?: 'single' | 'tiled';
+    color?: string;
+}
+export interface SDKPermissions {
+    canAddAnnotations?: boolean;
+    canEditAnnotations?: boolean;
+    canDeleteAnnotations?: boolean;
+    canRedact?: boolean;
+    /** Allow editing/deleting annotations authored by other users (default false). */
+    canEditOthers?: boolean;
+}
+export interface ViewerUser {
+    id: string;
+    name: string;
+}
+export type InitialScale = number | 'fit-width' | 'fit-page';
+/**
+ * Options accepted by `createWebViewer()` (and the deprecated `WebViewer()` alias).
+ * Every option is also available as a prop on `<TeamSyncViewer>`.
+ */
+export interface WebViewerOptions {
+    /** @deprecated Only meaningful for the iframe package (`public/webviewer.js`). */
+    path?: string;
+    /** URL of the PDF to load. Presigned/CORS-enabled URLs work; bytes are fetched by pdf.js. */
+    initialDoc?: string;
+    /** Display name used for downloads. */
+    fileName?: string;
+    initialScale?: InitialScale;
+    /** 1-based page to scroll to after load. */
+    initialPage?: number;
+    plugins?: ViewerPlugin[];
+    redactions?: Redaction[];
+    regexRedactions?: RegExp[];
+    enableAnnotations?: boolean;
+    enableSign?: boolean;
+    signOptions?: ('digital' | 'ades' | 'simple')[];
+    watermark?: WatermarkOptions;
+    permissions?: SDKPermissions;
+    enableRedactions?: boolean;
+    canAddAnnotations?: boolean;
+    canEditAnnotations?: boolean;
+    canDeleteAnnotations?: boolean;
+    /** Shorthand for "no annotation/redaction editing at all". */
+    readOnly?: boolean;
+    /** Author attached to annotations created in this viewer. */
+    currentUser?: ViewerUser;
+    /** pdf.js worker / CMap / font / wasm locations (see `configurePdfAssets`). */
+    assets?: PdfAssetPaths;
+    /** Send cookies with the document request (same-origin session-bound URLs). Default false. */
+    withCredentials?: boolean;
+    /** Render the top toolbar. Default true. */
+    toolbar?: boolean;
+    /** Render the left (thumbnails) and right (comments/search) panels. Default true. */
+    sidebars?: boolean;
+    /** Start with the thumbnails panel open. Default true. */
+    leftPanelOpen?: boolean;
+    /** Focus the viewer on mount so keyboard shortcuts work immediately. Default false. */
+    autoFocus?: boolean;
+}
+/** Events available through `instance.on(type, listener)`. */
+export interface ViewerEventMap {
+    documentLoaded: {
+        url: string;
+        numPages: number;
+    };
+    documentLoadError: {
+        url: string;
+        error: Error;
+        passwordRequired: boolean;
+    };
+    firstPageRendered: {
+        url: string;
+        pageNumber: number;
+    };
+    pageChanged: {
+        pageNumber: number;
+        numPages: number;
+    };
+    annotationsChanged: {
+        annotations: Annotation[];
+    };
+    /** Granular add / modify / delete (with the `imported` flag) from the AnnotationManager. */
+    annotationChanged: AnnotationChangedEvent;
+    toolChanged: {
+        tool: string | null;
+    };
+    destroy: Record<string, never>;
+}
+export type ViewerEventType = keyof ViewerEventMap;

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

@@ -0,0 +1,23 @@
+import { Redaction } from '../core/types';
+import * as pdfjsLib from 'pdfjs-dist';
+export interface SearchBounds {
+    x: number;
+    y: number;
+    width: number;
+    height: number;
+}
+export interface SearchResult {
+    id: string;
+    pageIndex: number;
+    snippet: string;
+    matchStartIndex: number;
+    matchLength: number;
+    bounds: SearchBounds[];
+}
+export declare function usePdfSearch(pdfDoc: pdfjsLib.PDFDocumentProxy | null, redactions?: Redaction[]): {
+    search: (query: string) => Promise<void>;
+    searchResults: SearchResult[];
+    isSearching: boolean;
+    searchProgress: number;
+    clearSearch: () => void;
+};

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

@@ -0,0 +1,13 @@
+export type ActionType = 'ROTATE_CW' | 'ROTATE_CCW' | 'UNDO' | 'REDO' | 'DELETE' | 'COPY' | 'PASTE' | 'FILE_PICKER' | 'SEARCH';
+export interface Shortcut {
+    action: ActionType;
+    description: string;
+    defaultCommand: string;
+    command: string;
+}
+export declare function useShortcuts(): {
+    shortcuts: Shortcut[];
+    updateShortcut: (action: ActionType, newCommand: string) => void;
+    getCommand: (action: ActionType) => string;
+};
+export declare function matchShortcut(e: KeyboardEvent, commandString: string): boolean;

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

@@ -0,0 +1,7 @@
+import { ViewerBus, BusListener } from '../core/eventBus';
+export declare function useViewerBus(): ViewerBus;
+/**
+ * Subscribe to a bus event for the lifetime of the component.
+ * The latest `listener` is always invoked (no stale closures) without re-subscribing on every render.
+ */
+export declare function useBusEvent<T = unknown>(type: string, listener: BusListener<T>): void;

package/dist/src/index.d.ts

@@ -0,0 +1,29 @@
+/**
+ * © 2026 AngelBot Ai Pvt Ltd. All rights reserved.
+ * TeamSync PDF Viewer SDK — public entry point.
+ *
+ * This module is side-effect free: importing it never touches `window`/`document`, so it is safe
+ * to import under SSR. Mount with `createWebViewer()` or render `<TeamSyncViewer>` on the client.
+ */
+export { createWebViewer, WebViewer } from './core/createWebViewer';
+export { WebViewerInstance } from './core/ViewerInstance';
+export { TeamSyncViewer } from './components/TeamSyncViewer';
+export type { TeamSyncViewerProps } from './components/TeamSyncViewer';
+export { configurePdfAssets, getPdfAssetPaths, isWorkerConfigured, pdfjsVersion } from './core/pdfAssets';
+export type { PdfAssetPaths } from './core/pdfAssets';
+export { ViewerBus } from './core/eventBus';
+export type { BusListener } from './core/eventBus';
+export { buildPdfBytes, MAX_EXPORT_BYTES } from './core/export';
+export type { ExportInput, ExportOptions } from './core/export';
+export type { WebViewerOptions, Redaction, WatermarkOptions, SDKPermissions, ViewerUser, InitialScale, ViewerEventMap, ViewerEventType, } from './core/types';
+export type { Annotation, AnnotationType, AnnotationPoint, AnnotationInput } from './annotations/types';
+export { AnnotationManager } from './annotations/AnnotationManager';
+export type { AnnotationAction, AnnotationChangedEvent, CommitOptions, ViewerUserInfo } from './annotations/AnnotationManager';
+export { newAnnotationId } from './annotations/ids';
+export { createPageGeometry, geometryFromPage, createGeometryResolver, toPdfPoint, fromPdfPoint, rectToPdf, rectFromPdf, rectToQuadPoints, quadPointsToRects, } from './annotations/geometry';
+export type { PageGeometry, GeometryResolver, PdfRect, Rect, Point } from './annotations/geometry';
+export { annotationsToXfdf, annotationToXfdfFragment, parseXfdf, toPdfDate, fromPdfDate, XFDF_NS } from './annotations/xfdf';
+export type { XfdfExportOptions } from './annotations/xfdf';
+export { printPdfBytes } from './core/print';
+export type { PrintOptions } from './core/print';
+export * from './plugins/types';

package/dist/src/plugins/index.d.ts

@@ -0,0 +1 @@
+export * from './types';

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

@@ -0,0 +1,26 @@
+import { default as React } from 'react';
+export interface PluginContext {
+    activeTool: string | null;
+    setActiveTool: (tool: string | null) => void;
+    annotations: any[];
+    setAnnotations: React.Dispatch<React.SetStateAction<any[]>>;
+    commitAnnotations: (anns: any[]) => void;
+    scale: number;
+    pdfDoc: any;
+    permissions?: any;
+    initialDoc?: string;
+    watermark?: any;
+}
+export interface ViewerPlugin {
+    id: string;
+    name: string;
+    renderHeaderActions?: (context: PluginContext) => React.ReactNode;
+    renderModals?: (context: PluginContext) => React.ReactNode;
+    onInit?: (context: PluginContext) => void;
+    onBeforeSave?: (pdfBytes: Uint8Array, context: PluginContext) => Promise<Uint8Array>;
+}
+export interface DigitalSignerOptions {
+    allowedTypes?: Array<'digital' | 'ades' | 'simple'>;
+    usbBridgeUrl?: string;
+    defaultSignerName?: string;
+}

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

@@ -0,0 +1,6 @@
+import { Redaction } from '../core/types';
+/**
+ * © 2026 AngelBot Ai Pvt Ltd. All rights reserved.
+ */
+import * as pdfjsLib from 'pdfjs-dist';
+export declare function findRegexRedactions(pdfDoc: pdfjsLib.PDFDocumentProxy, regexes: RegExp[]): Promise<Redaction[]>;

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

@@ -0,0 +1,32 @@
+/**
+ * © 2026 AngelBot Ai Pvt Ltd. All rights reserved.
+ */
+/**
+ * Converts screen/canvas coordinates in rotated page space to canonical unrotated page space.
+ */
+export declare function convertToUnrotated(rawX: number, rawY: number, rotation: number, unW: number, unH: number): {
+    x: number;
+    y: number;
+};
+/**
+ * Converts canonical unrotated page coordinates to rotated page space.
+ */
+export declare function convertToRotated(unX: number, unY: number, rotation: number, unW: number, unH: number): {
+    x: number;
+    y: number;
+};
+/**
+ * Converts a rectangle from unrotated page space to rotated page space.
+ */
+export declare function convertToRotatedRect(x: number, y: number, width: number, height: number, rotation: number, unW: number, unH: number): {
+    x: number;
+    y: number;
+    width: number;
+    height: number;
+};
+/**
+ * Returns SVG transform string for SVG groups to match page rotation.
+ */
+export declare function getRotationTransform(rotation: number, unW: number, unH: number): string | undefined;
+/** Normalizes any degree value into [0, 360). */
+export declare function normalizeRotation(rotation: number): number;