@embedpdf/plugin-annotation 2.6.2 → 2.7.0

package/dist/svelte/components/renderers/PolygonRenderer.svelte.d.ts

@@ -0,0 +1,5 @@
+import { PdfPolygonAnnoObject } from '@embedpdf/models';
+import { AnnotationRendererProps } from '../../context/types';
+declare const PolygonRenderer: import('svelte', { with: { "resolution-mode": "import" } }).Component<AnnotationRendererProps<PdfPolygonAnnoObject>, {}, "">;
+type PolygonRenderer = ReturnType<typeof PolygonRenderer>;
+export default PolygonRenderer;

package/dist/svelte/components/renderers/PolylineRenderer.svelte.d.ts

@@ -0,0 +1,5 @@
+import { PdfPolylineAnnoObject } from '@embedpdf/models';
+import { AnnotationRendererProps } from '../../context/types';
+declare const PolylineRenderer: import('svelte', { with: { "resolution-mode": "import" } }).Component<AnnotationRendererProps<PdfPolylineAnnoObject>, {}, "">;
+type PolylineRenderer = ReturnType<typeof PolylineRenderer>;
+export default PolylineRenderer;

package/dist/svelte/components/renderers/SquareRenderer.svelte.d.ts

@@ -0,0 +1,5 @@
+import { PdfSquareAnnoObject } from '@embedpdf/models';
+import { AnnotationRendererProps } from '../../context/types';
+declare const SquareRenderer: import('svelte', { with: { "resolution-mode": "import" } }).Component<AnnotationRendererProps<PdfSquareAnnoObject>, {}, "">;
+type SquareRenderer = ReturnType<typeof SquareRenderer>;
+export default SquareRenderer;

package/dist/svelte/components/renderers/SquigglyRenderer.svelte.d.ts

@@ -0,0 +1,5 @@
+import { PdfSquigglyAnnoObject } from '@embedpdf/models';
+import { AnnotationRendererProps } from '../../context/types';
+declare const SquigglyRenderer: import('svelte', { with: { "resolution-mode": "import" } }).Component<AnnotationRendererProps<PdfSquigglyAnnoObject>, {}, "">;
+type SquigglyRenderer = ReturnType<typeof SquigglyRenderer>;
+export default SquigglyRenderer;

package/dist/svelte/components/renderers/StampRenderer.svelte.d.ts

@@ -0,0 +1,5 @@
+import { PdfStampAnnoObject } from '@embedpdf/models';
+import { AnnotationRendererProps } from '../../context/types';
+declare const StampRenderer: import('svelte', { with: { "resolution-mode": "import" } }).Component<AnnotationRendererProps<PdfStampAnnoObject>, {}, "">;
+type StampRenderer = ReturnType<typeof StampRenderer>;
+export default StampRenderer;

package/dist/svelte/components/renderers/StrikeoutRenderer.svelte.d.ts

@@ -0,0 +1,5 @@
+import { PdfStrikeOutAnnoObject } from '@embedpdf/models';
+import { AnnotationRendererProps } from '../../context/types';
+declare const StrikeoutRenderer: import('svelte', { with: { "resolution-mode": "import" } }).Component<AnnotationRendererProps<PdfStrikeOutAnnoObject>, {}, "">;
+type StrikeoutRenderer = ReturnType<typeof StrikeoutRenderer>;
+export default StrikeoutRenderer;

package/dist/svelte/components/renderers/UnderlineRenderer.svelte.d.ts

@@ -0,0 +1,5 @@
+import { PdfUnderlineAnnoObject } from '@embedpdf/models';
+import { AnnotationRendererProps } from '../../context/types';
+declare const UnderlineRenderer: import('svelte', { with: { "resolution-mode": "import" } }).Component<AnnotationRendererProps<PdfUnderlineAnnoObject>, {}, "">;
+type UnderlineRenderer = ReturnType<typeof UnderlineRenderer>;
+export default UnderlineRenderer;

package/dist/svelte/components/text-markup/Highlight.svelte.d.ts

@@ -8,6 +8,8 @@ interface HighlightProps {
     scale: number;
     onClick?: (e: MouseEvent | TouchEvent) => void;
     style?: Record<string, string | number | undefined>;
+    /** When true, AP image provides the visual; only render hit area */
+    appearanceActive?: boolean;
 }
 declare const Highlight: import('svelte', { with: { "resolution-mode": "import" } }).Component<HighlightProps, {}, "">;
 type Highlight = ReturnType<typeof Highlight>;

package/dist/svelte/components/text-markup/Squiggly.svelte.d.ts

