@embedpdf/plugin-annotation 1.3.15 → 1.4.0

package/dist/shared/components/annotation-container.d.ts

@@ -0,0 +1,31 @@
+import { PdfAnnotationObject } from '@embedpdf/models';
+import { TrackedAnnotation } from '../../index.ts';
+import { JSX, CSSProperties } from '../../react/adapter.ts';
+import { CustomAnnotationRenderer, ResizeHandleUI, SelectionMenuProps, VertexHandleUI } from './types';
+import { VertexConfig } from '../types';
+interface AnnotationContainerProps<T extends PdfAnnotationObject> {
+    scale: number;
+    pageIndex: number;
+    rotation: number;
+    pageWidth: number;
+    pageHeight: number;
+    trackedAnnotation: TrackedAnnotation<T>;
+    children: JSX.Element | ((annotation: T) => JSX.Element);
+    isSelected: boolean;
+    isDraggable: boolean;
+    isResizable: boolean;
+    lockAspectRatio?: boolean;
+    style?: CSSProperties;
+    vertexConfig?: VertexConfig<T>;
+    selectionMenu?: (props: SelectionMenuProps) => JSX.Element;
+    outlineOffset?: number;
+    onDoubleClick?: (event: any) => void;
+    onSelect: (event: any) => void;
+    zIndex?: number;
+    resizeUI?: ResizeHandleUI;
+    vertexUI?: VertexHandleUI;
+    selectionOutlineColor?: string;
+    customAnnotationRenderer?: CustomAnnotationRenderer<T>;
+}
+export declare function AnnotationContainer<T extends PdfAnnotationObject>({ scale, pageIndex, rotation, pageWidth, pageHeight, trackedAnnotation, children, isSelected, isDraggable, isResizable, lockAspectRatio, style, vertexConfig, selectionMenu, outlineOffset, onDoubleClick, onSelect, zIndex, resizeUI, vertexUI, selectionOutlineColor, customAnnotationRenderer, ...props }: AnnotationContainerProps<T>): JSX.Element;
+export {};

package/dist/shared/components/annotation-layer.d.ts

@@ -0,0 +1,23 @@
+import { HTMLAttributes, CSSProperties } from '../../react/adapter.ts';
+import { SelectionMenu, ResizeHandleUI, VertexHandleUI, CustomAnnotationRenderer } from './types';
+import { PdfAnnotationObject } from '@embedpdf/models';
+type AnnotationLayerProps = Omit<HTMLAttributes<HTMLDivElement>, 'style'> & {
+    pageIndex: number;
+    scale: number;
+    pageWidth: number;
+    pageHeight: number;
+    rotation: number;
+    /** Customize selection menu across all annotations on this layer */
+    selectionMenu?: SelectionMenu;
+    style?: CSSProperties;
+    /** Customize resize handles */
+    resizeUI?: ResizeHandleUI;
+    /** Customize vertex handles */
+    vertexUI?: VertexHandleUI;
+    /** Customize selection outline color */
+    selectionOutlineColor?: string;
+    /** Customize annotation renderer */
+    customAnnotationRenderer?: CustomAnnotationRenderer<PdfAnnotationObject>;
+};
+export declare function AnnotationLayer({ style, pageIndex, scale, selectionMenu, resizeUI, vertexUI, pageWidth, pageHeight, rotation, selectionOutlineColor, customAnnotationRenderer, ...props }: AnnotationLayerProps): import("react/jsx-runtime").JSX.Element;
+export {};

package/dist/shared/components/annotation-paint-layer.d.ts

@@ -0,0 +1,6 @@
+interface Props {
+    pageIndex: number;
+    scale: number;
+}
+export declare function AnnotationPaintLayer({ pageIndex, scale }: Props): import("react/jsx-runtime").JSX.Element;
+export {};

package/dist/shared/components/annotations/circle.d.ts

