react-pdf-highlighter-plus 1.0.2 → 1.0.4

package/dist/esm/contexts/PdfHighlighterContext.d.ts

@@ -1,89 +0,0 @@
-/// <reference types="react" />
-import { GhostHighlight, Highlight, PdfSelection, Tip } from "../types";
-import { PDFViewer } from "pdfjs-dist/types/web/pdf_viewer";
-/**
- * A set of utilities for to control the behaviour of {@link PdfHighlighter}.
- *
- * @category Context
- */
-export type PdfHighlighterUtils = {
-    /**
-     * Checks whether a selection is progress, a ghost highlight, or an edit.
-     *
-     * @returns - `true` if editing, ghost highlighting, or selecting.
-     */
-    isEditingOrHighlighting(): boolean;
-    /**
-     * Get currently selected area or text selection.
-     *
-     * @returns - current selection or `null` if no selection is being made.
-     */
-    getCurrentSelection(): PdfSelection | null;
-    /**
-     * Get the currently present ghost highlight.
-     *
-     * @return - currently present ghost highlight or `null` if non-existent.
-     */
-    getGhostHighlight(): GhostHighlight | null;
-    /**
-     * Cancel any ghost highlight.
-     * The selected area will stay selected until the user clicks away.
-     */
-    removeGhostHighlight(): void;
-    /**
-     * If enabled, automatic tips/popups inside of a PdfHighlighter will be disabled.
-     * Additional niceties will also be provided to prevent new highlights being made.
-     */
-    toggleEditInProgress(flag?: boolean): void;
-    /**
-     * Whether an AreaHighlight is being moved/resized, or a manual highlight edit has
-     * been toggled.
-     *
-     * @returns - `true` if AreaHighlight is being edited or edit mode was set.
-     */
-    isEditInProgress(): boolean;
-    /**
-     * Whether a mouse selection or text selection is currently being performed.
-     *
-     * @returns - `true` if mouse selection or text selection is being performed.
-     */
-    isSelectionInProgress(): boolean;
-    /**
-     * Scroll to a highlight in this viewer.
-     *
-     * @param highlight - A highlight provided to the {@link PdfHighlighter} to
-     * scroll to.
-     */
-    scrollToHighlight(highlight: Highlight): void;
-    /**
-     * Get a reference to the currently used instance of a PDF Viewer.
-     *
-     * @returns - The currently active PDF Viewer.
-     */
-    getViewer(): PDFViewer | null;
-    /**
-     * Get the currently active tip, if any.
-     *
-     * @returns - the currently active tip or `null` if inactive.
-     */
-    getTip(): Tip | null;
-    /**
-     * Set a tip to be displayed in the current PDF Viewer.
-     *
-     * @param tip - tip to be displayed, or `null` to hide any tip.
-     */
-    setTip(tip: Tip | null): void;
-    /**
-     * Callback to update any currently active tip's position. This will make sure
-     * the tip is visible above/below its highlight.
-     */
-    updateTipPosition(): void;
-};
-export declare const PdfHighlighterContext: import("react").Context<PdfHighlighterUtils | undefined>;
-/**
- * Custom hook for providing {@link PdfHighlighterUtils}. Must be used
- * within a child of {@link PdfHighlighter}.
- *
- * @category Context
- */
-export declare const usePdfHighlighterContext: () => PdfHighlighterUtils;

package/dist/esm/contexts/PdfHighlighterContext.js

@@ -1,16 +0,0 @@
-import { createContext, useContext } from "react";
-export const PdfHighlighterContext = createContext(undefined);
-/**
- * Custom hook for providing {@link PdfHighlighterUtils}. Must be used
- * within a child of {@link PdfHighlighter}.
- *
- * @category Context
- */
-export const usePdfHighlighterContext = () => {
-    const pdfHighlighterUtils = useContext(PdfHighlighterContext);
-    if (pdfHighlighterUtils === undefined) {
-        throw new Error("usePdfHighlighterContext must be used within PdfHighlighter!");
-    }
-    return pdfHighlighterUtils;
-};
-//# sourceMappingURL=PdfHighlighterContext.js.map

package/dist/esm/contexts/PdfHighlighterContext.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"PdfHighlighterContext.js","sourceRoot":"","sources":["../../../src/contexts/PdfHighlighterContext.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,UAAU,EAAE,MAAM,OAAO,CAAC;AA6FlD,MAAM,CAAC,MAAM,qBAAqB,GAAG,aAAa,CAEhD,SAAS,CAAC,CAAC;AAEb;;;;;GAKG;AACH,MAAM,CAAC,MAAM,wBAAwB,GAAG,GAAG,EAAE;IAC3C,MAAM,mBAAmB,GAAG,UAAU,CAAC,qBAAqB,CAAC,CAAC;IAE9D,IAAI,mBAAmB,KAAK,SAAS,EAAE,CAAC;QACtC,MAAM,IAAI,KAAK,CACb,8DAA8D,CAC/D,CAAC;IACJ,CAAC;IAED,OAAO,mBAAmB,CAAC;AAC7B,CAAC,CAAC"}

