@embedpdf/plugin-annotation 2.6.2 → 2.7.0

package/dist/vue/components/renderers/link-renderer.vue.d.ts

@@ -0,0 +1,6 @@
+import { PdfLinkAnnoObject } from '@embedpdf/models';
+import { AnnotationRendererProps } from '../../context/types';
+type __VLS_Props = AnnotationRendererProps<PdfLinkAnnoObject>;
+declare const __VLS_export: import('vue').DefineComponent<__VLS_Props, {}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<__VLS_Props> & Readonly<{}>, {}, {}, {}, {}, string, import('vue').ComponentProvideOptions, false, {}, any>;
+declare const _default: typeof __VLS_export;
+export default _default;

package/dist/vue/components/renderers/polygon-renderer.vue.d.ts

@@ -0,0 +1,6 @@
+import { PdfPolygonAnnoObject } from '@embedpdf/models';
+import { AnnotationRendererProps } from '../../context/types';
+type __VLS_Props = AnnotationRendererProps<PdfPolygonAnnoObject>;
+declare const __VLS_export: import('vue').DefineComponent<__VLS_Props, {}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<__VLS_Props> & Readonly<{}>, {}, {}, {}, {}, string, import('vue').ComponentProvideOptions, false, {}, any>;
+declare const _default: typeof __VLS_export;
+export default _default;

package/dist/vue/components/renderers/polyline-renderer.vue.d.ts

@@ -0,0 +1,6 @@
+import { PdfPolylineAnnoObject } from '@embedpdf/models';
+import { AnnotationRendererProps } from '../../context/types';
+type __VLS_Props = AnnotationRendererProps<PdfPolylineAnnoObject>;
+declare const __VLS_export: import('vue').DefineComponent<__VLS_Props, {}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<__VLS_Props> & Readonly<{}>, {}, {}, {}, {}, string, import('vue').ComponentProvideOptions, false, {}, any>;
+declare const _default: typeof __VLS_export;
+export default _default;

package/dist/vue/components/renderers/square-renderer.vue.d.ts

@@ -0,0 +1,6 @@
+import { PdfSquareAnnoObject } from '@embedpdf/models';
+import { AnnotationRendererProps } from '../../context/types';
+type __VLS_Props = AnnotationRendererProps<PdfSquareAnnoObject>;
+declare const __VLS_export: import('vue').DefineComponent<__VLS_Props, {}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<__VLS_Props> & Readonly<{}>, {}, {}, {}, {}, string, import('vue').ComponentProvideOptions, false, {}, any>;
+declare const _default: typeof __VLS_export;
+export default _default;

package/dist/vue/components/renderers/squiggly-renderer.vue.d.ts

@@ -0,0 +1,6 @@
+import { PdfSquigglyAnnoObject } from '@embedpdf/models';
+import { AnnotationRendererProps } from '../../context/types';
+type __VLS_Props = AnnotationRendererProps<PdfSquigglyAnnoObject>;
+declare const __VLS_export: import('vue').DefineComponent<__VLS_Props, {}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<__VLS_Props> & Readonly<{}>, {}, {}, {}, {}, string, import('vue').ComponentProvideOptions, false, {}, any>;
+declare const _default: typeof __VLS_export;
+export default _default;

package/dist/vue/components/renderers/stamp-renderer.vue.d.ts

@@ -0,0 +1,6 @@
+import { PdfStampAnnoObject } from '@embedpdf/models';
+import { AnnotationRendererProps } from '../../context/types';
+type __VLS_Props = AnnotationRendererProps<PdfStampAnnoObject>;
+declare const __VLS_export: import('vue').DefineComponent<__VLS_Props, {}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<__VLS_Props> & Readonly<{}>, {}, {}, {}, {}, string, import('vue').ComponentProvideOptions, false, {}, any>;
+declare const _default: typeof __VLS_export;
+export default _default;

package/dist/vue/components/renderers/strikeout-renderer.vue.d.ts

@@ -0,0 +1,6 @@
+import { PdfStrikeOutAnnoObject } from '@embedpdf/models';
+import { AnnotationRendererProps } from '../../context/types';
+type __VLS_Props = AnnotationRendererProps<PdfStrikeOutAnnoObject>;
+declare const __VLS_export: import('vue').DefineComponent<__VLS_Props, {}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<__VLS_Props> & Readonly<{}>, {}, {}, {}, {}, string, import('vue').ComponentProvideOptions, false, {}, any>;
+declare const _default: typeof __VLS_export;
+export default _default;

package/dist/vue/components/renderers/underline-renderer.vue.d.ts

@@ -0,0 +1,6 @@
+import { PdfUnderlineAnnoObject } from '@embedpdf/models';
+import { AnnotationRendererProps } from '../../context/types';
+type __VLS_Props = AnnotationRendererProps<PdfUnderlineAnnoObject>;
+declare const __VLS_export: import('vue').DefineComponent<__VLS_Props, {}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<__VLS_Props> & Readonly<{}>, {}, {}, {}, {}, string, import('vue').ComponentProvideOptions, false, {}, any>;
+declare const _default: typeof __VLS_export;
+export default _default;

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

@@ -1,5 +1,7 @@
 import { Rect } from '@embedpdf/models';