@@ -0,0 +1,29 @@
+import { MouseEvent, TouchEvent } from '../../../react/adapter.ts';
+import { PdfAnnotationBorderStyle, Rect } from '@embedpdf/models';
+interface CircleProps {
+    /** Whether the annotation is selected */
+    isSelected: boolean;
+    /** Fill colour – defaults to PDFium’s black if omitted */
+    color?: string;
+    /** Stroke colour – defaults to same as fill when omitted */
+    strokeColor?: string;
+    /** 0 – 1 */
+    opacity?: number;
+    /** Stroke width in PDF units */
+    strokeWidth: number;
+    /** Stroke type – defaults to solid when omitted */
+    strokeStyle?: PdfAnnotationBorderStyle;
+    /** Stroke dash array – defaults to undefined when omitted */
+    strokeDashArray?: number[];
+    /** Bounding box of the annotation */
+    rect: Rect;
+    /** Current page zoom factor */
+    scale: number;
+    /** Click handler (used for selection) */
+    onClick?: (e: MouseEvent<SVGElement> | TouchEvent<SVGElement>) => void;
+}
+/**
+ * Renders a PDF Circle annotation (ellipse) as SVG.
+ */
+export declare function Circle({ color, strokeColor, opacity, strokeWidth, strokeStyle, strokeDashArray, rect, scale, onClick, isSelected, }: CircleProps): JSX.Element;
+export {};

package/dist/shared/components/annotations/free-text.d.ts

@@ -0,0 +1,14 @@
+import { MouseEvent, TouchEvent } from '../../../react/adapter.ts';
+import { PdfFreeTextAnnoObject } from '@embedpdf/models';
+import { TrackedAnnotation } from '../../../index.ts';
+interface FreeTextProps {
+    isSelected: boolean;
+    isEditing: boolean;
+    annotation: TrackedAnnotation<PdfFreeTextAnnoObject>;
+    pageIndex: number;
+    scale: number;
+    onClick?: (e: MouseEvent<HTMLDivElement> | TouchEvent<HTMLDivElement>) => void;
+    onDoubleClick?: (event: MouseEvent<HTMLDivElement>) => void;
+}
+export declare function FreeText({ isSelected, isEditing, annotation, pageIndex, scale, onClick, }: FreeTextProps): import("react/jsx-runtime").JSX.Element;
+export {};

package/dist/shared/components/annotations/ink.d.ts

@@ -0,0 +1,25 @@
+import { MouseEvent, TouchEvent } from '../../../react/adapter.ts';
+import { PdfInkListObject, Rect } from '@embedpdf/models';
+interface InkProps {
+    /** Whether the annotation is selected */
+    isSelected: boolean;
+    /** Stroke colour (falls back to PDFium default black) */
+    color?: string;
+    /** 0 – 1 */
+    opacity?: number;
+    /** Line width in PDF units */
+    strokeWidth: number;
+    /** Array of strokes — exactly as in your JSON */
+    inkList: PdfInkListObject[];
+    /** Bounding box of the whole annotation */
+    rect: Rect;
+    /** Page zoom factor */
+    scale: number;
+    /** Callback for when the annotation is clicked */
+    onClick?: (e: MouseEvent<SVGPathElement> | TouchEvent<SVGPathElement>) => void;
+}
+/**
+ * Renders a PDF Ink annotation (free-hand drawing) as SVG.
+ */
+export declare function Ink({ isSelected, color, opacity, strokeWidth, inkList, rect, scale, onClick, }: InkProps): JSX.Element;
+export {};

package/dist/shared/components/annotations/line.d.ts