package/dist/esm/lib/coordinates.d.ts

@@ -1,16 +0,0 @@
-import { PDFViewer } from "pdfjs-dist/types/web/pdf_viewer";
-import type { LTWHP, ViewportPosition, Scaled, ScaledPosition } from "../types";
-import { PageViewport } from "pdfjs-dist";
-interface WIDTH_HEIGHT {
-    width: number;
-    height: number;
-}
-/** @category Utilities */
-export declare const viewportToScaled: (rect: LTWHP, { width, height }: WIDTH_HEIGHT) => Scaled;
-/** @category Utilities */
-export declare const viewportPositionToScaled: ({ boundingRect, rects }: ViewportPosition, viewer: PDFViewer) => ScaledPosition;
-/** @category Utilities */
-export declare const scaledToViewport: (scaled: Scaled, viewport: PageViewport, usePdfCoordinates?: boolean) => LTWHP;
-/** @category Utilities */
-export declare const scaledPositionToViewport: ({ boundingRect, rects, usePdfCoordinates }: ScaledPosition, viewer: PDFViewer) => ViewportPosition;
-export {};

package/dist/esm/lib/coordinates.js

@@ -1,69 +0,0 @@
-/** @category Utilities */
-export const viewportToScaled = (rect, { width, height }) => {
-    return {
-        x1: rect.left,
-        y1: rect.top,
-        x2: rect.left + rect.width,
-        y2: rect.top + rect.height,
-        width,
-        height,
-        pageNumber: rect.pageNumber,
-    };
-};
-/** @category Utilities */
-export const viewportPositionToScaled = ({ boundingRect, rects }, viewer) => {
-    const pageNumber = boundingRect.pageNumber;
-    const viewport = viewer.getPageView(pageNumber - 1).viewport; // Account for 1 indexing of PDF documents
-    const scale = (obj) => viewportToScaled(obj, viewport);
-    return {
-        boundingRect: scale(boundingRect),
-        rects: (rects || []).map(scale),
-    };
-};
-const pdfToViewport = (pdf, viewport) => {
-    const [x1, y1, x2, y2] = viewport.convertToViewportRectangle([
-        pdf.x1,
-        pdf.y1,
-        pdf.x2,
-        pdf.y2,
-    ]);
-    return {
-        left: Math.min(x1, x2),
-        top: Math.min(y1, y2),
-        width: Math.abs(x2 - x1),
-        height: Math.abs(y1 - y2),
-        pageNumber: pdf.pageNumber,
-    };
-};
-/** @category Utilities */
-export const scaledToViewport = (scaled, viewport, usePdfCoordinates = false) => {
-    const { width, height } = viewport;
-    if (usePdfCoordinates) {
-        return pdfToViewport(scaled, viewport);
-    }
-    if (scaled.x1 === undefined) {
-        throw new Error("You are using old position format, please update");
-    }
-    const x1 = (width * scaled.x1) / scaled.width;
-    const y1 = (height * scaled.y1) / scaled.height;
-    const x2 = (width * scaled.x2) / scaled.width;
-    const y2 = (height * scaled.y2) / scaled.height;
-    return {
-        left: x1,
-        top: y1,
-        width: x2 - x1,
-        height: y2 - y1,
-        pageNumber: scaled.pageNumber,
-    };
-};
-/** @category Utilities */
-export const scaledPositionToViewport = ({ boundingRect, rects, usePdfCoordinates }, viewer) => {
-    const pageNumber = boundingRect.pageNumber;
-    const viewport = viewer.getPageView(pageNumber - 1).viewport; // Account for 1 indexing of PDF documents
-    const scale = (obj) => scaledToViewport(obj, viewport, usePdfCoordinates);
-    return {
-        boundingRect: scale(boundingRect),
-        rects: (rects || []).map(scale),
-    };
-};
-//# sourceMappingURL=coordinates.js.map