-type __VLS_Props = {
+declare const _default: typeof __VLS_export;
+export default _default;
+declare const __VLS_export: import('vue').DefineComponent<{
     /** Stroke/markup color */
     strokeColor?: string;
     opacity?: number;
@@ -7,9 +9,19 @@ type __VLS_Props = {
     rect?: Rect;
     scale: number;
     onClick?: (e: PointerEvent | TouchEvent) => void;
-};
-declare const __VLS_export: import('vue').DefineComponent<__VLS_Props, {}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<__VLS_Props> & Readonly<{}>, {
+    /** When true, AP image provides the visual; only render hit area */
+    appearanceActive?: boolean;
+}, {}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<{
+    /** Stroke/markup color */
+    strokeColor?: string;
+    opacity?: number;
+    segmentRects: Rect[];
+    rect?: Rect;
+    scale: number;
+    onClick?: (e: PointerEvent | TouchEvent) => void;
+    /** When true, AP image provides the visual; only render hit area */
+    appearanceActive?: boolean;
+}> & Readonly<{}>, {
     opacity: number;
+    appearanceActive: boolean;
 }, {}, {}, {}, string, import('vue').ComponentProvideOptions, false, {}, any>;
-declare const _default: typeof __VLS_export;
-export default _default;

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

@@ -1,5 +1,7 @@
 import { Rect } from '@embedpdf/models';
-type __VLS_Props = {
+declare const _default: typeof __VLS_export;
+export default _default;
+declare const __VLS_export: import('vue').DefineComponent<{
     /** Stroke/markup color */
     strokeColor?: string;
     opacity?: number;
@@ -7,9 +9,19 @@ type __VLS_Props = {
     rect?: Rect;
     scale: number;
     onClick?: (e: PointerEvent | TouchEvent) => void;
-};
-declare const __VLS_export: import('vue').DefineComponent<__VLS_Props, {}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<__VLS_Props> & Readonly<{}>, {
+    /** When true, AP image provides the visual; only render hit area */
+    appearanceActive?: boolean;
+}, {}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<{
+    /** Stroke/markup color */
+    strokeColor?: string;
+    opacity?: number;
+    segmentRects: Rect[];
+    rect?: Rect;
+    scale: number;
+    onClick?: (e: PointerEvent | TouchEvent) => void;
+    /** When true, AP image provides the visual; only render hit area */
+    appearanceActive?: boolean;
+}> & Readonly<{}>, {
     opacity: number;
+    appearanceActive: boolean;
 }, {}, {}, {}, string, import('vue').ComponentProvideOptions, false, {}, any>;
-declare const _default: typeof __VLS_export;
-export default _default;

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

@@ -1,5 +1,7 @@
 import { Rect } from '@embedpdf/models';
-type __VLS_Props = {
+declare const _default: typeof __VLS_export;
+export default _default;
+declare const __VLS_export: import('vue').DefineComponent<{
     /** Stroke/markup color */
     strokeColor?: string;
     opacity?: number;
@@ -7,9 +9,19 @@ type __VLS_Props = {
     rect?: Rect;
     scale: number;
     onClick?: (e: PointerEvent | TouchEvent) => void;
-};
-declare const __VLS_export: import('vue').DefineComponent<__VLS_Props, {}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<__VLS_Props> & Readonly<{}>, {
+    /** When true, AP image provides the visual; only render hit area */
+    appearanceActive?: boolean;
+}, {}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<{
+    /** Stroke/markup color */
+    strokeColor?: string;
+    opacity?: number;
+    segmentRects: Rect[];
+    rect?: Rect;
+    scale: number;
+    onClick?: (e: PointerEvent | TouchEvent) => void;
+    /** When true, AP image provides the visual; only render hit area */
+    appearanceActive?: boolean;
+}> & Readonly<{}>, {
     opacity: number;
+    appearanceActive: boolean;
 }, {}, {}, {}, string, import('vue').ComponentProvideOptions, false, {}, any>;
-declare const _default: typeof __VLS_export;
-export default _default;

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

@@ -1,5 +1,7 @@
 import { Rect } from '@embedpdf/models';
-type __VLS_Props = {
+declare const _default: typeof __VLS_export;
+export default _default;
+declare const __VLS_export: import('vue').DefineComponent<{
     /** Stroke/markup color */
     strokeColor?: string;
     opacity?: number;
@@ -7,9 +9,19 @@ type __VLS_Props = {
     rect?: Rect;
     scale: number;
     onClick?: (e: PointerEvent | TouchEvent) => void;
-};
-declare const __VLS_export: import('vue').DefineComponent<__VLS_Props, {}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<__VLS_Props> & Readonly<{}>, {
+    /** When true, AP image provides the visual; only render hit area */
+    appearanceActive?: boolean;
+}, {}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<{
+    /** Stroke/markup color */
+    strokeColor?: string;
+    opacity?: number;
+    segmentRects: Rect[];
+    rect?: Rect;
+    scale: number;
+    onClick?: (e: PointerEvent | TouchEvent) => void;
+    /** When true, AP image provides the visual; only render hit area */
+    appearanceActive?: boolean;
+}> & Readonly<{}>, {
     opacity: number;
+    appearanceActive: boolean;
 }, {}, {}, {}, string, import('vue').ComponentProvideOptions, false, {}, any>;
-declare const _default: typeof __VLS_export;
-export default _default;

package/dist/vue/context/renderer-registry.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
@@ -23,4 +23,4 @@ export declare function useRegisterRenderers(entries: BoxedAnnotationRenderer[])
  * Wraps component in markRaw to prevent reactivity overhead.
  */
 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/vue/context/types.d.ts

@@ -1,15 +1,35 @@
-import { Component } from 'vue';
+import { Component, CSSProperties } from 'vue';
 import { PdfAnnotationObject } from '@embedpdf/models';
 import { TrackedAnnotation } from '../../lib';
+import { VertexConfig } from '../../shared-vue/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;
     /** Vue 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) => CSSProperties;
+    /** 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) => CSSProperties;
+    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;
 }