@@ -0,0 +1,33 @@
+import { MouseEvent, TouchEvent } from '../../../react/adapter.ts';
+import { Rect, LinePoints, LineEndings, PdfAnnotationBorderStyle } from '@embedpdf/models';
+interface LineProps {
+    /** interior colour */
+    color?: string;
+    /** 0 – 1 */
+    opacity?: number;
+    /** Stroke width in PDF units */
+    strokeWidth: number;
+    /** Stroke colour (falls back to PDFium default black) */
+    strokeColor?: string;
+    /** Stroke style */
+    strokeStyle?: PdfAnnotationBorderStyle;
+    /** Stroke dash array */
+    strokeDashArray?: number[];
+    /** Bounding box of the annotation */
+    rect: Rect;
+    /** Line start / end points (page units) */
+    linePoints: LinePoints;
+    /** Line endings (eg. OpenArrow / Butt) */
+    lineEndings?: LineEndings;
+    /** Current page zoom factor */
+    scale: number;
+    /** Click handler (used for selection) */
+    onClick?: (e: MouseEvent<SVGElement> | TouchEvent<SVGElement>) => void;
+    /** Whether the annotation is selected */
+    isSelected: boolean;
+}
+/**
+ * Renders a PDF Line annotation as SVG (with arrow/butt endings).
+ */
+export declare function Line({ color, opacity, strokeWidth, strokeColor, strokeStyle, strokeDashArray, rect, linePoints, lineEndings, scale, onClick, isSelected, }: LineProps): JSX.Element;
+export {};

package/dist/shared/components/annotations/polygon.d.ts

@@ -0,0 +1,20 @@
+import { MouseEvent, TouchEvent } from '../../../react/adapter.ts';
+import { Rect, Position, PdfAnnotationBorderStyle } from '@embedpdf/models';
+interface PolygonProps {
+    rect: Rect;
+    vertices: Position[];
+    color?: string;
+    strokeColor?: string;
+    opacity?: number;
+    strokeWidth: number;
+    strokeStyle?: PdfAnnotationBorderStyle;
+    strokeDashArray?: number[];
+    scale: number;
+    isSelected: boolean;
+    onClick?: (e: MouseEvent<SVGElement> | TouchEvent<SVGElement>) => void;
+    currentVertex?: Position;
+    handleSize?: number;
+}
+export declare function Polygon({ rect, vertices, color, strokeColor, opacity, strokeWidth, strokeStyle, strokeDashArray, scale, isSelected, onClick, currentVertex, // A preview-only prop
+handleSize, }: PolygonProps): JSX.Element;
+export {};

package/dist/shared/components/annotations/polyline.d.ts

@@ -0,0 +1,17 @@
+import { MouseEvent, TouchEvent } from '../../../react/adapter.ts';
+import { Rect, Position, LineEndings } from '@embedpdf/models';
+interface PolylineProps {
+    rect: Rect;
+    vertices: Position[];
+    color?: string;
+    strokeColor?: string;
+    opacity?: number;
+    strokeWidth: number;
+    scale: number;
+    isSelected: boolean;
+    onClick?: (e: MouseEvent<SVGElement> | TouchEvent<SVGElement>) => void;
+    /** Optional start & end endings */
+    lineEndings?: LineEndings;
+}
+export declare function Polyline({ rect, vertices, color, strokeColor, opacity, strokeWidth, scale, isSelected, onClick, lineEndings, }: PolylineProps): JSX.Element;
+export {};

package/dist/shared/components/annotations/square.d.ts

@@ -0,0 +1,29 @@
+import { MouseEvent, TouchEvent } from '../../../react/adapter.ts';
+import { PdfAnnotationBorderStyle, Rect } from '@embedpdf/models';
+interface SquareProps {
+    /** Whether the annotation is selected */
+    isSelected: boolean;
+    /** Fill colour – defaults to PDFium’s black if omitted */
+    color?: string;
+    /** Stroke colour – defaults to same as fill when omitted */
+    strokeColor?: string;
+    /** 0 – 1 */
+    opacity?: number;
+    /** Stroke width in PDF units */
+    strokeWidth: number;
+    /** Stroke type – defaults to solid when omitted */
+    strokeStyle?: PdfAnnotationBorderStyle;
+    /** Stroke dash array – defaults to undefined when omitted */
+    strokeDashArray?: number[];
+    /** Bounding box of the annotation (PDF units) */
+    rect: Rect;
+    /** Current page zoom factor */
+    scale: number;
+    /** Click handler (used for selection) */
+    onClick?: (e: MouseEvent<SVGElement> | TouchEvent<SVGElement>) => void;
+}
+/**
+ * Renders a PDF Square annotation (rectangle) as SVG.
+ */
+export declare function Square({ isSelected, color, strokeColor, opacity, strokeWidth, strokeStyle, strokeDashArray, rect, scale, onClick, }: SquareProps): JSX.Element;
+export {};