package/dist/esm/lib/coordinates.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"coordinates.js","sourceRoot":"","sources":["../../../src/lib/coordinates.ts"],"names":[],"mappings":"AASA,0BAA0B;AAC1B,MAAM,CAAC,MAAM,gBAAgB,GAAG,CAC9B,IAAW,EACX,EAAE,KAAK,EAAE,MAAM,EAAgB,EACvB,EAAE;IACV,OAAO;QACL,EAAE,EAAE,IAAI,CAAC,IAAI;QACb,EAAE,EAAE,IAAI,CAAC,GAAG;QAEZ,EAAE,EAAE,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,KAAK;QAC1B,EAAE,EAAE,IAAI,CAAC,GAAG,GAAG,IAAI,CAAC,MAAM;QAE1B,KAAK;QACL,MAAM;QAEN,UAAU,EAAE,IAAI,CAAC,UAAU;KAC5B,CAAC;AACJ,CAAC,CAAC;AAEF,0BAA0B;AAC1B,MAAM,CAAC,MAAM,wBAAwB,GAAG,CACtC,EAAE,YAAY,EAAE,KAAK,EAAoB,EACzC,MAAiB,EACD,EAAE;IAClB,MAAM,UAAU,GAAG,YAAY,CAAC,UAAU,CAAC;IAC3C,MAAM,QAAQ,GAAG,MAAM,CAAC,WAAW,CAAC,UAAU,GAAG,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,0CAA0C;IACxG,MAAM,KAAK,GAAG,CAAC,GAAU,EAAE,EAAE,CAAC,gBAAgB,CAAC,GAAG,EAAE,QAAQ,CAAC,CAAC;IAE9D,OAAO;QACL,YAAY,EAAE,KAAK,CAAC,YAAY,CAAC;QACjC,KAAK,EAAE,CAAC,KAAK,IAAI,EAAE,CAAC,CAAC,GAAG,CAAC,KAAK,CAAC;KAChC,CAAC;AACJ,CAAC,CAAC;AAEF,MAAM,aAAa,GAAG,CAAC,GAAW,EAAE,QAAsB,EAAS,EAAE;IACnE,MAAM,CAAC,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,CAAC,GAAG,QAAQ,CAAC,0BAA0B,CAAC;QAC3D,GAAG,CAAC,EAAE;QACN,GAAG,CAAC,EAAE;QACN,GAAG,CAAC,EAAE;QACN,GAAG,CAAC,EAAE;KACP,CAAC,CAAC;IAEH,OAAO;QACL,IAAI,EAAE,IAAI,CAAC,GAAG,CAAC,EAAE,EAAE,EAAE,CAAC;QACtB,GAAG,EAAE,IAAI,CAAC,GAAG,CAAC,EAAE,EAAE,EAAE,CAAC;QAErB,KAAK,EAAE,IAAI,CAAC,GAAG,CAAC,EAAE,GAAG,EAAE,CAAC;QACxB,MAAM,EAAE,IAAI,CAAC,GAAG,CAAC,EAAE,GAAG,EAAE,CAAC;QAEzB,UAAU,EAAE,GAAG,CAAC,UAAU;KAC3B,CAAC;AACJ,CAAC,CAAC;AAEF,0BAA0B;AAC1B,MAAM,CAAC,MAAM,gBAAgB,GAAG,CAC9B,MAAc,EACd,QAAsB,EACtB,oBAA6B,KAAK,EAC3B,EAAE;IACT,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,GAAG,QAAQ,CAAC;IAEnC,IAAI,iBAAiB,EAAE,CAAC;QACtB,OAAO,aAAa,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAC;IACzC,CAAC;IAED,IAAI,MAAM,CAAC,EAAE,KAAK,SAAS,EAAE,CAAC;QAC5B,MAAM,IAAI,KAAK,CAAC,kDAAkD,CAAC,CAAC;IACtE,CAAC;IAED,MAAM,EAAE,GAAG,CAAC,KAAK,GAAG,MAAM,CAAC,EAAE,CAAC,GAAG,MAAM,CAAC,KAAK,CAAC;IAC9C,MAAM,EAAE,GAAG,CAAC,MAAM,GAAG,MAAM,CAAC,EAAE,CAAC,GAAG,MAAM,CAAC,MAAM,CAAC;IAEhD,MAAM,EAAE,GAAG,CAAC,KAAK,GAAG,MAAM,CAAC,EAAE,CAAC,GAAG,MAAM,CAAC,KAAK,CAAC;IAC9C,MAAM,EAAE,GAAG,CAAC,MAAM,GAAG,MAAM,CAAC,EAAE,CAAC,GAAG,MAAM,CAAC,MAAM,CAAC;IAEhD,OAAO;QACL,IAAI,EAAE,EAAE;QACR,GAAG,EAAE,EAAE;QACP,KAAK,EAAE,EAAE,GAAG,EAAE;QACd,MAAM,EAAE,EAAE,GAAG,EAAE;QACf,UAAU,EAAE,MAAM,CAAC,UAAU;KAC9B,CAAC;AACJ,CAAC,CAAC;AAEF,0BAA0B;AAC1B,MAAM,CAAC,MAAM,wBAAwB,GAAG,CACtC,EAAE,YAAY,EAAE,KAAK,EAAE,iBAAiB,EAAkB,EAC1D,MAAiB,EACC,EAAE;IACpB,MAAM,UAAU,GAAG,YAAY,CAAC,UAAU,CAAC;IAC3C,MAAM,QAAQ,GAAG,MAAM,CAAC,WAAW,CAAC,UAAU,GAAG,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,0CAA0C;IACxG,MAAM,KAAK,GAAG,CAAC,GAAW,EAAE,EAAE,CAC5B,gBAAgB,CAAC,GAAG,EAAE,QAAQ,EAAE,iBAAiB,CAAC,CAAC;IAErD,OAAO;QACL,YAAY,EAAE,KAAK,CAAC,YAAY,CAAC;QACjC,KAAK,EAAE,CAAC,KAAK,IAAI,EAAE,CAAC,CAAC,GAAG,CAAC,KAAK,CAAC;KAChC,CAAC;AACJ,CAAC,CAAC"}

