react-web-pdf-editor 0.0.0-stage → 0.1.1

package/dist/index.d.cts

@@ -0,0 +1,195 @@
+import * as react from 'react';
+import { CSSProperties, ReactNode } from 'react';
+import { PDFDocumentProxy } from 'pdfjs-dist';
+
+declare function configurePdfWorker(workerSrc?: string): void;
+
+type PdfSource = string | URL | File | Blob | ArrayBuffer | Uint8Array;
+type PdfLoadSuccess = {
+    numPages: number;
+};
+type Tool = "select" | "draw" | "text" | "highlight" | "image" | "signature";
+type TextAnnotation = {
+    id: string;
+    pageNumber: number;
+    x: number;
+    y: number;
+    width?: number;
+    height?: number;
+    text: string;
+    fontFamily: string;
+    fontSize: number;
+    color: string;
+    fontWeight: "normal" | "bold";
+    fontStyle: "normal" | "italic";
+    textAlign: "left" | "center" | "right";
+    rotation?: number;
+};
+type DrawPoint = {
+    x: number;
+    y: number;
+};
+type DrawStroke = {
+    id: string;
+    pageNumber: number;
+    points: DrawPoint[];
+    color: string;
+    width: number;
+};
+type HighlightRect = {
+    left: number;
+    top: number;
+    width: number;
+    height: number;
+};
+type HighlightAnnotation = {
+    id: string;
+    pageNumber: number;
+    rects: HighlightRect[];
+    color: string;
+    text?: string;
+};
+type SignatureAnnotation = {
+    id: string;
+    pageNumber: number;
+    x: number;
+    y: number;
+    width: number;
+    height: number;
+    src: string;
+    rotation?: number;
+};
+type PendingSignature = {
+    src: string;
+    aspect: number;
+};
+type ImageAnnotation = {
+    id: string;
+    pageNumber: number;
+    x: number;
+    y: number;
+    width: number;
+    height: number;
+    src: string;
+    rotation?: number;
+    opacity?: number;
+};
+type PendingImage = {
+    src: string;
+    aspect: number;
+    name?: string;
+};
+type ToolbarSearchState = {
+    query: string;
+    setQuery: (query: string) => void;
+    matchCount: number;
+    currentIndex: number;
+    next: () => void;
+    prev: () => void;
+    clear: () => void;
+};
+type ToolbarShortcuts = {
+    undo: string;
+    redo: string;
+    undoKeys: string;
+    redoKeys: string;
+};
+type ToolbarApi = {
+    name: string;
+    setName: (name: string) => void;
+    disabled: boolean;
+    canUndo: boolean;
+    canRedo: boolean;
+    undoLabel?: string;
+    redoLabel?: string;
+    undo: () => void;
+    redo: () => void;
+    shortcuts: ToolbarShortcuts;
+    activeTool: Tool;
+    setTool: (tool: Tool) => void;
+    scale: number;
+    minScale: number;
+    maxScale: number;
+    setScale: (scale: number) => void;
+    zoomIn: () => void;
+    zoomOut: () => void;
+    page: number;
+    numPages: number;
+    setPage: (page: number) => void;
+    prevPage: () => void;
+    nextPage: () => void;
+    search: ToolbarSearchState;
+    exportPdf: () => void;
+    exporting: boolean;
+    exportError: Error | null;
+};
+type SidebarPage = {
+    pageNumber: number;
+    index: number;
+    label: number;
+    selected: boolean;
+    justAdded: boolean;
+};
+type SidebarApi = {
+    pdf: PDFDocumentProxy | null;
+    page: number;
+    numPages: number;
+    pages: SidebarPage[];
+    setPage: (page: number) => void;
+    addBlankPage: (afterPage: number) => void;
+    deletePage: (pageNumber: number) => void;
+    reorderPages: (from: number, to: number) => void;
+    disabled: boolean;
+    mutating: boolean;
+    adding: boolean;
+    canAdd: boolean;
+    canDelete: boolean;
+    canReorder: boolean;
+    error: string | null;
+    drawStrokes: DrawStroke[];
+    highlights: HighlightAnnotation[];
+    textAnnotations: TextAnnotation[];
+    signatures: SignatureAnnotation[];
+    images: ImageAnnotation[];
+};
+type PdfEditorProps = {
+    file?: PdfSource | null;
+    name?: string;
+    className?: string;
+    style?: CSSProperties;
+    page?: number;
+    defaultPage?: number;
+    scale?: number;
+    defaultScale?: number;
+    minScale?: number;
+    maxScale?: number;
+    workerSrc?: string;
+    exportWorkerSrc?: string;
+    exportFileName?: string;
+    showToolbar?: boolean;
+    toolbar?: (api: ToolbarApi) => ReactNode;
+    showSidebar?: boolean;
+    sidebar?: (api: SidebarApi) => ReactNode;
+    emptyState?: ReactNode;
+    onLoadSuccess?: (info: PdfLoadSuccess) => void;
+    onLoadError?: (error: Error) => void;
+    onPageChange?: (page: number) => void;
+    onScaleChange?: (scale: number) => void;
+    onNameChange?: (name: string) => void;
+    onExport?: (blob: Blob) => void | Promise<void>;
+    onExportError?: (error: Error) => void;
+};
+
+declare function PdfEditor({ file, name, className, style, page, defaultPage, scale, defaultScale, minScale, maxScale, workerSrc, exportWorkerSrc, exportFileName, showToolbar, toolbar, showSidebar, sidebar, emptyState, onLoadSuccess, onLoadError, onPageChange, onScaleChange, onNameChange, onExport, onExportError, }: PdfEditorProps): react.JSX.Element;
+
+declare function PagesSidebar({ pdf, page, pages, setPage, addBlankPage, deletePage, reorderPages, adding, mutating, canAdd, canDelete, canReorder, disabled, error, drawStrokes, highlights, textAnnotations, signatures, images, }: SidebarApi): react.JSX.Element;
+
+type ToolbarProps = ToolbarApi & {
+    compact?: boolean;
+    showPagesButton?: boolean;
+    pagesOpen?: boolean;
+    onTogglePages?: () => void;
+};
+declare function Toolbar({ page, numPages, scale, minScale, maxScale, disabled, activeTool, search, setPage, setScale, setTool, exportPdf, exporting, exportError, name, setName, canUndo, canRedo, undoLabel, redoLabel, undo, redo, shortcuts, zoomIn, zoomOut, prevPage, nextPage, compact, showPagesButton, pagesOpen, onTogglePages, }: ToolbarProps): react.JSX.Element;
+
+export { type DrawPoint, type DrawStroke, type HighlightAnnotation, type HighlightRect, type ImageAnnotation, PagesSidebar, PdfEditor, type PdfEditorProps, type PdfLoadSuccess, type PdfSource, type PendingImage, type PendingSignature, type SidebarApi, type SidebarPage, type SignatureAnnotation, type TextAnnotation, type Tool, Toolbar, type ToolbarApi, type ToolbarSearchState, type ToolbarShortcuts, configurePdfWorker };