package/dist/shared/components/annotations/stamp.d.ts

@@ -0,0 +1,12 @@
+import { MouseEvent, TouchEvent } from '../../../react/adapter.ts';
+import { PdfStampAnnoObject } from '@embedpdf/models';
+import { TrackedAnnotation } from '../../../index.ts';
+interface StampProps {
+    isSelected: boolean;
+    annotation: TrackedAnnotation<PdfStampAnnoObject>;
+    pageIndex: number;
+    scale: number;
+    onClick: (e: MouseEvent<HTMLDivElement> | TouchEvent<HTMLDivElement>) => void;
+}
+export declare function Stamp({ isSelected, annotation, pageIndex, scale, onClick }: StampProps): import("react/jsx-runtime").JSX.Element;
+export {};

package/dist/shared/components/annotations.d.ts

@@ -0,0 +1,16 @@
+import { PdfAnnotationObject } from '@embedpdf/models';
+import { CustomAnnotationRenderer, ResizeHandleUI, SelectionMenu, VertexHandleUI } from './types';
+interface AnnotationsProps {
+    pageIndex: number;
+    scale: number;
+    rotation: number;
+    pageWidth: number;
+    pageHeight: number;
+    selectionMenu?: SelectionMenu;
+    resizeUI?: ResizeHandleUI;
+    vertexUI?: VertexHandleUI;
+    selectionOutlineColor?: string;
+    customAnnotationRenderer?: CustomAnnotationRenderer<PdfAnnotationObject>;
+}
+export declare function Annotations(annotationsProps: AnnotationsProps): import("react/jsx-runtime").JSX.Element;
+export {};

package/dist/shared/components/index.d.ts

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

package/dist/shared/components/preview-renderer.d.ts

@@ -0,0 +1,7 @@
+import { AnyPreviewState } from '../../index.ts';
+interface Props {
+    preview: AnyPreviewState;
+    scale: number;
+}
+export declare function PreviewRenderer({ preview, scale }: Props): import("react/jsx-runtime").JSX.Element | null;
+export {};

package/dist/shared/components/render-annotation.d.ts

@@ -0,0 +1,11 @@
+import { HTMLAttributes, CSSProperties } from '../../react/adapter.ts';
+import { PdfAnnotationObject } from '@embedpdf/models';
+type RenderAnnotationProps = Omit<HTMLAttributes<HTMLImageElement>, 'style'> & {
+    pageIndex: number;
+    annotation: PdfAnnotationObject;
+    scaleFactor?: number;
+    dpr?: number;
+    style?: CSSProperties;
+};
+export declare function RenderAnnotation({ pageIndex, annotation, scaleFactor, style, ...props }: RenderAnnotationProps): import("react/jsx-runtime").JSX.Element;
+export {};

package/dist/shared/components/text-markup/highlight.d.ts

@@ -0,0 +1,13 @@
+import { CSSProperties, MouseEvent, TouchEvent } from '../../../react/adapter.ts';
+import { Rect } from '@embedpdf/models';
+type HighlightProps = {
+    color?: string;
+    opacity?: number;
+    segmentRects: Rect[];
+    rect?: Rect;
+    scale: number;
+    onClick?: (e: MouseEvent<HTMLDivElement> | TouchEvent<HTMLDivElement>) => void;
+    style?: CSSProperties;
+};
+export declare function Highlight({ color, opacity, segmentRects, rect, scale, onClick, style, }: HighlightProps): import("react/jsx-runtime").JSX.Element;
+export {};

package/dist/shared/components/text-markup/squiggly.d.ts