@@ -8,6 +8,8 @@ interface SquigglyProps {
     scale: number;
     onClick?: (e: MouseEvent | TouchEvent) => void;
     style?: Record<string, string | number | undefined>;
+    /** When true, AP image provides the visual; only render hit area */
+    appearanceActive?: boolean;
 }
 declare const Squiggly: import('svelte', { with: { "resolution-mode": "import" } }).Component<SquigglyProps, {}, "">;
 type Squiggly = ReturnType<typeof Squiggly>;

package/dist/svelte/components/text-markup/Strikeout.svelte.d.ts

@@ -8,6 +8,8 @@ interface StrikeoutProps {
     scale: number;
     onClick?: (e: MouseEvent | TouchEvent) => void;
     style?: Record<string, string | number | undefined>;
+    /** When true, AP image provides the visual; only render hit area */
+    appearanceActive?: boolean;
 }
 declare const Strikeout: import('svelte', { with: { "resolution-mode": "import" } }).Component<StrikeoutProps, {}, "">;
 type Strikeout = ReturnType<typeof Strikeout>;

package/dist/svelte/components/text-markup/Underline.svelte.d.ts

@@ -8,6 +8,8 @@ interface UnderlineProps {
     scale: number;
     onClick?: (e: MouseEvent | TouchEvent) => void;
     style?: Record<string, string | number | undefined>;
+    /** When true, AP image provides the visual; only render hit area */
+    appearanceActive?: boolean;
 }
 declare const Underline: import('svelte', { with: { "resolution-mode": "import" } }).Component<UnderlineProps, {}, "">;
 type Underline = ReturnType<typeof Underline>;

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

@@ -1,7 +1,7 @@
 import { Snippet } from 'svelte';
 import { CustomAnnotationRenderer, ResizeHandleUI, VertexHandleUI, RotationHandleUI, SelectionOutline, AnnotationSelectionMenuRenderFn, AnnotationSelectionMenuProps, GroupSelectionMenuRenderFn } from '../types';
 import { VertexConfig } from '../../shared-svelte/types';