package/dist/index.d.ts

@@ -0,0 +1,195 @@
+import * as react from 'react';
+import { CSSProperties, ReactNode } from 'react';
+import { PDFDocumentProxy } from 'pdfjs-dist';
+
+declare function configurePdfWorker(workerSrc?: string): void;
+
+type PdfSource = string | URL | File | Blob | ArrayBuffer | Uint8Array;
+type PdfLoadSuccess = {
+    numPages: number;
+};
+type Tool = "select" | "draw" | "text" | "highlight" | "image" | "signature";
+type TextAnnotation = {
+    id: string;
+    pageNumber: number;
+    x: number;
+    y: number;
+    width?: number;
+    height?: number;
+    text: string;
+    fontFamily: string;
+    fontSize: number;
+    color: string;
+    fontWeight: "normal" | "bold";
+    fontStyle: "normal" | "italic";
+    textAlign: "left" | "center" | "right";
+    rotation?: number;
+};
+type DrawPoint = {
+    x: number;
+    y: number;
+};
+type DrawStroke = {
+    id: string;
+    pageNumber: number;
+    points: DrawPoint[];
+    color: string;
+    width: number;
+};
+type HighlightRect = {
+    left: number;
+    top: number;
+    width: number;
+    height: number;
+};
+type HighlightAnnotation = {
+    id: string;
+    pageNumber: number;
+    rects: HighlightRect[];
+    color: string;
+    text?: string;
+};
+type SignatureAnnotation = {
+    id: string;
+    pageNumber: number;
+    x: number;
+    y: number;
+    width: number;
+    height: number;
+    src: string;
+    rotation?: number;
+};
+type PendingSignature = {
+    src: string;
+    aspect: number;
+};
+type ImageAnnotation = {
+    id: string;
+    pageNumber: number;
+    x: number;
+    y: number;
+    width: number;
+    height: number;
+    src: string;
+    rotation?: number;
+    opacity?: number;
+};
+type PendingImage = {
+    src: string;
+    aspect: number;
+    name?: string;
+};
+type ToolbarSearchState = {
+    query: string;
+    setQuery: (query: string) => void;
+    matchCount: number;
+    currentIndex: number;
+    next: () => void;
+    prev: () => void;
+    clear: () => void;
+};
+type ToolbarShortcuts = {
+    undo: string;
+    redo: string;
+    undoKeys: string;
+    redoKeys: string;
+};
+type ToolbarApi = {
+    name: string;
+    setName: (name: string) => void;
+    disabled: boolean;
+    canUndo: boolean;
+    canRedo: boolean;
+    undoLabel?: string;
+    redoLabel?: string;
+    undo: () => void;
+    redo: () => void;
+    shortcuts: ToolbarShortcuts;
+    activeTool: Tool;
+    setTool: (tool: Tool) => void;
+    scale: number;
+    minScale: number;
+    maxScale: number;
+    setScale: (scale: number) => void;
+    zoomIn: () => void;
+    zoomOut: () => void;
+    page: number;
+    numPages: number;
+    setPage: (page: number) => void;
+    prevPage: () => void;
+    nextPage: () => void;
+    search: ToolbarSearchState;
+    exportPdf: () => void;
+    exporting: boolean;
+    exportError: Error | null;
+};
+type SidebarPage = {
+    pageNumber: number;
+    index: number;
+    label: number;
+    selected: boolean;
+    justAdded: boolean;
+};
+type SidebarApi = {
+    pdf: PDFDocumentProxy | null;
+    page: number;
+    numPages: number;
+    pages: SidebarPage[];
+    setPage: (page: number) => void;
+    addBlankPage: (afterPage: number) => void;
+    deletePage: (pageNumber: number) => void;
+    reorderPages: (from: number, to: number) => void;
+    disabled: boolean;
+    mutating: boolean;
+    adding: boolean;
+    canAdd: boolean;
+    canDelete: boolean;
+    canReorder: boolean;
+    error: string | null;
+    drawStrokes: DrawStroke[];
+    highlights: HighlightAnnotation[];
+    textAnnotations: TextAnnotation[];
+    signatures: SignatureAnnotation[];
+    images: ImageAnnotation[];
+};
+type PdfEditorProps = {
+    file?: PdfSource | null;
+    name?: string;
+    className?: string;
+    style?: CSSProperties;
+    page?: number;
+    defaultPage?: number;
+    scale?: number;
+    defaultScale?: number;
+    minScale?: number;
+    maxScale?: number;
+    workerSrc?: string;
+    exportWorkerSrc?: string;
+    exportFileName?: string;
+    showToolbar?: boolean;
+    toolbar?: (api: ToolbarApi) => ReactNode;
+    showSidebar?: boolean;
+    sidebar?: (api: SidebarApi) => ReactNode;
+    emptyState?: ReactNode;
+    onLoadSuccess?: (info: PdfLoadSuccess) => void;
+    onLoadError?: (error: Error) => void;
+    onPageChange?: (page: number) => void;
+    onScaleChange?: (scale: number) => void;
+    onNameChange?: (name: string) => void;
+    onExport?: (blob: Blob) => void | Promise<void>;
+    onExportError?: (error: Error) => void;
+};
+
+declare function PdfEditor({ file, name, className, style, page, defaultPage, scale, defaultScale, minScale, maxScale, workerSrc, exportWorkerSrc, exportFileName, showToolbar, toolbar, showSidebar, sidebar, emptyState, onLoadSuccess, onLoadError, onPageChange, onScaleChange, onNameChange, onExport, onExportError, }: PdfEditorProps): react.JSX.Element;
+
+declare function PagesSidebar({ pdf, page, pages, setPage, addBlankPage, deletePage, reorderPages, adding, mutating, canAdd, canDelete, canReorder, disabled, error, drawStrokes, highlights, textAnnotations, signatures, images, }: SidebarApi): react.JSX.Element;
+
+type ToolbarProps = ToolbarApi & {
+    compact?: boolean;
+    showPagesButton?: boolean;
+    pagesOpen?: boolean;
+    onTogglePages?: () => void;
+};
+declare function Toolbar({ page, numPages, scale, minScale, maxScale, disabled, activeTool, search, setPage, setScale, setTool, exportPdf, exporting, exportError, name, setName, canUndo, canRedo, undoLabel, redoLabel, undo, redo, shortcuts, zoomIn, zoomOut, prevPage, nextPage, compact, showPagesButton, pagesOpen, onTogglePages, }: ToolbarProps): react.JSX.Element;
+
+export { type DrawPoint, type DrawStroke, type HighlightAnnotation, type HighlightRect, type ImageAnnotation, PagesSidebar, PdfEditor, type PdfEditorProps, type PdfLoadSuccess, type PdfSource, type PendingImage, type PendingSignature, type SidebarApi, type SidebarPage, type SignatureAnnotation, type TextAnnotation, type Tool, Toolbar, type ToolbarApi, type ToolbarSearchState, type ToolbarShortcuts, configurePdfWorker };