@@ -0,0 +1,13 @@
+import { CSSProperties, MouseEvent, TouchEvent } from '../../../react/adapter.ts';
+import { Rect } from '@embedpdf/models';
+type SquigglyProps = {
+    color?: string;
+    opacity?: number;
+    segmentRects: Rect[];
+    rect?: Rect;
+    scale: number;
+    onClick?: (e: MouseEvent<HTMLDivElement> | TouchEvent<HTMLDivElement>) => void;
+    style?: CSSProperties;
+};
+export declare function Squiggly({ color, opacity, segmentRects, rect, scale, onClick, style, }: SquigglyProps): import("react/jsx-runtime").JSX.Element;
+export {};

package/dist/shared/components/text-markup/strikeout.d.ts

@@ -0,0 +1,13 @@
+import { CSSProperties, MouseEvent, TouchEvent } from '../../../react/adapter.ts';
+import { Rect } from '@embedpdf/models';
+type StrikeoutProps = {
+    color?: string;
+    opacity?: number;
+    segmentRects: Rect[];
+    rect?: Rect;
+    scale: number;
+    onClick?: (e: MouseEvent<HTMLDivElement> | TouchEvent<HTMLDivElement>) => void;
+    style?: CSSProperties;
+};
+export declare function Strikeout({ color, opacity, segmentRects, rect, scale, onClick, style, }: StrikeoutProps): import("react/jsx-runtime").JSX.Element;
+export {};

package/dist/shared/components/text-markup/underline.d.ts

@@ -0,0 +1,13 @@
+import { CSSProperties, MouseEvent, TouchEvent } from '../../../react/adapter.ts';
+import { Rect } from '@embedpdf/models';
+type UnderlineProps = {
+    color?: string;
+    opacity?: number;
+    segmentRects: Rect[];
+    rect?: Rect;
+    scale: number;
+    onClick?: (e: MouseEvent<HTMLDivElement> | TouchEvent<HTMLDivElement>) => void;
+    style?: CSSProperties;
+};
+export declare function Underline({ color, opacity, segmentRects, rect, scale, onClick, style, }: UnderlineProps): import("react/jsx-runtime").JSX.Element;
+export {};

package/dist/shared/components/text-markup.d.ts

@@ -0,0 +1,6 @@
+interface TextMarkupProps {
+    pageIndex: number;
+    scale: number;
+}
+export declare function TextMarkup({ pageIndex, scale }: TextMarkupProps): import("react/jsx-runtime").JSX.Element | null;
+export {};

package/dist/shared/components/types.d.ts

@@ -0,0 +1,51 @@
+import { PdfAnnotationObject, Rect } from '@embedpdf/models';
+import { TrackedAnnotation } from '../../index.ts';
+import { HandleElementProps, MenuWrapperProps } from '../../react/utils.ts';
+import { JSX } from '../../react/adapter.ts';
+export type ResizeDirection = 'top-left' | 'top-right' | 'bottom-left' | 'bottom-right' | 'none';
+export interface SelectionMenuProps {
+    annotation: TrackedAnnotation;
+    selected: boolean;
+    rect: Rect;
+    menuWrapperProps: MenuWrapperProps;
+}
+export type SelectionMenu = (props: SelectionMenuProps) => JSX.Element;
+export type HandleProps = HandleElementProps & {
+    backgroundColor?: string;
+};
+/** UI customization for resize handles */
+export interface ResizeHandleUI {
+    /** Handle size in CSS px (default: 12) */
+    size?: number;
+    /** Default background color for the handle (used by default renderer) */
+    color?: string;
+    /** Custom renderer for each handle (overrides default) */
+    component?: (p: HandleProps) => JSX.Element;
+}
+/** UI customization for vertex handles */
+export interface VertexHandleUI {
+    /** Handle size in CSS px (default: 12) */
+    size?: number;
+    /** Default background color for the handle (used by default renderer) */
+    color?: string;
+    /** Custom renderer for each vertex (overrides default) */
+    component?: (p: HandleProps) => JSX.Element;
+}
+/**
+ * Props for the custom annotation renderer
+ */
+export interface CustomAnnotationRendererProps<T extends PdfAnnotationObject> {
+    annotation: T;
+    children: JSX.Element;
+    isSelected: boolean;
+    scale: number;
+    rotation: number;
+    pageWidth: number;
+    pageHeight: number;
+    pageIndex: number;
+    onSelect: (event: any) => void;
+}
+/**
+ * Custom renderer for an annotation
+ */
+export type CustomAnnotationRenderer<T extends PdfAnnotationObject> = (props: CustomAnnotationRendererProps<T>) => JSX.Element | null;