-import { PdfAnnotationObject } from '@embedpdf/models';
+import { PdfAnnotationObject, AnnotationAppearances } from '@embedpdf/models';
 import { TrackedAnnotation } from '../../lib/index.ts';
 import { BoxedAnnotationRenderer } from '../context';
 export interface AnnotationContainerProps<T extends PdfAnnotationObject> {
@@ -12,8 +12,12 @@ export interface AnnotationContainerProps<T extends PdfAnnotationObject> {
     pageWidth: number;
     pageHeight: number;
     trackedAnnotation: TrackedAnnotation<T>;
-    children: Snippet<[T]>;
+    children: Snippet<[T, {
+        appearanceActive: boolean;
+    }]>;
     isSelected: boolean;
+    /** Whether the annotation is in editing mode (e.g., FreeText text editing) */
+    isEditing?: boolean;
     /** Whether multiple annotations are selected (container becomes passive) */
     isMultiSelected?: boolean;
     isDraggable: boolean;
@@ -29,6 +33,8 @@ export interface AnnotationContainerProps<T extends PdfAnnotationObject> {
     outlineOffset?: number;
     onDoubleClick?: (event: any) => void;
     onSelect: (event: any) => void;
+    /** Pre-rendered appearance stream images for AP mode rendering */
+    appearance?: AnnotationAppearances<Blob> | null;
     zIndex?: number;
     resizeUI?: ResizeHandleUI;
     vertexUI?: VertexHandleUI;

package/dist/svelte/context/renderer-registry.svelte.d.ts

@@ -1,4 +1,4 @@
-import { BoxedAnnotationRenderer, AnnotationRendererEntry, AnnotationRendererProps } from './types';
+import { BoxedAnnotationRenderer, AnnotationRendererEntry, AnnotationRendererProps, AnnotationInteractionEvent, SelectOverrideHelpers } from './types';
 import { PdfAnnotationObject } from '@embedpdf/models';
 /**
  * Annotation Renderer Registry
@@ -17,4 +17,4 @@ export declare function getRendererRegistry(): AnnotationRendererRegistry | null
  * Factory to create a boxed renderer from a typed entry.
  */
 export declare function createRenderer<T extends PdfAnnotationObject>(entry: AnnotationRendererEntry<T>): BoxedAnnotationRenderer;
-export type { AnnotationRendererProps, AnnotationRendererEntry, BoxedAnnotationRenderer };
+export type { AnnotationRendererProps, AnnotationRendererEntry, BoxedAnnotationRenderer, AnnotationInteractionEvent, SelectOverrideHelpers, };

package/dist/svelte/context/types.d.ts

@@ -1,15 +1,35 @@
 import { Component } from 'svelte';
 import { PdfAnnotationObject } from '@embedpdf/models';
-import { TrackedAnnotation } from '../../lib';
+import { TrackedAnnotation } from '../../lib/index.ts';
+import { VertexConfig } from '../../shared-svelte/types';
+/**
+ * Properly typed event for annotation interactions (click, select, etc.)
+ */
+export type AnnotationInteractionEvent = PointerEvent | MouseEvent | TouchEvent;
 /**
  * Props passed to custom annotation renderer components
  */
 export interface AnnotationRendererProps<T extends PdfAnnotationObject = PdfAnnotationObject> {
     annotation: TrackedAnnotation<T>;
+    currentObject: T;
     isSelected: boolean;
+    isEditing: boolean;
     scale: number;
     pageIndex: number;
-    onClick: (e: PointerEvent | TouchEvent) => void;
+    documentId: string;
+    onClick: (e: AnnotationInteractionEvent) => void;
+    /** When true, AP canvas provides the visual; component should only render hit area */
+    appearanceActive: boolean;
+}
+/**
+ * Helpers passed to selectOverride for custom selection behavior.
+ */
+export interface SelectOverrideHelpers {
+    defaultSelect: (e: AnnotationInteractionEvent, annotation: TrackedAnnotation) => void;
+    selectAnnotation: (pageIndex: number, id: string) => void;
+    clearSelection: () => void;
+    allAnnotations: TrackedAnnotation[];
+    pageIndex: number;
 }
 /**
  * Entry for defining a custom annotation renderer.
@@ -22,6 +42,31 @@ export interface AnnotationRendererEntry<T extends PdfAnnotationObject = PdfAnno
     matches: (annotation: PdfAnnotationObject) => annotation is T;
     /** Svelte component to render the annotation */
     component: Component<AnnotationRendererProps<T>>;
+    /** Vertex configuration for annotations with draggable vertices (line, polyline, polygon) */
+    vertexConfig?: VertexConfig<T>;
+    /** z-index for the annotation container (default: 1, text markup uses 0) */
+    zIndex?: number;
+    /** Style applied to the annotation container (overrides default blendMode style) */
+    containerStyle?: (annotation: T) => string;
+    /** Type-specific interaction fallbacks used when the tool doesn't define a property */
+    interactionDefaults?: {
+        isDraggable?: boolean;
+        isResizable?: boolean;
+        isRotatable?: boolean;
+        lockAspectRatio?: boolean;
+    };
+    /** Whether this annotation type uses AP rendering before editing (default: true) */
+    useAppearanceStream?: boolean;
+    /** Override resolved isDraggable (e.g., FreeText disables drag while editing) */
+    isDraggable?: (toolDraggable: boolean, context: {
+        isEditing: boolean;
+    }) => boolean;
+    /** Handle double-click on the annotation container */
+    onDoubleClick?: (annotationId: string, setEditingId: (id: string) => void) => void;
+    /** Override default selection behavior (e.g., Link IRT parent resolution) */
+    selectOverride?: (e: AnnotationInteractionEvent, annotation: TrackedAnnotation<T>, helpers: SelectOverrideHelpers) => void;
+    /** Return true to hide the selection menu for this annotation */
+    hideSelectionMenu?: (annotation: T) => boolean;
 }
 /**
  * Boxed renderer stored in registry (generic erased for storage)
@@ -30,4 +75,20 @@ export interface BoxedAnnotationRenderer {
     id: string;
     matches: (annotation: PdfAnnotationObject) => boolean;
     component: Component<AnnotationRendererProps>;
+    vertexConfig?: VertexConfig<PdfAnnotationObject>;
+    zIndex?: number;
+    containerStyle?: (annotation: PdfAnnotationObject) => string;
+    interactionDefaults?: {
+        isDraggable?: boolean;
+        isResizable?: boolean;
+        isRotatable?: boolean;
+        lockAspectRatio?: boolean;
+    };
+    useAppearanceStream?: boolean;
+    isDraggable?: (toolDraggable: boolean, context: {
+        isEditing: boolean;
+    }) => boolean;
+    onDoubleClick?: (annotationId: string, setEditingId: (id: string) => void) => void;
+    selectOverride?: (e: AnnotationInteractionEvent, annotation: TrackedAnnotation, helpers: SelectOverrideHelpers) => void;
+    hideSelectionMenu?: (annotation: PdfAnnotationObject) => boolean;
 }