package/dist/esm/lib/export-pdf.d.ts

@@ -1,81 +0,0 @@
-import type { ScaledPosition, ShapeData } from "../types";
-/**
- * Options for the PDF export function.
- *
- * @category Type
- */
-export interface ExportPdfOptions {
-    /** Default color for text highlights. Default: "rgba(255, 226, 143, 0.5)" */
-    textHighlightColor?: string;
-    /** Default color for area highlights. Default: "rgba(255, 226, 143, 0.5)" */
-    areaHighlightColor?: string;
-    /** Default text color for freetext. Default: "#333333" */
-    defaultFreetextColor?: string;
-    /** Default background for freetext. Default: "#ffffc8" */
-    defaultFreetextBgColor?: string;
-    /** Default font size for freetext. Default: 14 */
-    defaultFreetextFontSize?: number;
-    /** Progress callback for large PDFs */
-    onProgress?: (current: number, total: number) => void;
-}
-/**
- * A highlight that can be exported to PDF.
- *
- * @category Type
- */
-export interface ExportableHighlight {
-    id: string;
-    type?: "text" | "area" | "freetext" | "image" | "drawing" | "shape";
-    content?: {
-        text?: string;
-        image?: string;
-        shape?: ShapeData;
-    };
-    position: ScaledPosition;
-    /** Per-highlight color override (for text/area highlights) */
-    highlightColor?: string;
-    /** Style mode for text highlights: "highlight" (default), "underline", or "strikethrough" */
-    highlightStyle?: "highlight" | "underline" | "strikethrough";
-    /** Text color for freetext highlights */
-    color?: string;
-    /** Background color for freetext highlights */
-    backgroundColor?: string;
-    /** Font size for freetext highlights */
-    fontSize?: string;
-    /** Font family for freetext highlights (not used in export, Helvetica is always used) */
-    fontFamily?: string;
-    /** Shape type for shape highlights */
-    shapeType?: "rectangle" | "circle" | "arrow";
-    /** Stroke color for shape highlights */
-    strokeColor?: string;
-    /** Stroke width for shape highlights */
-    strokeWidth?: number;
-}
-/**
- * Export a PDF with annotations embedded.
- *
- * @param pdfSource - The source PDF as a URL string, Uint8Array, or ArrayBuffer
- * @param highlights - Array of highlights to embed in the PDF
- * @param options - Export options for customizing colors and behavior
- * @returns Promise<Uint8Array> - The modified PDF as bytes
- *
- * @example
- * ```typescript
- * const pdfBytes = await exportPdf(pdfUrl, highlights, {
- *   textHighlightColor: "rgba(255, 255, 0, 0.4)",
- *   onProgress: (current, total) => console.log(`${current}/${total} pages`)
- * });
- *
- * // Download the file
- * const blob = new Blob([pdfBytes], { type: "application/pdf" });
- * const url = URL.createObjectURL(blob);
- * const a = document.createElement("a");
- * a.href = url;
- * a.download = "annotated.pdf";
- * a.click();
- * URL.revokeObjectURL(url);
- * ```
- *
- * @category Function
- */
-export declare function exportPdf(pdfSource: string | Uint8Array | ArrayBuffer, highlights: ExportableHighlight[], options?: ExportPdfOptions): Promise<Uint8Array>;