package/dist/shared/hooks/index.d.ts

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

package/dist/shared/hooks/use-annotation.d.ts

@@ -0,0 +1,15 @@
+import { AnnotationPlugin, AnnotationState } from '../../index.ts';
+export declare const useAnnotationPlugin: () => {
+    plugin: AnnotationPlugin | null;
+    isLoading: boolean;
+    ready: Promise<void>;
+};
+export declare const useAnnotationCapability: () => {
+    provides: Readonly<import('../../index.ts').AnnotationCapability> | null;
+    isLoading: boolean;
+    ready: Promise<void>;
+};
+export declare const useAnnotation: () => {
+    state: AnnotationState;
+    provides: Readonly<import('../../index.ts').AnnotationCapability> | null;
+};

package/dist/shared/index.d.ts

@@ -0,0 +1,3 @@
+export * from './hooks';
+export * from './components';
+export * from '../index.ts';

package/dist/shared/types.d.ts

@@ -0,0 +1,10 @@
+import { PdfAnnotationObject, Position } from '@embedpdf/models';
+/**
+ * Interface for vertex configuration - handles annotation-specific vertex logic
+ */
+export interface VertexConfig<T extends PdfAnnotationObject> {
+    /** Extract vertices from annotation - handles different vertex formats */
+    extractVertices: (annotation: T) => Position[];
+    /** Transform annotation when vertices change */
+    transformAnnotation: (annotation: T, vertices: Position[]) => Partial<T>;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@embedpdf/plugin-annotation",
-  "version": "1.3.15",
+  "version": "1.4.0",
   "type": "module",
   "license": "MIT",
   "main": "./dist/index.cjs",
@@ -29,26 +29,26 @@
     }
   },
   "dependencies": {
-    "@embedpdf/models": "1.3.15",
-    "@embedpdf/utils": "1.3.15"
+    "@embedpdf/models": "1.4.0",
+    "@embedpdf/utils": "1.4.0"
   },
   "devDependencies": {
     "@types/react": "^18.2.0",
     "typescript": "^5.0.0",
-    "@embedpdf/build": "1.0.1",
-    "@embedpdf/plugin-interaction-manager": "1.3.15",
-    "@embedpdf/plugin-selection": "1.3.15",
-    "@embedpdf/plugin-history": "1.3.15"
+    "@embedpdf/plugin-interaction-manager": "1.4.0",
+    "@embedpdf/build": "1.1.0",
+    "@embedpdf/plugin-selection": "1.4.0",
+    "@embedpdf/plugin-history": "1.4.0"
   },
   "peerDependencies": {
     "react": ">=16.8.0",
     "react-dom": ">=16.8.0",
     "preact": "^10.26.4",
     "vue": ">=3.2.0",
-    "@embedpdf/plugin-interaction-manager": "1.3.15",
-    "@embedpdf/plugin-selection": "1.3.15",
-    "@embedpdf/plugin-history": "1.3.15",
-    "@embedpdf/core": "1.3.15"
+    "@embedpdf/core": "1.4.0",
+    "@embedpdf/plugin-interaction-manager": "1.4.0",
+    "@embedpdf/plugin-selection": "1.4.0",
+    "@embedpdf/plugin-history": "1.4.0"
   },
   "files": [
     "dist",