@arbidocs/react 0.5.111 → 0.5.112

package/dist/viewers/PdfViewer.d.cts

@@ -1,9 +0,0 @@
-import { ComponentType } from 'react';
-import { L as LazyChunk } from '../lazy-chunk.d-B6YDLMKI.cjs';
-import { a as PdfViewerProps, _ as __PdfViewerImpl } from '../PdfViewerImpl.d-B28hLEuj.cjs';
-export { P as PdfViewerAssets } from '../PdfViewerImpl.d-B28hLEuj.cjs';
-
-declare const pdfViewerChunk: LazyChunk<typeof __PdfViewerImpl>;
-declare const PdfViewer: ComponentType<PdfViewerProps>;
-
-export { PdfViewer, PdfViewerProps, pdfViewerChunk };

package/dist/viewers/index.d.cts

@@ -1,262 +0,0 @@
-export { PdfViewer, pdfViewerChunk } from './PdfViewer.cjs';
-import * as React from 'react';
-import { RefObject } from 'react';
-export { P as PdfViewerAssets, a as PdfViewerProps } from '../PdfViewerImpl.d-B28hLEuj.cjs';
-import '../lazy-chunk.d-B6YDLMKI.cjs';
-
-/**
- * Shims for the newer JS built-ins pdf.js 6 calls on the main thread, which browsers still in use
- * lack (Chrome 128, for one, has none of the first three):
- *
- *   - `Map.prototype.getOrInsertComputed` / `getOrInsert`, and the `WeakMap` pair (Chrome 145).
- *     Behind every page render: without it "this[#t].getOrInsertComputed is not a function" is
- *     thrown and nothing draws.
- *   - `Uint8Array.prototype.toHex` / `Uint8Array.fromHex` and `toBase64` / `fromBase64` (Chrome
- *     140): document fingerprints, embedded fonts, signatures.
- *   - `Math.sumPrecise` (Chrome 147): float accumulation; missing, layout degrades to NaN.
- *   - `Promise.try` (Chrome 128): the worker message handler.
- *
- * {@link installPdfjsPolyfills} is called by every code path here that runs pdf.js (the
- * `PdfViewer`, the browser Freeze rasteriser), so a host never has to load them itself. It is a
- * function rather than a side-effect import because this package is `sideEffects: false`: a
- * bundler may drop a bare import, never a call. Each shim steps aside where the runtime has the
- * real method. The pdf.js worker has its own global scope and gets the same set prepended by
- * `arbidocs-copy-pdf-assets` (@arbidocs/blocks).
- */
-/** Install the shims pdf.js needs on this thread. Idempotent and cheap: call it before using pdf.js. */
-declare function installPdfjsPolyfills(): void;
-
-/**
- * DocxViewer
- *
- * Renders DOCX files natively using docx-preview, preserving track changes
- * (shown as strikethrough deletions + inserted text) and inline comments.
- *
- * Pages render at their natural width and are scaled down to fit the
- * container, so the document resizes with the panel instead of clipping.
- *
- * `docx-preview` is an OPTIONAL peer dependency, imported dynamically — a
- * consumer that never renders a .docx does not need it installed. If it is
- * missing the viewer shows a load error rather than crashing the app.
- */
-interface DocxViewerProps {
-    blob: Blob;
-}
-declare function DocxViewer({ blob }: DocxViewerProps): React.JSX.Element;
-
-/**
- * XlsxViewer
- *
- * Renders spreadsheets natively using SheetJS, showing every sheet with a tab
- * bar. Preserves cell data and multiple sheets.
- *
- * `xlsx` is an OPTIONAL peer dependency, imported dynamically — a consumer that
- * never renders a spreadsheet does not need it installed. If it is missing the
- * viewer shows a load error rather than crashing the app.
- */
-interface XlsxViewerProps {
-    blob: Blob;
-}
-declare function XlsxViewer({ blob }: XlsxViewerProps): React.JSX.Element;
-
-interface ImageViewerProps {
-    blob: Blob;
-    alt: string;
-}
-/** Renders an image blob, scaled to fit its container. */
-declare function ImageViewer({ blob, alt }: ImageViewerProps): React.JSX.Element | null;
-
-interface AudioViewerProps {
-    blob: Blob;
-    title: string;
-}
-/** Renders an audio blob with the browser's native transport controls. */
-declare function AudioViewer({ blob, title }: AudioViewerProps): React.JSX.Element | null;
-
-interface VideoViewerProps {
-    blob: Blob;
-    title: string;
-}
-/** Renders a video blob with the browser's native transport controls. */
-declare function VideoViewer({ blob, title }: VideoViewerProps): React.JSX.Element | null;
-
-/**
- * Zoom for page-stacked viewers (PDF + parsed/HTML).
- *
- * Browser pinch-zoom only magnifies the bitmap the page already painted: a PDF canvas rendered at
- * fit-width stays blurry however far you pinch. The viewers therefore own the zoom: `zoom` is a
- * multiplier of the fit-width size (1 = fit width, 2 = twice as wide). The PDF viewer re-renders
- * its canvases at the new scale; the parsed viewer reflows its text. This module holds the pure
- * math and the touch gesture hook (pinch, double-tap) both use.
- */
-
-declare const MIN_ZOOM = 0.5;
-declare const MAX_ZOOM = 4;
-declare function clampZoom(zoom: number): number;
-/** The zoom button: the next preset above the current zoom, or back to fit width after the last. */
-declare function cycleZoom(zoom: number): number;
-/** Double-tap toggles between fit width and a comfortable reading zoom. */
-declare function doubleTapZoom(zoom: number): number;
-declare function zoomLabel(zoom: number): string;
-/** The zoom a pinch has reached: the start zoom scaled by how far the fingers moved apart. */
-declare function pinchZoom(startZoom: number, startDistance: number, distance: number): number;
-/**
- * New scroll offset that keeps the content point under `focal` (a viewport coordinate) still while
- * the zoom changes from `oldZoom` to `newZoom`.
- */
-declare function anchoredScroll(scroll: number, focal: number, oldZoom: number, newZoom: number): number;
-/**
- * Device pixel ratio to rasterise a page of `cssWidth` x `cssHeight` at: the device's own, capped,
- * and lowered further when the page would otherwise exceed the canvas pixel budget.
- */
-declare function renderDpr(cssWidth: number, cssHeight: number, devicePixelRatio: number, maxPixels?: number): number;
-interface PinchZoomOptions {
-    containerRef: RefObject<HTMLElement | null>;
-    zoom: number;
-    onZoomChange?: (zoom: number) => void;
-}
-/**
- * Pinch and double-tap zoom on a scroller, plus focal-point preservation for EVERY zoom change
- * (gesture, buttons, props): after the new zoom has laid out, the scroll offset is moved so the
- * content under the pinch centre (or the viewport centre) stays where it was.
- *
- * The scroller must carry `touch-action: pan-x pan-y` so the browser leaves two-finger gestures
- * to this hook instead of zooming the whole app.
- */
-declare function usePinchZoom({ containerRef, zoom, onZoomChange }: PinchZoomOptions): void;
-
-/**
- * Scroll stability for page-stacked viewers (PDF + parsed/HTML).
- *
- * Pages are lazy: their height can change after the user is already looking at something further
- * down (a placeholder replaced by the real page, a late canvas). Browsers that implement scroll
- * anchoring (Chromium) hide that; Safari/WebKit does not, so the content visibly jumps under the
- * finger and momentum scrolling is cut short. The viewers therefore do their own anchoring, the
- * same way on every engine: native anchoring is switched off and a page that changes height
- * entirely ABOVE the viewport shifts `scrollTop` by exactly that change.
- */
-
-/** One page of a stacked viewer (both viewers mark pages like this). */
-declare const PAGE_SELECTOR = "[role=\"article\"][data-page-number]";
-/**
- * How far to move `scrollTop` after a page changed height from `previousHeight` to `nextHeight`.
- * Only a page that lay completely above the visible top edge (`containerTop`) pushes the content
- * the user is reading; anything at or below it just grows or shrinks away from the viewport.
- *
- * @param pageTop viewport-relative top of the page (unchanged by its own resize)
- */
-declare function anchorDelta(previousHeight: number, nextHeight: number, pageTop: number, containerTop: number): number;
-/**
- * Keep the reading position when pages above it change height. `key` re-scans for pages when the
- * page set changes (page count, first layout).
- */
-declare function useScrollAnchor(containerRef: RefObject<HTMLElement | null>, key: unknown): void;
-
-interface UsePageIntersectionObserverOptions {
-    /** Container element that scrolls */
-    containerRef: RefObject<HTMLElement | null>;
-    /** Ref tracking whether initial scroll has completed */
-    scrollCompleteRef: RefObject<boolean>;
-    /** Whether the observer should be active */
-    isEnabled: boolean;
-    /** Function to get page elements to observe */
-    getPageElements: () => Element[];
-    /** Function to extract page number from element */
-    getPageNumber: (element: Element) => number;
-    /** Callback when page number changes */
-    onPageChange: (pageNumber: number) => void;
-    /** Optional callback with visibility data for custom logic (e.g., lazy loading) */
-    onVisibilityUpdate?: (visibilityMap: Map<number, number>) => void;
-    /**
-     * Re-subscribe when this changes (the set of page elements: page count, first layout). Callers
-     * may pass fresh inline callbacks every render: they are read through refs and never cause a
-     * re-subscribe (a re-subscribe re-delivers every page and, with a state-setting callback, loops).
-     */
-    observeKey?: unknown;
-}
-/**
- * Custom hook to track the visible page of a page-stacked viewer.
- * Used for bidirectional page synchronization in document viewers.
- *
- * IntersectionObserver wakes it when pages enter or leave the viewport; a passive scroll listener
- * (at most one measurement per frame) keeps it current in between. The page itself is chosen from
- * live geometry (see `measureVisiblePages`).
- */
-declare function usePageIntersectionObserver({ containerRef, scrollCompleteRef, isEnabled, getPageElements, getPageNumber, onPageChange, onVisibilityUpdate, observeKey, }: UsePageIntersectionObserverOptions): void;
-
-/** Pages to render before the visible area (canvas pre-load buffer) */
-declare const LAZY_LOAD_BUFFER_BEFORE = 2;
-/** Pages to render after the visible area (canvas pre-load buffer) */
-declare const LAZY_LOAD_BUFFER_AFTER = 5;
-/**
- * Smaller render window used on the very first paint so time-to-first-visible-page is
- * fast. Expanded to LAZY_LOAD_BUFFER_BEFORE / LAZY_LOAD_BUFFER_AFTER once the browser
- * is idle (via requestIdleCallback / setTimeout fallback).
- */
-declare const INITIAL_LAZY_LOAD_BUFFER: {
-    before: number;
-    after: number;
-};
-
-/**
- * Processed Chunks Hook
- *
- * Processes raw document chunks into page-grouped structure.
- * Pre-computes footnote inlining so it runs once during processing, not on every render.
- */
-interface RawChunk {
-    content: string;
-    metadata?: {
-        page_number?: number;
-        chunk_doc_idx?: number;
-        chunk_ext_id?: string;
-        doc_title?: string | null;
-    };
-}
-interface ProcessedChunk {
-    content: string;
-    chunkIndex: number | undefined;
-    chunkExtId: string | undefined;
-    docTitle: string | undefined;
-}
-interface ProcessedPage {
-    pageNumber: number | null;
-    chunks: ProcessedChunk[];
-}
-interface UseProcessedChunksResult {
-    processedChunks: ProcessedPage[];
-    maxPageNumber: number;
-}
-declare function useProcessedChunks(chunks: RawChunk[] | undefined, footnotes?: Record<string, string>): UseProcessedChunksResult;
-
-/**
- * Contiguous-run grouping for selected passages.
- *
- * Selecting passages 4–9 is one citation, not six. This collapses a flat set of
- * selected chunk ids into the contiguous runs they form in document order, so
- * the viewer can draw each run as a single block with a single "p.3(4–9)" label
- * instead of stacking six identical pills.
- *
- * Purely positional: the pages arrive in document order (which is
- * `chunk_doc_idx` order), so adjacency is just "next in the list".
- */
-interface RunChunk {
-    chunkExtId: string | undefined;
-    /** 0-based index within the document; displayed 1-based */
-    chunkIndex: number | undefined;
-}
-interface RunPage {
-    pageNumber: number | null;
-    chunks: RunChunk[];
-}
-/** Where a selected chunk sits inside its contiguous run of selected chunks. */
-interface ChunkRunInfo {
-    isStart: boolean;
-    isEnd: boolean;
-    /** Set only on the run's first member — the bounds its single label shows. */
-    endIndex: number | undefined;
-    endPage: number | null | undefined;
-}
-declare function computeSelectionRuns(pages: RunPage[], selectedChunks: Set<string>): Map<string, ChunkRunInfo>;
-
-export { AudioViewer, type AudioViewerProps, type ChunkRunInfo, DocxViewer, type DocxViewerProps, INITIAL_LAZY_LOAD_BUFFER, ImageViewer, type ImageViewerProps, LAZY_LOAD_BUFFER_AFTER, LAZY_LOAD_BUFFER_BEFORE, MAX_ZOOM, MIN_ZOOM, PAGE_SELECTOR, type ProcessedChunk, type ProcessedPage, type RawChunk, type RunChunk, type RunPage, type UseProcessedChunksResult, VideoViewer, type VideoViewerProps, XlsxViewer, type XlsxViewerProps, anchorDelta, anchoredScroll, clampZoom, computeSelectionRuns, cycleZoom, doubleTapZoom, installPdfjsPolyfills, pinchZoom, renderDpr, usePageIntersectionObserver, usePinchZoom, useProcessedChunks, useScrollAnchor, zoomLabel };